TimestampGranularities
AudioTranscriptionQuery.swift:12enum TimestampGranularities
enum TimestampGranularities
s6OpenAI23AudioTranscriptionQueryV22TimestampGranularitiesO
What are these?7M89Y
import OpenAI
struct AudioTranscriptionQuery
case word
case segment
init(file: Data, fileType: Self.FileType, model: Model, prompt: String? = nil, temperature: Double? = nil, language: String? = nil, responseFormat: Self.ResponseFormat? = nil, timestampGranularities: [Self.TimestampGranularities] = [])
init(from decoder: any Decoder) throws
let file: Data
The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
let fileType: Self.FileType
let language: String?
The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. https://platform.openai.com/docs/guides/speech-to-text/prompting
let model: Model
ID of the model to use. Only whisper-1 is currently available.
let prompt: String?
An optional text to guide the model’s style or continue a previous audio segment. The prompt should match the audio language.
let responseFormat: Self.ResponseFormat?
The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt. Defaults to json
let temperature: Double?
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. Defaults to 0
let timestampGranularities: [Self.TimestampGranularities]
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. Defaults to segment
enum FileType
enum ResponseFormat
protocol CaseIterable
A type that provides a collection of all of its values.
protocol Decodable
A type that can decode itself from an external representation.
protocol Encodable
A type that can encode itself to an external representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable : Equatable
A type that can be hashed into a Hasher
to produce an integer hash value.
protocol RawRepresentable<RawValue>
A type that can be converted to and from an associated raw value.
init?(rawValue: String)
init(from decoder: any Decoder) throws
Creates a new instance by decoding from the given decoder, when the type’s RawValue
is String
.
var hashValue: Int { get }
static func != (lhs: Self, rhs: Self) -> Bool
Returns a Boolean value indicating whether two values are not equal.
func encode(to encoder: any Encoder) throws
Encodes this value into the given encoder, when the type’s RawValue
is String
.
func hash(into hasher: inout Hasher)