@ai-sdk/hume 3.0.0-beta.20 → 3.0.0-beta.21

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @ai-sdk/hume
 
+## 3.0.0-beta.21
+
+### Patch Changes
+
+- b3976a2: Add workflow serialization support to all provider models.
+
+  **`@ai-sdk/provider-utils`:** New `serializeModel()` helper that extracts only serializable properties from a model instance, filtering out functions and objects containing functions. Third-party provider authors can use this to add workflow support to their own models.
+
+  **All providers:** `headers` is now optional in provider config types. This is non-breaking — existing code that passes `headers` continues to work. Custom provider implementations that construct model configs manually can now omit `headers`, which is useful when models are deserialized from a workflow step boundary where auth is provided separately.
+
+  All provider model classes now include `WORKFLOW_SERIALIZE` and `WORKFLOW_DESERIALIZE` static methods, enabling them to cross workflow step boundaries without serialization errors.
+
+- Updated dependencies [b3976a2]
+- Updated dependencies [ff5eba1]
+  - @ai-sdk/provider-utils@5.0.0-beta.20
+  - @ai-sdk/provider@4.0.0-beta.12
+
 ## 3.0.0-beta.20
 
 ### Major Changes

package/dist/index.d.ts

@@ -1,5 +1,6 @@
+import * as _ai_sdk_provider from '@ai-sdk/provider';
 import { SpeechModelV4, ProviderV4 } from '@ai-sdk/provider';
-import { FetchFunction } from '@ai-sdk/provider-utils';
+import { FetchFunction, WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
 type HumeConfig = {
@@ -8,7 +9,7 @@ type HumeConfig = {
         modelId: string;
         path: string;
     }) => string;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     fetch?: FetchFunction;
     generateId?: () => string;
 };
@@ -49,6 +50,14 @@ declare class HumeSpeechModel implements SpeechModelV4 {
     private readonly config;
     readonly specificationVersion = "v4";
     get provider(): string;
+    static [WORKFLOW_SERIALIZE](model: HumeSpeechModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: '';
+        config: HumeSpeechModelConfig;
+    }): HumeSpeechModel;
     constructor(modelId: '', config: HumeSpeechModelConfig);
     private getArgs;
     doGenerate(options: Parameters<SpeechModelV4['doGenerate']>[0]): Promise<Awaited<ReturnType<SpeechModelV4['doGenerate']>>>;

package/dist/index.js

@@ -9,7 +9,10 @@ import {
   combineHeaders,
   createBinaryResponseHandler,
   parseProviderOptions,
-  postJsonToApi
+  postJsonToApi,
+  serializeModelOptions,
+  WORKFLOW_SERIALIZE,
+  WORKFLOW_DESERIALIZE
 } from "@ai-sdk/provider-utils";
 import { z as z2 } from "zod/v4";
 
@@ -92,7 +95,7 @@ var humeSpeechModelOptionsSchema = z2.object({
     })
   ).nullish()
 });
