Class AnalyzeDocumentChain

Chain that combines documents by stuffing into context.

Example

const model = new ChatOpenAI({ 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

Implements

Constructors

constructor

Properties

combineDocumentsChain inputKey textSplitter memory?

Accessors

inputKeys outputKeys

Methods

apply call invoke prepOutputs run serialize deserialize

Constructors

constructor

Properties

combineDocumentsChain

combineDocumentsChain: BaseChain<ChainValues, ChainValues>

inputKey

inputKey: string = "input_document"

textSplitter

textSplitter: TextSplitter

Optional memory

memory?: any

Accessors

inputKeys

outputKeys

Methods

apply

  • Parameters

    • inputs: ChainValues[]
    • Optional config: any[]

    Returns Promise<ChainValues[]>

    ⚠️ Deprecated ⚠️

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

    This feature is deprecated and will be removed in the future.

    It is not recommended for use.

    Call the chain on all inputs in the list

call

  • Parameters

    • values: any
    • Optional config: any
    • Optional tags: string[]

      Deprecated

    Returns Promise<ChainValues>

    Deprecated

    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

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

    Parameters

    • input: ChainValues

      Input values for the chain run.

    • Optional config: any

      Optional configuration for the Runnable.

    Returns Promise<ChainValues>

    Promise that resolves with the output of the chain run.

prepOutputs

  • Parameters

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

    Returns Promise<Record<string, unknown>>

run

  • Parameters

    • input: any
    • Optional config: any

    Returns Promise<string>

    Deprecated

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

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc