Partager via


Microsoft.SemanticKernel.Data Namespace

Classes

DeleteRecordOptions

Options when calling DeleteAsync(TKey, DeleteRecordOptions, CancellationToken).

DistanceFunction

Defines a list of well known distance functions that can be used to compare vectors.

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.

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.

VolatileVectorStore

Service for storing and retrieving vector records, and managing vector record collections, that uses an in memory dictionary as the underlying storage.

VolatileVectorStoreRecordCollection<TKey,TRecord>

Service for storing and retrieving vector records, that uses an in memory dictionary as the underlying storage.

VolatileVectorStoreRecordCollectionOptions

Options when creating a VolatileVectorStoreRecordCollection<TKey,TRecord>.

Interfaces

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.