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

Begin a chat completions request and get an object that can stream response data as it becomes available.

public virtual Azure.AI.OpenAI.StreamingResponse<Azure.AI.OpenAI.StreamingChatCompletionsUpdate> GetChatCompletionsStreaming (Azure.AI.OpenAI.ChatCompletionsOptions chatCompletionsOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member GetChatCompletionsStreaming : Azure.AI.OpenAI.ChatCompletionsOptions * System.Threading.CancellationToken -> Azure.AI.OpenAI.StreamingResponse<Azure.AI.OpenAI.StreamingChatCompletionsUpdate>
override this.GetChatCompletionsStreaming : Azure.AI.OpenAI.ChatCompletionsOptions * System.Threading.CancellationToken -> Azure.AI.OpenAI.StreamingResponse<Azure.AI.OpenAI.StreamingChatCompletionsUpdate>

Public Overridable Function GetChatCompletionsStreaming (chatCompletionsOptions As ChatCompletionsOptions, Optional cancellationToken As CancellationToken = Nothing) As StreamingResponse(Of StreamingChatCompletionsUpdate)

Parameters

chatCompletionsOptions: ChatCompletionsOptions

the chat completions options for this chat completions request.

cancellationToken: CancellationToken

a cancellation token that can be used to cancel the initial request or ongoing streaming operation.

Returns

StreamingResponse<StreamingChatCompletionsUpdate>

The response returned from the service.

Exceptions

ArgumentNullException

chatCompletionsOptions or chatCompletionsOptions.DeploymentName.DeploymentName is null.

ArgumentException

chatCompletionsOptions.DeploymentName.DeploymentName is an empty string.

Applies to

Share via