Participant Class
An object that represents conversation participant.
Constructor
Participant(user_id: str, preferred_language: str, voice_signature: str | None = None)
Parameters
| Name | Description |
|---|---|
|
user_id
Required
|
The user identification string. |
|
preferred_language
Required
|
The preferred language of user in BCP-47 format. |
|
voice_signature
|
User's voice signature (optional). Default value: None
|
Methods
| set_preferred_language |
Sets the preferred language of the participant |
| set_voice_signature |
Sets the voice signature of the participant used for identification. |
set_preferred_language
Sets the preferred language of the participant
set_preferred_language(language: str) -> None
Parameters
| Name | Description |
|---|---|
|
language
Required
|
The language in BCP-47 format. |
set_voice_signature
Sets the voice signature of the participant used for identification.
set_voice_signature(signature: str) -> None
Parameters
| Name | Description |
|---|---|
|
signature
Required
|
The language in BCP-47 format. |
Attributes
participant_id
Get the identifier for the participant.
properties
A collection of properties and their values defined for this Participant.