Class RefineDocumentsChain

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

Hierarchy

BaseChain
- RefineDocumentsChain

Implements

RefineDocumentsChainInput

Index

Constructors

constructor

new RefineDocumentsChain(fields): RefineDocumentsChain
Parameters
- fields: RefineDocumentsChainInput
Returns RefineDocumentsChain
Overrides BaseChain.constructor
- Defined in docs/api_refs/langchain/src/chains/combine_docs_chain.ts:361

Properties

documentPrompt

documentPrompt: BasePromptTemplate<any, BasePromptValue, any> = ...

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<string, LLMType>

LLM Wrapper to use after formatting documents

outputKey

outputKey: string = "output_text"

refineLLMChain

refineLLMChain: LLMChain<string, LLMType>

`Optional` memory

memory?: BaseMemory

Accessors

defaultDocumentPrompt

get defaultDocumentPrompt(): BasePromptTemplate<any, BasePromptValue, any>
Returns BasePromptTemplate<any, BasePromptValue, any>
- Defined in docs/api_refs/langchain/src/chains/combine_docs_chain.ts:335

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in docs/api_refs/langchain/src/chains/combine_docs_chain.ts:344

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in docs/api_refs/langchain/src/chains/combine_docs_chain.ts:357

Methods

apply

apply(inputs, config?): Promise<ChainValues[]>
Call the chain on all inputs in the list
Parameters
- inputs: ChainValues[]
- Optional config: (BaseCallbackConfig | Callbacks)[]
Returns Promise<ChainValues[]>
Inherited from BaseChain.apply
- Defined in docs/api_refs/langchain/src/chains/base.ts:252

call

call(values, config?, tags?): Promise<ChainValues>
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>
Inherited from BaseChain.call
- Defined in docs/api_refs/langchain/src/chains/base.ts:192

invoke

invoke(input, config?): Promise<ChainValues>
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.
Inherited from BaseChain.invoke
- Defined in docs/api_refs/langchain/src/chains/base.ts:83

prepOutputs

prepOutputs(inputs, outputs, returnOnlyOutputs?): 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 docs/api_refs/langchain/src/chains/base.ts:99

run

run(input, config?): Promise<string>
Parameters
- input: any
- Optional config: BaseCallbackConfig | Callbacks
Returns Promise<string>
Inherited from BaseChain.run
- Defined in docs/api_refs/langchain/src/chains/base.ts:140

serialize

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

Returns SerializedRefineDocumentsChain
Overrides BaseChain.serialize
- Defined in docs/api_refs/langchain/src/chains/combine_docs_chain.ts:476

`Static` deserialize

deserialize(data): Promise<RefineDocumentsChain>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedRefineDocumentsChain
Returns Promise<RefineDocumentsChain>
Overrides BaseChain.deserialize
- Defined in docs/api_refs/langchain/src/chains/combine_docs_chain.ts:457

Class RefineDocumentsChain

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: RefineDocumentsChainInput

Returns RefineDocumentsChain

Properties

documentPrompt

documentVariableName

initialResponseName

inputKey

llmChain

outputKey

refineLLMChain

Optional memory

Accessors

defaultDocumentPrompt

Returns BasePromptTemplate<any, BasePromptValue, any>

inputKeys

Returns string[]

outputKeys

Returns string[]

Methods

apply

Parameters

inputs: ChainValues[]

Optional config: (BaseCallbackConfig | Callbacks)[]

Returns Promise<ChainValues[]>

call

Parameters

values: ChainValues & { signal?: AbortSignal; timeout?: number; }

Optional config: BaseCallbackConfig | Callbacks

Optional tags: string[]

Deprecated

Returns Promise<ChainValues>

invoke

Parameters

input: ChainValues

Optional config: BaseCallbackConfig

Returns Promise<ChainValues>

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

Returns SerializedRefineDocumentsChain

Static deserialize

Parameters

data: SerializedRefineDocumentsChain

Returns Promise<RefineDocumentsChain>

Settings

Member Visibility

Theme

On This Page

`Optional` memory

`Optional` config: (BaseCallbackConfig | Callbacks)[]

values: ChainValues & {
signal?: AbortSignal;
timeout?: number;
}

`Optional` config: BaseCallbackConfig | Callbacks

`Optional` tags: string[]

`Optional` config: BaseCallbackConfig

`Optional` config: BaseCallbackConfig | Callbacks

`Static` deserialize