@deepgram/sdk 2.1.1 → 2.3.0

package/dist/projects.d.ts

@@ -9,32 +9,32 @@ export declare class Projects {
      * Returns all projects accessible by the API key.
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<ProjectResponse | ErrorResponse>}
+     * @returns {Promise<ProjectResponse>}
      */
-    list(endpoint?: string): Promise<ProjectResponse | ErrorResponse>;
+    list(endpoint?: string): Promise<ProjectResponse>;
     /**
      * Retrieves a specific project based on the provided project_id.
      * @param {string} projectId Unique identifier of the project
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<Project | ErrorResponse>}
+     * @returns {Promise<Project>}
      */
-    get(projectId: string, endpoint?: string): Promise<Project | ErrorResponse>;
+    get(projectId: string, endpoint?: string): Promise<Project>;
     /**
      * Update a project.
-     * @param {Project} project Project to update
+     * @param {string | Project} project Project to update
      * @param {ProjectPatchRequest} payload Details to change as an object
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<ProjectPatchResponse | ErrorResponse>}
+     * @returns {Promise<ProjectPatchResponse>}
      */
-    update(project: Project, payload: ProjectPatchRequest, endpoint?: string): Promise<ProjectPatchResponse | ErrorResponse>;
+    update(project: string | Project, payload: ProjectPatchRequest, endpoint?: string): Promise<ProjectPatchResponse>;
     /**
      * Delete a project.
      * @param {string} projectId Unique identifier of the project
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<Message | ErrorResponse>}
+     * @returns {Promise<void | ErrorResponse>}
      */
     delete(projectId: string, endpoint?: string): Promise<void | ErrorResponse>;
 }

package/dist/scopes.d.ts

@@ -1,4 +1,4 @@
-import { ScopeList, Message, RequestFunction, ErrorResponse } from "./types";
+import { ScopeList, Message, RequestFunction } from "./types";
 export declare class Scopes {
     private _credentials;
     private _apiUrl;
@@ -11,9 +11,9 @@ export declare class Scopes {
      * @param {string} memberId Unique identifier of the member
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<ScopeList | ErrorResponse>}
+     * @returns {Promise<ScopeList>}
      */
-    get(projectId: string, memberId: string, endpoint?: string): Promise<ScopeList | ErrorResponse>;
+    get(projectId: string, memberId: string, endpoint?: string): Promise<ScopeList>;
     /**
      * Updates the scope for the specified member in the specified project.
      * @param {string} projectId Unique identifier of the project
@@ -21,7 +21,7 @@ export declare class Scopes {
      * @param {string} scope Scope to update the member to
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<Message | ErrorResponse>}
+     * @returns {Promise<Message>}
      */
-    update(projectID: string, memberId: string, scope: string, endpoint?: string): Promise<Message | ErrorResponse>;
+    update(projectID: string, memberId: string, scope: string, endpoint?: string): Promise<Message>;
 }

package/dist/transcription/index.d.ts

