RealtimeAPIEvents
Constants
ConnectorInformation
Contains information about connector.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ConversationItemCreated
Returned when a new Item is created in the Conversation.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ConversationItemDeleted
Returned when an item in the conversation is deleted by the client with a conversation.item.delete event.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ConversationItemInputAudioTranscriptionCompleted
This event is the output of audio transcription for user audio written to the user audio buffer.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ConversationItemInputAudioTranscriptionDelta
Returned when the text value of an input audio transcription content part is updated with incremental transcription results.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ConversationItemInputAudioTranscriptionFailed
Returned when input audio transcription is configured, and a transcription request for a user message failed.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ConversationItemInputAudioTranscriptionSegment
Returned when an input audio transcription segment is identified for an item.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ConversationItemRetrieved
Returned when a conversation item is retrieved with conversation.item.retrieve.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ConversationItemTruncated
Returned when an earlier assistant audio message item is truncated by the client with a conversation.item.truncate event.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
Error
Returned when an error occurs, which could be a client problem or a server problem.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
HTTPResponse
The HTTP response event.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
InputAudioBufferCleared
Returned when the input audio buffer is cleared by the client with an input_audio_buffer.clear event.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
InputAudioBufferCommitted
Returned when an input audio buffer is committed.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
InputAudioBufferSpeechStarted
Sent by the server when in server_vad mode to indicate that speech has been detected in the audio buffer.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
InputAudioBufferSpeechStopped
Returned in server_vad mode when the server detects the end of speech in the audio buffer.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
InputAudioBufferTimeoutTriggered
Returned when the Server VAD timeout is triggered for the input audio buffer.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
MCPListToolsCompleted
Returned when listing MCP tools has completed for an item.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
MCPListToolsFailed
Returned when listing MCP tools has failed for an item.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
MCPListToolsInProgress
Returned when listing MCP tools is in progress for an item.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
RateLimitsUpdated
Emitted at the beginning of a Response to indicate the updated rate limits.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseContentPartAdded
Returned when a new content part is added to an assistant message item during response generation.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseContentPartDone
Returned when a content part is done streaming in an assistant message item.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseCreated
Returned when a new Response is created.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseDone
Returned when a Response is done streaming.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseFunctionCallArgumentsDelta
Returned when the model-generated function call arguments are updated.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseFunctionCallArgumentsDone
Returned when the model-generated function call arguments are done streaming.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseMCPCallArgumentsDelta
Returned when MCP tool call arguments are updated during response generation.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseMCPCallArgumentsDone
Returned when MCP tool call arguments are finalized during response generation.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseMCPCallCompleted
Returned when an MCP tool call has completed successfully.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseMCPCallFailed
Returned when an MCP tool call has failed.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseMCPCallInProgress
Returned when an MCP tool call has started and is in progress.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseOutputAudioDone
Returned when the model-generated audio is done.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseOutputAudioTranscriptDelta
Returned when the model-generated transcription of audio output is updated.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseOutputAudioTranscriptDone
Returned when the model-generated transcription of audio output is done streaming.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseOutputItemAdded
Returned when a new Item is created during Response generation.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseOutputItemDone
Returned when an Item is done streaming.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseOutputTextDelta
Returned when the text value of an "output_text" content part is updated.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
ResponseOutputTextDone
Returned when the text value of an "output_text" content part is done streaming.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
SessionCreated
Returned when a Session is created.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
SessionUpdated
Returned when a session is updated with a session.update event, unless there is an error.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
Unknown
The unknown event.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.
WebSocketError
The WebSocket error response event.
Parameters
client:
The Yandex.RealtimeAPIClient instance.
data:
Object
OptionalThe event's data.