ResponseTextDoneEvent Class

Definition

Emitted when text content is finalized.

public class ResponseTextDoneEvent : Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.ResponseTextDoneEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.ResponseTextDoneEvent>
type ResponseTextDoneEvent = class
    inherit ResponseStreamEvent
    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(Int64, String, Int64, Int64, String, IEnumerable<ResponseLogProb>)

Initializes a new instance of ResponseTextDoneEvent.

Properties

Name Description
ContentIndex

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

EventType

Gets the event type discriminator (e.g. response.created, response.completed).

(Inherited from ResponseStreamEvent)
ItemId

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

Logprobs

The log probabilities of the tokens in the delta.

OutputIndex

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

SequenceNumber

Gets the SequenceNumber.

(Inherited from ResponseStreamEvent)
Text

The text content that is finalized.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Explicit(ClientResult to ResponseTextDoneEvent)

Explicit Interface Implementations

Name Description
IJsonModel<ResponseStreamEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IJsonModel<ResponseStreamEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IJsonModel<ResponseTextDoneEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ResponseTextDoneEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ResponseStreamEvent>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.Write(ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseTextDoneEvent>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ResponseTextDoneEvent>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ResponseTextDoneEvent>.Write(ModelReaderWriterOptions)

Extension Methods

Name Description
SnapshotEmbeddedResponse(ResponseStreamEvent, ResponseObject)

If the event is a lifecycle event that embeds a ResponseObject reference, replaces it with an immutable snapshot of the given accumulator. Non-lifecycle events are left unchanged.

Applies to