@deepgram/sdk 5.0.0-beta.3 → 5.0.0

package/dist/esm/api/types/OpenAiSpeakProvider.d.mts

@@ -0,0 +1,27 @@
+export interface OpenAiSpeakProvider {
+    type: "open_ai";
+    /** The REST API version for the OpenAI text-to-speech API */
+    version?: "v1" | undefined;
+    /** OpenAI TTS model */
+    model: OpenAiSpeakProvider.Model;
+    /** OpenAI voice */
+    voice: OpenAiSpeakProvider.Voice;
+}
+export declare namespace OpenAiSpeakProvider {
+    /** OpenAI TTS model */
+    const Model: {
+        readonly Tts1: "tts-1";
+        readonly Tts1Hd: "tts-1-hd";
+    };
+    type Model = (typeof Model)[keyof typeof Model] | string;
+    /** OpenAI voice */
+    const Voice: {
+        readonly Alloy: "alloy";
+        readonly Echo: "echo";
+        readonly Fable: "fable";
+        readonly Onyx: "onyx";
+        readonly Nova: "nova";
+        readonly Shimmer: "shimmer";
+    };
+    type Voice = (typeof Voice)[keyof typeof Voice] | string;
+}

package/dist/esm/api/types/OpenAiSpeakProvider.mjs

@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+export var OpenAiSpeakProvider;
+(function (OpenAiSpeakProvider) {
+    /** OpenAI TTS model */
+    OpenAiSpeakProvider.Model = {
+        Tts1: "tts-1",
+        Tts1Hd: "tts-1-hd",
+    };
+    /** OpenAI voice */
+    OpenAiSpeakProvider.Voice = {
+        Alloy: "alloy",
+        Echo: "echo",
+        Fable: "fable",
+        Onyx: "onyx",
+        Nova: "nova",
+        Shimmer: "shimmer",
+    };
+})(OpenAiSpeakProvider || (OpenAiSpeakProvider = {}));

package/dist/esm/api/types/OpenAiThinkProvider.d.mts

@@ -0,0 +1,23 @@
+export interface OpenAiThinkProvider {
+    type: "open_ai";
+    /** The REST API version for the OpenAI chat completions API */
+    version?: "v1" | undefined;
+    /** OpenAI model to use */
+    model: OpenAiThinkProvider.Model;
+    /** OpenAI temperature (0-2) */
+    temperature?: number | undefined;
+}
+export declare namespace OpenAiThinkProvider {
+    /** OpenAI model to use */
+    const Model: {
+        readonly Gpt5: "gpt-5";
+        readonly Gpt5Mini: "gpt-5-mini";
+        readonly Gpt5Nano: "gpt-5-nano";
+        readonly Gpt41: "gpt-4.1";
+        readonly Gpt41Mini: "gpt-4.1-mini";
+        readonly Gpt41Nano: "gpt-4.1-nano";
+        readonly Gpt4O: "gpt-4o";
+        readonly Gpt4OMini: "gpt-4o-mini";
+    };
+    type Model = (typeof Model)[keyof typeof Model] | string;
+}

package/dist/esm/api/types/OpenAiThinkProvider.mjs

@@ -0,0 +1,15 @@
+// This file was auto-generated by Fern from our API Definition.
+export var OpenAiThinkProvider;
+(function (OpenAiThinkProvider) {
+    /** OpenAI model to use */
+    OpenAiThinkProvider.Model = {
+        Gpt5: "gpt-5",
+        Gpt5Mini: "gpt-5-mini",
+        Gpt5Nano: "gpt-5-nano",
+        Gpt41: "gpt-4.1",
+        Gpt41Mini: "gpt-4.1-mini",
+        Gpt41Nano: "gpt-4.1-nano",
+        Gpt4O: "gpt-4o",
+        Gpt4OMini: "gpt-4o-mini",
+    };
+})(OpenAiThinkProvider || (OpenAiThinkProvider = {}));

package/dist/esm/api/types/ProjectRequestResponse.d.mts

