StreamingChatChoiceUpdate Class

Reference

Definition

Namespace:: Azure.AI.Inference

Assembly:: Azure.AI.Inference.dll

Package:: Azure.AI.Inference v1.0.0-beta.3

Source:: StreamingChatChoiceUpdate.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.

Represents an update to a single prompt completion when the service is streaming updates using Server Sent Events (SSE). Generally, n choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.

public class StreamingChatChoiceUpdate : System.ClientModel.Primitives.IJsonModel<Azure.AI.Inference.StreamingChatChoiceUpdate>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Inference.StreamingChatChoiceUpdate>

type StreamingChatChoiceUpdate = class
    interface IJsonModel<StreamingChatChoiceUpdate>
    interface IPersistableModel<StreamingChatChoiceUpdate>

Public Class StreamingChatChoiceUpdate
Implements IJsonModel(Of StreamingChatChoiceUpdate), IPersistableModel(Of StreamingChatChoiceUpdate)

Inheritance: Object
StreamingChatChoiceUpdate

Implements: IJsonModel<StreamingChatChoiceUpdate> IPersistableModel<StreamingChatChoiceUpdate> IPersistableModel<T>

Properties

Delta	An update to the chat message for a given chat completions prompt.
FinishReason	The reason that this chat completions choice completed its generated.
Index	The ordered index associated with this chat completions choice.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<StreamingChatChoiceUpdate>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<StreamingChatChoiceUpdate>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<StreamingChatChoiceUpdate>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<StreamingChatChoiceUpdate>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<StreamingChatChoiceUpdate>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via