语言

VectorStoreCollection<TKey,TRecord> 类

定义

表示矢量存储中的记录的命名集合,可用于搜索和管理记录,以及创建或删除集合本身。

generic <typename TKey, typename TRecord>
 where TRecord : classpublic ref class VectorStoreCollection abstract : IDisposable, Microsoft::Extensions::VectorData::IVectorSearchable<TRecord>
public abstract class VectorStoreCollection<TKey,TRecord> : IDisposable, Microsoft.Extensions.VectorData.IVectorSearchable<TRecord> where TRecord : class
type VectorStoreCollection<'Key, 'Record (requires 'Record : null)> = class
    interface IVectorSearchable<'Record (requires 'Record : null)>
    interface IDisposable
Public MustInherit Class VectorStoreCollection(Of TKey, TRecord)
Implements IDisposable, IVectorSearchable(Of TRecord)

类型参数

TKey

记录键的数据类型。

TRecord

用于从存储中添加、更新和检索数据的记录数据模型。

继承
VectorStoreCollection<TKey,TRecord>
实现

注解

除非另有说明,否则此抽象基类的实现应是线程安全的,并且可以从多个线程并发使用。

构造函数

名称 说明
VectorStoreCollection<TKey,TRecord>()

表示矢量存储中的记录的命名集合,可用于搜索和管理记录,以及创建或删除集合本身。

属性

名称 说明
Name

获取集合的名称。

方法

名称 说明
CollectionExistsAsync(CancellationToken)

检查矢量存储中是否存在集合。

DeleteAsync(IEnumerable<TKey>, CancellationToken)

从向量存储中删除一批记录。 不保证集合存在。

DeleteAsync(TKey, CancellationToken)

从向量存储中删除记录。 不保证集合存在。

Dispose()

执行与释放、释放或重置非托管资源关联的应用程序定义任务。

Dispose(Boolean)

释放 VectorStoreCollection<TKey,TRecord> 并释放它保留的任何资源。

EnsureCollectionDeletedAsync(CancellationToken)

从矢量存储中删除集合(如果存在)。

EnsureCollectionExistsAsync(CancellationToken)

如果尚不存在,请在向量存储中创建此集合。

GetAsync(Expression<Func<TRecord,Boolean>>, Int32, FilteredRecordRetrievalOptions<TRecord>, CancellationToken)

从向量存储中获取匹配的记录。 不保证集合存在。

GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken)

从向量存储中获取一批记录。 不保证集合存在。

GetAsync(TKey, RecordRetrievalOptions, CancellationToken)

从向量存储中获取记录。 不保证集合存在。 如果未找到记录,则返回 null。

GetService(Type, Object)

IVectorSearchable<TRecord>请求指定类型的serviceType对象。

SearchAsync<TInput>(TInput, Int32, VectorSearchOptions<TRecord>, CancellationToken)

在向量存储中搜索类似于给定值的记录。

UpsertAsync(IEnumerable<TRecord>, CancellationToken)

将一批记录向上插入到向量存储中。 不保证集合存在。 如果记录已存在,则会更新该记录。 如果记录不存在,则会创建该记录。

UpsertAsync(TRecord, CancellationToken)

将记录向上插入矢量存储。 不保证集合存在。 如果记录已存在,则会更新该记录。 如果记录不存在,则会创建该记录。

适用于