@@ -1,4 +1,4 @@
-import { LiveTranscriptionOptions, PrerecordedTranscriptionOptions, PrerecordedTranscriptionResponse, TranscriptionSource, ErrorResponse } from "../types";
+import { LiveTranscriptionOptions, PrerecordedTranscriptionOptions, PrerecordedTranscriptionResponse, TranscriptionSource } from "../types";
 import { LiveTranscription } from "./liveTranscription";
 export declare class Transcriber {
     private _credentials;
@@ -11,15 +11,15 @@ export declare class Transcriber {
      * @param {PrerecordedTranscriptionOptions} options Options used to toggle transcription features
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {Promise<PrerecordedTranscriptionResponse | ErrorResponse>}
+     * @returns {Promise<PrerecordedTranscriptionResponse>}
      */
-    preRecorded(source: TranscriptionSource, options?: PrerecordedTranscriptionOptions, endpoint?: string): Promise<PrerecordedTranscriptionResponse | ErrorResponse>;
+    preRecorded(source: TranscriptionSource, options?: PrerecordedTranscriptionOptions, endpoint?: string): Promise<PrerecordedTranscriptionResponse>;
     /**
      * Opens a websocket to Deepgram's API for live transcriptions
      * @param {LiveTranscriptionOptions} options Options used to toggle transcription features
      * @param {string} endpoint Custom API endpoint
      *
-     * @returns {LiveTranscription | ErrorResponse}
+     * @returns {LiveTranscription}
      */
-    live(options?: LiveTranscriptionOptions, endpoint?: string): LiveTranscription | ErrorResponse;
+    live(options?: LiveTranscriptionOptions, endpoint?: string): LiveTranscription;
 }

package/dist/transcription/liveTranscription.d.ts

@@ -7,6 +7,7 @@ export declare class LiveTranscription extends EventEmitter {
     constructor(credentials: string, apiUrl: string, requireSSL: boolean, options?: LiveTranscriptionOptions, endpoint?: string);
     private _bindSocketEvents;
     configure(config: ToggleConfigOptions): void;
+    keepAlive(): void;
     /**
      * Returns the ready state of the websocket connection
      */

package/dist/transcription/preRecordedTranscription.d.ts

@@ -10,4 +10,4 @@ import { PrerecordedTranscriptionOptions, PrerecordedTranscriptionResponse, Tran
  * @param options string
  * @returns Promise<PrerecordedTranscriptionResponse>
  */
-export declare const preRecordedTranscription: (apiKey: string, apiUrl: string, requireSSL: boolean, source: TranscriptionSource, options?: PrerecordedTranscriptionOptions | undefined, endpoint?: string) => Promise<PrerecordedTranscriptionResponse>;
+export declare const preRecordedTranscription: (apiKey: string, apiUrl: string, requireSSL: boolean, source: TranscriptionSource, options?: PrerecordedTranscriptionOptions, endpoint?: string) => Promise<PrerecordedTranscriptionResponse>;

package/dist/types/alternatives.d.ts

@@ -4,7 +4,7 @@ import { Entity } from "./entity";
 import { Summary } from "./summary";
 import { Translation } from "./translation";
 import { TopicGroup } from "./topicGroup";
-export declare type Alternative = {
+export type Alternative = {
     /**
      * Text of speech identified by API
      */

package/dist/types/balance.d.ts

@@ -1,6 +1,8 @@
-export declare type Balance = {
+export type Balance = {
     balance_id: string;
     amount: number;
     units: string;
     purchase: string;
+    err_code?: string;
+    err_msg?: string;
 };

package/dist/types/balanceList.d.ts

@@ -1,4 +1,6 @@
 import { Balance } from "./balance";
-export declare type BalanceList = {
+export type BalanceList = {
     balances?: Array<Balance>;
+    err_code?: string;
+    err_msg?: string;
 };

package/dist/types/channel.d.ts

@@ -3,7 +3,7 @@ import { Search } from "./search";
 /**
  * Channel of speech identified by Deepgram
  */
-export declare type Channel = {
+export type Channel = {
     /**
      * Searched terms & results
      */

package/dist/types/createKeyOptions.d.ts

@@ -1,7 +1,7 @@
 /**
  * Optional options used when creating an API key
  */
-export declare type CreateKeyOptions = {
+export type CreateKeyOptions = {
     /**
      * Date on which the key you would like to create should expire.
      */

package/dist/types/entity.d.ts

@@ -1,4 +1,4 @@
-export declare type Entity = {
+export type Entity = {
     /**
      * This is the type of the entity.
      * Examples include: PER, ORG, DATE, etc.

package/dist/types/error.d.ts

@@ -1,4 +1,4 @@
-export declare type ErrorResponse = {
+export type ErrorResponse = {
     err_code: string;
     err_msg: string;
     request_id: string;

package/dist/types/hit.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents an identified search term in the transcript
  */
-export declare type Hit = {
+export type Hit = {
     /**
      * Value between 0 and 1 that indicates the model's relative confidence in this hit.
      */

package/dist/types/invitationList.d.ts

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

package/dist/types/invitationOptions.d.ts

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

package/dist/types/key.d.ts

@@ -1,7 +1,7 @@
 /**
  * API key used for authenticating with the Deepgram API
  */
-export declare type Key = {
+export type Key = {
     /**
      * Unique identifier of the key to use in API requests
      */
@@ -22,4 +22,6 @@ export declare type Key = {
      * Array of scopes assigned to the key
      */
     scopes: Array<string>;
+    err_code?: string;
+    err_msg?: string;
 };

package/dist/types/keyResponse.d.ts

@@ -2,9 +2,11 @@ import { KeyResponseObj } from "./keyResponseObj";
 /**
  * Response from the Deepgram API to list keys
  */
-export declare type KeyResponse = {
+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,6 +1,6 @@
 import { Key } from "./key";
 import { Member } from "./member";
-export declare type KeyResponseObj = {
+export type KeyResponseObj = {
     /**
      * Optional member associated with the API key
      */

package/dist/types/keyword.d.ts

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

package/dist/types/liveTranscriptionOptions.d.ts

@@ -2,7 +2,7 @@ import { Models } from "../enums";
 /**
  * Options for transcription
  */
-export declare type LiveTranscriptionOptions = {
+export type LiveTranscriptionOptions = {
     /**
      * AI model used to process submitted audio.
      * @default general
@@ -24,12 +24,6 @@ export declare type LiveTranscriptionOptions = {
      * @see https://developers.deepgram.com/documentation/features/tier/
      */
     tier?: 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;
     /**
      * BCP-47 language tag that hints at the primary spoken language.
      * @default en-US
@@ -103,13 +97,6 @@ export declare type LiveTranscriptionOptions = {
      * adds spaces between numbers in the transcript
      */
     numbers_spaces?: boolean;
-    /**
-     * 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?: Array<string>;
     /**
      * Callback URL to provide if you would like your submitted audio to be
      * processed asynchronously. When passed, Deepgram will immediately respond
@@ -120,6 +107,19 @@ export declare type LiveTranscriptionOptions = {
      * @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,
@@ -127,7 +127,7 @@ export declare type LiveTranscriptionOptions = {
      * hard-to-decipher speech when it knows the context of the conversation.
      * @see https://developers.deepgram.com/documentation/features/keywords/
      */
-    keywords?: Array<string>;
+    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

package/dist/types/liveTranscriptionResponse.d.ts

@@ -1,5 +1,5 @@
 import { Channel } from "./channel";
-export declare type LiveTranscriptionResponse = {
+export type LiveTranscriptionResponse = {
     channel_index: Array<number>;
     duration: number;
     start: number;

package/dist/types/member.d.ts

@@ -1,4 +1,4 @@
-export declare type Member = {
+export type Member = {
     member_id: string;
     first_name?: string;
     last_name?: string;

package/dist/types/memberList.d.ts

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

package/dist/types/message.d.ts

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

package/dist/types/metadata.d.ts

@@ -1,8 +1,18 @@
-export declare type Metadata = {
+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,5 +1,5 @@
 import { Sentence } from "./sentence";
-export declare type Paragraph = {
+export type Paragraph = {
     /**
      * Sentences within the paragraph.
      */

package/dist/types/paragraphGroup.d.ts

@@ -1,5 +1,5 @@
 import { Paragraph } from "./paragraph";
-export declare type ParagraphGroup = {
+export type ParagraphGroup = {
     /**
      * Full transcript
      */

package/dist/types/prerecordedTranscriptionOptions.d.ts

@@ -2,7 +2,7 @@ import { Models } from "../enums";
 /**
  * Options for transcription
  */
-export declare type PrerecordedTranscriptionOptions = {
+export type PrerecordedTranscriptionOptions = {
     /**
      * AI model used to process submitted audio.
      * @default general
@@ -24,12 +24,6 @@ export declare type PrerecordedTranscriptionOptions = {
      * @see https://developers.deepgram.com/documentation/features/tier/
      */
     tier?: 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;
     /**
      * BCP-47 language tag that hints at the primary spoken language.
      * @default en-US
@@ -103,13 +97,6 @@ export declare type PrerecordedTranscriptionOptions = {
      * adds spaces between numbers in the transcript
      */
     numbers_spaces?: boolean;
-    /**
-     * 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?: Array<string>;
     /**
      * Callback URL to provide if you would like your submitted audio to be
      * processed asynchronously. When passed, Deepgram will immediately respond
@@ -120,6 +107,19 @@ export declare type PrerecordedTranscriptionOptions = {
      * @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,
@@ -127,7 +127,7 @@ export declare type PrerecordedTranscriptionOptions = {
      * hard-to-decipher speech when it knows the context of the conversation.
      * @see https://developers.deepgram.com/documentation/features/keywords/
      */
-    keywords?: Array<string>;
+    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
@@ -178,7 +178,7 @@ export declare type PrerecordedTranscriptionOptions = {
     /**
      * Indicates whether Deepgram should provide summarizations of sections of the provided audio.
      */
-    summarize?: boolean;
+    summarize?: boolean | string;
     /**
      * Corresponds to the language code Deepgram will translate the results into
      * For example, 'es', 'fr', 'ja'

package/dist/types/prerecordedTranscriptionResponse.d.ts

@@ -2,24 +2,28 @@ 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;
+        };
     };
     /**
-     * Converts the transcription to the WebVTT format
-     * @remarks In order to translate the transcription to WebVTT, the utterances
-     * feature must be used.
-     * @returns A string with the transcription in the WebVTT format
+     * Returns a VTT formatted string based on the transcription response.
+     * @param {number} lineLength The maximum line length. Default: 8
+     * @returns {string}
      */
-    toWebVTT(): string;
+    toWebVTT(lineLength?: number): string;
     /**
-     * Converts the transcription to the SRT format
-     * @remarks In order to translate the transcription to SRT, the utterances
-     * feature must be used.
-     * @returns A string with the transcription in the SRT format
+     * Returns a SRT formatted string based on the transcription response.
+     * @param {number} lineLength The maximum line length. Default: 8
+     * @returns {string}
      */
-    toSRT(): string;
+    toSRT(lineLength?: number): string;
 }

package/dist/types/project.d.ts

@@ -1,7 +1,7 @@
 /**
  * Deepgram project
  */
-export declare type Project = {
+export type Project = {
     /**
      * Unique identifier of the project
      */
@@ -14,4 +14,6 @@ export declare type Project = {
      * 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 +1,4 @@
-export declare type ProjectPatchRequest = {
+export type ProjectPatchRequest = {
     name?: string;
     company?: string;
 };

package/dist/types/projectPatchResponse.d.ts

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

package/dist/types/projectResponse.d.ts

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

package/dist/types/requestFunction.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { ReadStream } from "fs";
-export declare type RequestFunction = NodeRequest | BrowserRequest;
-export declare type NodeRequest = (method: string, apiKey: string, apiUrl: string, requireSSL: boolean, path: string, payload?: string | Buffer | ReadStream, options?: Object) => Promise<any>;
-export declare type BrowserRequest = (method: string, apiKey: string, apiUrl: string, requireSSL: boolean, path: string, payload?: string) => Promise<any>;
+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,3 +1,5 @@
-export declare type ScopeList = {
+export type ScopeList = {
     scopes: Array<string>;
+    err_code?: string;
+    err_msg?: string;
 };

package/dist/types/search.d.ts

@@ -2,7 +2,7 @@ import { Hit } from "./hit";
 /**
  * Search result for a transcription
  */
-export declare type Search = {
+export type Search = {
     /**
      * Term for which Deepgram is searching.
      */

package/dist/types/sentence.d.ts

@@ -1,4 +1,4 @@
-export declare type Sentence = {
+export type Sentence = {
     /**
      * Text transcript of the sentence.
      */

package/dist/types/summary.d.ts

@@ -1,7 +1,7 @@
 /**
  * Summary of a section of audio provided.
  */
-export declare type Summary = {
+export type Summary = {
     /**
      * Summary of a section of the transcript
      */

package/dist/types/toggleConfigOptions.d.ts

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

package/dist/types/topic.d.ts

@@ -1,4 +1,4 @@
-export declare type Topic = {
+export type Topic = {
     /**
      * Topic detected.
      */

package/dist/types/topicGroup.d.ts

@@ -1,5 +1,5 @@
 import { Topic } from "./topic";
-export declare type TopicGroup = {
+export type TopicGroup = {
     /**
      * Array of Topics identified.
      */

package/dist/types/transcriptionSource.d.ts

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

package/dist/types/translation.d.ts

@@ -1,4 +1,4 @@
-export declare type Translation = {
+export type Translation = {
     /**
      * Language code of the translation.
      */

package/dist/types/usageCallback.d.ts

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