Class ChatAgentOutputParser

A class that extends the AgentActionOutputParser to parse the output of the ChatAgent in LangChain. It checks if the output text contains the final answer action or a JSON response, and parses it accordingly.

Example

const prompt = ChatPromptTemplate.fromMessages([
[
"ai",
`{PREFIX}
{FORMAT_INSTRUCTIONS}
{SUFFIX}`,
],
["human", "Question: {input}"],
]);
const runnableAgent = RunnableSequence.from([
{
input: (i: { input: string; steps: AgentStep[] }) => i.input,
agent_scratchpad: (i: { input: string; steps: AgentStep[] }) =>
formatLogToString(i.steps),
},
prompt,
new OpenAI({ temperature: 0 }),
new ChatAgentOutputParser(),
]);

const executor = AgentExecutor.fromAgentAndTools({
agent: runnableAgent,
tools: [new SerpAPI(), new Calculator()],
});

const result = await executor.invoke({
input:
"Who is Olivia Wilde's boyfriend? What is his current age raised to the 0.23 power?",
});

Hierarchy

Constructors

Methods

  • Returns the format instructions used in the output parser for the ChatAgent class.

    Returns string

    The format instructions as a string.

  • Calls the parser with a given input and optional configuration options. If the input is a string, it creates a generation with the input as text and calls parseResult. If the input is a BaseMessage, it creates a generation with the input as a message and the content of the input as text, and then calls parseResult.

    Parameters

    • input: string | BaseMessage

      The input to the parser, which can be a string or a BaseMessage.

    • Optional options: BaseCallbackConfig

      Optional configuration options.

    Returns Promise<AgentAction | AgentFinish>

    A promise of the parsed output.

  • Parses the output text from the MRKL chain into an agent action or agent finish. If the text contains the final answer action or does not contain an action, it returns an AgentFinish with the output and log. If the text contains a JSON response, it returns the tool, toolInput, and log.

    Parameters

    • text: string

      The output text from the MRKL chain.

    Returns Promise<{
        log: string;
        returnValues: {
            output: string;
        };
        tool?: undefined;
        toolInput?: undefined;
    } | {
        log: string;
        tool: any;
        toolInput: any;
        returnValues?: undefined;
    }>

    An object that satisfies the AgentFinish interface or an object with the tool, toolInput, and log.

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    Returns RunnableSequence<string | BaseMessage, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    • input: string | BaseMessage
    • Optional options: Partial<BaseCallbackConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    Returns AsyncGenerator<AgentAction | AgentFinish, any, unknown>

Generated using TypeDoc