import type { StructuredToolInterface } from "@langchain/core/tools"; import type { BaseChatModel, BaseChatModelCallOptions } from "@langchain/core/language_models/chat_models"; import { ChatPromptTemplate } from "@langchain/core/prompts"; import { OpenAIClient } from "@langchain/openai"; import { ToolDefinition } from "@langchain/core/language_models/base"; import { OpenAIToolsAgentOutputParser, type ToolsAgentStep } from "./output_parser.js"; import { AgentRunnableSequence } from "../agent.js"; export { OpenAIToolsAgentOutputParser, type ToolsAgentStep }; /** * Params used by the createOpenAIToolsAgent function. */ export type CreateOpenAIToolsAgentParams = { /** * LLM to use as the agent. Should work with OpenAI tool calling, * so must either be an OpenAI model that supports that or a wrapper of * a different model that adds in equivalent support. */ llm: BaseChatModel; /** Tools this agent has access to. */ tools: StructuredToolInterface[] | ToolDefinition[]; /** The prompt to use, must have an input key of `agent_scratchpad`. */ prompt: ChatPromptTemplate; /** * Whether to invoke the underlying model in streaming mode, * allowing streaming of intermediate steps. Defaults to true. */ streamRunnable?: boolean; }; /** * Create an agent that uses OpenAI-style tool calling. * @param params Params required to create the agent. Includes an LLM, tools, and prompt. * @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. * * @example * ```typescript * import { AgentExecutor, createOpenAIToolsAgent } from "langchain/agents"; * import { pull } from "langchain/hub"; * import type { ChatPromptTemplate } from "@langchain/core/prompts"; * import { AIMessage, HumanMessage } from "@langchain/core/messages"; * * import { ChatOpenAI } from "@langchain/openai"; * * // Define the tools the agent will have access to. * const tools = [...]; * * // Get the prompt to use - you can modify this! * // If you want to see the prompt in full, you can at: * // https://smith.langchain.com/hub/hwchase17/openai-tools-agent * const prompt = await pull( * "hwchase17/openai-tools-agent" * ); * * const llm = new ChatOpenAI({ * temperature: 0, * modelName: "gpt-3.5-turbo-1106", * }); * * const agent = await createOpenAIToolsAgent({ * llm, * tools, * prompt, * }); * * const agentExecutor = new AgentExecutor({ * agent, * tools, * }); * * const result = await agentExecutor.invoke({ * input: "what is LangChain?", * }); * * // With chat history * const result2 = await agentExecutor.invoke({ * input: "what's my name?", * chat_history: [ * new HumanMessage("hi! my name is cob"), * new AIMessage("Hello Cob! How can I assist you today?"), * ], * }); * ``` */ export declare function createOpenAIToolsAgent({ llm, tools, prompt, streamRunnable, }: CreateOpenAIToolsAgentParams): Promise>;