/** * @example * { * appid: "appid", * agentId: "agentId", * text: "Sorry, the conversation content is not compliant.", * priority: "INTERRUPT", * interruptable: false * } */ export interface SpeakAgentsRequest { /** The App ID of the project. */ appid: string; /** The agent instance ID you obtained after successfully calling `join` to start a conversational AI agent. */ agentId: string; /** The broadcast message text. The maximum length of the text content is 512 bytes. */ text: string; /** * Sets the priority of the message broadcast: * - `INTERRUPT`: High priority. The agent immediately interrupts the current interaction to announce the message. * - `APPEND`: Medium priority. The agent announces the message after the current interaction ends. * - `IGNORE`: Low priority. If the agent is busy interacting, it ignores and discards the broadcast; the message is only announced if the agent is not interacting. */ priority?: SpeakAgentsRequest.Priority; /** * Whether to allow users to interrupt the agent's broadcast by speaking: * - `true`: Allow * - `false`: Don't allow */ interruptable?: boolean; } export declare namespace SpeakAgentsRequest { /** * Sets the priority of the message broadcast: * - `INTERRUPT`: High priority. The agent immediately interrupts the current interaction to announce the message. * - `APPEND`: Medium priority. The agent announces the message after the current interaction ends. * - `IGNORE`: Low priority. If the agent is busy interacting, it ignores and discards the broadcast; the message is only announced if the agent is not interacting. */ const Priority: { readonly Interrupt: "INTERRUPT"; readonly Append: "APPEND"; readonly Ignore: "IGNORE"; }; type Priority = (typeof Priority)[keyof typeof Priority]; }