ResponseAudioDeltaEvent Class

Definition

Emitted when there is a partial audio response.

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

Constructors

Name Description
ResponseAudioDeltaEvent(Int64, BinaryData)

Initializes a new instance of ResponseAudioDeltaEvent.

Properties

Name Description
Delta

A chunk of Base64 encoded response audio bytes.

To assign a byte[] to this property use FromBytes(Byte[]). The byte[] will be serialized to a Base64 encoded string.

Examples:

  • BinaryData.FromBytes(new byte[] { 1, 2, 3 }). : Creates a payload of "AQID".

EventType

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

(Inherited from ResponseStreamEvent)
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 ResponseAudioDeltaEvent)

Explicit Interface Implementations

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

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