@deepgram/sdk 1.2.2 → 1.3.1-beta

package/dist/types/liveTranscriptionOptions.d.ts

@@ -1,148 +1,148 @@
-import { Models } from "../enums";
-/**
- * Options for transcription
- */
-export declare 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/model
-     */
-    model?: Models | string;
-    /**
-     * Version of the model to use.
-     * @default latest
-     * @remarks latest OR <version_id>
-     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/version
-     */
-    version: 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/language
-     */
-    language?: string;
-    /**
-     * Indicates whether to add punctuation and capitalization to the transcript.
-     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/punctuate
-     */
-    punctuate?: boolean;
-    /**
-     * Indicates whether to remove profanity from the transcript.
-     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/redact
-     */
-    redact?: Array<string>;
-    /**
-     * Indicates whether to recognize speaker changes. When set to true, each word
-     * in the transcript will be assigned a speaker number starting at 0.
-     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/diarize
-     */
-    diarize?: boolean;
-    /**
-     * 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/numerals
-     */
-    numerals?: 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/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
-     * 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/callback
-     */
-    callback?: 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/keywords
-     */
-    keywords?: Array<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/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/endpointing
-     */
-    endpointing?: boolean;
-    /**
-     * 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
-     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/vad_turnoff
-     */
-    vad_turnoff?: number;
-    /**
-     * Expected encoding of the submitted streaming audio.
-     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/sample_rate
-     */
-    sample_rate?: number;
-};
+import { Models } from "../enums";
+/**
+ * Options for transcription
+ */
+export declare 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/model
+     */
+    model?: Models | string;
+    /**
+     * Version of the model to use.
+     * @default latest
+     * @remarks latest OR <version_id>
+     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/version
+     */
+    version?: 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/language
+     */
+    language?: string;
+    /**
+     * Indicates whether to add punctuation and capitalization to the transcript.
+     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/punctuate
+     */
+    punctuate?: boolean;
+    /**
+     * Indicates whether to remove profanity from the transcript.
+     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/redact
+     */
+    redact?: Array<string>;
+    /**
+     * Indicates whether to recognize speaker changes. When set to true, each word
+     * in the transcript will be assigned a speaker number starting at 0.
+     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/diarize
+     */
+    diarize?: boolean;
+    /**
+     * 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/numerals
+     */
+    numerals?: 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/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
+     * 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/callback
+     */
+    callback?: 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/api-reference/speech-recognition-api#operation/transcribeAudio/properties/keywords
+     */
+    keywords?: Array<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/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/endpointing
+     */
+    endpointing?: boolean;
+    /**
+     * 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
+     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/vad_turnoff
+     */
+    vad_turnoff?: number;
+    /**
+     * Expected encoding of the submitted streaming audio.
+     * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/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/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/sample_rate
+     */
+    sample_rate?: number;
+};

package/dist/types/liveTranscriptionOptions.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=liveTranscriptionOptions.js.map

package/dist/types/liveTranscriptionResponse.d.ts

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

package/dist/types/liveTranscriptionResponse.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=liveTranscriptionResponse.js.map

package/dist/types/member.d.ts

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

package/dist/types/member.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=member.js.map

package/dist/types/memberList.d.ts

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

package/dist/types/memberList.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=memberList.js.map

package/dist/types/memberList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memberList.js","sourceRoot":"","sources":["../../src/types/memberList.ts"],"names":[],"mappings":""}

package/dist/types/message.d.ts

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

package/dist/types/message.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=message.js.map

package/dist/types/message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.js","sourceRoot":"","sources":["../../src/types/message.ts"],"names":[],"mappings":""}

package/dist/types/metadata.d.ts

@@ -1,8 +1,8 @@
-export declare type Metadata = {
-    request_id: string;
-    transaction_key: string;
-    sha256: string;
-    created: string;
-    duration: number;
-    channels: number;
-};
+export declare type Metadata = {
+    request_id: string;
+    transaction_key: string;
+    sha256: string;
+    created: string;
+    duration: number;
+    channels: number;
+};

package/dist/types/metadata.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=metadata.js.map