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?: BaseMemory

Accessors

inputKeys

  • get inputKeys(): string[]

  • Returns string[]

outputKeys

  • get outputKeys(): string[]

  • Returns string[]

Methods

apply

  • Call the chain on all inputs in the list

    Parameters

    • inputs: ChainValues[]
    • Optional config: (BaseCallbackConfig | Callbacks)[]

    Returns Promise<ChainValues[]>

call

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

    Wraps _call and handles memory.

    Parameters

    • values: ChainValues & {
          signal?: AbortSignal;
          timeout?: number;
      }
    • Optional config: BaseCallbackConfig | Callbacks
    • Optional tags: string[]

      Deprecated

    Returns Promise<ChainValues>

invoke

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

    Parameters

    • input: ChainValues

      Input values for the chain run.

    • Optional config: BaseCallbackConfig

      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: BaseCallbackConfig | Callbacks

    Returns Promise<string>

serialize

Static deserialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc