class

OpenAI::CreateTranscriptionRequest

Inherits JSON::Serializable < Reference < Object

Constructors

new(file : String = "", model : CreateTranscriptionRequestModel = "", language : String | Nil = nil, prompt : String | Nil = nil, response_format : AudioResponseFormat | Nil = nil, temperature : Float64 | Nil = nil, include_value : Array(TranscriptionInclude) | Nil = nil, timestamp_granularities : Array(CreateTranscriptionRequestTimestampGranularitiesItem) | Nil = nil, stream : CreateTranscriptionRequestStream | Nil = nil, chunking_strategy : TranscriptionChunkingStrategy | Nil = nil, known_speaker_names : Array(String) | Nil = nil, known_speaker_references : Array(String) | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

chunking_strategy
Source
chunking_strategy=(chunking_strategy : TranscriptionChunkingStrategy | Nil)
Source
file

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

Source
file=(file : String)

The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.

Source
include_value

Additional information to include in the transcription response. logprobs will return the log probabilities of the tokens in the response to understand the model's confidence in the transcription. logprobs only works with response_format set to json and only with the models gpt-4o-transcribe and gpt-4o-mini-transcribe. This field is not supported when using gpt-4o-transcribe-diarize.

Source
include_value=(include_value : Array(TranscriptionInclude) | Nil)

Additional information to include in the transcription response. logprobs will return the log probabilities of the tokens in the response to understand the model's confidence in the transcription. logprobs only works with response_format set to json and only with the models gpt-4o-transcribe and gpt-4o-mini-transcribe. This field is not supported when using gpt-4o-transcribe-diarize.

Source
known_speaker_names

Optional list of speaker names that correspond to the audio samples provided in known_speaker_references[]. Each entry should be a short identifier (for example customer or agent). Up to 4 speakers are supported.

Source
known_speaker_names=(known_speaker_names : Array(String) | Nil)

Optional list of speaker names that correspond to the audio samples provided in known_speaker_references[]. Each entry should be a short identifier (for example customer or agent). Up to 4 speakers are supported.

Source
known_speaker_references

Optional list of audio samples (as data URLs) that contain known speaker references matching known_speaker_names[]. Each sample must be between 2 and 10 seconds, and can use any of the same input audio formats supported by file.

Source
known_speaker_references=(known_speaker_references : Array(String) | Nil)

Optional list of audio samples (as data URLs) that contain known speaker references matching known_speaker_names[]. Each sample must be between 2 and 10 seconds, and can use any of the same input audio formats supported by file.

Source
language

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

Source
language=(language : String | Nil)

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

Source
model

ID of the model to use. The options are gpt-4o-transcribe, gpt-4o-mini-transcribe, whisper-1 (which is powered by our open source Whisper V2 model), and gpt-4o-transcribe-diarize.

Source
model=(model : CreateTranscriptionRequestModel)

ID of the model to use. The options are gpt-4o-transcribe, gpt-4o-mini-transcribe, whisper-1 (which is powered by our open source Whisper V2 model), and gpt-4o-transcribe-diarize.

Source
prompt

An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. This field is not supported when using gpt-4o-transcribe-diarize.

Source
prompt=(prompt : String | Nil)

An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. This field is not supported when using gpt-4o-transcribe-diarize.

Source
response_format
Source
response_format=(response_format : AudioResponseFormat | Nil)
Source
stream
Source
stream=(stream : CreateTranscriptionRequestStream | Nil)
Source
temperature

The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

Source
temperature=(temperature : Float64 | Nil)

The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.

Source
timestamp_granularities

The timestamp granularities to populate for this transcription. response_format must be set verbose_json to use timestamp granularities. Either or both of these options are supported: word, or segment. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. This option is not available for gpt-4o-transcribe-diarize.

Source
timestamp_granularities=(timestamp_granularities : Array(CreateTranscriptionRequestTimestampGranularitiesItem) | Nil)

The timestamp granularities to populate for this transcription. response_format must be set verbose_json to use timestamp granularities. Either or both of these options are supported: word, or segment. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. This option is not available for gpt-4o-transcribe-diarize.

Source