Class: AnalyzeDocumentChain

chains.AnalyzeDocumentChain

Chain that combines documents by stuffing into context.

Hierarchy

• BaseChain

  ↳ AnalyzeDocumentChain

Implements

• AnalyzeDocumentChainInput

Constructors

constructor

• new AnalyzeDocumentChain(fields)

Parameters

Name	Type
fields	Object
fields.combineDocumentsChain	BaseChain
fields.inputKey?	string
fields.outputKey?	string
fields.textSplitter?	TextSplitter

Overrides

BaseChain.constructor

Defined in

langchain/src/chains/analyze_documents_chain.ts:34

Properties

callbackManager

• callbackManager: CallbackManager

Inherited from

BaseChain.callbackManager

Defined in

langchain/src/chains/base.ts:25

---

combineDocumentsChain

• combineDocumentsChain: BaseChain

Implementation of

AnalyzeDocumentChainInput.combineDocumentsChain

Defined in

langchain/src/chains/analyze_documents_chain.ts:30

---

inputKey

• inputKey: string = "input_document"

Defined in

langchain/src/chains/analyze_documents_chain.ts:26

---

memory

• Optional memory: BaseMemory

Inherited from

BaseChain.memory

Defined in

langchain/src/chains/base.ts:21

---

outputKey

• outputKey: string = "output_text"

Defined in

langchain/src/chains/analyze_documents_chain.ts:28

---

textSplitter

• textSplitter: TextSplitter

Implementation of

AnalyzeDocumentChainInput.textSplitter

Defined in

langchain/src/chains/analyze_documents_chain.ts:32

---

verbose

• verbose: boolean

Inherited from

BaseChain.verbose

Defined in

langchain/src/chains/base.ts:23

Accessors

inputKeys

• get inputKeys(): string[]

Returns

string[]

Overrides

BaseChain.inputKeys

Defined in

langchain/src/chains/analyze_documents_chain.ts:48

Methods

_call

▸ _call(values): Promise<ChainValues>

Run the core logic of this chain and return the output

Parameters

Name	Type
values	ChainValues

Returns

Promise<ChainValues>

Overrides

BaseChain._call

Defined in

langchain/src/chains/analyze_documents_chain.ts:52

---

_chainType

▸ _chainType(): "analyze_document_chain"

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

Returns

"analyze_document_chain"

Overrides

BaseChain._chainType

Defined in

langchain/src/chains/analyze_documents_chain.ts:66

---

apply

▸ apply(inputs): Promise<ChainValues>

Call the chain on all inputs in the list

Parameters

Name	Type
inputs	ChainValues[]

Returns

Promise<ChainValues>

Inherited from

BaseChain.apply

Defined in

langchain/src/chains/base.ts:109

---

call

▸ call(values): Promise<ChainValues>

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

Wraps _call and handles memory.

Parameters

Name	Type
values	ChainValues

Returns

Promise<ChainValues>

Inherited from

BaseChain.call

Defined in

langchain/src/chains/base.ts:79

---

run

▸ run(input): Promise<string>

Parameters

Name	Type
input	any

Returns

Promise<string>

Inherited from

BaseChain.run

Defined in

langchain/src/chains/base.ts:55

---

serialize

▸ serialize(): SerializedAnalyzeDocumentChain

Return a json-like object representing this chain.

Returns

SerializedAnalyzeDocumentChain

Overrides

BaseChain.serialize

Defined in

langchain/src/chains/analyze_documents_chain.ts:95

---

deserialize

▸ Static deserialize(data, values): Promise<AnalyzeDocumentChain>

Load a chain from a json-like object describing it.

Parameters

Name	Type
data	SerializedAnalyzeDocumentChain
values	LoadValues

Returns

Promise<AnalyzeDocumentChain>

Overrides

BaseChain.deserialize

Defined in

langchain/src/chains/analyze_documents_chain.ts:70