ai 6.0.31 → 6.0.32

package/docs/07-reference/05-ai-sdk-errors/ai-too-many-embedding-values-for-call-error.mdx

@@ -0,0 +1,27 @@
+---
+title: AI_TooManyEmbeddingValuesForCallError
+description: Learn how to fix AI_TooManyEmbeddingValuesForCallError
+---
+
+# AI_TooManyEmbeddingValuesForCallError
+
+This error occurs when too many values are provided in a single embedding call.
+
+## Properties
+
+- `provider`: The AI provider name
+- `modelId`: The ID of the embedding model
+- `maxEmbeddingsPerCall`: The maximum number of embeddings allowed per call
+- `values`: The array of values that was provided
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_TooManyEmbeddingValuesForCallError` using:
+
+```typescript
+import { TooManyEmbeddingValuesForCallError } from 'ai';
+
+if (TooManyEmbeddingValuesForCallError.isInstance(error)) {
+  // Handle the error
+}
+```

package/docs/07-reference/05-ai-sdk-errors/ai-tool-call-not-found-for-approval-error.mdx

@@ -0,0 +1,26 @@
+---
+title: AI_ToolCallNotFoundForApprovalError
+description: Learn how to fix AI_ToolCallNotFoundForApprovalError
+---
+
+# AI_ToolCallNotFoundForApprovalError
+
+This error occurs when a tool approval request references a tool call that was not found. This can happen when processing provider-emitted approval requests (e.g., MCP flows) where the referenced tool call ID does not exist.
+
+## Properties
+
+- `toolCallId`: The tool call ID that was not found
+- `approvalId`: The approval request ID
+- `message`: The error message
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_ToolCallNotFoundForApprovalError` using:
+
+```typescript
+import { ToolCallNotFoundForApprovalError } from 'ai';
+
+if (ToolCallNotFoundForApprovalError.isInstance(error)) {
+  // Handle the error
+}
+```

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

@@ -0,0 +1,28 @@
+---
+title: ToolCallRepairError
+description: Learn how to fix AI SDK ToolCallRepairError
+---
+
+# ToolCallRepairError
+
+This error occurs when there is a failure while attempting to repair an invalid tool call.
+This typically happens when the AI attempts to fix either
+a `NoSuchToolError` or `InvalidToolInputError`.
+
+## Properties
+
+- `originalError`: The original error that triggered the repair attempt (either `NoSuchToolError` or `InvalidToolInputError`)
+- `message`: The error message
+- `cause`: The underlying error that caused the repair to fail
+
+## Checking for this Error
+
+You can check if an error is an instance of `ToolCallRepairError` using:
+
+```typescript
+import { ToolCallRepairError } from 'ai';
+
+if (ToolCallRepairError.isInstance(error)) {
+  // Handle the error
+}
+```

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

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

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

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

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

