RealtimeServerEventConversationItemInputAudioTranscriptionCompleted Class

This event is the output of audio transcription for user audio written to the user audio buffer. Transcription begins when the input audio buffer is committed by the client or server (when VAD is enabled). Transcription runs asynchronously with Response creation, so this event may come before or after the Response events. Realtime API models accept audio natively, and thus input transcription is a separate process run on a separate ASR (Automatic Speech Recognition) model. The transcript may diverge somewhat from the model's interpretation, and should be treated as a rough guide.

Constructor

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

Variables

Name	Description
event_id	str The unique ID of the server event. Required.
type	str or <xref:azure.ai.projects.models.CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_COMPLETED> The event type, must be `conversation.item.input_audio_transcription.completed`. Required. CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_COMPLETED.
item_id	str The ID of the item containing the audio that is being transcribed. Required.
content_index	int The index of the content part containing the audio. Required.
transcript	str The transcribed text. Required.
languages	list[TranscriptionLanguage] The languages detected in the audio. Returned by `gpt-transcribe`. An empty array indicates that no language could be reliably detected.
logprobs	list[LogProbProperties]
usage	TranscriptTextUsageTokens or TranscriptTextUsageDuration Usage statistics for the transcription, this is billed according to the ASR model's pricing rather than the realtime model's pricing. Required. Is either a TranscriptTextUsageTokens type or a TranscriptTextUsageDuration type.
phrases	list[VoiceAgentTranscriptionPhrase] Phrase-level transcription timing and confidence details.

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	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

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

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	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	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>) -> 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 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>) -> Any

Parameters

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) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on the mapping's values

Attributes

content_index

The index of the content part containing the audio. Required.

content_index: int

event_id

The unique ID of the server event. Required.

event_id: str

item_id

The ID of the item containing the audio that is being transcribed. Required.

item_id: str

languages

The languages detected in the audio. Returned by gpt-transcribe. An empty array indicates that no language could be reliably detected.

languages: list['_models.TranscriptionLanguage'] | None

logprobs

logprobs: list['_models.LogProbProperties'] | None

phrases

Phrase-level transcription timing and confidence details.

phrases: list['_models.VoiceAgentTranscriptionPhrase'] | None

transcript

The transcribed text. Required.

transcript: str

type

The event type, must be conversation.item.input_audio_transcription.completed. Required. CONVERSATION_ITEM_INPUT_AUDIO_TRANSCRIPTION_COMPLETED.

type: completed'>]

usage

Usage statistics for the transcription, this is billed according to the ASR model's pricing rather than the realtime model's pricing. Required. Is either a TranscriptTextUsageTokens type or a TranscriptTextUsageDuration type.

usage: _models.TranscriptTextUsageTokens | _models.TranscriptTextUsageDuration

Commenti e suggerimenti

Questa pagina è stata utile?