deepgram 0.14.0

Community Rust SDK for Deepgram's automated speech recognition APIs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

//! Voice Agent (`/v1/agent/converse`) types.
//!
//! It contains:
//!
//! - [`endpoint::Endpoint`] — custom LLM/TTS endpoint URL + headers.
//! - [`aws_credentials::AwsCredentials`] — credential block shared by AWS Bedrock (Think) and AWS Polly (Speak).
//! - [`audio`] — `AudioConfig`, `AudioInput`, `AudioOutput`, encodings,
//!   and container for the `audio` block on `Settings`.
//! - [`listen`] — `AgentListenSettings` and the V1/V2 Deepgram STT
//!   provider sub-types.
//! - [`think`] — `ThinkSettings` and the five Think provider variants
//!   (OpenAI, Anthropic, AWS Bedrock, Google, Groq).
//! - [`speak`] — `SpeakSettings` and the five Speak provider variants
//!   (Deepgram, ElevenLabs, Cartesia, OpenAI, AWS Polly).
//! - [`history`] — `HistoryMessage` (conversation + function-call history)
//!   used by `agent.context.messages[]` and the server-emitted `History` event.
//! - [`settings`] — top-level `SettingsMessage` and the `AgentConfig`
//!   oneOf (`Inline(InlineAgentConfig)` vs. `Saved(Uuid)`).
//! - [`messages`] — the remaining client-to-server messages
//!   (`UpdateListen`, `UpdateSpeak`, `UpdateThink`, `UpdatePrompt`,
//!   `InjectUserMessage`, `InjectAgentMessage`, `FunctionCallResponse`,
//!   `KeepAlive`, `ForceEndTurn`) plus the `ClientMessage` discriminated
//!   union over all ten.
//! - [`response`] — every server-emitted JSON event (`Welcome`,
//!   `SettingsApplied`, `ConversationText`, `UserStartedSpeaking`,
//!   `AgentThinking`, `FunctionCallRequest`, `FunctionCallCancelled`,
//!   `AgentStartedSpeaking`, `AgentAudioDone`, `Error`, `Warning`,
//!   `History`, `LatencyReport`, `ListenUpdated`, `PromptUpdated`,
//!   `SpeakUpdated`, `ThinkUpdated`, `InjectionRefused`,
//!   `FunctionCallResponse`) plus an `Unknown` catch-all for forward
//!   compatibility, all unified under the [`response::AgentResponse`] enum.
//!   Dispatch is on the event's `type`, so `AgentResponse::Unknown` holds
//!   exactly the *events* this SDK does not model; a recognized event
//!   with a malformed payload is an error on the stream, never a silent
//!   `Unknown`. A recognized event carrying an *unrecognized value* is
//!   neither: it stays on the happy path through that value's own
//!   catch-all. A `role` this release does not name, on `ConversationText`
//!   or `History`, arrives as
//!   [`ConversationRole::Unknown(String)`](history::ConversationRole::Unknown)
//!   holding the wire string verbatim, and a history entry matching
//!   neither modeled shape as
//!   [`HistoryMessage::Unknown(serde_json::Value)`](history::HistoryMessage::Unknown).
//!   So a new server enum value never ends a session.
//! - [`websocket`] — the [`Agent`] sub-client and live-session
//!   primitives ([`AgentHandle`], [`AgentEventStream`], [`AgentEvent`])
//!   that connect to `wss://agent.deepgram.com/v1/agent/converse`.
//!   `start_at_url` requires TLS (`wss://`) except for loopback hosts.
//!
//! `Debug` output for [`AwsCredentials`], [`Endpoint`], and
//! [`FunctionEndpoint`] redacts secrets (AWS keys/tokens and header
//! values), so a `Settings` value can be logged safely.
//!
//! Wire format matches the AsyncAPI schemas in `deepgram-docs` under
//! `api/specs/asyncapi/schemas/agent/`. See the `simple_agent` and
//! `function_calling` examples for end-to-end usage.

pub mod audio;
pub mod aws_credentials;
pub mod endpoint;
pub mod history;
pub mod listen;
pub mod messages;
pub mod response;
pub mod settings;
pub mod speak;
pub mod think;
pub mod websocket;

pub use audio::{
    AudioConfig, AudioContainer, AudioInput, AudioInputEncoding, AudioOutput, AudioOutputEncoding,
};
pub use aws_credentials::{AwsCredentials, AwsCredentialsType};
pub use endpoint::Endpoint;
pub use history::{
    ConversationHistoryMessage, ConversationRole, FunctionCallHistoryMessage, HistoryFunctionCall,
    HistoryMessage, HistoryMessageType,
};
pub use listen::{
    AgentListenProvider, AgentListenSettings, DeepgramListenV1Provider, DeepgramListenV1Version,
    DeepgramListenV2Provider, DeepgramListenV2Version, DeepgramProviderType,
};
pub use messages::{
    ClientMessage, ForceEndTurnMessage, ForceEndTurnType, FunctionCallResponseMessage,
    FunctionCallResponseType, InjectAgentBehavior, InjectAgentMessageMessage,
    InjectAgentMessageType, InjectUserMessageMessage, InjectUserMessageType, KeepAliveMessage,
    KeepAliveType, UpdateListenMessage, UpdateListenType, UpdatePromptMessage, UpdatePromptType,
    UpdateSpeakMessage, UpdateSpeakType, UpdateThinkMessage, UpdateThinkType,
};
pub use response::{
    AgentAudioDoneEvent, AgentAudioDoneType, AgentFunctionCall, AgentResponse,
    AgentStartedSpeakingEvent, AgentStartedSpeakingType, AgentThinkingEvent, AgentThinkingType,
    CancelledFunctionCall, ConversationTextEvent, ConversationTextType, ErrorEvent, ErrorType,
    FunctionCallCancelledEvent, FunctionCallCancelledType, FunctionCallRequestEvent,
    FunctionCallRequestType, InjectionRefusedEvent, InjectionRefusedType, LatencyReportEvent,
    LatencyReportType, ListenUpdatedEvent, ListenUpdatedType, PromptUpdatedEvent,
    PromptUpdatedType, SettingsAppliedEvent, SettingsAppliedType, SpeakUpdatedEvent,
    SpeakUpdatedType, ThinkUpdatedEvent, ThinkUpdatedType, UserStartedSpeakingEvent,
    UserStartedSpeakingType, WarningEvent, WarningType, WelcomeEvent, WelcomeType,
};
pub use settings::{
    AgentConfig, AgentContext, InlineAgentConfig, SettingsFlags, SettingsMessage,
    SettingsMessageType,
};
pub use speak::{SpeakProvider, SpeakSettings};
pub use think::{ContextLength, FunctionEndpoint, ThinkFunction, ThinkProvider, ThinkSettings};
pub use websocket::{Agent, AgentEvent, AgentEventStream, AgentHandle, InsecureAgentUrl};