qi8dZddlmZmZmZmZmZddlmZddl m Z dZ dZ edZ GddeZGd d eZGd d eZGd deZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGdd eZGd!d"eZGd#d$eZGd%d&eZGd'd(eZGd)d*eZGd+d,eZ Gd-d.eZ!Gd/d0eZ"Gd1d2eZ#Gd3d4eZ$Gd5d6eZ%Gd7d8eZ&Gd9d:eZ'Gd;deZ)Gd?d@eZ*GdAdBeZ+GdCdDeZ,GdEdFe,Z-GdGdHeZ.GdIdJeZ/GdKdLeZ0GdMdNeZ1GdOdPeZ2GdQdReZ3GdSdTeZ4GdUdVeZ5GdWdXeZ6GdYdZeZ7Gd[d\eZ8Gd]d^eZ9Gd_d`eZ:GdadbeZ;GdcddeZ<GdedfeZ=GdgdheZ>GdidjeZ?GdkdleZ@GdmdneZAGdodpeZByq)raCRTVI protocol v1 message models. Contains all RTVI protocol v1 message definitions and data structures. Import this module under the ``RTVI`` alias to use as a namespace:: import pipecat.processors.frameworks.rtvi.models as RTVI msg = RTVI.BotReady(id="1", data=RTVI.BotReadyData(version=RTVI.PROTOCOL_VERSION)) )AnyDictLiteralMappingOptional) BaseModel)AggregationTypez1.2.0zrtvi-aicReZdZUdZeZeed<eed<eed<dZ e e ee fed<y)MessagezaBase RTVI message structure. Represents the standard format for RTVI protocol messages. labeltypeidNdata) __name__ __module__ __qualname____doc__ MESSAGE_LABELr MessageLiteral__annotations__strrrrr[/opt/pipecat/venv/lib/python3.12/site-packages/pipecat/processors/frameworks/rtvi/models.pyr r (s4 *E>) I G%)D(4S> ")rr c0eZdZUdZeed<dZeeed<y)RawClientMessageDatazEData structure expected from client messages sent to the RTVI server.tNd rrrrrrrrrrrrrr7sO FAx}rrc:eZdZUdZeed<eed<dZeeed<y) ClientMessagez9Cleansed data structure for client messages for handling.msg_idr Nr) rrrrrrrrrrrrr!r!>sC K ID(3-rr!c0eZdZUdZeed<dZeeed<y)RawServerResponseDataz7Data structure for server responses to client messages.rNrrrrrr$r$FsA FAx}rr$cHeZdZUdZeZeed<dZe ded<e ed<e ed<y)ServerResponsezThe RTVI-formatted message response from the server to the client. This message is used to respond to custom messages sent by the client. r zserver-responser rrN) rrrrrr rrr rrr$rrrr&r&Ms. *E>)'8D'# $8 G rr&cleZdZUdZeed<dZeeed<dZeeed<dZ eeed<dZ ee ed<y)AboutClientDatazData about the RTVI client. Contains information about the client, including which RTVI library it is using, what platform it is on and any additional details, if available. libraryNlibrary_versionplatformplatform_versionplatform_details) rrrrrrr*rr+r,r-rrrrr(r(YsH L%)OXc])"Hhsm"&*hsm*&*hsm*rr(c&eZdZUdZeed<eed<y)ClientReadyDatazjData format of client ready messages. Contains the RTVI protocol version and client information. versionaboutN)rrrrrrr(rrrr/r/gs L rr/ceZdZUdZeed<y)ErrorResponseDatazaData for an RTVI error response. Contains the error message to send back to the client. errorNrrrrrrrrrr3r3ts Jrr3cHeZdZUdZeZeed<dZe ded<e ed<e ed<y) ErrorResponsezqRTVI error response message. RTVI formatted error response message for relaying failed client requests. r zerror-responser rrN) rrrrrr rrr rrr3rrrr7r7}s. *E>)&6D'" #6 G rr7c&eZdZUdZeed<eed<y) ErrorDataz`Data for an RTVI error event. Contains error information including whether it's fatal. r4fatalNrrrrrrboolrrrr9r9s J Krr9c>eZdZUdZeZeed<dZe ded<e ed<y)ErrorzeRTVI error event message. RTVI formatted error message for relaying errors in the pipeline. r r4r rN) rrrrrr rrr rr9rrrr>r>s' *E>)$D'' $ Orr>c:eZdZUdZeed<dZeeee fed<y) BotReadyDataz_Data for bot ready notification. Contains protocol version and initial configuration. r0Nr1) rrrrrrr1rrrrrrr@r@s& L)-E8GCH% &-rr@cHeZdZUdZeZeed<dZe ded<e ed<e ed<y)BotReadyzeMessage indicating bot is ready for interaction. Sent after bot initialization is complete. r z bot-readyr rrN) rrrrrr rrr rrr@rrrrBrBs- *E>)!,D'+ , G rrBc:eZdZUdZeed<eed<eeefed<y)LLMFunctionCallMessageDatazData for LLM function call notification. Contains function call details including name, ID, and arguments. .. deprecated:: 0.0.102 Use ``LLMFunctionCallInProgressMessageData`` instead. function_name tool_call_idargsN)rrrrrrrrrrrrDrDs$ #s( rrDc>eZdZUdZeZeed<dZe ded<e ed<y)LLMFunctionCallMessagezMessage notifying of an LLM function call. Sent when the LLM makes a function call. .. deprecated:: 0.0.102 Use ``LLMFunctionCallInProgressMessage`` with the ``llm-function-call-in-progress`` event type instead. r zllm-function-callr rN) rrrrrr rrr rrDrrrrIrIs)*E>))eZdZUdZeZeed<dZe ded<e ed<y)AppendToContextzRTVI message format to append content to the LLM context. .. deprecated:: 0.0.85 The RTVI message, append-to-context, has been deprecated. Use send-text or custom client and server messages instead. r zappend-to-contextr rN) rrrrrr rrr rrSrrrrXrXs)*E>))eZdZUdZeZeed<dZe ded<e ed<y)LLMFunctionCallStartMessagezlMessage notifying that an LLM function call has started. Sent when the LLM begins a function call. r zllm-function-call-startedr rN) rrrrrr rrr rrZrrrr\r\s) *E>)1LD'- .L ))rr\c@eZdZUdZeed<eed<eed<eezed<y)LLMFunctionCallResultDatazWData for LLM function call result. Contains function call details and result. rErF argumentsresultN)rrrrrrdictrrrr^r^s$ O 3Jrr^cNeZdZUdZeed<dZeeed<dZee ee fed<y)$LLMFunctionCallInProgressMessageDatazData for LLM function call in-progress notification. Contains function call details including name, ID, and arguments. Fields may be omitted based on the configured function_call_report_level for security. rFNrEr_) rrrrrrrErr_rrrrrrcrc%s5 #'M8C='-1IxS)*1rrcc>eZdZUdZeZeed<dZe ded<e ed<y) LLMFunctionCallInProgressMessagezwMessage notifying that an LLM function call is in progress. Sent when the LLM function call execution begins. r zllm-function-call-in-progressr rN) rrrrrr rrr rrcrrrrere1s) *E>)5TD'1 2T ..rrecNeZdZUdZeed<eed<dZeeed<dZ ee ed<y)!LLMFunctionCallStoppedMessageDataaData for LLM function call stopped notification. Contains details about the function call that stopped, including whether it was cancelled or completed with a result. Fields may be omitted based on the configured function_call_report_level for security. rF cancelledNrEr`) rrrrrrr<rErr`rrrrrgrg<s0O#'M8C=' FHSM rrgc>eZdZUdZeZeed<dZe ded<e ed<y)LLMFunctionCallStoppedMessagezMessage notifying that an LLM function call has stopped. Sent when a function call completes (with result) or is cancelled. r zllm-function-call-stoppedr rN) rrrrrr rrr rrgrrrrjrjJs) *E>)1LD'- .L ++rrjc4eZdZUdZeZeed<dZe ded<y)BotLLMStartedMessagez2Message indicating bot LLM processing has started.r zbot-llm-startedr N rrrrrr rrr rrrrrlrlU<)E>)'8D'# $8rrlc4eZdZUdZeZeed<dZe ded<y)BotLLMStoppedMessagez2Message indicating bot LLM processing has stopped.r zbot-llm-stoppedr Nrmrrrrprp\rnrrpc4eZdZUdZeZeed<dZe ded<y)BotTTSStartedMessagez2Message indicating bot TTS processing has started.r zbot-tts-startedr Nrmrrrrrrrcrnrrrc4eZdZUdZeZeed<dZe ded<y)BotTTSStoppedMessagez2Message indicating bot TTS processing has stopped.r zbot-tts-stoppedr NrmrrrrtrtjrnrrtceZdZUdZeed<y)TextMessageDatazCData for text-based RTVI messages. Contains text content. textNr5rrrrvrvqs Irrvc0eZdZUdZdZeed<eezed<y)BotOutputMessageDatazjData for bot output RTVI messages. Extends TextMessageData to include metadata about the output. Fspoken aggregated_byN) rrrrrzr<rr rrrrryryzs FD"S((rryc>eZdZUdZeZeed<dZe ded<e ed<y)BotOutputMessagezMessage containing bot output text. An event meant to holistically represent what the bot is outputting, along with metadata about the output and if it has been spoken. r z bot-outputr rN) rrrrrr rrr rryrrrr}r}s( *E>)".D', . rr}c>eZdZUdZeZeed<dZe ded<e ed<y)BotTranscriptionMessagez_Message containing bot transcription text. Sent when the bot's speech is transcribed. r zbot-transcriptionr rN rrrrrr rrr rrvrrrrrs) *E>))eZdZUdZeZeed<dZe ded<e ed<y)BotLLMTextMessagezYMessage containing bot LLM text output. Sent when the bot's LLM generates text. r z bot-llm-textr rNrrrrrr( *E>)$2D'. !2 rrc>eZdZUdZeZeed<dZe ded<e ed<y)BotTTSTextMessagez[Message containing bot TTS text output. Sent when text is being processed by TTS. r z bot-tts-textr rNrrrrrrrrrc0eZdZUdZeed<eed<eed<y)AudioMessageDatazOData for audio-based RTVI messages. Contains audio data and metadata. audio sample_rate num_channelsN)rrrrrrintrrrrrs Jrrc>eZdZUdZeZeed<dZe ded<e ed<y)BotTTSAudioMessagez[Message containing bot TTS audio output. Sent when the bot's TTS generates audio. r z bot-tts-audior rN) rrrrrr rrr rrrrrrrs( *E>)%4D'/ "4 rrc:eZdZUdZeed<eed<eed<eed<y)UserTranscriptionMessageDatazYData for user transcription messages. Contains transcription text and metadata. rwuser_id timestampfinalNr;rrrrrs I LN Krrc>eZdZUdZeZeed<dZe ded<e ed<y)UserTranscriptionMessagezVMessage containing user transcription. Sent when user speech is transcribed. r zuser-transcriptionr rN) rrrrrr rrr rrrrrrrs) *E>)*>D'& '> &&rrc>eZdZUdZeZeed<dZe ded<e ed<y)UserLLMTextMessagezbMessage containing user text input for LLM. Sent when user text is processed by the LLM. r z user-llm-textr rNrrrrrrs( *E>)%4D'/ "4 rrc4eZdZUdZeZeed<dZe ded<y)UserStartedSpeakingMessagez-Message indicating user has started speaking.r zuser-started-speakingr Nrmrrrrr7)E>)-DD') *Drrc4eZdZUdZeZeed<dZe ded<y)UserStoppedSpeakingMessagez-Message indicating user has stopped speaking.r zuser-stopped-speakingr Nrmrrrrrrrrc4eZdZUdZeZeed<dZe ded<y)UserMuteStartedMessagez'Message indicating user has been muted.r zuser-mute-startedr Nrmrrrrrs1)E>))))),BD'( )Brrc4eZdZUdZeZeed<dZe ded<y)BotStoppedSpeakingMessagez,Message indicating bot has stopped speaking.r zbot-stopped-speakingr Nrmrrrrr rrrcHeZdZUdZeZeed<dZe ded<e e e fed<y)MetricsMessagez`Message containing performance metrics. Sent to provide performance and usage metrics. r metricsr rN) rrrrrr rrr rrrrrrrrrs1 *E>)(D') ( #s( rrc>eZdZUdZeZeed<dZe ded<e ed<y) ServerMessagezLGeneric server message. Used for custom server-to-client messages. r zserver-messager rN) rrrrrr rrr rrrrrrrs( *E>)&6D'" #6 IrrceZdZUdZeed<y)AudioLevelMessageDataz%Data format for sending audio levels.valueN)rrrrfloatrrrrrr*s / Lrrc>eZdZUdZeZeed<dZe ded<e ed<y)UserAudioLevelMessagez$Message indicating user audio level.r zuser-audio-levelr rN rrrrrr rrr rrrrrrr0s%.)E>)(:D'$ %: rrc>eZdZUdZeZeed<dZe ded<e ed<y)BotAudioLevelMessagez#Message indicating bot audio level.r zbot-audio-levelr rNrrrrrr8s%-)E>)'8D'# $8 rrc>eZdZUdZeZeed<dZe ded<e ed<y)SystemLogMessagezMessage including a system log.r z system-logr rNrrrrrr@s$))E>)".D', . rrN)Crtypingrrrrrpydanticrpipecat.frames.framesr PROTOCOL_VERSIONrrr rr!r$r&r(r/r3r7r9r>r@rBrDrIrKrOrSrXrZr\r^rcrergrjrlrprrrtrvryr}rrrrrrrrrrrrrrrrrrrrrrrrs  # *i *9II  Y   +i +i  I  I.9. y    %Y % i .9. ") " i (i(*)*   29 2/y/ ! !,I,999999999999i)?) y i  y 9 'y'EEEE=Y==Y=C CC CYII  I  9 yr