Search
K
OpenAI API

CreateTranslationRequest

object
* Additional properties are NOT allowed.
filestring(binary)required

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

modelAny Of
required

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

Example:whisper-1

Variant 1string
promptstring

An optional text to guide the model’s style or continue a previous audio segment. The prompt should be in English.

response_formatstring

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

Allowed values:jsontextsrtverbose_jsonvtt

Default:json

temperaturenumber

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.

Default:0

Example

CreateTranslationResponseJson

object
textstringrequired
Example

CreateTranslationResponseVerboseJson

object
languagestringrequired

The language of the output translation (always english).

durationnumberrequired

The duration of the input audio.

textstringrequired

The translated text.

segmentsarray[object]

Segments of the translated text and their corresponding details.

Show Child Parameters
Example

CreateUploadRequest

object
* Additional properties are NOT allowed.
filenamestringrequired

The name of the file to upload.

purposestringrequired

The intended purpose of the uploaded file.

See the documentation on File purposes.

Allowed values:assistantsbatchfine-tunevision

bytesintegerrequired

The number of bytes in the file you are uploading.

mime_typestringrequired

The MIME type of the file.

This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.

Example

CreateVectorStoreFileBatchRequest

object
* Additional properties are NOT allowed.
file_idsarray[string]required

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.

>= 1 items<= 500 items

chunking_strategyOne Of
object

The chunking strategy used to chunk the file(s). If not set, will use the auto strategy.

Auto Chunking Strategyobject

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

* Additional properties are NOT allowed.
Show Child Parameters
Example