Udostępnij przez

ServerEvent Class

A voicelive server event.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ServerEventConversationItemCreated, ServerEventConversationItemDeleted, ServerEventConversationItemInputAudioTranscriptionCompleted, ServerEventConversationItemInputAudioTranscriptionDelta, ServerEventConversationItemInputAudioTranscriptionFailed, ServerEventConversationItemRetrieved, ServerEventConversationItemTruncated, ServerEventError, ServerEventInputAudioBufferCleared, ServerEventInputAudioBufferCommitted, ServerEventInputAudioBufferSpeechStarted, ServerEventInputAudioBufferSpeechStopped, ServerEventResponseAnimationBlendshapeDelta, ServerEventResponseAnimationBlendshapeDone, ServerEventResponseAnimationVisemeDelta, ServerEventResponseAnimationVisemeDone, ServerEventResponseAudioDelta, ServerEventResponseAudioDone, ServerEventResponseAudioTimestampDelta, ServerEventResponseAudioTimestampDone, ServerEventResponseAudioTranscriptDelta, ServerEventResponseAudioTranscriptDone, ServerEventResponseContentPartAdded, ServerEventResponseContentPartDone, ServerEventResponseCreated, ServerEventResponseDone, ServerEventResponseFunctionCallArgumentsDelta, ServerEventResponseFunctionCallArgumentsDone, ServerEventResponseOutputItemAdded, ServerEventResponseOutputItemDone, ServerEventResponseTextDelta, ServerEventResponseTextDone, ServerEventSessionAvatarConnecting, ServerEventSessionCreated, ServerEventSessionUpdated

Constructor

ServerEvent(*args: Any, **kwargs: Any)

Variables

Name Description
type
str or ServerEventType

The type of event. Required. Known values are: "error", "session.avatar.connecting", "session.created", "session.updated", "conversation.item.input_audio_transcription.completed", "conversation.item.input_audio_transcription.delta", "conversation.item.input_audio_transcription.failed", "conversation.item.created", "conversation.item.retrieved", "conversation.item.truncated", "conversation.item.deleted", "input_audio_buffer.committed", "input_audio_buffer.cleared", "input_audio_buffer.speech_started", "input_audio_buffer.speech_stopped", "response.created", "response.done", "response.output_item.added", "response.output_item.done", "response.content_part.added", "response.content_part.done", "response.text.delta", "response.text.done", "response.audio_transcript.delta", "response.audio_transcript.done", "response.audio.delta", "response.audio.done", "response.animation_blendshapes.delta", "response.animation_blendshapes.done", "response.audio_timestamp.delta", "response.audio_timestamp.done", "response.animation_viseme.delta", "response.animation_viseme.done", "response.function_call_arguments.delta", and "response.function_call_arguments.done".
event_id
str

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear

Remove all items from D.
copy
deserialize
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: D[k] if k in D, else d. :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 D is empty.
setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update

Updates D from mapping/iterable E and F. :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
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy 

copy() -> Model

deserialize 

deserialize(payload: dict[str, Any]) -> ServerEvent

Parameters

Name Description
payload
Required

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: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

Returns

Type Description
ItemsView

set-like object providing a view on D's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

a set-like object providing a view on D'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>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Returns

Type Description
ValuesView

an object providing a view on D's values

Attributes

event_id 

event_id: str | None

type

"error", "session.avatar.connecting", "session.created", "session.updated", "conversation.item.input_audio_transcription.completed", "conversation.item.input_audio_transcription.delta", "conversation.item.input_audio_transcription.failed", "conversation.item.created", "conversation.item.retrieved", "conversation.item.truncated", "conversation.item.deleted", "input_audio_buffer.committed", "input_audio_buffer.cleared", "input_audio_buffer.speech_started", "input_audio_buffer.speech_stopped", "response.created", "response.done", "response.output_item.added", "response.output_item.done", "response.content_part.added", "response.content_part.done", "response.text.delta", "response.text.done", "response.audio_transcript.delta", "response.audio_transcript.done", "response.audio.delta", "response.audio.done", "response.animation_blendshapes.delta", "response.animation_blendshapes.done", "response.audio_timestamp.delta", "response.audio_timestamp.done", "response.animation_viseme.delta", "response.animation_viseme.done", "response.function_call_arguments.delta", and "response.function_call_arguments.done".

type: str