EmbeddingGeneratorExtensions.GenerateAsync<TInput,TEmbedding> メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定した valueから埋め込みを生成します。
public static System.Threading.Tasks.Task<TEmbedding> GenerateAsync<TInput,TEmbedding>(this Microsoft.Extensions.AI.IEmbeddingGenerator<TInput,TEmbedding> generator, TInput value, Microsoft.Extensions.AI.EmbeddingGenerationOptions? options = default, System.Threading.CancellationToken cancellationToken = default) where TEmbedding : Microsoft.Extensions.AI.Embedding;static member GenerateAsync : Microsoft.Extensions.AI.IEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Microsoft.Extensions.AI.Embedding)> * 'Input * Microsoft.Extensions.AI.EmbeddingGenerationOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Embedding (requires 'Embedding :> Microsoft.Extensions.AI.Embedding)> (requires 'Embedding :> Microsoft.Extensions.AI.Embedding)<Extension()>
Public Function GenerateAsync(Of TInput, TEmbedding) (generator As IEmbeddingGenerator(Of TInput, TEmbedding), value As TInput, Optional options As EmbeddingGenerationOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of TEmbedding)型パラメーター
- TInput
埋め込みの生成元となる型。
- TEmbedding
生成する埋め込みの種類。
パラメーター
- generator
- IEmbeddingGenerator<TInput,TEmbedding>
埋め込みジェネレーター。
- value
- TInput
埋め込みの生成元となる値。
- options
- EmbeddingGenerationOptions
要求を構成するための埋め込み生成オプション。
- cancellationToken
- CancellationToken
キャンセル要求を監視する CancellationToken 。 既定値は None です。
返品
Task<TEmbedding>
指定した valueに対して生成された埋め込み。
例外
value は nullです。
ジェネレーターは 1 つの埋め込みを正確に生成しませんでした。
注釈
この操作は、単一のvalueで構成されるコレクションでGenerateAsync(IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)を使用し、結果のGeneratedEmbeddings<TEmbedding> コレクションから最初の埋め込み要素を返すのと同じです。
