StreamingChatCompletionsUpdate Class
Definition
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.
Represents an incremental update to a streamed Chat Completions response.
public class StreamingChatCompletionsUpdate : System.ClientModel.Primitives.IJsonModel<Azure.AI.Inference.StreamingChatCompletionsUpdate>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Inference.StreamingChatCompletionsUpdate>
type StreamingChatCompletionsUpdate = class
interface IJsonModel<StreamingChatCompletionsUpdate>
interface IPersistableModel<StreamingChatCompletionsUpdate>
Public Class StreamingChatCompletionsUpdate
Implements IJsonModel(Of StreamingChatCompletionsUpdate), IPersistableModel(Of StreamingChatCompletionsUpdate)
- Inheritance
-
StreamingChatCompletionsUpdate
- Implements
Properties
Choices |
An update to the collection of completion choices associated with this completions response.
Generally, |
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. |
Id |
Gets a unique identifier associated with this streamed Chat Completions response. |
Model |
The model used for the chat completion. |
Role |
Gets the ChatRole associated with this update. |
ToolCallUpdate |
An incremental update payload for a tool call that is part of this response. |
Usage |
Usage information for tokens processed and generated as part of this completions operation. |
Explicit Interface Implementations
IJsonModel<StreamingChatCompletionsUpdate>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<StreamingChatCompletionsUpdate>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<StreamingChatCompletionsUpdate>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<StreamingChatCompletionsUpdate>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<StreamingChatCompletionsUpdate>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
Applies to
Azure SDK for .NET