o Zh4@s8dZddlmZmZmZmZmZmZmZddl m Z ddl m Z m Z ddlmZmZddlmZddlmZmZddlmZdd lmZmZmZmZdd lmZmZdd l m!Z!dd l"m#Z#dd l$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-e ddddGddde)Z.dedee!dedefddZ/dS)zHModule implements an agent that uses OpenAI's APIs function enabled API.)AnyListOptionalSequenceTupleTypeUnion) deprecated) AgentAction AgentFinish)BaseCallbackManager Callbacks)BaseLanguageModel) BaseMessage SystemMessage)BasePromptTemplate)BaseMessagePromptTemplateChatPromptTemplateHumanMessagePromptTemplateMessagesPlaceholder)RunnableRunnablePassthrough)BaseToolconvert_to_openai_function)model_validator)Self)BaseSingleActionAgent"format_to_openai_function_messages) OpenAIFunctionsAgentOutputParserz0.1.0create_openai_functions_agentz1.0) alternativeZremovalc@seZdZUdZeed<eeed<eed<e Z e e ed<de e fddZed d defd d Zede e fd dZede efddZ  d'de eee fdedededeeeff ddZ d(de eee fdededeeeffddZde de eee fdedefddZe e!dddfd e"e!d!e"e e#de$fd"d#Z%e dde!ddfdedeed$e"e&d!e"e e#d e"e!dede'fd%d&Z(dS))OpenAIFunctionsAgentazAn Agent driven by OpenAIs function powered API. Args: llm: This should be an instance of ChatOpenAI, specifically a model that supports using `functions`. tools: The tools this agent has access to. prompt: The prompt for this agent, should support agent_scratchpad as one of the variables. For an easy way to construct this prompt, use `OpenAIFunctionsAgent.create_prompt(...)` output_parser: The output parser for this agent. Should be an instance of OpenAIFunctionsAgentOutputParser. Defaults to OpenAIFunctionsAgentOutputParser. llmtoolsprompt output_parserreturncCdd|jDS)zGet allowed tools.cSsg|]}|jqS)name.0tr*r*c/var/www/html/lang_env/lib/python3.10/site-packages/langchain/agents/openai_functions_agent/base.py <sz:OpenAIFunctionsAgent.get_allowed_tools..r%selfr*r*r/get_allowed_tools:sz&OpenAIFunctionsAgent.get_allowed_toolsafter)modecCs$|j}d|jvrtd|j|S)zValidate prompt. Args: values: Values to validate. Returns: Validated values. Raises: ValueError: If `agent_scratchpad` is not in the prompt. agent_scratchpadzE`agent_scratchpad` should be one of the variables in the prompt, got )r&input_variables ValueError)r3r&r*r*r/validate_prompt>s z$OpenAIFunctionsAgent.validate_promptcCsdgS)z0Get input keys. Input refers to user input here.inputr*r2r*r*r/ input_keysSszOpenAIFunctionsAgent.input_keyscCr))zGet functions.cSsg|]}tt|qSr*)dictrr,r*r*r/r0\sz2OpenAIFunctionsAgent.functions..r1r2r*r*r/ functionsXszOpenAIFunctionsAgent.functionsNTintermediate_steps callbackswith_functionskwargsc  st|}fdd|jjD}tdi|d|i}|jjdi|}|} |r4|jj| |j|d} n|jj| |d} |j | } | S)a Given input, decided what to do. Args: intermediate_steps: Steps the LLM has taken to date, along with observations. callbacks: Callbacks to use. Defaults to None. with_functions: Whether to use functions. Defaults to True. **kwargs: User inputs. Returns: Action specifying what tool to use. If the agent is finished, returns an AgentFinish. If the agent is not finished, returns an AgentAction. ci|] }|dkr||qSr7r*r-krBr*r/ tz-OpenAIFunctionsAgent.plan..r7r>r@)r@Nr*) rr&r8r= format_prompt to_messagesr$Zpredict_messagesr>r'_parse_ai_message) r3r?r@rArBr7selected_inputs full_inputsr&messagespredicted_messageagent_decisionr*rGr/plan^s&  zOpenAIFunctionsAgent.planc szt|}fdd|jjD}tdi|d|i}|jjdi|}|}|jj||j|dIdH} |j | } | S)aAsync given input, decided what to do. Args: intermediate_steps: Steps the LLM has taken to date, along with observations. callbacks: Callbacks to use. Defaults to None. **kwargs: User inputs. Returns: Action specifying what tool to use. If the agent is finished, returns an AgentFinish. If the agent is not finished, returns an AgentAction. crCrDr*rErGr*r/rHrIz.OpenAIFunctionsAgent.aplan..r7rJNr*) rr&r8r=rKrLr$Zapredict_messagesr>r'rM) r3r?r@rBr7rNrOr&rPrQrRr*rGr/aplans  zOpenAIFunctionsAgent.aplanearly_stopping_methodcKs^|dkr tddidS|dkr(|j|fddi|}t|tr!|Std|td |) aReturn response when agent has been stopped due to max iterations. Args: early_stopping_method: The early stopping method to use. intermediate_steps: Intermediate steps. **kwargs: User inputs. Returns: AgentFinish. Raises: ValueError: If `early_stopping_method` is not `force` or `generate`. ValueError: If `agent_decision` is not an AgentAction. forceoutputz3Agent stopped due to iteration limit or time limit.generaterAFz,got AgentAction with no functions provided: zBearly_stopping_method should be one of `force` or `generate`, got )r rS isinstancer9)r3rUr?rBrRr*r*r/return_stopped_responses, z,OpenAIFunctionsAgent.return_stopped_responsezYou are a helpful AI assistant.)contentsystem_messageextra_prompt_messagescCsD|pg}|r |g}ng}|g|tdtddt|dS)aCreate prompt for this agent. Args: system_message: Message to use as the system message that will be the first in the prompt. extra_prompt_messages: Prompt messages that will be placed between the system message and the new human input. Returns: A prompt template to pass into this agent. z{input}r7)Z variable_name)rP)extendrZ from_templaterr)clsr]r^Z_promptsrPr*r*r/ create_prompts z"OpenAIFunctionsAgent.create_promptcallback_managercKs&|j||d}|d||||d|S)aConstruct an agent from an LLM and tools. Args: llm: The LLM to use as the agent. tools: The tools to use. callback_manager: The callback manager to use. Defaults to None. extra_prompt_messages: Extra prompt messages to use. Defaults to None. system_message: The system message to use. Defaults to a default system message. kwargs: Additional parameters to pass to the agent. )r^r])r$r&r%rbNr*)ra)r`r$r%rbr^r]rBr&r*r*r/from_llm_and_toolssz'OpenAIFunctionsAgent.from_llm_and_tools)NT)N))__name__ __module__ __qualname____doc__r__annotations__rrrr r'rrstrr4rrr:propertyr<r=r>rr r boolrrr rSrTr[ classmethodrrrrrar rrcr*r*r*r/r##s    -    *  "   r#r$r%r&r(cCs^d|jt|jvrtd|jd|jdd|Dd}tjddd |B|BtB}|S) a Create an agent that uses OpenAI function calling. Args: llm: LLM to use as the agent. Should work with OpenAI function calling, so either be an OpenAI model that supports that or a wrapper of a different model that adds in equivalent support. tools: Tools this agent has access to. prompt: The prompt to use. See Prompt section below for more. Returns: A Runnable sequence representing an agent. It takes as input all the same input variables as the prompt passed in does. It returns as output either an AgentAction or AgentFinish. Raises: ValueError: If `agent_scratchpad` is not in the prompt. Example: Creating an agent with no memory .. code-block:: python from langchain_community.chat_models import ChatOpenAI from langchain.agents import AgentExecutor, create_openai_functions_agent from langchain import hub prompt = hub.pull("hwchase17/openai-functions-agent") model = ChatOpenAI() tools = ... agent = create_openai_functions_agent(model, tools, prompt) agent_executor = AgentExecutor(agent=agent, tools=tools) agent_executor.invoke({"input": "hi"}) # Using with chat history from langchain_core.messages import AIMessage, HumanMessage agent_executor.invoke( { "input": "what's my name?", "chat_history": [ HumanMessage(content="hi! my name is bob"), AIMessage(content="Hello Bob! How can I assist you today?"), ], } ) Prompt: The agent prompt must have an `agent_scratchpad` key that is a ``MessagesPlaceholder``. Intermediate agent actions and tool output messages will be passed in here. Here's an example: .. code-block:: python from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder prompt = ChatPromptTemplate.from_messages( [ ("system", "You are a helpful assistant"), MessagesPlaceholder("chat_history", optional=True), ("human", "{input}"), MessagesPlaceholder("agent_scratchpad"), ] ) r7zLPrompt must have input variable `agent_scratchpad`, but wasn't found. Found z instead.cSsg|]}t|qSr*rr,r*r*r/r0hsz1create_openai_functions_agent..)r>cSs t|dS)Nr?r)xr*r*r/ksz/create_openai_functions_agent..rD)r8listZpartial_variablesr9bindrZassignr )r$r%r&Zllm_with_toolsZagentr*r*r/r!s(H N)0rgtypingrrrrrrrZlangchain_core._apir Zlangchain_core.agentsr r Zlangchain_core.callbacksr r Zlangchain_core.language_modelsrZlangchain_core.messagesrrZlangchain_core.promptsrZlangchain_core.prompts.chatrrrrZlangchain_core.runnablesrrZlangchain_core.toolsrZ%langchain_core.utils.function_callingrZpydanticrZtyping_extensionsrZlangchain.agentsrZ3langchain.agents.format_scratchpad.openai_functionsrZ0langchain.agents.output_parsers.openai_functionsr r#r!r*r*r*r/s:$           v