o Zh{@sddlmZddlZddlZddlZddlZddlmZmZm Z m Z m Z m Z m Z mZmZmZmZmZmZmZmZddlmZddlmZmZddlmZmZddlmZm Z m!Z!ddl"m#Z#m$Z$m%Z%dd l&m'Z'dd l(m)Z)dd l*m+Z+m,Z,m-Z-dd l.m/Z/e0e1Z2dddZ5d?ddZ6 d@dAd#d$Z7 d@dBd(d)Z8 d@dCd+d,Z9Gd-d.d.eZ:ed/d0d1d2Gd3d4d4e:Z;ed/d0d5d2Gd6d7d7e:Z._completion_with_retryNr-rLrr(r)r"rOrPrJr@rBrLZretry_decoratorrSr-rRr.completion_with_retryrs  rV'Optional[AsyncCallbackManagerForLLMRun]csRtrjjdi|IdHSt|d}|d fdd }|di|IdHS) z0Use tenacity to retry the async completion call.NrMrLrr(csjjdi|IdHSrN)rOZacreaterQrRr-r.rSsz6acompletion_with_retry.._completion_with_retryr-rT)r" async_clientrPrJrUr-rRr.acompletion_with_retrys rYcseZdZUdZedddZedddZedd d Zedd dZ e dddZ de d<e dddZ de d<e dddZde d< dZde d< dZde d< d Zde d!< d"Zde d#< d"Zde d$< d Zde d%< d Zde d&< e ed'Zd e d(< e dd)dZd*e d+< e dd,dZd*e d-< e dd.dZd*e d/< dZd*e d0<d1Zde d2< e dd3dZd4e d5< e ed'Zd6e d7< d8Zde d9< d:Z d e d;< e!Z"dZ#d?e d@< dZ$d*e dA< dZ%dBe dC<dZ&dDe dE<dZ'dFe dG< dfdJdK Z(e)ddLZ*e+dMdNeddPdQZ,e-ddSdTZ.eddUdVZ/  ddd^d_Z0  dddbdcZ1  dddfdgZ2  dddhdiZ3 dddldmZ4ddnddsdtZ5eddudvZ6eddxdyZ7eddzd{Z8dfd~d Z9e:dddZ;edddZS) BaseOpenAIz'Base OpenAI large language model class.r(Dict[str, str]cCsddiS)Nopenai_api_keyOPENAI_API_KEYr-selfr-r-r. lc_secretsszBaseOpenAI.lc_secrets List[str]cCgdSz*Get the namespace of the langchain object.)Z langchainZllmsrFr-clsr-r-r.get_lc_namespacezBaseOpenAI.get_lc_namespacer&cCs8i}|jr |j|d<|jr|j|d<|jr|j|d<|S)Nopenai_api_baseopenai_organization openai_proxy)rhrirj)r_ attributesr-r-r. lc_attributess   zBaseOpenAI.lc_attributesboolcCdS)NTr-rdr-r-r.is_lc_serializableszBaseOpenAI.is_lc_serializableNTdefaultexcluderrOrXgpt-3.5-turbo-instructmodelrqaliasstr model_namegffffff?float temperatureint max_tokenstop_prfrequency_penaltypresence_penaltynbest_ofdefault_factory model_kwargsapi_key Optional[str]r\base_urlrh organizationrirj batch_sizetimeoutz,Union[float, Tuple[float, float], Any, None]request_timeoutzOptional[Dict[str, float]] logit_biasrEF streaming'Union[Literal['all'], AbstractSet[str]]allowed_specialall&Union[Literal['all'], Collection[str]]disallowed_specialtiktoken_model_namezUnion[Mapping[str, str], None]default_headersz!Union[Mapping[str, object], None] default_queryzUnion[Any, None] http_clientdataUnion[OpenAIChat, BaseOpenAI]c sL|dd}|ds|dr d|vr tdtdi|St|S) zInitialize the OpenAI object.rxr2 gpt-3.5-turbogpt-4z -instructYou are trying to use a chat model. This way of initializing it is no longer supported. Instead, please use: `from langchain_community.chat_models import ChatOpenAI`Nr-)r; startswithwarningswarn OpenAIChatsuper__new__)rerrx __class__r-r.rs  zBaseOpenAI.__new__)Zpopulate_by_namebeforemodevaluescCst|}t||}|S)>Build extra kwargs from additional params that were passed in.)rr)rerall_required_field_namesr-r-r. build_extra s zBaseOpenAI.build_extrar c Csh|ddkr td|dr|ddkrtd|dr&|ddkr&tdt|dd |d<|d p6td |d <t|d d dd|d <|dpPtdpPtd|d<zddl}Wn tydtdwtr|d|d|d |d|d|d|d|dd}|ds|jdi|j |d<|ds|j di|j |d<|S|ds|j |d<|S |S)?Validate that api key and python package exists in environment.rr~n must be at least 1.r!Cannot stream results when n > 1.r'Cannot stream results when best_of > 1.r\r]rhOPENAI_API_BASErj OPENAI_PROXYr2rqri OPENAI_ORG_IDOPENAI_ORGANIZATIONrNTCould not import openai python package. Please install it with `pip install openai`.rrErrr)rrrrrErrrrOrXr-) ValueErrorrosgetenvrF ImportErrorr"r;OpenAI completionsZ AsyncOpenAI Completion)rerrF client_paramsr-r-r.validate_environmentsd        zBaseOpenAI.validate_environmentcCsn|j|j|j|j|j|jd}|jdur|j|d<|jdur&ts&|j|d<|j dkr0|j |d<i||j S)2Get the default parameters for calling OpenAI API.)rzrrrrrNr}rr~r) rzrrrrrr}rr"rr)r_Z normal_paramsr-r-r._default_paramsLs    zBaseOpenAI._default_paramspromptstopOptional[List[str]]rBrKrLIterator[GenerationChunk]cksi|j|ddi}|||g|t|f||d|D]'}t|ts*|}t|}|rC|j|j||j|j r?|j dndd|VqdSNstreamTrrBr6)chunkverboser6) _invocation_paramsget_sub_promptsrV isinstancer:r<on_llm_new_tokenr4rr9r_rrrBrLparams stream_resprr-r-r._streamds0  zBaseOpenAI._streamrWAsyncIterator[GenerationChunk]cKsi|j|ddi}|||g|t|f||d|IdH2z.3dHW}t|ts1|}t|}|rM|j|j||j|j rF|j dnddIdH|Vq"6dSr) rrrYrr:r<rr4rr9rr-r-r._astream~s0   zBaseOpenAI._astreampromptsrcKs<|j}i||}||||}g}i}hd} d} |D]w} |jrkt| dkr+tdd} |j| d||fi|D] } | durC| } q:| | 7} q:| dusNJ|| j| jr[| j dnd| jre| j dnddqt |f| |d |}t |t s| }| |d t| ||| s| d } q|j||||| d S) atCall out to OpenAI's endpoint with k unique prompts. Args: prompts: The prompts to pass into the model. stop: Optional list of stop words to use when generating. Returns: The full LLM output. Example: .. code-block:: python response = openai.generate(["Tell me a joke."]) Z total_tokensZcompletion_tokensZ prompt_tokensNr~,Cannot stream results with multiple prompts.rr5r6r>rr1system_fingerprintr)rrrlenrrappendr4r9r;rVrr:extendr/create_llm_resultr_rrrBrLr sub_promptsr1r'Z_keysrZ_prompts generationrr%r-r-r. _generates`        zBaseOpenAI._generatecs@|j}i||}||||}g}i}hd} d} |D]x} |jrqt| dkr,tdd} |j| d||fi|2z3dHW} | durH| } q;| | 7} q;6| dusTJ|| j| jra| j dnd| jrk| j dnddqt |f| |d |IdH}t |t s| }| |d t| ||q|j||||| d S) z:Call out to OpenAI's endpoint async with k unique prompts.rNr~rrr5r6r>rr1r)rrrrrrrr4r9r;rYrr:rr/rrr-r-r. _ageneratesf       zBaseOpenAI._ageneraterList[List[str]]csx|durd|vr td||d<|ddkr)tdkr tdd|d<fd d tdtjD}|S) z!Get the sub prompts for llm call.Nr2`stop` found in both the input and default params.r}r~z7max_tokens set to -1 not supported for multiple inputs.rcsg|] }||jqSr-)r).0irr_r-r. .sz.BaseOpenAI.get_sub_prompts..)rrmax_tokens_for_promptranger)r_rrrrr-rr.rs   zBaseOpenAI.get_sub_promptsrr1r'Dict[str, int]rc Cstg}|d|j}t|D]\}} ||||d|} |dd| Dq ||jd} |r4|| d<t|| dS)z2Create the LLMResult from the choices and prompts.rr~c Ss0g|]}t|dt|d|dddqS)r4r5r6r7r8)rr:r;)rchoicer-r-r.rCsz0BaseOpenAI.create_llm_result..r'rxr generations llm_output)r;r enumeraterrxr) r_r1rrr'rrrr_Z sub_choicesrr-r-r.r4s   zBaseOpenAI.create_llm_resultcCsNi}ts||j|j|jd|jr ddl}|j|jd|_i||jS)z,Get the parameters used to invoke the model.)rapi_baserrNhttphttps) r"updater\rhrirjrFproxyr)r_Z openai_credsrFr-r-r.rSszBaseOpenAI._invocation_paramsMapping[str, Any]cCid|ji|jSzGet the identifying parameters.rxrxrr^r-r-r._identifying_paramsezBaseOpenAI._identifying_paramscCrn)Return type of llm.rFr-r^r-r-r. _llm_typejzBaseOpenAI._llm_typer4 List[int]cstjddkr t|Szddl}Wn tytdw|jp$|j}z||}Wnt yAt dd}| |}Ynw|j ||j|jdS) -Get the token IDs using the tiktoken package.r~rNCould not import tiktoken python package. This is needed in order to calculate get_num_tokens. Please install it with `pip install tiktoken`.z5Warning: model not found. Using cl100k_base encoding.Z cl100k_baserr)sys version_inforget_num_tokenstiktokenrrrxencoding_for_modelKeyErrorloggerwarningZ get_encodingencoderr)r_r4r rxencrtrr-r. get_token_idsos,      zBaseOpenAI.get_token_ids modelnamec Csidddddddddddd d d d d d d dd dd dddddd ddddddddddddddddd }d|vrM|dd}||d }|d urftd!|d"d#||S)$aoCalculate the maximum number of tokens possible to generate for a model. Args: modelname: The modelname we want to know the context size for. Returns: The maximum context size Example: .. code-block:: python max_tokens = openai.modelname_to_contextsize("gpt-3.5-turbo-instruct") zgpt-4oizgpt-4o-2024-05-13ri z gpt-4-0314z gpt-4-0613z gpt-4-32kizgpt-4-32k-0314zgpt-4-32k-0613rizgpt-3.5-turbo-0301zgpt-3.5-turbo-0613zgpt-3.5-turbo-16ki@zgpt-3.5-turbo-16k-0613rsz text-ada-001iadaztext-babbage-001iiiAi) Zbabbageztext-curie-001ZcurieZdavinciztext-davinci-003ztext-davinci-002zcode-davinci-002zcode-davinci-001zcode-cushman-002zcode-cushman-001zft-:rNzUnknown model: z=. Please provide a valid OpenAI model name.Known models are: z, )splitr;rjoinr#)rZmodel_token_mappingZ context_sizer-r-r.modelname_to_contextsizesp        z#BaseOpenAI.modelname_to_contextsizecCs ||jS)z$Get max context size for this model.)rrxr^r-r-r.max_context_sizes zBaseOpenAI.max_context_sizecCs||}|j|S)apCalculate the maximum number of tokens possible to generate for a prompt. Args: prompt: The prompt to pass into the model. Returns: The maximum number of tokens to generate for a prompt. Example: .. code-block:: python max_tokens = openai.max_tokens_for_prompt("Tell me a joke.") )r r)r_rZ num_tokensr-r-r.rs  z BaseOpenAI.max_tokens_for_prompt)r(r[r(rar(r&)r(rm)rrr(rrr&r(rrr r(r NN rrwrrrBrKrLrr(r rrwrrrBrWrLrr(r rrarrrBrKrLrr(r rrarrrBrWrLrr(rN)rr&rrarrr(r) r1rrrarr&r'rrrr(rr(rr(rwr4rwr(r)rrwr(r|)r(r|)rrwr(r|)?__name__ __module__ __qualname____doc__propertyr` classmethodrfrlror rO__annotations__rXrxrzr}rrrrrr:rr\rhrirjrrrrErsetrrrrrrrrZ model_configr!rrrrrrrrrrrrrr staticmethodrrr __classcell__r-r-rr.rZs                     8    N >     : rZz0.0.10z1.0zlangchain_openai.OpenAI)ZsinceZremovalZalternative_importcs4eZdZdZed ddZed fdd ZZS) raOpenAI large language models. To use, you should have the ``openai`` python package installed, and the environment variable ``OPENAI_API_KEY`` set with your API key. Any parameters that are valid to be passed to the openai.create call can be passed in, even if not explicitly saved on this class. Example: .. code-block:: python from langchain_community.llms import OpenAI openai = OpenAI(model_name="gpt-3.5-turbo-instruct") r(racCrbrcr-rdr-r-r.rfrgzOpenAI.get_lc_namespacer&cid|jitjS)Nrt)rxrrr^rr-r.rszOpenAI._invocation_paramsrr) r)r*r+r,r.rfr-rr2r-r-rr.rs  rzlangchain_openai.AzureOpenAIcseZdZUdZdZded< edddZded< edd dZd ed < edd dZ ded < dZ ded< dZ ded< dZ ded< dZ d ed< dZded< ed)ddZed*ddZed+fd d! Zed,fd#d$ Zed-d%d&Zed,d'd(ZZS). AzureOpenAIaAzure-specific OpenAI large language models. To use, you should have the ``openai`` python package installed, and the environment variable ``OPENAI_API_KEY`` set with your API key. Any parameters that are valid to be passed to the openai.create call can be passed in, even if not explicitly saved on this class. Example: .. code-block:: python from langchain_community.llms import AzureOpenAI openai = AzureOpenAI(model_name="gpt-3.5-turbo-instruct") NzUnion[str, None]azure_endpointazure_deploymentrudeployment_namer2 api_versionrwopenai_api_versionrr\azure_ad_tokenzUnion[Callable[[], str], None]azure_ad_token_providerz)Union[Callable[[], Awaitable[str]], None]azure_ad_async_token_provideropenai_api_typeTrmvalidate_base_urlr(racCrbrcr-rdr-r-r.rf7rgzAzureOpenAI.get_lc_namespacerr cCs|ddkr td|dr|ddkrtd|dr&|ddkr&td|dp3td p3td |d<|d p>td |d <|d pItd|d <|dpTtd|d<t|dddd|d<|dpntdpntd|d<|dpytd|d<t|dddd|d<zddl}Wn tytdwtrH|d}|r|d rd!|vr|dd"d!|d<t d#|d$|dd%|d&rt d'|d&|dvrt d(|d$|dd%|dd)|d&7<d|d&<|d|d |d&|d|d |d*|d|d|d+|d,i|d-pid.d/i|d0|d1d2 }|j d6i|j |d3<|d4}|r;||d*<|j d6i|j |d5<|S|j |d3<|S)7rrr~rrrrrr\ZAZURE_OPENAI_API_KEYr]r5ZAZURE_OPENAI_ENDPOINTr:ZAZURE_OPENAI_AD_TOKENrhrrjrr2rrirrr9ZOPENAI_API_VERSIONr=ZOPENAI_API_TYPEazurerNrr>z/openai/zAs of openai>=1.0.0, Azure endpoints should be specified via the `azure_endpoint` param not `openai_api_base` (or alias `base_url`). Updating `openai_api_base` from z to .r7zAs of openai>=1.0.0, if `deployment_name` (or alias `azure_deployment`) is specified then `openai_api_base` (or alias `base_url`) should not be. Instead use `deployment_name` (or alias `azure_deployment`) and `azure_endpoint`.zAs of openai>=1.0.0, if `openai_api_base` (or alias `base_url`) is specified it is expected to be of the form https://example-resource.azure.openai.com/openai/deployments/example-deployment. Updating z /deployments/r;rrErz User-Agentz"langchain-comm-python-azure-openairr) r8r5r6rr:r;rrrrErrrrOr<rXr-)rrrrrFrr"rstriprrr4rZAsyncAzureOpenAIr)rerrFrhrr<r-r-r.r<s             z AzureOpenAI.validate_environmentrcr3)Nr7)r7rrr^rr-r.rs zAzureOpenAI._identifying_paramsr&cs4tr d|ji}n |j|j|jd}i|tjS)Nrt)ZengineZapi_typer8)r"r7r=r9rr)r_Z openai_paramsrr-r.rs zAzureOpenAI._invocation_paramscCrn)rr?r-r^r-r-r.rrzAzureOpenAI._llm_typecCs|j|jdS)Nr=r9rCr^r-r-r.rlszAzureOpenAI.lc_attributesrrr&rr')r)r*r+r,r5r/r r7r9r\r:r;r<r=r>r.rfrrr-rrrrlr2r-r-rr.r4s@         y r4z0.0.1zlangchain_openai.ChatOpenAIcseZdZUdZedddZded<edddZded<dZd ed < ee d Z d ed < edddZ ded< edddZ ded< dZ ded<dZded< eed Zded< dZded< eZded< dZd ed!< ed"d#edMd&d'ZedNd)d*ZedOd+d,Z dPdQd2d3Z  dRdSd9d:Z  dRdTd=d>Z  dRdUd@dAZ  dRdVdBdCZ edWdEdFZ!edXdGdHZ"dYfdKdL Z#Z$S)ZraOpenAI Chat large language models. To use, you should have the ``openai`` python package installed, and the environment variable ``OPENAI_API_KEY`` set with your API key. Any parameters that are valid to be passed to the openai.create call can be passed in, even if not explicitly saved on this class. Example: .. code-block:: python from langchain_community.llms import OpenAIChat openaichat = OpenAIChat(model_name="gpt-3.5-turbo") NTrprrOrXrrwrxrr&rrrurr\rrhrjr|rEr prefix_messagesFrmrrrrrrrrrr(cCsjddt|D}|di}t|D]}||vr.||vr'td|d||||<q||d<|S)rcSsh|]}|jqSr-)rv)rfieldr-r-r. sz)OpenAIChat.build_extra..rzFound z supplied twice.)rrr;listrpop)rerrextra field_namer-r-r.rs  zOpenAIChat.build_extrar cCst|dd}t|dddd}t|dddd}t|d d dd}zd d l}||_|r+||_|r0||_|r8||d |_Wn tyDtdwz|j|d<Wn tyWt dwt d|S)rr\r]rhrr2rrjrrirrNrrrOz`openai` has no `ChatCompletion` attribute, this is likely due to an old version of the openai package. Try upgrading it with `pip install --upgrade openai`.r) rrFrrrrrZChatCompletionAttributeErrorrrr)rerr\rhrjrirFr-r-r.rsX   zOpenAIChat.validate_environmentcCs|jS)r)rr^r-r-r.rHszOpenAIChat._default_paramsrrarrrcCst|dkr td||jd|ddg}id|ji|j}|dur2d|vr.td||d<|d d kr<|d =||fS) Nr~z6OpenAIChat currently only supports single prompt, got userr)Zrolecontentrtrrr}r)rrrErxrr;)r_rrmessagesrr-r-r._get_chat_paramsMs zOpenAIChat._get_chat_paramsrrBrKrLrc ks||g|\}}i||ddi}t|f||d|D](}t|ts*|}|ddddd}t|d } |rD|j|| d | VqdS NrTrOrBr1rdeltarNr2r3)r)rPrVrr:r;rr r_rrrBrLrOrrtokenrr-r-r.r_s$  zOpenAIChat._streamrWrc Ks||g|\}}i||ddi}t|f||d|IdH2z/3dHW}t|ts1|}|ddddd}t|d } |rN|j|| d IdH| Vq"6dSrQ)rPrYrr:r;rrrTr-r-r.rss$  zOpenAIChat._astreamrc Ks|jr-d}|j|d||fi|D] }|dur|}q||7}q|dus&Jt|ggdS|||\}}i||}t|f||d|} t| tsO| } | d|jd} tt| ddddd gg| d S Nr)rrRr*rr1messagerNr3r) rrrrPrVrr:rxr r_rrrBrLrrrOrZ full_responserr-r-r.rs6    zOpenAIChat._generatec s|jr3d}|j|d||fi|2z3dHW}|dur |}q||7}q6|dus,Jt|ggdS|||\}}i||}t|f||d|IdH} t| tsX| } | d|jd} tt| ddddd gg| d SrV) rrrrPrYrr:rxrrXr-r-r.rs:&    zOpenAIChat._ageneratercCrrrr^r-r-r.rrzOpenAIChat._identifying_paramscCrn)rz openai-chatr-r^r-r-r.rrzOpenAIChat._llm_typer4rcs^tjddkr t|Szddl}Wn tytdw||j}|j||j |j dS)rr~rrNrr ) r r rrr rrrxrrr)r_r4r rrr-r.rs    zOpenAIChat.get_token_idsrrrr%)rrarrr(rr r!r"r#r$r&r'r()%r)r*r+r,r rOr/rXrxr:rr\rhrjrErHrErr0rrr!r.rrrr-rrPrrrrrrrr2r-r-rr.rsb       2     & #  r)r#r$r%r&r'r&r(r))r0r&r(r)r%r&r0r&r(r)rr%)r@rArBrCr(rD)r@rArBrKrLrr(r)r@rArBrWrLrr(r)> __future__rloggingrr rtypingrrrrrrr r r r r rrrrZlangchain_core._api.deprecationrZlangchain_core.callbacksrrZ#langchain_core.language_models.llmsrrZlangchain_core.outputsrrrZlangchain_core.utilsrrrZlangchain_core.utils.pydanticrZlangchain_core.utils.utilsrZpydanticrr r!Z langchain_community.utils.openair" getLoggerr)rr/r<r=r?rJrVrYrZrr4rr-r-r-r.sX D            J\