StreamingChatCompletionsUpdate Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

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

Source:

StreamingChatCompletionsUpdate.cs

Represents an incremental update to a streamed Chat Completions response.

public class StreamingChatCompletionsUpdate

type StreamingChatCompletionsUpdate = class

Public Class StreamingChatCompletionsUpdate

Inheritance

Object

StreamingChatCompletionsUpdate

Properties

AuthorName	Gets an optional name associated with the role of the streamed Chat Completion, typically as previously specified in a system message.
AzureExtensionsContext	Gets additional data associated with this update that is specific to use with Azure OpenAI and that service's extended capabilities.
ChoiceIndex	Gets the choice index associated with this streamed update.
ContentUpdate	Gets the content fragment associated with this update.
Created	Gets the first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
FinishReason	Gets the CompletionsFinishReason associated with this update.
FunctionArgumentsUpdate	Gets a function arguments fragment associated with this update.
FunctionName	Gets the name of a function to be called.
Id	Gets a unique identifier associated with this streamed Chat Completions response.
LogProbabilityInfo	Gets the log probability information associated with the content of this update, as requested by providing values for EnableLogProbabilities and LogProbabilitiesPerToken in the request.
Model	The model name used for this completions request.
Role	Gets the ChatRole associated with this update.
SystemFingerprint	Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.
ToolCallUpdate	An incremental update payload for a tool call that is part of this response.