Share via


StreamingChatCompletionUpdate Class

Definition

Represents a single response chunk from an IChatClient.

public ref class StreamingChatCompletionUpdate
public class StreamingChatCompletionUpdate
type StreamingChatCompletionUpdate = class
Public Class StreamingChatCompletionUpdate
Inheritance
StreamingChatCompletionUpdate

Constructors

StreamingChatCompletionUpdate()

Properties

AdditionalProperties

Gets or sets additional properties for the update.

AuthorName

Gets or sets the name of the author of the completion update.

ChoiceIndex

Gets or sets the zero-based index of the choice with which this update is associated in the streaming sequence.

CompletionId

Gets or sets the ID of the completion of which this update is a part.

Contents

Gets or sets the chat completion update content items.

CreatedAt

Gets or sets a timestamp for the completion update.

FinishReason

Gets or sets the finish reason for the operation.

ModelId

Gets or sets the model ID using in the creation of the chat completion of which this update is a part.

RawRepresentation

Gets or sets the raw representation of the completion update from an underlying implementation.

Role

Gets or sets the role of the author of the completion update.

Text

Gets or sets the text of the first TextContent instance in Contents.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

Applies to