langchain.agents.openai_functions_agent.base.OpenAIFunctionsAgent

类 langchain.agents.openai_functions_agent.base.OpenAIFunctionsAgent[来源]

继承： BaseSingleActionAgent

自版本 0.1.0 起弃用：请使用 create_openai_functions_agent。

由 OpenAIs 函数驱动 API 的 Agent。

参数

  • llm – 这应该是 ChatOpenAI 的实例，特别是支持使用 函数 的模型。

  • tools – 此 Agent 可访问的工具。

  • prompt – 此 Agent 的提示，应支持 agent_scratchpad 作为变量之一。为轻松构建此提示，请使用 OpenAIFunctionsAgent.create_prompt(…)。

  • output_parser – 此 Agent 的输出解析器。应该是 OpenAIFunctionsAgentOutputParser 的实例。默认为 OpenAIFunctionsAgentOutputParser。

通过解析和验证从关键字参数输入的数据来创建新的模型。

如果输入数据无法解析成有效的模型，则会引发 ValidationError。

参数 llm: BaseLanguageModel [必选]
参数 output_parser: Type[OpenAIFunctionsAgentOutputParser] = <class 'langchain.agents.output_parsers.openai_functions.OpenAIFunctionsAgentOutputParser'>
参数 prompt: BasePromptTemplate [必选]
参数 tools: Sequence[BaseTool] [必选]
async aplan(intermediate_steps: List[Tuple[AgentAction, str]], callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]] = None, **kwargs: Any) → Union[AgentAction, AgentFinish][source]

Async给定输入，决定要做什么。

参数

  • intermediate_steps (列表[[元组[AgentAction, str]]) – LLM至今已采取的动作步骤及其观察。

  • callbacks (可选[[联合[[列表[[BaseCallbackHandler]], BaseCallbackManager]]]) – 要使用的回调。默认为None。

  • **kwargs (任何) – 用户输入。

返回

指定使用什么工具的动作。如果代理完成，返回一个AgentFinish。如果代理没完成，返回一个AgentAction。

返回类型

联合[[AgentAction, AgentFinish]

类方法 create_prompt(system_message: Optional[SystemMessage] = SystemMessage(content='您是一个友好的AI助手。'), extra_prompt_messages: Optional[列表[BaseMessagePromptTemplate]] = None) → ChatPromptTemplate[源代码]

为该智能体创建提示。

参数

  • system_message (可选[SystemMessage]) – 作为提示中第一行的系统消息使用的消息。

  • extra_prompt_messages (可选[列表[BaseMessagePromptTemplate]]) – 放置在系统消息和新的用户输入之间的提示消息。

返回

传递给该智能体的提示模板。

返回类型

ChatPromptTemplate

classmethod from_llm_and_tools(llm: BaseLanguageModel, tools: Sequence[BaseTool], callback_manager: Optional[BaseCallbackManager] = None extra_prompt_messages: Optional[List[BaseMessagePromptTemplate] = None system_message: Optional[SystemMessage] = SystemMessage(content='You are a helpful AI assistant.'), **kwargs: Any) → BaseSingleActionAgent[source]

从LLM和工具中构建智能体。

参数

  • llm (BaseLanguageModel) – 要用作智能体的LLM。

  • tools (Sequence[BaseTool]) – 要使用的工具。

  • callback_manager (Optional[BaseCallbackManager]) – 要使用的回调管理器。默认为None。

  • extra_prompt_messages (Optional[List[BaseMessagePromptTemplate]]) – 要使用的额外提示消息。默认为None。

  • 系统消息 (可选[SystemMessage]) – 要使用的系统消息。默认为默认系统消息。

  • kwargs (任何) – 传递给代理的附加参数。

返回类型

BaseSingleActionAgent

get_allowed_tools() → List[str][source]

获取允许的工具。

返回类型

字符串列表

plan(intermediate_steps: List[Tuple[AgentAction, str]], callbacks: Optional[Union[List[BaseCallbackHandler], BaseCallbackManager]], with_functions: bool = True, **kwargs: Any) → Union[AgentAction, AgentFinish][source]

给定输入，决定要做什么。

参数

  • intermediate_steps (列表[[元组[AgentAction, str]]) – LLM至今已采取的动作步骤及其观察。

  • callbacks (可选[[联合[[列表[[BaseCallbackHandler]], BaseCallbackManager]]]) – 要使用的回调。默认为None。

  • with_functions (布尔值) – 是否使用函数。默认为 True。

  • **kwargs (任何) – 用户输入。

返回

指定使用什么工具的动作。如果代理完成，返回一个AgentFinish。如果代理没完成，返回一个AgentAction。

返回类型

联合[[AgentAction, AgentFinish]

return_stopped_response(early_stopping_method: str, intermediate_steps: List[Tuple[AgentAction, str]], **kwargs: Any) → AgentFinish[source]

当智能体由于最大迭代次数而被停止时返回响应。

参数

  • early_stopping_method (str) – 要使用的早期停止方法。

  • intermediate_steps (List[Tuple[AgentAction, str]]) – 中间步骤。

  • **kwargs (任何) – 用户输入。

返回

AgentFinish。

抛出

  • ValueError – 如果 early_stopping_method 不是 force 或 generate。

  • ValueError – 如果 agent_decision 不是一个 AgentAction。

返回类型

AgentFinish

save(file_path: Union[Path, str]) → None

保存智能体。

参数

file_path (Union[Path, str]) – 保存智能体的文件路径。

返回类型

None

示例: .. code-block:: python

如果使用智能体执行器: agent.agent.save(file_path="path/agent.yaml")

tool_run_logging_kwargs() → Dict

返回工具运行的日志参数。

返回类型

Dict

property functions: List[dict]

获取函数。

property input_keys: List[str]

获取输入键。在这里，输入指的是用户输入。

属性 return_values: 列表[字符串]

代理的返回值。

使用 OpenAIFunctionsAgent 的示例