agsamantha/node_modules/langchain/dist/output_parsers/router.d.ts
2024-10-02 15:15:21 -05:00

30 lines
1.3 KiB
TypeScript

import { z } from "zod";
import { JsonMarkdownStructuredOutputParser } from "./structured.js";
/**
* Defines the input parameters for the RouterOutputParser class. It can
* include a default destination and an interpolation depth.
*/
export type RouterOutputParserInput = {
defaultDestination?: string;
interpolationDepth?: number;
};
/**
* 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.
*/
export declare class RouterOutputParser<Y extends z.ZodTypeAny> extends JsonMarkdownStructuredOutputParser<Y> {
defaultDestination: string;
constructor(schema: Y, options?: RouterOutputParserInput);
/**
* 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.
* @param text The text to be parsed.
* @returns The parsed text as a Promise.
*/
parse(text: string): Promise<z.infer<Y>>;
}