Microsoft.Extensions.VectorData Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
AnyTagEqualToFilterClause |
FilterClause which filters by checking if a field consisting of a list of values contains a specific value. |
DeleteRecordOptions |
Options when calling DeleteAsync(TKey, DeleteRecordOptions, CancellationToken). |
DistanceFunction |
Defines a list of well known distance functions that can be used to compare vectors. |
EqualToFilterClause |
FilterClause which filters using equality of a field value. |
FilterClause |
Base class for filter clauses. |
GetRecordOptions |
Options when calling GetAsync(TKey, GetRecordOptions, CancellationToken). |
IndexKind |
Defines a list of well known index types that can be used to index vectors. |
StorageToDataModelMapperOptions |
Options to use with the MapFromStorageToDataModel(TStorageModel, StorageToDataModelMapperOptions) method. |
UpsertRecordOptions |
Options when calling UpsertAsync(TRecord, UpsertRecordOptions, CancellationToken). Reserved for future use. |
VectorSearchFilter |
Used to provide filtering when doing vector searches. Contains configuration for doing basic vector search filtering. |
VectorSearchOptions |
Options for vector search. |
VectorSearchResult<TRecord> |
A single search result from a vector search. |
VectorSearchResults<TRecord> |
Contains the full list of search results for a vector search operation with metadata. |
VectorStoreException |
Base exception type thrown for any type of failure when using vector stores. |
VectorStoreGenericDataModel<TKey> |
A generic data model that can be used to store and retrieve any data from a vector store. |
VectorStoreOperationException |
Exception thrown when a vector store command fails, such as upserting a record or deleting a collection. |
VectorStoreRecordDataAttribute |
Attribute to mark a property on a record class as 'data'. |
VectorStoreRecordDataProperty |
Defines a data property on a vector store record. |
VectorStoreRecordDefinition |
A description of the properties of a record stored in a vector store. |
VectorStoreRecordKeyAttribute |
Attribute to mark a property on a record class as the key under which the record is stored in a vector store. |
VectorStoreRecordKeyProperty |
Defines a key property on a vector store record. |
VectorStoreRecordMappingException |
Exception thrown when a failure occurs while trying to convert models for storage or retrieval. |
VectorStoreRecordProperty |
Defines a base property class for properties on a vector store record. |
VectorStoreRecordVectorAttribute |
Attribute to mark a property on a record class as a vector. |
VectorStoreRecordVectorProperty |
Defines a vector property on a vector store record. |
Interfaces
IVectorizableTextSearch<TRecord> |
Contains a method for doing a vector search using text that will be vectorized downstream. |
IVectorizedSearch<TRecord> |
Contains a method for doing a vector search using a vector. |
IVectorStore |
Interface for accessing the list of collections in a vector store. |
IVectorStoreRecordCollection<TKey,TRecord> |
A schema aware interface for managing a named collection of records in a vector store and for creating or deleting the collection itself. |
IVectorStoreRecordMapper<TRecordDataModel,TStorageModel> |
Interface for mapping between a storage model, and the consumer record data model. |