RealtimeTranscriptionSessionCreateRequest class

Request for creating a realtime transcription session via HTTP.

Transcription sessions are optimized for audio-to-text scenarios without generating audio responses.

Example

final response = await client.realtimeSessions.createTranscription(
  RealtimeTranscriptionSessionCreateRequest(
    inputAudioFormat: RealtimeAudioFormat.pcm16,
    inputAudioTranscription: InputAudioTranscription(model: 'whisper-1'),
  ),
);

print('Client secret: ${response.clientSecret.value}');
Annotations
  • @immutable

Constructors

RealtimeTranscriptionSessionCreateRequest({RealtimeAudioFormat? inputAudioFormat, InputAudioTranscription? inputAudioTranscription, TurnDetection? turnDetection, NoiseReductionConfig? inputAudioNoiseReduction})
Creates a RealtimeTranscriptionSessionCreateRequest.
const
RealtimeTranscriptionSessionCreateRequest.fromJson(Map<String, dynamic> json)
Creates a RealtimeTranscriptionSessionCreateRequest from JSON.
factory

Properties

hashCode → int
The hash code for this object.
no setteroverride
inputAudioFormat → RealtimeAudioFormat?
Input audio format.
final
inputAudioNoiseReduction → NoiseReductionConfig?
Input audio noise reduction configuration.
final
inputAudioTranscription → InputAudioTranscription?
Configuration for input audio transcription.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
turnDetection → TurnDetection?
Turn detection configuration.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts to JSON.
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override