Class MultiQueryRetriever

Example

const retriever = new MultiQueryRetriever.fromLLM({
  llm: new ChatAnthropic({}),
  retriever: new MemoryVectorStore().asRetriever(),
  verbose: true,
});
const retrievedDocs = await retriever.getRelevantDocuments(
  "What are mitochondria made of?",
);

Hierarchy

BaseRetriever
- MultiQueryRetriever

Index

Constructors

constructor

new MultiQueryRetriever(fields): MultiQueryRetriever
Parameters
- fields: MultiQueryRetrieverInput
Returns MultiQueryRetriever
Overrides BaseRetriever.constructor
- Defined in langchain/src/retrievers/multi_query.ts:109

Properties

documentCompressor

documentCompressor: undefined | BaseDocumentCompressor

`Optional` documentCompressorFilteringFn

documentCompressorFilteringFn?: ((docs) => MultiDocs)

Type declaration

- (docs): MultiDocs
- Parameters
  - docs: MultiDocs
  Returns MultiDocs

Methods

`Static` fromLLM

fromLLM(fields): MultiQueryRetriever
Parameters
- fields: Omit<MultiQueryRetrieverInput, "llmChain"> & {
  llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>;
  prompt?: BasePromptTemplate<any, BasePromptValueInterface, any>;
  }
Returns MultiQueryRetriever
- Defined in langchain/src/retrievers/multi_query.ts:119

Class MultiQueryRetriever

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fields: MultiQueryRetrieverInput

Returns MultiQueryRetriever

Properties

documentCompressor

`Optional` documentCompressorFilteringFn

Type declaration

Parameters

docs: MultiDocs

Returns MultiDocs

Methods

`Static` fromLLM

Parameters

fields: Omit<MultiQueryRetrieverInput, "llmChain"> & {
llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>;
prompt?: BasePromptTemplate<any, BasePromptValueInterface, any>;
}

Returns MultiQueryRetriever

Settings

Member Visibility

Theme

On This Page

Class MultiQueryRetriever

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fields: MultiQueryRetrieverInput

Returns MultiQueryRetriever

Properties

documentCompressor

Optional documentCompressorFilteringFn

Type declaration

Parameters

docs: MultiDocs

Returns MultiDocs

Methods

Static fromLLM

Parameters

fields: Omit<MultiQueryRetrieverInput, "llmChain"> & { llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>; prompt?: BasePromptTemplate<any, BasePromptValueInterface, any>; }

Returns MultiQueryRetriever

Settings

Member Visibility

Theme

On This Page

`Optional` documentCompressorFilteringFn

`Static` fromLLM

fields: Omit<MultiQueryRetrieverInput, "llmChain"> & {
llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>;
prompt?: BasePromptTemplate<any, BasePromptValueInterface, any>;
}