InputAudioTranscriptionRealtimeServerMessage Class

Definition

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

Represents a real-time server message for input audio transcription.

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

Remarks

Used when having InputAudioTranscriptionCompleted, InputAudioTranscriptionDelta, or InputAudioTranscriptionFailed response types.

Constructors

Name Description
InputAudioTranscriptionRealtimeServerMessage(RealtimeServerMessageType)

Initializes a new instance of the InputAudioTranscriptionRealtimeServerMessage class.

Properties

Name Description
ContentIndex

Gets or sets the index of the content part containing the audio.
Error

Gets or sets the error content if an error occurred during transcription.
ItemId

Gets or sets the ID of the item containing the audio that is being transcribed.
MessageId

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

(Inherited from RealtimeServerMessage)
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)
Transcription

Gets or sets the transcription text of the audio.
Type

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

(Inherited from RealtimeServerMessage)
Usage

Gets or sets the transcription-specific usage, which is billed separately from the realtime model.

Applies to