OutputTextAudioRealtimeServerMessage Class

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v10.4.1
Source:
OutputTextAudioRealtimeServerMessage.cs

Represents a real-time server message for output text and audio.

public ref class OutputTextAudioRealtimeServerMessage : Microsoft::Extensions::AI::RealtimeServerMessage
[System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public class OutputTextAudioRealtimeServerMessage : Microsoft.Extensions.AI.RealtimeServerMessage
public class OutputTextAudioRealtimeServerMessage : Microsoft.Extensions.AI.RealtimeServerMessage
[<System.Diagnostics.CodeAnalysis.Experimental("MEAI001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type OutputTextAudioRealtimeServerMessage = class
    inherit RealtimeServerMessage
type OutputTextAudioRealtimeServerMessage = class
    inherit RealtimeServerMessage
Public Class OutputTextAudioRealtimeServerMessage
Inherits RealtimeServerMessage
Inheritance
Object
RealtimeServerMessage
OutputTextAudioRealtimeServerMessage
Attributes
ExperimentalAttribute

Constructors

Name Description
OutputTextAudioRealtimeServerMessage(RealtimeServerMessageType)

Initializes a new instance of the OutputTextAudioRealtimeServerMessage class for handling output text delta responses.

Properties

Name Description
Audio

Gets or sets the Base64-encoded audio data delta or final audio content.
ContentIndex

Gets or sets the index of the content part whose text has been updated.
ItemId

Gets or sets the ID of the item containing the content part whose text has been updated.
MessageId

Gets or sets the optional message ID associated with the response. This can be used for tracking and correlation purposes.

(Inherited from RealtimeServerMessage)
OutputIndex

Gets or sets the index of the output item in the response.
RawRepresentation

Gets or sets the raw representation of the response. This can be used to hold the original data structure received from the model.

(Inherited from RealtimeServerMessage)
ResponseId

Gets or sets the ID of the response.
Text

Gets or sets the text delta or final text content.
Type

Gets or sets the type of the real-time response.

(Inherited from RealtimeServerMessage)

Applies to