qiudZddlZddlmZmZmZddlmZmZm Z ddl m Z ddl m Z mZmZmZmZmZmZmZmZmZddlmZddlmZmZmZmZmZdd lm Z dd l!m"Z"dd l#m$Z$dd l%m&Z&dd l'm(Z( ddl)m*Z*ddl+m,Z,ddl-m.Z.m/Z/m0Z0GddZ5eGddeZ6Gdde"Z7y#e1$r7Z2e jfde2e jfde4de2dZ2[2wwxYw)z/Deepgram speech-to-text service implementation.N) dataclassfieldfields)AnyAsyncGeneratorOptional)logger) CancelFrameEndFrameFrameInterimTranscriptionFrame StartFrameTranscriptionFrameUserStartedSpeakingFrameUserStoppedSpeakingFrameVADUserStartedSpeakingFrameVADUserStoppedSpeakingFrame)FrameDirection) NOT_GIVEN STTSettings _NotGiven_warn_deprecated_paramis_given)DEEPGRAM_TTFS_P99) STTService)Language)time_now_iso8601) traced_stt)AsyncDeepgramClient) EventType)ListenV1ResultsListenV1SpeechStartedListenV1UtteranceEndz Exception: zIIn order to use Deepgram, you need to `pip install pipecat-ai[deepgram]`.zMissing module: c:eZdZdZddddddddddddddddddddddddddddddeedeedeedeedeed eed eed eed eed eedeedeedeedeedeedeedeedeedeedeedeedeedeedeedeedeedeedeef8d Z d!efd"Z d#e fd$Z y)% LiveOptionsaGDeepgram live transcription options. Compatibility wrapper that mirrors the ``LiveOptions`` class removed in deepgram-sdk v6. .. deprecated:: 0.0.105 Use ``settings=DeepgramSTTSettings(...)`` for runtime-updatable fields and direct ``__init__`` parameters for connection-level config instead. N)callbackcallback_methodchannelsdetect_entitiesdiarize dictationencoding endpointingextrainterim_resultskeytermkeywordslanguage mip_opt_outmodel multichannelnumeralsprofanity_filter punctuateredactreplace sample_ratesearch smart_formattagutterance_end_ms vad_eventsversionr&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rAc ||_||_||_||_||_||_||_||_| |_| |_ | |_ | |_ | |_ ||_ ||_||_||_||_||_||_||_||_||_||_||_||_||_||_||_y)aInitialize live transcription options. Args: callback: Callback URL for async transcription delivery. callback_method: HTTP method to use for the callback (``"GET"`` or ``"POST"``). channels: Number of audio channels. detect_entities: Enable named entity detection. diarize: Enable speaker diarization. dictation: Enable dictation mode (converts commands to punctuation). encoding: Audio encoding (e.g. ``"linear16"``). endpointing: Endpointing sensitivity in ms, or ``False`` to disable. extra: Additional key-value metadata to attach to the transcription (str or list). interim_results: Whether to emit interim transcriptions. keyterm: Keyterms to boost (str or list of str). keywords: Keywords to boost (str or list of str). language: BCP-47 language tag (e.g. ``"en-US"``). mip_opt_out: Opt out of model improvement program. model: Deepgram model name (e.g. ``"nova-3-general"``). multichannel: Enable per-channel transcription for multi-channel audio. numerals: Convert spoken numbers to numerals. profanity_filter: Filter profanity from transcripts. punctuate: Add punctuation to transcripts. redact: Redact sensitive information (str or list of redaction types). replace: Word replacement rules (str or list). sample_rate: Audio sample rate in Hz. search: Search terms to highlight (str or list of str). smart_format: Apply smart formatting to transcripts. tag: Custom billing tag (str or list of str). utterance_end_ms: Silence duration in ms before an utterance-end event. vad_events: Enable Deepgram VAD speech-started / utterance-end events. version: Model version (e.g. ``"latest"``). **kwargs: Any additional Deepgram query parameters. N)r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rA_extra)selfr&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rAkwargss O/opt/pipecat/venv/lib/python3.12/site-packages/pipecat/services/deepgram/stt.py__init__zLiveOptions.__init__BsD! .  . "  & .     & (  0"  & ( 0$  namec~|jjdi} ||S#t$rtd|dwxYw)NrCz''LiveOptions' object has no attribute '')__dict__getKeyErrorAttributeError)rDrIr.s rF __getattr__zLiveOptions.__getattr__sQ !!(B/ T;  T #J4&PQ!RS S Ts#<returnc t|jDcic]\}}|jdr|||}}}|j|jjDcic] \}}| || c}}|Scc}}wcc}}w)z&Return a dict of all non-None options._)varsitems startswithupdaterC)rDkvresults rFto_dictzLiveOptions.to_dictsy#':#3#3#5a41aQ\\#=NSTS`!Q$aa  (9(9(;M1q}q!tMN bMsBBB* B 5B ) __name__ __module__ __qualname____doc__rstrintboolrrGrPdictr[rHrFr%r%7s"#')-"&*."&$("&%)#*.!%"&"&&*#'+#'+/$( $!%%) $'+!*.%)!%=^3-^"# ^ 3- ^ "$ ^$^D>^3-^c]^}^"$^#^3-^3-^ d^!^"}#^$tn%^&4.'^(#4.)^*D>+^, -^.#/^0c]1^2 3^4tn5^6c]7^8#3-9^:TN;^<#=^@TTrHr%c`eZdZUdZedZeezed<edZ eezed<edZ eezed<ed Z e ezed <ed Z eezed <ed Ze ezed<edZe ezed<edZeezed<edZeezed<edZeezed<edZe ezed<edZe ezed<edZe ezed<edZeezed<edZed zezed!<ed"Zeezed#<d%d$Zy )&DeepgramSTTSettingsaSettings for DeepgramSTTService. ``model`` and ``language`` are inherited from ``STTSettings`` / ``ServiceSettings``. Additional Deepgram connection params may be passed in through ``extra`` (also inherited). Parameters: detect_entities: Enable named entity detection. diarize: Enable speaker diarization. dictation: Enable dictation mode (converts commands to punctuation). endpointing: Endpointing sensitivity in ms, or ``False`` to disable. interim_results: Whether to emit interim transcriptions. keyterm: Keyterms to boost (str or list of str). keywords: Keywords to boost (str or list of str). numerals: Convert spoken numbers to numerals. profanity_filter: Filter profanity from transcripts. punctuate: Add punctuation to transcripts. redact: Redact sensitive information (str or list of redaction types). replace: Word replacement rules (str or list). search: Search terms to highlight (str or list of str). smart_format: Apply smart formatting to transcripts. utterance_end_ms: Silence duration in ms before an utterance-end event. vad_events: Enable Deepgram VAD speech-started / utterance-end events. ctSNrrdrHrFzDeepgramSTTSettings.irH)default_factoryr)ctSrhrirdrHrFrjzDeepgramSTTSettings.irHr*ctSrhrirdrHrFrjzDeepgramSTTSettings. rHr+ctSrhrirdrHrFrjzDeepgramSTTSettings.rHr-ctSrhrirdrHrFrjzDeepgramSTTSettings.rkrHr/ctSrhrirdrHrFrjzDeepgramSTTSettings.YrHr0ctSrhrirdrHrFrjzDeepgramSTTSettings.rnrHr1ctSrhrirdrHrFrjzDeepgramSTTSettings.syrHr6ctSrhrirdrHrFrjzDeepgramSTTSettings.syrHr7ctSrhrirdrHrFrjzDeepgramSTTSettings.rprHr8ctSrhrirdrHrFrjzDeepgramSTTSettings.IrHr9ctSrhrirdrHrFrjzDeepgramSTTSettings.rurHr:ctSrhrirdrHrFrjzDeepgramSTTSettings.r{rHr<ctSrhrirdrHrFrjzDeepgramSTTSettings.s9rHr=ctSrhrirdrHrFrjzDeepgramSTTSettings.sYrHNr?ctSrhrirdrHrFrjzDeepgramSTTSettings.rrrHr@c|jsyt|Dchc]7}|jdvr'|jjds |j9}}t |jj D]E}||vst ||}t|st|||j||j|=Gycc}w)aSync values from extra dict to declared fields. If a key in extra matches a field name and the field is NOT_GIVEN, promote the extra value to the field. This ensures self._settings always reflects the "final truth" of values that will be used. Keys in extra that match declared fields are always removed from extra to avoid confusion, even if the field was already set. N)r.r4r2rS) r.rrIrVlistkeysgetattrrsetattr)rDf field_nameskey current_values rF_sync_extra_to_fieldsz)DeepgramSTTSettings._sync_extra_to_fieldsszz D\ vv;;AFFDUDUVYDZ FF   )* $Ck! 'c 2  .D#tzz#7JJsO $  sO(POTI%P %6G HGTI H"'8I"JItiJ#(9J#KKyK(->O(POTI%P$5FGGS9_G %6G HHcIoH!&7H!IHdYI).?P)QdY&Q"'8I"JItiJ#4EFFC)OF$5FGGS9_G#4EFFC)OF%*;L%ML$"M/4EV/WcDj9,W#(9J#KJy K$rHrfc"eZdZUdZeZeed<dddddddddddddded d ed ed ed ede de de e de ede ede e de e de e de ede de ede ef fdZedZde fdZdedeee fffd Zd effd! Zd effd" Zd effd# Zd$edeedffd%Zdefd&Z d'Z!d(Z"d)Z#d*Z$d+Z%d,Z&d-Z'd.Z(e) d6d/ed0e d1e e*fd2Z+d3Z,d ed4e-ffd5 Z.xZ/S)7DeepgramSTTServicea Deepgram speech-to-text service. Provides real-time speech recognition using Deepgram's WebSocket API. Supports configurable models, languages, and various audio processing options. Event handlers available (in addition to STTService events): - on_speech_started(service): Deepgram detected start of speech - on_utterance_end(service): Deepgram detected end of utterance Example:: @stt.event_handler("on_speech_started") async def on_speech_started(service): ... _settingslinear16FNT)urlbase_urlr,r(r5r;r&r'r>r3 live_optionsaddonsshould_interruptsettingsttfs_p99_latencyapi_keyrrr,r(r5r;r&r'r>r3rrrrrc :|rFddl}|j5|jd|jdtddd|}t d)idddt jdd d d d d d dd ddddddd dddddddddddd dddd }| 5tdt |s"| j| | j}| j | j}| j | j}| j | j}| j | j} | j | j} | j | j} | j | j }hd}| j#j%Dcic] \}}||vs ||}}}t j'|}|j)|||j)||j+t-|\d)|||d|| |_||_||_||_||_||_| |_| |_| |_ |jBjDrFddl}|j5|jd|jdtdddd|rU dd l#m$}|jKd!r|nd!|}|jKd"r|nd"|}||||#}tM||$|_'ntM|&|_'d|_+d|_,|jZr#|j]d'|j]d(yy#1swYxYwcc}}w#1swYxYw#tP$r,tSjT|d%tM|&|_'YwxYw)*ajInitialize the Deepgram STT service. Args: api_key: Deepgram API key for authentication. url: Custom Deepgram API base URL. .. deprecated:: 0.0.64 Parameter `url` is deprecated, use `base_url` instead. base_url: Custom Deepgram API base URL. encoding: Audio encoding format. Defaults to "linear16". channels: Number of audio channels. Defaults to 1. multichannel: Transcribe each audio channel independently. Defaults to False. sample_rate: Audio sample rate in Hz. If None, uses the pipeline sample rate. callback: Callback URL for async transcription delivery. callback_method: HTTP method for the callback (``"GET"`` or ``"POST"``). tag: Custom billing tag. mip_opt_out: Opt out of Deepgram model improvement program. live_options: Legacy configuration options. .. deprecated:: 0.0.105 Use ``settings=DeepgramSTTSettings(...)`` for runtime-updatable fields and direct init parameters for connection-level config. addons: Additional Deepgram features to enable. should_interrupt: Whether to interrupt the bot when Deepgram VAD detects the user is speaking. .. deprecated:: 0.0.99 This parameter will be removed along with `vad_events` support. settings: Runtime-updatable settings. When provided alongside ``live_options``, ``settings`` values take precedence (applied after the ``live_options`` merge). ttfs_p99_latency: P99 latency from speech end to final transcript in seconds. Override for your deployment. See https://github.com/pipecat-ai/stt-benchmark **kwargs: Additional arguments passed to the parent STTService. Note: The `vad_events` option in LiveOptions is deprecated as of version 0.0.99 and will be removed in a future version. Please use the Silero VAD instead. rNalwaysz6Parameter 'url' is deprecated, use 'base_url' instead.r4znova-3-generalr2r)Fr*r+r-r/Tr0r1r6r7r8r9r:r<r=r?r@r>r>r&r(r,r3r;r5r')r;rrztThe 'vad_events' parameter is deprecated and will be removed in a future version. Please use the Silero VAD instead.) stacklevel)DeepgramClientEnvironmentzwss://zhttps://)base productionagent)r environmentz?: Custom base_url configuration failed, falling back to default)ron_speech_startedon_utterance_endrd)/warningscatch_warnings simplefilterwarnDeprecationWarningrfrENrr;r,r(r&r'r>r3r5r[rU from_mapping apply_updatersuperrG_addons_should_interrupt _encoding _channels _multichannel _callback_callback_method_tag _mip_opt_outrr@deepgramrrVr_client Exceptionr warning _connection_connection_task vad_enabled_register_event_handler)rDrrrr,r(r5r;r&r'r>r3rrrrrrErdefault_settings init_onlyrXrYlo_dictdeltarws_urlhttp_urlr __class__s rFrGzDeepgramSTTService.__init__s!@  ((* %%h/ L&  H/ " [[ "       !    "     ! ""# $% 0  # ">3F G++7K> $ $ ((* %%h/ 9&    D>%-%8%8%B&QYPZH['/':'::'F8hW_V`La7!%  37P[\ /w?DL $     ( ()< =  ( (); < C  Bb>  , Df[\ 37C  Ds6(M M!M.*M#AM%MM"%2NNc.|jjS)zCheck if Deepgram VAD events are enabled. Returns: True if VAD events are enabled in the current settings. )rr@rDs rFrzDeepgramSTTService.vad_enableds~~(((rHrQcy)zCheck if this service can generate processing metrics. Returns: True, as Deepgram service supports metrics generation. Trdrs rFcan_generate_metricsz'DeepgramSTTService.can_generate_metricss rHrc2Kt||d{}|s|St|jtr|jj |j r0|jd{|jd{|S7z7 7 w)z9Apply a settings delta and reconnect if anything changed.N) r_update_settings isinstancerrfrr _disconnect_connect)rDrchangedrs rFrz#DeepgramSTTService._update_settingss077N dnn&9 : NN 0 0 2   ""$ $ $--/ ! !8 % !s4BBAB2B3B B BBBframectKt||d{|jd{y77w)zStart the Deepgram STT service. Args: frame: The start frame containing initialization parameters. N)rstartrrDrrs rFrzDeepgramSTTService.starts3 gmE"""mmo #848688ctKt||d{|jd{y77w)zXStop the Deepgram STT service. Args: frame: The end frame. N)rstoprrs rFrzDeepgramSTTService.stops6 gl5!!!    " rctKt||d{|jd{y77w)z]Cancel the Deepgram STT service. Args: frame: The cancel frame. N)rcancelrrs rFrzDeepgramSTTService.cancel s6 gnU###    $ raudiocxK|jr#|jj|d{dy7 w)zSend audio data to Deepgram for transcription. Args: audio: Raw audio bytes to transcribe. Yields: Frame: None (transcription results come via WebSocket callbacks). N)r send_media)rDrs rFrun_sttzDeepgramSTTService.run_stts5   ""--e4 4 4  5s +:8 :cVi}|j}t|D]}|jdvs|jjdr-t ||j}t |r|Qt |trt|jn t|||j<t |jr$|jt|j|d<t |jr$|jt|j|d<|j|d<t|j|d<t|jj|d<t|j|d<|j |j |d <|j"|j"|d <|j$t|j$|d <|j&&t|j&j|d <|j(j+D]?\}}| t |trt|jn t|||<A|j,r0|j,j+D]\}}t|||<|S) zQBuild keyword arguments for ``client.listen.v1.connect()`` from current settings.)r4r2r.rSr4r2r,r(r5r;r&r'r>r3)rrrIrVrrrrbr`lowerr4r2rrrr;rrrrr.rUr)rDrEsrvaluers rF_build_connect_kwargsz(DeepgramSTTService._build_connect_kwargs"s= NN [Avv77166;L;LS;QAqvv&EE?em3=eT3JSZ--/PSTYPZF166N  [ AGG !4!!''lF7O AJJ AJJ$:!$QZZF: "^^z 0z!$T%7%7!8!>!>!@~ #D$4$4 5} >> %!%F:   ,(,(=(=F$ % 99  NF5M    ($'(9(9$:$@$@$BF= !''--/ \JC 4>ud4Kc%j..0QTUZQ[s  \ <<"ll002 ) U!%js  ) rHc~Ktjd|j|j|_yw)NzConnecting to Deepgram)r debug create_task_connection_handlerrrs rFrzDeepgramSTTService._connectPs/ -. $ 0 01I1I1K Ls;=cK|jsytjd|j}d|_|r|j d{|j |jd{d|_y7/7w)NzDisconnecting from Deepgram)rr rrsend_close_stream cancel_task)rD connections rFrzDeepgramSTTService._disconnectTst$$  23%%  ..0 0 0t44555 $ 15s$A B A="B0A?1 B?BcxK |j} |jjjjdi|4d{}||_|j tj|j|j tj|jtj|d|j|j|d} |j!d{|j#|d{dddd{d|_+7787!#|j#|d{7wxYw72#1d{7swYBxYw#t$j&$rt($r$}tj*|d|Yd}~d}~wwxYw#d|_wxYww)zManages the full WebSocket lifecycle inside a single async with block. Reconnects automatically after transient errors. Exits cleanly when the task is cancelled (i.e. on stop/cancel). Nz": Websocket connection initializedz ::keepalivez: Connection lost, will retry: rd)rrlistenv1connectronr MESSAGE _on_messageERROR _on_errorr rr_keepalive_handlerstart_listeningrasyncioCancelledErrorrr)rDconnect_kwargsrkeepalive_taskes rFrz&DeepgramSTTService._connection_handlerds !779N (94<<..1199KNK ? ?z'1D$MM)"3"3T5E5EFMM)//4>>BLLD6)K!LM%)%5%5//1dV;3G&N?(88:::"..~>>> ? ?&$( - ?;>d..~>>> ? ? ? ?))  L$'FqcJKK L$( sF:4E+ D/ E+ BE%D58D19D5=ED3E E+!E"E+& F:/E+1D53E5E E EEE+E(E E($E++F+F&!F.&F++F.. F77F:c>K tjdd{|jr; |jjd{t j |de7L7#t $r$}t j|d|Yd}~-d}~wwxYww)zPeriodically send KeepAlive frames to prevent server-side timeout. Deepgram closes inactive connections after 10 seconds (NET-0001 error). Sending every 5 seconds stays within the recommended 3-5 second interval. Nz: Sent keepalivez: Keepalive failed: )rsleeprsend_keep_aliver tracerr)rDrs rFrz%DeepgramSTTService._keepalive_handlers --" " "E**::<<<LLD6)9!:;  "= ENNdV+?s#CDDEsJBA)BA- A+ A-(B+A-- B6BBBBc@K|jd{y7w)z7Start processing metrics collection for this utterance.N)start_processing_metricsrs rF_start_metricsz!DeepgramSTTService._start_metricss++---s cKtj|d||j|d{|jd{y77w)Nz connection error, will retry: ) error_msg)r r push_errorstop_all_metrics)rDerrors rFrzDeepgramSTTService._on_errorsO$>ugFGoo5'o333##%%% 4%s!1AAA A AAcK|jd{|jd|d{|jtd{|jr|j d{yy7a7I7.7 w)Nr)r_call_event_handlerbroadcast_framerrbroadcast_interruptionrDmessages rF_on_speech_startedz%DeepgramSTTService._on_speech_startedsu!!###&&':GDDD""#;<<<  ! !--/ / / " $D< /sCBA8BA:B A<#B1A>2B:B<B>BcK|jd|d{|jtd{y7"7w)Nr)rr rr s rF_on_utterance_endz$DeepgramSTTService._on_utterance_ends<&&'97CCC""#;<<< DZZrHr)8r_r dataclassesrrrtypingrrrlogurur pipecat.frames.framesr r r r rrrrrr"pipecat.processors.frame_processorrpipecat.services.settingsrrrrrpipecat.services.stt_latencyrpipecat.services.stt_servicerpipecat.transcriptions.languagerpipecat.utils.timer(pipecat.utils.tracing.service_decoratorsrrrdeepgram.core.eventsr deepgram.listen.v1.typesr!r"r#ModuleNotFoundErrorrrrr%rfrrdrHrFr6s60000   >;34/? ,,.xxv E$+E$ E$PsZsZU,FLL;qc"#FLL\] &qc* ++,s,B((C$-2CC$