xinference.client.handlers.AudioModelHandle.transcriptions#

AudioModelHandle.transcriptions(audio: bytes, language: str | None = None, prompt: str | None = None, response_format: str | None = 'json', temperature: float | None = 0, timestamp_granularities: List[str] | None = None)#

Transcribes audio into the input language.

Parameters:

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

  • language (Optional[str]) – The language of the input audio. Supplying the input language in ISO-639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format will improve accuracy and latency.

  • prompt (Optional[str]) – An optional text to guide the model’s style or continue a previous audio segment. The prompt should match the audio language.

  • response_format (Optional[str], defaults to json) – The format of the transcript output, in one of these options: json, text, srt, verbose_json, or vtt.

  • temperature (Optional[float], 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.

  • timestamp_granularities (Optional[List[str]], default is None.) – 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.

Return type:

The transcribed text.