ai 6.0.31 → 6.0.32

package/docs/07-reference/05-ai-sdk-errors/ai-api-call-error.mdx

@@ -0,0 +1,30 @@
+---
+title: AI_APICallError
+description: Learn how to fix AI_APICallError
+---
+
+# AI_APICallError
+
+This error occurs when an API call fails.
+
+## Properties
+
+- `url`: The URL of the API request that failed
+- `requestBodyValues`: The request body values sent to the API
+- `statusCode`: The HTTP status code returned by the API
+- `responseHeaders`: The response headers returned by the API
+- `responseBody`: The response body returned by the API
+- `isRetryable`: Whether the request can be retried based on the status code
+- `data`: Any additional data associated with the error
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_APICallError` using:
+
+```typescript
+import { APICallError } from 'ai';
+
+if (APICallError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-download-error.mdx

@@ -0,0 +1,27 @@
+---
+title: AI_DownloadError
+description: Learn how to fix AI_DownloadError
+---
+
+# AI_DownloadError
+
+This error occurs when a download fails.
+
+## Properties
+
+- `url`: The URL that failed to download
+- `statusCode`: The HTTP status code returned by the server
+- `statusText`: The HTTP status text returned by the server
+- `message`: The error message containing details about the download failure
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_DownloadError` using:
+
+```typescript
+import { DownloadError } from 'ai';
+
+if (DownloadError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-empty-response-body-error.mdx

@@ -0,0 +1,24 @@
+---
+title: AI_EmptyResponseBodyError
+description: Learn how to fix AI_EmptyResponseBodyError
+---
+
+# AI_EmptyResponseBodyError
+
+This error occurs when the server returns an empty response body.
+
+## Properties
+
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_EmptyResponseBodyError` using:
+
+```typescript
+import { EmptyResponseBodyError } from 'ai';
+
+if (EmptyResponseBodyError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-invalid-argument-error.mdx

@@ -0,0 +1,26 @@
+---
+title: AI_InvalidArgumentError
+description: Learn how to fix AI_InvalidArgumentError
+---
+
+# AI_InvalidArgumentError
+
+This error occurs when an invalid argument was provided.
+
+## Properties
+
+- `parameter`: The name of the parameter that is invalid
+- `value`: The invalid value
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_InvalidArgumentError` using:
+
+```typescript
+import { InvalidArgumentError } from 'ai';
+
+if (InvalidArgumentError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-invalid-data-content-error.mdx

@@ -0,0 +1,25 @@
+---
+title: AI_InvalidDataContentError
+description: How to fix AI_InvalidDataContentError
+---
+
+# AI_InvalidDataContentError
+
+This error occurs when the data content provided in a multi-modal message part is invalid. Check out the [ prompt examples for multi-modal messages ](/docs/foundations/prompts#message-prompts).
+
+## Properties
+
+- `content`: The invalid content value
+- `message`: The error message describing the expected and received content types
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_InvalidDataContentError` using:
+
+```typescript
+import { InvalidDataContentError } from 'ai';
+
+if (InvalidDataContentError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-invalid-data-content.mdx

@@ -0,0 +1,26 @@
+---
+title: AI_InvalidDataContent
+description: Learn how to fix AI_InvalidDataContent
+---
+
+# AI_InvalidDataContent
+
+This error occurs when invalid data content is provided.
+
+## Properties
+
+- `content`: The invalid content value
+- `message`: The error message
+- `cause`: The cause of the error
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_InvalidDataContent` using:
+
+```typescript
+import { InvalidDataContent } from 'ai';
+
+if (InvalidDataContent.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-invalid-message-role-error.mdx

@@ -0,0 +1,25 @@
+---
+title: AI_InvalidMessageRoleError
+description: Learn how to fix AI_InvalidMessageRoleError
+---
+
+# AI_InvalidMessageRoleError
+
+This error occurs when an invalid message role is provided.
+
+## Properties
+
+- `role`: The invalid role value
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_InvalidMessageRoleError` using:
+
+```typescript
+import { InvalidMessageRoleError } from 'ai';
+
+if (InvalidMessageRoleError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-invalid-prompt-error.mdx

@@ -0,0 +1,47 @@
+---
+title: AI_InvalidPromptError
+description: Learn how to fix AI_InvalidPromptError
+---
+
+# AI_InvalidPromptError
+
+This error occurs when the prompt provided is invalid.
+
+## Potential Causes
+
+### UI Messages
+
+You are passing a `UIMessage[]` as messages into e.g. `streamText`.
+
+You need to first convert them to a `ModelMessage[]` using `convertToModelMessages()`.
+
+```typescript
+import { type UIMessage, generateText, convertToModelMessages } from 'ai';
+
+const messages: UIMessage[] = [
+  /* ... */
+];
+
+const result = await generateText({
+  // ...
+  messages: await convertToModelMessages(messages),
+});
+```
+
+## Properties
+
+- `prompt`: The invalid prompt value
+- `message`: The error message
+- `cause`: The cause of the error
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_InvalidPromptError` using:
+
+```typescript
+import { InvalidPromptError } from 'ai';
+
+if (InvalidPromptError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-invalid-response-data-error.mdx

@@ -0,0 +1,25 @@
+---
+title: AI_InvalidResponseDataError
+description: Learn how to fix AI_InvalidResponseDataError
+---
+
+# AI_InvalidResponseDataError
+
+This error occurs when the server returns a response with invalid data content.
+
+## Properties
+
+- `data`: The invalid response data value
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_InvalidResponseDataError` using:
+
+```typescript
+import { InvalidResponseDataError } from 'ai';
+
+if (InvalidResponseDataError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-invalid-tool-approval-error.mdx

@@ -0,0 +1,25 @@
+---
+title: AI_InvalidToolApprovalError
+description: Learn how to fix AI_InvalidToolApprovalError
+---
+
+# AI_InvalidToolApprovalError
+
+This error occurs when a tool approval response references an unknown `approvalId`. No matching `tool-approval-request` was found in the message history.
+
+## Properties
+
+- `approvalId`: The approval ID that was not found
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_InvalidToolApprovalError` using:
+
+```typescript
+import { InvalidToolApprovalError } from 'ai';
+
+if (InvalidToolApprovalError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-invalid-tool-input-error.mdx

@@ -0,0 +1,27 @@
+---
+title: AI_InvalidToolInputError
+description: Learn how to fix AI_InvalidToolInputError
+---
+
+# AI_InvalidToolInputError
+
+This error occurs when invalid tool input was provided.
+
+## Properties
+
+- `toolName`: The name of the tool with invalid inputs
+- `toolInput`: The invalid tool inputs
+- `message`: The error message
+- `cause`: The cause of the error
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_InvalidToolInputError` using:
+
+```typescript
+import { InvalidToolInputError } from 'ai';
+
+if (InvalidToolInputError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-json-parse-error.mdx

@@ -0,0 +1,25 @@
+---
+title: AI_JSONParseError
+description: Learn how to fix AI_JSONParseError
+---
+
+# AI_JSONParseError
+
+This error occurs when JSON fails to parse.
+
+## Properties
+
+- `text`: The text value that could not be parsed
+- `message`: The error message including parse error details
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_JSONParseError` using:
+
+```typescript
+import { JSONParseError } from 'ai';
+
+if (JSONParseError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-load-api-key-error.mdx

@@ -0,0 +1,24 @@
+---
+title: AI_LoadAPIKeyError
+description: Learn how to fix AI_LoadAPIKeyError
+---
+
+# AI_LoadAPIKeyError
+
+This error occurs when API key is not loaded successfully.
+
+## Properties
+
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_LoadAPIKeyError` using:
+
+```typescript
+import { LoadAPIKeyError } from 'ai';
+
+if (LoadAPIKeyError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-load-setting-error.mdx

@@ -0,0 +1,24 @@
+---
+title: AI_LoadSettingError
+description: Learn how to fix AI_LoadSettingError
+---
+
+# AI_LoadSettingError
+
+This error occurs when a setting is not loaded successfully.
+
+## Properties
+
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_LoadSettingError` using:
+
+```typescript
+import { LoadSettingError } from 'ai';
+
+if (LoadSettingError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-message-conversion-error.mdx

@@ -0,0 +1,25 @@
+---
+title: AI_MessageConversionError
+description: Learn how to fix AI_MessageConversionError
+---
+
+# AI_MessageConversionError
+
+This error occurs when message conversion fails.
+
+## Properties
+
+- `originalMessage`: The original message that failed conversion
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_MessageConversionError` using:
+
+```typescript
+import { MessageConversionError } from 'ai';
+
+if (MessageConversionError.isInstance(error)) {
+  // Handle the error
+}
+```

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

@@ -0,0 +1,24 @@
+---
+title: AI_NoContentGeneratedError
+description: Learn how to fix AI_NoContentGeneratedError
+---
+
+# AI_NoContentGeneratedError
+
+This error occurs when the AI provider fails to generate content.
+
+## Properties
+
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoContentGeneratedError` using:
+
+```typescript
+import { NoContentGeneratedError } from 'ai';
+
+if (NoContentGeneratedError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-no-image-generated-error.mdx

@@ -0,0 +1,36 @@
+---
+title: AI_NoImageGeneratedError
+description: Learn how to fix AI_NoImageGeneratedError
+---
+
+# AI_NoImageGeneratedError
+
+This error occurs when the AI provider fails to generate an image.
+It can arise due to the following reasons:
+
+- The model failed to generate a response.
+- The model generated an invalid response.
+
+## Properties
+
+- `message`: The error message.
+- `responses`: Metadata about the image model responses, including timestamp, model, and headers.
+- `cause`: The cause of the error. You can use this for more detailed error handling.
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoImageGeneratedError` using:
+
+```typescript
+import { generateImage, NoImageGeneratedError } from 'ai';
+
+try {
+  await generateImage({ model, prompt });
+} catch (error) {
+  if (NoImageGeneratedError.isInstance(error)) {
+    console.log('NoImageGeneratedError');
+    console.log('Cause:', error.cause);
+    console.log('Responses:', error.responses);
+  }
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-no-object-generated-error.mdx

@@ -0,0 +1,43 @@
+---
+title: AI_NoObjectGeneratedError
+description: Learn how to fix AI_NoObjectGeneratedError
+---
+
+# AI_NoObjectGeneratedError
+
+This error occurs when the AI provider fails to generate a parsable object that conforms to the schema.
+It can arise due to the following reasons:
+
+- The model failed to generate a response.
+- The model generated a response that could not be parsed.
+- The model generated a response that could not be validated against the schema.
+
+## Properties
+
+- `message`: The error message.
+- `text`: The text that was generated by the model. This can be the raw text or the tool call text, depending on the object generation mode.
+- `response`: Metadata about the language model response, including response id, timestamp, and model.
+- `usage`: Request token usage.
+- `finishReason`: Request finish reason. For example 'length' if model generated maximum number of tokens, this could result in a JSON parsing error.
+- `cause`: The cause of the error (e.g. a JSON parsing error). You can use this for more detailed error handling.
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoObjectGeneratedError` using:
+
+```typescript
+import { generateObject, NoObjectGeneratedError } from 'ai';
+
+try {
+  await generateObject({ model, schema, prompt });
+} catch (error) {
+  if (NoObjectGeneratedError.isInstance(error)) {
+    console.log('NoObjectGeneratedError');
+    console.log('Cause:', error.cause);
+    console.log('Text:', error.text);
+    console.log('Response:', error.response);
+    console.log('Usage:', error.usage);
+    console.log('Finish Reason:', error.finishReason);
+  }
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-no-speech-generated-error.mdx

@@ -0,0 +1,25 @@
+---
+title: AI_NoSpeechGeneratedError
+description: Learn how to fix AI_NoSpeechGeneratedError
+---
+
+# AI_NoSpeechGeneratedError
+
+This error occurs when no audio could be generated from the input.
+
+## Properties
+
+- `responses`: Array of responses
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoSpeechGeneratedError` using:
+
+```typescript
+import { NoSpeechGeneratedError } from 'ai';
+
+if (NoSpeechGeneratedError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-no-such-model-error.mdx

@@ -0,0 +1,26 @@
+---
+title: AI_NoSuchModelError
+description: Learn how to fix AI_NoSuchModelError
+---
+
+# AI_NoSuchModelError
+
+This error occurs when a model ID is not found.
+
+## Properties
+
+- `modelId`: The ID of the model that was not found
+- `modelType`: The type of model
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoSuchModelError` using:
+
+```typescript
+import { NoSuchModelError } from 'ai';
+
+if (NoSuchModelError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-no-such-provider-error.mdx

@@ -0,0 +1,28 @@
+---
+title: AI_NoSuchProviderError
+description: Learn how to fix AI_NoSuchProviderError
+---
+
+# AI_NoSuchProviderError
+
+This error occurs when a provider ID is not found.
+
+## Properties
+
+- `providerId`: The ID of the provider that was not found
+- `availableProviders`: Array of available provider IDs
+- `modelId`: The ID of the model
+- `modelType`: The type of model
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoSuchProviderError` using:
+
+```typescript
+import { NoSuchProviderError } from 'ai';
+
+if (NoSuchProviderError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-no-such-tool-error.mdx

@@ -0,0 +1,26 @@
+---
+title: AI_NoSuchToolError
+description: Learn how to fix AI_NoSuchToolError
+---
+
+# AI_NoSuchToolError
+
+This error occurs when a model tries to call an unavailable tool.
+
+## Properties
+
+- `toolName`: The name of the tool that was not found
+- `availableTools`: Array of available tool names
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoSuchToolError` using:
+
+```typescript
+import { NoSuchToolError } from 'ai';
+
+if (NoSuchToolError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-no-transcript-generated-error.mdx

@@ -0,0 +1,25 @@
+---
+title: AI_NoTranscriptGeneratedError
+description: Learn how to fix AI_NoTranscriptGeneratedError
+---
+
+# AI_NoTranscriptGeneratedError
+
+This error occurs when no transcript could be generated from the input.
+
+## Properties
+
+- `responses`: Array of responses
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoTranscriptGeneratedError` using:
+
+```typescript
+import { NoTranscriptGeneratedError } from 'ai';
+
+if (NoTranscriptGeneratedError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-retry-error.mdx

@@ -0,0 +1,27 @@
+---
+title: AI_RetryError
+description: Learn how to fix AI_RetryError
+---
+
+# AI_RetryError
+
+This error occurs when a retry operation fails.
+
+## Properties
+
+- `reason`: The reason for the retry failure
+- `lastError`: The most recent error that occurred during retries
+- `errors`: Array of all errors that occurred during retry attempts
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_RetryError` using:
+
+```typescript
+import { RetryError } from 'ai';
+
+if (RetryError.isInstance(error)) {
+  // Handle the error
+}
+```