ResponseTextDeltaEvent Class

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.4
Source:
ResponseTextDeltaEvent.cs

Emitted when there is an additional text delta.

public class ResponseTextDeltaEvent : Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.ResponseTextDeltaEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.ResponseTextDeltaEvent>
type ResponseTextDeltaEvent = class
    inherit ResponseStreamEvent
    interface IJsonModel<ResponseTextDeltaEvent>
    interface IPersistableModel<ResponseTextDeltaEvent>
Public Class ResponseTextDeltaEvent
Inherits ResponseStreamEvent
Implements IJsonModel(Of ResponseTextDeltaEvent), IPersistableModel(Of ResponseTextDeltaEvent)
Inheritance
Object
ResponseStreamEvent
ResponseTextDeltaEvent
Implements
IJsonModel<ResponseTextDeltaEvent> IPersistableModel<ResponseTextDeltaEvent> IPersistableModel<T>

Constructors

Name Description
ResponseTextDeltaEvent(Int64, String, Int64, Int64, String, IEnumerable<ResponseLogProb>)

Initializes a new instance of ResponseTextDeltaEvent.

Properties

Name Description
ContentIndex

The index of the content part that the text delta was added to.
Delta

The text delta that was added.
EventType

Gets the event type discriminator (e.g. response.created, response.completed).

(Inherited from ResponseStreamEvent)
ItemId

The ID of the output item that the text delta was added to.
Logprobs

The log probabilities of the tokens in the delta.
OutputIndex

The index of the output item that the text delta was added to.
SequenceNumber

Gets the SequenceNumber.

(Inherited from ResponseStreamEvent)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Explicit(ClientResult to ResponseTextDeltaEvent)

Explicit Interface Implementations

Name Description
IJsonModel<ResponseStreamEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IJsonModel<ResponseStreamEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IJsonModel<ResponseTextDeltaEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ResponseTextDeltaEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ResponseStreamEvent>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.Write(ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseTextDeltaEvent>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ResponseTextDeltaEvent>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ResponseTextDeltaEvent>.Write(ModelReaderWriterOptions)

Extension Methods

Name Description
SnapshotEmbeddedResponse(ResponseStreamEvent, ResponseObject)

If the event is a lifecycle event that embeds a ResponseObject reference, replaces it with an immutable snapshot of the given accumulator. Non-lifecycle events are left unchanged.

Applies to