Share via

ResponseRefusalDeltaEvent 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:
ResponseRefusalDeltaEvent.cs

Emitted when there is a partial refusal text.

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

Constructors

Name Description
ResponseRefusalDeltaEvent()

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

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

Initializes a new instance of ResponseRefusalDeltaEvent.

Properties

Name Description
ContentIndex

The index of the content part that the refusal text is added to.
Delta

The refusal text that is added.
ItemId

The ID of the output item that the refusal text is added to.
OutputIndex

The index of the output item that the refusal text is added to.
SequenceNumber

The sequence number for this event.

(Inherited from ResponseStreamEvent)
Type

Gets or sets the type.

(Inherited from ResponseStreamEvent)

Methods

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

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

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

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