OpenAIClient.GetCompletionsAsync 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 textual completions as configured for a given prompt.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Completions>> GetCompletionsAsync (Azure.AI.OpenAI.CompletionsOptions completionsOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member GetCompletionsAsync : Azure.AI.OpenAI.CompletionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Completions>>
override this.GetCompletionsAsync : Azure.AI.OpenAI.CompletionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Completions>>

Public Overridable Function GetCompletionsAsync (completionsOptions As CompletionsOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Completions))

Parameters

completionsOptions: CompletionsOptions

The options for this completions request.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<Completions>>

Exceptions

ArgumentNullException

completionsOptions or completionsOptions.DeploymentName.DeploymentName is null.

ArgumentException

completionsOptions.DeploymentName.DeploymentName is an empty string.

Applies to

Share via