a bg@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/e0e1Z2d ddddddZ3dddddZ4ddddddZ5ddddZ6d:dddd d!d"Z7d;dd#d$d$d%d&d'Z8d._completion_with_retry)r"rMrNrGr@rArIZretry_decoratorrQr,rPr-completion_with_retryrs  rS'Optional[AsyncCallbackManagerForLLMRun]csVtrjjfi|IdHSt|d}|dddfdd }|fi|IdHS)z0Use tenacity to retry the async completion call.NrJrrKcsjjfi|IdHSrL)rMZacreaterOrPr,r-rQsz6acompletion_with_retry.._completion_with_retry)r" async_clientrNrGrRr,rPr-acompletion_with_retrys  rVcsReZdZUdZeddddZeddddZed dd d Zed dd 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<ddHdIfdJdK Z(e)ddLZ*e+dMdNed ddOdPdQZ,e-dRdRdOdSdTZ.ed ddUdVZ/dddWdXddYdZd[d\Z0dddWd]dd^dZd_d`Z1dddWdXddadbdcddZ2dddWd]ddadbdedfZ3dd ddWdgdhdidjZ4ddkddd dld*dadmdndoZ5ed ddpdqZ6edrddsdtZ7edddudvZ8ddwdxfdydz Z9e:ddd{d|d}Z;eddd~dZS) BaseOpenAIz'Base OpenAI large language model class.zDict[str, str]r=cCsddiS)Nopenai_api_keyOPENAI_API_KEYr,selfr,r,r- lc_secretsszBaseOpenAI.lc_secrets List[str]cCsgdSz*Get the namespace of the langchain object.)Z langchainZllmsrCr,clsr,r,r-get_lc_namespaceszBaseOpenAI.get_lc_namespacer#cCs8i}|jr|j|d<|jr$|j|d<|jr4|j|d<|S)Nopenai_api_baseopenai_organization openai_proxy)rbrcrd)r[ attributesr,r,r- lc_attributess   zBaseOpenAI.lc_attributesboolcCsdS)NTr,r_r,r,r-is_lc_serializableszBaseOpenAI.is_lc_serializableNTdefaultexcluderrMrUgpt-3.5-turbo-instructmodelrjaliasstr model_namegffffff?float temperatureint max_tokenstop_prfrequency_penaltypresence_penaltynbest_ofdefault_factory model_kwargsapi_key Optional[str]rXbase_urlrb organizationrcrd batch_sizetimeoutz,Union[float, Tuple[float, float], Any, None]request_timeoutzOptional[Dict[str, float]] logit_biasrBF 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_clientzUnion[OpenAIChat, BaseOpenAI])datar(c sL|dd}|ds |dr@d|vr@tdtfi|St|S)zInitialize the OpenAI object.rqr1 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`)r: startswithwarningswarn OpenAIChatsuper__new__)r`rrq __class__r,r-rs zBaseOpenAI.__new__)Zpopulate_by_namebeforemodevaluesr(cCst|}t||}|S)>Build extra kwargs from additional params that were passed in.)rr)r`rall_required_field_namesr,r,r- build_extra s zBaseOpenAI.build_extrar c Csn|ddkrtd|dr0|ddkr0td|drL|ddkrLtdt|dd |d<|d pltd |d <t|d d dd|d <|dptdptd|d<z ddl}WntytdYn0trR|d|d|d |d|d|d|d|dd}|ds.|jfi|j |d<|dsj|j fi|j |d<n|dsj|j |d<n|S)?Validate that api key and python package exists in environment.r{rwn must be at least 1.r!Cannot stream results when n > 1.r|'Cannot stream results when best_of > 1.rXrYrbOPENAI_API_BASErd OPENAI_PROXYr1rjrc OPENAI_ORG_IDOPENAI_ORGANIZATIONrNTCould not import openai python package. Please install it with `pip install openai`.rrBrrr)rrrrrBrrrrMrU) ValueErrorrosgetenvrC ImportErrorr"r:OpenAI completionsZ AsyncOpenAI Completion)r`rrC client_paramsr,r,r-validate_environments\          zBaseOpenAI.validate_environmentcCsn|j|j|j|j|j|jd}|jdur2|j|d<|jdurLtsL|j|d<|j dkr`|j |d<i||j S)2Get the default parameters for calling OpenAI API.)rsrxryrzr{rNrvrrwr|) rsrxryrzr{rrvrr"r|r)r[Z normal_paramsr,r,r-_default_paramsLs     zBaseOpenAI._default_paramsOptional[List[str]]rHIterator[GenerationChunk]promptstoprArIr(cksi|j|ddi}|||g|t|f||d|D]N}t|tsR|}t|}|r|j|j||j|j r||j dndd|Vqrr0system_fingerprintr)rrrlenrrappendr3r8r:rSrr9extendr.create_llm_resultr[rrrArIr sub_promptsr0r'Z_keysrZ_prompts generationrr&r,r,r- _generates^        zBaseOpenAI._generatecs@|j}i||}||||}g}i}hd} d} |D]} |jrt| dkrVtdd} |j| d||fi|2z"3dHW} | dur| } qt| | 7} qt6| dusJ|| j| jr| j dnd| jr| j dnddq8t |f| |d |IdH}t |t s| }| |d t| ||q8|j||||| d S) z:Call out to OpenAI's endpoint async with k unique prompts.rNrwrrr4r5r>rr0r)rrrrrrrr3r8r:rVrr9rr.rrr,r,r- _ageneratesb        zBaseOpenAI._ageneratezList[List[str]])rrrr(csx|dur d|vrtd||d<|ddkrRtdkr@tdd|d<fd d tdtjD}|S) z!Get the sub prompts for llm call.Nr2`stop` found in both the input and default params.rvrwz7max_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_promptsrzDict[str, int])r0rrr'rr(c Cstg}|d|j}t|D]4\}} ||||d|} |dd| Dq||jd} |rh|| d<t|| dS)z2Create the LLMResult from the choices and prompts.r{rwc Ss0g|](}t|dt|d|dddqS)r3r4r5r6r7)rr9r:)rchoicer,r,r-rCsz0BaseOpenAI.create_llm_result..r'rqr generations llm_output)r:r{ enumeraterrqr) r[r0rrr'rrr{r_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"updaterXrbrcrdrCproxyr)r[Z openai_credsrCr,r,r-rSszBaseOpenAI._invocation_paramsMapping[str, Any]cCsid|ji|jSzGet the identifying parameters.rqrqrrZr,r,r-_identifying_paramseszBaseOpenAI._identifying_paramscCsdS)Return type of llm.rCr,rZr,r,r- _llm_typejszBaseOpenAI._llm_type List[int]r3r(cstjddkrt|Sz ddl}Wnty@tdYn0|jpL|j}z||}Wn*t yt dd}| |}Yn0|j ||j|jdS) -Get the token IDs using the tiktoken package.rwrNCould 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_tokenstiktokenrrrqencoding_for_modelKeyErrorloggerwarningZ get_encodingencoderr)r[r3rrqencrmrr,r- get_token_idsos(       zBaseOpenAI.get_token_ids) modelnamer(cCsdddddddddddddddddddddddd d d d d }d |vrR|d d}||d}|durtd|dd||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") ii iii@iiiiAi)zgpt-4ozgpt-4o-2024-05-13rz gpt-4-0314z gpt-4-0613z gpt-4-32kzgpt-4-32k-0314zgpt-4-32k-0613rzgpt-3.5-turbo-0301zgpt-3.5-turbo-0613zgpt-3.5-turbo-16kzgpt-3.5-turbo-16k-0613rlz text-ada-001adaztext-babbage-001Zbabbageztext-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%)r Zmodel_token_mappingZ context_sizer,r,r-modelname_to_contextsizesL   z#BaseOpenAI.modelname_to_contextsizecCs ||jS)z$Get max context size for this model.)rrqrZr,r,r-max_context_sizeszBaseOpenAI.max_context_size)rr(cCs||}|j|S)aoCalculate 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_token_for_prompt("Tell me a joke.") )rr)r[rZ num_tokensr,r,r-rs z BaseOpenAI.max_tokens_for_prompt)NN)NN)NN)NN)N)?__name__ __module__ __qualname____doc__propertyr\ classmethodrarfrhr rM__annotations__rUrqrsrvrxryrzr{r|r9rrXrbrcrdrrrrBrsetrrrrrrrrZ model_configr!rrrrrrrrrrrrrr  staticmethodrrr __classcell__r,r,rr-rWs                 8N>:rWz0.0.10z1.0zlangchain_openai.OpenAI)ZsinceZremovalZalternative_importcs<eZdZdZeddddZeddfdd 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]r=cCsgdSr^r,r_r,r,r-raszOpenAI.get_lc_namespacer#csid|jitjS)Nrm)rqrrrZrr,r-rszOpenAI._invocation_params) rrrrrrarrrr,r,rr-rs rzlangchain_openai.AzureOpenAIcseZdZUdZdZded<edddZded<edd dZd ed <edd dZ ded <dZ ded<dZ ded<dZ ded<dZ d ed<dZded<eddddZedddddZeddfd d! Zed"dfd#d$ Zed dd%d&Zed"dd'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_deploymentrndeployment_namer1 api_versionrpopenai_api_versionrrXazure_ad_tokenzUnion[Callable[[], str], None]azure_ad_token_providerz)Union[Callable[[], Awaitable[str]], None]azure_ad_async_token_provideropenai_api_typeTrgvalidate_base_urlr]r=cCsgdSr^r,r_r,r,r-ra7szAzureOpenAI.get_lc_namespacer rcCs|ddkrtd|dr0|ddkr0td|drL|ddkrLtd|dpftd pftd |d<|d p|td |d <|d ptd|d <|dptd|d<t|dddd|d<|dptdptd|d<|dptd|d<t|dddd|d<z ddl}Wnty4tdYn0tr|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,|d-|d.|d/d0 }|j fi|j |d1<|d2}|rt||d*<|j fi|j |d3<n |j |d1<|S)4rr{rwrrrr|rrXZAZURE_OPENAI_API_KEYrYrZAZURE_OPENAI_ENDPOINTr#ZAZURE_OPENAI_AD_TOKENrbrrdrr1rrcrrr"ZOPENAI_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 .r zAs 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$rrBrrr) r!rrrr#r$rrrrBrrrrMr%rU)rrrrrCrr"rstriprrrrZAsyncAzureOpenAIr)r`rrCrbrr%r,r,r-r<s             z AzureOpenAI.validate_environmentrcsid|jitjS)Nr )r rrrZrr,r-rs zAzureOpenAI._identifying_paramsr#cs4trd|ji}n|j|j|jd}i|tjS)Nrm)ZengineZapi_typer!)r"r r&r"rr)r[Z openai_paramsrr,r-rs zAzureOpenAI._invocation_paramscCsdS)rr(r,rZr,r,r-rszAzureOpenAI._llm_typecCs|j|jdS)Nr&r"r,rZr,r,r-rfszAzureOpenAI.lc_attributes)rrrrrrr r r"rXr#r$r%r&r'rrarrrrrrrfrr,r,rr-rs,       v rz0.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#ed dd$d%d&Zed'd'd$d(d)Zed d*d+d,ZdKd-d.d/d0d1d2ZdLd d.d3dd4d5d6d7ZdMd d.d8dd9d5d:d;ZdNd-d.d3ddd?ZdOd-d.d8ddz)OpenAIChat.build_extra..rzFound z supplied twice.)rrr:listrpop)r`rrextra field_namer,r,r-rs  zOpenAIChat.build_extrar cCst|dd}t|dddd}t|dddd}t|d d dd}z6d d l}||_|rV||_|r`||_|rp||d |_WntytdYn0z|j|d<Wntyt dYn0t d|S)rrXrYrbrr1rrdrrcrrNrrrMz`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) rrCrrrrrZChatCompletionAttributeErrorrrr)r`rrXrbrdrcrCr,r,r-rsR    zOpenAIChat.validate_environmentr=cCs|jS)r)rrZr,r,r-rEszOpenAIChat._default_paramsr]rr)rrr(cCst|dkrtd||jd|ddg}id|ji|j}|durdd|vr\td||d<|d d krx|d =||fS) Nrwz6OpenAIChat currently only supports single prompt, got userr)Zrolecontentrmrrrvr)rrr.rqrr:)r[rrmessagesrr,r,r-_get_chat_paramsJs zOpenAIChat._get_chat_paramsrHrrc ks||g|\}}i||ddi}t|f||d|D]P}t|tsR|}|ddddd}t|d } |r|j|| d | Vqr,r,r-rps   zOpenAIChat._astreamrrc Ks|jrZd}|j|d||fi|D]}|dur6|}q$||7}q$|dusLJt|ggdS|||\}}i||}t|f||d|} t| ts| } | d|jd} tt| ddddd gg| d S Nr)rr<r)rr0messager8r2r) rrrr:rSrr9rqr r[rrrArIrrr9rZ full_responserr,r,r-rs6    zOpenAIChat._generatec s|jrdd}|j|d||fi|2z"3dHW}|dur>|}q$||7}q$6|dusVJt|ggdS|||\}}i||}t|f||d|IdH} t| ts| } | d|jd} tt| ddddd gg| d Sr@) rrrr:rVrr9rqrrBr,r,r-rs6&     zOpenAIChat._ageneratercCsid|ji|jSrrrZr,r,r-rszOpenAIChat._identifying_paramscCsdS)rz openai-chatr,rZr,r,r-rszOpenAIChat._llm_typerrcsbtjddkrt|Sz ddl}Wnty@tdYn0||j}|j||j |j dS)rrwrrNrr) rrrr rrrrqr rr)r[r3rr rr,r-r s     zOpenAIChat.get_token_ids)N)NN)NN)NN)NN)%rrrrr rMrrUrqr9rrXrbrdrBr2r.rrrrr!rrrrrrr:rrrrrrr rr,r,rr-rsN       2&#r)N)N)N)> __future__rloggingrrrtypingrrrrrrr 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" getLoggerrrr.r;r<r?rGrSrVrWrrrr,r,r,r-sV D       J Y