@fairyhunter13/ai-sdk 6.0.116-fork.1

package/docs/07-reference/03-ai-sdk-rsc/20-render.mdx

@@ -0,0 +1,266 @@
+---
+title: render (Removed)
+description: Reference for the render function from the AI SDK RSC
+---
+
+# `render` (Removed)
+
+<Note type="warning">"render" has been removed in AI SDK 4.0.</Note>
+
+<Note type="warning">
+  AI SDK RSC is currently experimental. We recommend using [AI SDK
+  UI](/docs/ai-sdk-ui/overview) for production. For guidance on migrating from
+  RSC to UI, see our [migration guide](/docs/ai-sdk-rsc/migrating-to-ui).
+</Note>
+
+A helper function to create a streamable UI from LLM providers. This function is similar to AI SDK Core APIs and supports the same model interfaces.
+
+> **Note**: `render` has been deprecated in favor of [`streamUI`](/docs/reference/ai-sdk-rsc/stream-ui). During migration, please ensure that the `messages` parameter follows the updated [specification](/docs/reference/ai-sdk-rsc/stream-ui#messages).
+
+## Import (No longer available)
+
+The following import will no longer work since `render` has been removed:
+
+<Snippet text={`import { render } from "@ai-sdk/rsc"`} prompt={false} />
+
+Use [`streamUI`](/docs/reference/ai-sdk-rsc/stream-ui) instead.
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'model',
+      type: 'string',
+      description: 'Model identifier, must be OpenAI SDK compatible.',
+    },
+    {
+      name: 'provider',
+      type: 'provider client',
+      description:
+        'Currently the only provider available is OpenAI. This needs to match the model name.',
+    },
+    {
+      name: 'initial',
+      isOptional: true,
+      type: 'ReactNode',
+      description: 'The initial UI to render.',
+    },
+    {
+      name: 'messages',
+      type: 'Array<SystemMessage | UserMessage | AssistantMessage | ToolMessage>',
+      description: 'A list of messages that represent a conversation.',
+      properties: [
+        {
+          type: 'SystemMessage',
+          parameters: [
+            {
+              name: 'role',
+              type: "'system'",
+              description: 'The role for the system message.',
+            },
+            {
+              name: 'content',
+              type: 'string',
+              description: 'The content of the message.',
+            },
+          ],
+        },
+        {
+          type: 'UserMessage',
+          parameters: [
+            {
+              name: 'role',
+              type: "'user'",
+              description: 'The role for the user message.',
+            },
+            {
+              name: 'content',
+              type: 'string',
+              description: 'The content of the message.',
+            },
+          ],
+        },
+        {
+          type: 'AssistantMessage',
+          parameters: [
+            {
+              name: 'role',
+              type: "'assistant'",
+              description: 'The role for the assistant message.',
+            },
+            {
+              name: 'content',
+              type: 'string',
+              description: 'The content of the message.',
+            },
+            {
+              name: 'tool_calls',
+              type: 'ToolCall[]',
+              description: 'A list of tool calls made by the model.',
+              properties: [
+                {
+                  type: 'ToolCall',
+                  parameters: [
+                    {
+                      name: 'id',
+                      type: 'string',
+                      description: 'The id of the tool call.',
+                    },
+                    {
+                      name: 'type',
+                      type: "'function'",
+                      description: 'The type of the tool call.',
+                    },
+                    {
+                      name: 'function',
+                      type: 'Function',
+                      description: 'The function to call.',
+                      properties: [
+                        {
+                          type: 'Function',
+                          parameters: [
+                            {
+                              name: 'name',
+                              type: 'string',
+                              description: 'The name of the function.',
+                            },
+                            {
+                              name: 'arguments',
+                              type: 'string',
+                              description: 'The arguments of the function.',
+                            },
+                          ],
+                        },
+                      ],
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+        {
+          type: 'ToolMessage',
+          parameters: [
+            {
+              name: 'role',
+              type: "'tool'",
+              description: 'The role for the tool message.',
+            },
+            {
+              name: 'content',
+              type: 'string',
+              description: 'The content of the message.',
+            },
+            {
+              name: 'toolCallId',
+              type: 'string',
+              description: 'The id of the tool call.',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: 'functions',
+      type: 'ToolSet',
+      isOptional: true,
+      description:
+        'Tools that are accessible to and can be called by the model.',
+      properties: [
+        {
+          type: 'Tool',
+          parameters: [
+            {
+              name: 'description',
+              isOptional: true,
+              type: 'string',
+              description:
+                'Information about the purpose of the tool including details on how and when it can be used by the model.',
+            },
+            {
+              name: 'parameters',
+              type: 'zod schema',
+              description:
+                'The typed schema that describes the parameters of the tool that can also be used to validation and error handling.',
+            },
+            {
+              name: 'render',
+              isOptional: true,
+              type: 'async (parameters) => any',
+              description:
+                'An async function that is called with the arguments from the tool call and produces a result.',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: 'tools',
+      type: 'ToolSet',
+      isOptional: true,
+      description:
+        'Tools that are accessible to and can be called by the model.',
+      properties: [
+        {
+          type: 'Tool',
+          parameters: [
+            {
+              name: 'description',
+              isOptional: true,
+              type: 'string',
+              description:
+                'Information about the purpose of the tool including details on how and when it can be used by the model.',
+            },
+            {
+              name: 'parameters',
+              type: 'zod schema',
+              description:
+                'The typed schema that describes the parameters of the tool that can also be used to validation and error handling.',
+            },
+            {
+              name: 'render',
+              isOptional: true,
+              type: 'async (parameters) => any',
+              description:
+                'An async function that is called with the arguments from the tool call and produces a result.',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: 'text',
+      isOptional: true,
+      type: '(Text) => ReactNode',
+      description: 'Callback to handle the generated tokens from the model.',
+      properties: [
+        {
+          type: 'Text',
+          parameters: [
+            {
+              name: 'content',
+              type: 'string',
+              description: 'The full content of the completion.',
+            },
+            { name: 'delta', type: 'string', description: 'The delta.' },
+            { name: 'done', type: 'boolean', description: 'Is it done?' },
+          ],
+        },
+      ],
+    },
+    {
+      name: 'temperature',
+      isOptional: true,
+      type: 'number',
+      description: 'The temperature to use for the model.',
+    },
+  ]}
+/>
+
+### Returns
+
+It can return any valid ReactNode.

package/docs/07-reference/03-ai-sdk-rsc/index.mdx

@@ -0,0 +1,67 @@
+---
+title: AI SDK RSC
+description: Reference documentation for the AI SDK RSC
+collapsed: true
+---
+
+# AI SDK RSC
+
+<Note type="warning">
+  AI SDK RSC is currently experimental. We recommend using [AI SDK
+  UI](/docs/ai-sdk-ui/overview) for production. For guidance on migrating from
+  RSC to UI, see our [migration guide](/docs/ai-sdk-rsc/migrating-to-ui).
+</Note>
+
+<IndexCards
+  cards={[
+    {
+      title: 'streamUI',
+      description:
+        'Use a helper function that streams React Server Components on tool execution.',
+      href: '/docs/reference/ai-sdk-rsc/stream-ui',
+    },
+    {
+      title: 'createAI',
+      description:
+        'Create a context provider that wraps your application and shares state between the client and language model on the server.',
+      href: '/docs/reference/ai-sdk-rsc/create-ai',
+    },
+    {
+      title: 'createStreamableUI',
+      description:
+        'Create a streamable UI component that can be rendered on the server and streamed to the client.',
+      href: '/docs/reference/ai-sdk-rsc/create-streamable-ui',
+    },
+    {
+      title: 'createStreamableValue',
+      description:
+        'Create a streamable value that can be rendered on the server and streamed to the client.',
+      href: '/docs/reference/ai-sdk-rsc/create-streamable-value',
+    },
+    {
+      title: 'getAIState',
+      description: 'Read the AI state on the server.',
+      href: '/docs/reference/ai-sdk-rsc/get-ai-state',
+    },
+    {
+      title: 'getMutableAIState',
+      description: 'Read and update the AI state on the server.',
+      href: '/docs/reference/ai-sdk-rsc/get-mutable-ai-state',
+    },
+    {
+      title: 'useAIState',
+      description: 'Get the AI state on the client from the context provider.',
+      href: '/docs/reference/ai-sdk-rsc/use-ai-state',
+    },
+    {
+      title: 'useUIState',
+      description: 'Get the UI state on the client from the context provider.',
+      href: '/docs/reference/ai-sdk-rsc/use-ui-state',
+    },
+    {
+      title: 'useActions',
+      description: 'Call server actions from the client.',
+      href: '/docs/reference/ai-sdk-rsc/use-actions',
+    },
+  ]}
+/>

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

@@ -0,0 +1,31 @@
+---
+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 (optional)
+- `responseHeaders`: The response headers returned by the API (optional)
+- `responseBody`: The response body returned by the API (optional)
+- `isRetryable`: Whether the request can be retried based on the status code
+- `data`: Any additional data associated with the error (optional)
+- `cause`: The underlying error that caused the API call to fail (optional)
+
+## 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,28 @@
+---
+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 (optional)
+- `statusText`: The HTTP status text returned by the server (optional)
+- `cause`: The underlying error that caused the download to fail (optional)
+- `message`: The error message containing details about the download failure (optional, auto-generated)
+
+## 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,26 @@
+---
+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
+- `cause`: The underlying error that caused this error (optional)
+- `message`: The error message describing the expected and received content types (optional, auto-generated)
+
+## 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-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 (optional, auto-generated from `role`)
+
+## 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 (required in constructor)
+- `cause`: The cause of the error (optional)
+
+## 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,24 @@
+---
+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
+
+## 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
+- `cause`: The underlying parsing error (required in constructor)
+
+## 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
+}
+```