Share via


ResponseTextDeltaEvent Class

Definition

Emitted when there is an additional text delta.

public class ResponseTextDeltaEvent : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseTextDeltaEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseTextDeltaEvent>
type ResponseTextDeltaEvent = class
    inherit ResponseStreamEvent
    interface IUtf8JsonSerializable
    interface IJsonModel<ResponseTextDeltaEvent>
    interface IPersistableModel<ResponseTextDeltaEvent>
Public Class ResponseTextDeltaEvent
Inherits ResponseStreamEvent
Implements IJsonModel(Of ResponseTextDeltaEvent), IPersistableModel(Of ResponseTextDeltaEvent)
Inheritance
ResponseTextDeltaEvent
Implements

Constructors

Name Description
ResponseTextDeltaEvent()

Initializes a new instance of ResponseTextDeltaEvent for deserialization.

ResponseTextDeltaEvent(Int32, String, Int32, Int32, String)

Initializes a new instance of ResponseTextDeltaEvent.

ResponseTextDeltaEvent(ResponseStreamEventType, Int32, IDictionary<String,BinaryData>, String, Int32, Int32, String)

Initializes a new instance of ResponseTextDeltaEvent.

Properties

Name Description
ContentIndex

The index of the content part that the text delta was added to.

Delta

The text delta that was added.

ItemId

The ID of the output item that the text delta was added to.

OutputIndex

The index of the output item that the text delta was added to.

SequenceNumber

The sequence number for this event.

(Inherited from ResponseStreamEvent)
Type

Gets or sets the type.

(Inherited from ResponseStreamEvent)

Methods

Name Description
DeserializeResponseTextDeltaEvent(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<ResponseStreamEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ResponseStreamEvent)
IJsonModel<ResponseStreamEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ResponseStreamEvent)
IJsonModel<ResponseTextDeltaEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ResponseTextDeltaEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ResponseStreamEvent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ResponseStreamEvent)
IPersistableModel<ResponseTextDeltaEvent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ResponseTextDeltaEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ResponseTextDeltaEvent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to