Share via


ResponseReasoningSummaryDoneEvent Class

Definition

Emitted when the reasoning summary content is finalized for an item.

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

Constructors

Name Description
ResponseReasoningSummaryDoneEvent()

Initializes a new instance of ResponseReasoningSummaryDoneEvent for deserialization.

ResponseReasoningSummaryDoneEvent(Int32, String, Int32, Int32, String)

Initializes a new instance of ResponseReasoningSummaryDoneEvent.

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

Initializes a new instance of ResponseReasoningSummaryDoneEvent.

Properties

Name Description
ItemId

The unique identifier of the item for which the reasoning summary is finalized.

OutputIndex

The index of the output item in the response's output array.

SequenceNumber

The sequence number for this event.

(Inherited from ResponseStreamEvent)
SummaryIndex

The index of the summary part within the output item.

Text

The finalized reasoning summary text.

Type

Gets or sets the type.

(Inherited from ResponseStreamEvent)

Methods

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

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

IJsonModel<ResponseReasoningSummaryDoneEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

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)
IPersistableModel<ResponseReasoningSummaryDoneEvent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ResponseReasoningSummaryDoneEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ResponseReasoningSummaryDoneEvent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

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)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to