Class: VectorIndexRetriever<OBJECT, VALUE, INDEX, FILTER>
Type parameters
| Name |
|---|
OBJECT |
VALUE |
INDEX |
FILTER |
Implements
Retriever<OBJECT,VALUE>
Constructors
constructor
• new VectorIndexRetriever<OBJECT, VALUE, INDEX, FILTER>(«destructured»): VectorIndexRetriever<OBJECT, VALUE, INDEX, FILTER>
Type parameters
| Name |
|---|
OBJECT |
VALUE |
INDEX |
FILTER |
Parameters
| Name | Type |
|---|---|
«destructured» | { embeddingModel: EmbeddingModel<VALUE, EmbeddingModelSettings> ; vectorIndex: VectorIndex<OBJECT, INDEX, FILTER> } & VectorIndexRetrieverSettings<FILTER> |
Returns
VectorIndexRetriever<OBJECT, VALUE, INDEX, FILTER>
Defined in
packages/modelfusion/src/vector-index/VectorIndexRetriever.ts:26
Methods
retrieve
▸ retrieve(query, options?): Promise<OBJECT[]>
Parameters
| Name | Type |
|---|---|
query | VALUE |
options? | FunctionOptions |
Returns
Promise<OBJECT[]>
Implementation of
Defined in
packages/modelfusion/src/vector-index/VectorIndexRetriever.ts:45
withSettings
▸ withSettings(additionalSettings): this
Parameters
| Name | Type |
|---|---|
additionalSettings | Partial<VectorIndexRetrieverSettings<FILTER>> |
Returns
this
Defined in
packages/modelfusion/src/vector-index/VectorIndexRetriever.ts:62