agsamantha/node_modules/langchain/dist/chains/combine_docs_chain.d.ts

import { Document } from "@langchain/core/documents";
import { ChainValues } from "@langchain/core/utils/types";
import { CallbackManagerForChainRun } from "@langchain/core/callbacks/manager";
import { BasePromptTemplate } from "@langchain/core/prompts";
import type { SerializedStuffDocumentsChain, SerializedMapReduceDocumentsChain, SerializedRefineDocumentsChain } from "./serde.js";
import { BaseChain, ChainInputs } from "./base.js";
import { LLMChain } from "./llm_chain.js";
/**
 * Interface for the input properties of the StuffDocumentsChain class.
 */
export interface StuffDocumentsChainInput extends ChainInputs {
    /** LLM Wrapper to use after formatting documents */
    llmChain: LLMChain;
    inputKey?: string;
    /** Variable name in the LLM chain to put the documents in */
    documentVariableName?: string;
}
/**
 * Chain that combines documents by stuffing into context.
 * @augments BaseChain
 * @augments StuffDocumentsChainInput
 */
export declare class StuffDocumentsChain extends BaseChain implements StuffDocumentsChainInput {
    static lc_name(): string;
    llmChain: LLMChain;
    inputKey: string;
    documentVariableName: string;
    get inputKeys(): string[];
    get outputKeys(): string[];
    constructor(fields: StuffDocumentsChainInput);
    /** @ignore */
    _prepInputs(values: ChainValues): ChainValues;
    /** @ignore */
    _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
    _chainType(): "stuff_documents_chain";
    static deserialize(data: SerializedStuffDocumentsChain): Promise<StuffDocumentsChain>;
    serialize(): SerializedStuffDocumentsChain;
}
/**
 * Interface for the input properties of the MapReduceDocumentsChain
 * class.
 */
export interface MapReduceDocumentsChainInput extends StuffDocumentsChainInput {
    /** The maximum number of tokens before requiring to do the reduction */
    maxTokens?: number;
    /** The maximum number of iterations to run through the map */
    maxIterations?: number;
    /** Ensures that the map step is taken regardless of max tokens */
    ensureMapStep?: boolean;
    /** Chain to use to combine results of applying llm_chain to documents. */
    combineDocumentChain: StuffDocumentsChain;
    /** Return the results of the map steps in the output. */
    returnIntermediateSteps?: boolean;
}
/**
 * Combine documents by mapping a chain over them, then combining results.
 * @augments BaseChain
 * @augments StuffDocumentsChainInput
 */
export declare class MapReduceDocumentsChain extends BaseChain implements MapReduceDocumentsChainInput {
    static lc_name(): string;
    llmChain: LLMChain;
    inputKey: string;
    documentVariableName: string;
    returnIntermediateSteps: boolean;
    get inputKeys(): string[];
    get outputKeys(): string[];
    maxTokens: number;
    maxIterations: number;
    ensureMapStep: boolean;
    combineDocumentChain: StuffDocumentsChain;
    constructor(fields: MapReduceDocumentsChainInput);
    /** @ignore */
    _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
    _chainType(): "map_reduce_documents_chain";
    static deserialize(data: SerializedMapReduceDocumentsChain): Promise<MapReduceDocumentsChain>;
    serialize(): SerializedMapReduceDocumentsChain;
}
/**
 * Interface for the input properties of the RefineDocumentsChain class.
 */
export interface RefineDocumentsChainInput extends StuffDocumentsChainInput {
    refineLLMChain: LLMChain;
    documentPrompt?: BasePromptTemplate;
    initialResponseName?: string;
    documentVariableName?: string;
    outputKey?: string;
}
/**
 * Combine documents by doing a first pass and then refining on more documents.
 * @augments BaseChain
 * @augments RefineDocumentsChainInput
 */
export declare class RefineDocumentsChain extends BaseChain implements RefineDocumentsChainInput {
    static lc_name(): string;
    llmChain: LLMChain;
    inputKey: string;
    outputKey: string;
    documentVariableName: string;
    initialResponseName: string;
    refineLLMChain: LLMChain;
    get defaultDocumentPrompt(): BasePromptTemplate;
    documentPrompt: BasePromptTemplate<any, import("@langchain/core/prompt_values").BasePromptValueInterface, any>;
    get inputKeys(): string[];
    get outputKeys(): string[];
    constructor(fields: RefineDocumentsChainInput);
    /** @ignore */
    _constructInitialInputs(doc: Document, rest: Record<string, unknown>): Promise<{
        [x: string]: unknown;
    }>;
    /** @ignore */
    _constructRefineInputs(doc: Document, res: string): Promise<{
        [x: string]: unknown;
    }>;
    /** @ignore */
    _call(values: ChainValues, runManager?: CallbackManagerForChainRun): Promise<ChainValues>;
    _chainType(): "refine_documents_chain";
    static deserialize(data: SerializedRefineDocumentsChain): Promise<RefineDocumentsChain>;
    serialize(): SerializedRefineDocumentsChain;
}