Language

EmbeddingGeneratorExtensions.GenerateVectorAsync<TInput,TEmbeddingElement> メソッド

定義

指定した valueから埋め込みベクターを生成します。

public static System.Threading.Tasks.Task<ReadOnlyMemory<TEmbeddingElement>> GenerateVectorAsync<TInput,TEmbeddingElement>(this Microsoft.Extensions.AI.IEmbeddingGenerator<TInput,Microsoft.Extensions.AI.Embedding<TEmbeddingElement>> generator, TInput value, Microsoft.Extensions.AI.EmbeddingGenerationOptions? options = default, System.Threading.CancellationToken cancellationToken = default);
static member GenerateVectorAsync : Microsoft.Extensions.AI.IEmbeddingGenerator<'Input, Microsoft.Extensions.AI.Embedding<'EmbeddingElement>> * 'Input * Microsoft.Extensions.AI.EmbeddingGenerationOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<ReadOnlyMemory<'EmbeddingElement>>
<Extension()>
Public Function GenerateVectorAsync(Of TInput, TEmbeddingElement) (generator As IEmbeddingGenerator(Of TInput, Embedding(Of TEmbeddingElement)), value As TInput, Optional options As EmbeddingGenerationOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ReadOnlyMemory(Of TEmbeddingElement))

型パラメーター

TInput

埋め込みの生成元となる型。

TEmbeddingElement

埋め込みデータの数値型。

パラメーター

generator
IEmbeddingGenerator<TInput,Embedding<TEmbeddingElement>>

埋め込みジェネレーター。

value
TInput

埋め込みの生成元となる値。

options
EmbeddingGenerationOptions

要求を構成するための埋め込み生成オプション。

cancellationToken
CancellationToken

キャンセル要求を監視する CancellationToken 。 既定値は None です。

戻り値

Task<ReadOnlyMemory<TEmbeddingElement>>

指定した valueに対して生成された埋め込み。

例外

value は nullです。

ジェネレーターは 1 つの埋め込みを正確に生成しませんでした。

注釈

この操作は、 GenerateAsync<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, TInput, EmbeddingGenerationOptions, CancellationToken) を使用して結果の Embedding<T>の Vector プロパティを返すのと同じです。

適用対象