VoiceAgentEvents
Constants
AgentAudioDone
Get signals that the server has finished sending the final audio segment to the client. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1AgentAudioDone
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
AgentThinking
Informs the client when the agent is processing information. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1AgentThinking
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
ConnectorInformation
Contains information about connector.
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
ConversationText
Facilitates real-time communication by relaying spoken statements from both the user and the agent. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1ConversationText
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
Error
Receive errors from the server if an issue has occurred. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1Error
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
FunctionCallRequest
Server-initiated message requesting a function call, to be handled by either client or server. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1FunctionCallRequest
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
FunctionCallResponse
Message containing the result of a function call, sent by client or server. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1ReceiveFunctionCallResponse
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
HTTPResponse
The HTTP response event.
Parameters
client:
The ElevenLabs.AgentsClient instance.
data:
Object
OptionalThe event's data.
History
Provide conversation and function call history when starting a new Voice Agent session. https://developers.deepgram.com/docs/voice-agent-history
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
PromptUpdated
Confirms that a Prompt Configuration change has been applied. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1PromptUpdated
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
SettingsApplied
Confirms the server has successfully received and applied the Settings message. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1SettingsApplied
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
SpeakUpdated
Confirms that a Speak Configuration change has been applied. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1SpeakUpdated
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
Unknown
The unknown event.
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
UserStartedSpeaking
Notifies the client that the user has begun speaking. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1UserStartedSpeaking
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
Warning
Receive warnings from the server if an issue has occurred. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1Warning
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.
WebSocketError
The WebSocket error response event.
Parameters
client:
The ElevenLabs.AgentsClient instance.
data:
Object
OptionalThe event's data.
Welcome
Receive a welcome message from the server to confirm the websocket has opened. https://developers.deepgram.com/reference/voice-agent/voice-agent#receive.AgentV1Welcome
Parameters
client:
The Deepgram.VoiceAgentClient instance.
data:
Object
OptionalThe event's data.