feat: upgrade speech models to v2 specification (#6798)

## background

transcription model implementations updated to `specificationVersion:
'v2'` and updated the `SpeechModelV2`

## summary

- update all speech models to use v2 specification version
- create v2 speech model type definitions

## verification

- type errors resolved for all speech providers
- specification versions now match interface requirements

## tasks

- [x] update specificationVersion to 'v2' in all speech model
implementations
- [x] create v2 speech model types and interfaces
- [x] update provider exports to use v2 types

Author: dancer

.changeset/odd-peaches-beam.md

@@ -0,0 +1,5 @@
+---
+'@ai-sdk/provider': major
+---
+
+feat: upgrade speech models to v2 specification

content/docs/07-reference/01-ai-sdk-core/12-generate-speech.mdx

@@ -37,7 +37,7 @@ console.log(audio);
   content={[
     {
       name: 'model',
-      type: 'SpeechModelV1',
+      type: 'SpeechModelV2',
       description: 'The speech model to use.',
     },
     {

packages/ai/core/generate-speech/generate-speech.test.ts

@@ -1,9 +1,9 @@
 import {
   JSONValue,
-  SpeechModelV1,
-  SpeechModelV1CallWarning,
+  SpeechModelV2,
+  SpeechModelV2CallWarning,
 } from '@ai-sdk/provider';
-import { MockSpeechModelV1 } from '../test/mock-speech-model-v1';
+import { MockSpeechModelV2 } from '../test/mock-speech-model-v2';
 import { generateSpeech } from './generate-speech';
 import {
   GeneratedAudioFile,
@@ -21,7 +21,7 @@ const sampleText = 'This is a sample text to convert to speech.';
 
 const createMockResponse = (options: {
   audio: GeneratedAudioFile;
-  warnings?: SpeechModelV1CallWarning[];
+  warnings?: SpeechModelV2CallWarning[];
   timestamp?: Date;
   modelId?: string;
   headers?: Record<string, string>;
@@ -42,10 +42,10 @@ describe('generateSpeech', () => {
     const abortController = new AbortController();
     const abortSignal = abortController.signal;
 
-    let capturedArgs!: Parameters<SpeechModelV1['doGenerate']>[0];
+    let capturedArgs!: Parameters<SpeechModelV2['doGenerate']>[0];
 
     await generateSpeech({
-      model: new MockSpeechModelV1({
+      model: new MockSpeechModelV2({
         doGenerate: async args => {
           capturedArgs = args;
           return createMockResponse({
@@ -73,7 +73,7 @@ describe('generateSpeech', () => {
 
   it('should return warnings', async () => {
     const result = await generateSpeech({
-      model: new MockSpeechModelV1({
+      model: new MockSpeechModelV2({
         doGenerate: async () =>
           createMockResponse({
             audio: mockFile,
@@ -103,7 +103,7 @@ describe('generateSpeech', () => {
 
   it('should return the audio data', async () => {
     const result = await generateSpeech({
-      model: new MockSpeechModelV1({
+      model: new MockSpeechModelV2({
         doGenerate: async () =>
           createMockResponse({
             audio: mockFile,
@@ -130,7 +130,7 @@ describe('generateSpeech', () => {
     it('should throw NoSpeechGeneratedError when no audio is returned', async () => {
       await expect(
         generateSpeech({
-          model: new MockSpeechModelV1({
+          model: new MockSpeechModelV2({
             doGenerate: async () =>
               createMockResponse({
                 audio: new DefaultGeneratedAudioFile({
@@ -157,7 +157,7 @@ describe('generateSpeech', () => {
     it('should include response headers in error when no audio generated', async () => {
       await expect(
         generateSpeech({
-          model: new MockSpeechModelV1({
+          model: new MockSpeechModelV2({
             doGenerate: async () =>
               createMockResponse({
                 audio: new DefaultGeneratedAudioFile({
@@ -192,7 +192,7 @@ describe('generateSpeech', () => {
     const testHeaders = { 'x-test': 'value' };
 
     const result = await generateSpeech({
-      model: new MockSpeechModelV1({
+      model: new MockSpeechModelV2({
         doGenerate: async () =>
           createMockResponse({
             audio: mockFile,

packages/ai/core/generate-speech/generate-speech.ts

@@ -1,4 +1,4 @@
-import { JSONValue, SpeechModelV1 } from '@ai-sdk/provider';
+import { JSONValue, SpeechModelV2 } from '@ai-sdk/provider';
 import { NoSpeechGeneratedError } from '../../src/error/no-speech-generated-error';
 import {
   audioMediaTypeSignatures,
@@ -46,7 +46,7 @@ export async function generateSpeech({
   /**
 The speech model to use.
      */
-  model: SpeechModelV1;
+  model: SpeechModelV2;
 
   /**
 The text to convert to speech.

packages/ai/core/test/mock-speech-model-v1.ts

@@ -0,0 +1,24 @@
+import { SpeechModelV2 } from '@ai-sdk/provider';
+import { notImplemented } from './not-implemented';
+
+export class MockSpeechModelV2 implements SpeechModelV2 {
+  readonly specificationVersion = 'v2';
+  readonly provider: SpeechModelV2['provider'];
+  readonly modelId: SpeechModelV2['modelId'];
+
+  doGenerate: SpeechModelV2['doGenerate'];
+
+  constructor({
+    provider = 'mock-provider',
+    modelId = 'mock-model-id',
+    doGenerate = notImplemented,
+  }: {
+    provider?: SpeechModelV2['provider'];
+    modelId?: SpeechModelV2['modelId'];
+    doGenerate?: SpeechModelV2['doGenerate'];
+  } = {}) {
+    this.provider = provider;
+    this.modelId = modelId;
+    this.doGenerate = doGenerate;
+  }
+}

packages/ai/core/test/mock-speech-model-v2.ts

@@ -3,7 +3,7 @@ import {
   TranscriptionModelV2,
   TranscriptionModelV2CallWarning,
 } from '@ai-sdk/provider';
-import { MockTranscriptionModelV2 } from '../test/mock-transcription-model-v1';
+import { MockTranscriptionModelV2 } from '../test/mock-transcription-model-v2';
 import { transcribe } from './transcribe';
 
 const audioData = new Uint8Array([1, 2, 3, 4]); // Sample audio data

packages/ai/core/test/mock-transcription-model-v1.ts renamed to packages/ai/core/test/mock-transcription-model-v2.ts

@@ -1,12 +1,12 @@
-import { SpeechModelV1, SpeechModelV1CallWarning } from '@ai-sdk/provider';
+import { SpeechModelV2, SpeechModelV2CallWarning } from '@ai-sdk/provider';
 
 /**
 Speech model that is used by the AI SDK Core functions.
   */
-export type SpeechModel = SpeechModelV1;
+export type SpeechModel = SpeechModelV2;
 
 /**
 Warning from the model provider for this call. The call will proceed, but e.g.
 some settings might not be supported, which can lead to suboptimal results.
   */
-export type SpeechWarning = SpeechModelV1CallWarning;
+export type SpeechWarning = SpeechModelV2CallWarning;

packages/ai/core/transcribe/transcribe.test.ts

@@ -1,4 +1,4 @@
-import { SpeechModelV1, ProviderV2 } from '@ai-sdk/provider';
+import { SpeechModelV2, ProviderV2 } from '@ai-sdk/provider';
 import { FetchFunction, loadApiKey } from '@ai-sdk/provider-utils';
 import { HumeSpeechModel } from './hume-speech-model';
 
@@ -10,7 +10,7 @@ export interface HumeProvider extends Pick<ProviderV2, 'speechModel'> {
   /**
 Creates a model for speech synthesis.
    */
-  speech(): SpeechModelV1;
+  speech(): SpeechModelV2;
 }
 
 export interface HumeProviderSettings {