qi^dZddlZddlZddlmZmZmZmZmZm Z ddl m Z m Z m Z ddlmZedZGdde ZGd d eZGd d eZGd deZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGdde Ze eeeeeeeffZedZGd d!e Z Gd"d#e Z!Gd$d%e Z"Gd&d'e Z#Gd(d)e Z$Gd*d+e Z%Gd,d-e Z&Gd.d/e&Z'Gd0d1e&Z(Gd2d3e&Z)Gd4d5e&Z*Gd6d7e&Z+Gd8d9e&Z,Gd:d;e&Z-Gd<d=e Z.Gd>d?e.Z/Gd@dAe.Z0GdBdCe.Z1GdDdEe.Z2GdFdGe.Z3GdHdIe.Z4GdJdKe.Z5GdLdMe.Z6GdNdOe.Z7GdPdQe.Z8GdRdSe.Z9GdTdUe.Z:GdVdWe.Z;GdXdYe.Z<GdZd[e.Z=Gd\d]e.Z>Gd^d_e Z?Gd`dae Z@GdbdOe.Z7Gdcdde.ZAGdedfe.ZBGdgdhe ZCGdidje.ZDGdkdle.ZEGdmdne.ZFGdodpe.ZGidqeGdreFdse/dte0due1dve2dwe3dxe4dye5dze6d{e7d|e8d}eBd~eDdeEde9de:e;eeAdZHdefdZIy)zEvent models and data structures for Grok Voice Agent API communication. Based on xAI's Grok Voice Agent API documentation: https://docs.x.ai/docs/guides/voice/agent N)AnyDictListLiteralOptionalUnion) BaseModel ConfigDictField) ToolsSchema)i@i>i:R]i}iDiceZdZUdZeed<y) AudioFormatz*Base class for audio format configuration.typeN)__name__ __module__ __qualname____doc__str__annotations__W/opt/pipecat/venv/lib/python3.12/site-packages/pipecat/services/grok/realtime/events.pyrrs 4 Irrc4eZdZUdZdZeded<dZeed<y)PCMAudioFormataPCM audio format configuration with configurable sample rate. Grok supports: 8000, 16000, 21050, 24000, 32000, 44100, 48000 Hz Parameters: type: Audio format type, always "audio/pcm". rate: Sample rate in Hz. Defaults to 24000. z audio/pcmrr rateN) rrrrrrrrSUPPORTED_SAMPLE_RATESrrrrr#s#"-D'+ ,#(D (rrc&eZdZUdZdZeded<y)PCMUAudioFormatuPCMU (G.711 μ-law) audio format configuration. Fixed at 8000 Hz sample rate. Parameters: type: Audio format type, always "audio/pcmu". z audio/pcmurNrrrrrrrrrrrr1#/D', .rrc&eZdZUdZdZeded<y)PCMAAudioFormatzPCMA (G.711 A-law) audio format configuration. Fixed at 8000 Hz sample rate. Parameters: type: Audio format type, always "audio/pcma". z audio/pcmarNr rrrr#r#=r!rr#c,eZdZUdZdZeeded<y) TurnDetectionzServer-side voice activity detection configuration. Parameters: type: Detection type, must be "server_vad" or None for manual. server_vadrN)rrrrrrrrrrrr%r%Ns -9D(7<( )8rr%c2eZdZUdZdZeeeee fe d<y) AudioInputzjAudio input configuration. Parameters: format: The format configuration for input audio. Nformat rrrrr)rrrrr#rrrrr(r(]& QUFHU>?OKL MTrr(c2eZdZUdZdZeeeee fe d<y) AudioOutputzlAudio output configuration. Parameters: format: The format configuration for output audio. Nr)r*rrrr-r-gr+rr-c:eZdZUdZdZeeed<dZee ed<y)AudioConfigurationzAudio configuration for input and output. Parameters: input: Configuration for input audio. output: Configuration for output audio. Ninputoutput) rrrrr0rr(rr1r-rrrr/r/qs'#'E8J &$(FH[ !(rr/c&eZdZUdZdZeded<y) WebSearchToolzkWeb search tool configuration. Enables the voice agent to search the web for current information. web_searchrNr rrrr3r3s #/D', .rr3c@eZdZUdZdZeded<dZee e ed<y) XSearchToolzX (Twitter) search tool configuration. Enables the voice agent to search X for posts and information. Parameters: type: Tool type, always "x_search". allowed_x_handles: Optional list of X handles to filter search results. x_searchrNallowed_x_handles) rrrrrrrr8rrrrrrr6r6s,!+D'* *-1xS *1rr6cJeZdZUdZdZeded<eeed<dZ e e ed<y)FileSearchToola7File/Collection search tool configuration. Enables the voice agent to search through uploaded document collections. Parameters: type: Tool type, always "file_search". vector_store_ids: List of collection IDs to search. max_num_results: Maximum number of results to return. file_searchrvector_store_ids max_num_resultsN) rrrrrrrrrr>rintrrrr:r:s0$1D'- 03i%'OXc]'rr:cNeZdZUdZdZeded<eed<eed<eee fed<y) FunctionToolzCustom function tool configuration. Parameters: type: Tool type, always "function". name: Name of the function. description: Description of what the function does. parameters: JSON schema for function parameters. functionrname description parametersN) rrrrrrrrrrrrrrArAs1!+D'* * IS#XrrA)AraRexSalEveLeoceZdZUdZedZdZeee d<dZ ee eze d<e d Z eee d <dZeee d <dZeeeeze d <y) SessionPropertiesa#Configuration properties for a Grok Voice Agent session. Parameters: instructions: System instructions for the assistant. voice: The voice the model uses to respond. Options: Ara, Rex, Sal, Eve, Leo. Defaults to "Ara". turn_detection: Configuration for turn detection. Defaults to server-side VAD. Set to None for manual turn detection. audio: Configuration for input and output audio. tools: Available tools for the assistant (web_search, x_search, file_search, function). Tarbitrary_types_allowedN instructionsrFvoicectdS)Nr&)r)r%rrrzSessionProperties.s < @rdefault_factoryturn_detectionaudiotools)rrrrr model_configrOrrrrP GrokVoicer rUr%rVr/rWr rGrokToolrrrrLrLsw d;L"&L(3-&',E8IO $,.3@/NH]++/E8& '.48E8K$x.0 18rrLc^eZdZUdZeded<dZeeed<dZ eeed<dZ eeed<y) ItemContentaContent within a conversation item. Parameters: type: Content type (input_text, input_audio, text, audio). text: Text content for text-based items. audio: Base64-encoded audio data for audio items. transcript: Transcribed text for audio items. )textrV input_text input_audio output_text output_audiorNr]rV transcript) rrrrrrr]rrrVrbrrrr\r\s? ] ^^D(3-E8C= $J $rr\ceZdZUdZedZeed<dZe e ded<e ded <dZ e e d ed <dZ e e d ed <dZ e eeed<dZe eed<dZe eed<dZe eed<dZe eed<y)ConversationItemaA conversation item in the realtime session. Parameters: id: Unique identifier for the item, auto-generated if not provided. object: Object type identifier for the realtime API. type: Item type (message, function_call, or function_call_output). status: Current status of the item. role: Speaker role for message items (user, assistant, or system). content: Content list for message items. call_id: Function call identifier for function_call items. name: Function name for function_call items. arguments: Function arguments as JSON string for function_call items. output: Function output as JSON string for function_call_output items. cPttjjSN)ruuiduuid4hexrrrrRzConversationItem. sC 0@0@,ArrSidNz realtime.itemobject)message function_callfunction_call_outputr) completed in_progress incompletestatus)user assistantsystemtoolrolecontentcall_idrC argumentsr1)rrrrr rjrrrkrrrrrwrxrr\ryrCrzr1rrrrdrds $ABBB15FHW_- .5 D EEJNFHWEF GNEID(7@A BI+/GXd;' (/!GXc]!D(3-#Ix}# FHSM rrdc,eZdZUdZeed<eded<y)RealtimeConversationzA realtime conversation session. Parameters: id: Unique identifier for the conversation. object: Object type identifier, always "realtime.conversation". rjzrealtime.conversationrkN)rrrrrrrrrrr|r|s G + ,,rr|c6eZdZUdZddgZeeeded<y)ResponsePropertieszProperties for configuring assistant responses. Parameters: modalities: Output modalities for the response (text, audio, or both). r]rV)r]rV modalitiesN) rrrrrrrrrrrrr~r~!s( =CG;LJgo678Lrr~cleZdZUdZdZeeed<dZeeed<eed<dZ eeed<dZ eeed<y) RealtimeErrora>Error information from the realtime API. Parameters: type: Error type identifier. code: Specific error code. message: Human-readable error message. param: Parameter name that caused the error, if applicable. event_id: Event ID associated with the error, if applicable. Nrcoderlparamevent_id) rrrrrrrrrrrrrrrr0sFD(3-D(3- LE8C="Hhsm"rrc0eZdZUdZedZeed<y) ClientEventzBase class for client events sent to the realtime API. Parameters: event_id: Unique identifier for the event, auto-generated if not provided. c<ttjSrf)rrgrhrrrrRzClientEvent.Ns#djjl2CrrSrN)rrrrr rrrrrrrrGs *CDHcDrrc0eZdZUdZdZeded<eed<y)SessionUpdateEventzEvent to update session properties. Parameters: type: Event type, always "session.update". session: Updated session properties. zsession.updatersessionN)rrrrrrrrLrrrrrQs'7D'" #6 rrc0eZdZUdZdZeded<eed<y)InputAudioBufferAppendEventzEvent to append audio data to the input buffer. Parameters: type: Event type, always "input_audio_buffer.append". audio: Base64-encoded audio data to append. zinput_audio_buffer.appendrrVN)rrrrrrrrrrrrr]s2MD'- .L Jrrc&eZdZUdZdZeded<y)InputAudioBufferCommitEventzEvent to commit the current input audio buffer. Used when turn_detection is null (manual mode). Parameters: type: Event type, always "input_audio_buffer.commit". zinput_audio_buffer.commitrNr rrrrris2MD'- .Lrrc&eZdZUdZdZeded<y)InputAudioBufferClearEventzyEvent to clear the input audio buffer. Parameters: type: Event type, always "input_audio_buffer.clear". zinput_audio_buffer.clearrNr rrrrrus 1KD', -JrrcDeZdZUdZdZeded<dZee ed<e ed<y)ConversationItemCreateEventzEvent to create a new conversation item. Parameters: type: Event type, always "conversation.item.create". previous_item_id: ID of the item to insert after, if any. item: The conversation item to create. zconversation.item.createrNprevious_item_iditem) rrrrrrrrrrrdrrrrrs/1KD', -J&*hsm* rrc:eZdZUdZdZeded<dZee ed<y)ResponseCreateEventzEvent to create a new assistant response. Parameters: type: Event type, always "response.create". response: Optional response configuration properties. zresponse.createrNresponse) rrrrrrrrrr~rrrrrs)(9D'# $8-1Hh)*1rrc&eZdZUdZdZeded<y)ResponseCancelEventzyEvent to cancel the current assistant response. Parameters: type: Event type, always "response.cancel". zresponse.cancelrNr rrrrrs (9D'# $8rrc8eZdZUdZedZeed<eed<y) ServerEventzBase class for server events received from the realtime API. Parameters: event_id: Unique identifier for the event. type: Type of the server event. TrMrrN)rrrrr rXrrrrrrrsd;LM Irrc,eZdZUdZeded<eed<y)SessionUpdatedEventzEvent indicating a session has been updated. Parameters: type: Event type, always "session.updated". session: The updated session properties. session.updatedrrN)rrrrrrrLrrrrrs # $$ rrc,eZdZUdZeded<eed<y)ConversationCreatedzEvent indicating a conversation has been created. This is the first message received after connecting. Parameters: type: Event type, always "conversation.created". conversation: The created conversation. conversation.createdr conversationN)rrrrrrr|rrrrrs ( ))&&rrc@eZdZUdZeded<dZeeed<e ed<y)ConversationItemAddedzEvent indicating a conversation item has been added. Parameters: type: Event type, always "conversation.item.added". previous_item_id: ID of the previous item, if any. item: The added conversation item. conversation.item.addedrNrr) rrrrrrrrrrdrrrrrs* + ,,&*hsm* rrc6eZdZUdZeded<eed<eed<y)0ConversationItemInputAudioTranscriptionCompletedaEvent indicating input audio transcription is complete. Parameters: type: Event type, always "conversation.item.input_audio_transcription.completed". item_id: ID of the conversation item that was transcribed. transcript: Complete transcription text. 5conversation.item.input_audio_transcription.completedritem_idrbNrrrrrrrrrrrrs I JJ LOrrc,eZdZUdZeded<eed<y)InputAudioBufferSpeechStartedaEvent indicating speech has started in the input audio buffer. Only sent when turn_detection is "server_vad". Parameters: type: Event type, always "input_audio_buffer.speech_started". item_id: ID of the associated conversation item. !input_audio_buffer.speech_startedrrNrrrrrr 5 66 Lrrc,eZdZUdZeded<eed<y)InputAudioBufferSpeechStoppedaEvent indicating speech has stopped in the input audio buffer. Only sent when turn_detection is "server_vad". Parameters: type: Event type, always "input_audio_buffer.speech_stopped". item_id: ID of the associated conversation item. !input_audio_buffer.speech_stoppedrrNrrrrrrrrrc@eZdZUdZeded<dZeeed<eed<y)InputAudioBufferCommittedaEvent indicating the input audio buffer has been committed. Parameters: type: Event type, always "input_audio_buffer.committed". previous_item_id: ID of the previous item, if any. item_id: ID of the committed conversation item. input_audio_buffer.committedrNrr) rrrrrrrrrrrrrrs) 0 11&*hsm* Lrrc"eZdZUdZeded<y)InputAudioBufferClearedzEvent indicating the input audio buffer has been cleared. Parameters: type: Event type, always "input_audio_buffer.cleared". input_audio_buffer.clearedrNrrrrrrrrrrrs . //rrc,eZdZUdZeded<ded<y)ResponseCreatedEvent indicating an assistant response has been created. Parameters: type: Event type, always "response.created". response: The created response object. response.createdrResponserNrrrrrr s $ %%rrc@eZdZUdZeded<eed<eed<eed<y)ResponseOutputItemAddedaEvent indicating an output item has been added to a response. Parameters: type: Event type, always "response.output_item.added". response_id: ID of the response. output_index: Index of the output item. item: The added conversation item. response.output_item.addedr response_id output_indexrN rrrrrrrr?rdrrrrr,s' . // rrc@eZdZUdZeded<eed<eed<eed<y)ResponseAudioTranscriptDeltaa"Event containing incremental audio transcript from a response. Parameters: type: Event type, always "response.output_audio_transcript.delta". response_id: ID of the response. item_id: ID of the conversation item. delta: Incremental transcript text. &response.output_audio_transcript.deltarrrdeltaNrrrrrr<s% : ;; L Jrrc6eZdZUdZeded<eed<eed<y)ResponseAudioTranscriptDonezEvent indicating audio transcript is complete. Parameters: type: Event type, always "response.output_audio_transcript.done". response_id: ID of the response. item_id: ID of the conversation item. %response.output_audio_transcript.donerrrNrrrrrrLs  9 :: LrrcTeZdZUdZeded<eed<eed<eed<eed<eed<y ) ResponseAudioDeltaa}Event containing incremental audio data from a response. Parameters: type: Event type, always "response.output_audio.delta". response_id: ID of the response. item_id: ID of the conversation item. output_index: Index of the output item. content_index: Index of the content part. delta: Base64-encoded incremental audio data. response.output_audio.deltarrrr content_indexrNrrrrrrrr?rrrrrZs1  / 00 L Jrrc6eZdZUdZeded<eed<eed<y)ResponseAudioDonezEvent indicating audio content is complete. Parameters: type: Event type, always "response.output_audio.done". response_id: ID of the response. item_id: ID of the conversation item. response.output_audio.donerrrNrrrrrrns  . // LrrcreZdZUdZeded<dZeeed<dZ eeed<eed<eed<dZ eeed <y) "ResponseFunctionCallArgumentsDeltaaEvent containing incremental function call arguments. Parameters: type: Event type, always "response.function_call_arguments.delta". response_id: ID of the response. item_id: ID of the conversation item. call_id: ID of the function call. delta: Incremental function arguments as JSON. previous_item_id: ID of the previous item, if any. &response.function_call_arguments.deltarNrrryrr) rrrrrrrrrrrrrrrr|sJ  : ;;!%K#%!GXc]! L J&*hsm*rrc@eZdZUdZeded<eed<eed<eed<y)!ResponseFunctionCallArgumentsDonea0Event indicating function call arguments are complete. Parameters: type: Event type, always "response.function_call_arguments.done". call_id: ID of the function call. name: Name of the function being called. arguments: Complete function arguments as JSON string. %response.function_call_arguments.donerryrCrzNrrrrrrs$ 9 :: L INrrcNeZdZUdZdZeeed<dZeeed<dZ eeed<y)Usagea#Token usage statistics for a response. All fields are optional because Grok sends empty usage in some events. Parameters: total_tokens: Total number of tokens used. input_tokens: Number of input tokens used. output_tokens: Number of output tokens used. N total_tokens input_tokens output_tokens) rrrrrrr?rrrrrrrrs3#'L(3-&"&L(3-&#'M8C='rrcteZdZUdZeed<eded<eded<dZee ed<e e ed <dZ ee ed <y) raAA complete assistant response. Parameters: id: Unique identifier for the response. object: Object type, always "realtime.response". status: Current status of the response. output: List of conversation items in the response. usage: Token usage statistics for the response. rjzrealtime.responserk)rorprq cancelledfailedrrNstatus_detailsr1usage)rrrrrrrrrrrrdrrrrrrrsN G ' (( S TT$(NHSM( ! ""!E8E?!rrc,eZdZUdZeded<eed<y)rrrrrN)rrrrrrrrrrrrs $ %%rc@eZdZUdZeded<eed<dZee ed<y) ResponseDonezEvent indicating an assistant response is complete. Parameters: type: Event type, always "response.done". response: The completed response object. usage: Token usage (also available at top level in Grok). response.donerrNr) rrrrrrrrrrrrrrrs( / ""!E8E?!rrc@eZdZUdZeded<eed<eed<eed<y)ResponseOutputItemDoneaEvent indicating an output item is complete. Parameters: type: Event type, always "response.output_item.done". response_id: ID of the response. output_index: Index of the output item. item: The completed conversation item. response.output_item.donerrrrNrrrrrrs' - .. rrc0eZdZUdZeed<dZeeed<y) ContentPartzA content part within a response. Parameters: type: Type of the content part (audio, text). transcript: Transcript text if applicable. rNrb)rrrrrrrbrrrrrrs I $J $rrcTeZdZUdZeded<eed<eed<eed<eed<eed<y ) ResponseContentPartAddedarEvent indicating a content part has been added to a response. Parameters: type: Event type, always "response.content_part.added". response_id: ID of the response. item_id: ID of the conversation item. content_index: Index of the content part. output_index: Index of the output item. part: The added content part. response.content_part.addedrrrrrpartN) rrrrrrrr?rrrrrrs2  / 00 L rrcJeZdZUdZeded<eed<eed<eed<eed<y) ResponseContentPartDonea:Event indicating a content part is complete. Parameters: type: Event type, always "response.content_part.done". response_id: ID of the response. item_id: ID of the conversation item. content_index: Index of the content part. output_index: Index of the output item. response.content_part.donerrrrrNrrrrrr s, . // Lrrc,eZdZUdZeded<eed<y) PingEventzKeep-alive ping event from the server. Parameters: type: Event type, always "ping". timestamp: Server timestamp in milliseconds. pingr timestampN)rrrrrrr?rrrrrs &/Nrrc,eZdZUdZeded<eed<y) ErrorEventzEvent indicating an error occurred. Parameters: type: Event type, always "error". error: Error details. errorrN)rrrrrrrrrrrr+s '  rrrrrrrrrrrrrrrrrrr)rrrrrdatac tj|}|d}|tvrtd|t|j |S#t$r}t|d|d}~wwxYw)a Parse a server event from JSON string. Args: data: JSON string containing the server event. Returns: Parsed server event object of the appropriate type. Raises: Exception: If the event type is unimplemented or parsing fails. rz!Unimplemented server event type: z N)jsonloads_server_event_types Exceptionmodel_validate)revent event_typees rparse_server_eventrUsv+ 4 6] 0 0? |LM M":.==eDD +1#U4&)**+sAA A(A##A()Jrrrgtypingrrrrrrpydanticr r r %pipecat.adapters.schemas.tools_schemar rrrrr#r%r(r-r/r3r6r:rArrZrYrLr\rdr|r~rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr s  <<11=!!OP) )[ ) /k / /k /"9I9UUU)U ) )"/I/ 2) 2 (Y ( 9 "  ^\4PSUXPX>Y Z 5 6 9 9> %) % !y!8 -9 -MM#I#.E)E   +  M+ MKK +  2+ 29+9 )  +  '+ ' K  {  K  K   0k0 k  k  ;  + (  ++(   (I ( "y"& k  "; " [  %) %{(k$      Z I*/  4  <=m ()F()F#$=!"9!"9 !7"#;!"9 -.J!",-H#$$6"3.P-N!-4+S+r