qi',dZddlmZddlmZmZmZmZddlZddl m Z ddl m Z m Z ddlmZmZGdd eeZGd d eeZGd d eeZGdde ZGdde ZGdde ZGdde ZGddeZGddeZy)z;HeyGen API. API to communicate with HeyGen Streaming API. )Enum)AnyDictLiteralOptionalN)logger) BaseModelField) BaseAvatarApiStandardSessionResponseceZdZdZdZdZdZy) AvatarQualityz2Enum representing different avatar quality levels.lowmediumhighN)__name__ __module__ __qualname____doc__rrr`/opt/pipecat/venv/lib/python3.12/site-packages/pipecat/services/heygen/api_interactive_avatar.pyrrs< C F DrrceZdZdZdZdZy) VideoEncodingz%Enum representing the video encoding.H264VP8N)rrrrrrrrrrrs/ D Crrc$eZdZdZdZdZdZdZdZy) VoiceEmotionz0Enum representing different voice emotion types.excitedseriousfriendlysoothing broadcasterN) rrrrEXCITEDSERIOUSFRIENDLYSOOTHING BROADCASTERrrrrr%s:GGHHKrrcveZdZUdZdZeeed<dZeeed<dZ ee ed<dZ ee ed<dZ eeed<y)ElevenLabsSettingsaSettings for ElevenLabs voice configuration. Parameters: stability (Optional[float]): Stability of the voice synthesis. similarity_boost (Optional[float]): Adjustment for similarity in voice performance. model_id (Optional[str]): Identifier for the ElevenLabs model to use. style (Optional[int]): Style metric to apply for the voice. use_speaker_boost (Optional[bool]): Flag to enable speaker boost. N stabilitysimilarity_boostmodel_idstyleuse_speaker_boost)rrrrr+rfloat__annotations__r,r-strr.intr/boolrrrr*r*/sQ"&Ix%(,huo,"Hhsm"E8C=(,x~,rr*ceZdZUdZeddZeeed<dZ ee ed<dZ ee ed<eddZ eeed <y) VoiceSettingsaVVoice configuration settings. Parameters: voice_id (Optional[str]): ID of the voice to be used. rate (Optional[float]): Speaking rate for the voice. emotion (Optional[VoiceEmotion]): Emotion tone for the voice. elevenlabs_settings (Optional[ElevenLabsSettings]): Details for ElevenLabs configuration. NvoiceId)aliasvoice_idrateemotionelevenlabsSettingselevenlabs_settings)rrrrr r9rr2r1r:r0r;rr=r*rrrr6r6AsT$D :Hhsm: D(5/ &*GXl #*8=dJ^8_"45_rr6ceZdZUdZdZeeed<dZee ed<dZ ee ed<dZ ee ed<dZee ed<dZee ed<d Zed ed <dZeeed <dZeeed <y) NewSessionRequestaRequesting model for creating a new HeyGen session. Parameters: quality (Optional[AvatarQuality]): Desired quality of the avatar. avatar_id (Optional[str]): Unique identifier for the avatar. voice (Optional[VoiceSettings]): Voice configurations for the session. video_encoding (Optional[VideoEncoding]): Desired encoding for the video stream. knowledge_id (Optional[str]): Identifier for the knowledge base (if applicable). knowledge_base (Optional[str]): Details of any external knowledge base. version (Literal["v2"]): API version to use. disable_idle_timeout (Optional[bool]): Flag to disable automatic idle timeout. activity_idle_timeout (Optional[int]): Timeout in seconds for activity-based idle detection. Nquality avatar_idvoicevideo_encoding knowledge_idknowledge_basev2versiondisable_idle_timeoutactivity_idle_timeout)rrrrr@rrr1rAr2rBr6rCrrDrErGrrHr4rIr3rrrr?r?Qs (,GXm $+#Ix}#%)E8M ").2NH]+2"&L(3-&$(NHSM(!GWT]!+/(4./+/8C=/rr?cDeZdZUdZeed<eed<eed<eed<eed<y) HeyGenSessionuResponse model for a HeyGen session. Parameters: session_id (str): Unique identifier for the streaming session. access_token (str): Token for accessing the session securely. livekit_agent_token (str): Token for HeyGen’s audio agents(Pipecat). realtime_endpoint (str): Real-time communication endpoint URL. url (str): Direct URL for the session. session_id access_tokenlivekit_agent_tokenrealtime_endpointurlN)rrrrr2r1rrrrKrKks%O HrrKc4eZdZdZdedededdffd ZxZS)HeygenApiErrorz'Custom exception for HeyGen API errors.messagestatus response_textreturnNc@t||||_||_y)zInitialize the HeyGen API error. Args: message: Error message status: HTTP status code response_text: Raw response text from the API N)super__init__rTrU)selfrSrTrU __class__s rrYzHeygenApiError.__init__s! ! *r)rrrrr2r3rY __classcell__)r[s@rrRrR}s,1 + +S + + + +rrRc eZdZdZdZdedejddfdZdded e ee fd e de fd Z d e defd Zdede fdZdede fdZdefdZy) HeyGenApizHeyGen Streaming API client.zhttps://api.heygen.com/v1api_keysessionrVNc ||_||_y)zInitialize the HeyGen API. Args: api_key: HeyGen API key session: Optional aiohttp client session N)r_r`)rZr_r`s rrYzHeyGenApi.__init__s  rpathparams expect_datacK|j|}|jdd}tjd| |jj |||4d{}|j sT|jd{}tjd|td|j|j||r<|jd{}|jd} | cdddd{S|jd{cdddd{S777U7477#1d{7swYyxYw#tj$r'} tjd t| d} ~ wwxYww) aMake a POST request to the HeyGen API. Args: path: API endpoint path. params: JSON-serializable parameters. expect_data: Whether to expect and extract 'data' field from response (default: True). Returns: Parsed JSON response data. Raises: HeygenApiError: If the API response is not successful or data is missing when expected. aiohttp.ClientError: For network-related errors. zapplication/json)z x-api-keyz Content-TypezHeyGen API request: )jsonheadersNzHeyGen API error: zAPI request failed with status dataz(Network error while calling HeyGen API: )BASE_URLr_rdebugr`postoktexterrorrRrTrfgetaiohttp ClientErrorr2) rZrbrcrdrPrgresponserU json_datarhes r_requestzHeyGenApi._requestshv&.   +C512 ||((67(K - -x{{*2--/$9MLL#5m_!EF(9(//9JK % &.mmo 5I$==0D - - -&]]_, - - -$9!6 -- - - - -""  LLCCF8L M  s8F"E D)E ! D5D+AD5D-D5. E :D/;E ?FD5D1D5 E #D3$E (F)E +D5-D5/E 1D53E 5E;D> <EE FE F"E??FF request_datac &K|j|j|jr|jjnd|jr|jjnd|jr|jj nd|jr|jj ndd|j|j|j|j|j|jd }|jd|d{}td|tj!|}|j#|j$d{t'|j$|j(|j*|j,|j.|S77Iw)a5Create a new streaming session and start it immediately. https://docs.heygen.com/reference/new-session Args: request_data: Session configuration parameters. Returns: StandardSessionResponse: Standardized session information with HeyGen raw response. N)r9r:r;r=) r@rArBrDrErGrCrHrIz/streaming.newzheygen session info)rLrM livekit_urlrNws_url raw_response)r@rArBr7r:r;r<rDrErGrCrHrIruprintrKmodel_validate_start_sessionrLr rMrPrNrO)rZrvrc session_infoheygen_sessions r new_sessionzHeyGenApi.new_sessions[$++%//:F:L:LL..66RV3?3E3E **//49E9K9K<--55QU=I=O=OL&&99UY )55*99#++*99$0$E$E%1%G%G! $"]]+;VDD  #\2&55lC!!.";";<<<'%00'44&** . B B!33'   E =s&C?FF AFFAFFrLcdK|s tdd|i}|jd|d{S7w)a1Start the streaming session. https://docs.heygen.com/reference/start-session Args: session_id: ID of the session to start. Returns: Response data from the start session API call. Raises: ValueError: If session ID is not set. .Session ID is not set. Call new_session first.rLz/streaming.startN ValueErrorrurZrLrcs rr}zHeyGenApi._start_sessions?MN N * ]]#5v>>>>s '0.0chK|s tdd|i}|jd|dd{S7w)a=Terminate an active the streaming session. https://docs.heygen.com/reference/close-session Args: session_id: ID of the session to stop. Returns: Response data from the stop session API call. Raises: ValueError: If session ID is not set. rrLz/streaming.stopF)rdNrrs r close_sessionzHeyGenApi.close_session sCMN N * ]]#4f%]PPPPs )202cLK|jdid{}|dS7 w)zCreate a streaming token. https://docs.heygen.com/reference/streaming-token Returns: str: The generated access token for the streaming session z/streaming.create_tokenNtoken)ru)rZ token_infos r create_tokenzHeyGenApi.create_token s- ==)BBGG '""Hs $" $)T)rrrrrir2rp ClientSessionrYrrr4rur?r rr}rrrrrr^r^s&*Hg.C.C(3(S#X(T(]`(T, .?, D[, \?s?s?,QcQcQ, #C #rr^)renumrtypingrrrrrplogururpydanticr r pipecat.services.heygen.base_apir r r2rrrr*r6r?rK ExceptionrRr^rrrrs //%SCC 3 --$ `I ` 0 04 I $ +Y + \# \#r