Class RouterOutputParser<Y>

A type of output parser that extends the JsonMarkdownStructuredOutputParser. It is used to parse the output of a router in LangChain. The class takes a schema and an optional RouterOutputParserInput object as parameters.

Type Parameters

  • Y extends z.ZodTypeAny

Hierarchy

Constructors

Properties

defaultDestination: string = "DEFAULT"
schema: Y

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<TypeOf<Y>>

    A promise of the parsed output.

  • Overrides the parse method from JsonMarkdownStructuredOutputParser. This method takes a string as input, attempts to parse it, and returns the parsed text. If the destination of the parsed text matches the defaultDestination, the destination is set to null. If the parsing fails, an OutputParserException is thrown.

    Parameters

    • text: string

      The text to be parsed.

    Returns Promise<TypeOf<Y>>

    The parsed text as a Promise.

  • 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