Conversation Text

The ConversationText message is a JSON message that will be sent as a user interacts with the agent.

Purpose

The ConversationText message facilitates real-time communication by relaying spoken statements from both the user and the assistant. This ensures that the conversation can be dynamically displayed on the client side, enhancing transparency and providing a clear, synchronized view of the interaction as it unfolds.

Example Payload

The server will send a ConversationText message every time the agent hears the user say something, and every time the agent speaks something. These can be used on the client side to display the conversation messages as they happen in real-time.

1
{
2
  "type": "ConversationText",
3
  "role": "", // The speaker of this statement, either "user" or "assistant"
4
  "content": "" // The statement that was spoken
5
}