OpenAIClient.GetChatCompletionsAsync 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.

Get chat completions for provided chat context messages.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.ChatCompletions>> GetChatCompletionsAsync (Azure.AI.OpenAI.ChatCompletionsOptions chatCompletionsOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member GetChatCompletionsAsync : Azure.AI.OpenAI.ChatCompletionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.ChatCompletions>>
override this.GetChatCompletionsAsync : Azure.AI.OpenAI.ChatCompletionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.ChatCompletions>>

Public Overridable Function GetChatCompletionsAsync (chatCompletionsOptions As ChatCompletionsOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ChatCompletions))

Parameters

chatCompletionsOptions: ChatCompletionsOptions

The options for this chat completions request.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<ChatCompletions>>

Exceptions

ArgumentNullException

chatCompletionsOptions or chatCompletionsOptions.DeploymentName.DeploymentName is null.

ArgumentException

chatCompletionsOptions.DeploymentName.DeploymentName is an empty string.

Applies to

Share via