VoiceAgentSessionAvatarConfig Class

Avatar settings accepted by the stable voice-agent WebSocket contract.

Constructor

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

Variables

Name	Description
type	str or VoiceAgentAvatarType The avatar type. Required. Known values are: "video_avatar" and "photo_avatar".
character	str The avatar character identifier, e.g. 'lisa'. Required.
style	str The avatar style, e.g. 'casual-sitting'.
customized	bool Whether the avatar is a customer-customized avatar. Defaults to false.
output_protocol	str or VoiceAgentAvatarOutputProtocol The transport used to deliver the avatar video stream. Known values are: "webrtc" and "websocket".
model	str The avatar model identifier.
video	VoiceAgentAvatarVideoParams Avatar video encoder and presentation settings.
scene	VoiceAgentAvatarScene Avatar placement and motion settings.
output_audit_audio	bool Whether audit audio is emitted with avatar output. Defaults to false.
ice_servers	list[VoiceAgentAvatarIceServer]

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

character

The avatar character identifier, e.g. 'lisa'. Required.

character: str

customized

Whether the avatar is a customer-customized avatar. Defaults to false.

customized: bool | None

ice_servers

ice_servers: list['_models.VoiceAgentAvatarIceServer'] | None

model

The avatar model identifier.

model: str | None

output_audit_audio

Whether audit audio is emitted with avatar output. Defaults to false.

output_audit_audio: bool | None

output_protocol

"webrtc" and "websocket".

output_protocol: str | '_models.VoiceAgentAvatarOutputProtocol' | None

scene

Avatar placement and motion settings.

scene: '_models.VoiceAgentAvatarScene' | None

style

The avatar style, e.g. 'casual-sitting'.

style: str | None

type

"video_avatar" and "photo_avatar".

type: str | '_models.VoiceAgentAvatarType'

video

Avatar video encoder and presentation settings.

video: '_models.VoiceAgentAvatarVideoParams' | None