Share via


ResponseReasoningDeltaEvent Class

Definition

Emitted when there is a delta (partial update) to the reasoning content.

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

Constructors

Name Description
ResponseReasoningDeltaEvent()

Initializes a new instance of ResponseReasoningDeltaEvent for deserialization.

ResponseReasoningDeltaEvent(Int32, String, Int32, Int32, BinaryData)

Initializes a new instance of ResponseReasoningDeltaEvent.

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

Initializes a new instance of ResponseReasoningDeltaEvent.

Properties

Name Description
ContentIndex

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

Delta

The partial update to the reasoning content.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

ItemId

The unique identifier of the item for which reasoning is being updated.

OutputIndex

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

SequenceNumber

The sequence number for this event.

(Inherited from ResponseStreamEvent)
Type

Gets or sets the type.

(Inherited from ResponseStreamEvent)

Methods

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

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

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

Converts the provided BinaryData into a model.

IPersistableModel<ResponseReasoningDeltaEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

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

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