Class VectorDBQAChain

Class that represents a VectorDBQAChain. It extends the BaseChain class and implements the VectorDBQAChainInput interface. It performs a similarity search using a vector store and combines the search results using a specified combine documents chain.

Hierarchy

BaseChain
- VectorDBQAChain

Implements

VectorDBQAChainInput

Index

Constructors

constructor

new VectorDBQAChain(fields): VectorDBQAChain
Parameters
- fields: VectorDBQAChainInput
Returns VectorDBQAChain
Overrides BaseChain.constructor
- Defined in docs/api_refs/langchain/src/chains/vector_db_qa.ts:58

Properties

combineDocumentsChain

combineDocumentsChain: BaseChain<ChainValues, ChainValues>

inputKey

inputKey: string = "query"

k

k: number = 4

returnSourceDocuments

returnSourceDocuments: boolean = false

vectorstore

vectorstore: VectorStore

`Optional` memory

memory?: BaseMemory

Accessors

inputKeys

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

outputKeys

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

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(): SerializedVectorDBQAChain
Return a json-like object representing this chain.

Returns SerializedVectorDBQAChain
Overrides BaseChain.serialize
- Defined in docs/api_refs/langchain/src/chains/vector_db_qa.ts:127

`Static` deserialize

deserialize(data, values): Promise<VectorDBQAChain>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedVectorDBQAChain
- values: LoadValues
Returns Promise<VectorDBQAChain>
Overrides BaseChain.deserialize
- Defined in docs/api_refs/langchain/src/chains/vector_db_qa.ts:102

`Static` fromLLM

fromLLM(llm, vectorstore, options?): VectorDBQAChain
Static method that creates a VectorDBQAChain instance from a BaseLanguageModel and a vector store. It also accepts optional options to customize the chain.
Parameters
- llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>
  
  The BaseLanguageModel instance.
- vectorstore: VectorStore
  
  The vector store used for similarity search.
- Optional options: Partial<Omit<VectorDBQAChainInput, "vectorstore" | "combineDocumentsChain">>
  
  Optional options to customize the chain.
Returns VectorDBQAChain
A new instance of VectorDBQAChain.
- Defined in docs/api_refs/langchain/src/chains/vector_db_qa.ts:144

Class VectorDBQAChain

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: VectorDBQAChainInput

Returns VectorDBQAChain

Properties

combineDocumentsChain

inputKey

k

returnSourceDocuments

vectorstore

Optional memory

Accessors

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 SerializedVectorDBQAChain

Static deserialize

Parameters

data: SerializedVectorDBQAChain

values: LoadValues

Returns Promise<VectorDBQAChain>

Static fromLLM

Parameters

llm: BaseLanguageModel<any, BaseLanguageModelCallOptions>

vectorstore: VectorStore

Optional options: Partial<Omit<VectorDBQAChainInput, "vectorstore" | "combineDocumentsChain">>

Returns VectorDBQAChain

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

`Static` fromLLM

`Optional` options: Partial<Omit<VectorDBQAChainInput, "vectorstore" | "combineDocumentsChain">>