-var HumeSpeechModel = class {
+var HumeSpeechModel = class _HumeSpeechModel {
   constructor(modelId, config) {
     this.modelId = modelId;
     this.config = config;
@@ -101,6 +104,15 @@ var HumeSpeechModel = class {
   get provider() {
     return this.config.provider;
   }
+  static [WORKFLOW_SERIALIZE](model) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config
+    });
+  }
+  static [WORKFLOW_DESERIALIZE](options) {
+    return new _HumeSpeechModel(options.modelId, options.config);
+  }
   async getArgs({
     text,
     voice = "d8ab67c6-953d-4bd8-9370-8fa53a0f1453",
@@ -180,7 +192,7 @@ var HumeSpeechModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d, _e;
     const currentDate = (_c = (_b = (_a = this.config._internal) == null ? void 0 : _a.currentDate) == null ? void 0 : _b.call(_a)) != null ? _c : /* @__PURE__ */ new Date();
     const { requestBody, warnings } = await this.getArgs(options);
     const {
@@ -192,7 +204,7 @@ var HumeSpeechModel = class {
         path: "/v0/tts/file",
         modelId: this.modelId
       }),
-      headers: combineHeaders(this.config.headers(), options.headers),
+      headers: combineHeaders((_e = (_d = this.config).headers) == null ? void 0 : _e.call(_d), options.headers),
       body: requestBody,
       failedResponseHandler: humeFailedResponseHandler,
       successfulResponseHandler: createBinaryResponseHandler(),
@@ -216,7 +228,7 @@ var HumeSpeechModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.0-beta.20" : "0.0.0-test";
+var VERSION = true ? "3.0.0-beta.21" : "0.0.0-test";
 
 // src/hume-provider.ts
 function createHume(options = {}) {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/hume-provider.ts","../src/hume-speech-model.ts","../src/hume-error.ts","../src/version.ts"],"sourcesContent":["import { SpeechModelV4, ProviderV4 } from '@ai-sdk/provider';\nimport {\n  FetchFunction,\n  loadApiKey,\n  withUserAgentSuffix,\n} from '@ai-sdk/provider-utils';\nimport { HumeSpeechModel } from './hume-speech-model';\nimport { VERSION } from './version';\n\nexport interface HumeProvider extends Pick<ProviderV4, 'speechModel'> {\n  (settings?: {}): {\n    speech: HumeSpeechModel;\n  };\n\n  /**\n   * Creates a model for speech synthesis.\n   */\n  speech(): SpeechModelV4;\n}\n\nexport interface HumeProviderSettings {\n  /**\n   * API key for authenticating requests.\n   */\n  apiKey?: string;\n\n  /**\n   * Custom headers to include in the requests.\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * Custom fetch implementation. You can use it as a middleware to intercept requests,\n   * or to provide a custom fetch implementation for e.g. testing.\n   */\n  fetch?: FetchFunction;\n}\n\n/**\n * Create an Hume provider instance.\n */\nexport function createHume(options: HumeProviderSettings = {}): HumeProvider {\n  const getHeaders = () =>\n    withUserAgentSuffix(\n      {\n        'X-Hume-Api-Key': loadApiKey({\n          apiKey: options.apiKey,\n          environmentVariableName: 'HUME_API_KEY',\n          description: 'Hume',\n        }),\n        ...options.headers,\n      },\n      `ai-sdk/hume/${VERSION}`,\n    );\n\n  const createSpeechModel = () =>\n    new HumeSpeechModel('', {\n      provider: `hume.speech`,\n      url: ({ path }) => `https://api.hume.ai${path}`,\n      headers: getHeaders,\n      fetch: options.fetch,\n    });\n\n  const provider = function () {\n    return {\n      speech: createSpeechModel(),\n    };\n  };\n\n  provider.speech = createSpeechModel;\n  provider.speechModel = createSpeechModel;\n\n  return provider satisfies HumeProvider;\n}\n\n/**\n * Default Hume provider instance.\n */\nexport const hume = createHume();\n","import { SpeechModelV4, SharedV4Warning } from '@ai-sdk/provider';\nimport {\n  combineHeaders,\n  createBinaryResponseHandler,\n  parseProviderOptions,\n  postJsonToApi,\n} from '@ai-sdk/provider-utils';\nimport { z } from 'zod/v4';\nimport { HumeConfig } from './hume-config';\nimport { humeFailedResponseHandler } from './hume-error';\nimport { HumeSpeechAPITypes } from './hume-api-types';\n\n// https://dev.hume.ai/reference/text-to-speech-tts/synthesize-file\nconst humeSpeechModelOptionsSchema = z.object({\n  /**\n   * Context for the speech synthesis request.\n   * Can be either a generationId for retrieving a previous generation,\n   * or a list of utterances to synthesize.\n   */\n  context: z\n    .object({\n      /**\n       * ID of a previously generated speech synthesis to retrieve.\n       */\n      generationId: z.string(),\n    })\n    .or(\n      z.object({\n        /**\n         * List of utterances to synthesize into speech.\n         */\n        utterances: z.array(\n          z.object({\n            /**\n             * The text content to convert to speech.\n             */\n            text: z.string(),\n            /**\n             * Optional description or instructions for how the text should be spoken.\n             */\n            description: z.string().optional(),\n            /**\n             * Optional speech rate multiplier.\n             */\n            speed: z.number().optional(),\n            /**\n             * Optional duration of silence to add after the utterance in seconds.\n             */\n            trailingSilence: z.number().optional(),\n            /**\n             * Voice configuration for the utterance.\n             * Can be specified by ID or name.\n             */\n            voice: z\n              .object({\n                /**\n                 * ID of the voice to use.\n                 */\n                id: z.string(),\n                /**\n                 * Provider of the voice, either Hume's built-in voices or a custom voice.\n                 */\n                provider: z.enum(['HUME_AI', 'CUSTOM_VOICE']).optional(),\n              })\n              .or(\n                z.object({\n                  /**\n                   * Name of the voice to use.\n                   */\n                  name: z.string(),\n                  /**\n                   * Provider of the voice, either Hume's built-in voices or a custom voice.\n                   */\n                  provider: z.enum(['HUME_AI', 'CUSTOM_VOICE']).optional(),\n                }),\n              )\n              .optional(),\n          }),\n        ),\n      }),\n    )\n    .nullish(),\n});\n\nexport type HumeSpeechModelOptions = z.infer<\n  typeof humeSpeechModelOptionsSchema\n>;\n\ninterface HumeSpeechModelConfig extends HumeConfig {\n  _internal?: {\n    currentDate?: () => Date;\n  };\n}\n\nexport class HumeSpeechModel implements SpeechModelV4 {\n  readonly specificationVersion = 'v4';\n\n  get provider(): string {\n    return this.config.provider;\n  }\n\n  constructor(\n    readonly modelId: '',\n    private readonly config: HumeSpeechModelConfig,\n  ) {}\n\n  private async getArgs({\n    text,\n    voice = 'd8ab67c6-953d-4bd8-9370-8fa53a0f1453',\n    outputFormat = 'mp3',\n    speed,\n    instructions,\n    language,\n    providerOptions,\n  }: Parameters<SpeechModelV4['doGenerate']>[0]) {\n    const warnings: SharedV4Warning[] = [];\n\n    // Parse provider options\n    const humeOptions = await parseProviderOptions({\n      provider: 'hume',\n      providerOptions,\n      schema: humeSpeechModelOptionsSchema,\n    });\n\n    // Create request body\n    const requestBody: HumeSpeechAPITypes = {\n      utterances: [\n        {\n          text,\n          speed,\n          description: instructions,\n          voice: {\n            id: voice,\n            provider: 'HUME_AI',\n          },\n        },\n      ],\n      format: { type: 'mp3' },\n    };\n\n    if (outputFormat) {\n      if (['mp3', 'pcm', 'wav'].includes(outputFormat)) {\n        requestBody.format = { type: outputFormat as 'mp3' | 'pcm' | 'wav' };\n      } else {\n        warnings.push({\n          type: 'unsupported',\n          feature: 'outputFormat',\n          details: `Unsupported output format: ${outputFormat}. Using mp3 instead.`,\n        });\n      }\n    }\n\n    // Add provider-specific options\n    if (humeOptions) {\n      const speechModelOptions: Omit<\n        HumeSpeechAPITypes,\n        'utterances' | 'format'\n      > = {};\n\n      if (humeOptions.context) {\n        if ('generationId' in humeOptions.context) {\n          speechModelOptions.context = {\n            generation_id: humeOptions.context.generationId,\n          };\n        } else {\n          speechModelOptions.context = {\n            utterances: humeOptions.context.utterances.map(utterance => ({\n              text: utterance.text,\n              description: utterance.description,\n              speed: utterance.speed,\n              trailing_silence: utterance.trailingSilence,\n              voice: utterance.voice,\n            })),\n          };\n        }\n      }\n\n      for (const key in speechModelOptions) {\n        const value =\n          speechModelOptions[\n            key as keyof Omit<HumeSpeechAPITypes, 'utterances' | 'format'>\n          ];\n        if (value !== undefined) {\n          (requestBody as Record<string, unknown>)[key] = value;\n        }\n      }\n    }\n\n    if (language) {\n      warnings.push({\n        type: 'unsupported',\n        feature: 'language',\n        details: `Hume speech models do not support language selection. Language parameter \"${language}\" was ignored.`,\n      });\n    }\n\n    return {\n      requestBody,\n      warnings,\n    };\n  }\n\n  async doGenerate(\n    options: Parameters<SpeechModelV4['doGenerate']>[0],\n  ): Promise<Awaited<ReturnType<SpeechModelV4['doGenerate']>>> {\n    const currentDate = this.config._internal?.currentDate?.() ?? new Date();\n    const { requestBody, warnings } = await this.getArgs(options);\n\n    const {\n      value: audio,\n      responseHeaders,\n      rawValue: rawResponse,\n    } = await postJsonToApi({\n      url: this.config.url({\n        path: '/v0/tts/file',\n        modelId: this.modelId,\n      }),\n      headers: combineHeaders(this.config.headers(), options.headers),\n      body: requestBody,\n      failedResponseHandler: humeFailedResponseHandler,\n      successfulResponseHandler: createBinaryResponseHandler(),\n      abortSignal: options.abortSignal,\n      fetch: this.config.fetch,\n    });\n\n    return {\n      audio,\n      warnings,\n      request: {\n        body: JSON.stringify(requestBody),\n      },\n      response: {\n        timestamp: currentDate,\n        modelId: this.modelId,\n        headers: responseHeaders,\n        body: rawResponse,\n      },\n    };\n  }\n}\n","import { z } from 'zod/v4';\nimport { createJsonErrorResponseHandler } from '@ai-sdk/provider-utils';\n\nexport const humeErrorDataSchema = z.object({\n  error: z.object({\n    message: z.string(),\n    code: z.number(),\n  }),\n});\n\nexport type HumeErrorData = z.infer<typeof humeErrorDataSchema>;\n\nexport const humeFailedResponseHandler = createJsonErrorResponseHandler({\n  errorSchema: humeErrorDataSchema,\n  errorToMessage: data => data.error.message,\n});\n","// Version string of this package injected at build time.\ndeclare const __PACKAGE_VERSION__: string | undefined;\nexport const VERSION: string =\n  typeof __PACKAGE_VERSION__ !== 'undefined'\n    ? __PACKAGE_VERSION__\n    : '0.0.0-test';\n"],"mappings":";AACA;AAAA,EAEE;AAAA,EACA;AAAA,OACK;;;ACJP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,KAAAA,UAAS;;;ACPlB,SAAS,SAAS;AAClB,SAAS,sCAAsC;AAExC,IAAM,sBAAsB,EAAE,OAAO;AAAA,EAC1C,OAAO,EAAE,OAAO;AAAA,IACd,SAAS,EAAE,OAAO;AAAA,IAClB,MAAM,EAAE,OAAO;AAAA,EACjB,CAAC;AACH,CAAC;AAIM,IAAM,4BAA4B,+BAA+B;AAAA,EACtE,aAAa;AAAA,EACb,gBAAgB,UAAQ,KAAK,MAAM;AACrC,CAAC;;;ADFD,IAAM,+BAA+BC,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM5C,SAASA,GACN,OAAO;AAAA;AAAA;AAAA;AAAA,IAIN,cAAcA,GAAE,OAAO;AAAA,EACzB,CAAC,EACA;AAAA,IACCA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,MAIP,YAAYA,GAAE;AAAA,QACZA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,UAIP,MAAMA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,UAIf,aAAaA,GAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,UAIjC,OAAOA,GAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,UAI3B,iBAAiBA,GAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,UAKrC,OAAOA,GACJ,OAAO;AAAA;AAAA;AAAA;AAAA,YAIN,IAAIA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,YAIb,UAAUA,GAAE,KAAK,CAAC,WAAW,cAAc,CAAC,EAAE,SAAS;AAAA,UACzD,CAAC,EACA;AAAA,YACCA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,cAIP,MAAMA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,cAIf,UAAUA,GAAE,KAAK,CAAC,WAAW,cAAc,CAAC,EAAE,SAAS;AAAA,YACzD,CAAC;AAAA,UACH,EACC,SAAS;AAAA,QACd,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH,EACC,QAAQ;AACb,CAAC;AAYM,IAAM,kBAAN,MAA+C;AAAA,EAOpD,YACW,SACQ,QACjB;AAFS;AACQ;AARnB,SAAS,uBAAuB;AAAA,EAS7B;AAAA,EAPH,IAAI,WAAmB;AACrB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAOA,MAAc,QAAQ;AAAA,IACpB;AAAA,IACA,QAAQ;AAAA,IACR,eAAe;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAA+C;AAC7C,UAAM,WAA8B,CAAC;AAGrC,UAAM,cAAc,MAAM,qBAAqB;AAAA,MAC7C,UAAU;AAAA,MACV;AAAA,MACA,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,cAAkC;AAAA,MACtC,YAAY;AAAA,QACV;AAAA,UACE;AAAA,UACA;AAAA,UACA,aAAa;AAAA,UACb,OAAO;AAAA,YACL,IAAI;AAAA,YACJ,UAAU;AAAA,UACZ;AAAA,QACF;AAAA,MACF;AAAA,MACA,QAAQ,EAAE,MAAM,MAAM;AAAA,IACxB;AAEA,QAAI,cAAc;AAChB,UAAI,CAAC,OAAO,OAAO,KAAK,EAAE,SAAS,YAAY,GAAG;AAChD,oBAAY,SAAS,EAAE,MAAM,aAAsC;AAAA,MACrE,OAAO;AACL,iBAAS,KAAK;AAAA,UACZ,MAAM;AAAA,UACN,SAAS;AAAA,UACT,SAAS,8BAA8B,YAAY;AAAA,QACrD,CAAC;AAAA,MACH;AAAA,IACF;AAGA,QAAI,aAAa;AACf,YAAM,qBAGF,CAAC;AAEL,UAAI,YAAY,SAAS;AACvB,YAAI,kBAAkB,YAAY,SAAS;AACzC,6BAAmB,UAAU;AAAA,YAC3B,eAAe,YAAY,QAAQ;AAAA,UACrC;AAAA,QACF,OAAO;AACL,6BAAmB,UAAU;AAAA,YAC3B,YAAY,YAAY,QAAQ,WAAW,IAAI,gBAAc;AAAA,cAC3D,MAAM,UAAU;AAAA,cAChB,aAAa,UAAU;AAAA,cACvB,OAAO,UAAU;AAAA,cACjB,kBAAkB,UAAU;AAAA,cAC5B,OAAO,UAAU;AAAA,YACnB,EAAE;AAAA,UACJ;AAAA,QACF;AAAA,MACF;AAEA,iBAAW,OAAO,oBAAoB;AACpC,cAAM,QACJ,mBACE,GACF;AACF,YAAI,UAAU,QAAW;AACvB,UAAC,YAAwC,GAAG,IAAI;AAAA,QAClD;AAAA,MACF;AAAA,IACF;AAEA,QAAI,UAAU;AACZ,eAAS,KAAK;AAAA,QACZ,MAAM;AAAA,QACN,SAAS;AAAA,QACT,SAAS,6EAA6E,QAAQ;AAAA,MAChG,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,WACJ,SAC2D;AA5M/D;AA6MI,UAAM,eAAc,sBAAK,OAAO,cAAZ,mBAAuB,gBAAvB,4CAA0C,oBAAI,KAAK;AACvE,UAAM,EAAE,aAAa,SAAS,IAAI,MAAM,KAAK,QAAQ,OAAO;AAE5D,UAAM;AAAA,MACJ,OAAO;AAAA,MACP;AAAA,MACA,UAAU;AAAA,IACZ,IAAI,MAAM,cAAc;AAAA,MACtB,KAAK,KAAK,OAAO,IAAI;AAAA,QACnB,MAAM;AAAA,QACN,SAAS,KAAK;AAAA,MAChB,CAAC;AAAA,MACD,SAAS,eAAe,KAAK,OAAO,QAAQ,GAAG,QAAQ,OAAO;AAAA,MAC9D,MAAM;AAAA,MACN,uBAAuB;AAAA,MACvB,2BAA2B,4BAA4B;AAAA,MACvD,aAAa,QAAQ;AAAA,MACrB,OAAO,KAAK,OAAO;AAAA,IACrB,CAAC;AAED,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,SAAS;AAAA,QACP,MAAM,KAAK,UAAU,WAAW;AAAA,MAClC;AAAA,MACA,UAAU;AAAA,QACR,WAAW;AAAA,QACX,SAAS,KAAK;AAAA,QACd,SAAS;AAAA,QACT,MAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACF;;;AE7OO,IAAM,UACX,OACI,kBACA;;;AHoCC,SAAS,WAAW,UAAgC,CAAC,GAAiB;AAC3E,QAAM,aAAa,MACjB;AAAA,IACE;AAAA,MACE,kBAAkB,WAAW;AAAA,QAC3B,QAAQ,QAAQ;AAAA,QAChB,yBAAyB;AAAA,QACzB,aAAa;AAAA,MACf,CAAC;AAAA,MACD,GAAG,QAAQ;AAAA,IACb;AAAA,IACA,eAAe,OAAO;AAAA,EACxB;AAEF,QAAM,oBAAoB,MACxB,IAAI,gBAAgB,IAAI;AAAA,IACtB,UAAU;AAAA,IACV,KAAK,CAAC,EAAE,KAAK,MAAM,sBAAsB,IAAI;AAAA,IAC7C,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,WAAW,WAAY;AAC3B,WAAO;AAAA,MACL,QAAQ,kBAAkB;AAAA,IAC5B;AAAA,EACF;AAEA,WAAS,SAAS;AAClB,WAAS,cAAc;AAEvB,SAAO;AACT;AAKO,IAAM,OAAO,WAAW;","names":["z","z"]}
+{"version":3,"sources":["../src/hume-provider.ts","../src/hume-speech-model.ts","../src/hume-error.ts","../src/version.ts"],"sourcesContent":["import { SpeechModelV4, ProviderV4 } from '@ai-sdk/provider';\nimport {\n  FetchFunction,\n  loadApiKey,\n  withUserAgentSuffix,\n} from '@ai-sdk/provider-utils';\nimport { HumeSpeechModel } from './hume-speech-model';\nimport { VERSION } from './version';\n\nexport interface HumeProvider extends Pick<ProviderV4, 'speechModel'> {\n  (settings?: {}): {\n    speech: HumeSpeechModel;\n  };\n\n  /**\n   * Creates a model for speech synthesis.\n   */\n  speech(): SpeechModelV4;\n}\n\nexport interface HumeProviderSettings {\n  /**\n   * API key for authenticating requests.\n   */\n  apiKey?: string;\n\n  /**\n   * Custom headers to include in the requests.\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * Custom fetch implementation. You can use it as a middleware to intercept requests,\n   * or to provide a custom fetch implementation for e.g. testing.\n   */\n  fetch?: FetchFunction;\n}\n\n/**\n * Create an Hume provider instance.\n */\nexport function createHume(options: HumeProviderSettings = {}): HumeProvider {\n  const getHeaders = () =>\n    withUserAgentSuffix(\n      {\n        'X-Hume-Api-Key': loadApiKey({\n          apiKey: options.apiKey,\n          environmentVariableName: 'HUME_API_KEY',\n          description: 'Hume',\n        }),\n        ...options.headers,\n      },\n      `ai-sdk/hume/${VERSION}`,\n    );\n\n  const createSpeechModel = () =>\n    new HumeSpeechModel('', {\n      provider: `hume.speech`,\n      url: ({ path }) => `https://api.hume.ai${path}`,\n      headers: getHeaders,\n      fetch: options.fetch,\n    });\n\n  const provider = function () {\n    return {\n      speech: createSpeechModel(),\n    };\n  };\n\n  provider.speech = createSpeechModel;\n  provider.speechModel = createSpeechModel;\n\n  return provider satisfies HumeProvider;\n}\n\n/**\n * Default Hume provider instance.\n */\nexport const hume = createHume();\n","import { SpeechModelV4, SharedV4Warning } from '@ai-sdk/provider';\nimport {\n  combineHeaders,\n  createBinaryResponseHandler,\n  parseProviderOptions,\n  postJsonToApi,\n  serializeModelOptions,\n  WORKFLOW_SERIALIZE,\n  WORKFLOW_DESERIALIZE,\n} from '@ai-sdk/provider-utils';\nimport { z } from 'zod/v4';\nimport { HumeConfig } from './hume-config';\nimport { humeFailedResponseHandler } from './hume-error';\nimport { HumeSpeechAPITypes } from './hume-api-types';\n\n// https://dev.hume.ai/reference/text-to-speech-tts/synthesize-file\nconst humeSpeechModelOptionsSchema = z.object({\n  /**\n   * Context for the speech synthesis request.\n   * Can be either a generationId for retrieving a previous generation,\n   * or a list of utterances to synthesize.\n   */\n  context: z\n    .object({\n      /**\n       * ID of a previously generated speech synthesis to retrieve.\n       */\n      generationId: z.string(),\n    })\n    .or(\n      z.object({\n        /**\n         * List of utterances to synthesize into speech.\n         */\n        utterances: z.array(\n          z.object({\n            /**\n             * The text content to convert to speech.\n             */\n            text: z.string(),\n            /**\n             * Optional description or instructions for how the text should be spoken.\n             */\n            description: z.string().optional(),\n            /**\n             * Optional speech rate multiplier.\n             */\n            speed: z.number().optional(),\n            /**\n             * Optional duration of silence to add after the utterance in seconds.\n             */\n            trailingSilence: z.number().optional(),\n            /**\n             * Voice configuration for the utterance.\n             * Can be specified by ID or name.\n             */\n            voice: z\n              .object({\n                /**\n                 * ID of the voice to use.\n                 */\n                id: z.string(),\n                /**\n                 * Provider of the voice, either Hume's built-in voices or a custom voice.\n                 */\n                provider: z.enum(['HUME_AI', 'CUSTOM_VOICE']).optional(),\n              })\n              .or(\n                z.object({\n                  /**\n                   * Name of the voice to use.\n                   */\n                  name: z.string(),\n                  /**\n                   * Provider of the voice, either Hume's built-in voices or a custom voice.\n                   */\n                  provider: z.enum(['HUME_AI', 'CUSTOM_VOICE']).optional(),\n                }),\n              )\n              .optional(),\n          }),\n        ),\n      }),\n    )\n    .nullish(),\n});\n\nexport type HumeSpeechModelOptions = z.infer<\n  typeof humeSpeechModelOptionsSchema\n>;\n\ninterface HumeSpeechModelConfig extends HumeConfig {\n  _internal?: {\n    currentDate?: () => Date;\n  };\n}\n\nexport class HumeSpeechModel implements SpeechModelV4 {\n  readonly specificationVersion = 'v4';\n\n  get provider(): string {\n    return this.config.provider;\n  }\n\n  static [WORKFLOW_SERIALIZE](model: HumeSpeechModel) {\n    return serializeModelOptions({\n      modelId: model.modelId,\n      config: model.config,\n    });\n  }\n\n  static [WORKFLOW_DESERIALIZE](options: {\n    modelId: '';\n    config: HumeSpeechModelConfig;\n  }) {\n    return new HumeSpeechModel(options.modelId as '', options.config);\n  }\n\n  constructor(\n    readonly modelId: '',\n    private readonly config: HumeSpeechModelConfig,\n  ) {}\n\n  private async getArgs({\n    text,\n    voice = 'd8ab67c6-953d-4bd8-9370-8fa53a0f1453',\n    outputFormat = 'mp3',\n    speed,\n    instructions,\n    language,\n    providerOptions,\n  }: Parameters<SpeechModelV4['doGenerate']>[0]) {\n    const warnings: SharedV4Warning[] = [];\n\n    // Parse provider options\n    const humeOptions = await parseProviderOptions({\n      provider: 'hume',\n      providerOptions,\n      schema: humeSpeechModelOptionsSchema,\n    });\n\n    // Create request body\n    const requestBody: HumeSpeechAPITypes = {\n      utterances: [\n        {\n          text,\n          speed,\n          description: instructions,\n          voice: {\n            id: voice,\n            provider: 'HUME_AI',\n          },\n        },\n      ],\n      format: { type: 'mp3' },\n    };\n\n    if (outputFormat) {\n      if (['mp3', 'pcm', 'wav'].includes(outputFormat)) {\n        requestBody.format = { type: outputFormat as 'mp3' | 'pcm' | 'wav' };\n      } else {\n        warnings.push({\n          type: 'unsupported',\n          feature: 'outputFormat',\n          details: `Unsupported output format: ${outputFormat}. Using mp3 instead.`,\n        });\n      }\n    }\n\n    // Add provider-specific options\n    if (humeOptions) {\n      const speechModelOptions: Omit<\n        HumeSpeechAPITypes,\n        'utterances' | 'format'\n      > = {};\n\n      if (humeOptions.context) {\n        if ('generationId' in humeOptions.context) {\n          speechModelOptions.context = {\n            generation_id: humeOptions.context.generationId,\n          };\n        } else {\n          speechModelOptions.context = {\n            utterances: humeOptions.context.utterances.map(utterance => ({\n              text: utterance.text,\n              description: utterance.description,\n              speed: utterance.speed,\n              trailing_silence: utterance.trailingSilence,\n              voice: utterance.voice,\n            })),\n          };\n        }\n      }\n\n      for (const key in speechModelOptions) {\n        const value =\n          speechModelOptions[\n            key as keyof Omit<HumeSpeechAPITypes, 'utterances' | 'format'>\n          ];\n        if (value !== undefined) {\n          (requestBody as Record<string, unknown>)[key] = value;\n        }\n      }\n    }\n\n    if (language) {\n      warnings.push({\n        type: 'unsupported',\n        feature: 'language',\n        details: `Hume speech models do not support language selection. Language parameter \"${language}\" was ignored.`,\n      });\n    }\n\n    return {\n      requestBody,\n      warnings,\n    };\n  }\n\n  async doGenerate(\n    options: Parameters<SpeechModelV4['doGenerate']>[0],\n  ): Promise<Awaited<ReturnType<SpeechModelV4['doGenerate']>>> {\n    const currentDate = this.config._internal?.currentDate?.() ?? new Date();\n    const { requestBody, warnings } = await this.getArgs(options);\n\n    const {\n      value: audio,\n      responseHeaders,\n      rawValue: rawResponse,\n    } = await postJsonToApi({\n      url: this.config.url({\n        path: '/v0/tts/file',\n        modelId: this.modelId,\n      }),\n      headers: combineHeaders(this.config.headers?.(), options.headers),\n      body: requestBody,\n      failedResponseHandler: humeFailedResponseHandler,\n      successfulResponseHandler: createBinaryResponseHandler(),\n      abortSignal: options.abortSignal,\n      fetch: this.config.fetch,\n    });\n\n    return {\n      audio,\n      warnings,\n      request: {\n        body: JSON.stringify(requestBody),\n      },\n      response: {\n        timestamp: currentDate,\n        modelId: this.modelId,\n        headers: responseHeaders,\n        body: rawResponse,\n      },\n    };\n  }\n}\n","import { z } from 'zod/v4';\nimport { createJsonErrorResponseHandler } from '@ai-sdk/provider-utils';\n\nexport const humeErrorDataSchema = z.object({\n  error: z.object({\n    message: z.string(),\n    code: z.number(),\n  }),\n});\n\nexport type HumeErrorData = z.infer<typeof humeErrorDataSchema>;\n\nexport const humeFailedResponseHandler = createJsonErrorResponseHandler({\n  errorSchema: humeErrorDataSchema,\n  errorToMessage: data => data.error.message,\n});\n","// Version string of this package injected at build time.\ndeclare const __PACKAGE_VERSION__: string | undefined;\nexport const VERSION: string =\n  typeof __PACKAGE_VERSION__ !== 'undefined'\n    ? __PACKAGE_VERSION__\n    : '0.0.0-test';\n"],"mappings":";AACA;AAAA,EAEE;AAAA,EACA;AAAA,OACK;;;ACJP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,KAAAA,UAAS;;;ACVlB,SAAS,SAAS;AAClB,SAAS,sCAAsC;AAExC,IAAM,sBAAsB,EAAE,OAAO;AAAA,EAC1C,OAAO,EAAE,OAAO;AAAA,IACd,SAAS,EAAE,OAAO;AAAA,IAClB,MAAM,EAAE,OAAO;AAAA,EACjB,CAAC;AACH,CAAC;AAIM,IAAM,4BAA4B,+BAA+B;AAAA,EACtE,aAAa;AAAA,EACb,gBAAgB,UAAQ,KAAK,MAAM;AACrC,CAAC;;;ADCD,IAAM,+BAA+BC,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM5C,SAASA,GACN,OAAO;AAAA;AAAA;AAAA;AAAA,IAIN,cAAcA,GAAE,OAAO;AAAA,EACzB,CAAC,EACA;AAAA,IACCA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,MAIP,YAAYA,GAAE;AAAA,QACZA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,UAIP,MAAMA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,UAIf,aAAaA,GAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,UAIjC,OAAOA,GAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,UAI3B,iBAAiBA,GAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,UAKrC,OAAOA,GACJ,OAAO;AAAA;AAAA;AAAA;AAAA,YAIN,IAAIA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,YAIb,UAAUA,GAAE,KAAK,CAAC,WAAW,cAAc,CAAC,EAAE,SAAS;AAAA,UACzD,CAAC,EACA;AAAA,YACCA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,cAIP,MAAMA,GAAE,OAAO;AAAA;AAAA;AAAA;AAAA,cAIf,UAAUA,GAAE,KAAK,CAAC,WAAW,cAAc,CAAC,EAAE,SAAS;AAAA,YACzD,CAAC;AAAA,UACH,EACC,SAAS;AAAA,QACd,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH,EACC,QAAQ;AACb,CAAC;AAYM,IAAM,kBAAN,MAAM,iBAAyC;AAAA,EAqBpD,YACW,SACQ,QACjB;AAFS;AACQ;AAtBnB,SAAS,uBAAuB;AAAA,EAuB7B;AAAA,EArBH,IAAI,WAAmB;AACrB,WAAO,KAAK,OAAO;AAAA,EACrB;AAAA,EAEA,QAAQ,kBAAkB,EAAE,OAAwB;AAClD,WAAO,sBAAsB;AAAA,MAC3B,SAAS,MAAM;AAAA,MACf,QAAQ,MAAM;AAAA,IAChB,CAAC;AAAA,EACH;AAAA,EAEA,QAAQ,oBAAoB,EAAE,SAG3B;AACD,WAAO,IAAI,iBAAgB,QAAQ,SAAe,QAAQ,MAAM;AAAA,EAClE;AAAA,EAOA,MAAc,QAAQ;AAAA,IACpB;AAAA,IACA,QAAQ;AAAA,IACR,eAAe;AAAA,IACf;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF,GAA+C;AAC7C,UAAM,WAA8B,CAAC;AAGrC,UAAM,cAAc,MAAM,qBAAqB;AAAA,MAC7C,UAAU;AAAA,MACV;AAAA,MACA,QAAQ;AAAA,IACV,CAAC;AAGD,UAAM,cAAkC;AAAA,MACtC,YAAY;AAAA,QACV;AAAA,UACE;AAAA,UACA;AAAA,UACA,aAAa;AAAA,UACb,OAAO;AAAA,YACL,IAAI;AAAA,YACJ,UAAU;AAAA,UACZ;AAAA,QACF;AAAA,MACF;AAAA,MACA,QAAQ,EAAE,MAAM,MAAM;AAAA,IACxB;AAEA,QAAI,cAAc;AAChB,UAAI,CAAC,OAAO,OAAO,KAAK,EAAE,SAAS,YAAY,GAAG;AAChD,oBAAY,SAAS,EAAE,MAAM,aAAsC;AAAA,MACrE,OAAO;AACL,iBAAS,KAAK;AAAA,UACZ,MAAM;AAAA,UACN,SAAS;AAAA,UACT,SAAS,8BAA8B,YAAY;AAAA,QACrD,CAAC;AAAA,MACH;AAAA,IACF;AAGA,QAAI,aAAa;AACf,YAAM,qBAGF,CAAC;AAEL,UAAI,YAAY,SAAS;AACvB,YAAI,kBAAkB,YAAY,SAAS;AACzC,6BAAmB,UAAU;AAAA,YAC3B,eAAe,YAAY,QAAQ;AAAA,UACrC;AAAA,QACF,OAAO;AACL,6BAAmB,UAAU;AAAA,YAC3B,YAAY,YAAY,QAAQ,WAAW,IAAI,gBAAc;AAAA,cAC3D,MAAM,UAAU;AAAA,cAChB,aAAa,UAAU;AAAA,cACvB,OAAO,UAAU;AAAA,cACjB,kBAAkB,UAAU;AAAA,cAC5B,OAAO,UAAU;AAAA,YACnB,EAAE;AAAA,UACJ;AAAA,QACF;AAAA,MACF;AAEA,iBAAW,OAAO,oBAAoB;AACpC,cAAM,QACJ,mBACE,GACF;AACF,YAAI,UAAU,QAAW;AACvB,UAAC,YAAwC,GAAG,IAAI;AAAA,QAClD;AAAA,MACF;AAAA,IACF;AAEA,QAAI,UAAU;AACZ,eAAS,KAAK;AAAA,QACZ,MAAM;AAAA,QACN,SAAS;AAAA,QACT,SAAS,6EAA6E,QAAQ;AAAA,MAChG,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,WACJ,SAC2D;AA7N/D;AA8NI,UAAM,eAAc,sBAAK,OAAO,cAAZ,mBAAuB,gBAAvB,4CAA0C,oBAAI,KAAK;AACvE,UAAM,EAAE,aAAa,SAAS,IAAI,MAAM,KAAK,QAAQ,OAAO;AAE5D,UAAM;AAAA,MACJ,OAAO;AAAA,MACP;AAAA,MACA,UAAU;AAAA,IACZ,IAAI,MAAM,cAAc;AAAA,MACtB,KAAK,KAAK,OAAO,IAAI;AAAA,QACnB,MAAM;AAAA,QACN,SAAS,KAAK;AAAA,MAChB,CAAC;AAAA,MACD,SAAS,gBAAe,gBAAK,QAAO,YAAZ,6BAAyB,QAAQ,OAAO;AAAA,MAChE,MAAM;AAAA,MACN,uBAAuB;AAAA,MACvB,2BAA2B,4BAA4B;AAAA,MACvD,aAAa,QAAQ;AAAA,MACrB,OAAO,KAAK,OAAO;AAAA,IACrB,CAAC;AAED,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,SAAS;AAAA,QACP,MAAM,KAAK,UAAU,WAAW;AAAA,MAClC;AAAA,MACA,UAAU;AAAA,QACR,WAAW;AAAA,QACX,SAAS,KAAK;AAAA,QACd,SAAS;AAAA,QACT,MAAM;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACF;;;AE9PO,IAAM,UACX,OACI,kBACA;;;AHoCC,SAAS,WAAW,UAAgC,CAAC,GAAiB;AAC3E,QAAM,aAAa,MACjB;AAAA,IACE;AAAA,MACE,kBAAkB,WAAW;AAAA,QAC3B,QAAQ,QAAQ;AAAA,QAChB,yBAAyB;AAAA,QACzB,aAAa;AAAA,MACf,CAAC;AAAA,MACD,GAAG,QAAQ;AAAA,IACb;AAAA,IACA,eAAe,OAAO;AAAA,EACxB;AAEF,QAAM,oBAAoB,MACxB,IAAI,gBAAgB,IAAI;AAAA,IACtB,UAAU;AAAA,IACV,KAAK,CAAC,EAAE,KAAK,MAAM,sBAAsB,IAAI;AAAA,IAC7C,SAAS;AAAA,IACT,OAAO,QAAQ;AAAA,EACjB,CAAC;AAEH,QAAM,WAAW,WAAY;AAC3B,WAAO;AAAA,MACL,QAAQ,kBAAkB;AAAA,IAC5B;AAAA,EACF;AAEA,WAAS,SAAS;AAClB,WAAS,cAAc;AAEvB,SAAO;AACT;AAKO,IAAM,OAAO,WAAW;","names":["z","z"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/hume",
-  "version": "3.0.0-beta.20",
+  "version": "3.0.0-beta.21",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -29,8 +29,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "4.0.0-beta.11",
-    "@ai-sdk/provider-utils": "5.0.0-beta.19"
+    "@ai-sdk/provider": "4.0.0-beta.12",
+    "@ai-sdk/provider-utils": "5.0.0-beta.20"
   },
   "devDependencies": {
     "@types/node": "20.17.24",

package/src/hume-config.ts

@@ -3,7 +3,7 @@ import { FetchFunction } from '@ai-sdk/provider-utils';
 export type HumeConfig = {
   provider: string;
   url: (options: { modelId: string; path: string }) => string;
-  headers: () => Record<string, string | undefined>;
+  headers?: () => Record<string, string | undefined>;
   fetch?: FetchFunction;
   generateId?: () => string;
 };

package/src/hume-speech-model.ts

@@ -4,6 +4,9 @@ import {
   createBinaryResponseHandler,
   parseProviderOptions,
   postJsonToApi,
+  serializeModelOptions,
+  WORKFLOW_SERIALIZE,
+  WORKFLOW_DESERIALIZE,
 } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 import { HumeConfig } from './hume-config';
@@ -99,6 +102,20 @@ export class HumeSpeechModel implements SpeechModelV4 {
     return this.config.provider;
   }
 
+  static [WORKFLOW_SERIALIZE](model: HumeSpeechModel) {
+    return serializeModelOptions({
+      modelId: model.modelId,
+      config: model.config,
+    });
+  }
+
+  static [WORKFLOW_DESERIALIZE](options: {
+    modelId: '';
+    config: HumeSpeechModelConfig;
+  }) {
+    return new HumeSpeechModel(options.modelId as '', options.config);
+  }
+
   constructor(
     readonly modelId: '',
     private readonly config: HumeSpeechModelConfig,
@@ -215,7 +232,7 @@ export class HumeSpeechModel implements SpeechModelV4 {
         path: '/v0/tts/file',
         modelId: this.modelId,
       }),
-      headers: combineHeaders(this.config.headers(), options.headers),
+      headers: combineHeaders(this.config.headers?.(), options.headers),
       body: requestBody,
       failedResponseHandler: humeFailedResponseHandler,
       successfulResponseHandler: createBinaryResponseHandler(),