providerplaneai
    Preparing search index...

    Interface ClientAudioTranscriptionRequest

    Interface contract for ClientAudioTranscriptionRequest.

    interface ClientAudioTranscriptionRequest {
        context?: { metadata?: Record<string, unknown>; requestId?: string };
        file: ClientAudioInputSource;
        filename?: string;
        include?: "logprobs"[];
        knownSpeakerNames?: string[];
        language?: string;
        mimeType?: string;
        model?: string;
        options?: Record<string, unknown>;
        prompt?: string;
        responseFormat?: ClientAudioTranscriptionResponseFormat;
        stream?: boolean;
        temperature?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    context? file filename? include? knownSpeakerNames? language? mimeType? model? options? prompt? responseFormat? stream? temperature?

    Properties

    context?: { metadata?: Record<string, unknown>; requestId?: string }

    Execution context (tracing, requestId, etc.) Not sent to the provider.

    file: ClientAudioInputSource

    Audio source to transcribe.

    filename?: string

    Optional filename hint (useful when input is bytes/stream).

    include?: "logprobs"[]

    Optional include flags such as token logprobs for supported providers.

    knownSpeakerNames?: string[]

    Optional known speaker labels for diarization-capable providers.

    language?: string

    Optional input language hint (e.g. "en").

    mimeType?: string

    Optional MIME type hint (e.g. audio/mpeg, audio/wav).

    model?: string
    options?: Record<string, unknown>

    Provider-agnostic tuning options (temperature, max tokens, etc.)

    prompt?: string

    Optional prompt to guide transcription style/terms.

    responseFormat?: ClientAudioTranscriptionResponseFormat

    Requested transcript output format.

    stream?: boolean

    Whether to request a streaming transcription response when supported.

    temperature?: number

    Optional sampling temperature.

    Settings

    Member Visibility

    On This Page

    Properties