VoiceAudioItem Class

Metadata for a single conversation item's audio segment. For bring-your-own-storage (BYOS), the response includes blob_uri, a direct customer-storage URI without a SAS token, that the customer accesses with their own credentials. For Foundry-managed storage, blob_uri is absent and the bytes are streamed through the item's /audio/content route.

Constructor

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

Variables

Name	Description
conversation_id	str The id of the conversation the item belongs to. Required.
item_id	str The id of the item this audio belongs to. Required.
role	str or VoiceAudioRole The role the audio belongs to. Known values are: "user" and "agent".
format	str or VoiceAudioContainerFormat The container format of the audio. "wav"
codec	str or VoiceAudioCodec The audio codec. Known values are: "pcm16", "pcmu", and "pcma".
sample_rate	int The sample rate in Hz.
channels	int The number of audio channels.
start_offset_ms	timedelta The offset from the session start at which this segment begins.
duration_ms	timedelta The duration of the audio segment.
blob_uri	str For bring-your-own-storage (BYOS) recordings only: the URI of the recording in the customer's own storage, without a SAS token. The customer downloads it using their own storage credentials. Absent for Foundry-managed storage, where the bytes are streamed via the item's /audio/content route instead.

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

blob_uri

the URI of the recording in the customer's own storage, without a SAS token. The customer downloads it using their own storage credentials. Absent for Foundry-managed storage, where the bytes are streamed via the item's /audio/content route instead.

blob_uri: str | None

channels

The number of audio channels.

channels: int | None

codec

"pcm16", "pcmu", and "pcma".

codec: str | _models.VoiceAudioCodec | None

conversation_id

The id of the conversation the item belongs to. Required.

conversation_id: str

duration_ms

The duration of the audio segment.

duration_ms: timedelta | None

format

The container format of the audio. "wav"

format: str | _models.VoiceAudioContainerFormat | None

item_id

The id of the item this audio belongs to. Required.

item_id: str

role

"user" and "agent".

role: str | _models.VoiceAudioRole | None

sample_rate

The sample rate in Hz.

sample_rate: int | None

start_offset_ms

The offset from the session start at which this segment begins.

start_offset_ms: timedelta | None