NggLdZddlmZddlmZmZmZmZmZm Z m Z m Z m Z m Z ddlmZmZddlmZddlmZddlmZmZmZmZmZmZddlmZmZmZdd l m!Z!dd l"m#Z#dd l$m%Z%dd l&m'Z'dd l(m)Z)ddl*m+Z+ddl,m-Z-dZ.eGddZ/eGddZ0dedefdZ1de0defdZ2dede3fdZ4dede3fdZ5dede3fdZ6dede3fdZ7Gdd eZ8d!S)"zHugging Face Chat Wrapper.) dataclass) AnyCallableDictListLiteralOptionalSequenceTypeUnioncast)AsyncCallbackManagerForLLMRunCallbackManagerForLLMRun)LanguageModelInput) BaseChatModel) AIMessage BaseMessage ChatMessage HumanMessage SystemMessage ToolMessage)ChatGeneration ChatResult LLMResult)Runnable)BaseToolconvert_to_openai_tool)model_validator)Self)HuggingFaceEndpoint)HuggingFacePipelinez4You are a helpful, respectful, and honest assistant.c4eZdZUdZeeed<eed<dS) TGI_RESPONSEz'Response from the TextGenInference API.choicesusageN)__name__ __module__ __qualname____doc__rr__annotations__ri/var/www/html/ai-engine/env/lib/python3.11/site-packages/langchain_huggingface/chat_models/huggingface.pyr$r$,s/11 #Y KKKKKr-r$c>eZdZUdZeed<eed<eeed<dS) TGI_MESSAGEz,Message to send to the TextGenInference API.rolecontent tool_callsN)r'r(r)r*strr+rrr,r-r.r0r04s:66 III LLLT r-r0messagereturnct|trt|j|jSt|t rtd|jSt|t r.d|jvrd|jdD}nd}d|j|dSt|trtd|jSt|trd|j|j d Std |) Nr1r2userr3cLg|]!}d|dd|dddi"S)functionname arguments)r<r=r,).0tcs r. z4_convert_message_to_chat_message..FsQ  ":v 6%' ^K%@!!r- assistant)r1r2r3systemtool)r1r2r<zGot unknown type ) isinstancerdictr1r2rradditional_kwargsrrr< ValueError)r5r3s r. _convert_message_to_chat_messagerH=s/';''8w???? G\ * *89999 GY ' '8 74 4 4"3LAJJJ$   G] + + 87?;;;; G[ ) )8L   6W66777r-_messagec~|j}|dks Jd|tt|j}|d}i}|jx}rjd|ddvrUt|ddd}|dd}||ddd<||d <t|| S) NrAz%Expected role to be 'assistant', got r=rr;'"r3)r2rF)r1r r4r2r3popreplacer)rIr1r2rFr3functions_stringcorrected_functionss r."_convert_TGI_message_to_LC_messagerRbs =D ;    N N N   3())G ((z5 *Q- 3 3 3":a=#<#@#@#M#MNN "2":":3"D"D 5HJqM* %k 2*4,' W8I J J JJr-llmcR ddlm}t||S#t$rYdSwxYw)Nr)HuggingFaceHubF)(langchain_community.llms.huggingface_hubrUrD ImportError)rSrUs r._is_huggingface_hubrXtsY      #~... uu  &&cR ddlm}t||S#t$rYdSwxYw)Nr)HuggingFaceTextGenInferenceF)7langchain_community.llms.huggingface_text_gen_inferencer[rDrW)rSr[s r.!_is_huggingface_textgen_inferencer]sZ      #:;;; uurYc,t|tSN)rDr!rSs r._is_huggingface_endpointra c. / //r-c,t|tSr_)rDr"r`s r._is_huggingface_pipelinerdrbr-c eZdZUdZeed< eeZeed<dZ eed<dZ e e ed<deffd Z ed d efd Zded efdZ d"deede ee de eded ef dZ d"deede ee de eded ef dZdeed e fdZded efdZeded efdZd#dZ ddde!e"e#e efe$e%e&fde e"ee e'de(fded e)e*efffdZ+deede ee d ee#eeffd Z,e-d e fd!Z.xZ/S)$ChatHuggingFaceuHugging Face LLM's as ChatModels. Works with `HuggingFaceTextGenInference`, `HuggingFaceEndpoint`, `HuggingFaceHub`, and `HuggingFacePipeline` LLMs. Upon instantiating this class, the model_id is resolved from the url provided to the LLM, and the appropriate tokenizer is loaded from the HuggingFace Hub. Setup: Install ``langchain-huggingface`` and ensure your Hugging Face token is saved. .. code-block:: bash pip install langchain-huggingface .. code-block:: python from huggingface_hub import login login() # You will be prompted for your HF key, which will then be saved locally Key init args — completion params: llm: `HuggingFaceTextGenInference`, `HuggingFaceEndpoint`, `HuggingFaceHub`, or 'HuggingFacePipeline' LLM to be used. Key init args — client params: custom_get_token_ids: Optional[Callable[[str], List[int]]] Optional encoder to use for counting tokens. metadata: Optional[Dict[str, Any]] Metadata to add to the run trace. tags: Optional[List[str]] Tags to add to the run trace. tokenizer: Any verbose: bool Whether to print out response text. See full list of supported init args and their descriptions in the params section. Instantiate: .. code-block:: python from langchain_huggingface import HuggingFaceEndpoint, ChatHuggingFace llm = HuggingFaceEndpoint( repo_id="microsoft/Phi-3-mini-4k-instruct", task="text-generation", max_new_tokens=512, do_sample=False, repetition_penalty=1.03, ) chat = ChatHuggingFace(llm=llm, verbose=True) Invoke: .. code-block:: python messages = [ ("system", "You are a helpful translator. Translate the user sentence to French."), ("human", "I love programming."), ] chat(...).invoke(messages) .. code-block:: python AIMessage(content='Je ai une passion pour le programme. In French, we use "ai" for masculine subjects and "a" for feminine subjects. Since "programming" is gender-neutral in English, we will go with the masculine "programme". Confirmation: "J'aime le programme." is more commonly used. The sentence above is technically accurate, but less commonly used in spoken French as "ai" is used less frequently in everyday speech.', response_metadata={'token_usage': ChatCompletionOutputUsage (completion_tokens=100, prompt_tokens=55, total_tokens=155), 'model': '', 'finish_reason': 'length'}, id='run-874c24b7-0272-4c99-b259-5d6d7facbc56-0') Stream: .. code-block:: python for chunk in chat.stream(messages): print(chunk) .. code-block:: python content='Je ai une passion pour le programme. In French, we use "ai" for masculine subjects and "a" for feminine subjects. Since "programming" is gender-neutral in English, we will go with the masculine "programme". Confirmation: "J'aime le programme." is more commonly used. The sentence above is technically accurate, but less commonly used in spoken French as "ai" is used less frequently in everyday speech.' response_metadata={'token_usage': ChatCompletionOutputUsage (completion_tokens=100, prompt_tokens=55, total_tokens=155), 'model': '', 'finish_reason': 'length'} id='run-7d7b1967-9612-4f9a-911a-b2b5ca85046a-0' Async: .. code-block:: python await chat.ainvoke(messages) .. code-block:: python AIMessage(content='Je déaime le programming. Littérale : Je (j'aime) déaime (le) programming. Note: "Programming" in French is "programmation". But here, I used "programming" instead of "programmation" because the user said "I love programming" instead of "I love programming (in French)", which would be "J'aime la programmation". By translating the sentence literally, I preserved the original meaning of the user's sentence.', id='run-fd850318-e299-4735-b4c6-3496dc930b1d-0') Tool calling: .. code-block:: python from pydantic import BaseModel, Field class GetWeather(BaseModel): '''Get the current weather in a given location''' location: str = Field(..., description="The city and state, e.g. San Francisco, CA") class GetPopulation(BaseModel): '''Get the current population in a given location''' location: str = Field(..., description="The city and state, e.g. San Francisco, CA") chat_with_tools = chat.bind_tools([GetWeather, GetPopulation]) ai_msg = chat_with_tools.invoke("Which city is hotter today and which is bigger: LA or NY?") ai_msg.tool_calls .. code-block:: python [{'name': 'GetPopulation', 'args': {'location': 'Los Angeles, CA'}, 'id': '0'}] Response metadata .. code-block:: python ai_msg = chat.invoke(messages) ai_msg.response_metadata .. code-block:: python {'token_usage': ChatCompletionOutputUsage(completion_tokens=100, prompt_tokens=8, total_tokens=108), 'model': '', 'finish_reason': 'length'} rSr2system_messageN tokenizermodel_idkwargsc tjdi|ddlm}||j||jn|j|_dS)Nr) AutoTokenizerr,)super__init__ transformersrm_resolve_model_idrifrom_pretrainedrj)selfrkrm __class__s r.rozChatHuggingFace.__init__<sv""6"""......    ~%  ) )$- 8 8 8 r-after)moder6ct|js`t|jsLt|js8t |js$t dt |j|S)NzyExpected llm to be one of HuggingFaceTextGenInference, HuggingFaceEndpoint, HuggingFaceHub, HuggingFacePipeline received )rXrSr]rard TypeErrortyperss r. validate_llmzChatHuggingFace.validate_llmIs$DH-- 5dh?? -TX66 -TX66  - NN--   r-responsecg}|jdj}tt|jdjd|i}|||j}|jj}||d}t||S)Nr finish_reasonr5generation_info) token_usagemodel generations llm_output) r%r~rrRr5appendr&rSinference_server_urlr)rsr|rr~genr model_objectrs r._create_chat_resultz#ChatHuggingFace._create_chat_resultXs  (+9 6x7G7J7RSS,m<    3n x4 %0<HH kjIIIIr-messagesstop run_managerc t|jrD|||}|jjjdd|i|}||St |jrD|||}|jjjdd|i|}||S||}|jj d|g||d|}| |SNr)promptsrrr,) r]rS_create_message_dictsclientchatrrachat_completion_to_chat_prompt _generate_to_chat_result rsrrrrk message_dictsanswer llm_input llm_results r.rzChatHuggingFace._generatees -TX 6 6 4 66xFFM)TX_)KK=KFKKF++F33 3 %dh / / 4 66xFFM4TX_4VVmVvVVF++F33 3,,X66I++" $KKQJ'' 33 3r-cPKt|jrJ|||}|jjjdd|i|d{V}||S||}|jjd|g||d|d{V}||Sr) r]rSr async_clientrrr _ageneraterrs r.rzChatHuggingFace._agenerate{s -TX 6 6 4 66xFFM54805WW}WPVWWWWWWWWF++F33 3,,X66I2tx2 " $K  KQ  J'' 33 3r-c|stdt|dtstdfd|D}j|ddS)zHConvert a list of messages into a prompt format expected by wrapped LLM.z+At least one HumanMessage must be provided!z$Last message must be a HumanMessage!c:g|]}|Sr,)_to_chatml_format)r>mrss r.r@z3ChatHuggingFace._to_chat_prompt..s'FFF$0033FFFr-FT)tokenizeadd_generation_prompt)rGrDrriapply_chat_template)rsrmessages_dictss` r.rzChatHuggingFace._to_chat_prompts  LJKK K(2, 55 ECDD DFFFFXFFF~11 U$2   r-r5ct|trd}nOt|trd}n7t|trd}nt dt |||jdS)z+Convert LangChain message to ChatML format.rBrAr9zUnknown message type: r8)rDrrrrGryr2)rsr5r1s r.rz!ChatHuggingFace._to_chatml_formats g} - - GDD  + + GDD  . . GDDEd7mmEEFF F999r-rcg}|jdD]@}tt|j|j}||At ||jS)Nrrgrr)rrrtextrrrr)rchat_generationsgchat_generations r.rzChatHuggingFace._to_chat_results'* 5 5A,!!&1111CTO  # #O 4 4 4 4(Z5J    r-cddlm}t|js!t |jdr|jjr|jj|_dSt|jr |jj}n3t|jr|jj|_dS|jj }|d}|D]}|j |kr |j |_|jstd|ddS)z8Resolve the model_id from the LLM's inference_server_urlr)list_inference_endpointsrepo_idN*zIFailed to resolve model_id:Could not find model id for inference server: zBMake sure that your Hugging Face token has access to the endpoint.)huggingface_hubrrXrShasattrrrjr]rrd endpoint_urlurl repositoryrG)rsrravailable_endpointsendpoints r.rqz!ChatHuggingFace._resolve_model_ids  =<<<<< tx ( ( 1 DHi ( ( 1-1X-= 1!H,DM F .tx 8 8 1*.(*GLL %dh / / 1 H-DM F80L66s;;+ 4 4H||++ ( 3 } UAMUUU   r-) tool_choicetoolsrautononec 0d|D}||rt|dkr tdt|dt|tr |dvrdd|id }nt|tr |d }ntt|t rM|d dd|ddkr(td |d |d ddd ntd|||d<t jdd|i|S)a*Bind tool-like objects to this chat model. Assumes model is compatible with OpenAI tool-calling API. Args: tools: A list of tool definitions to bind to this chat model. Supports any tool definition handled by :meth:`langchain_core.utils.function_calling.convert_to_openai_tool`. tool_choice: Which tool to require the model to call. Must be the name of the single provided function or "auto" to automatically determine which function to call (if any), or a dict of the form: {"type": "function", "function": {"name": <>}}. **kwargs: Any additional parameters to pass to the :class:`~langchain.runnable.Runnable` constructor. c,g|]}t|Sr,r)r>rCs r.r@z.ChatHuggingFace.bind_tools..s!JJJD1$77JJJr-NzKWhen specifying `tool_choice`, you must provide exactly one tool. Received z tools.rr;r<)ryr;rz Tool choice z/ was specified, but the only provided tool was .zEUnrecognized tool_choice type. Expected str, bool or dict. Received: rrr,)lenrGrDr4boolrErnbind)rsrrrkformatted_toolsrts r. bind_toolszChatHuggingFace.bind_toolss0KJEJJJ  "{ "?##q(( D&)/&:&:DDD+s++ &666 *%+[$9##KK.. -a0 K.. #A&z26:":.v677%W{WW-rs r.r@z9ChatHuggingFace._create_message_dicts..s!OOO9!<<OOOr-r,)rsrrrs r.rz%ChatHuggingFace._create_message_dictssPOhOOO r-cdS)Nzhuggingface-chat-wrapperr,rzs r. _llm_typezChatHuggingFace._llm_types))r-)NN)r6N)0r'r(r)r*rr+rDEFAULT_SYSTEM_PROMPTrhrirjr r4rorr r{r$rrrrrrrrrrEr staticmethodrrrqr r rr rrrrrrrrpropertyr __classcell__)rts@r.rfrfs`]]~ HHH3%2M:O$P$P$PNMPPPIs"Hhsm"""         _'""" d   #"  JL JZ J J J J %):> 44{#4tCy!467 4  4  44442%)?C 44{#4tCy!4;< 4  4  4444$ {#      " : : : : : :  I  *    \  BRV 6=6=6=d38ndHhFGH6=eD#w~/F$LMN 6=  6= $k1 2 6=6=6=6=6=6=p[)19$s)1D d38n  *3***X*****r-rfN)9r* dataclassesrtypingrrrrrr r r r r langchain_core.callbacks.managerrrlangchain_core.language_modelsr*langchain_core.language_models.chat_modelsrlangchain_core.messagesrrrrrrlangchain_core.outputsrrrlangchain_core.runnablesrlangchain_core.toolsr%langchain_core.utils.function_callingrpydanticrtyping_extensionsr /langchain_huggingface.llms.huggingface_endpointr!/langchain_huggingface.llms.huggingface_pipeliner"rr$r0rHrRrrXr]rardrfr,r-r.rsU !!!!!!                        >=====DDDDDDIHHHHHHHHH------))))))HHHHHH$$$$$$""""""OOOOOOOOOOOOR    "8 "8 "8"8"8"8JKKKKKK$ S T     3 4    0#0$00000#0$0000C*C*C*C*C*mC*C*C*C*C*r-