VectorStoreCollection<TKey,TRecord>.GetAsync メソッド

定義

名前空間:: Microsoft.Extensions.VectorData

アセンブリ:: Microsoft.Extensions.VectorData.Abstractions.dll

パッケージ:: Microsoft.Extensions.VectorData.Abstractions v10.6.0

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

名前	説明
GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken)	ベクターストアからレコードのバッチを取得します。コレクションが存在することを保証しません。
GetAsync(TKey, RecordRetrievalOptions, CancellationToken)	ベクターストアからレコードを取得します。コレクションが存在することを保証しません。レコードが見つからない場合は null を返します。
GetAsync(Expression<Func<TRecord,Boolean>>, Int32, FilteredRecordRetrievalOptions<TRecord>, CancellationToken)	ベクターストアから一致するレコードを取得します。コレクションが存在することを保証しません。

GetAsync(IEnumerable<TKey>, RecordRetrievalOptions, CancellationToken)

ベクターストアからレコードのバッチを取得します。コレクションが存在することを保証しません。

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

コマンドは何らかの理由で実行に失敗します。

注釈

正確な取得方法は実装固有であり、データベースのサポートによって異なる場合があります。このメソッドの既定の実装ではレコードが 1 つずつ取得されますが、バッチ処理をサポートする実装はオーバーライドして、より効率的な実装を提供できます。

見つかったレコードのみが返されるため、結果セットは要求されたキーよりも小さい可能性があります。

このメソッドは、レコードが見つからない以外の問題に対してスローします。

適用対象

GetAsync(TKey, RecordRetrievalOptions, CancellationToken)

ベクターストアからレコードを取得します。コレクションが存在することを保証しません。レコードが見つからない場合は null を返します。

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>

見つかった場合はレコード。それ以外の場合は null。

例外

VectorStoreException

コマンドは何らかの理由で実行に失敗します。

適用対象

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

ベクターストアから一致するレコードを取得します。コレクションが存在することを保証しません。

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)