OpenAIClient.GetEmbeddingsAsync(EmbeddingsOptions, CancellationToken) Method

Reference

Definition

Namespace:: Azure.AI.OpenAI

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v1.0.0-beta.17

Source:: OpenAIClient.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 computed embeddings for a given prompt.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Embeddings>> GetEmbeddingsAsync (Azure.AI.OpenAI.EmbeddingsOptions embeddingsOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member GetEmbeddingsAsync : Azure.AI.OpenAI.EmbeddingsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Embeddings>>
override this.GetEmbeddingsAsync : Azure.AI.OpenAI.EmbeddingsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Embeddings>>

Public Overridable Function GetEmbeddingsAsync (embeddingsOptions As EmbeddingsOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Embeddings))

Parameters

embeddingsOptions: EmbeddingsOptions

The options for this embeddings request.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<Embeddings>>

Exceptions

ArgumentNullException

embeddingsOptions or embeddingsOptions.DeploymentName.DeploymentName is null.

ArgumentException

embeddingsOptions.DeploymentName.DeploymentName is an empty string.

Applies to

Share via