RealtimeServerEvent Class
A realtime server event.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: RealtimeServerEventConversationItemAdded, RealtimeServerEventConversationItemCreated, RealtimeServerEventConversationItemDeleted, RealtimeServerEventConversationItemDone, RealtimeServerEventConversationItemInputAudioTranscriptionCompleted, RealtimeServerEventConversationItemInputAudioTranscriptionDelta, RealtimeServerEventConversationItemInputAudioTranscriptionFailed, RealtimeServerEventConversationItemInputAudioTranscriptionSegment, RealtimeServerEventConversationItemRetrieved, RealtimeServerEventConversationItemTruncated, RealtimeServerEventInputAudioBufferCleared, RealtimeServerEventInputAudioBufferCommitted, RealtimeServerEventInputAudioBufferSpeechStarted, RealtimeServerEventInputAudioBufferSpeechStopped, RealtimeServerEventInputAudioBufferTimeoutTriggered, RealtimeServerEventMCPListToolsCompleted, RealtimeServerEventMCPListToolsFailed, RealtimeServerEventMCPListToolsInProgress, RealtimeServerEventOutputAudioBufferCleared, RealtimeServerEventRateLimitsUpdated, VoiceAgentServerEventResponseAnimationBlendshapesDelta, VoiceAgentServerEventResponseAnimationBlendshapesDone, VoiceAgentServerEventResponseAnimationVisemeDelta, VoiceAgentServerEventResponseAnimationVisemeDone, VoiceAgentServerEventResponseAudioTimestampDelta, VoiceAgentServerEventResponseAudioTimestampDone, RealtimeServerEventResponseContentPartAdded, RealtimeServerEventResponseContentPartDone, RealtimeServerEventResponseCreated, RealtimeServerEventResponseDone, RealtimeServerEventResponseFunctionCallArgumentsDelta, RealtimeServerEventResponseFunctionCallArgumentsDone, RealtimeServerEventResponseMCPCallCompleted, RealtimeServerEventResponseMCPCallFailed, RealtimeServerEventResponseMCPCallInProgress, RealtimeServerEventResponseMCPCallArgumentsDelta, RealtimeServerEventResponseMCPCallArgumentsDone, RealtimeServerEventResponseAudioDelta, RealtimeServerEventResponseAudioDone, RealtimeServerEventResponseAudioTranscriptDelta, RealtimeServerEventResponseAudioTranscriptDone, RealtimeServerEventResponseOutputItemAdded, RealtimeServerEventResponseOutputItemDone, RealtimeServerEventResponseTextDelta, RealtimeServerEventResponseTextDone, VoiceAgentServerEventResponseVideoDelta, VoiceAgentServerEventRtcCallError, VoiceAgentServerEventRtcCallSdpCreated, VoiceAgentServerEventSessionAvatarConnecting, VoiceAgentServerEventSessionAvatarSwitchToIdle, VoiceAgentServerEventSessionAvatarSwitchToSpeaking, RealtimeServerEventSessionCreated, VoiceAgentServerEventSessionSubagentAborted, VoiceAgentServerEventSessionSubagentCompleted, VoiceAgentServerEventSessionSubagentStarted, RealtimeServerEventSessionUpdated, VoiceAgentServerEventWarning
Constructor
RealtimeServerEvent(*args: Any, **kwargs: Any)Variables
| Name | Description |
|---|---|
|
type
|
Required. Known values are: "conversation.created", "conversation.item.created", "conversation.item.deleted", "conversation.item.input_audio_transcription.completed", "conversation.item.input_audio_transcription.delta", "conversation.item.input_audio_transcription.failed", "conversation.item.retrieved", "conversation.item.truncated", "error", "input_audio_buffer.cleared", "input_audio_buffer.committed", "input_audio_buffer.dtmf_event_received", "input_audio_buffer.speech_started", "input_audio_buffer.speech_stopped", "rate_limits.updated", "response.output_audio.delta", "response.output_audio.done", "response.output_audio_transcript.delta", "response.output_audio_transcript.done", "response.content_part.added", "response.content_part.done", "response.created", "response.done", "response.function_call_arguments.delta", "response.function_call_arguments.done", "response.output_item.added", "response.output_item.done", "response.output_text.delta", "response.output_text.done", "session.created", "session.updated", "output_audio_buffer.started", "output_audio_buffer.stopped", "output_audio_buffer.cleared", "conversation.item.added", "conversation.item.done", "input_audio_buffer.timeout_triggered", "conversation.item.input_audio_transcription.segment", "mcp_list_tools.in_progress", "mcp_list_tools.completed", "mcp_list_tools.failed", "response.mcp_call_arguments.delta", "response.mcp_call_arguments.done", "response.mcp_call.in_progress", "response.mcp_call.completed", "response.mcp_call.failed", "warning", "session.subagent.started", "session.subagent.completed", "session.subagent.aborted", "session.avatar.connecting", "session.avatar.switch_to_speaking", "session.avatar.switch_to_idle", "rtc.call.sdp.created", "rtc.call.error", "response.audio_timestamp.delta", "response.audio_timestamp.done", "response.animation_blendshapes.delta", "response.animation_blendshapes.done", "response.animation_viseme.delta", "response.animation_viseme.done", and "response.video.delta". |
Methods
| as_dict |
Return a dict that can be turned into json using json.dump. |
| clear |
Remove all items from the dictionary. |
| copy | |
| get |
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any |
| items | |
| keys | |
| pop |
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given. |
| popitem |
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty. |
| setdefault |
Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any |
| update |
Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs. |
| values |
as_dict
Return a dict that can be turned into json using json.dump.
as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]Keyword-Only Parameters
| Name | Description |
|---|---|
|
exclude_readonly
|
Whether to remove the readonly properties. Default value: False
|
Returns
| Type | Description |
|---|---|
|
A dict JSON compatible object |
clear
Remove all items from the dictionary.
clear() -> Nonecopy
copy() -> Modelget
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any
get(key: str, default: Any = None) -> AnyParameters
| Name | Description |
|---|---|
|
key
Required
|
|
|
default
|
Default value: None
|
items
items() -> ItemsView[str, Any]Returns
| Type | Description |
|---|---|
|
a set-like object providing a view on the mapping's items |
keys
keys() -> KeysView[str]Returns
| Type | Description |
|---|---|
|
a set-like object providing a view on the mapping's keys |
pop
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
pop(key: str, default: ~typing.Any = <object object>) -> AnyParameters
| Name | Description |
|---|---|
|
key
Required
|
|
|
default
|
|
popitem
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.
popitem() -> tuple[str, Any]setdefault
Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
setdefault(key: str, default: ~typing.Any = <object object>) -> AnyParameters
| Name | Description |
|---|---|
|
key
Required
|
|
|
default
|
|
update
Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.
update(*args: Any, **kwargs: Any) -> Nonevalues
values() -> ValuesView[Any]Returns
| Type | Description |
|---|---|
|
an object providing a view on the mapping's values |
Attributes
type
"conversation.created", "conversation.item.created", "conversation.item.deleted", "conversation.item.input_audio_transcription.completed", "conversation.item.input_audio_transcription.delta", "conversation.item.input_audio_transcription.failed", "conversation.item.retrieved", "conversation.item.truncated", "error", "input_audio_buffer.cleared", "input_audio_buffer.committed", "input_audio_buffer.dtmf_event_received", "input_audio_buffer.speech_started", "input_audio_buffer.speech_stopped", "rate_limits.updated", "response.output_audio.delta", "response.output_audio.done", "response.output_audio_transcript.delta", "response.output_audio_transcript.done", "response.content_part.added", "response.content_part.done", "response.created", "response.done", "response.function_call_arguments.delta", "response.function_call_arguments.done", "response.output_item.added", "response.output_item.done", "response.output_text.delta", "response.output_text.done", "session.created", "session.updated", "output_audio_buffer.started", "output_audio_buffer.stopped", "output_audio_buffer.cleared", "conversation.item.added", "conversation.item.done", "input_audio_buffer.timeout_triggered", "conversation.item.input_audio_transcription.segment", "mcp_list_tools.in_progress", "mcp_list_tools.completed", "mcp_list_tools.failed", "response.mcp_call_arguments.delta", "response.mcp_call_arguments.done", "response.mcp_call.in_progress", "response.mcp_call.completed", "response.mcp_call.failed", "warning", "session.subagent.started", "session.subagent.completed", "session.subagent.aborted", "session.avatar.connecting", "session.avatar.switch_to_speaking", "session.avatar.switch_to_idle", "rtc.call.sdp.created", "rtc.call.error", "response.audio_timestamp.delta", "response.audio_timestamp.done", "response.animation_blendshapes.delta", "response.animation_blendshapes.done", "response.animation_viseme.delta", "response.animation_viseme.done", and "response.video.delta".
type: str