@fairyhunter13/ai-sdk 6.0.116-fork.1

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 (optional, defaults to `'No content generated.'`)
+
+## 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 (optional, defaults to `'No image generated.'`).
+- `responses`: Metadata about the image model responses, including timestamp, model, and headers (optional).
+- `cause`: The cause of the error. You can use this for more detailed error handling (optional).
+
+## 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 (optional, defaults to `'No object generated.'`).
+- `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 (optional).
+- `response`: Metadata about the language model response, including response id, timestamp, and model (required in constructor).
+- `usage`: Request token usage (required in constructor).
+- `finishReason`: Request finish reason. For example 'length' if model generated maximum number of tokens, this could result in a JSON parsing error (required in constructor).
+- `cause`: The cause of the error (e.g. a JSON parsing error). You can use this for more detailed error handling (optional).
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoObjectGeneratedError` using:
+
+```typescript
+import { generateText, NoObjectGeneratedError, Output } from 'ai';
+
+try {
+  await generateText({ model, output: Output.object({ 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-output-generated-error.mdx

@@ -0,0 +1,25 @@
+---
+title: AI_NoOutputGeneratedError
+description: Learn how to fix AI_NoOutputGeneratedError
+---
+
+# AI_NoOutputGeneratedError
+
+This error is thrown when no LLM output was generated, e.g. because of errors.
+
+## Properties
+
+- `message`: The error message (optional, defaults to `'No output generated.'`)
+- `cause`: The underlying error that caused no output to be generated (optional)
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoOutputGeneratedError` using:
+
+```typescript
+import { NoOutputGeneratedError } from 'ai';
+
+if (NoOutputGeneratedError.isInstance(error)) {
+  // Handle the error
+}
+```

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

@@ -0,0 +1,24 @@
+---
+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 speech model response metadata (required in constructor)
+
+## 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 (`'languageModel'`, `'embeddingModel'`, `'imageModel'`, `'transcriptionModel'`, `'speechModel'`, or `'rerankingModel'`)
+- `message`: The error message (optional, auto-generated from `modelId` and `modelType`)
+
+## 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 (optional)
+- `message`: The error message (optional, auto-generated from `toolName` and `availableTools`)
+
+## 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,24 @@
+---
+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 transcription model response metadata (required in constructor)
+
+## 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-no-video-generated-error.mdx

@@ -0,0 +1,39 @@
+---
+title: AI_NoVideoGeneratedError
+description: Learn how to fix AI_NoVideoGeneratedError
+---
+
+# AI_NoVideoGeneratedError
+
+This error occurs when the AI provider fails to generate a video.
+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 (optional, defaults to `'No video generated.'`).
+- `responses`: Metadata about the video model responses, including timestamp, model, and headers (optional).
+- `cause`: The cause of the error. You can use this for more detailed error handling (optional).
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_NoVideoGeneratedError` using:
+
+```typescript
+import {
+  experimental_generateVideo as generateVideo,
+  NoVideoGeneratedError,
+} from 'ai';
+
+try {
+  await generateVideo({ model, prompt });
+} catch (error) {
+  if (NoVideoGeneratedError.isInstance(error)) {
+    console.log('NoVideoGeneratedError');
+    console.log('Cause:', error.cause);
+    console.log('Responses:', error.responses);
+  }
+}
+```

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
+}
+```

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,25 @@
+---
+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
+
+## 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
+- `cause`: The underlying validation error (required in constructor)
+
+## 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-ui-message-stream-error.mdx

@@ -0,0 +1,67 @@
+---
+title: AI_UIMessageStreamError
+description: Learn how to fix AI_UIMessageStreamError
+---
+
+# AI_UIMessageStreamError
+
+This error occurs when a UI message stream contains invalid or out-of-sequence chunks.
+
+Common causes:
+
+- Receiving a `text-delta` chunk without a preceding `text-start` chunk
+- Receiving a `text-end` chunk without a preceding `text-start` chunk
+- Receiving a `reasoning-delta` chunk without a preceding `reasoning-start` chunk
+- Receiving a `reasoning-end` chunk without a preceding `reasoning-start` chunk
+- Receiving a `tool-input-delta` chunk without a preceding `tool-input-start` chunk
+- Attempting to access a tool invocation that doesn't exist
+
+This error often surfaces when an upstream request fails **before any tokens are streamed** and a custom transport tries to write an inline error message to the UI stream without the proper start chunk.
+
+## Properties
+
+- `chunkType`: The type of chunk that caused the error (e.g., `text-delta`, `reasoning-end`, `tool-input-delta`)
+- `chunkId`: The ID associated with the failing chunk (part ID or toolCallId)
+- `message`: The error message with details about what went wrong
+
+## Checking for this Error
+
+You can check if an error is an instance of `AI_UIMessageStreamError` using:
+
+```typescript
+import { UIMessageStreamError } from 'ai';
+
+if (UIMessageStreamError.isInstance(error)) {
+  console.log('Chunk type:', error.chunkType);
+  console.log('Chunk ID:', error.chunkId);
+  // Handle the error
+}
+```
+
+## Common Solutions
+
+1. **Ensure proper chunk ordering**: Always send a `*-start` chunk before any `*-delta` or `*-end` chunks for the same ID:
+
+   ```typescript
+   // Correct order
+   writer.write({ type: 'text-start', id: 'my-text' });
+   writer.write({ type: 'text-delta', id: 'my-text', delta: 'Hello' });
+   writer.write({ type: 'text-end', id: 'my-text' });
+   ```
+
+2. **Verify IDs match**: Ensure the `id` used in `*-delta` and `*-end` chunks matches the `id` used in the corresponding `*-start` chunk.
+
+3. **Handle error paths correctly**: When writing error messages in custom transports, ensure you emit the full start/delta/end sequence:
+
+   ```typescript
+   // When handling errors in custom transports
+   writer.write({ type: 'text-start', id: errorId });
+   writer.write({
+     type: 'text-delta',
+     id: errorId,
+     delta: 'Request failed...',
+   });
+   writer.write({ type: 'text-end', id: errorId });
+   ```
+
+4. **Check stream producer logic**: Review your streaming implementation to ensure chunks are sent in the correct order, especially when dealing with concurrent operations or merged streams.

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 supported.
+
+## Properties
+
+- `functionality`: The name of the unsupported functionality
+- `message`: The error message (optional, auto-generated from `functionality`)
+
+## 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,39 @@
+---
+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_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_NoVideoGeneratedError](/docs/reference/ai-sdk-errors/ai-no-video-generated-error)
+- [AI_NoObjectGeneratedError](/docs/reference/ai-sdk-errors/ai-no-object-generated-error)
+- [AI_NoOutputGeneratedError](/docs/reference/ai-sdk-errors/ai-no-output-generated-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_UIMessageStreamError](/docs/reference/ai-sdk-errors/ai-ui-message-stream-error)
+- [AI_UnsupportedFunctionalityError](/docs/reference/ai-sdk-errors/ai-unsupported-functionality-error)

package/docs/07-reference/index.mdx

@@ -0,0 +1,28 @@
+---
+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',
+    },
+  ]}
+/>