Class OpenAIToolsAgentOutputParser

Example


const prompt = ChatPromptTemplate.fromMessages([
  ["ai", "You are a helpful assistant"],
  ["human", "{input}"],
  new MessagesPlaceholder("agent_scratchpad"),
]);

const runnableAgent = RunnableSequence.from([
  {
    input: (i: { input: string; steps: ToolsAgentStep[] }) => i.input,
    agent_scratchpad: (i: { input: string; steps: ToolsAgentStep[] }) =>
      formatToOpenAIToolMessages(i.steps),
  },
  prompt,
  new ChatOpenAI({
    modelName: "gpt-3.5-turbo-1106",
    temperature: 0,
  }).bind({ tools: tools.map(convertToOpenAITool) }),
  new OpenAIToolsAgentOutputParser(),
]).withConfig({ runName: "OpenAIToolsAgent" });

const result = await runnableAgent.invoke({
  input:
    "What is the sum of the current temperature in San Francisco, New York, and Tokyo?",
});

Hierarchy

  • AgentMultiActionOutputParser
    • OpenAIToolsAgentOutputParser

Constructors

constructor

Properties

name?

Methods

assign batch bind getFormatInstructions getName invoke map parse parseAIMessage parseResult parseResultWithPrompt parseWithPrompt pick pipe stream streamLog toJSON toJSONNotImplemented transform withConfig withFallbacks withListeners withRetry isRunnable

Constructors

constructor

  • Parameters

    • Optional kwargs: SerializedFields
    • Rest ..._args: never[]

    Returns OpenAIToolsAgentOutputParser

Properties

Optional name

name?: string

Methods

assign

  • Assigns new fields to the dict output of this runnable. Returns a new runnable.

    Parameters

    • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

    Returns Runnable<any, any, RunnableConfig>

batch

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: (string | BaseMessage)[]

      Array of inputs to each batch call.

    • Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<(AgentAction[] | AgentFinish)[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(Error | AgentAction[] | AgentFinish)[]>

  • Parameters

    Returns Promise<(Error | AgentAction[] | AgentFinish)[]>

bind

getFormatInstructions

getName

  • Parameters

    • Optional suffix: string

    Returns string

invoke

  • 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: RunnableConfig

      Optional configuration options.

    Returns Promise<AgentAction[] | AgentFinish>

    A promise of the parsed output.

map

parse

parseAIMessage

parseResult

parseResultWithPrompt

  • Parses the result of an LLM call with a given prompt. By default, it simply calls parseResult.

    Parameters

    • generations: Generation[] | ChatGeneration[]

      The generations from an LLM call.

    • _prompt: BasePromptValueInterface

      The prompt used in the LLM call.

    • Optional callbacks: Callbacks

      Optional callbacks.

    Returns Promise<AgentAction[] | AgentFinish>

    A promise of the parsed output.

parseWithPrompt

  • Parameters

    • text: string
    • _prompt: BasePromptValueInterface
    • Optional callbacks: Callbacks

    Returns Promise<AgentAction[] | AgentFinish>

pick

  • Pick keys from the dict output of this runnable. Returns a new runnable.

    Parameters

    • keys: string | string[]

    Returns Runnable<any, any, RunnableConfig>

pipe

  • 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 Runnable<string | BaseMessage, Exclude<NewRunOutput, Error>, RunnableConfig>

    A new runnable sequence.

stream

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<AgentAction[] | AgentFinish>>

    A readable stream that is also an iterable.

streamLog

  • 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<RunnableConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

toJSON

  • Returns Serialized

toJSONNotImplemented

transform

  • 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>

withConfig

withFallbacks

withListeners

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<string | BaseMessage, AgentAction[] | AgentFinish, RunnableConfig>

withRetry

Static isRunnable

  • Parameters

    • thing: any

    Returns thing is Runnable<any, any, RunnableConfig>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc