Interactions Protocol

Utterance Event

This is an event broadcasted by Tavus.

An utterance contains the content of the what was spoken and an indication of who spoke it (i.e. the user or replica). Each utterance event includes all of the words spoken by the user or replica measured from when the person started speaking to when they finished speaking. This could include multiple sentences or phrases.

Utterance events can be used to keep track of what the user or the replica has said.

To track when how long an utterance lasts, please refer to duration in “User Started/Stopped Speaking” and “Replica Started/Stopped Speaking” events.

message_type

string

Message type indicates what product this event will be used for. In this case, the message_type will be conversation

Example:

"conversation"

event_type

string

This is the type of event that is being sent back. This field will be present on all events and can be used to distinguish between different event types.

Example:

"conversation.utterance"

conversation_id

string

The unique identifier for the conversation.

Example:

"c123456"

inference_id

string

This is a unique identifier for a given utterance. In this case, it will be the utterance the replica is speaking.

Example:

"83294d9f-8306-491b-a284-791f56c8383f"

properties

object

This object will contain the speech property which contains the contents of the utterance and will optionally contain the visual_context property.

Show child attributes

properties.speech

string

required

The content of the utterance.

Example:

"Hello, how are you?"

properties.role

string

Indicicates who spoke the utterance. Possible values: user, replica.

Example:

"user"

properties.visual_context

string

If VQA is enabled for the conversation, visual_context will contain the description of the user frame. This property will not be included in every utterance event. It will only be included when a visual frame has been captured which occurs every 4 seconds.

Example:

"There is a man wearing over-ear headphones in a room that seems to be in an office setting, with monitors in the background. The man seems happy, and is looking at the screen."

Append Conversational Context Interaction Tool Call Event

⌘I

Getting Started

Conversational Video Interface

Replica

Video Generation

Resources

Utterance Event