Class PlanOutputParser

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

Hierarchy

  • BaseOutputParser<Plan>
    • PlanOutputParser

Constructors

constructor

Methods

getFormatInstructions parse

Constructors

constructor

  • new PlanOutputParser(kwargs?, ..._args): PlanOutputParser

  • Parameters

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

    Returns PlanOutputParser

Methods

getFormatInstructions

  • getFormatInstructions(): string

  • Returns a string that represents the format instructions for the plan. This is defined by the PLANNER_SYSTEM_PROMPT_MESSAGE_TEMPLATE constant.

    Returns string

    A string representing the format instructions for the plan.

parse

  • parse(text): Promise<Plan>

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc