ResponseOutputTextAnnotationAddedEvent Class

Definition

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

ResponseOutputTextAnnotationAddedEvent.

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

Constructors

Name Description
ResponseOutputTextAnnotationAddedEvent(Int64, String, Int64, Int64, Int64, Annotation)

Initializes a new instance of ResponseOutputTextAnnotationAddedEvent.

Properties

Name Description
Annotation

The annotation object being added. (See annotation schema for details.).
AnnotationIndex

The index of the annotation within the content part.
ContentIndex

The index of the content part within the output item.
EventType

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

(Inherited from ResponseStreamEvent)
ItemId

The unique identifier of the item to which the annotation is being added.
OutputIndex

The index of the output item in the response's output array.
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 ResponseOutputTextAnnotationAddedEvent)

Explicit Interface Implementations

Name Description
IJsonModel<ResponseOutputTextAnnotationAddedEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ResponseOutputTextAnnotationAddedEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ResponseStreamEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IJsonModel<ResponseStreamEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseOutputTextAnnotationAddedEvent>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ResponseOutputTextAnnotationAddedEvent>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ResponseOutputTextAnnotationAddedEvent>.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