AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Class TranscriptionRequest

    Transcribes audio into the input language.

    Inheritance
    object
    RequestBody
    ModelRequest
    TranscriptionRequest
    Inherited Members
    ModelRequest.Model
    ModelRequest.N
    ModelRequest.Metadata
    ModelRequest.User
    Namespace: Glitch9.AIDevKit.OpenAI
    Assembly: .dll
    Syntax
    public class TranscriptionRequest : ModelRequest
    Remarks

    returns the transcription object or a verbose transcription object.

    Properties

    File

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

    Declaration
    public FormFile File { get; set; }
    Property Value
    Type Description
    FormFile

    Language

    The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency.

    Declaration
    public SystemLanguage? Language { get; set; }
    Property Value
    Type Description
    SystemLanguage?

    Prompt

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

    Declaration
    public string Prompt { get; set; }
    Property Value
    Type Description
    string

    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.

    Declaration
    public float? Temperature { get; set; }
    Property Value
    Type Description
    float?

    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.

    Declaration
    public string[] TimestampGranularities { get; set; }
    Property Value
    Type Description
    string[]
    Remarks

    Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.

    Extension Methods

    RequestExtensions.ExecuteAsync(TranscriptionRequest)
    In this article
    Back to top Generated by DocFX