openai.createtranscriptionprops
Home > @runlightyear/openai > CreateTranscriptionProps
CreateTranscriptionProps interface
Signature:interface CreateTranscriptionProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| file | string | The audio file to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm. | |
| model | string | ID of the model to use. Only whisper-1 is currently available. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| language? | string | The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. | |
| prompt? | string | An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. | |
| responseFormat? | string | Defaults to json The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt. | |
| temperature? | number | Defaults to 0 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. |