Class StuffDocumentsChain

Chain that combines documents by stuffing into context.

Hierarchy (View Summary)

BaseChain
- StuffDocumentsChain

Implements

StuffDocumentsChainInput

Index

Constructors

constructor

new StuffDocumentsChain(fields: StuffDocumentsChainInput): StuffDocumentsChain
Parameters
- fields: StuffDocumentsChainInput
Returns StuffDocumentsChain
Overrides BaseChain.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/combine_docs_chain.ts:53

Properties

documentVariableName

documentVariableName: string = "context"

Variable name in the LLM chain to put the documents in

inputKey

inputKey: string = "input_documents"

llmChain

llmChain: LLMChain

LLM Wrapper to use after formatting documents

`Optional`memory

memory?: any

Accessors

inputKeys

get inputKeys(): any[]
Returns any[]
Overrides BaseChain.inputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/combine_docs_chain.ts:43

lc_namespace

get lc_namespace(): string[]
Returns string[]
Inherited from QAEvalChain.lc_namespace
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:41

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/combine_docs_chain.ts:49

Methods

_chainType

_chainType(): "stuff_documents_chain"
Return the string type key uniquely identifying this class of chain.

Returns "stuff_documents_chain"
Overrides BaseChain._chainType
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/combine_docs_chain.ts:87

`Protected`_formatValues

_formatValues(values: any): Promise<any>
Parameters
- values: any
Returns Promise<any>
Inherited from BaseChain._formatValues
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:217

apply

apply(inputs: ChainValues[], config?: any[]): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optionalconfig: any[]
Returns Promise<ChainValues[]>
Deprecated
Use .batch() instead. Will be removed in 0.2.0.

Call the chain on all inputs in the list
Inherited from BaseChain.apply
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:258

call

call(values: any, config?: any, tags?: string[]): Promise<ChainValues>
Parameters
- values: any
- Optionalconfig: any
- Optionaltags: 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.
Inherited from BaseChain.call
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:243

invoke

invoke(input: ChainValues, options?: any): Promise<ChainValues>
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.
Inherited from BaseChain.invoke
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:86

prepOutputs

prepOutputs(
    inputs: Record<string, unknown>,
    outputs: Record<string, unknown>,
    returnOnlyOutputs?: boolean,
): Promise<Record<string, unknown>>
Parameters
- inputs: Record<string, unknown>
- outputs: Record<string, unknown>
- returnOnlyOutputs: boolean = false
Returns Promise<Record<string, unknown>>
Inherited from BaseChain.prepOutputs
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:149

run

run(input: any, config?: any): Promise<string>
Parameters
- input: any
- Optionalconfig: any
Returns Promise<string>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from BaseChain.run
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:190

serialize

serialize(): SerializedStuffDocumentsChain
Return a json-like object representing this chain.

Returns SerializedStuffDocumentsChain
Overrides BaseChain.serialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/combine_docs_chain.ts:101

`Static`deserialize

deserialize(data: SerializedStuffDocumentsChain): Promise<StuffDocumentsChain>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedStuffDocumentsChain
Returns Promise<StuffDocumentsChain>
Overrides BaseChain.deserialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/combine_docs_chain.ts:91

`Static`lc_name

lc_name(): string
Returns string
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/combine_docs_chain.ts:33

Class StuffDocumentsChain

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StuffDocumentsChain

Properties

documentVariableName

inputKey

llmChain

Optionalmemory

Accessors

inputKeys

Returns any[]

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_chainType

Returns "stuff_documents_chain"

Protected_formatValues

Parameters

Returns Promise<any>

apply

Parameters

Returns Promise<ChainValues[]>

Deprecated

call

Parameters

Deprecated

Returns Promise<ChainValues>

Deprecated

invoke

Parameters

Returns Promise<ChainValues>

prepOutputs

Parameters

Returns Promise<Record<string, unknown>>

run

Parameters

Returns Promise<string>

Deprecated

serialize

Returns SerializedStuffDocumentsChain

Staticdeserialize

Parameters

Returns Promise<StuffDocumentsChain>

Staticlc_name

Returns string

Settings

On This Page

`Optional`memory

`Protected`_formatValues

`Static`deserialize

`Static`lc_name