Skip to content

Commit c319849

Browse files
vercel-ai-sdk[bot]EurFeluxgr2m
authored
Backport: fix(ai): update docs for NoSpeechGeneratedError and export it (#8967)
This is an automated backport of #8512 to the release-v5.0 branch. Co-authored-by: Phantom <59059173+EurFelux@users.noreply.github.com> Co-authored-by: Gregor Martynus <39992+gr2m@users.noreply.github.com>
1 parent 80bcc8c commit c319849

File tree

6 files changed

+36
-30
lines changed

6 files changed

+36
-30
lines changed

.changeset/late-emus-explode.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'ai': patch
3+
---
4+
5+
fixed docs and exported NoSpeechGeneratedError

content/docs/03-ai-sdk-core/37-speech.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ const warnings = audio.warnings;
114114

115115
### Error Handling
116116

117-
When `generateSpeech` cannot generate a valid audio, it throws a [`AI_NoAudioGeneratedError`](/docs/reference/ai-sdk-errors/ai-no-audio-generated-error).
117+
When `generateSpeech` cannot generate a valid audio, it throws a [`AI_NoSpeechGeneratedError`](/docs/reference/ai-sdk-errors/ai-no-speech-generated-error).
118118

119119
This error can arise for any the following reasons:
120120

@@ -129,7 +129,7 @@ The error preserves the following information to help you log the issue:
129129
```ts
130130
import {
131131
experimental_generateSpeech as generateSpeech,
132-
AI_NoAudioGeneratedError,
132+
NoSpeechGeneratedError,
133133
} from 'ai';
134134
import { openai } from '@ai-sdk/openai';
135135

@@ -139,8 +139,8 @@ try {
139139
text: 'Hello, world!',
140140
});
141141
} catch (error) {
142-
if (AI_NoAudioGeneratedError.isInstance(error)) {
143-
console.log('AI_NoAudioGeneratedError');
142+
if (NoSpeechGeneratedError.isInstance(error)) {
143+
console.log('AI_NoSpeechGeneratedError');
144144
console.log('Cause:', error.cause);
145145
console.log('Responses:', error.responses);
146146
}

content/docs/07-reference/05-ai-sdk-errors/ai-no-audio-generated-error.mdx

Lines changed: 0 additions & 25 deletions
This file was deleted.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: AI_NoSpeechGeneratedError
3+
description: Learn how to fix AI_NoSpeechGeneratedError
4+
---
5+
6+
# AI_NoSpeechGeneratedError
7+
8+
This error occurs when no audio could be generated from the input.
9+
10+
## Properties
11+
12+
- `responses`: Array of responses
13+
- `message`: The error message
14+
15+
## Checking for this Error
16+
17+
You can check if an error is an instance of `AI_NoSpeechGeneratedError` using:
18+
19+
```typescript
20+
import { NoSpeechGeneratedError } from 'ai';
21+
22+
if (NoSpeechGeneratedError.isInstance(error)) {
23+
// Handle the error
24+
}
25+
```

content/docs/07-reference/05-ai-sdk-errors/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ collapsed: true
2020
- [AI_LoadAPIKeyError](/docs/reference/ai-sdk-errors/ai-load-api-key-error)
2121
- [AI_LoadSettingError](/docs/reference/ai-sdk-errors/ai-load-setting-error)
2222
- [AI_MessageConversionError](/docs/reference/ai-sdk-errors/ai-message-conversion-error)
23-
- [AI_NoAudioGeneratedError](/docs/reference/ai-sdk-errors/ai-no-audio-generated-error)
23+
- [AI_NoSpeechGeneratedError](/docs/reference/ai-sdk-errors/ai-no-speech-generated-error)
2424
- [AI_NoContentGeneratedError](/docs/reference/ai-sdk-errors/ai-no-content-generated-error)
2525
- [AI_NoImageGeneratedError](/docs/reference/ai-sdk-errors/ai-no-image-generated-error)
2626
- [AI_NoTranscriptGeneratedError](/docs/reference/ai-sdk-errors/ai-no-transcript-generated-error)

packages/ai/src/error/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export { NoImageGeneratedError } from './no-image-generated-error';
2121
export { NoObjectGeneratedError } from './no-object-generated-error';
2222
export { NoOutputGeneratedError } from './no-output-generated-error';
2323
export { NoOutputSpecifiedError } from './no-output-specified-error';
24+
export { NoSpeechGeneratedError } from './no-speech-generated-error';
2425
export { NoSuchToolError } from './no-such-tool-error';
2526
export { ToolCallRepairError } from './tool-call-repair-error';
2627
export { UnsupportedModelVersionError } from './unsupported-model-version-error';

0 commit comments

Comments
 (0)