Share via


ResponseCompletedEvent Class

Definition

Emitted when the model response is complete.

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

Constructors

Name Description
ResponseCompletedEvent()

Initializes a new instance of ResponseCompletedEvent for deserialization.

ResponseCompletedEvent(Int32, Response)

Initializes a new instance of ResponseCompletedEvent.

ResponseCompletedEvent(ResponseStreamEventType, Int32, IDictionary<String,BinaryData>, Response)

Initializes a new instance of ResponseCompletedEvent.

Properties

Name Description
Response

Properties of the completed response.

SequenceNumber

The sequence number for this event.

(Inherited from ResponseStreamEvent)
Type

Gets or sets the type.

(Inherited from ResponseStreamEvent)

Methods

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

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

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

Converts the provided BinaryData into a model.

IPersistableModel<ResponseCompletedEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ResponseCompletedEvent>.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