Specific implementation of the BaseOutputParser class designed to parse the output text into a Plan object.

Hierarchy

Constructors

Methods

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

    A promise of the parsed output.

  • Parses the output text into a Plan object. The steps are extracted by splitting the text on newline followed by a number and a period, indicating the start of a new step. The <END_OF_PLAN> tag is then removed from each step.

    Parameters

    • text: string

      The output text to be parsed.

    Returns Promise<Plan>

    A Plan object consisting of a series of steps.

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

Generated using TypeDoc