ai 6.0.31 → 6.0.33

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

@@ -0,0 +1,262 @@
+---
+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
+
+<Snippet text={`import { render } from "@ai-sdk/rsc"`} prompt={false} />
+
+## 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 UI
+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/04-stream-helpers/01-ai-stream.mdx

@@ -0,0 +1,89 @@
+---
+title: AIStream
+description: Learn to use AIStream helper function in your application.
+---
+
+# `AIStream`
+
+<Note type="warning">
+  AIStream has been removed in AI SDK 4.0. Use
+  `streamText.toDataStreamResponse()` instead.
+</Note>
+
+Creates a readable stream for AI responses. This is based on the responses returned
+by fetch and serves as the basis for the OpenAIStream and AnthropicStream. It allows
+you to handle AI response streams in a controlled and customized manner that will
+work with useChat and useCompletion.
+
+AIStream will throw an error if response doesn't have a 2xx status code. This is to ensure that the stream is only created for successful responses.
+
+## Import
+
+### React
+
+<Snippet text={`import { AIStream } from "ai"`} prompt={false} />
+
+## API Signature
+
+<PropertiesTable
+  content={[
+    {
+      name: 'response',
+      type: 'Response',
+      description:
+        "This is the response object returned by fetch. It's used as the source of the readable stream.",
+    },
+    {
+      name: 'customParser',
+      type: '(AIStreamParser) => void',
+      description:
+        'This is a function that is used to parse the events in the stream. It should return a function that receives a stringified chunk from the LLM and extracts the message content. The function is expected to return nothing (void) or a string.',
+      properties: [
+        {
+          type: 'AIStreamParser',
+          parameters: [
+            {
+              name: '',
+              type: '(data: string) => string | void',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: 'callbacks',
+      type: 'AIStreamCallbacksAndOptions',
+      properties: [
+        {
+          type: 'AIStreamCallbacksAndOptions',
+          parameters: [
+            {
+              name: 'onStart',
+              type: '() => Promise<void>',
+              description:
+                'An optional function that is called at the start of the stream processing.',
+            },
+            {
+              name: 'onCompletion',
+              type: '(completion: string) => Promise<void>',
+              description:
+                "An optional function that is called for every completion. It's passed the completion as a string.",
+            },
+            {
+              name: 'onFinal',
+              type: '(completion: string) => Promise<void>',
+              description:
+                'An optional function that is called once when the stream is closed with the final completion message.',
+            },
+            {
+              name: 'onToken',
+              type: '(token: string) => Promise<void>',
+              description:
+                "An optional function that is called for each token in the stream. It's passed the token as a string.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>

package/docs/07-reference/04-stream-helpers/02-streaming-text-response.mdx

@@ -0,0 +1,79 @@
+---
+title: StreamingTextResponse
+description: Learn to use StreamingTextResponse helper function in your application.
+---
+
+# `StreamingTextResponse`
+
+<Note type="warning">
+  `StreamingTextResponse` has been removed in AI SDK 4.0. Use
+  [`streamText.toDataStreamResponse()`](/docs/reference/ai-sdk-core/stream-text)
+  instead.
+</Note>
+
+It is a utility class that simplifies the process of returning a ReadableStream of text in HTTP responses.
+It is a lightweight wrapper around the native Response class, automatically setting the status code to 200 and the Content-Type header to 'text/plain; charset=utf-8'.
+
+## Import
+
+<Snippet text={`import { StreamingTextResponse } from "ai"`} prompt={false} />
+
+## API Signature
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'stream',
+      type: 'ReadableStream',
+      description: 'The stream of content which represents the HTTP response.',
+    },
+    {
+      name: 'init',
+      isOptional: true,
+      type: 'ResponseInit',
+      description:
+        'It can be used to customize the properties of the HTTP response. It is an object that corresponds to the ResponseInit object used in the Response constructor.',
+      properties: [
+        {
+          type: 'ResponseInit',
+          parameters: [
+            {
+              name: 'status',
+              type: 'number',
+              isOptional: true,
+              description:
+                'The status code for the response. StreamingTextResponse will overwrite this value with 200.',
+            },
+            {
+              name: 'statusText',
+              type: 'string',
+              isOptional: true,
+              description:
+                'The status message associated with the status code.',
+            },
+            {
+              name: 'headers',
+              type: 'HeadersInit',
+              isOptional: true,
+              description:
+                "Any headers you want to add to your response. StreamingTextResponse will add 'Content-Type': 'text/plain; charset=utf-8' to these headers.",
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: 'data',
+      isOptional: true,
+      type: 'StreamData',
+      description:
+        'StreamData object that you are using to generate additional data for the response.',
+    },
+  ]}
+/>
+
+### Returns
+
+An instance of Response with the provided ReadableStream as the body, the status set to 200, and the Content-Type header set to 'text/plain; charset=utf-8'. Additional headers and properties can be added using the init parameter

package/docs/07-reference/04-stream-helpers/05-stream-to-response.mdx

@@ -0,0 +1,108 @@
+---
+title: streamToResponse
+description: Learn to use streamToResponse helper function in your application.
+---
+
+# `streamToResponse`
+
+<Note type="warning">
+  `streamToResponse` has been removed in AI SDK 4.0. Use
+  `pipeDataStreamToResponse` from
+  [streamText](/docs/reference/ai-sdk-core/stream-text) instead.
+</Note>
+
+`streamToResponse` pipes a data stream to a Node.js `ServerResponse` object and sets the status code and headers.
+
+This is useful to create data stream responses in environments that use `ServerResponse` objects, such as Node.js HTTP servers.
+
+The status code and headers can be configured using the `options` parameter.
+By default, the status code is set to 200 and the Content-Type header is set to `text/plain; charset=utf-8`.
+
+## Import
+
+<Snippet text={`import { streamToResponse } from "ai"`} prompt={false} />
+
+## Example
+
+You can e.g. use `streamToResponse` to pipe a data stream to a Node.js HTTP server response:
+
+```ts
+import { StreamData, streamText, streamToResponse } from 'ai';
+__PROVIDER_IMPORT__;
+import { createServer } from 'http';
+
+createServer(async (req, res) => {
+  const result = streamText({
+    model: __MODEL__,
+    prompt: 'What is the weather in San Francisco?',
+  });
+
+  // use stream data
+  const data = new StreamData();
+
+  data.append('initialized call');
+
+  streamToResponse(
+    result.toAIStream({
+      onFinal() {
+        data.append('call completed');
+        data.close();
+      },
+    }),
+    res,
+    {},
+    data,
+  );
+}).listen(8080);
+```
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'stream',
+      type: 'ReadableStream',
+      description:
+        'The Web Stream to pipe to the response. It can be the return value of OpenAIStream, HuggingFaceStream, AnthropicStream, or an AIStream instance.',
+    },
+    {
+      name: 'response',
+      type: 'ServerResponse',
+      description:
+        'The Node.js ServerResponse object to pipe the stream to. This is usually the second argument of a Node.js HTTP request handler.',
+    },
+    {
+      name: 'options',
+      type: 'Options',
+      description: 'Configure the response',
+      properties: [
+        {
+          type: 'Options',
+          parameters: [
+            {
+              name: 'status',
+              type: 'number',
+              description:
+                'The status code to set on the response. Defaults to `200`.',
+            },
+            {
+              name: 'headers',
+              type: 'Record<string, string>',
+              description:
+                "Additional headers to set on the response. Defaults to `{ 'Content-Type': 'text/plain; charset=utf-8' }`.",
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: 'data',
+      type: 'StreamData',
+      description:
+        'StreamData object for forwarding additional data to the client.',
+    },
+  ]}
+/>

package/docs/07-reference/04-stream-helpers/07-openai-stream.mdx

@@ -0,0 +1,77 @@
+---
+title: OpenAIStream
+description: Learn to use OpenAIStream helper function in your application.
+---
+
+# `OpenAIStream`
+
+<Note type="warning">OpenAIStream has been removed in AI SDK 4.0</Note>
+
+<Note type="warning">
+  OpenAIStream is part of the legacy OpenAI integration. It is not compatible
+  with the AI SDK 3.1 functions. It is recommended to use the [AI SDK OpenAI
+  Provider](/providers/ai-sdk-providers/openai) instead.
+</Note>
+
+Transforms the response from OpenAI's language models into a ReadableStream.
+
+Note: Prior to v4, the official OpenAI API SDK does not support the Edge Runtime and only works in serverless environments. The openai-edge package is based on fetch instead of axios (and thus works in the Edge Runtime) so we recommend using openai v4+ or openai-edge.
+
+## Import
+
+### React
+
+<Snippet text={`import { OpenAIStream } from "ai"`} prompt={false} />
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'response',
+      type: 'Response',
+      description:
+        'The response object returned by a call made by the Provider SDK.',
+    },
+    {
+      name: 'callbacks',
+      type: 'AIStreamCallbacksAndOptions',
+      isOptional: true,
+      description:
+        'An object containing callback functions to handle the start, each token, and completion of the AI response. In the absence of this parameter, default behavior is implemented.',
+      properties: [
+        {
+          type: 'AIStreamCallbacksAndOptions',
+          parameters: [
+            {
+              name: 'onStart',
+              type: '() => Promise<void>',
+              description:
+                'An optional function that is called at the start of the stream processing.',
+            },
+            {
+              name: 'onCompletion',
+              type: '(completion: string) => Promise<void>',
+              description:
+                "An optional function that is called for every completion. It's passed the completion as a string.",
+            },
+            {
+              name: 'onFinal',
+              type: '(completion: string) => Promise<void>',
+              description:
+                'An optional function that is called once when the stream is closed with the final completion message.',
+            },
+            {
+              name: 'onToken',
+              type: '(token: string) => Promise<void>',
+              description:
+                "An optional function that is called for each token in the stream. It's passed the token as a string.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>