ResponseOutputItemDoneEvent Class

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.4
Source:
ResponseOutputItemDoneEvent.cs

Emitted when an output item is marked done.

public class ResponseOutputItemDoneEvent : Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.ResponseOutputItemDoneEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.ResponseOutputItemDoneEvent>
type ResponseOutputItemDoneEvent = class
    inherit ResponseStreamEvent
    interface IJsonModel<ResponseOutputItemDoneEvent>
    interface IPersistableModel<ResponseOutputItemDoneEvent>
Public Class ResponseOutputItemDoneEvent
Inherits ResponseStreamEvent
Implements IJsonModel(Of ResponseOutputItemDoneEvent), IPersistableModel(Of ResponseOutputItemDoneEvent)
Inheritance
Object
ResponseStreamEvent
ResponseOutputItemDoneEvent
Implements
IJsonModel<ResponseOutputItemDoneEvent> IPersistableModel<ResponseOutputItemDoneEvent> IPersistableModel<T>

Constructors

Name Description
ResponseOutputItemDoneEvent(Int64, Int64, OutputItem)

Initializes a new instance of ResponseOutputItemDoneEvent.

Properties

Name Description
EventType

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

(Inherited from ResponseStreamEvent)
Item

The output item that was marked done.
OutputIndex

The index of the output item that was marked done.
SequenceNumber

Gets the SequenceNumber.

(Inherited from ResponseStreamEvent)

Methods

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

Operators

Name Description
Explicit(ClientResult to ResponseOutputItemDoneEvent)

Explicit Interface Implementations

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

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