Constructor Detail

Method Detail

• file

   final AudioTranscriptionCreateParams.Builder file(InputStream 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.

• file

   final AudioTranscriptionCreateParams.Builder file(MultipartField<InputStream> 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.

• file

   final AudioTranscriptionCreateParams.Builder file(ByteArray 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.

• file

   final AudioTranscriptionCreateParams.Builder file(Path 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.

• model

   final AudioTranscriptionCreateParams.Builder model(AudioModel model)

  ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.

• model

   final AudioTranscriptionCreateParams.Builder model(MultipartField<AudioModel> model)

  ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.

• model

   final AudioTranscriptionCreateParams.Builder model(String value)

  ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.

• language

   final AudioTranscriptionCreateParams.Builder language(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.

• language

   final AudioTranscriptionCreateParams.Builder language(MultipartField<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.

• prompt

   final AudioTranscriptionCreateParams.Builder prompt(String prompt)

  An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.

• prompt

   final AudioTranscriptionCreateParams.Builder prompt(MultipartField<String> prompt)

  An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.

• responseFormat

   final AudioTranscriptionCreateParams.Builder responseFormat(AudioResponseFormat responseFormat)

  The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.

• responseFormat

   final AudioTranscriptionCreateParams.Builder responseFormat(MultipartField<AudioResponseFormat> responseFormat)

  The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.

• temperature

   final AudioTranscriptionCreateParams.Builder temperature(Double 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.

• temperature

   final AudioTranscriptionCreateParams.Builder temperature(MultipartField<Double> 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.

• timestampGranularities

   final AudioTranscriptionCreateParams.Builder timestampGranularities(List<AudioTranscriptionCreateParams.TimestampGranularity> 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.

• timestampGranularities

   final AudioTranscriptionCreateParams.Builder timestampGranularities(MultipartField<List<AudioTranscriptionCreateParams.TimestampGranularity>> 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.

• addTimestampGranularity

   final AudioTranscriptionCreateParams.Builder addTimestampGranularity(AudioTranscriptionCreateParams.TimestampGranularity timestampGranularity)

  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.

• additionalHeaders

   final AudioTranscriptionCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final AudioTranscriptionCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final AudioTranscriptionCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final AudioTranscriptionCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final AudioTranscriptionCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final AudioTranscriptionCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final AudioTranscriptionCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final AudioTranscriptionCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final AudioTranscriptionCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final AudioTranscriptionCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final AudioTranscriptionCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final AudioTranscriptionCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final AudioTranscriptionCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final AudioTranscriptionCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final AudioTranscriptionCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final AudioTranscriptionCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final AudioTranscriptionCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final AudioTranscriptionCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final AudioTranscriptionCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final AudioTranscriptionCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final AudioTranscriptionCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final AudioTranscriptionCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final AudioTranscriptionCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final AudioTranscriptionCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final AudioTranscriptionCreateParams build()