EmbeddingGeneratorExtensions.GenerateAsync<TInput,TEmbedding> Methode

Definition

Generiert eine Einbettung aus dem angegebenen 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)

Typparameter

TInput

Der Typ, aus dem Einbettungen generiert werden.

TEmbedding

Der Typ der zu generierenden Einbettung.

Parameter

generator
IEmbeddingGenerator<TInput,TEmbedding>

Der Einbettungsgenerator.

value
TInput

Ein Wert, aus dem eine Einbettung generiert wird.

options
EmbeddingGenerationOptions

Die Einbettungsgenerierungsoptionen zum Konfigurieren der Anforderung.

cancellationToken
CancellationToken

Der CancellationToken zu überwachende Monitor für Abbruchanforderungen. Der Standardwert lautet None.

Gibt zurück

Task<TEmbedding>

Die generierte Einbettung für die angegebene value.

Ausnahmen

value ist null.

Der Generator hat nicht genau eine Einbettung erzeugt.

Hinweise

Diese Vorgänge entsprechen der Verwendung GenerateAsync(IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken) mit einer Sammlung, die aus dem einzelnen value besteht, und gibt dann das erste einbettungselement aus der resultierenden GeneratedEmbeddings<TEmbedding> Auflistung zurück.

Gilt für: