@deepgram/sdk 2.4.0 → 3.0.0-alpha.2

package/dist/types/prerecordedTranscriptionOptions.d.ts

@@ -1,252 +0,0 @@
-import { Models } from "../enums";
-/**
- * Options for transcription
- */
-export type PrerecordedTranscriptionOptions = {
-    /**
-     * AI model used to process submitted audio.
-     * @default general
-     * @remarks Possible values are general, phonecall, meeting or a custom string
-     * @see https://developers.deepgram.com/documentation/features/model/
-     */
-    model?: Models | string;
-    /**
-     * Version of the model to use.
-     * @default latest
-     * @remarks latest OR <version_id>
-     * @see https://developers.deepgram.com/documentation/features/version/
-     */
-    version?: string;
-    /**
-     * Tier of the model to use.
-     * @default base
-     * @remarks Possible values are base or enhanced
-     * @see https://developers.deepgram.com/documentation/features/tier/
-     */
-    tier?: string;
-    /**
-     * BCP-47 language tag that hints at the primary spoken language.
-     * @default en-US
-     * @remarks Possible values are en-GB, en-IN, en-NZ, en-US, es, fr, ko, pt,
-     * pt-BR, ru, tr or null
-     * @see https://developers.deepgram.com/documentation/features/language/
-     */
-    language?: string;
-    /**
-     * Indicates whether to add punctuation and capitalization to the transcript.
-     * @see https://developers.deepgram.com/documentation/features/punctuate/
-     */
-    punctuate?: boolean;
-    /**
-     * Indicates whether to remove profanity from the transcript.
-     * @see https://developers.deepgram.com/documentation/features/profanity-filter/
-     */
-    profanity_filter?: boolean;
-    /**
-     * Indicates whether to redact sensitive information, replacing redacted content with asterisks (*).
-     * @remarks Options include:
-     *  `pci`: Redacts sensitive credit card information, including credit card number, expiration date, and CVV
-     *  `numbers` (or `true)`: Aggressively redacts strings of numerals
-     *  `ssn` (*beta*): Redacts social security numbers
-     * @see https://developers.deepgram.com/documentation/features/redact/
-     */
-    redact?: Array<string> | Array<boolean> | boolean;
-    /**
-     * Indicates whether to recognize speaker changes. When passed in, each word
-     * in the transcript will be assigned a speaker number starting at 0.
-     * If 'true' is passed, the latest version of the diarizer  will be used.
-     * To use an old version of the diarizer, pass in the version in the `diarize_version` option.
-     * @see https://developers.deepgram.com/documentation/features/diarize/
-     */
-    diarize?: boolean;
-    /**
-     * Indicates which version of the diarizer to use. When passed in, each word
-     * in the transcript will be assigned a speaker number starting at 0.
-     * Ex: YYYY-MM-DD.X where YYYY-MM-DD is the version date and X is the version number.
-     * @see https://developers.deepgram.com/documentation/features/diarize/
-     */
-    diarize_version?: string;
-    /**
-     * Indicates whether to transcribe each audio channel independently. When set
-     * to true, you will receive one transcript for each channel, which means you
-     * can apply a different model to each channel using the model parameter (e.g.,
-     * set model to general:phonecall, which applies the general model to channel
-     * 0 and the phonecall model to channel 1).
-     * @see https://developers.deepgram.com/documentation/features/multichannel/
-     */
-    multichannel?: boolean;
-    /**
-     * Maximum number of transcript alternatives to return. Just like a human listener,
-     * Deepgram can provide multiple possible interpretations of what it hears.
-     * @default 1
-     */
-    alternatives?: number;
-    /**
-     * Indicates whether to convert numbers from written format (e.g., one) to
-     * numerical format (e.g., 1). Deepgram can format numbers up to 999,999.
-     * @remarks Converted numbers do not include punctuation. For example,
-     * 999,999 would be transcribed as 999999.
-     * @see https://developers.deepgram.com/documentation/features/numerals/
-     */
-    numbers?: boolean;
-    /**
-     * Same as numbers. Is the old name for the option. Will eventually be deprecated
-     */
-    numerals?: boolean;
-    /**
-     * adds spaces between numbers in the transcript
-     */
-    numbers_spaces?: boolean;
-    /**
-     * Callback URL to provide if you would like your submitted audio to be
-     * processed asynchronously. When passed, Deepgram will immediately respond
-     * with a request_id. When it has finished analyzing the audio, it will send
-     * a POST request to the provided URL with an appropriate HTTP status code.
-     * @remarks You may embed basic authentication credentials in the callback URL.
-     * Only ports 80, 443, 8080, and 8443 can be used for callbacks.
-     * @see https://developers.deepgram.com/documentation/features/callback/
-     */
-    callback?: string;
-    /**
-     * Terms or phrases to search for in the submitted audio and replace
-     * @remarks Can send multiple instances in query string replace=this:that&replace=thisalso:thatalso. Replacing a term or phrase with nothing will remove the term or phrase from the audio transcript.
-     * @see https://developers.deepgram.com/documentation/features/replace/
-     */
-    replace?: string[] | string;
-    /**
-     * Terms or phrases to search for in the submitted audio. Deepgram searches
-     * for acoustic patterns in audio rather than text patterns in transcripts
-     * because we have noticed that acoustic pattern matching is more performant.
-     * @see https://developers.deepgram.com/documentation/features/search/
-     */
-    search?: string[] | string;
-    /**
-     * Keywords to which the model should pay particular attention to boosting
-     * or suppressing to help it understand context. Just like a human listener,
-     * Deepgram can better understand mumbled, distorted, or otherwise
-     * hard-to-decipher speech when it knows the context of the conversation.
-     * @see https://developers.deepgram.com/documentation/features/keywords/
-     */
-    keywords?: string[] | string;
-    /**
-     * Support for out-of-vocabulary (OOV) keyword boosting when processing streaming audio is
-     * currently in beta; to fall back to previous keyword behavior append the query parameter
-     * keyword_boost=legacy to your API request.
-     */
-    keyword_boost?: string;
-    /**
-     * Indicates whether Deepgram will segment speech into meaningful semantic
-     * units, which allows the model to interact more naturally and effectively
-     * with speakers' spontaneous speech patterns. For example, when humans
-     * speak to each other conversationally, they often pause mid-sentence to
-     * reformulate their thoughts, or stop and restart a badly-worded sentence.
-     * When utterances is set to true, these utterances are identified and
-     * returned in the transcript results.
-     *
-     * By default, when utterances is enabled, it starts a new utterance after
-     * 0.8 s of silence. You can customize the length of time used to determine
-     * where to split utterances by submitting the utt_split parameter.
-     * @see https://developers.deepgram.com/documentation/features/utterances/
-     */
-    utterances?: boolean;
-    /**
-     * Length of time in seconds of silence between words that Deepgram will
-     * use when determining where to split utterances. Used when utterances
-     * is enabled.
-     * @default 0.8 seconds
-     * @see https://developers.deepgram.com/documentation/features/utterance-split/
-     */
-    utt_split?: number;
-    /**
-     * Detects the language of the recorded audio and passes audio through appropriate model
-     *
-     *
-     * @see https://developers.deepgram.com/documentation/features/detect-language/
-     */
-    detect_language?: boolean;
-    /**
-     * Indicates whether Deepgram will split audio into paragraphs to improve transcript
-     * readability. When paragraphs is set to true, you must also set either punctuate,
-     * diarize, or multichannel to true.
-     */
-    paragraphs?: boolean;
-    /**
-     * Indicates whether Deepgram will Identify and detect entities in the transcript
-     * This is a beta feature and is is subject to change. Right now, pass in the string "latest" instead of a boolean value
-     */
-    detect_entities?: boolean;
-    /**
-     * Indicates whether Deepgram should provide summarizations of sections of the provided audio.
-     */
-    summarize?: boolean | string;
-    /**
-     * Corresponds to the language code Deepgram will translate the results into
-     * For example, 'es', 'fr', 'ja'
-     * If requests translation in the same language as their ASR request, a 400 will be returned.
-     */
-    translate?: Array<string>;
-    /**
-     * Indicates whether Deepgram will identify and detect topics in the transcript.
-     */
-    detect_topics?: boolean;
-    /**
-     * Indicates whether Deepgram will identify sentiment in the audio.
-     */
-    sentiment?: boolean;
-    /**
-     * Indicates whether Deepgram will identify sentiment in the transcript.
-     */
-    analyze_sentiment?: boolean;
-    /**
-     * Indicates the confidence requirement for non-neutral sentiment.
-     * Setting this variable turns sentiment analysis on.
-     */
-    sentiment_threshold?: number;
-    /**
-     * Indicates whether to convert dates from written format (e.g., january first) to
-     * numerical format (e.g., 01-01).
-     */
-    dates?: boolean;
-    /**
-     * Indicates the format the dates will be converted to. Requires dates to be turned on.
-     * Format string is specified using chrono strftime notation https://docs.rs/chrono/latest/chrono/format/strftime/index.html   *
-     * @example %Y-%m-%d
-     */
-    date_format?: string;
-    /**
-     * Indicates whether to convert times from written format (e.g., three oclock) to
-     * numerical format (e.g., 3:00).
-     * 	*/
-    times?: boolean;
-    /**
-     * Option to format punctuated commands
-     * Before - “i went to the store period new paragraph then i went home”
-     * After - “i went to the store. <\n> then i went home”
-     */
-    dictation?: boolean;
-    /**
-     * Option to format measurements in the transcript
-     * */
-    measurements?: boolean;
-    /**
-     * Indicates whether to use Smart Format on the transcript. When enabled,
-     * Smart Format will add punctuation and formatting to entities like dates, times,
-     * tracking numbers, and more.
-     * */
-    smart_format?: boolean;
-    /**
-     * allows you to label your API requests for the purpose of identification during usage reporting.
-     * You can also apply tags to API Keys; if you do, any tags applied to the API Key running the API request
-     * will also be applied to the request itself.
-     * */
-    tag?: Array<string>;
-    ner?: boolean;
-    /**
-     * @see https://developers.deepgram.com/docs/filler-words
-     */
-    filler_words?: boolean;
-    /**
-     * allow arbitrary unknown key/value pairs to be passed through the SDK to the API
-     */
-    [key: string]: unknown;
-};

