@deepgram/sdk 2.4.0 → 3.0.0-alpha.2

package/dist/types/hit.d.ts

@@ -1,21 +0,0 @@
-/**
- * Represents an identified search term in the transcript
- */
-export type Hit = {
-    /**
-     * Value between 0 and 1 that indicates the model's relative confidence in this hit.
-     */
-    confidence: number;
-    /**
-     * Offset in seconds from the start of the audio to where the hit occurs.
-     */
-    start: number;
-    /**
-     * Offset in seconds from the start of the audio to where the hit ends.
-     */
-    end: number;
-    /**
-     * Transcript that corresponds to the time between start and end.
-     */
-    snippet: string;
-};

package/dist/types/index.d.ts

@@ -1,49 +0,0 @@
-export * from "./alternatives";
-export * from "./balance";
-export * from "./balanceList";
-export * from "./channel";
-export * from "./createKeyOptions";
-export * from "./entity";
-export * from "./hit";
-export * from "./invitationList";
-export * from "./invitationOptions";
-export * from "./key";
-export * from "./keyResponse";
-export * from "./keyResponseObj";
-export * from "./liveTranscriptionOptions";
-export * from "./liveTranscriptionResponse";
-export * from "./member";
-export * from "./memberList";
-export * from "./message";
-export * from "./metadata";
-export * from "./paragraph";
-export * from "./paragraphGroup";
-export * from "./prerecordedTranscriptionOptions";
-export * from "./prerecordedTranscriptionResponse";
-export * from "./project";
-export * from "./projectPatchRequest";
-export * from "./projectPatchResponse";
-export * from "./projectResponse";
-export * from "./requestFunction";
-export * from "./scopeList";
-export * from "./search";
-export * from "./sentence";
-export * from "./summary";
-export * from "./toggleConfigOptions";
-export * from "./topic";
-export * from "./topicGroup";
-export * from "./transcriptionSource";
-export * from "./translation";
-export * from "./usageCallback";
-export * from "./usageField";
-export * from "./usageFieldOptions";
-export * from "./usageOptions";
-export * from "./usageRequest";
-export * from "./usageRequestDetail";
-export * from "./usageRequestList";
-export * from "./usageRequestListOptions";
-export * from "./usageResponse";
-export * from "./usageResponseDetail";
-export * from "./utterance";
-export * from "./wordBase";
-export * from "./error";

package/dist/types/invitationList.d.ts

