Class ScoreThresholdRetriever<V>

Class for performing document retrieval from a VectorStore. Can perform similarity search or maximal marginal relevance search.

Type Parameters

V extends VectorStore

Hierarchy

VectorStoreRetriever<V>
- ScoreThresholdRetriever

Index

Constructors

Properties

k kIncrement maxK minSimilarityScore searchType vectorStore filter? searchKwargs?

Methods

addDocuments getRelevantDocuments fromVectorStore

Constructors

constructor

new ScoreThresholdRetriever<V>(input): ScoreThresholdRetriever<V>
Type Parameters
- V extends VectorStore<V>
Parameters
- input: ScoreThresholdRetrieverInput<V>
Returns ScoreThresholdRetriever<V>
Overrides VectorStoreRetriever.constructor
- Defined in docs/api_refs/langchain/src/retrievers/score_threshold.ts:26

Properties

k

k: number = 4

kIncrement

kIncrement: number = 10

maxK

maxK: number = 100

minSimilarityScore

minSimilarityScore: number

searchType

searchType: string = "similarity"

vectorStore

vectorStore: V

`Optional` filter

filter?: V["FilterType"]

`Optional` searchKwargs

searchKwargs?: VectorStoreRetrieverMMRSearchKwargs

Methods

addDocuments

addDocuments(documents, options?): Promise<void | string[]>
Parameters
- documents: Document<Record<string, any>>[]
- Optional options: AddDocumentOptions
Returns Promise<void | string[]>
Inherited from VectorStoreRetriever.addDocuments
- Defined in docs/api_refs/langchain/src/vectorstores/base.ts:128

getRelevantDocuments

getRelevantDocuments(query): Promise<Document<Record<string, any>>[]>
Parameters
- query: string
Returns Promise<Document<Record<string, any>>[]>
Overrides VectorStoreRetriever.getRelevantDocuments
- Defined in docs/api_refs/langchain/src/retrievers/score_threshold.ts:34

`Static` fromVectorStore

fromVectorStore<V>(vectorStore, options): ScoreThresholdRetriever<V>
Type Parameters
- V extends VectorStore<V>
Parameters
- vectorStore: V
- options: Omit<ScoreThresholdRetrieverInput<V>, "vectorStore">
Returns ScoreThresholdRetriever<V>
- Defined in docs/api_refs/langchain/src/retrievers/score_threshold.ts:51

Generated using TypeDoc