langchain.js
    Preparing search index...

    Class AnalyzeDocumentChain

    Chain that combines documents by stuffing into context.

    const model = new ChatOpenAI({ model: "gpt-4o-mini", temperature: 0 });
    const combineDocsChain = loadSummarizationChain(model);
    const chain = new AnalyzeDocumentChain({
      combineDocumentsChain: combineDocsChain,
    });

    // Read the text from a file (this is a placeholder for actual file reading)
    const text = readTextFromFile("state_of_the_union.txt");

    // Invoke the chain to analyze the document
    const res = await chain.call({
      input_document: text,
    });

    console.log({ res });

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    combineDocumentsChain inputKey memory? textSplitter

    Accessors

    inputKeys lc_namespace outputKeys

    Methods

    _chainType _formatValues apply call invoke prepOutputs run serialize deserialize lc_name

    Constructors

    Properties

    combineDocumentsChain: BaseChain
    inputKey: string = "input_document"
    memory?: any
    textSplitter: TextSplitter

    Accessors

    • get inputKeys(): string[]

      Returns string[]

    • get lc_namespace(): string[]

      Returns string[]

    • get outputKeys(): string[]

      Returns string[]

    Methods

    _chainType

    • _chainType(): "analyze_document_chain"

      Return the string type key uniquely identifying this class of chain.

      Returns "analyze_document_chain"

    Protected_formatValues

    • _formatValues(values: any): Promise<any>

      Parameters

      • values: any

      Returns Promise<any>

    • Parameters

      • inputs: ChainValues[]
      • Optionalconfig: any[]

      Returns Promise<ChainValues[]>

      Use .batch() instead. Will be removed in 0.2.0.

      Call the chain on all inputs in the list

    • Parameters

      • values: any
      • Optionalconfig: any
      • Optionaltags: string[]

      Returns Promise<ChainValues>

      Use .invoke() instead. Will be removed in 0.2.0.

      Run the core logic of this chain and add to output if desired.

      Wraps _call and handles memory.

    • Invoke the chain with the provided input and returns the output.

      Parameters

      • input: ChainValues

        Input values for the chain run.

      • Optionaloptions: any

      Returns Promise<ChainValues>

      Promise that resolves with the output of the chain run.

    • Parameters

      • inputs: Record<string, unknown>
      • outputs: Record<string, unknown>
      • returnOnlyOutputs: boolean = false

      Returns Promise<Record<string, unknown>>

    • Parameters

      • input: any
      • Optionalconfig: any

      Returns Promise<string>

      Use .invoke() instead. Will be removed in 0.2.0.

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods