o ÿiø8ã@sœdZddlmZmZmZmZmZddlmZddl m Z dZ dZ edZ Gdd„deƒZGd d „d eƒZGd d „d eƒZGd d„deƒZGdd„deƒZGdd„deƒZGdd„deƒZGdd„deƒZGdd„deƒZGdd„deƒZGdd„deƒZGdd„deƒZGdd „d eƒZGd!d"„d"eƒZGd#d$„d$eƒZGd%d&„d&eƒZGd'd(„d(eƒZGd)d*„d*eƒZGd+d,„d,eƒZ Gd-d.„d.eƒZ!Gd/d0„d0eƒZ"Gd1d2„d2eƒZ#Gd3d4„d4eƒZ$Gd5d6„d6eƒZ%Gd7d8„d8eƒZ&Gd9d:„d:eƒZ'Gd;d<„d„d>eƒZ)Gd?d@„d@eƒZ*GdAdB„dBeƒZ+GdCdD„dDeƒZ,GdEdF„dFe,ƒZ-GdGdH„dHeƒZ.GdIdJ„dJeƒZ/GdKdL„dLeƒZ0GdMdN„dNeƒZ1GdOdP„dPeƒZ2GdQdR„dReƒZ3GdSdT„dTeƒZ4GdUdV„dVeƒZ5GdWdX„dXeƒZ6GdYdZ„dZeƒZ7Gd[d\„d\eƒZ8Gd]d^„d^eƒZ9Gd_d`„d`eƒZ:Gdadb„dbeƒZ;Gdcdd„ddeƒZGdidj„djeƒZ?Gdkdl„dleƒZ@Gdmdn„dneƒZAGdodp„dpeƒZBdqS)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)) é)ÚAnyÚDictÚLiteralÚMappingÚOptional)Ú BaseModel)ÚAggregationTypez1.2.0zrtvi-aic@sFeZdZUdZeZeed<eed<eed<dZ e e ee fed<dS)ÚMessagezaBase RTVI message structure. Represents the standard format for RTVI protocol messages. ÚlabelÚtypeÚidNÚdata) Ú__name__Ú __module__Ú __qualname__Ú__doc__Ú MESSAGE_LABELr ÚMessageLiteralÚ__annotations__Ústrr rrr©rrú]/home/ubuntu/.local/lib/python3.10/site-packages/pipecat/processors/frameworks/rtvi/models.pyr (s  r c@ó*eZdZUdZeed<dZeeed<dS)ÚRawClientMessageDatazEData structure expected from client messages sent to the RTVI server.ÚtNÚd© rrrrrrrrrrrrrr7ó rc@s2eZdZUdZeed<eed<dZeeed<dS)Ú ClientMessagez9Cleansed data structure for client messages for handling.Úmsg_idr Nr ) rrrrrrr rrrrrrr>s rc@r)ÚRawServerResponseDataz7Data structure for server responses to client messages.rNrrrrrrr Frr c@ó>eZdZUdZeZeed<dZe ded<e ed<e ed<dS)ÚServerResponsez“The 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 r r N) rrrrrr rrr rrr rrrrr"Mó   r"c@sZeZdZUdZeed<dZeeed<dZeeed<dZ eeed<dZ ee ed<dS)ÚAboutClientDataz»Data 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. ÚlibraryNÚlibrary_versionÚplatformÚplatform_versionÚplatform_details) rrrrrrr&rr'r(r)rrrrrr$Ys r$c@ó"eZdZUdZeed<eed<dS)ÚClientReadyDatazjData format of client ready messages. Contains the RTVI protocol version and client information. ÚversionÚaboutN)rrrrrrr$rrrrr+gó  r+c@óeZdZUdZeed<dS)ÚErrorResponseDatazaData for an RTVI error response. Contains the error message to send back to the client. ÚerrorN©rrrrrrrrrrr0tó  r0c@r!)Ú ErrorResponsezqRTVI error response message. RTVI formatted error response message for relaying failed client requests. r zerror-responser r r N) rrrrrr rrr rrr0rrrrr4}r#r4c@r*)Ú ErrorDataz`Data for an RTVI error event. Contains error information including whether it's fatal. r1ÚfatalN©rrrrrrÚboolrrrrr5‰r.r5c@ó6eZdZUdZeZeed<dZe ded<e ed<dS)ÚErrorzeRTVI error event message. RTVI formatted error message for relaying errors in the pipeline. r r1r r N) rrrrrr rrr rr5rrrrr:“ó   r:c@s2eZdZUdZeed<dZeeee fed<dS)Ú BotReadyDataz_Data for bot ready notification. Contains protocol version and initial configuration. r,Nr-) rrrrrrr-rrrrrrrr<¡s r<c@r!)ÚBotReadyzeMessage indicating bot is ready for interaction. Sent after bot initialization is complete. r z bot-readyr r r N) rrrrrr rrr rrr<rrrrr=«r#r=c@s2eZdZUdZeed<eed<eeefed<dS)ÚLLMFunctionCallMessageDatazÏData 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_idÚargsN)rrrrrrrrrrrrr>·s r>c@r9)ÚLLMFunctionCallMessagezòMessage 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 r N) rrrrrr rrr rr>rrrrrBÅs   rBc@s*eZdZUdZdZeed<dZeed<dS)ÚSendTextOptionszyOptions for sending text input to the LLM. Contains options for how the pipeline should process the text input. TÚrun_immediatelyÚaudio_responseN)rrrrrDr8rrErrrrrCÔó  rCc@r)Ú SendTextDataz’Data format for sending text input to the LLM. Contains the text content to send and any options for how the pipeline should process it. ÚcontentNÚoptions) rrrrrrrIrrCrrrrrGÞs rGc@s6eZdZUdZedeBed<eed<dZe ed<dS)ÚAppendToContextDataa&Data format for appending messages to the context. Contains the role, content, and whether to run the message immediately. .. deprecated:: 0.0.85 The RTVI message, append-to-context, has been deprecated. Use send-text or custom client and server messages instead. )ÚuserÚ assistantÚrolerHFrDN) rrrrrrrrrDr8rrrrrJès  rJc@r9)ÚAppendToContextzàRTVI 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 r N) rrrrrr rrr rrJrrrrrN÷s   rNc@s"eZdZUdZdZeeed<dS)ÚLLMFunctionCallStartMessageDataz¼Data for LLM function call start notification. Contains the function name being called. Fields may be omitted based on the configured function_call_report_level for security. Nr?)rrrrr?rrrrrrrrOs rOc@r9)ÚLLMFunctionCallStartMessagezlMessage notifying that an LLM function call has started. Sent when the LLM begins a function call. r zllm-function-call-startedr r N) rrrrrr rrr rrOrrrrrPr;rPc@s6eZdZUdZeed<eed<eed<eeBed<dS)ÚLLMFunctionCallResultDatazWData for LLM function call result. Contains function call details and result. r?r@Ú argumentsÚresultN)rrrrrrÚdictrrrrrQs rQc@sBeZdZUdZeed<dZeeed<dZee ee fed<dS)Ú$LLMFunctionCallInProgressMessageDatazÛData 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. r@Nr?rR) rrrrrrr?rrRrrrrrrrU%s rUc@r9)Ú LLMFunctionCallInProgressMessagezwMessage notifying that an LLM function call is in progress. Sent when the LLM function call execution begins. r zllm-function-call-in-progressr r N) rrrrrr rrr rrUrrrrrV1r;rVc@sBeZdZUdZeed<eed<dZeeed<dZ ee ed<dS)Ú!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. r@Ú cancelledNr?rS) rrrrrrr8r?rrSrrrrrrW<s rWc@r9)ÚLLMFunctionCallStoppedMessagez…Message notifying that an LLM function call has stopped. Sent when a function call completes (with result) or is cancelled. r zllm-function-call-stoppedr r N) rrrrrr rrr rrWrrrrrYJr;rYc@ó.eZdZUdZeZeed<dZe ded<dS)ÚBotLLMStartedMessagez2Message indicating bot LLM processing has started.r zbot-llm-startedr N© rrrrrr rrr rrrrrr[Uó  r[c@rZ)ÚBotLLMStoppedMessagez2Message indicating bot LLM processing has stopped.r zbot-llm-stoppedr Nr\rrrrr^\r]r^c@rZ)ÚBotTTSStartedMessagez2Message indicating bot TTS processing has started.r zbot-tts-startedr Nr\rrrrr_cr]r_c@rZ)ÚBotTTSStoppedMessagez2Message indicating bot TTS processing has stopped.r zbot-tts-stoppedr Nr\rrrrr`jr]r`c@r/)ÚTextMessageDatazCData for text-based RTVI messages. Contains text content. ÚtextNr2rrrrraqr3rac@s*eZdZUdZdZeed<eeBed<dS)ÚBotOutputMessageDatazjData for bot output RTVI messages. Extends TextMessageData to include metadata about the output. FÚspokenÚ aggregated_byN) rrrrrdr8rrrrrrrrczrFrcc@r9)ÚBotOutputMessagez¶Message 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 r N) rrrrrr rrr rrcrrrrrf…s   rfc@r9)ÚBotTranscriptionMessagez_Message containing bot transcription text. Sent when the bot's speech is transcribed. r zbot-transcriptionr r N© rrrrrr rrr rrarrrrrg‘r;rgc@r9)ÚBotLLMTextMessagezYMessage containing bot LLM text output. Sent when the bot's LLM generates text. r z bot-llm-textr r Nrhrrrrriœr;ric@r9)ÚBotTTSTextMessagez[Message containing bot TTS text output. Sent when text is being processed by TTS. r z bot-tts-textr r Nrhrrrrrj§r;rjc@s*eZdZUdZeed<eed<eed<dS)ÚAudioMessageDatazOData for audio-based RTVI messages. Contains audio data and metadata. ÚaudioÚ sample_rateÚ num_channelsN)rrrrrrÚintrrrrrk²s  rkc@r9)ÚBotTTSAudioMessagez[Message containing bot TTS audio output. Sent when the bot's TTS generates audio. r z bot-tts-audior r N) rrrrrr rrr rrkrrrrrp½r;rpc@s2eZdZUdZeed<eed<eed<eed<dS)ÚUserTranscriptionMessageDatazYData for user transcription messages. Contains transcription text and metadata. rbÚuser_idÚ timestampÚfinalNr7rrrrrqÈs  rqc@r9)ÚUserTranscriptionMessagezVMessage containing user transcription. Sent when user speech is transcribed. r zuser-transcriptionr r N) rrrrrr rrr rrqrrrrruÔr;ruc@r9)ÚUserLLMTextMessagezbMessage containing user text input for LLM. Sent when user text is processed by the LLM. r z user-llm-textr r Nrhrrrrrvßr;rvc@rZ)ÚUserStartedSpeakingMessagez-Message indicating user has started speaking.r zuser-started-speakingr Nr\rrrrrwêr]rwc@rZ)ÚUserStoppedSpeakingMessagez-Message indicating user has stopped speaking.r zuser-stopped-speakingr Nr\rrrrrxñr]rxc@rZ)ÚUserMuteStartedMessagez'Message indicating user has been muted.r zuser-mute-startedr Nr\rrrrryør]ryc@rZ)ÚUserMuteStoppedMessagez)Message indicating user has been unmuted.r zuser-mute-stoppedr Nr\rrrrrzÿr]rzc@rZ)ÚBotStartedSpeakingMessagez,Message indicating bot has started speaking.r zbot-started-speakingr Nr\rrrrr{r]r{c@rZ)ÚBotStoppedSpeakingMessagez,Message indicating bot has stopped speaking.r zbot-stopped-speakingr Nr\rrrrr| r]r|c@s>eZdZUdZeZeed<dZe ded<e e e fed<dS)ÚMetricsMessagez`Message containing performance metrics. Sent to provide performance and usage metrics. r Úmetricsr r N) rrrrrr rrr rrrrrrrrr}s  r}c@r9)Ú ServerMessagezLGeneric server message. Used for custom server-to-client messages. r zserver-messager r N) rrrrrr rrr rrrrrrrr;rc@r/)ÚAudioLevelMessageDataz%Data format for sending audio levels.ÚvalueN)rrrrÚfloatrrrrrr€*s  r€c@r9)ÚUserAudioLevelMessagez$Message indicating user audio level.r zuser-audio-levelr r N© rrrrrr rrr rr€rrrrrƒ0ó   rƒc@r9)ÚBotAudioLevelMessagez#Message indicating bot audio level.r zbot-audio-levelr r Nr„rrrrr†8r…r†c@r9)ÚSystemLogMessagezMessage including a system log.r z system-logr r Nrhrrrrr‡@r…r‡N)CrÚtypingrrrrrÚpydanticrÚpipecat.frames.framesrÚPROTOCOL_VERSIONrrr rrr r"r$r+r0r4r5r:r<r=r>rBrCrGrJrNrOrPrQrUrVrWrYr[r^r_r`rarcrfrgrirjrkrprqrurvrwrxryrzr{r|r}rr€rƒr†r‡rrrrÚsx