Class TranscriptionSessionUpdate.Session.InputAudioTranscription
-
- All Implemented Interfaces:
public final class TranscriptionSessionUpdate.Session.InputAudioTranscription
Configuration for input audio transcription. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
TranscriptionSessionUpdate.Session.InputAudioTranscription.Builder
A builder for InputAudioTranscription.
public final class
TranscriptionSessionUpdate.Session.InputAudioTranscription.Model
The model to use for transcription, current options are
gpt-4o-transcribe
,gpt-4o-mini-transcribe
, andwhisper-1
.
-
Method Summary
-
-
Method Detail
-
language
final Optional<String> language()
The language of the input audio. Supplying the input language in ISO-639-1 (e.g.
en
) format will improve accuracy and latency.
-
model
final Optional<TranscriptionSessionUpdate.Session.InputAudioTranscription.Model> model()
The model to use for transcription, current options are
gpt-4o-transcribe
,gpt-4o-mini-transcribe
, andwhisper-1
.
-
prompt
final Optional<String> prompt()
An optional text to guide the model's style or continue a previous audio segment. For
whisper-1
, the prompt is a list of keywords. Forgpt-4o-transcribe
models, the prompt is a free text string, for example "expect words related to technology".
-
_language
final JsonField<String> _language()
Returns the raw JSON value of language.
Unlike language, this method doesn't throw if the JSON field has an unexpected type.
-
_model
final JsonField<TranscriptionSessionUpdate.Session.InputAudioTranscription.Model> _model()
Returns the raw JSON value of model.
Unlike model, this method doesn't throw if the JSON field has an unexpected type.
-
_prompt
final JsonField<String> _prompt()
Returns the raw JSON value of prompt.
Unlike prompt, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final TranscriptionSessionUpdate.Session.InputAudioTranscription.Builder toBuilder()
-
validate
final TranscriptionSessionUpdate.Session.InputAudioTranscription validate()
-
builder
final static TranscriptionSessionUpdate.Session.InputAudioTranscription.Builder builder()
Returns a mutable builder for constructing an instance of InputAudioTranscription.
-
-
-
-