Share via


ResponseTextDoneEvent Class

Definition

Emitted when text content is finalized.

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

Constructors

Name Description
ResponseTextDoneEvent()

Initializes a new instance of ResponseTextDoneEvent for deserialization.

ResponseTextDoneEvent(Int32, String, Int32, Int32, String)

Initializes a new instance of ResponseTextDoneEvent.

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

Initializes a new instance of ResponseTextDoneEvent.

Properties

Name Description
ContentIndex

The index of the content part that the text content is finalized.

ItemId

The ID of the output item that the text content is finalized.

OutputIndex

The index of the output item that the text content is finalized.

SequenceNumber

The sequence number for this event.

(Inherited from ResponseStreamEvent)
Text

The text content that is finalized.

Type

Gets or sets the type.

(Inherited from ResponseStreamEvent)

Methods

Name Description
DeserializeResponseTextDoneEvent(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<ResponseTextDoneEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ResponseTextDoneEvent>.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<ResponseTextDoneEvent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ResponseTextDoneEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ResponseTextDoneEvent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to