package/dist/types/prerecordedTranscriptionResponse.d.ts

@@ -1,29 +0,0 @@
-import { Metadata } from "./metadata";
-import { Channel } from "./channel";
-import { Utterance } from "./utterance";
-export declare class PrerecordedTranscriptionResponse {
-    err_code?: string;
-    err_msg?: string;
-    request_id?: string;
-    metadata?: Metadata;
-    results?: {
-        channels: Array<Channel>;
-        utterances?: Array<Utterance>;
-        summary?: {
-            result: "success" | "failure";
-            short: string;
-        };
-    };
-    /**
-     * Returns a VTT formatted string based on the transcription response.
-     * @param {number} lineLength The maximum line length. Default: 8
-     * @returns {string}
-     */
-    toWebVTT(lineLength?: number): string;
-    /**
-     * Returns a SRT formatted string based on the transcription response.
-     * @param {number} lineLength The maximum line length. Default: 8
-     * @returns {string}
-     */
-    toSRT(lineLength?: number): string;
-}

package/dist/types/project.d.ts

@@ -1,19 +0,0 @@
-/**
- * Deepgram project
- */
-export type Project = {
-    /**
-     * Unique identifier of the project
-     */
-    project_id: string;
-    /**
-     * User provided name of the project
-     */
-    name?: string;
-    /**
-     * Name of the company associated with the project. Optional.
-     */
-    company?: string;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/projectPatchRequest.d.ts

@@ -1,4 +0,0 @@
-export type ProjectPatchRequest = {
-    name?: string;
-    company?: string;
-};

package/dist/types/projectPatchResponse.d.ts

@@ -1,8 +0,0 @@
-export type ProjectPatchResponse = {
-    /**
-     * Success message.
-     */
-    message: string;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/projectResponse.d.ts

@@ -1,6 +0,0 @@
-import { Project } from "./project";
-export type ProjectResponse = {
-    projects: Array<Project>;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/requestFunction.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { ReadStream } from "fs";
-export type RequestFunction = NodeRequest | BrowserRequest;
-export type NodeRequest = (method: string, apiKey: string, apiUrl: string, requireSSL: boolean, path: string, payload?: string | Buffer | ReadStream, options?: Object) => Promise<any>;
-export type BrowserRequest = (method: string, apiKey: string, apiUrl: string, requireSSL: boolean, path: string, payload?: string) => Promise<any>;

package/dist/types/scopeList.d.ts

@@ -1,5 +0,0 @@
-export type ScopeList = {
-    scopes: Array<string>;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/search.d.ts

@@ -1,14 +0,0 @@
-import { Hit } from "./hit";
-/**
- * Search result for a transcription
- */
-export type Search = {
-    /**
-     * Term for which Deepgram is searching.
-     */
-    query: string;
-    /**
-     * Instances of query found in transcript
-     */
-    hits: Array<Hit>;
-};

package/dist/types/sentence.d.ts

@@ -1,14 +0,0 @@
-export type Sentence = {
-    /**
-     * Text transcript of the sentence.
-     */
-    text: string;
-    /**
-     * Start time (in seconds) from the start of the audio to where the sentence starts.
-     */
-    start: number;
-    /**
-     * End time (in seconds) from the start of the audio to where the sentence ends.
-     */
-    end: number;
-};

package/dist/types/summary.d.ts

@@ -1,17 +0,0 @@
-/**
- * Summary of a section of audio provided.
- */
-export type Summary = {
-    /**
-     * Summary of a section of the transcript
-     */
-    summary?: string;
-    /**
-     * Word position in transcript where the summary begins
-     */
-    start_word?: number;
-    /**
-     * Word position in transcript where the summary ends
-     */
-    end_word?: number;
-};

package/dist/types/toggleConfigOptions.d.ts

@@ -1,3 +0,0 @@
-export type ToggleConfigOptions = {
-    numerals: boolean;
-};

package/dist/types/topic.d.ts

@@ -1,10 +0,0 @@
-export type Topic = {
-    /**
-     * Topic detected.
-     */
-    topic: string;
-    /**
-     * Value between 0 and 1 indicating the model's relative confidence in this topic.
-     */
-    confidence: number;
-};

package/dist/types/topicGroup.d.ts

@@ -1,19 +0,0 @@
-import { Topic } from "./topic";
-export type TopicGroup = {
-    /**
-     * Array of Topics identified.
-     */
-    topics: Array<Topic>;
-    /**
-     * Transcript covered by the topic.
-     */
-    text: string;
-    /**
-     * Word position in transcript where the topic begins
-     */
-    start_word: number;
-    /**
-     * Word position in transcript where the topic ends
-     */
-    end_word: number;
-};

package/dist/types/transcriptionSource.d.ts

@@ -1,15 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { Readable } from "stream";
-export type TranscriptionSource = UrlSource | BufferSource | ReadStreamSource;
-export type ReadStreamSource = {
-    stream: Readable;
-    mimetype: string;
-};
-export type UrlSource = {
-    url: string;
-};
-export type BufferSource = {
-    buffer: Buffer;
-    mimetype: string;
-};

package/dist/types/translation.d.ts

@@ -1,10 +0,0 @@
-export type Translation = {
-    /**
-     * Language code of the translation.
-     */
-    language: string;
-    /**
-     * Translated transcript.
-     */
-    translation: string;
-};

package/dist/types/usageCallback.d.ts

@@ -1,4 +0,0 @@
-export type UsageCallback = {
-    code: number;
-    completed: string;
-};

package/dist/types/usageField.d.ts

@@ -1,9 +0,0 @@
-export type UsageField = {
-    tags: Array<string>;
-    models: Array<string>;
-    processing_methods: Array<string>;
-    languages: Array<string>;
-    features: Array<string>;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/usageFieldOptions.d.ts

@@ -1,4 +0,0 @@
-export type UsageFieldOptions = {
-    start?: string;
-    end?: string;
-};

package/dist/types/usageRequest.d.ts

@@ -1,13 +0,0 @@
-import { UsageCallback } from "./usageCallback";
-import { UsageRequestDetail } from "./usageRequestDetail";
-import { UsageRequestMessage } from "./usageRequestMessage";
-export type UsageRequest = {
-    request_id: string;
-    created: string;
-    path: string;
-    accessor: string;
-    response?: UsageRequestDetail | UsageRequestMessage;
-    callback?: UsageCallback;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/usageRequestDetail.d.ts

@@ -1,33 +0,0 @@
-export type UsageRequestDetail = {
-    details: {
-        usd: number;
-        duration: number;
-        total_audio: number;
-        channels: number;
-        streams: number;
-        model: string;
-        method: "sync" | "async" | "streaming";
-        tags: Array<string>;
-        features: Array<string>;
-        config: {
-            multichannel?: boolean;
-            interim_results?: boolean;
-            punctuate?: boolean;
-            ner?: boolean;
-            utterances?: boolean;
-            replace?: boolean;
-            profanity_filter?: boolean;
-            keywords?: boolean;
-            sentiment?: boolean;
-            diarize?: boolean;
-            detect_language?: boolean;
-            search?: boolean;
-            redact?: boolean;
-            alternatives?: boolean;
-            numerals?: boolean;
-            numbers?: boolean;
-            smart_format?: boolean;
-            translate?: boolean;
-        };
-    };
-};

package/dist/types/usageRequestList.d.ts

@@ -1,8 +0,0 @@
-import { UsageRequest } from "./usageRequest";
-export type UsageRequestList = {
-    page: number;
-    limit: number;
-    requests?: Array<UsageRequest>;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/usageRequestListOptions.d.ts

@@ -1,7 +0,0 @@
-export type UsageRequestListOptions = {
-    start?: string;
-    end?: string;
-    page?: number;
-    limit?: number;
-    status?: "succeeded" | "failed";
-};

package/dist/types/usageRequestMessage.d.ts

@@ -1,3 +0,0 @@
-export type UsageRequestMessage = {
-    message?: string;
-};

package/dist/types/usageResponse.d.ts

@@ -1,12 +0,0 @@
-import { UsageResponseDetail } from "./usageResponseDetail";
-export type UsageResponse = {
-    start: string;
-    end: string;
-    resolution: {
-        units: string;
-        amount: number;
-    };
-    results: Array<UsageResponseDetail>;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/usageResponseDetail.d.ts

@@ -1,6 +0,0 @@
-export type UsageResponseDetail = {
-    start: string;
-    end: string;
-    hours: number;
-    requests: number;
-};

package/dist/types/utterance.d.ts

@@ -1,39 +0,0 @@
-import { WordBase } from "./wordBase";
-export type Utterance = {
-    /**
-     * Start time (in seconds) from the beginning of the audio stream.
-     */
-    start: number;
-    /**
-     * End time (in seconds) from the beginning of the audio stream.
-     */
-    end: number;
-    /**
-     * Floating point value between 0 and 1 that indicates overall transcript
-     * reliability. Larger values indicate higher confidence.
-     */
-    confidence: number;
-    /**
-     * Audio channel to which the utterance belongs. When using multichannel audio,
-     * utterances are chronologically ordered by channel.
-     */
-    channel: number;
-    /**
-     *  Transcript for the audio segment being processed.
-     */
-    transcript: string;
-    /**
-     * Object containing each word in the transcript, along with its start time
-     * and end time (in seconds) from the beginning of the audio stream, and a confidence value.
-     */
-    words: Array<WordBase>;
-    /**
-     * Integer indicating the predicted speaker of the majority of words
-     * in the utterance who is saying the words being processed.
-     */
-    speaker?: number;
-    /**
-     * Unique identifier of the utterance
-     */
-    id: string;
-};

package/dist/types/warning.d.ts

@@ -1,5 +0,0 @@
-export type Warning = {
-    parameter: string;
-    type: "unsupported_language" | "unsupported_model" | "unsupported_encoding" | "deprecated";
-    message: string;
-};

package/dist/types/wordBase.d.ts

@@ -1,9 +0,0 @@
-export type WordBase = {
-    word: string;
-    start: number;
-    end: number;
-    confidence: number;
-    punctuated_word?: string;
-    speaker?: number;
-    speaker_confidence?: number;
-};