SongGuess
    Preparing search index...

    Interface Ai_Cf_Deepgram_Nova_3_Input

    interface Ai_Cf_Deepgram_Nova_3_Input {
        audio: { body: object; contentType: string };
        channels?: number;
        custom_intent?: string;
        custom_intent_mode?: "strict" | "extended";
        custom_topic?: string;
        custom_topic_mode?: "strict" | "extended";
        detect_entities?: boolean;
        detect_language?: boolean;
        diarize?: boolean;
        dictation?: boolean;
        encoding?:
            | "flac"
            | "opus"
            | "linear16"
            | "mulaw"
            | "amr-nb"
            | "amr-wb"
            | "speex"
            | "g729";
        endpointing?: string;
        extra?: string;
        filler_words?: boolean;
        interim_results?: boolean;
        keyterm?: string;
        keywords?: string;
        language?: string;
        measurements?: boolean;
        mip_opt_out?: boolean;
        mode?: "general"
        | "medical"
        | "finance";
        multichannel?: boolean;
        numerals?: boolean;
        paragraphs?: boolean;
        profanity_filter?: boolean;
        punctuate?: boolean;
        redact?: string;
        replace?: string;
        search?: string;
        sentiment?: boolean;
        smart_format?: boolean;
        topics?: boolean;
        utt_split?: number;
        utterance_end_ms?: boolean;
        utterances?: boolean;
        vad_events?: boolean;
    }
    Index

    Properties

    audio: { body: object; contentType: string }
    channels?: number

    The number of channels in the submitted audio

    custom_intent?: string

    Custom intents you want the model to detect within your input audio if present

    custom_intent_mode?: "strict" | "extended"

    Sets how the model will interpret intents submitted to the custom_intent param. When strict, the model will only return intents submitted using the custom_intent param. When extended, the model will return its own detected intents in addition those submitted using the custom_intents param

    custom_topic?: string

    Custom topics you want the model to detect within your input audio or text if present Submit up to 100

    custom_topic_mode?: "strict" | "extended"

    Sets how the model will interpret strings submitted to the custom_topic param. When strict, the model will only return topics submitted using the custom_topic param. When extended, the model will return its own detected topics in addition to those submitted using the custom_topic param.

    detect_entities?: boolean

    Identifies and extracts key entities from content in submitted audio

    detect_language?: boolean

    Identifies the dominant language spoken in submitted audio

    diarize?: boolean

    Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0

    dictation?: boolean

    Identify and extract key entities from content in submitted audio

    encoding?:
        | "flac"
        | "opus"
        | "linear16"
        | "mulaw"
        | "amr-nb"
        | "amr-wb"
        | "speex"
        | "g729"

    Specify the expected encoding of your submitted audio

    endpointing?: string

    Indicates how long model will wait to detect whether a speaker has finished speaking or pauses for a significant period of time. When set to a value, the streaming endpoint immediately finalizes the transcription for the processed time range and returns the transcript with a speech_final parameter set to true. Can also be set to false to disable endpointing

    extra?: string

    Arbitrary key-value pairs that are attached to the API response for usage in downstream processing

    filler_words?: boolean

    Filler Words can help transcribe interruptions in your audio, like 'uh' and 'um'

    interim_results?: boolean

    Specifies whether the streaming endpoint should provide ongoing transcription updates as more audio is received. When set to true, the endpoint sends continuous updates, meaning transcription results may evolve over time. Note: Supported only for webosockets.

    keyterm?: string

    Key term prompting can boost or suppress specialized terminology and brands.

    keywords?: string

    Keywords can boost or suppress specialized terminology and brands.

    language?: string

    The BCP-47 language tag that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available.

    measurements?: boolean

    Spoken measurements will be converted to their corresponding abbreviations.

    mip_opt_out?: boolean

    Opts out requests from the Deepgram Model Improvement Program. Refer to our Docs for pricing impacts before setting this to true. https://dpgr.am/deepgram-mip.

    mode?: "general" | "medical" | "finance"

    Mode of operation for the model representing broad area of topic that will be talked about in the supplied audio

    multichannel?: boolean

    Transcribe each audio channel independently.

    numerals?: boolean

    Numerals converts numbers from written format to numerical format.

    paragraphs?: boolean

    Splits audio into paragraphs to improve transcript readability.

    profanity_filter?: boolean

    Profanity Filter looks for recognized profanity and converts it to the nearest recognized non-profane word or removes it from the transcript completely.

    punctuate?: boolean

    Add punctuation and capitalization to the transcript.

    redact?: string

    Redaction removes sensitive information from your transcripts.

    replace?: string

    Search for terms or phrases in submitted audio and replaces them.

    search?: string

    Search for terms or phrases in submitted audio.

    sentiment?: boolean

    Recognizes the sentiment throughout a transcript or text.

    smart_format?: boolean

    Apply formatting to transcript output. When set to true, additional formatting will be applied to transcripts to improve readability.

    topics?: boolean

    Detect topics throughout a transcript or text.

    utt_split?: number

    Seconds to wait before detecting a pause between words in submitted audio.

    utterance_end_ms?: boolean

    Indicates how long model will wait to send an UtteranceEnd message after a word has been transcribed. Use with interim_results. Note: Supported only for webosockets.

    utterances?: boolean

    Segments speech into meaningful semantic units.

    vad_events?: boolean

    Indicates that speech has started. You'll begin receiving Speech Started messages upon speech starting. Note: Supported only for webosockets.