@ai-sdk/deepgram 3.0.0-beta.3 → 3.0.0-beta.31

package/src/deepgram-transcription-model.ts

@@ -1,59 +1,19 @@
-import { SharedV3Warning, TranscriptionModelV3 } from '@ai-sdk/provider';
+import type { SharedV4Warning, TranscriptionModelV4 } from '@ai-sdk/provider';
 import {
   combineHeaders,
   createJsonResponseHandler,
   parseProviderOptions,
   postToApi,
+  serializeModelOptions,
+  WORKFLOW_SERIALIZE,
+  WORKFLOW_DESERIALIZE,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
-import { DeepgramTranscriptionAPITypes } from './deepgram-api-types';
-import { DeepgramConfig } from './deepgram-config';
+import type { DeepgramTranscriptionAPITypes } from './deepgram-api-types';
+import type { DeepgramConfig } from './deepgram-config';
 import { deepgramFailedResponseHandler } from './deepgram-error';
-import { DeepgramTranscriptionModelId } from './deepgram-transcription-options';
-
-// https://developers.deepgram.com/docs/pre-recorded-audio#results
-const deepgramTranscriptionModelOptionsSchema = z.object({
-  /** Language to use for transcription. If not specified, Deepgram defaults to English. Use `detectLanguage: true` to enable automatic language detection. */
-  language: z.string().nullish(),
-  /** Whether to enable automatic language detection. When true, Deepgram will detect the language of the audio. */
-  detectLanguage: z.boolean().nullish(),
-  /** Whether to use smart formatting, which formats written-out numbers, dates, times, etc. */
-  smartFormat: z.boolean().nullish(),
-  /** Whether to add punctuation to the transcript. */
-  punctuate: z.boolean().nullish(),
-  /** Whether to format the transcript into paragraphs. */
-  paragraphs: z.boolean().nullish(),
-  /** Whether to generate a summary of the transcript. Use 'v2' for the latest version or false to disable. */
-  summarize: z.union([z.literal('v2'), z.literal(false)]).nullish(),
-  /** Whether to identify topics in the transcript. */
-  topics: z.boolean().nullish(),
-  /** Whether to identify intents in the transcript. */
-  intents: z.boolean().nullish(),
-  /** Whether to analyze sentiment in the transcript. */
-  sentiment: z.boolean().nullish(),
-  /** Whether to detect and tag named entities in the transcript. */
-  detectEntities: z.boolean().nullish(),
-  /** Specify terms or patterns to redact from the transcript. Can be a string or array of strings. */
-  redact: z.union([z.string(), z.array(z.string())]).nullish(),
-  /** String to replace redacted content with. */
-  replace: z.string().nullish(),
-  /** Term or phrase to search for in the transcript. */
-  search: z.string().nullish(),
-  /** Key term to identify in the transcript. */
-  keyterm: z.string().nullish(),
-  /** Whether to identify different speakers in the audio. */
-  diarize: z.boolean().nullish(),
-  /** Whether to segment the transcript into utterances. */
-  utterances: z.boolean().nullish(),
-  /** Minimum duration of silence (in seconds) to trigger a new utterance. */
-  uttSplit: z.number().nullish(),
-  /** Whether to include filler words (um, uh, etc.) in the transcript. */
-  fillerWords: z.boolean().nullish(),
-});
-
-export type DeepgramTranscriptionModelOptions = z.infer<
-  typeof deepgramTranscriptionModelOptionsSchema
->;
+import { deepgramTranscriptionModelOptionsSchema } from './deepgram-transcription-model-options';
+import type { DeepgramTranscriptionModelId } from './deepgram-transcription-options';
 
 interface DeepgramTranscriptionModelConfig extends DeepgramConfig {
   _internal?: {
@@ -61,13 +21,27 @@ interface DeepgramTranscriptionModelConfig extends DeepgramConfig {
   };
 }
 
-export class DeepgramTranscriptionModel implements TranscriptionModelV3 {
-  readonly specificationVersion = 'v3';
+export class DeepgramTranscriptionModel implements TranscriptionModelV4 {
+  readonly specificationVersion = 'v4';
 
   get provider(): string {
     return this.config.provider;
   }
 
+  static [WORKFLOW_SERIALIZE](model: DeepgramTranscriptionModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: DeepgramTranscriptionModelId;
+    config: DeepgramTranscriptionModelConfig;
+  }) {
+    return new DeepgramTranscriptionModel(options.modelId, options.config);
+  }
+
   constructor(
     readonly modelId: DeepgramTranscriptionModelId,
     private readonly config: DeepgramTranscriptionModelConfig,
@@ -75,8 +49,8 @@ export class DeepgramTranscriptionModel implements TranscriptionModelV3 {
 
   private async getArgs({
     providerOptions,
-  }: Parameters<TranscriptionModelV3['doGenerate']>[0]) {
-    const warnings: SharedV3Warning[] = [];
+  }: Parameters<TranscriptionModelV4['doGenerate']>[0]) {
+    const warnings: SharedV4Warning[] = [];
 
     // Parse provider options
     const deepgramOptions = await parseProviderOptions({
@@ -125,8 +99,8 @@ export class DeepgramTranscriptionModel implements TranscriptionModelV3 {
   }
 
   async doGenerate(
-    options: Parameters<TranscriptionModelV3['doGenerate']>[0],
-  ): Promise<Awaited<ReturnType<TranscriptionModelV3['doGenerate']>>> {
+    options: Parameters<TranscriptionModelV4['doGenerate']>[0],
+  ): Promise<Awaited<ReturnType<TranscriptionModelV4['doGenerate']>>> {
     const currentDate = this.config._internal?.currentDate?.() ?? new Date();
     const { queryParams, warnings } = await this.getArgs(options);
 
@@ -143,7 +117,7 @@ export class DeepgramTranscriptionModel implements TranscriptionModelV3 {
         '?' +
         queryParams.toString(),
       headers: {
-        ...combineHeaders(this.config.headers(), options.headers),
+        ...combineHeaders(this.config.headers?.(), options.headers),
         'Content-Type': options.mediaType,
       },
       body: {

package/src/index.ts

@@ -8,7 +8,7 @@ export type {
   DeepgramSpeechModelOptions,
   /** @deprecated Use `DeepgramSpeechModelOptions` instead. */
   DeepgramSpeechModelOptions as DeepgramSpeechCallOptions,
-} from './deepgram-speech-model';
+} from './deepgram-speech-model-options';
 export type { DeepgramSpeechModelId } from './deepgram-speech-options';
-export type { DeepgramTranscriptionModelOptions } from './deepgram-transcription-model';
+export type { DeepgramTranscriptionModelOptions } from './deepgram-transcription-model-options';
 export { VERSION } from './version';

package/dist/index.d.mts

@@ -1,128 +0,0 @@
-import { TranscriptionModelV3, ProviderV3, SpeechModelV3 } from '@ai-sdk/provider';
-import { FetchFunction } from '@ai-sdk/provider-utils';
-import { z } from 'zod/v4';
-
-type DeepgramConfig = {
-    provider: string;
-    url: (options: {
-        modelId: string;
-        path: string;
-    }) => string;
-    headers: () => Record<string, string | undefined>;
-    fetch?: FetchFunction;
-    generateId?: () => string;
-};
-
-type DeepgramTranscriptionModelId = 'base' | 'base-general' | 'base-meeting' | 'base-phonecall' | 'base-finance' | 'base-conversationalai' | 'base-voicemail' | 'base-video' | 'enhanced' | 'enhanced-general' | 'enhanced-meeting' | 'enhanced-phonecall' | 'enhanced-finance' | 'nova' | 'nova-general' | 'nova-phonecall' | 'nova-medical' | 'nova-2' | 'nova-2-general' | 'nova-2-meeting' | 'nova-2-phonecall' | 'nova-2-finance' | 'nova-2-conversationalai' | 'nova-2-voicemail' | 'nova-2-video' | 'nova-2-medical' | 'nova-2-drivethru' | 'nova-2-automotive' | 'nova-2-atc' | 'nova-3' | 'nova-3-general' | 'nova-3-medical' | (string & {});
-
-declare const deepgramTranscriptionModelOptionsSchema: z.ZodObject<{
-    language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    detectLanguage: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    smartFormat: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    punctuate: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    paragraphs: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    summarize: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodLiteral<"v2">, z.ZodLiteral<false>]>>>;
-    topics: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    intents: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    sentiment: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    detectEntities: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    redact: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
-    replace: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    search: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    keyterm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    diarize: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    utterances: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    uttSplit: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    fillerWords: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-}, z.core.$strip>;
-type DeepgramTranscriptionModelOptions = z.infer<typeof deepgramTranscriptionModelOptionsSchema>;
-interface DeepgramTranscriptionModelConfig extends DeepgramConfig {
-    _internal?: {
-        currentDate?: () => Date;
-    };
-}
-declare class DeepgramTranscriptionModel implements TranscriptionModelV3 {
-    readonly modelId: DeepgramTranscriptionModelId;
-    private readonly config;
-    readonly specificationVersion = "v3";
-    get provider(): string;
-    constructor(modelId: DeepgramTranscriptionModelId, config: DeepgramTranscriptionModelConfig);
-    private getArgs;
-    doGenerate(options: Parameters<TranscriptionModelV3['doGenerate']>[0]): Promise<Awaited<ReturnType<TranscriptionModelV3['doGenerate']>>>;
-}
-
-type DeepgramSpeechModelId = 'aura-asteria-en' | 'aura-2-asteria-en' | 'aura-2-thalia-en' | 'aura-2-helena-en' | 'aura-2-orpheus-en' | 'aura-2-zeus-en' | 'aura-luna-en' | 'aura-stella-en' | (string & {});
-
-interface DeepgramProvider extends ProviderV3 {
-    (modelId: 'nova-3', settings?: {}): {
-        transcription: DeepgramTranscriptionModel;
-    };
-    /**
-     * Creates a model for transcription.
-     */
-    transcription(modelId: DeepgramTranscriptionModelId): TranscriptionModelV3;
-    /**
-     * Creates a model for speech generation.
-     */
-    speech(modelId: DeepgramSpeechModelId): SpeechModelV3;
-    /**
-     * @deprecated Use `embeddingModel` instead.
-     */
-    textEmbeddingModel(modelId: string): never;
-}
-interface DeepgramProviderSettings {
-    /**
-     * API key for authenticating requests.
-     */
-    apiKey?: string;
-    /**
-     * Custom headers to include in the requests.
-     */
-    headers?: Record<string, string>;
-    /**
-     * Custom fetch implementation. You can use it as a middleware to intercept requests,
-     * or to provide a custom fetch implementation for e.g. testing.
-     */
-    fetch?: FetchFunction;
-}
-/**
- * Create an Deepgram provider instance.
- */
-declare function createDeepgram(options?: DeepgramProviderSettings): DeepgramProvider;
-/**
- * Default Deepgram provider instance.
- */
-declare const deepgram: DeepgramProvider;
-
-declare const deepgramSpeechModelOptionsSchema: z.ZodObject<{
-    bitRate: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
-    container: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    encoding: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    sampleRate: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    callback: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    callbackMethod: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-        POST: "POST";
-        PUT: "PUT";
-    }>>>;
-    mipOptOut: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-    tag: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>>;
-}, z.core.$strip>;
-type DeepgramSpeechModelOptions = z.infer<typeof deepgramSpeechModelOptionsSchema>;
-interface DeepgramSpeechModelConfig extends DeepgramConfig {
-    _internal?: {
-        currentDate?: () => Date;
-    };
-}
-declare class DeepgramSpeechModel implements SpeechModelV3 {
-    readonly modelId: DeepgramSpeechModelId;
-    private readonly config;
-    readonly specificationVersion = "v3";
-    get provider(): string;
-    constructor(modelId: DeepgramSpeechModelId, config: DeepgramSpeechModelConfig);
-    private getArgs;
-    doGenerate(options: Parameters<SpeechModelV3['doGenerate']>[0]): Promise<Awaited<ReturnType<SpeechModelV3['doGenerate']>>>;
-}
-
-declare const VERSION: string;
-
-export { type DeepgramProvider, type DeepgramProviderSettings, type DeepgramSpeechModelOptions as DeepgramSpeechCallOptions, DeepgramSpeechModel, type DeepgramSpeechModelId, type DeepgramSpeechModelOptions, type DeepgramTranscriptionModelOptions, VERSION, createDeepgram, deepgram };