@@ -0,0 +1,38 @@
+---
+title: AI SDK Errors
+description: Troubleshooting information for common AI SDK errors.
+collapsed: true
+---
+
+# AI SDK Errors
+
+- [AI_APICallError](/docs/reference/ai-sdk-errors/ai-api-call-error)
+- [AI_DownloadError](/docs/reference/ai-sdk-errors/ai-download-error)
+- [AI_EmptyResponseBodyError](/docs/reference/ai-sdk-errors/ai-empty-response-body-error)
+- [AI_InvalidArgumentError](/docs/reference/ai-sdk-errors/ai-invalid-argument-error)
+- [AI_InvalidDataContent](/docs/reference/ai-sdk-errors/ai-invalid-data-content)
+- [AI_InvalidDataContentError](/docs/reference/ai-sdk-errors/ai-invalid-data-content-error)
+- [AI_InvalidMessageRoleError](/docs/reference/ai-sdk-errors/ai-invalid-message-role-error)
+- [AI_InvalidPromptError](/docs/reference/ai-sdk-errors/ai-invalid-prompt-error)
+- [AI_InvalidResponseDataError](/docs/reference/ai-sdk-errors/ai-invalid-response-data-error)
+- [AI_InvalidToolApprovalError](/docs/reference/ai-sdk-errors/ai-invalid-tool-approval-error)
+- [AI_InvalidToolInputError](/docs/reference/ai-sdk-errors/ai-invalid-tool-input-error)
+- [AI_JSONParseError](/docs/reference/ai-sdk-errors/ai-json-parse-error)
+- [AI_LoadAPIKeyError](/docs/reference/ai-sdk-errors/ai-load-api-key-error)
+- [AI_LoadSettingError](/docs/reference/ai-sdk-errors/ai-load-setting-error)
+- [AI_MessageConversionError](/docs/reference/ai-sdk-errors/ai-message-conversion-error)
+- [AI_NoSpeechGeneratedError](/docs/reference/ai-sdk-errors/ai-no-speech-generated-error)
+- [AI_NoContentGeneratedError](/docs/reference/ai-sdk-errors/ai-no-content-generated-error)
+- [AI_NoImageGeneratedError](/docs/reference/ai-sdk-errors/ai-no-image-generated-error)
+- [AI_NoTranscriptGeneratedError](/docs/reference/ai-sdk-errors/ai-no-transcript-generated-error)
+- [AI_NoObjectGeneratedError](/docs/reference/ai-sdk-errors/ai-no-object-generated-error)
+- [AI_NoOutputSpecifiedError](/docs/reference/ai-sdk-errors/ai-no-output-specified-error)
+- [AI_NoSuchModelError](/docs/reference/ai-sdk-errors/ai-no-such-model-error)
+- [AI_NoSuchProviderError](/docs/reference/ai-sdk-errors/ai-no-such-provider-error)
+- [AI_NoSuchToolError](/docs/reference/ai-sdk-errors/ai-no-such-tool-error)
+- [AI_RetryError](/docs/reference/ai-sdk-errors/ai-retry-error)
+- [AI_ToolCallNotFoundForApprovalError](/docs/reference/ai-sdk-errors/ai-tool-call-not-found-for-approval-error)
+- [AI_ToolCallRepairError](/docs/reference/ai-sdk-errors/ai-tool-call-repair-error)
+- [AI_TooManyEmbeddingValuesForCallError](/docs/reference/ai-sdk-errors/ai-too-many-embedding-values-for-call-error)
+- [AI_TypeValidationError](/docs/reference/ai-sdk-errors/ai-type-validation-error)
+- [AI_UnsupportedFunctionalityError](/docs/reference/ai-sdk-errors/ai-unsupported-functionality-error)

package/docs/07-reference/index.mdx

@@ -0,0 +1,34 @@
+---
+title: Reference
+description: Reference documentation for the AI SDK
+---
+
+# API Reference
+
+<IndexCards
+  cards={[
+    {
+      title: 'AI SDK Core',
+      description: 'Switch between model providers without changing your code.',
+      href: '/docs/reference/ai-sdk-core',
+    },
+    {
+      title: 'AI SDK RSC',
+      description:
+        'Use React Server Components to stream user interfaces to the client.',
+      href: '/docs/reference/ai-sdk-rsc',
+    },
+    {
+      title: 'AI SDK UI',
+      description:
+        'Use hooks to integrate user interfaces that interact with language models.',
+      href: '/docs/reference/ai-sdk-ui',
+    },
+    {
+      title: 'Stream Helpers',
+      description:
+        'Use special functions that help stream model generations from various providers.',
+      href: '/docs/reference/stream-helpers',
+    },
+  ]}
+/>

package/docs/08-migration-guides/00-versioning.mdx

@@ -0,0 +1,46 @@
+---
+title: Versioning
+description: Understand how the AI SDK approaches versioning.
+---
+
+# Versioning
+
+Each version number follows the format: `MAJOR.MINOR.PATCH`
+
+- **Major**: Breaking API updates that require code changes.
+- **Minor**: Blog post that aggregates new features and improvements into a public release that highlights benefits.
+- **Patch**: New features and bug fixes.
+
+## API Stability
+
+We communicate the stability of our APIs as follows:
+
+### Stable APIs
+
+All APIs without special prefixes are considered stable and ready for production use. We maintain backward compatibility for stable features and only introduce breaking changes in major releases.
+
+### Experimental APIs
+
+APIs prefixed with `experimental_` or `Experimental_` (e.g. `experimental_generateImage()`) are in development and can change in any releases. To use experimental APIs safely:
+
+1. Test them first in development, not production
+2. Review release notes before upgrading
+3. Prepare for potential code updates
+
+<Note type="warning">
+  If you use experimental APIs, make sure to pin your AI SDK version number
+  exactly (avoid using ^ or ~ version ranges) to prevent unexpected breaking
+  changes.
+</Note>
+
+### Deprecated APIs
+
+APIs marked as `deprecated` will be removed in future major releases. You can wait until the major release to update your code. To handle deprecations:
+
+1. Switch to the recommended alternative API
+2. Follow the migration guide (released alongside major releases)
+
+<Note>
+  For major releases, we provide automated codemods where possible to help
+  migrate your code to the new version.
+</Note>