Share via

ResponseErrorEvent Class

Definition

Namespace:
Azure.AI.AgentServer.Contracts.Generated.OpenAI
Assembly:
Azure.AI.AgentServer.Contracts.dll
Package:
Azure.AI.AgentServer.Contracts v1.0.0-beta.4
Source:
ResponseErrorEvent.cs

Emitted when an error occurs.

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

Constructors

Name Description
ResponseErrorEvent()

Initializes a new instance of ResponseErrorEvent for deserialization.
ResponseErrorEvent(Int32, String, String, String)

Initializes a new instance of ResponseErrorEvent.
ResponseErrorEvent(ResponseStreamEventType, Int32, IDictionary<String,BinaryData>, String, String, String)

Initializes a new instance of ResponseErrorEvent.

Properties

Name Description
Code

The error code.
Message

The error message.
Param

The error parameter.
SequenceNumber

The sequence number for this event.

(Inherited from ResponseStreamEvent)
Type

Gets or sets the type.

(Inherited from ResponseStreamEvent)

Methods

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

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ResponseErrorEvent>.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<ResponseErrorEvent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<ResponseErrorEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ResponseErrorEvent>.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