45 lines
1.6 KiB
TypeScript
45 lines
1.6 KiB
TypeScript
|
import { BaseOutputParser } from "@langchain/core/output_parsers";
|
||
|
|
import type { SerializedFields } from "../load/map_keys.js";
|
||
|
|
export interface RegExpFields {
|
||
|
|
pattern: string;
|
||
|
|
flags?: string;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Interface for the fields required to create a RegexParser instance.
|
||
|
|
*/
|
||
|
|
export interface RegexParserFields {
|
||
|
|
regex: string | RegExp | RegExpFields;
|
||
|
|
outputKeys: string[];
|
||
|
|
defaultOutputKey?: string;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Class to parse the output of an LLM call into a dictionary.
|
||
|
|
* @augments BaseOutputParser
|
||
|
|
*/
|
||
|
|
export declare class RegexParser extends BaseOutputParser<Record<string, string>> {
|
||
|
|
static lc_name(): string;
|
||
|
|
lc_namespace: string[];
|
||
|
|
lc_serializable: boolean;
|
||
|
|
get lc_attributes(): SerializedFields | undefined;
|
||
|
|
regex: string | RegExp;
|
||
|
|
outputKeys: string[];
|
||
|
|
defaultOutputKey?: string;
|
||
|
|
constructor(fields: RegexParserFields);
|
||
|
|
constructor(regex: string | RegExp, outputKeys: string[], defaultOutputKey?: string);
|
||
|
|
_type(): string;
|
||
|
|
/**
|
||
|
|
* Parses the given text using the regex pattern and returns a dictionary
|
||
|
|
* with the parsed output. If the regex pattern does not match the text
|
||
|
|
* and no defaultOutputKey is provided, throws an OutputParserException.
|
||
|
|
* @param text The text to be parsed.
|
||
|
|
* @returns A dictionary with the parsed output.
|
||
|
|
*/
|
||
|
|
parse(text: string): Promise<Record<string, string>>;
|
||
|
|
/**
|
||
|
|
* Returns a string with instructions on how the LLM output should be
|
||
|
|
* formatted to match the regex pattern.
|
||
|
|
* @returns A string with formatting instructions.
|
||
|
|
*/
|
||
|
|
getFormatInstructions(): string;
|
||
|
|
}
|