ai 6.0.31 → 6.0.33

package/docs/07-reference/04-stream-helpers/08-anthropic-stream.mdx

@@ -0,0 +1,79 @@
+---
+title: AnthropicStream
+description: Learn to use AnthropicStream helper function in your application.
+---
+
+# `AnthropicStream`
+
+<Note type="warning">AnthropicStream has been removed in AI SDK 4.0.</Note>
+
+<Note type="warning">
+  AnthropicStream is part of the legacy Anthropic integration. It is not
+  compatible with the AI SDK 3.1 functions. It is recommended to use the [AI SDK
+  Anthropic Provider](/providers/ai-sdk-providers/anthropic) instead.
+</Note>
+
+It is a utility function that transforms the output from Anthropic's SDK into a ReadableStream. It uses AIStream under the hood, applying a specific parser for the Anthropic's response data structure.
+
+## Import
+
+### React
+
+<Snippet text={`import { AnthropicStream } 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.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### Returns
+
+A `ReadableStream`.

package/docs/07-reference/04-stream-helpers/09-aws-bedrock-stream.mdx

@@ -0,0 +1,91 @@
+---
+title: AWSBedrockStream
+description: Learn to use AWSBedrockStream helper function in your application.
+---
+
+# `AWSBedrockStream`
+
+<Note type="warning">AWSBedrockStream has been removed in AI SDK 4.0.</Note>
+
+<Note type="warning">
+  AWSBedrockStream is part of the legacy AWS Bedrock integration. It is not
+  compatible with the AI SDK 3.1 functions.
+</Note>
+
+The AWS Bedrock stream functions are utilties that transform the outputs from the AWS Bedrock API into a ReadableStream. It uses AIStream under the hood and handle parsing Bedrock's response.
+
+## Import
+
+### React
+
+<Snippet text={`import { AWSBedrockStream } from "ai"`} prompt={false} />
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'response',
+      type: 'AWSBedrockResponse',
+      description: 'The response object returned from AWS Bedrock.',
+      properties: [
+        {
+          type: 'AWSBedrockResponse',
+          parameters: [
+            {
+              name: 'body',
+              isOptional: true,
+              type: 'AsyncIterable<{ chunk?: { bytes?: Uint8Array } }>',
+              description:
+                'An optional async iterable of objects containing optional binary data chunks.',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      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.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### Returns
+
+A `ReadableStream`.

package/docs/07-reference/04-stream-helpers/10-aws-bedrock-anthropic-stream.mdx

@@ -0,0 +1,96 @@
+---
+title: AWSBedrockAnthropicStream
+description: Learn to use AWSBedrockAnthropicStream helper function in your application.
+---
+
+# `AWSBedrockAnthropicStream`
+
+<Note type="warning">
+  AWSBedrockAnthropicStream has been removed in AI SDK 4.0.
+</Note>
+
+<Note type="warning">
+  AWSBedrockAnthropicStream is part of the legacy AWS Bedrock integration. It is
+  not compatible with the AI SDK 3.1 functions.
+</Note>
+
+The AWS Bedrock stream functions are utilties that transform the outputs from the AWS Bedrock API into a ReadableStream. It uses AIStream under the hood and handle parsing Bedrock's response.
+
+## Import
+
+### React
+
+<Snippet
+  text={`import { AWSBedrockAnthropicStream } from "ai"`}
+  prompt={false}
+/>
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'response',
+      type: 'AWSBedrockResponse',
+      description: 'The response object returned from AWS Bedrock.',
+      properties: [
+        {
+          type: 'AWSBedrockResponse',
+          parameters: [
+            {
+              name: 'body',
+              isOptional: true,
+              type: 'AsyncIterable<{ chunk?: { bytes?: Uint8Array } }>',
+              description:
+                'An optional async iterable of objects containing optional binary data chunks.',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      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.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### Returns
+
+A `ReadableStream`.

package/docs/07-reference/04-stream-helpers/10-aws-bedrock-messages-stream.mdx

@@ -0,0 +1,96 @@
+---
+title: AWSBedrockAnthropicMessagesStream
+description: Learn to use AWSBedrockAnthropicMessagesStream helper function in your application.
+---
+
+# `AWSBedrockAnthropicMessagesStream`
+
+<Note type="warning">
+  AWSBedrockAnthropicMessagesStream has been removed in AI SDK 4.0.
+</Note>
+
+<Note type="warning">
+  AWSBedrockAnthropicMessagesStream is part of the legacy AWS Bedrock
+  integration. It is not compatible with the AI SDK 3.1 functions.
+</Note>
+
+The AWS Bedrock stream functions are utilties that transform the outputs from the AWS Bedrock API into a ReadableStream. It uses AIStream under the hood and handle parsing Bedrock's response.
+
+## Import
+
+### React
+
+<Snippet
+  text={`import { AWSBedrockAnthropicMessagesStream } from "ai"`}
+  prompt={false}
+/>
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'response',
+      type: 'AWSBedrockResponse',
+      description: 'The response object returned from AWS Bedrock.',
+      properties: [
+        {
+          type: 'AWSBedrockResponse',
+          parameters: [
+            {
+              name: 'body',
+              isOptional: true,
+              type: 'AsyncIterable<{ chunk?: { bytes?: Uint8Array } }>',
+              description:
+                'An optional async iterable of objects containing optional binary data chunks.',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      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.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### Returns
+
+A `ReadableStream`.

package/docs/07-reference/04-stream-helpers/11-aws-bedrock-cohere-stream.mdx

@@ -0,0 +1,93 @@
+---
+title: AWSBedrockCohereStream
+description: Learn to use AWSBedrockCohereStream helper function in your application.
+---
+
+# `AWSBedrockCohereStream`
+
+<Note type="warning">
+  AWSBedrockCohereStream has been removed in AI SDK 4.0.
+</Note>
+
+<Note type="warning">
+  AWSBedrockCohereStream is part of the legacy AWS Bedrock integration. It is
+  not compatible with the AI SDK 3.1 functions.
+</Note>
+
+## Import
+
+The AWS Bedrock stream functions are utilties that transform the outputs from the AWS Bedrock API into a ReadableStream. It uses AIStream under the hood and handles parsing Bedrock's response.
+
+### React
+
+<Snippet text={`import { AWSBedrockCohereStream } from "ai"`} prompt={false} />
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'response',
+      type: 'AWSBedrockResponse',
+      description: 'The response object returned from AWS Bedrock.',
+      properties: [
+        {
+          type: 'AWSBedrockResponse',
+          parameters: [
+            {
+              name: 'body',
+              isOptional: true,
+              type: 'AsyncIterable<{ chunk?: { bytes?: Uint8Array } }>',
+              description:
+                'An optional async iterable of objects containing optional binary data chunks.',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      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.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### Returns
+
+A `ReadableStream`.

package/docs/07-reference/04-stream-helpers/12-aws-bedrock-llama-2-stream.mdx

@@ -0,0 +1,93 @@
+---
+title: AWSBedrockLlama2Stream
+description: Learn to use AWSBedrockLlama2Stream helper function in your application.
+---
+
+# `AWSBedrockLlama2Stream`
+
+<Note type="warning">
+  AWSBedrockLlama2Stream has been removed in AI SDK 4.0.
+</Note>
+
+<Note type="warning">
+  AWSBedrockLlama2Stream is part of the legacy AWS Bedrock integration. It is
+  not compatible with the AI SDK 3.1 functions.
+</Note>
+
+The AWS Bedrock stream functions are utilties that transform the outputs from the AWS Bedrock API into a ReadableStream. It uses AIStream under the hood and handle parsing Bedrock's response.
+
+## Import
+
+### React
+
+<Snippet text={`import { AWSBedrockLlama2Stream } from "ai"`} prompt={false} />
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'response',
+      type: 'AWSBedrockResponse',
+      description: 'The response object returned from AWS Bedrock.',
+      properties: [
+        {
+          type: 'AWSBedrockResponse',
+          parameters: [
+            {
+              name: 'body',
+              isOptional: true,
+              type: 'AsyncIterable<{ chunk?: { bytes?: Uint8Array } }>',
+              description:
+                'An optional async iterable of objects containing optional binary data chunks.',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      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.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### Returns
+
+A `ReadableStream`.

package/docs/07-reference/04-stream-helpers/13-cohere-stream.mdx

@@ -0,0 +1,78 @@
+---
+title: CohereStream
+description: Learn to use CohereStream helper function in your application.
+---
+
+# `CohereStream`
+
+<Note type="warning">CohereStream has been removed in AI SDK 4.0.</Note>
+
+<Note type="warning">
+  CohereStream is part of the legacy Cohere integration. It is not compatible
+  with the AI SDK 3.1 functions.
+</Note>
+
+The CohereStream function is a utility that transforms the output from Cohere's API into a ReadableStream. It uses AIStream under the hood, applying a specific parser for the Cohere's response data structure. This works with the official Cohere API, and it's supported in both Node.js, the Edge Runtime, and browser environments.
+
+## Import
+
+### React
+
+<Snippet text={`import { CohereStream } 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.",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+### Returns
+
+A `ReadableStream`.