@@ -3,21 +3,21 @@
  */
 export interface ProjectRequestResponse {
     /** The unique identifier of the request */
-    request_id?: string;
+    request_id?: string | undefined;
     /** The unique identifier of the project */
-    project_uuid?: string;
+    project_uuid?: string | undefined;
     /** The date and time the request was created */
-    created?: string;
+    created?: string | undefined;
     /** The API path of the request */
-    path?: string;
+    path?: string | undefined;
     /** The unique identifier of the API key */
-    api_key_id?: string;
+    api_key_id?: string | undefined;
     /** The response of the request */
-    response?: Record<string, unknown>;
+    response?: Record<string, unknown> | undefined;
     /** The response code of the request */
-    code?: number;
+    code?: number | undefined;
     /** The deployment type */
-    deployment?: string;
+    deployment?: string | undefined;
     /** The callback URL for the request */
-    callback?: string;
+    callback?: string | undefined;
 }

package/dist/esm/api/types/ReadV1ResponseMetadata.d.mts

@@ -1,36 +1,36 @@
 export interface ReadV1ResponseMetadata {
-    metadata?: ReadV1ResponseMetadata.Metadata;
+    metadata?: ReadV1ResponseMetadata.Metadata | undefined;
 }
 export declare namespace ReadV1ResponseMetadata {
     interface Metadata {
-        request_id?: string;
-        created?: string;
-        language?: string;
-        summary_info?: Metadata.SummaryInfo;
-        sentiment_info?: Metadata.SentimentInfo;
-        topics_info?: Metadata.TopicsInfo;
-        intents_info?: Metadata.IntentsInfo;
+        request_id?: string | undefined;
+        created?: string | undefined;
+        language?: string | undefined;
+        summary_info?: Metadata.SummaryInfo | undefined;
+        sentiment_info?: Metadata.SentimentInfo | undefined;
+        topics_info?: Metadata.TopicsInfo | undefined;
+        intents_info?: Metadata.IntentsInfo | undefined;
     }
     namespace Metadata {
         interface SummaryInfo {
-            model_uuid?: string;
-            input_tokens?: number;
-            output_tokens?: number;
+            model_uuid?: string | undefined;
+            input_tokens?: number | undefined;
+            output_tokens?: number | undefined;
         }
         interface SentimentInfo {
-            model_uuid?: string;
-            input_tokens?: number;
-            output_tokens?: number;
+            model_uuid?: string | undefined;
+            input_tokens?: number | undefined;
+            output_tokens?: number | undefined;
         }
         interface TopicsInfo {
-            model_uuid?: string;
-            input_tokens?: number;
-            output_tokens?: number;
+            model_uuid?: string | undefined;
+            input_tokens?: number | undefined;
+            output_tokens?: number | undefined;
         }
         interface IntentsInfo {
-            model_uuid?: string;
-            input_tokens?: number;
-            output_tokens?: number;
+            model_uuid?: string | undefined;
+            input_tokens?: number | undefined;
+            output_tokens?: number | undefined;
         }
     }
 }

package/dist/esm/api/types/ReadV1ResponseResults.d.mts

@@ -1,7 +1,7 @@
 import type * as Deepgram from "../index.mjs";
 export interface ReadV1ResponseResults {
-    summary?: Deepgram.ReadV1ResponseResultsSummary;
-    topics?: Deepgram.SharedTopics;
-    intents?: Deepgram.SharedIntents;
-    sentiments?: Deepgram.SharedSentiments;
+    summary?: Deepgram.ReadV1ResponseResultsSummary | undefined;
+    topics?: Deepgram.SharedTopics | undefined;
+    intents?: Deepgram.SharedIntents | undefined;
+    sentiments?: Deepgram.SharedSentiments | undefined;
 }

package/dist/esm/api/types/ReadV1ResponseResultsSummary.d.mts

