ImageEmbeddingsClient.EmbedAsync Method

Reference

Definition

Namespace:: Azure.AI.Inference

Assembly:: Azure.AI.Inference.dll

Package:: Azure.AI.Inference v1.0.0-beta.3

Source:: ImageEmbeddingsClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Return the embedding vectors for given images. The method makes a REST API call to the /images/embeddings route on the given endpoint.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Inference.EmbeddingsResult>> EmbedAsync(Azure.AI.Inference.ImageEmbeddingsOptions imageEmbeddingsOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member EmbedAsync : Azure.AI.Inference.ImageEmbeddingsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Inference.EmbeddingsResult>>
override this.EmbedAsync : Azure.AI.Inference.ImageEmbeddingsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Inference.EmbeddingsResult>>

Public Overridable Function EmbedAsync (imageEmbeddingsOptions As ImageEmbeddingsOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EmbeddingsResult))

Parameters

imageEmbeddingsOptions: ImageEmbeddingsOptions

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<EmbeddingsResult>>

Exceptions

ArgumentNullException

imageEmbeddingsOptions is null.

Applies to

Share via