Class RefineDocumentsChain

Combine documents by doing a first pass and then refining on more documents.

Hierarchy (View Summary)

BaseChain
- RefineDocumentsChain

Implements

RefineDocumentsChainInput

Index

Constructors

constructor

new RefineDocumentsChain(
fields: RefineDocumentsChainInput,
): RefineDocumentsChain
Parameters
- fields: RefineDocumentsChainInput
Returns RefineDocumentsChain
Overrides BaseChain.constructor
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/combine_docs_chain.ts:353

Properties

documentPrompt

documentPrompt: BasePromptTemplate = ...

documentVariableName

documentVariableName: string = "context"

Variable name in the LLM chain to put the documents in

initialResponseName

initialResponseName: string = "existing_answer"

inputKey

inputKey: string = "input_documents"

llmChain

llmChain: LLMChain

LLM Wrapper to use after formatting documents

`Optional`memory

memory?: any

outputKey

outputKey: string = "output_text"

refineLLMChain

refineLLMChain: LLMChain

Accessors

defaultDocumentPrompt

get defaultDocumentPrompt(): BasePromptTemplate
Returns BasePromptTemplate
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/combine_docs_chain.ts:327

inputKeys

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

lc_namespace

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

outputKeys

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

Methods

_chainType

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

Returns "refine_documents_chain"
Overrides BaseChain._chainType
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/combine_docs_chain.ts:444

`Protected`_formatValues

_formatValues(values: any): Promise<any>
Parameters
- values: any
Returns Promise<any>
Inherited from BaseChain._formatValues
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/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/main/libs/langchain-classic/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/main/libs/langchain-classic/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/main/libs/langchain-classic/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/main/libs/langchain-classic/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/main/libs/langchain-classic/src/chains/base.ts:190

serialize

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

Returns SerializedRefineDocumentsChain
Overrides BaseChain.serialize
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/combine_docs_chain.ts:467

`Static`deserialize

deserialize(data: SerializedRefineDocumentsChain): Promise<RefineDocumentsChain>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedRefineDocumentsChain
Returns Promise<RefineDocumentsChain>
Overrides BaseChain.deserialize
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-classic/src/chains/combine_docs_chain.ts:448

`Static`lc_name

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

Class RefineDocumentsChain

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RefineDocumentsChain

Properties

documentPrompt

documentVariableName

initialResponseName

inputKey

llmChain

Optionalmemory

outputKey

refineLLMChain

Accessors

defaultDocumentPrompt

Returns BasePromptTemplate

inputKeys

Returns any[]

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_chainType

Returns "refine_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 SerializedRefineDocumentsChain

Staticdeserialize

Parameters

Returns Promise<RefineDocumentsChain>

Staticlc_name

Returns string

Settings

On This Page

`Optional`memory

`Protected`_formatValues

`Static`deserialize

`Static`lc_name