@@ -1,6 +0,0 @@
-import { InvitationOptions } from "./invitationOptions";
-export type InvitationList = {
-    invites?: Array<InvitationOptions>;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/invitationOptions.d.ts

@@ -1,4 +0,0 @@
-export type InvitationOptions = {
-    email?: string;
-    scope?: string;
-};

package/dist/types/key.d.ts

@@ -1,27 +0,0 @@
-/**
- * API key used for authenticating with the Deepgram API
- */
-export type Key = {
-    /**
-     * Unique identifier of the key to use in API requests
-     */
-    api_key_id: string;
-    /**
-     * API key to send in API requests (Only displayed when first created)
-     */
-    key?: string;
-    /**
-     * Comment for user reference
-     */
-    comment: string;
-    /**
-     * Timestamp of the date/time the key was created
-     */
-    created: string;
-    /**
-     * Array of scopes assigned to the key
-     */
-    scopes: Array<string>;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/keyResponse.d.ts

@@ -1,12 +0,0 @@
-import { KeyResponseObj } from "./keyResponseObj";
-/**
- * Response from the Deepgram API to list keys
- */
-export type KeyResponse = {
-    /**
-     * Array of API keys associated with the project
-     */
-    api_keys: Array<KeyResponseObj>;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/keyResponseObj.d.ts

@@ -1,42 +0,0 @@
-import { Key } from "./key";
-import { Member } from "./member";
-export type KeyResponseObj = {
-    /**
-     * Optional member associated with the API key
-     */
-    member?: Member;
-    /**
-     * API key
-     */
-    api_key: Key;
-    /**
-     * Unique identifier of the key to use in API requests
-     * @deprecated This property has moved to api_key.api_key_id and will
-     * be removed in future versions.
-     */
-    api_key_id: string;
-    /**
-     * API key to send in API requests (Only displayed when first created)
-     * @deprecated This property has moved to api_key.key and will
-     * be removed in future versions.
-     */
-    key?: string;
-    /**
-     * Comment for user reference
-     * @deprecated This property has moved to api_key.comment and will
-     * be removed in future versions.
-     */
-    comment: string;
-    /**
-     * Timestamp of the date/time the key was created
-     * @deprecated This property has moved to api_key.created and will
-     * be removed in future versions.
-     */
-    created: string;
-    /**
-     * Array of scopes assigned to the key
-     * @deprecated This property has moved to api_key.scopes and will
-     * be removed in future versions.
-     */
-    scopes: Array<string>;
-};

package/dist/types/keyword.d.ts

@@ -1,4 +0,0 @@
-export type Keyword = {
-    keyword: string;
-    boost?: number;
-};

package/dist/types/liveTranscriptionOptions.d.ts

@@ -1,238 +0,0 @@
-import { Models } from "../enums";
-/**
- * Options for transcription
- */
-export type LiveTranscriptionOptions = {
-    /**
-     * 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 the streaming endpoint should send you updates to its
-     * transcription as more audio becomes available. By default, the streaming
-     * endpoint returns regular updates, which means transcription results will
-     * likely change for a period of time. You can avoid receiving these updates
-     * by setting this flag to false.
-     * @see https://developers.deepgram.com/documentation/features/interim-results/
-     */
-    interim_results?: boolean;
-    /**
-     * Indicates whether Deepgram will detect whether a speaker has finished
-     * speaking (or paused for a significant period of time, indicating the
-     * completion of an idea). When Deepgram detects an endpoint, it assumes
-     * that no additional data will improve its prediction, so it immediately
-     * finalizes the result for the processed time range and returns the
-     * transcript with a speech_final parameter set to true.
-     
-     * @see https://developers.deepgram.com/documentation/features/endpointing/
-  
-     */
-    endpointing?: boolean | number;
-    /**
-     * Length of time in milliseconds of silence that voice activation detection
-     * (VAD) will use to detect that a speaker has finished speaking. Used when
-     * endpointing is enabled. Defaults to 10 ms. Deepgram customers may configure
-     * a value between 10 ms and 500 ms; on-premise customers may remove this
-     * restriction.
-     * @default 10
-     */
-    vad_turnoff?: number;
-    /**
-     * Expected encoding of the submitted streaming audio.
-     * @see https://developers.deepgram.com/documentation/features/encoding/
-     */
-    encoding?: string;
-    /**
-     * Number of independent audio channels contained in submitted streaming
-     * audio. Only read when a value is provided for encoding.
-     * @default 1
-     * @see https://developers.deepgram.com/documentation/features/channels/
-     */
-    channels?: number;
-    /**
-     * Sample rate of submitted streaming audio. Required (and only read)
-     * when a value is provided for encoding.
-     * @see https://developers.deepgram.com/documentation/features/sample-rate/
-     */
-    sample_rate?: number;
-    /**
-     * 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 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/liveTranscriptionResponse.d.ts

@@ -1,9 +0,0 @@
-import { Channel } from "./channel";
-export type LiveTranscriptionResponse = {
-    channel_index: Array<number>;
-    duration: number;
-    start: number;
-    is_final: boolean;
-    speech_final: boolean;
-    channel: Channel;
-};

package/dist/types/member.d.ts

@@ -1,7 +0,0 @@
-export type Member = {
-    member_id: string;
-    first_name?: string;
-    last_name?: string;
-    scopes?: Array<string>;
-    email: string;
-};

package/dist/types/memberList.d.ts

@@ -1,6 +0,0 @@
-import { Member } from "./member";
-export type MemberList = {
-    members?: Array<Member>;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/message.d.ts

@@ -1,5 +0,0 @@
-export type Message = {
-    message?: string;
-    err_code?: string;
-    err_msg?: string;
-};

package/dist/types/metadata.d.ts

@@ -1,18 +0,0 @@
-import { Warning } from "./warning";
-export type Metadata = {
-    request_id: string;
-    transaction_key: string;
-    sha256: string;
-    created: string;
-    duration: number;
-    channels: number;
-    model_info: {
-        [key: string]: {
-            name: string;
-            version: string;
-            arch: string;
-        };
-    };
-    warnings?: Array<Warning>;
-    models: Array<string>;
-};

package/dist/types/paragraph.d.ts

@@ -1,19 +0,0 @@
-import { Sentence } from "./sentence";
-export type Paragraph = {
-    /**
-     * Sentences within the paragraph.
-     */
-    sentences: Array<Sentence>;
-    /**
-     * Start time (in seconds) from the start of the audio to where the paragraph starts.
-     */
-    start: number;
-    /**
-     * End time (in seconds) from the start of the audio to where the paragraph ends.
-     */
-    end: number;
-    /**
-     * Number of words in the paragraph
-     */
-    num_words: number;
-};

package/dist/types/paragraphGroup.d.ts

@@ -1,11 +0,0 @@
-import { Paragraph } from "./paragraph";
-export type ParagraphGroup = {
-    /**
-     * Full transcript
-     */
-    transcript: string;
-    /**
-     * Array of Paragraph objects.
-     */
-    paragraphs: Array<Paragraph>;
-};