qi :dZddlZddlmZmZddlmZmZmZm Z m Z m Z m Z m Z mZmZmZddlmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd l m!Z!dd l"m#Z#ddl$m%Z%m&Z&er ddl'm(Z(m)Z)ddl*m+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1GddZ2e2Zdee3fdZ4eGddZ5eGdde5Z6eGdde5Z7eGdde5Z8eGd d!Z9eGd"d#Z:eGd$d%Z;eGd&d'e7e:ZeGd,d-e<Z?eGd.d/e=Z@eGd0d1e7ZAeGd2d3e7ZBeGd4d5eBZCeGd6d7eBZDeGd8d9eCZEeGd:d;eDZFeGd<d=eBZGeGd>d?eBZHeGd@dAeBZIeGdBdCe7ZJeGdDdEe7ZKeGdFdGZLeGdHdIZMeGdJdKe7ZNeGdLdMe5ZOeGdNdOe8ZPeGdPdQe7ZQeGdRdSe8ZReGdTdUe7ZSeGdVdWe7ZTeGdXdYe7ZUeGdZd[e7ZVeGd\d]e7ZWeGd^d_e7ZXeGd`dae7ZYeGdbdce7ZZeGdddeZ[eGdfdge7e9Z\eGdhdie7Z]eGdjdke7Z^eGdldme^Z_eGdndoZ`eGdpdqe`e7ZaeGdrdse6ZbeGdtdue6ZceGdvdwe6ZdeGdxdyedZeeGdzd{e6ZfeGd|d}e6ZgeGd~de6ZheGddehZieGdde6ZjeGdde6ZkeGdde6ZleGdde6ZmeGdde6ZneGdde6ZoeGdde6ZpeGdde6ZqeGdde6ZreGdde6ZseGdde6ZteGdde6ZueGdde6ZveGddZweGdde6ZxeGdde6ZyeGdde6ZzeGdde6Z{eGdde{Z|eGdde6Z}eGdde}Z~eGdde6ZeGdde6e:ZeGdde6e;ZeGdde6eBZeGddeZeGddeZeGdde=ZeGdde`e6ZeGdde`e6ZeGdde6ZeGdde6ZeGd„deZeGdĄde8ZeGdƄde6ZeGdȄdeZeGdʄdeZeGd̄deZeGd΄deZeGdЄdeZeGd҄de8e9ZeGdԄde8e9ZeGdքde6ZeGd؄de6ZeGdڄde8ZeGd܄de8ZeGdބde8ZeGdde8ZeGdde8ZeGdde8ZeGdde8ZeGdde8ZeGdde8ZeGdde8e9ZeGdde8e9ZeGddeZeGddeZeGdde8ZeGdde8ZeGdde8e9ZeGddeZeGddeZeGddeZeGdde6ZeGdde8ZeGdde8ZeGddeZeGdd eZeGd d e8ZeGd d eZeGddeZeGdde8ZeGddeZy(zCore frame definitions for the Pipecat AI framework. This module contains all frame types used throughout the Pipecat pipeline system, including data frames, system frames, and control frames for audio, video, text, and LLM processing. N) dataclassfield) TYPE_CHECKINGAny AwaitableCallableDictListLiteralMappingOptionalSequenceTuple) ToolsSchema) KeypadEntry)BaseInterruptionStrategy)BaseTurnParams) VADParams) MetricsData)Language)AggregationTypenanoseconds_to_str) obj_countobj_id) LLMContextNotGiven)FrameProcessor)ServiceSettings)LLMContextSummaryConfig)TracingContextcDeZdZdZeZedZdededefdZ dZ dZ y ) DeprecatedKeypadEntryaBDTMF keypad entries for phone system integration. .. deprecated:: 0.0.82 This class is deprecated and will be removed in a future version. Instead, use `audio.dtmf.types.KeypadEntry`. Parameters: ONE: Number key 1. TWO: Number key 2. THREE: Number key 3. FOUR: Number key 4. FIVE: Number key 5. SIX: Number key 6. SEVEN: Number key 7. EIGHT: Number key 8. NINE: Number key 9. ZERO: Number key 0. POUND: Pound/hash key (#). STAR: Star/asterisk key (*). cddl}|j5|jd|jdtddddy#1swYyxYw)Nralwaysz`pipecat.frames.frames.KeypadEntry` is deprecated and will be removed in a future version. Use `pipecat.audio.dtmf.types.KeypadEntry` instead. stacklevelwarningscatch_warnings simplefilterwarnDeprecationWarning)clsr*s G/opt/pipecat/venv/lib/python3.12/site-packages/pipecat/frames/frames.py_warnzDeprecatedKeypadEntry._warnIsQ  $ $ &   ! !( + MMF"      *AAargskwargsreturncF|j|j|i|S)z.Allow the instance to be called as a function.r1_enum)selfr3r4s r0__call__zDeprecatedKeypadEntry.__call__Vs! tzz4*6**cN|jt|j|S)z/Retrieve an attribute from the underlying enum.)r1getattrr8r9names r0 __getattr__z!DeprecatedKeypadEntry.__getattr__[s tzz4((r;c@|j|j|S)z*Retrieve an item from the underlying enum.r7r>s r0 __getitem__z!DeprecatedKeypadEntry.__getitem__`s zz$r;N) __name__ __module__ __qualname____doc__NewKeypadEntryr8 classmethodr1rr:r@rBr;r0r#r#1sD* E  +c+S+S+ )  r;r#ptsc |r t|SdS)zFormat presentation timestamp (PTS) in nanoseconds to a human-readable string. Converts a PTS value in nanoseconds to a string representation. Args: pts: Presentation timestamp in nanoseconds, or None if not set. Nr)rJs r0 format_ptsrLis'* c "3t3r;ceZdZUdZedZeed<edZe ed<edZ e eed<edZ e eed<edZ ee efed<edZe e ed <edZe e ed <d Zd Zy )Framea)Base frame class for all frames in the Pipecat pipeline. All frames inherit from this base class and automatically receive unique identifiers, names, and metadata support. Parameters: id: Unique identifier for the frame instance. name: Human-readable name combining class name and instance count. pts: Presentation timestamp in nanoseconds. broadcast_sibling_id: ID of the paired frame when this frame was broadcast in both directions. Set automatically by ``broadcast_frame()`` and ``broadcast_frame_instance()``. metadata: Dictionary for arbitrary frame metadata. transport_source: Name of the transport source that created this frame. transport_destination: Name of the transport destination for this frame. Finitidr?rJbroadcast_sibling_idmetadatatransport_sourcetransport_destinationct|_|jjdt ||_d|_d|_i|_d|_ d|_ y)N#) rrQ __class__rCrr?rJrRrSrTrUr9s r0 __post_init__zFrame.__post_init__sSx NN334Aio5FG "&37!(* /348"r;c|jSN)r?rYs r0__str__z Frame.__str__s yyr;N)rCrDrErFrrQint__annotations__r?strrJr rRrSr rrTrUrZr]rIr;r0rNrNts"B5!D#!E*C#**/U*;(3-;$%0Hd38n0&+&7hsm7+0e+<8C=<9r;rNceZdZdZy) SystemFramezSystem frame class for immediate processing. A frame that takes higher priority than other frames. System frames are handled in order and are not affected by user interruptions. NrCrDrErFrIr;r0rbrb   r;rbceZdZdZy) DataFramezData frame class for processing data in order. A frame that is processed in order and usually contains data such as LLM context, text, audio or images. Data frames are cancelled by user interruptions. NrcrIr;r0rfrf  r;rfceZdZdZy) ControlFramea<Control frame class for processing control information in order. A frame that, similar to data frames, is processed in order and usually contains control information such as update settings or to end the pipeline after everything is flushed. Control frames are cancelled by user interruptions. NrcrIr;r0riri  r;riceZdZdZy)UninterruptibleFrameahA marker for data or control frames that must not be interrupted. Frames with this mixin are still ordered normally, but unlike other frames, they are preserved during interruptions: they remain in internal queues and any task processing them will not be cancelled. This ensures the frame is always delivered and processed to completion. NrcrIr;r0rlrlrjr;rlcTeZdZUdZeed<eed<eed<eddZeed<d Z y ) AudioRawFrameaA frame containing a chunk of raw audio. Parameters: audio: Raw audio bytes in PCM format. sample_rate: Audio sample rate in Hz. num_channels: Number of audio channels. num_frames: Number of audio frames (calculated automatically). audio sample_rate num_channelsrFdefaultrP num_framescjtt|j|jdzz |_yNr&)r^lenrorqrtrYs r0rZzAudioRawFrame.__post_init__s&c$**o1B1BQ1FGHr;N) rCrDrErFbytesr_r^rrtrZrIr;r0rnrns1 LAE2J2Ir;rnc@eZdZUdZeed<eeefed<ee ed<y) ImageRawFramezA frame containing a raw image. Parameters: image: Raw image bytes. size: Image dimensions as (width, height) tuple. format: Image format (e.g., 'RGB', 'RGBA'). imagesizeformatN) rCrDrErFrxr_rr^r r`rIr;r0rzrzs& L S/ SMr;rzc(eZdZdZfdZdZxZS)OutputAudioRawFrameaAudio data frame for output to transport. A chunk of raw audio that will be played by the output transport. If the transport supports multiple audio destinations (e.g. multiple audio tracks) the destination name can be specified in transport_destination. ct|tt|j|j dzz |_yrvsuperrZr^rwrorqrtr9rXs r0rZz!OutputAudioRawFrame.__post_init__2 c$**o1B1BQ1FGHr;ct|j}|jd|d|jdt |j d|j d|jd|jdS)N(pts: , destination: , size: , frames: , sample_rate: , channels: )) rLrJr?rUrwrortrprqr9rJs r0r]zOutputAudioRawFrame.__str__ s"))F3%t7Q7Q6RRZ[^_c_i_i[jZkkuvzwFwFvGGVW[WgWgVhhtuyuFuFtGGHI Ir;rCrDrErFrZr] __classcell__rXs@r0rrsIIr;rceZdZdZdZy)OutputImageRawFramezImage data frame for output to transport. An image that will be shown by the transport. If the transport supports multiple video destinations (e.g. multiple video tracks) the destination name can be specified in transport_destination. c t|j}|jd|d|jd|jd|j d S)Nrrr , format: r)rLrJr?rUr|r}rs r0r]zOutputImageRawFrame.__str__sS"))F3%t7Q7Q6RRZ[_[d[dZeeoptp{p{o||}~~r;NrCrDrErFr]rIr;r0rrs r;rc&eZdZUdZdZeeed<y)TTSAudioRawFramezAudio data frame generated by Text-to-Speech services. A chunk of output audio generated by a TTS service, ready for playback. Parameters: context_id: Unique identifier for the TTS context that generated this audio. N context_idrCrDrErFrr r`r_rIr;r0rrs!%J $r;rceZdZdZy)SpeechOutputAudioRawFrameaAn audio frame part of a speech audio stream. This frame is part of a continuous stream of audio frames containing speech. The audio stream might also contain silence frames, so a process to distinguish between speech and silence might be needed. NrcrIr;r0rr)rgr;rc,eZdZUdZdZeeed<dZy)URLImageRawFrameaImage frame with an associated URL. An output image with an associated URL. These images are usually generated by third-party services that provide a URL to download the image. Parameters: url: URL where the image can be downloaded from. Nurlc t|j}|jd|d|jd|jd|j d S)Nrz, url: rrr)rLrJr?rr|r}rs r0r]zURLImageRawFrame.__str__BsJ"))F3%wtxxj :VZVaVaUbbcddr;) rCrDrErFrr r`r_r]rIr;r0rr5sC#er;rc(eZdZUdZeeed<dZy) SpriteFramea_Animated sprite frame containing multiple images. An animated sprite that will be shown by the transport if the transport's camera is enabled. Will play at the framerate specified in the transport's `camera_out_framerate` constructor parameter. Parameters: images: List of image frames that make up the sprite animation. imagesc|t|j}|jd|dt|jdS)Nrrr)rLrJr?rwrrs r0r]zSpriteFrame.__str__Us7"))F3%xDKK0@/ACCr;N)rCrDrErFr rr_r]rIr;r0rrGs $ %%Dr;rceZdZUdZeed<edZee ed<edZ e ed<edZ e ed<fdZ d Z xZS) TextFrameaSText data frame for passing text through the pipeline. A chunk of text. Emitted by LLM services, consumed by context aggregators, TTS services and more. Can be used to send text through processors. Parameters: text: The text content. skip_tts: Whether this text should be skipped by the TTS service. includes_inter_frame_spaces: Whether any necessary inter-frame (leading/trailing) spaces are already included in the text. append_to_context: Whether this text should be appended to the LLM context. Defaults to True. textFrOskip_ttsincludes_inter_frame_spacesappend_to_contextcLt|d|_d|_d|_y)NFT)rrZrrrrs r0rZzTextFrame.__post_init__ws%  +0(!%r;cjt|j}|jd|d|jdS)Nr , text: [])rLrJr?rrs r0r]zTextFrame.__str__}s1"))F3%y 2>>r;)rCrDrErFr`r_rrr boolrrrZr]rrs@r0rrZsN  I$%0Hhtn0).5(99#/t/& ?r;rc"eZdZdZfdZxZS) LLMTextFramez%Text frame generated by LLM services.c0t|d|_yNTrrZrrs r0rZzLLMTextFrame.__post_init__ +/(r;rCrDrErFrZrrs@r0rrs/00r;rc6eZdZUdZeezed<dZeeed<y)AggregatedTextFrameavText frame representing an aggregation of TextFrames. This frame contains multiple TextFrames aggregated together for processing or output along with a field to indicate how they are aggregated. Parameters: aggregated_by: Method used to aggregate the text frames. context_id: Unique identifier for the TTS context that generated this text. aggregated_byNr) rCrDrErFrr`r_rr rIr;r0rrs"#S(( $J $r;rceZdZdZy)VisionTextFramez(Text frame generated by vision services.NrcrIr;r0rr2r;rc&eZdZUdZdZeeed<y) TTSTextFramezText frame generated by Text-to-Speech services. Parameters: context_id: Unique identifier for the TTS context that generated this text. NrrrIr;r0rr !%J $r;rcbeZdZUdZeed<eed<dZeeed<dZ ee ed<dZ e ed<d Z y) TranscriptionFramea4Text frame containing speech transcription data. A text frame with transcription-specific data. The `result` field contains the result from the STT service if available. Parameters: user_id: Identifier for the user who spoke. timestamp: When the transcription occurred. language: Detected or specified language of the speech. result: Raw result from the STT service. finalized: Whether this is the final transcription for an utterance. Set by STT services that support commit/finalize signals. user_id timestampNlanguageresultF finalizedc |jd|jd|jd|jd|jd SN(user: rz ], language: z , timestamp: rr?rrrrrYs r0r]zTranscriptionFrame.__str__K))GDLL>499+]SWS`S`Raanoso}o}n~~A Ar;)rCrDrErFr`r_rr rrrrrr]rIr;r0rrs@ LN#'Hhx ' FHSM ItAr;rc^eZdZUdZeed<eed<eed<dZeeed<dZ ee ed<dZ y) InterimTranscriptionFrameaText frame containing partial/interim transcription data. A text frame with interim transcription-specific data that represents partial results before final transcription. The `result` field contains the result from the STT service if available. Parameters: user_id: Identifier for the user who spoke. timestamp: When the interim transcription occurred. language: Detected or specified language of the speech. result: Raw result from the STT service. rrrNrrc |jd|jd|jd|jd|jd SrrrYs r0r]z!InterimTranscriptionFrame.__str__rr;) rCrDrErFr`r_rr rrrr]rIr;r0rrs;  I LN#'Hhx ' FHSM Ar;rc@eZdZUdZeed<eed<dZeeed<dZ y)TranslationFrameaoText frame containing translated transcription data. A text frame with translated transcription data that will be placed in the transport's receive queue when a participant speaks. Parameters: user_id: Identifier for the user who spoke. timestamp: When the translation occurred. language: Target language of the translation. rrNrc |jd|jd|jd|jd|jd SrrrYs r0r]zTranslationFrame.__str__rr;) rCrDrErFr`r_rr rr]rIr;r0rrs( LN#'Hhx 'Ar;rc.eZdZUdZeed<fdZxZS)'OpenAILLMContextAssistantTimestampFrameaTimestamp information for assistant messages in LLM context. .. deprecated:: 0.0.99 `OpenAILLMContextAssistantTimestampFrame` is deprecated and will be removed in a future version. Use `LLMContextAssistantTimestampFrame` with the universal `LLMContext` and `LLMContextAggregatorPair` instead. See `OpenAILLMContext` docstring for migration guide. Parameters: timestamp: Timestamp when the assistant message was created. rct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%zOpenAILLMContextAssistantTimestampFrame is deprecated and will be removed in a future version. Use LLMContextAssistantTimestampFrame with the universal LLMContext and LLMContextAggregatorPair instead. See OpenAILLMContext docstring for migration guide.r&r'rrZr*r+r,r-r.r9r*rXs r0rZz5OpenAILLMContextAssistantTimestampFrame.__post_init__s_   $ $ &   ! !( + MMF#      *AA )rCrDrErFr`r_rZrrs@r0rrs N  r;rceZdZUdZeed<y)!LLMContextAssistantTimestampFramezTimestamp information for assistant messages in LLM context. Parameters: timestamp: Timestamp when the assistant message was created. rNrCrDrErFr`r_rIr;r0rrs Nr;rcZeZdZUdZeded<eed<dZeeed<dZ eeed<dZ y) TranscriptionMessageaA message in a conversation transcript. A message in a conversation transcript containing the role and content. Messages are in standard format with roles normalized to user/assistant. Parameters: role: The role of the message sender (user or assistant). content: The message content/text. user_id: Optional identifier for the user. timestamp: Optional timestamp when the message was created. .. deprecated:: 0.0.99 `TranscriptionMessage` is deprecated and will be removed in a future version. Use `LLMUserAggregator`'s and `LLMAssistantAggregator`'s new events instead. )user assistantrolecontentNrrcddl}|j5|jd|jdtddddy#1swYyxYw)Nrr%zTranscriptionMessage is deprecated and will be removed in a future version. Use `LLMUserAggregator`'s and `LLMAssistantAggregator`'s new events instead.r&r'r)r9r*s r0rZz"TranscriptionMessage.__post_init__6sQ  $ $ &   ! !( + MM_"     r2) rCrDrErFr r_r`rr rrZrIr;r0rrs; % && L!GXc]!#Ix}# r;rcZeZdZUdZeddZeded<eed<dZ e eed<d Z y) ThoughtTranscriptionMessagezAn LLM thought message in a conversation transcript. .. deprecated:: 0.0.99 `ThoughtTranscriptionMessage` is deprecated and will be removed in a future version. Use `LLMAssistantAggregator`'s new events instead. rFrrrrNrcddl}|j5|jd|jdtddddy#1swYyxYw)Nrr%zThoughtTranscriptionMessage is deprecated and will be removed in a future version. Use `LLMAssistantAggregator`'s new events instead.r&r'r)rs r0rZz)ThoughtTranscriptionMessage.__post_init__PsQ  $ $ &   ! !( + MME"     r2) rCrDrErFrrr r_r`rr rZrIr;r0rrCs7"'{!GD'+ G L#Ix}# r;rc@eZdZUdZeeezed<fdZdZ xZ S)TranscriptionUpdateFrameaFrame containing new messages added to conversation transcript. A frame containing new messages added to the conversation transcript. This frame is emitted when new messages are added to the conversation history, containing only the newly added messages rather than the full transcript. Messages have normalized roles (user/assistant) regardless of the LLM service used. Messages are always in the OpenAI standard message format, which supports both: Examples: Simple format:: [ { "role": "user", "content": "Hi, how are you?" }, { "role": "assistant", "content": "Great! And you?" } ] Content list format:: [ { "role": "user", "content": [{"type": "text", "text": "Hi, how are you?"}] }, { "role": "assistant", "content": [{"type": "text", "text": "Great! And you?"}] } ] OpenAI supports both formats. Anthropic and Google messages are converted to the content list format. Parameters: messages: List of new transcript messages that were added. .. deprecated:: 0.0.99 `TranscriptionUpdateFrame` is deprecated and will be removed in a future version. Use `LLMUserAggregator`'s and `LLMAssistantAggregator`'s new events instead. messagesct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%zTranscriptionUpdateFrame is deprecated and will be removed in a future version. Use `LLMUserAggregator`'s and `LLMAssistantAggregator`'s new events instead.r&r'rrs r0rZz&TranscriptionUpdateFrame.__post_init__s]   $ $ &   ! !( + MM_"     rc|t|j}|jd|dt|jdS)Nrz , messages: r)rLrJr?rwrrs r0r]z TranscriptionUpdateFrame.__str__s7"))F3%|C 4F3GqIIr;) rCrDrErFr rrr_rZr]rrs@r0rr]s(,\'*EEFF Jr;rceZdZUdZded<y)LLMContextFramezFrame containing a universal LLM context. Used as a signal to LLM services to ingest the provided context and generate a response based on it. Parameters: context: The LLM context containing messages, tools, and configuration. rcontextNrCrDrErFr_rIr;r0rrsr;rcLeZdZUdZdZeed<dZee ed<fdZ dZ xZ S)LLMThoughtStartFrameaFrame indicating the start of an LLM thought. Parameters: append_to_context: Whether the thought should be appended to the LLM context. If it is appended, the `llm` field is required, since it will be appended as an `LLMSpecificMessage`. llm: Optional identifier of the LLM provider for LLM-specific handling. Only required if `append_to_context` is True, as the thought is appended to context as an `LLMSpecificMessage`. FrNllmcjt||jr|j t dyy)Nz/When append_to_context is True, llm must be set)rrZrr ValueErrorrs r0rZz"LLMThoughtStartFrame.__post_init__s4   ! !dhh&6NO O'7 !r;ct|j}|jd|d|jd|jdS)Nr, append_to_context: z, llm: r)rLrJr?rrrs r0r]zLLMThoughtStartFrame.__str__sG"yyku$9$:P:P9QQXY]YaYaXbbc d r;) rCrDrErFrrr_rr r`rZr]rrs@r0rrs. $t#C#P  r;rcPeZdZUdZeed<edZeed<fdZ dZ xZ S)LLMThoughtTextFrameaFrame containing the text (or text chunk) of an LLM thought. Note that despite this containing text, it is a DataFrame and not a TextFrame, to avoid most typical text processing, such as TTS. Parameters: text: The text (or text chunk) of the thought. rFrOrc0t|d|_yrrrs r0rZz!LLMThoughtTextFrame.__post_init__rr;cjt|j}|jd|d|jdS)Nrz, thought text: rrrs r0r]zLLMThoughtTextFrame.__str__s2"))F3%'7 {!DDr;) rCrDrErFr`r_rrrrZr]rrs@r0rrs* I(-5(990 Er;rc&eZdZUdZdZeed<dZy)LLMThoughtEndFramezFrame indicating the end of an LLM thought. Parameters: signature: Optional signature associated with the thought. This is used by Anthropic, which includes a signature at the end of each thought. N signaturecjt|j}|jd|d|jdS)Nrz , signature: r)rLrJr?rrs r0r]zLLMThoughtEndFrame.__str__s2"))F3%}T^^4DAFFr;)rCrDrErFrrr_r]rIr;r0rrsIsGr;rc4eZdZUdZeeed<fdZxZS)LLMMessagesFrameaFrame containing LLM messages for chat completion. .. deprecated:: 0.0.79 This class is deprecated and will be removed in a future version. Instead, use either: - `LLMMessagesUpdateFrame` with `run_llm=True` - `OpenAILLMContextFrame` with desired messages in a new context A frame containing a list of LLM messages. Used to signal that an LLM service should run a chat completion and emit an LLMFullResponseStartFrame, TextFrames and an LLMFullResponseEndFrame. Note that the `messages` property in this class is mutable, and will be updated by various aggregators. Parameters: messages: List of message dictionaries in LLM format. rct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%zLLMMessagesFrame is deprecated and will be removed in a future version. Instead, use either `LLMMessagesUpdateFrame` with `run_llm=True`, or `OpenAILLMContextFrame` with desired messages in a new contextr&r'rrs r0rZzLLMMessagesFrame.__post_init__ s_   $ $ &   ! !( + MMQ#     r) rCrDrErFr dictr_rZrrs@r0rrs$4j  r;rceZdZdZy) LLMRunFramezFrame to trigger LLM processing with current context. A frame that instructs the LLM service to process the current context and generate a response. NrcrIr;r0rrrdr;rc6eZdZUdZeeed<dZee ed<y)LLMMessagesAppendFramea3Frame containing LLM messages to append to current context. A frame containing a list of LLM messages that need to be added to the current context. Parameters: messages: List of message dictionaries to append. run_llm: Whether the context update should be sent to the LLM. rNrun_llm rCrDrErFr rr_rr rrIr;r0rr&!4j"GXd^"r;rc6eZdZUdZeeed<dZee ed<y)LLMMessagesUpdateFrameaEFrame containing LLM messages to replace current context. A frame containing a list of new LLM messages to replace the current context LLM messages. Parameters: messages: List of message dictionaries to replace current context. run_llm: Whether the context update should be sent to the LLM. rNrrrIr;r0r r 6rr;r c.eZdZUdZeeezdzed<y)LLMSetToolsFrameaDFrame containing tools for LLM function calling. A frame containing a list of tools for an LLM to use for function calling. The specific format depends on the LLM being used, but it should typically contain JSON Schema objects. Parameters: tools: List of tool/function definitions for the LLM. rtoolsN)rCrDrErFr rrr_rIr;r0r r Fs : #j 00r;r c(eZdZUdZedezed<y)LLMSetToolChoiceFramezFrame containing tool choice configuration for LLM function calling. Parameters: tool_choice: Tool choice setting - 'none', 'auto', 'required', or specific tool dict. )noneautorequired tool_choiceN)rCrDrErFr rr_rIr;r0rrUs 34t;;r;rceZdZUdZeed<y)LLMEnablePromptCachingFramezwFrame to enable/disable prompt caching in LLMs. Parameters: enable: Whether to enable prompt caching. enableNrCrDrErFrr_rIr;r0rr` Lr;rceZdZUdZeed<y)LLMConfigureOutputFrameahFrame to configure LLM output. This frame is used to configure how the LLM produces output. For example, it can tell the LLM to generate tokens that should be added to the context but not spoken by the TTS service (if one is present in the pipeline). Parameters: skip_tts: Whether LLM tokens should skip the TTS service (if any). rNrrIr;r0rrksNr;rcJeZdZUdZdZeeed<dZee ge dfed<y)FunctionCallResultPropertieszProperties for configuring function call result behavior. Parameters: run_llm: Whether to run the LLM after receiving this result. on_context_updated: Callback to execute when context is updated. Nron_context_updated) rCrDrErFrr rr_rrrrIr;r0rrzs5#GXd^"BF"io*=!>?Fr;rcbeZdZUdZeed<eed<eed<eed<dZee ed<dZ ee ed<y) FunctionCallResultFramea*Frame containing the result of an LLM function call. This is an uninterruptible frame because once a result is generated we always want to update the context. Parameters: function_name: Name of the function that was executed. tool_call_id: Unique identifier for the function call. arguments: Arguments that were passed to the function. result: The result returned by the function. run_llm: Whether to run the LLM after this result. properties: Additional properties for result handling. function_name tool_call_id argumentsrNr properties) rCrDrErFr`r_rrr rr#rrIr;r0rrs= N K"GXd^"9=J56=r;rc0eZdZUdZeed<dZeeed<y) TTSSpeakFrameaFrame containing text that should be spoken by TTS. A frame that contains text that should be spoken by the TTS service in the pipeline (if any). Parameters: text: The text to be spoken. append_to_context: Whether to append the text to the context. rNr) rCrDrErFr`r_rr rrIr;r0r%r%s I(,x~,r;r%c"eZdZUdZeed<dZy)OutputTransportMessageFramezwFrame containing transport-specific message data. Parameters: message: The transport message payload. messagec:|jd|jdSNz (message: rr?r(rYs r0r]z#OutputTransportMessageFrame.__str__))Jt||nA66r;NrCrDrErFrr_r]rIr;r0r'r' L7r;r'c"eZdZdZfdZxZS)TransportMessageFrameaFrame containing transport-specific message data. .. deprecated:: 0.0.87 This frame is deprecated and will be removed in a future version. Instead, use `OutputTransportMessageFrame`. Parameters: message: The transport message payload. ct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%zvTransportMessageFrame is deprecated and will be removed in a future version. Instead, use OutputTransportMessageFrame.r&r'rrs r0rZz#TransportMessageFrame.__post_init__\   $ $ &   ! !( + MM<"     rrrs@r0r0r0  r;r0ceZdZUdZeed<y) DTMFFramezBase class for DTMF (Dual-Tone Multi-Frequency) keypad frames. Parameters: button: The DTMF keypad entry that was pressed. buttonN)rCrDrErFrGr_rIr;r0r5r5s r;r5ceZdZdZy)OutputDTMFFrameaDTMF keypress output frame for transport queuing. A DTMF keypress output that will be queued. If your transport supports multiple dial-out destinations, use the `transport_destination` field to specify where the DTMF keypress should be sent. NrcrIr;r0r8r8rgr;r8ceZdZUdZdZeed<dZeed<dZe ed<dZ e ed<dZ e ed <dZ e ed <e e Zeeed <dZe ed <dZeded<y) StartFrameaFInitial frame to start pipeline processing. This is the first frame that should be pushed down a pipeline to initialize all processors with their configuration parameters. Parameters: audio_in_sample_rate: Input audio sample rate in Hz. audio_out_sample_rate: Output audio sample rate in Hz. allow_interruptions: Whether to allow user interruptions. .. deprecated:: 0.0.99 Use `LLMUserAggregator`'s new `user_mute_strategies` parameter instead. enable_metrics: Whether to enable performance metrics collection. enable_tracing: Whether to enable OpenTelemetry tracing. enable_usage_metrics: Whether to enable usage metrics collection. interruption_strategies: List of interruption handling strategies. .. deprecated:: 0.0.99 Use `LLMUserAggregator`'s new `user_turn_strategies` parameter instead. report_only_initial_ttfb: Whether to report only initial time-to-first-byte. tracing_context: Pipeline-scoped tracing context for span hierarchy. i>audio_in_sample_ratei]audio_out_sample_rateFallow_interruptionsenable_metricsenable_tracingenable_usage_metricsdefault_factoryinterruption_strategiesreport_only_initial_ttfbNr!tracing_context)rCrDrErFr;r^r_r<r=rr>r?r@rlistrCr rrDrEr rIr;r0r:r:s{2!&#%!&3& %% ND  ND !&$&>CTX>YT":;Y%*d*26OX./6r;r:c,eZdZUdZdZeeed<dZy) CancelFramezFrame indicating pipeline should stop immediately. Indicates that a pipeline needs to stop right away without processing remaining queued frames. Parameters: reason: Optional reason for pushing a cancel frame. Nreasonc:|jd|jdSNz (reason: rr?rIrYs r0r]zCancelFrame.__str__'))Idkk]!44r; rCrDrErFrIr rr_r]rIr;r0rHrHs!FHSM 5r;rHcXeZdZUdZeed<dZeed<dZe ded<dZ e e ed<d Z y) ErrorFrameaFrame notifying of errors in the pipeline. This is used to notify upstream that an error has occurred downstream in the pipeline. A fatal error indicates the error is unrecoverable and that the bot should exit. Parameters: error: Description of the error that occurred. fatal: Whether the error is fatal and requires bot shutdown. processor: The frame processor that generated the error. exception: The exception that occurred. errorFfatalNr processor exceptioncT|jd|jd|jdS)Nz(error: z , fatal: r)r?rQrRrYs r0r]zErrorFrame.__str__?s'))HTZZL $**QGGr;) rCrDrErFr`r_rRrrSr rT Exceptionr]rIr;r0rPrP+s=  JE4,0Ix()0%)Ix ")Hr;rPc0eZdZUdZeddZeed<y)FatalErrorFramezFrame notifying of unrecoverable errors requiring bot shutdown. This is used to notify upstream that an unrecoverable error has occurred and that the bot should exit immediately. Parameters: fatal: Always True for fatal errors. TFrrrRN)rCrDrErFrrRrr_rIr;r0rXrXCs51E41r;rXceZdZUdZded<y)FrameProcessorPauseUrgentFramea~Frame to pause frame processing immediately. This frame is used to pause frame processing for the given processor as fast as possible. Pausing frame processing will keep frames in the internal queue which will then be processed when frame processing is resumed with `FrameProcessorResumeFrame`. Parameters: processor: The frame processor to pause. rrSNrrIr;r0rZrZQ  r;rZceZdZUdZded<y)FrameProcessorResumeUrgentFrameaTFrame to resume frame processing immediately. This frame is used to resume frame processing for the given processor if it was previously paused as fast as possible. After resuming frame processing all queued frames will be processed in the order received. Parameters: processor: The frame processor to resume. rrSNrrIr;r0r]r]a r;r]ceZdZdZy)InterruptionFramezFrame pushed to interrupt the pipeline. This frame is used to interrupt the pipeline. For example, when a user starts speaking to cancel any in-progress bot output. It can also be pushed by any processor. NrcrIr;r0r`r`prgr;r`c"eZdZdZfdZxZS)StartInterruptionFrameaFrame indicating user started speaking (interruption detected). .. deprecated:: 0.0.85 This frame is deprecated and will be removed in a future version. Instead, use `InterruptionFrame`. Emitted by the BaseInputTransport to indicate that a user has started speaking (i.e. is interrupting). This is similar to UserStartedSpeakingFrame except that it should be pushed concurrently with other frames (so the order is not guaranteed). ct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%zmStartInterruptionFrame is deprecated and will be removed in a future version. Instead, use InterruptionFrame.r&r'rrs r0rZz$StartInterruptionFrame.__post_init__s\   $ $ &   ! !( + MM2"     rrrs@r0rbrb|   r;rbc eZdZUdZdZeed<y)UserStartedSpeakingFramea|Frame indicating that the user turn has started. Emitted when the user turn starts, which usually means that some transcriptions are already available. Parameters: emulated: Whether this event was emulated rather than detected by VAD. .. deprecated:: 0.0.99 This field is deprecated and will be removed in a future version. FemulatedNrCrDrErFrgrr_rIr;r0rfrf Hdr;rfc eZdZUdZdZeed<y)UserStoppedSpeakingFrameakFrame indicating that the user turn has ended. Emitted when the user turn ends. This usually coincides with the start of the bot turn. Parameters: emulated: Whether this event was emulated rather than detected by VAD. .. deprecated:: 0.0.99 This field is deprecated and will be removed in a future version. FrgNrhrIr;r0rkrkrir;rkceZdZdZy)UserMuteStartedFramezFrame indicating that the user has been muted. Emitted when a mute strategy activates, suppressing user frames (audio, transcription, interruption) from propagating through the pipeline. NrcrIr;r0rmrmrdr;rmceZdZdZy)UserMuteStoppedFramezFrame indicating that the user has been unmuted. Emitted when a mute strategy deactivates, allowing user frames to propagate through the pipeline again. NrcrIr;r0rorordr;roceZdZdZy)UserSpeakingFramezaFrame indicating the user is speaking. Emitted by VAD to indicate the user is speaking. NrcrIr;r0rqrq   r;rqc"eZdZdZfdZxZS)EmulateUserStartedSpeakingFrameaFrame to emulate user started speaking behavior. Emitted by internal processors upstream to emulate VAD behavior when a user starts speaking. .. deprecated:: 0.0.99 This frame is deprecated and will be removed in a future version. ct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%zVEmulateUserStartedSpeakingFrame is deprecated and will be removed in a future version.r&r'rrs r0rZz-EmulateUserStartedSpeakingFrame.__post_init__Z   $ $ &   ! !( + MMh"     rrrs@r0rtrt  r;rtc"eZdZdZfdZxZS)EmulateUserStoppedSpeakingFrameaFrame to emulate user stopped speaking behavior. Emitted by internal processors upstream to emulate VAD behavior when a user stops speaking. .. deprecated:: 0.0.99 This frame is deprecated and will be removed in a future version. ct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%zVEmulateUserStoppedSpeakingFrame is deprecated and will be removed in a future version.r&r'rrs r0rZz-EmulateUserStoppedSpeakingFrame.__post_init__rvrrrs@r0ryryrwr;rycPeZdZUdZdZeed<eejZ eed<y)VADUserStartedSpeakingFramea{Frame emitted when VAD definitively detects user started speaking. Parameters: start_secs: The VAD start_secs duration that was used to confirm the user started speaking. This represents the speech duration that had to elapse before the VAD determined speech began. timestamp: Wall-clock time when the VAD made its determination. start_secsrArN) rCrDrErFr~floatr_rtimerrIr;r0r|r|s&JTYY7Iu7r;r|cPeZdZUdZdZeed<eejZ eed<y)VADUserStoppedSpeakingFrameazFrame emitted when VAD definitively detects user stopped speaking. Parameters: stop_secs: The VAD stop_secs duration that was used to confirm the user stopped speaking. This represents the silence duration that had to elapse before the VAD determined speech ended. timestamp: Wall-clock time when the VAD made its determination. r} stop_secsrArN) rCrDrErFrrr_rrrrIr;r0rrs&IuTYY7Iu7r;rceZdZdZy)BotStartedSpeakingFramezFrame indicating the bot started speaking. Emitted upstream and downstream by the BaseTransportOutput to indicate the bot started speaking. NrcrIr;r0rr,rdr;rceZdZdZy)BotStoppedSpeakingFramezFrame indicating the bot stopped speaking. Emitted upstream and downstream by the BaseTransportOutput to indicate the bot stopped speaking. NrcrIr;r0rr7rdr;rceZdZdZy)BotSpeakingFrameaTFrame indicating the bot is currently speaking. Emitted upstream and downstream by the BaseOutputTransport while the bot is still speaking. This can be used, for example, to detect when a user is idle. That is, while the bot is speaking we don't want to trigger any user idle timeout since the user might be listening. NrcrIr;r0rrB  r;rc"eZdZUdZeeed<y) MetricsFramezFrame containing performance metrics data. Emitted by processors that can compute metrics like latencies. Parameters: data: List of metrics data collected by the processor. dataN)rCrDrErFr rr_rIr;r0rrOs { r;rcDeZdZUdZeed<eed<eeefed<eed<y)FunctionCallFromLLMaRepresents a function call returned by the LLM. Represents a function call returned by the LLM to be registered for execution. Parameters: function_name: The name of the function to call. tool_call_id: A unique identifier for the function call. arguments: The arguments to pass to the function. context: The LLM context when the function call was made. r r!r"rN)rCrDrErFr`r_r rrIr;r0rr\s) sCx  Lr;rc"eZdZUdZeeed<y)FunctionCallsStartedFramezFrame signaling that function call execution is starting. A frame signaling that one or more function call execution is going to start. Parameters: function_calls: Sequence of function calls that will be executed. function_callsN)rCrDrErFrrr_rIr;r0rros011r;rc&eZdZUdZeed<eed<y)FunctionCallCancelFramezFrame signaling that a function call has been cancelled. Parameters: function_name: Name of the function that was cancelled. tool_call_id: Unique identifier for the cancelled function call. r r!NrrIr;r0rr}sr;rceZdZUdZeed<y) STTMuteFramezFrame to mute/unmute the Speech-to-Text service. Parameters: mute: Whether to mute (True) or unmute (False) the STT service. muteNrrIr;r0rrs Jr;rc"eZdZUdZeed<dZy)InputTransportMessageFramezFrame for transport messages received from external sources. Parameters: message: The urgent transport message payload. r(c:|jd|jdSr*r+rYs r0r]z"InputTransportMessageFrame.__str__r,r;Nr-rIr;r0rrr.r;rc"eZdZdZfdZxZS) InputTransportMessageUrgentFramea"Frame for transport messages received from external sources. .. deprecated:: 0.0.87 This frame is deprecated and will be removed in a future version. Instead, use `InputTransportMessageFrame`. Parameters: message: The urgent transport message payload. ct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%zInputTransportMessageUrgentFrame is deprecated and will be removed in a future version. Instead, use InputTransportMessageFrame.r&r'rrs r0rZz.InputTransportMessageUrgentFrame.__post_init__s\   $ $ &   ! !( + MM;"     rrrs@r0rrr3r;rc"eZdZUdZeed<dZy)!OutputTransportMessageUrgentFramezFrame for urgent transport messages that need to be sent immediately. Parameters: message: The urgent transport message payload. r(c:|jd|jdSr*r+rYs r0r]z)OutputTransportMessageUrgentFrame.__str__r,r;Nr-rIr;r0rrr.r;rc"eZdZdZfdZxZS)TransportMessageUrgentFramea2Frame for urgent transport messages that need to be sent immediately. .. deprecated:: 0.0.87 This frame is deprecated and will be removed in a future version. Instead, use `OutputTransportMessageUrgentFrame`. Parameters: message: The urgent transport message payload. ct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%z|TransportMessageUrgentFrame is deprecated and will be removed in a future version. Instead, use OutputTransportMessageFrame.r&r'rrs r0rZz)TransportMessageUrgentFrame.__post_init__r2rrrs@r0rrr3r;rceZdZUdZeed<dZeeed<dZee ed<dZ eeed<dZ eeed<dZ eeed<dZ eeed <dZeeed <fd Zd ZxZS) UserImageRequestFramea%Frame requesting an image from a specific user. A frame to request an image from the given user. The request might come with a text that can be later used to describe the requested image. Parameters: user_id: Identifier of the user to request image from. text: An optional text associated to the image request. append_to_context: Whether the requested image should be appended to the LLM context. video_source: Specific video source to capture from. function_name: Name of function that generated this request (if any). tool_call_id: Tool call ID if generated by function call (if any). result_callback: Optional callback to invoke when the image is retrieved. context: [DEPRECATED] Optional context for the image request. rNrr video_sourcer r!result_callbackrct||jrGddl}|j 5|j d|j dtddddyy#1swYyxYw)Nrr%z6`UserImageRequestFrame` field `context` is deprecated.r&r')rrZrr*r+r,r-r.rs r0rZz#UserImageRequestFrame.__post_init__sk  << ((* %%h/ L&      s *A$$A-c |jd|jd|jd|jd|jd S)Nr, text: rz, r)r?rrrrrYs r0r]zUserImageRequestFrame.__str__s\))GDLL>$))DYZ^ZpZpYqqstxuFuFtGGHI Ir;)rCrDrErFr`r_rr rrrr r!rrrrZr]rrs@r0rrs} LD(3-(,x~,"&L(3-&#'M8C='"&L(3-&%)OXc])!GXc]! Ir;rc(eZdZdZfdZdZxZS)InputAudioRawFramezRaw audio input frame from transport. A chunk of audio usually coming from an input transport. If the transport supports multiple audio sources (e.g. multiple audio tracks) the source name will be specified in transport_source. ct|tt|j|j dzz |_yrvrrs r0rZz InputAudioRawFrame.__post_init__rr;ct|j}|jd|d|jdt |j d|j d|jd|jdS)Nr , source: rrrrr) rLrJr?rTrwrortrprqrs r0r]zInputAudioRawFrame.__str__s"))F3%z$2G2G1HQTUYU_U_Q`Paaklpl{l{k|}LMQM]M]L^^jkok|k|j}}~ r;rrs@r0rrsIr;rceZdZdZdZy)InputImageRawFramezRaw image input frame from transport. An image usually coming from an input transport. If the transport supports multiple video sources (e.g. multiple video tracks) the source name will be specified in transport_source. c t|j}|jd|d|jd|jd|j d S)Nrrrrr)rLrJr?rTr|r}rs r0r]zInputImageRawFrame.__str__-sR"))F3%z$2G2G1HQUQZQZP[[efjfqfqerrsttr;NrrIr;r0rr$s ur;rceZdZdZdZy)InputTextRawFramea Raw text input frame from transport. Text input usually coming from user typing or programmatic text injection that should be sent to LLM services as input, similar to how InputAudioRawFrame and InputImageRawFrame represent user audio and video input. ct|j}|jd|d|jd|jdS)Nrrrr)rLrJr?rTrrs r0r]zInputTextRawFrame.__str__;sC"))F3%z$2G2G1H RVR[R[Q\\^__r;NrrIr;r0rr2s `r;rc&eZdZUdZdZeed<dZy)UserAudioRawFramezRaw audio input frame associated with a specific user. A chunk of audio, usually coming from an input transport, associated to a user. Parameters: user_id: Identifier of the user who provided this audio. rct|j}|jd|d|jd|jdt |j d|jd|jd|jdS) Nr, user: rrrrrr) rLrJr?rrTrwrortrprqrs r0r]zUserAudioRawFrame.__str__Ls"))F3%x ~ZH]H]G^^fgjkokukugvfwxBCGCRCRBSSbcgcscsbtt@AEARAR@SSTU Ur;N)rCrDrErFrr`r_r]rIr;r0rr@sGSUr;rcbeZdZUdZdZeed<dZeeed<dZ ee ed<dZ ee ed<dZ y) UserImageRawFrameaRaw image input frame associated with a specific user. An image associated to a user, potentially in response to an image request. Parameters: user_id: Identifier of the user who provided this image. text: An optional text associated to this image. append_to_context: Whether the requested image should be appended to the LLM context. request: The original image request frame if this is a response. rrNrrrequestct|j}|jd|d|jd|jd|j d|j d|jd|jdS) Nrrrrrrrr) rLrJr?rrTr|r}rrrs r0r]zUserImageRawFrame.__str__cs"))F3%x ~ZH]H]G^^fgkgpgpfqq{}A}H}H|IIQRVR[R[Q\\qrvrHrHqIIJK Kr;)rCrDrErFrr`r_rr rrrrr]rIr;r0rrQsF GSD(3-(,x~,/3GX+ ,3Kr;rc:eZdZUdZdZeeed<dZee ed<y)AssistantImageRawFrameaFrame containing an image generated by the assistant. Contains both the raw frame for display (superclass functionality) as well as the original image, which can get used directly in LLM contexts. Parameters: original_data: The original image data, which can get used directly in an LLM context message without further encoding. original_mime_type: The MIME type of the original image data. N original_dataoriginal_mime_type) rCrDrErFrr rxr_rr`rIr;r0rrhs& &*M8E?)(, ,r;rceZdZdZy)InputDTMFFramez)DTMF keypress input frame from transport.NrcrIr;r0rrys3r;rceZdZdZy)OutputDTMFUrgentFramea DTMF keypress output frame for immediate sending. A DTMF keypress output that will be sent right away. If your transport supports multiple dial-out destinations, use the `transport_destination` field to specify where the DTMF keypress should be sent. NrcrIr;r0rrrgr;rc:eZdZUdZdZeeed<dZee ed<y)SpeechControlParamsFrameaFrame for notifying processors of speech control parameter changes. This includes parameters for both VAD (Voice Activity Detection) and turn-taking analysis. It allows downstream processors to adjust their behavior based on updated interaction control settings. Parameters: vad_params: Current VAD parameters. turn_params: Current turn-taking analysis parameters. N vad_params turn_params) rCrDrErFrr rr_rrrIr;r0rrs' '+J#*,0K.)0r;rceZdZUdZeed<y)ServiceMetadataFrameaBase metadata frame for services. Broadcast by services at pipeline start to share service-specific configuration and performance characteristics with downstream processors. Parameters: service_name: The name of the service broadcasting this metadata. service_nameNrrIr;r0rrsr;rceZdZUdZeed<y)STTMetadataFrameaMetadata from STT service. Broadcast by STT services to inform downstream processors (like turn strategies) about STT latency characteristics. Parameters: ttfs_p99_latency: Time to final segment P99 latency in seconds. This is the expected time from when speech ends to when the final transcript is received, at the 99th percentile. ttfs_p99_latencyNrCrDrErFrr_rIr;r0rrs r;rceZdZUdZded<y)#ServiceSwitcherRequestMetadataFrameaRequest a service to re-emit its metadata frames. Used by ServiceSwitcher when switching active services to ensure downstream processors receive updated metadata from the newly active service. Services that receive this frame should re-push their metadata frame (e.g., STTMetadataFrame for STT services). Parameters: service: The target service that should re-emit its metadata. rserviceNrrIr;r0rrs r;rceZdZdZy) TaskFramea'Base frame for task frames. This is a base class for frames that are meant to be sent and handled upstream by the pipeline task. This might result in a corresponding frame sent downstream (e.g. `InterruptionTaskFrame` / `InterruptionFrame` or `EndTaskFrame` / `EndFrame`). NrcrIr;r0rrrjr;rc,eZdZUdZdZeeed<dZy) EndTaskFrameaJFrame to request graceful pipeline task closure. This is used to notify the pipeline task that the pipeline should be closed nicely (flushing all the queued frames) by pushing an EndFrame downstream. This frame should be pushed upstream. Parameters: reason: Optional reason for pushing an end frame. NrIc:|jd|jdSrKrLrYs r0r]zEndTaskFrame.__str__rMr;rNrIr;r0rr!FHSM 5r;rc,eZdZUdZdZeeed<dZy)CancelTaskFramea9Frame to request immediate pipeline task cancellation. This is used to notify the pipeline task that the pipeline should be stopped immediately by pushing a CancelFrame downstream. This frame should be pushed upstream. Parameters: reason: Optional reason for pushing a cancel frame. NrIc:|jd|jdSrKrLrYs r0r]zCancelTaskFrame.__str__rMr;rNrIr;r0rrrr;rceZdZdZy) StopTaskFramea=Frame to request pipeline task stop while keeping processors running. This is used to notify the pipeline task that it should be stopped as soon as possible (flushing all the queued frames) but that the pipeline processors should be kept in a running state. This frame should be pushed upstream. NrcrIr;r0rrrr;rceZdZdZy)InterruptionTaskFramezFrame indicating the pipeline should be interrupted. This frame should be pushed upstream to indicate the pipeline should be interrupted. The pipeline task converts this into an `InterruptionFrame` and sends it downstream. NrcrIr;r0rrrgr;rc"eZdZdZfdZxZS)BotInterruptionFrameaFrame indicating the bot should be interrupted. .. deprecated:: 0.0.85 This frame is deprecated and will be removed in a future version. Instead, use `InterruptionTaskFrame`. Emitted when the bot should be interrupted. This will mainly cause the same actions as if the user interrupted except that the UserStartedSpeakingFrame and UserStoppedSpeakingFrame won't be generated. This frame should be pushed upstream. ct|ddl}|j5|j d|j dt ddddy#1swYyxYw)Nrr%zoBotInterruptionFrame is deprecated and will be removed in a future version. Instead, use InterruptionTaskFrame.r&r'rrs r0rZz"BotInterruptionFrame.__post_init__)s\   $ $ &   ! !( + MM6"     rrrs@r0rrrdr;rc,eZdZUdZdZeeed<dZy)EndFrameaFrame indicating pipeline has ended and should shut down. Indicates that a pipeline has ended and frame processors and pipelines should be shut down. If the transport receives this frame, it will stop sending frames to its output channel(s) and close all its threads. Note, that this is a control frame, which means it will be received in the order it was sent. This frame is marked as UninterruptibleFrame to ensure it is not lost when an InterruptionFrame is processed. Terminal frames must survive interruption to guarantee proper pipeline shutdown. Parameters: reason: Optional reason for pushing an end frame. NrIc:|jd|jdSrKrLrYs r0r]zEndFrame.__str__PrMr;rNrIr;r0rr<s !FHSM 5r;rceZdZdZy) StopFrameaFrame indicating pipeline should stop but keep processors running. Indicates that a pipeline should be stopped but that the pipeline processors should be kept in a running state. This is normally queued from the pipeline task. This frame is marked as UninterruptibleFrame to ensure it is not lost when an InterruptionFrame is processed. Terminal frames must survive interruption to guarantee proper pipeline control. NrcrIr;r0rrTs   r;rceZdZdZy)BotConnectedFramezFrame indicating the bot has connected to the transport service. Pushed downstream by SFU transports (Daily, LiveKit, HeyGen, Tavus) when the bot successfully joins the room. Non-SFU transports do not emit this frame. NrcrIr;r0rrdrgr;rceZdZdZy)ClientConnectedFramezFrame indicating that a client has connected to the transport. Pushed downstream by the input transport when a client (participant) connects. Used by observers to measure transport readiness timing. NrcrIr;r0rrprdr;rceZdZdZy)OutputTransportReadyFramezFrame indicating that the output transport is ready. Indicates that the output transport is ready and able to receive frames. NrcrIr;r0rr{rrr;rceZdZUdZeed<y)HeartbeatFramezFrame used by pipeline task to monitor pipeline health. This frame is used by the pipeline task as a mechanism to know if the pipeline is running properly. Parameters: timestamp: Timestamp when the heartbeat was generated. rN)rCrDrErFr^r_rIr;r0rrsNr;rceZdZUdZded<y)FrameProcessorPauseFrameawFrame to pause frame processing for a specific processor. This frame is used to pause frame processing for the given processor. Pausing frame processing will keep frames in the internal queue which will then be processed when frame processing is resumed with `FrameProcessorResumeFrame`. Parameters: processor: The frame processor to pause. rrSNrrIr;r0rrr[r;rceZdZUdZded<y)FrameProcessorResumeFrameaMFrame to resume frame processing for a specific processor. This frame is used to resume frame processing for the given processor if it was previously paused. After resuming frame processing all queued frames will be processed in the order received. Parameters: processor: The frame processor to resume. rrSNrrIr;r0rrr^r;rcFeZdZUdZedZeeed<fdZ xZ S)LLMFullResponseStartFramezFrame indicating the beginning of an LLM response. Used to indicate the beginning of an LLM response. Followed by one or more TextFrames and a final LLMFullResponseEndFrame. FrOrc0t|d|_yr\rrZrrs r0rZz'LLMFullResponseStartFrame.__post_init__  r; rCrDrErFrrr rr_rZrrs@r0rrs' %%0Hhtn0r;rcFeZdZUdZedZeeed<fdZ xZ S)LLMFullResponseEndFramez,Frame indicating the end of an LLM response.FrOrc0t|d|_yr\rrs r0rZz%LLMFullResponseEndFrame.__post_init__rr;rrs@r0rrs#6$%0Hhtn0r;rceZdZdZy) LLMAssistantPushAggregationFrameaXFrame that forces the LLM assistant aggregator to push its current aggregation to context. When received by ``LLMAssistantAggregator``, any text that has been accumulated in the aggregation buffer is immediately committed to the conversation context as an assistant message, without waiting for an ``LLMFullResponseEndFrame``. NrcrIr;r0rrsr;rc&eZdZUdZdZeded<y)LLMSummarizeContextFrameaFrame requesting on-demand context summarization. Push this frame into the pipeline to trigger a manual context summarization. Parameters: config: Optional per-request override for summary generation settings (prompt, token budget, messages to keep). If ``None``, the summarizer's default :class:`~pipecat.utils.context.llm_context_summarization.LLMContextSummaryConfig` is used. Nr config)rCrDrErFrr r_rIr;r0rrs 37FH. /6r;rcXeZdZUdZeed<ded<eed<eed<eed<dZee ed <y) LLMContextSummaryRequestFrameacFrame requesting context summarization from an LLM service. Sent by aggregators to LLM services when conversation context needs to be compressed. The LLM service generates a summary of older messages while preserving recent conversation history. Parameters: request_id: Unique identifier to match this request with its response. Used to handle async responses and avoid race conditions. context: The full LLM context containing all messages to analyze and summarize. min_messages_to_keep: Number of recent messages to preserve uncompressed. These messages will not be included in the summary. target_context_tokens: Maximum token size for the generated summary. This value is passed directly to the LLM as the max_tokens parameter when generating the summary text. summarization_prompt: System prompt instructing the LLM how to generate the summary. summarization_timeout: Maximum time in seconds for the LLM to generate a summary. When None, a default timeout of 120s is applied. request_idrrmin_messages_to_keeptarget_context_tokenssummarization_promptNsummarization_timeout) rCrDrErFr`r_r^r r rrIr;r0rrs5*O -18E?1r;rcDeZdZUdZeed<eed<eed<dZeeed<y)LLMContextSummaryResultFrameaFrame containing the result of context summarization. Sent by LLM services back to aggregators after generating a summary. Contains the formatted summary message and metadata about what was summarized. Parameters: request_id: Identifier matching the original request. Used to correlate async responses. summary: The formatted summary message ready to be inserted into context. last_summarized_index: Index (0-based) of the last message that was included in the summary. Messages after this index are preserved. error: Error message if summarization failed, None on success. rsummarylast_summarized_indexNrQ) rCrDrErFr`r_r^rQr rIr;r0r r s' O LE8C=r;r c>eZdZUdZeed<eed<eed<dZeed<y)FunctionCallInProgressFrameaFrame signaling that a function call is currently executing. This is an uninterruptible frame because we always want to update the context. Parameters: function_name: Name of the function being executed. tool_call_id: Unique identifier for this function call. arguments: Arguments passed to the function. cancel_on_interruption: Whether to cancel this call if interrupted. r r!r"Fcancel_on_interruptionN) rCrDrErFr`r_rrrrIr;r0rrs% N#(D(r;rceZdZdZy)VisionFullResponseStartFramezFrame indicating the beginning of a vision model response. Used to indicate the beginning of a vision model response. Followed by one or more VisionTextFrames and a final VisionFullResponseEndFrame. NrcrIr;r0rr/rgr;rceZdZdZy)VisionFullResponseEndFramez4Frame indicating the end of a Vision model response.NrcrIr;r0rr;s>r;rc&eZdZUdZdZeeed<y)TTSStartedFrameaFrame indicating the beginning of a TTS response. Used to indicate the beginning of a TTS response. Following TTSAudioRawFrames are part of the TTS response until a TTSStoppedFrame. These frames can be used for aggregating audio frames in a transport to optimize the size of frames sent to the session, without needing to control this in the TTS service. Parameters: context_id: Unique identifier for this TTS context. NrrrIr;r0rrBs !%J $r;rc&eZdZUdZdZeeed<y)TTSStoppedFramez}Frame indicating the end of a TTS response. Parameters: context_id: Unique identifier for this TTS context. NrrrIr;r0rrSrr;rcLeZdZUdZeeZeee fe d<dZ e de d<y)ServiceUpdateSettingsFrameaBase frame for updating service settings. Supports both a ``settings`` dict (for backward compatibility) and a ``delta`` object. When both are provided, ``delta`` takes precedence. Parameters: settings: Dictionary of setting name to value mappings. .. deprecated:: 0.0.104 Use ``delta`` with a typed settings object instead. delta: :class:`~pipecat.services.settings.ServiceSettings` delta-mode object describing the fields to change. rAsettingsNrdelta) rCrDrErFrrrr r`rr_rr rIr;r0rr^s1 #("=Hgc3h=)-E8% &-r;rceZdZdZy)LLMUpdateSettingsFramez(Frame for updating LLM service settings.NrcrIr;r0rrsrr;rceZdZdZy)TTSUpdateSettingsFramez(Frame for updating TTS service settings.NrcrIr;r0r!r!zrr;r!ceZdZdZy)STTUpdateSettingsFramez(Frame for updating STT service settings.NrcrIr;r0r#r#rr;r#ceZdZUdZeed<y)UserIdleTimeoutUpdateFramezFrame for updating the user idle timeout at runtime. Setting timeout to 0 disables idle detection. Setting a positive value enables it. Parameters: timeout: The new idle timeout in seconds. 0 disables idle detection. timeoutNrrIr;r0r%r%sNr;r%ceZdZUdZeed<y)VADParamsUpdateFramezFrame for updating VAD parameters. A control frame containing a request to update VAD params. Intended to be pushed upstream from RTVI processor. Parameters: params: New VAD parameters to apply. paramsN)rCrDrErFrr_rIr;r0r(r(s r;r(ceZdZdZy)FilterControlFramez/Base control frame for audio filter operations.NrcrIr;r0r+r+s9r;r+c&eZdZUdZeeefed<y)FilterUpdateSettingsFramezFrame for updating audio filter settings. Parameters: settings: Dictionary of filter setting name to value mappings. rNrCrDrErFr r`rr_rIr;r0r-r- c3hr;r-ceZdZUdZeed<y)FilterEnableFramezFrame for enabling/disabling audio filters at runtime. Parameters: enable: Whether to enable (True) or disable (False) the filter. rNrrIr;r0r1r1rr;r1ceZdZdZy)MixerControlFramez.Base control frame for audio mixer operations.NrcrIr;r0r3r3s8r;r3c&eZdZUdZeeefed<y)MixerUpdateSettingsFramezFrame for updating audio mixer settings. Parameters: settings: Dictionary of mixer setting name to value mappings. rNr.rIr;r0r5r5r/r;r5ceZdZUdZeed<y)MixerEnableFramezFrame for enabling/disabling audio mixer at runtime. Parameters: enable: Whether to enable (True) or disable (False) the mixer. rNrrIr;r0r7r7rr;r7ceZdZdZy)ServiceSwitcherFramez=A base class for frames that affect ServiceSwitcher behavior.NrcrIr;r0r9r9sGr;r9ceZdZUdZded<y)ManuallySwitchServiceFramezA frame to request a manual switch in the active service in a ServiceSwitcher. Handled by ServiceSwitcherStrategyManual to switch the active service. rrNrrIr;r0r;r;s r;r;)rFr dataclassesrrtypingrrrrr r r r r rr%pipecat.adapters.schemas.tools_schemarpipecat.audio.dtmf.typesrrG6pipecat.audio.interruptions.base_interruption_strategyr%pipecat.audio.turn.base_turn_analyzerrpipecat.audio.vad.vad_analyzerrpipecat.metrics.metricsrpipecat.transcriptions.languager'pipecat.utils.text.base_text_aggregatorrpipecat.utils.timerpipecat.utils.utilsrr*pipecat.processors.aggregators.llm_contextrr"pipecat.processors.frame_processorrpipecat.services.settingsr/pipecat.utils.context.llm_context_summarizationr %pipecat.utils.tracing.tracing_contextr!r#r^rLrNrbrfrirlrnrzrrrrrrrrrrrrrrrrrrrrrrrrrrr r rrrrrr%r'r0r5r8r:rHrPrXrZr]r`rbrfrkrmrorqrtryr|rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr rrrrrrrr!r#r%r(r+r-r1r3r5r7r9r;rIr;r0rMs2 (    >B[@4/4C11OA9WD2 2 j$% 4HSM4 $$ $N  %           5     $        II I&     & I)]I I"  )]     %* %  %  3    e*e e" D)D D$ $? $? $?N 090 0  %) %  %  l    %&% % AA A2 A A A0 AyA A( i :        F  2 AJyAJ AJH  e     <   6 E)E E.  G G  G  "y" "J  )     #Y #  #  #Y #  #  1y 1  1 i)=> >0  -I -  -  7) 7  7 7 2    i    "7"7 "7J  5+ 5  5  HH H.  2j 2  2   [        k           . 6 { " { "  ;     ;         k 0 k 0  8+ 8  8  8+ 8  8  k     k      {       ;     $  2 2  2  k    ;   7 7  7 'A 2  7 7  7 "C 2 )IK)I )IX m "  um u  u  ` Y `  `  U* U  U  K*K K,  -0 -  -   Y      I{     1{ 1  1   ;     +     ,   (        595 5" 5i5 5"   I       I    0 @ 5|15 5.   2            ;          \      |                  l  |   7| 7  7 2L2 2<  <1E   * ),0D) )&  #<     !8     %l %  %  %l% % ./C. .(  7     7     7          <          2    *        0    (   <    !5 r;