VectorPropertyModel.GenerateEmbeddingAsync(Object, CancellationToken) Method

Definition

Namespace:

Microsoft.Extensions.VectorData.ProviderServices

Assembly:

Microsoft.Extensions.VectorData.Abstractions.dll

Package:

Microsoft.Extensions.VectorData.Abstractions v10.9.0

Source:

VectorPropertyModel.cs

Generates a single embedding for the given value, using the configured EmbeddingGenerationDispatcher.

public:
 System::Threading::Tasks::Task<Microsoft::Extensions::AI::Embedding ^> ^ GenerateEmbeddingAsync(System::Object ^ value, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<Microsoft.Extensions.AI.Embedding> GenerateEmbeddingAsync(object? value, System.Threading.CancellationToken cancellationToken);

member this.GenerateEmbeddingAsync : obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.AI.Embedding>

Public Function GenerateEmbeddingAsync (value As Object, cancellationToken As CancellationToken) As Task(Of Embedding)

Parameters

value

Object

cancellationToken

CancellationToken

Returns

Task<Embedding>

The generated embedding.

Exceptions

InvalidOperationException

Thrown if no EmbeddingGenerationDispatcher is configured on this property.