Add streaming features and missing pre recorded features

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "deepgram"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Deepgram <[email protected]>"]
 edition = "2021"
 description = "Official Rust SDK for Deepgram's automated speech recognition APIs."
@@ -20,6 +20,7 @@ pin-project = "1"
 reqwest = { version = "0.11.22", default-features = false, features = ["json", "rustls-tls", "stream"] }
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
+serde_urlencoded = "0.7"
 thiserror = "1"
 tokio = { version = "1.13.0", features = ["full"] }
 tokio-tungstenite = { version = "0.20.1", features = ["rustls-tls-webpki-roots"], optional = true }
@@ -62,4 +63,4 @@ required-features = ["prerecorded"]
 
 [[example]]
 name = "simple_stream"
-required-features = ["live"]
+required-features = ["live"]

README.md

@@ -20,6 +20,7 @@ You can learn more about the Deepgram API at [developers.deepgram.com](https://d
 ## Current Status
 
 This SDK is still very much work-in-progress. The interface is subject to rapid change.
+
 ## Install
 
 From within your Cargo project directory, run the following command:
@@ -46,6 +47,13 @@ To make sure our community is safe for all, be sure to review and agree to our
 [Code of Conduct](./CODE_OF_CONDUCT.md). Then see the
 [Contributing Guidelines](./CONTRIBUTING.md) for more information.
 
+
+### Build the SDK
+
+```sh
+cargo build
+```
+
 ## Getting Help
 
 We love to hear from you so if you have questions, comments or find a bug in the
@@ -55,4 +63,4 @@ project, let us know! You can either:
 - [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
 - [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)
 
-[license]: LICENSE.txt
+[license]: LICENSE.txt

examples/README.md

@@ -0,0 +1,21 @@
+## Running Examples
+
+### Setting Env Vars
+
+```sh
+export FILENAME=./examples/prerecorded_from_file/bueller.wav
+```
+
+### Running the examples
+
+```sh
+cargo run --example prerecorded_from_url
+```
+
+```sh
+cargo run --example simple_stream
+```
+
+```sh
+cargo run --example advanced_stream
+```

examples/callback.rs

@@ -1,9 +1,9 @@
 use std::env;
 
 use deepgram::{
-    transcription::prerecorded::{
+    transcription::{
         audio_source::AudioSource,
-        options::{Language, Options},
+        common_options::{Language, Options},
     },
     Deepgram, DeepgramError,
 };

examples/make_prerecorded_request_builder.rs

@@ -1,10 +1,10 @@
 use std::env;
 
 use deepgram::{
-    transcription::prerecorded::{
+    transcription::{
         audio_source::AudioSource,
-        options::{Language, Options},
-        response::Response,
+        common_options::{Language, Options},
+        prerecorded::response::Response,
     },
     Deepgram,
 };
@@ -41,5 +41,7 @@ async fn main() -> reqwest::Result<()> {
     let transcript = &response.results.channels[0].alternatives[0].transcript;
     println!("{}", transcript);
 
+    println!("{:?}", response);
+
     Ok(())
 }

examples/microphone_stream.rs

@@ -94,8 +94,8 @@ async fn main() -> Result<(), DeepgramError> {
     let mut results = dg
         .transcription()
         .stream_request()
+        .keep_alive()
         .stream(microphone_as_stream())
-        // TODO Enum.
         .encoding("linear16".to_string())
         // TODO Specific to my machine, not general enough example.
         .sample_rate(44100)

examples/prerecorded_from_file/main.rs

@@ -1,9 +1,9 @@
 use std::env;
 
 use deepgram::{
-    transcription::prerecorded::{
+    transcription::{
         audio_source::AudioSource,
-        options::{Language, Options},
+        common_options::{Language, Options},
     },
     Deepgram, DeepgramError,
 };
@@ -35,5 +35,7 @@ async fn main() -> Result<(), DeepgramError> {
     let transcript = &response.results.channels[0].alternatives[0].transcript;
     println!("{}", transcript);
 
+    println!("{:?}", response);
+
     Ok(())
 }

examples/prerecorded_from_url.rs

@@ -1,9 +1,9 @@
 use std::env;
 
 use deepgram::{
-    transcription::prerecorded::{
+    transcription::{
         audio_source::AudioSource,
-        options::{Language, Options},
+        common_options::{CustomIntentMode, Language, Model, Options, Redact},
     },
     Deepgram, DeepgramError,
 };
@@ -20,8 +20,29 @@ async fn main() -> Result<(), DeepgramError> {
     let source = AudioSource::from_url(AUDIO_URL);
 
     let options = Options::builder()
+        .model(Model::CustomId(String::from("nova-2-general")))
         .punctuate(true)
+        .paragraphs(true)
+        .redact([Redact::Pci, Redact::Other(String::from("cvv"))])
+        .detect_language(true)
+        .diarize(true)
+        .diarize_version("2021-07-14.0")
+        .filler_words(true)
+        .smart_format(true)
+        .encoding("linear16")
         .language(Language::en_US)
+        .detect_entities(true)
+        .intents(true)
+        .custom_intent_mode(CustomIntentMode::Extended)
+        .custom_intents(["Phone repair", "Phone cancellation"])
+        .sentiment(true)
+        .topics(true)
+        .custom_intent_mode(CustomIntentMode::Strict)
+        .custom_intents(["Get support", "Complain"])
+        .summarize("v2")
+        .dictation(true)
+        .measurements(true)
+        .extra("key:value")
         .build();
 
     let response = dg_client
@@ -32,5 +53,7 @@ async fn main() -> Result<(), DeepgramError> {
     let transcript = &response.results.channels[0].alternatives[0].transcript;
     println!("{}", transcript);
 
+    println!("{:?}", response);
+
     Ok(())
 }

examples/simple_stream.rs

@@ -3,17 +3,34 @@ use std::time::Duration;
 
 use futures::stream::StreamExt;
 
-use deepgram::{Deepgram, DeepgramError};
+use deepgram::{
+    transcription::common_options::{Language, Options},
+    Deepgram, DeepgramError,
+};
 
 #[tokio::main]
 async fn main() -> Result<(), DeepgramError> {
     let dg = Deepgram::new(env::var("DEEPGRAM_API_KEY").unwrap());
 
+    let options = Options::builder()
+        .smart_format(true)
+        .language(Language::en_US)
+        .build();
+
     let mut results = dg
         .transcription()
-        .stream_request()
+        .stream_request_with_options(Some(&options))
+        .keep_alive()
+        .encoding("linear16".to_string())
+        .sample_rate(44100)
+        .channels(2)
+        .endpointing("300".to_string())
+        .interim_results(true)
+        .utterance_end_ms(1000)
+        .vad_events(true)
+        .no_delay(true)
         .file(
-            env::var("FILENAME").unwrap(),
+            "./examples/prerecorded_from_file/bueller.wav",
             3174,
             Duration::from_millis(16),
         )

src/transcription.rs

@@ -11,6 +11,9 @@ pub mod live;
 #[cfg(feature = "prerecorded")]
 pub mod prerecorded;
 
+pub mod audio_source;
+pub mod common_options;
+
 /// Transcribe audio using Deepgram's automated speech recognition.
 ///
 /// Constructed using [`Deepgram::transcription`].
@@ -19,7 +22,7 @@ pub mod prerecorded;
 ///
 /// [api]: https://developers.deepgram.com/api-reference/#transcription
 #[derive(Debug, Clone)]
-pub struct Transcription<'a>(#[allow(unused)] &'a Deepgram);
+pub struct Transcription<'a>(&'a Deepgram);
 
 impl Deepgram {
     /// Construct a new [`Transcription`] from a [`Deepgram`].

src/transcription/prerecorded/audio_source.rs → src/transcription/audio_source.rs

@@ -8,9 +8,11 @@ use reqwest::{header::CONTENT_TYPE, RequestBuilder};
 use serde::Serialize;
 
 /// Used as a parameter for [`Transcription::prerecorded`](crate::transcription::Transcription::prerecorded) and similar functions.
+#[cfg(any(feature = "prerecorded", feature = "live"))]
 #[derive(Debug)]
 pub struct AudioSource(InternalAudioSource);
 
+#[cfg(any(feature = "prerecorded", feature = "live"))]
 #[derive(Debug)]
 enum InternalAudioSource {
     Url(String),
@@ -20,6 +22,7 @@ enum InternalAudioSource {
     },
 }
 
+#[cfg(any(feature = "prerecorded", feature = "live"))]
 impl AudioSource {
     /// Constructs an [`AudioSource`] that will instruct Deepgram to download the audio from the specified URL.
     pub fn from_url(url: impl Into<String>) -> Self {