VectorStoreCollection<TKey,TRecord>.GetAsync 方法

定義

命名空間:: Microsoft.Extensions.VectorData

組件:: Microsoft.Extensions.VectorData.Abstractions.dll

套件:: Microsoft.Extensions.VectorData.Abstractions v10.9.0

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

多載

名稱	Description
GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken)	從向量儲存庫取得一批紀錄。但這並不保證該收藏品存在。
GetAsync(TKey, RecordRetrievalOptions, CancellationToken)	從向量商店取得紀錄。但這並不保證該收藏品存在。若找不到該紀錄，則回傳為空。
GetAsync(Expression<Func<TRecord,Boolean>>, Int32, FilteredRecordRetrievalOptions<TRecord>, CancellationToken)	從向量儲存庫取得匹配的紀錄。但這並不保證該收藏品存在。

GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken)

來源:: VectorStoreCollection.cs

從向量儲存庫取得一批紀錄。但這並不保證該收藏品存在。

public virtual System.Collections.Generic.IAsyncEnumerable<TRecord> GetAsync(System.Collections.Generic.IEnumerable<TKey> keys, Microsoft.Extensions.VectorData.RecordRetrievalOptions? options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : seq<'Key> * Microsoft.Extensions.VectorData.RecordRetrievalOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Record (requires 'Record : null)>
override this.GetAsync : seq<'Key> * Microsoft.Extensions.VectorData.RecordRetrievalOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Record (requires 'Record : null)>

Public Overridable Function GetAsync (keys As IEnumerable(Of TKey), Optional options As RecordRetrievalOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TRecord)

參數

keys: IEnumerable<TKey>

與紀錄相關的獨特ID。

options: RecordRetrievalOptions

取回紀錄的選項。

cancellationToken: CancellationToken

CancellationToken他們需要監控取消申請。預設值為 None。

傳回

IAsyncEnumerable<TRecord>

與指定唯一鍵相關聯的紀錄。

例外狀況

VectorStoreException

指令因任何原因無法執行。

備註

具體的檢索方式依實作而異，且可依資料庫支援而異。此方法的預設實作會依序檢索記錄，但支援批次處理的實作可覆蓋以提供更有效率的實作。

只回傳找到的記錄，因此結果集可能比請求的鍵值還小。

這種方法除了找不到紀錄外，還會排除其他問題。

適用於

GetAsync(TKey, RecordRetrievalOptions, CancellationToken)

來源:: VectorStoreCollection.cs

從向量商店取得紀錄。但這並不保證該收藏品存在。若找不到該紀錄，則回傳為空。

public abstract System.Threading.Tasks.Task<TRecord?> GetAsync(TKey key, Microsoft.Extensions.VectorData.RecordRetrievalOptions? options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : 'Key * Microsoft.Extensions.VectorData.RecordRetrievalOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Record (requires 'Record : null)>

Public MustOverride Function GetAsync (key As TKey, Optional options As RecordRetrievalOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TRecord)

參數

key: TKey

與紀錄相關的唯一ID。

options: RecordRetrievalOptions

可選的取回紀錄選項。

cancellationToken: CancellationToken

CancellationToken他們需要監控取消申請。預設值為 None。

傳回

Task<TRecord>

如果找到該紀錄，否則為零。

例外狀況

VectorStoreException

指令因任何原因無法執行。

適用於

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

來源:: VectorStoreCollection.cs

從向量儲存庫取得匹配的紀錄。但這並不保證該收藏品存在。

public abstract System.Collections.Generic.IAsyncEnumerable<TRecord> GetAsync(System.Linq.Expressions.Expression<Func<TRecord,bool>> filter, int top, Microsoft.Extensions.VectorData.FilteredRecordRetrievalOptions<TRecord>? options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : System.Linq.Expressions.Expression<Func<'Record, bool>> * int * Microsoft.Extensions.VectorData.FilteredRecordRetrievalOptions<'Record (requires 'Record : null)> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'Record (requires 'Record : null)>

Public MustOverride Function GetAsync (filter As Expression(Of Func(Of TRecord, Boolean)), top As Integer, Optional options As FilteredRecordRetrievalOptions(Of TRecord) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of TRecord)