Public Member Functions
	Message ()=default
	An empty message.

	Message (MessageType type, nlohmann::json data=nullptr)
	A message of `type` with `data`, and a new random ID.

Static Public Member Functions
static Message	client_ready (const AboutClientData &about)
	A message that says the client is ready, with information about it.

static Message	disconnect_bot ()
	A message that asks the bot to leave.

static Message	client_message (const std::string &type, const nlohmann::json &data)
	An app-defined message to the bot.

static Message	send_text (const std::string &content, const SendTextOptions &options={})
	Text for the bot's LLM.

static Message	dtmf (const std::string &buttons)
	One or more DTMF keys (0-9, * and #), for bots on RTVI 2.1 or newer.

static Message	llm_function_call_result (const LLMFunctionCallResultData &data)
	The result of a function call.

Public Attributes
std::string	id
	ID of the message. Answers have the request's ID.

std::string	label = MESSAGE_LABEL
	Always "rtvi-ai".

std::string	type
	Type of the message, e.g. "bot-ready".

nlohmann::json	data
	Data of the message. Null if it has none.

Detailed Description

An RTVI message.

PipecatClient creates and sends messages for you. You only need these to write a transport, or to read messages the client doesn't handle.

The documentation for this struct was generated from the following file:

Public Member Functions