@@ -2,15 +2,15 @@
  * Output whenever `summary=true` is used
  */
 export interface ReadV1ResponseResultsSummary {
-    results?: ReadV1ResponseResultsSummary.Results;
+    results?: ReadV1ResponseResultsSummary.Results | undefined;
 }
 export declare namespace ReadV1ResponseResultsSummary {
     interface Results {
-        summary?: Results.Summary;
+        summary?: Results.Summary | undefined;
     }
     namespace Results {
         interface Summary {
-            text?: string;
+            text?: string | undefined;
         }
     }
 }

package/dist/esm/api/types/SharedIntents.d.mts

@@ -2,31 +2,31 @@
  * Output whenever `intents=true` is used
  */
 export interface SharedIntents {
-    results?: SharedIntents.Results;
+    results?: SharedIntents.Results | undefined;
 }
 export declare namespace SharedIntents {
     interface Results {
-        intents?: Results.Intents;
+        intents?: Results.Intents | undefined;
     }
     namespace Results {
         interface Intents {
-            segments?: Intents.Segments.Item[];
+            segments?: Intents.Segments.Item[] | undefined;
         }
         namespace Intents {
             type Segments = Segments.Item[];
             namespace Segments {
                 interface Item {
-                    text?: string;
-                    start_word?: number;
-                    end_word?: number;
-                    intents?: Item.Intents.Item[];
+                    text?: string | undefined;
+                    start_word?: number | undefined;
+                    end_word?: number | undefined;
+                    intents?: Item.Intents.Item[] | undefined;
                 }
                 namespace Item {
                     type Intents = Intents.Item[];
                     namespace Intents {
                         interface Item {
-                            intent?: string;
-                            confidence_score?: number;
+                            intent?: string | undefined;
+                            confidence_score?: number | undefined;
                         }
                     }
                 }

package/dist/esm/api/types/SharedSentiments.d.mts

@@ -2,22 +2,22 @@
  * Output whenever `sentiment=true` is used
  */
 export interface SharedSentiments {
-    segments?: SharedSentiments.Segments.Item[];
-    average?: SharedSentiments.Average;
+    segments?: SharedSentiments.Segments.Item[] | undefined;
+    average?: SharedSentiments.Average | undefined;
 }
 export declare namespace SharedSentiments {
     type Segments = Segments.Item[];
     namespace Segments {
         interface Item {
-            text?: string;
-            start_word?: number;
-            end_word?: number;
-            sentiment?: string;
-            sentiment_score?: number;
+            text?: string | undefined;
+            start_word?: number | undefined;
+            end_word?: number | undefined;
+            sentiment?: string | undefined;
+            sentiment_score?: number | undefined;
         }
     }
     interface Average {
-        sentiment?: string;
-        sentiment_score?: number;
+        sentiment?: string | undefined;
+        sentiment_score?: number | undefined;
     }
 }

package/dist/esm/api/types/SharedTopics.d.mts

@@ -2,31 +2,31 @@
  * Output whenever `topics=true` is used
  */
 export interface SharedTopics {
-    results?: SharedTopics.Results;
+    results?: SharedTopics.Results | undefined;
 }
 export declare namespace SharedTopics {
     interface Results {
-        topics?: Results.Topics;
+        topics?: Results.Topics | undefined;
     }
     namespace Results {
         interface Topics {
-            segments?: Topics.Segments.Item[];
+            segments?: Topics.Segments.Item[] | undefined;
         }
         namespace Topics {
             type Segments = Segments.Item[];
             namespace Segments {
                 interface Item {
-                    text?: string;
-                    start_word?: number;
-                    end_word?: number;
-                    topics?: Item.Topics.Item[];
+                    text?: string | undefined;
+                    start_word?: number | undefined;
+                    end_word?: number | undefined;
+                    topics?: Item.Topics.Item[] | undefined;
                 }
                 namespace Item {
                     type Topics = Topics.Item[];
                     namespace Topics {
                         interface Item {
-                            topic?: string;
-                            confidence_score?: number;
+                            topic?: string | undefined;
+                            confidence_score?: number | undefined;
                         }
                     }
                 }

package/dist/esm/api/types/SpeakSettingsV1.d.mts

@@ -5,7 +5,7 @@ export interface SpeakSettingsV1 {
      * Optional if provider is Deepgram. Required for non-Deepgram TTS providers.
      * When present, must include url field and headers object. Valid schemes are https and wss with wss only supported for Eleven Labs.
      */
-    endpoint?: SpeakSettingsV1.Endpoint;
+    endpoint?: SpeakSettingsV1.Endpoint | undefined;
 }
 export declare namespace SpeakSettingsV1 {
     /**
@@ -14,7 +14,7 @@ export declare namespace SpeakSettingsV1 {
      */
     interface Endpoint {
         /** Custom TTS endpoint URL. Cannot contain `output_format` or `model_id` query parameters when the provider is Eleven Labs. */
-        url?: string;
-        headers?: Record<string, string>;
+        url?: string | undefined;
+        headers?: Record<string, string> | undefined;
     }
 }

package/dist/esm/api/types/SpeakSettingsV1Provider.d.mts

@@ -10,7 +10,7 @@ export declare namespace SpeakSettingsV1Provider {
     interface Cartesia extends Deepgram.Cartesia {
         type: "cartesia";
     }
-    interface OpenAi extends Deepgram.OpenAi {
+    interface OpenAi extends Deepgram.OpenAiSpeakProvider {
         type: "open_ai";
     }
     interface AwsPolly extends Deepgram.AwsPollySpeakProvider {

package/dist/esm/api/types/ThinkSettingsV1.d.mts

@@ -1,12 +1,12 @@
+import type * as Deepgram from "../index.mjs";
 export interface ThinkSettingsV1 {
-    /** Think provider configuration (OpenAI, AWS Bedrock, Anthropic, Google, or Groq) */
-    provider: Record<string, unknown>;
+    provider: Deepgram.ThinkSettingsV1Provider;
     /** Optional for non-Deepgram LLM providers. When present, must include url field and headers object */
-    endpoint?: ThinkSettingsV1.Endpoint;
-    functions?: ThinkSettingsV1.Functions.Item[];
-    prompt?: string;
+    endpoint?: ThinkSettingsV1.Endpoint | undefined;
+    functions?: ThinkSettingsV1.Functions.Item[] | undefined;
+    prompt?: string | undefined;
     /** Specifies the number of characters retained in context between user messages, agent responses, and function calls. This setting is only configurable when a custom think endpoint is used */
-    context_length?: ThinkSettingsV1.ContextLength;
+    context_length?: ThinkSettingsV1.ContextLength | undefined;
 }
 export declare namespace ThinkSettingsV1 {
     /**
@@ -14,21 +14,21 @@ export declare namespace ThinkSettingsV1 {
      */
     interface Endpoint {
         /** Custom LLM endpoint URL */
-        url?: string;
+        url?: string | undefined;
         /** Custom headers for the endpoint */
-        headers?: Record<string, string>;
+        headers?: Record<string, string> | undefined;
     }
     type Functions = Functions.Item[];
     namespace Functions {
         interface Item {
             /** Function name */
-            name?: string;
+            name?: string | undefined;
             /** Function description */
-            description?: string;
+            description?: string | undefined;
             /** Function parameters */
-            parameters?: Record<string, unknown>;
+            parameters?: Record<string, unknown> | undefined;
             /** The Function endpoint to call. if not passed, function is called client-side */
-            endpoint?: Item.Endpoint;
+            endpoint?: Item.Endpoint | undefined;
         }
         namespace Item {
             /**
@@ -36,10 +36,10 @@ export declare namespace ThinkSettingsV1 {
              */
             interface Endpoint {
                 /** Endpoint URL */
-                url?: string;
+                url?: string | undefined;
                 /** HTTP method */
-                method?: string;
-                headers?: Record<string, string>;
+                method?: string | undefined;
+                headers?: Record<string, string> | undefined;
             }
         }
     }

package/dist/esm/api/types/ThinkSettingsV1Provider.d.mts

@@ -0,0 +1,19 @@
+import type * as Deepgram from "../index.mjs";
+export type ThinkSettingsV1Provider = Deepgram.ThinkSettingsV1Provider.OpenAi | Deepgram.ThinkSettingsV1Provider.AwsBedrock | Deepgram.ThinkSettingsV1Provider.Anthropic | Deepgram.ThinkSettingsV1Provider.Google | Deepgram.ThinkSettingsV1Provider.Groq;
+export declare namespace ThinkSettingsV1Provider {
+    interface OpenAi extends Deepgram.OpenAiThinkProvider {
+        type: "open_ai";
+    }
+    interface AwsBedrock extends Deepgram.AwsBedrockThinkProvider {
+        type: "aws_bedrock";
+    }
+    interface Anthropic extends Deepgram.Anthropic {
+        type: "anthropic";
+    }
+    interface Google extends Deepgram.Google {
+        type: "google";
+    }
+    interface Groq extends Deepgram.Groq {
+        type: "groq";
+    }
+}

package/dist/esm/api/types/ThinkSettingsV1Provider.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/UpdateProjectMemberScopesV1Response.d.mts

@@ -1,4 +1,4 @@
 export interface UpdateProjectMemberScopesV1Response {
     /** confirmation message */
-    message?: string;
+    message?: string | undefined;
 }

package/dist/esm/api/types/UpdateProjectV1Response.d.mts

@@ -1,4 +1,4 @@
 export interface UpdateProjectV1Response {
     /** confirmation message */
-    message?: string;
+    message?: string | undefined;
 }

package/dist/esm/api/types/UsageBreakdownV1Response.d.mts

@@ -35,23 +35,23 @@ export declare namespace UsageBreakdownV1Response {
         namespace Item {
             interface Grouping {
                 /** Start date for this group */
-                start?: string;
+                start?: string | undefined;
                 /** End date for this group */
-                end?: string;
+                end?: string | undefined;
                 /** Optional accessor identifier */
-                accessor?: string;
+                accessor?: string | undefined;
                 /** Optional endpoint identifier */
-                endpoint?: string;
+                endpoint?: string | undefined;
                 /** Optional feature set identifier */
-                feature_set?: string;
+                feature_set?: string | undefined;
                 /** Optional models identifier */
-                models?: string;
+                models?: string | undefined;
                 /** Optional method identifier */
-                method?: string;
+                method?: string | undefined;
                 /** Optional tags */
-                tags?: string;
+                tags?: string | undefined;
                 /** Optional deployment identifier */
-                deployment?: string;
+                deployment?: string | undefined;
             }
         }
     }

package/dist/esm/api/types/UsageFieldsV1Response.d.mts

@@ -1,25 +1,25 @@
 export interface UsageFieldsV1Response {
     /** List of tags associated with the project */
-    tags?: string[];
+    tags?: string[] | undefined;
     /** List of models available for the project. */
-    models?: UsageFieldsV1Response.Models.Item[];
+    models?: UsageFieldsV1Response.Models.Item[] | undefined;
     /** Processing methods supported by the API */
-    processing_methods?: string[];
+    processing_methods?: string[] | undefined;
     /** API features available to the project */
-    features?: string[];
+    features?: string[] | undefined;
 }
 export declare namespace UsageFieldsV1Response {
     type Models = Models.Item[];
     namespace Models {
         interface Item {
             /** Name of the model. */
-            name?: string;
+            name?: string | undefined;
             /** The language supported by the model (IETF language tag). */
-            language?: string;
+            language?: string | undefined;
             /** Version identifier of the model, typically with a date and a revision number. */
-            version?: string;
+            version?: string | undefined;
             /** Unique identifier for the model. */
-            model_id?: string;
+            model_id?: string | undefined;
         }
     }
 }

package/dist/esm/api/types/UsageV1Response.d.mts

@@ -1,11 +1,11 @@
 export interface UsageV1Response {
-    start?: string;
-    end?: string;
-    resolution?: UsageV1Response.Resolution;
+    start?: string | undefined;
+    end?: string | undefined;
+    resolution?: UsageV1Response.Resolution | undefined;
 }
 export declare namespace UsageV1Response {
     interface Resolution {
-        units?: string;
-        amount?: number;
+        units?: string | undefined;
+        amount?: number | undefined;
     }
 }

package/dist/esm/api/types/index.d.mts

@@ -88,7 +88,8 @@ export * from "./ListProjectMembersV1Response.mjs";
 export * from "./ListProjectPurchasesV1Response.mjs";
 export * from "./ListProjectRequestsV1Response.mjs";
 export * from "./ListProjectsV1Response.mjs";
-export * from "./OpenAi.mjs";
+export * from "./OpenAiSpeakProvider.mjs";
+export * from "./OpenAiThinkProvider.mjs";
 export * from "./ProjectRequestResponse.mjs";
 export * from "./ReadV1Request.mjs";
 export * from "./ReadV1RequestText.mjs";
@@ -108,6 +109,7 @@ export * from "./SpeakV1Model.mjs";
 export * from "./SpeakV1Response.mjs";
 export * from "./SpeakV1SampleRate.mjs";
 export * from "./ThinkSettingsV1.mjs";
+export * from "./ThinkSettingsV1Provider.mjs";
 export * from "./UpdateProjectMemberScopesV1Response.mjs";
 export * from "./UpdateProjectV1Response.mjs";
 export * from "./UsageBreakdownV1Response.mjs";

package/dist/esm/api/types/index.mjs

@@ -88,7 +88,8 @@ export * from "./ListProjectMembersV1Response.mjs";
 export * from "./ListProjectPurchasesV1Response.mjs";
 export * from "./ListProjectRequestsV1Response.mjs";
 export * from "./ListProjectsV1Response.mjs";
-export * from "./OpenAi.mjs";
+export * from "./OpenAiSpeakProvider.mjs";
+export * from "./OpenAiThinkProvider.mjs";
 export * from "./ProjectRequestResponse.mjs";
 export * from "./ReadV1Request.mjs";
 export * from "./ReadV1RequestText.mjs";
@@ -108,6 +109,7 @@ export * from "./SpeakV1Model.mjs";
 export * from "./SpeakV1Response.mjs";
 export * from "./SpeakV1SampleRate.mjs";
 export * from "./ThinkSettingsV1.mjs";
+export * from "./ThinkSettingsV1Provider.mjs";
 export * from "./UpdateProjectMemberScopesV1Response.mjs";
 export * from "./UpdateProjectV1Response.mjs";
 export * from "./UsageBreakdownV1Response.mjs";

package/dist/esm/core/fetcher/Fetcher.mjs

@@ -152,7 +152,13 @@ function getHeaders(args) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a;
         const newHeaders = new Headers();
-        newHeaders.set("Accept", args.responseType === "json" ? "application/json" : args.responseType === "text" ? "text/plain" : "*/*");
+        newHeaders.set("Accept", args.responseType === "json"
+            ? "application/json"
+            : args.responseType === "text"
+                ? "text/plain"
+                : args.responseType === "sse"
+                    ? "text/event-stream"
+                    : "*/*");
         if (args.body !== undefined && args.contentType != null) {
             newHeaders.set("Content-Type", args.contentType);
         }
@@ -196,7 +202,7 @@ export function fetcherImpl(args) {
         }
         try {
             const response = yield requestWithRetries(() => __awaiter(this, void 0, void 0, function* () {
-                return makeRequest(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
+                return makeRequest(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex, args.responseType === "streaming" || args.responseType === "sse");
             }), args.maxRetries);
             if (response.status >= 200 && response.status < 400) {
                 if (logger.isDebug()) {

package/dist/esm/core/fetcher/makeRequest.d.mts

@@ -1 +1,6 @@
-export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half") => Promise<Response>;
+export declare function isCacheNoStoreSupported(): boolean;
+/**
+ * Reset the cached result of `isCacheNoStoreSupported`. Exposed for testing only.
+ */
+export declare function resetCacheNoStoreSupported(): void;
+export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half", disableCache?: boolean) => Promise<Response>;