59 lines
1.8 KiB
TypeScript
59 lines
1.8 KiB
TypeScript
|
import { AgentAction, AgentFinish } from "@langchain/core/agents";
|
||
|
|
import { BaseMessage } from "@langchain/core/messages";
|
||
|
|
import { ChatGeneration } from "@langchain/core/outputs";
|
||
|
|
import { AgentActionOutputParser } from "../types.js";
|
||
|
|
/**
|
||
|
|
* Type that represents an agent action with an optional message log.
|
||
|
|
*/
|
||
|
|
export type FunctionsAgentAction = AgentAction & {
|
||
|
|
messageLog?: BaseMessage[];
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* @example
|
||
|
|
* ```typescript
|
||
|
|
*
|
||
|
|
* const prompt = ChatPromptTemplate.fromMessages([
|
||
|
|
* ["ai", "You are a helpful assistant"],
|
||
|
|
* ["human", "{input}"],
|
||
|
|
* new MessagesPlaceholder("agent_scratchpad"),
|
||
|
|
* ]);
|
||
|
|
*
|
||
|
|
* const modelWithFunctions = new ChatOpenAI({
|
||
|
|
* modelName: "gpt-4",
|
||
|
|
* temperature: 0,
|
||
|
|
* }).bind({
|
||
|
|
* functions: tools.map((tool) => convertToOpenAIFunction(tool)),
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* const runnableAgent = RunnableSequence.from([
|
||
|
|
* {
|
||
|
|
* input: (i) => i.input,
|
||
|
|
* agent_scratchpad: (i) => formatAgentSteps(i.steps),
|
||
|
|
* },
|
||
|
|
* prompt,
|
||
|
|
* modelWithFunctions,
|
||
|
|
* new OpenAIFunctionsAgentOutputParser(),
|
||
|
|
* ]);
|
||
|
|
*
|
||
|
|
* const result = await runnableAgent.invoke({
|
||
|
|
* input: "What is the weather in New York?",
|
||
|
|
* steps: agentSteps,
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
export declare class OpenAIFunctionsAgentOutputParser extends AgentActionOutputParser {
|
||
|
|
lc_namespace: string[];
|
||
|
|
static lc_name(): string;
|
||
|
|
parse(text: string): Promise<AgentAction | AgentFinish>;
|
||
|
|
parseResult(generations: ChatGeneration[]): Promise<AgentFinish | FunctionsAgentAction>;
|
||
|
|
/**
|
||
|
|
* Parses the output message into a FunctionsAgentAction or AgentFinish
|
||
|
|
* object.
|
||
|
|
* @param message The BaseMessage to parse.
|
||
|
|
* @returns A FunctionsAgentAction or AgentFinish object.
|
||
|
|
*/
|
||
|
|
parseAIMessage(message: BaseMessage): FunctionsAgentAction | AgentFinish;
|
||
|
|
getFormatInstructions(): string;
|
||
|
|
}
|