80 lines
3.3 KiB
TypeScript
80 lines
3.3 KiB
TypeScript
|
import { JsonSchema7ObjectType } from "zod-to-json-schema";
|
||
|
|
import { type Operation as JSONPatchOperation } from "@langchain/core/utils/json_patch";
|
||
|
|
import { ChatGeneration, Generation } from "@langchain/core/outputs";
|
||
|
|
import { BaseCumulativeTransformOutputParser, type BaseCumulativeTransformOutputParserInput, BaseLLMOutputParser } from "@langchain/core/output_parsers";
|
||
|
|
import { Optional } from "../types/type-utils.js";
|
||
|
|
/**
|
||
|
|
* Represents optional parameters for a function in a JSON Schema.
|
||
|
|
*/
|
||
|
|
export type FunctionParameters = Optional<JsonSchema7ObjectType, "additionalProperties">;
|
||
|
|
/**
|
||
|
|
* Class for parsing the output of an LLM. Can be configured to return
|
||
|
|
* only the arguments of the function call in the output.
|
||
|
|
*/
|
||
|
|
export declare class OutputFunctionsParser extends BaseLLMOutputParser<string> {
|
||
|
|
static lc_name(): string;
|
||
|
|
lc_namespace: string[];
|
||
|
|
lc_serializable: boolean;
|
||
|
|
argsOnly: boolean;
|
||
|
|
constructor(config?: {
|
||
|
|
argsOnly?: boolean;
|
||
|
|
});
|
||
|
|
/**
|
||
|
|
* Parses the output and returns a string representation of the function
|
||
|
|
* call or its arguments.
|
||
|
|
* @param generations The output of the LLM to parse.
|
||
|
|
* @returns A string representation of the function call or its arguments.
|
||
|
|
*/
|
||
|
|
parseResult(generations: Generation[] | ChatGeneration[]): Promise<string>;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Class for parsing the output of an LLM into a JSON object. Uses an
|
||
|
|
* instance of `OutputFunctionsParser` to parse the output.
|
||
|
|
*/
|
||
|
|
export declare class JsonOutputFunctionsParser<Output extends object = object> extends BaseCumulativeTransformOutputParser<Output> {
|
||
|
|
static lc_name(): string;
|
||
|
|
lc_namespace: string[];
|
||
|
|
lc_serializable: boolean;
|
||
|
|
outputParser: OutputFunctionsParser;
|
||
|
|
argsOnly: boolean;
|
||
|
|
constructor(config?: {
|
||
|
|
argsOnly?: boolean;
|
||
|
|
} & BaseCumulativeTransformOutputParserInput);
|
||
|
|
protected _diff(prev: unknown | undefined, next: unknown): JSONPatchOperation[] | undefined;
|
||
|
|
parsePartialResult(generations: ChatGeneration[]): Promise<Output | undefined>;
|
||
|
|
/**
|
||
|
|
* Parses the output and returns a JSON object. If `argsOnly` is true,
|
||
|
|
* only the arguments of the function call are returned.
|
||
|
|
* @param generations The output of the LLM to parse.
|
||
|
|
* @returns A JSON object representation of the function call or its arguments.
|
||
|
|
*/
|
||
|
|
parseResult(generations: Generation[] | ChatGeneration[]): Promise<Output>;
|
||
|
|
parse(text: string): Promise<Output>;
|
||
|
|
getFormatInstructions(): string;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Class for parsing the output of an LLM into a JSON object and returning
|
||
|
|
* a specific attribute. Uses an instance of `JsonOutputFunctionsParser`
|
||
|
|
* to parse the output.
|
||
|
|
*/
|
||
|
|
export declare class JsonKeyOutputFunctionsParser<T = object> extends BaseLLMOutputParser<T> {
|
||
|
|
static lc_name(): string;
|
||
|
|
lc_namespace: string[];
|
||
|
|
lc_serializable: boolean;
|
||
|
|
outputParser: JsonOutputFunctionsParser<object>;
|
||
|
|
attrName: string;
|
||
|
|
get lc_aliases(): {
|
||
|
|
attrName: string;
|
||
|
|
};
|
||
|
|
constructor(fields: {
|
||
|
|
attrName: string;
|
||
|
|
});
|
||
|
|
/**
|
||
|
|
* Parses the output and returns a specific attribute of the parsed JSON
|
||
|
|
* object.
|
||
|
|
* @param generations The output of the LLM to parse.
|
||
|
|
* @returns The value of a specific attribute of the parsed JSON object.
|
||
|
|
*/
|
||
|
|
parseResult(generations: Generation[] | ChatGeneration[]): Promise<T>;
|
||
|
|
}
|