U h@sddlmZddlZddlZddlZddlZddlmZmZm Z m Z m Z m Z m Z mZmZmZmZmZmZmZddlmZddlmZmZddlmZmZddlmZmZm Z ddl!m"Z"m#Z#dd l$m%Z%m&Z&m'Z'dd l(m)Z)dd l*m+Z+dd l,m-Z-e.e/Z0d ddddddZ1dddddZ2ddddddZ3ddddZ4d:dddd d!d"Z5d;dd#d$d$d%d&d'Z6dr?rAerrorsr*r*r+_create_retry_decorator]srE"Optional[CallbackManagerForLLMRun]r)r>r?kwargsr&c sBtrjjf|St|d}|dddfdd }|f|S)z*Use tenacity to retry the completion call.r?rrGr&csjjf|SN)clientcreaterGr>r*r+_completion_with_retry|sz5completion_with_retry.._completion_with_retry)r rKrLrEr>r?rGZretry_decoratorrOr*rNr+completion_with_retryqs  rQ'Optional[AsyncCallbackManagerForLLMRun]csNtrjjf|IdHSt|d}|dddfdd }|f|IdHS)z0Use tenacity to retry the async completion call.NrHrrIcsjjf|IdHSrJ)rKZacreaterMrNr*r+rOsz6acompletion_with_retry.._completion_with_retry)r async_clientrLrErPr*rNr+acompletion_with_retrys  rTcsReZdZUdZeddddZeddddZed 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(GdLdMdMZ)e*ddNd d dOdPdQZ+e,dRdRdOdSdTZ-ed ddUdVZ.dddWdXddYdZd[d\Z/dddWd]dd^dZd_d`Z0dddWdXddadbdcddZ1dddWd]ddadbdedfZ2dd ddWdgdhdidjZ3ddkddd dld*dadmdndoZ4ed ddpdqZ5edrddsdtZ6edddudvZ7ddwdxfdydz Z8e9ddd{d|d}Z:eddd~dZ;dddddZ<Z=S) 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]cCs dddgSz*Get the namespace of the langchain object.Z langchainZllmsrAr*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)r`rarb)rY attributesr*r*r+ lc_attributess   zBaseOpenAI.lc_attributesboolcCsdS)NTr*r]r*r*r+is_lc_serializableszBaseOpenAI.is_lc_serializableNTdefaultexcluderrKrSgpt-3.5-turbo-instructmodelrhaliasstr model_namegffffff?float temperatureint max_tokenstop_prfrequency_penaltypresence_penaltynbest_ofdefault_factory model_kwargsapi_key Optional[str]rVbase_urlr` organizationrarb batch_sizetimeoutz,Union[float, Tuple[float, float], Any, None]request_timeoutzOptional[Dict[str, float]] logit_biasr@F 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 sH|dd}|ds |drBuild extra kwargs from additional params that were passed in.r})rr8r)r^rall_required_field_namesextrar*r*r+ build_extra s zBaseOpenAI.build_extrarc Csh|ddkrtd|dr0|ddkr0td|drL|ddkrLtdt|dd |d<|d pltd |d <t|d d dd|d <|dptdptd|d<z ddl}Wntk rtdYnXtrL|d|d|d |d|d|d|d|dd}|ds,|jf|j |d<|dsd|j f|j |d<n|dsd|j |d<n|S)?Validate that api key and python package exists in environment.ryrun must be at least 1.r!Cannot stream results when n > 1.rz'Cannot stream results when best_of > 1.rVrWr`OPENAI_API_BASErb OPENAI_PROXYr/rhra OPENAI_ORG_IDOPENAI_ORGANIZATIONrNTCould not import openai python package. Please install it with `pip install openai`.rr@rrr)r~rrrr@rrrrKrS) ValueErrorrosgetenvrA ImportErrorr r8OpenAI completionsZ AsyncOpenAI Completion)r^rrA client_paramsr*r*r+validate_environments`         zBaseOpenAI.validate_environmentcCsj|j|j|j|j|j|jd}|jdk r2|j|d<|jdk rLtsL|j|d<|j dkr`|j |d<||j S)2Get the default parameters for calling OpenAI API.)rqrvrwrxryrNrtrrurz) rqrvrwrxryrrtrr rzr})rYZ normal_paramsr*r*r+_default_paramsLs     zBaseOpenAI._default_paramsOptional[List[str]]rFIterator[GenerationChunk]promptstopr?rGr&cks|j|ddi}|||g|t|f||d|D]N}t|tsL|}t|}|r~|j|j||j|j rv|j dndd|Vq6dSNstreamTrr?r3)chunkverboser3) _invocation_paramsget_sub_promptsrQ isinstancer7r9on_llm_new_tokenr1rr6rYrrr?rGparams stream_resprr*r*r+_streamds.   zBaseOpenAI._streamrRAsyncIterator[GenerationChunk]cKs|j|ddi}|||g|t|f||d|IdH2z\3dHW}t|tsZ|}t|}|r|j|j||j|j r|j dnddIdH|Vq<6dSr) rrrTrr7r9rr1rr6rr*r*r+_astream~s.   zBaseOpenAI._astreamrpromptsrr?rGr&cKs6|j}||}||||}g}i}dddh} d} |D]} |jrt| dkrTtdd} |j| d||f|D]} | dkr| } qn| | 7} qn| dk st|| j| j r| j dnd| j r| j d ndd q6t |f| |d |}t |t s| }||d t| ||| s6| d } q6|j||||| dS)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."]) completion_tokens prompt_tokens total_tokensNru,Cannot stream results with multiple prompts.rr2r3r<rr.system_fingerprintr)rrrlenrrAssertionErrorappendr1r6r8rQrr7extendr,create_llm_resultrYrrr?rGr sub_promptsr.r%_keysrZ_prompts generationrr$r*r*r+ _generates`        zBaseOpenAI._generatecs:|j}||}||||}g}i}dddh} d} |D]} |jrt| dkrTtdd} |j| d||f|2z"3dHW} | dkr| } qn| | 7} qn6| dk st|| j| j r| j dnd| j r| j d ndd q6t |f| |d |IdH}t |t s | }||d t| ||q6|j||||| d S)z:Call out to OpenAI's endpoint async with k unique prompts.rrrNrurrr2r3r<rr.r)rrrrrrrrr1r6r8rTrr7rr,rrr*r*r+ _ageneratesh       zBaseOpenAI._ageneratezList[List[str]])rrrr&csx|dk r d|krtd||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.rtruz7max_tokens set to -1 not supported for multiple inputs.rcsg|]}||jqSr*)r).0irrYr*r+ .sz.BaseOpenAI.get_sub_prompts..)rrmax_tokens_for_promptranger)rYrrrrr*rr+rs   zBaseOpenAI.get_sub_promptsrzDict[str, int])r.rrr%rr&c Cstg}|d|j}t|D]4\}} ||||d|} |dd| Dq||jd} |rh|| d<t|| dS)z2Create the LLMResult from the choices and prompts.ryruc Ss0g|](}t|dt|d|dddqS)r1r2r3r4r5)rr7r8)rchoicer*r*r+rCsz0BaseOpenAI.create_llm_result..r%ror generations llm_output)r8ry enumeraterror) rYr.rrr%rrryr_Z sub_choicesrr*r*r+r4s  zBaseOpenAI.create_llm_resultcCsJi}ts"||j|j|jd|jr@ddl}|j|jd|_||jS)z,Get the parameters used to invoke the model.)r~api_baserrNhttphttps) r updaterVr`rarbrAproxyr)rYZ openai_credsrAr*r*r+rSszBaseOpenAI._invocation_paramsMapping[str, Any]cCsd|ji|jSzGet the identifying parameters.rororrXr*r*r+_identifying_paramseszBaseOpenAI._identifying_paramscCsdS)Return type of llm.rAr*rXr*r*r+ _llm_typejszBaseOpenAI._llm_type List[int]r1r&cstjddkrt|Sz ddl}Wntk rBtdYnX|jpN|j}z||}Wn,t k rt dd}| |}YnX|j ||j|jdS) -Get the token IDs using the tiktoken package.rurNCould 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_tokenstiktokenrrroencoding_for_modelKeyErrorloggerwarningZ get_encodingencoderr)rYr1r roencrkrr*r+ get_token_idsos(     zBaseOpenAI.get_token_ids) modelnamer&cCsdddddddddddddddddddddddd d d d d }d |krR|d d}||d}|dkrtd|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-0613rjz text-ada-001Zadaztext-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, )splitr8rjoinr#)rZmodel_token_mappingZ context_sizer*r*r+modelname_to_contextsizesL   z#BaseOpenAI.modelname_to_contextsizecCs ||jS)z$Get max context size for this model.)rrorXr*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.") )r r)rYrZ num_tokensr*r*r+rs z BaseOpenAI.max_tokens_for_prompt)NN)NN)NN)NN)N)>rrr__doc__propertyrZ classmethodr_rdrfrrK__annotations__rSrorqrtrvrwrxryrzr7r}rVr`rarbrrrr@rsetrrrrrrrrrrrrrrrrrrrrrrr staticmethodrrr __classcell__r*r*rr+rUs                  8N>:rUz0.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;cCs dddgSr\r*r]r*r*r+r_szOpenAI.get_lc_namespacer!csd|jitjS)Nrk)rorrrXrr*r+rszOpenAI._invocation_params) rrrrrr_rrrr*r*rr+rs rzlangchain_openai.AzureOpenAIcseZdZUdZdZded<edddZded<edd dZd ed <edd dZ ded <dZ ded<dZ ded<dZ d ed<dZ ded<eddddZedddddZeddfdd 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_deploymentrldeployment_namer/ api_versionrnopenai_api_versionr~rVazure_ad_tokenzUnion[Callable[[], str], None]azure_ad_token_provideropenai_api_typeTrevalidate_base_urlr[r;cCs dddgSr\r*r]r*r*r+r_1szAzureOpenAI.get_lc_namespacerrcCs~|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}Wntk r6tdYnXtrp|d}|r|d rd!|kr|dd"d!|d<t d#|d$|dd%|d&rt d'|d&|dkrt d(|d$|dd%|dd)|d&7<d|d&<|d|d |d&|d|d |d*|d|d|d+|d,|d-|d.|d/d0 }|j f|j |d1<|j f|j |d2<n |j |d1<|S)3rryrurrrrzrrVZAZURE_OPENAI_API_KEYrWr ZAZURE_OPENAI_ENDPOINTr%ZAZURE_OPENAI_AD_TOKENr`rrbrr/rrarrr$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&rr@rrr) r#r r!r~r%r&rrrr@rrrrKrS)rrrrrArr rstriprrrrZAsyncAzureOpenAIr)r^rrAr`rr*r*r+r6s              z AzureOpenAI.validate_environmentrcsd|jitjS)Nr")r"rrrXrr*r+rszAzureOpenAI._identifying_paramsr!cs0trd|ji}n|j|j|jd}|tjS)Nrk)ZengineZapi_typer#)r r"r'r$rr)rYZ openai_paramsrr*r+rs zAzureOpenAI._invocation_paramscCsdS)rr)r*rXr*r*r+rszAzureOpenAI._llm_typecCs|j|jdS)Nr'r$r-rXr*r*r+rdszAzureOpenAI.lc_attributes)rrrrr rrr"r$rVr%r&r'r(rr_rrrrrrrdrr*r*rr+rs*      p 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!<edd"d d d#d$d%Zed&d&d#d'd(Zed d)d*d+ZdJd,d-d.d/d0d1ZdKd d-d2dd3d4d5d6ZdLd d-d7dd8d4d9d:ZdMd,d-d2dd;d<d=d>ZdNd,d-d7dd;d<d?d@ZedAd)dBdCZ ed d)dDdEZ!d dFdGfdHdI Z"Z#S)OraOpenAI 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") NTrgrrKrSrrnror{r!r}r~rlrrVrr`rbrsr@r prefix_messagesFrerrrrrrrrcCsjddt|D}|di}t|D]2}||kr*||krNtd|d||||<q*||d<|S)rcSsh|] }|jqSr*)rm)rfieldr*r*r+ sz)OpenAIChat.build_extra..r}zFound z supplied twice.)rrr8listrpop)r^rrr field_namer*r*r+rs  zOpenAIChat.build_extrarcCst|dd}t|dddd}t|dddd}t|d d dd}z6d d l}||_|rV||_|r`||_|rp||d |_Wntk rtdYnXz|j|d<Wntk rt dYnXt d|S)rrVrWr`rr/rrbrrarrNrrrKz`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) rrAr~rrrrZChatCompletionAttributeErrorrrr)r^rrVr`rbrarAr*r*r+rs\  zOpenAIChat.validate_environmentr;cCs|jS)r)r}rXr*r*r+r8szOpenAIChat._default_paramsr[rr)rrr&cCs|t|dkrtd||jd|ddg}d|ji|j}|dk r`d|krXtd||d<|d d krt|d =||fS) Nruz6OpenAIChat currently only supports single prompt, got userr)rolecontentrkrrrtr)rrr/rorr8)rYrrmessagesrr*r*r+_get_chat_params=s zOpenAIChat._get_chat_paramsrFrrc ks||g|\}}||ddi}t|f||d|D]P}t|tsL|}|ddddd}t|d } |r|j|| d | Vq6dS NrTr9r?r.rdeltar8r/r0)r)r:rQrr7r8rr rYrrr?rGr9rrtokenrr*r*r+rOs"   zOpenAIChat._streamrRrc Ks||g|\}}||ddi}t|f||d|IdH2z^3dHW}t|tsZ|}|ddddd}t|d } |r|j|| d IdH| Vq<6dSr;)r:rTrr7r8rrr>r*r*r+rcs"  zOpenAIChat._astreamrrc Ks|jrVd}|j|d||f|D]}|dkr2|}q ||7}q |dk sHtt|ggdS|||\}}||}t|f||d|} t| ts| } | d|jd} tt | ddddd gg| d S Nr)rr<r'rr.messager8r0r) rrrrr:rQrr7ror rYrrr?rGrrr9rZ full_responserr*r*r+rws8   zOpenAIChat._generatec s|jr`d}|j|d||f|2z"3dHW}|dkr:|}q ||7}q 6|dk sRtt|ggdS|||\}}||}t|f||d|IdH} t| ts| } | d|jd} tt | ddddd gg| d Sr@) rrrrr:rTrr7rorrBr*r*r+rs8"    zOpenAIChat._ageneratercCsd|ji|jSrrrXr*r*r+rszOpenAIChat._identifying_paramscCsdS)rz openai-chatr*rXr*r*r+rszOpenAIChat._llm_typerrcsdtjddkrt|Sz ddl}Wntk rBtdYnX||j}|j||j |j dS)rrurrNrr) rrrrr rr rorrr)rYr1r rrr*r+rs    zOpenAIChat.get_token_ids)N)NN)NN)NN)NN)$rrrrrrKrrSror7r}rVr`rbr@r2r/rrrrrrrrrrr:rrrrrrrrr*r*rr+rsL       2&#r)N)N)N)< __future__rloggingrrrtypingrrrrrrr r r r r rrrZlangchain_core._api.deprecationrZlangchain_core.callbacksrrZ#langchain_core.language_models.llmsrrZlangchain_core.outputsrrrZlangchain_core.pydantic_v1rrZlangchain_core.utilsrrrZlangchain_core.utils.pydanticrZlangchain_core.utils.utilsrZ langchain_community.utils.openair getLoggerrr r,r9r:r=rErQrTrUrrrr*r*r*r+sZ @       K M