Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

VectorStore Class

Definition

Namespace:
Microsoft.Extensions.VectorData
Assembly:
Microsoft.Extensions.VectorData.Abstractions.dll
Package:
Microsoft.Extensions.VectorData.Abstractions v10.7.0
Source:
VectorStore.cs

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.

Represents a vector store that contains collections of records.

public ref class VectorStore abstract : IDisposable
public abstract class VectorStore : IDisposable
type VectorStore = class
 interface IDisposable
Public MustInherit Class VectorStore
Implements IDisposable
Inheritance
VectorStore
Implements

Remarks

This type can be used with collections of any schema type, but requires you to provide schema information when getting a collection.

Unless otherwise documented, implementations of this abstract base class can be expected to be thread-safe, and can be used concurrently from multiple threads.

Constructors

Name Description
VectorStore()

Methods

Name Description
CollectionExistsAsync(String, CancellationToken)

Checks if the collection exists in the vector store.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Dispose(Boolean)

Disposes the VectorStore and releases any resources it holds.

EnsureCollectionDeletedAsync(String, CancellationToken)

Deletes the collection from the vector store.

GetCollection<TKey,TRecord>(String, VectorStoreCollectionDefinition)

Gets a collection from the vector store.

GetDynamicCollection(String, VectorStoreCollectionDefinition)

Gets a collection from the vector store, using dynamic mapping; the record type is represented as a Dictionary<TKey,TValue>.

GetService(Type, Object)

Asks the VectorStore for an object of the specified type serviceType.

ListCollectionNamesAsync(CancellationToken)

Retrieves the names of all the collections in the vector store.

Applies to


Feedback

Was this page helpful?