ai 6.0.31 → 6.0.32

package/docs/07-reference/04-stream-helpers/14-google-generative-ai-stream.mdx

@@ -0,0 +1,85 @@
+---
+title: GoogleGenerativeAIStream
+description: Learn to use GoogleGenerativeAIStream helper function in your application.
+---
+
+# `GoogleGenerativeAIStream`
+
+<Note type="warning">
+  GoogleGenerativeAIStream has been removed in AI SDK 4.0.
+</Note>
+
+<Note type="warning">
+  GoogleGenerativeAIStream is part of the legacy Google Generative AI
+  integration. It is not compatible with the AI SDK 3.1 functions. It is
+  recommended to use the [AI SDK Google Generative AI
+  Provider](/providers/ai-sdk-providers/google-generative-ai) instead.
+</Note>
+
+The GoogleGenerativeAIStream function is a utility that transforms the output from Google's Generative AI SDK into a ReadableStream. It uses AIStream under the hood, applying a specific parser for the Google's response data structure. This works with the official Generative AI SDK, and it's supported in both Node.js, Edge Runtime, and browser environments.
+
+## Import
+
+### React
+
+<Snippet
+  text={`import { GoogleGenerativeAIStream } from "ai"`}
+  prompt={false}
+/>
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'response',
+      type: '{ stream: AsyncIterable<GenerateContentResponse> }',
+      description:
+        'The response object returned by the Google Generative AI API.',
+    },
+    {
+      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/15-hugging-face-stream.mdx

@@ -0,0 +1,84 @@
+---
+title: HuggingFaceStream
+description: Learn to use HuggingFaceStream helper function in your application.
+---
+
+# `HuggingFaceStream`
+
+<Note type="warning">HuggingFaceStream has been removed in AI SDK 4.0.</Note>
+
+<Note type="warning">
+  HuggingFaceStream is part of the legacy Hugging Face integration. It is not
+  compatible with the AI SDK 3.1 functions.
+</Note>
+
+Converts the output from language models hosted on Hugging Face into a ReadableStream.
+
+While HuggingFaceStream is compatible with most Hugging Face language models, the rapidly evolving landscape of models may result in certain new or niche models not being supported. If you encounter a model that isn't supported, we encourage you to open an issue.
+
+To ensure that AI responses are comprised purely of text without any delimiters that could pose issues when rendering in chat or completion modes, we standardize and remove special end-of-response tokens. If your use case requires a different handling of responses, you can fork and modify this stream to meet your specific needs.
+
+Currently, `</s>` and `<|endoftext|>` are recognized as end-of-stream tokens.
+
+## Import
+
+### React
+
+<Snippet text={`import { HuggingFaceStream } from "ai"`} prompt={false} />
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'iter',
+      type: 'AsyncGenerator<any>',
+      description:
+        'This parameter should be the generator function returned by the hf.textGenerationStream method in the Hugging Face Inference 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/16-langchain-adapter.mdx

@@ -0,0 +1,98 @@
+---
+title: '@ai-sdk/langchain Adapter'
+description: API Reference for the LangChain Adapter.
+---
+
+# `@ai-sdk/langchain`
+
+The `@ai-sdk/langchain` module provides helper functions to transform LangChain output streams into data streams and data stream responses.
+See the [LangChain Adapter documentation](/providers/adapters/langchain) for more information.
+
+It supports:
+
+- LangChain StringOutputParser streams
+- LangChain AIMessageChunk streams
+- LangChain StreamEvents v2 streams
+
+## Import
+
+<Snippet
+  text={`import { toDataStreamResponse } from "@ai-sdk/langchain"`}
+  prompt={false}
+/>
+
+## API Signature
+
+### Methods
+
+<PropertiesTable
+  content={[
+    {
+      name: 'toDataStream',
+      type: '(stream: ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, AIStreamCallbacksAndOptions) => AIStream',
+      description: 'Converts LangChain output streams to data stream.',
+    },
+    {
+      name: 'toDataStreamResponse',
+      type: '(stream: ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, options?: {init?: ResponseInit, data?: StreamData, callbacks?: AIStreamCallbacksAndOptions}) => Response',
+      description: 'Converts LangChain output streams to data stream response.',
+    },
+    {
+      name: 'mergeIntoDataStream',
+      type: '(stream: ReadableStream<LangChainStreamEvent> | ReadableStream<LangChainAIMessageChunk> | ReadableStream<string>, options: { dataStream: DataStreamWriter; callbacks?: StreamCallbacks }) => void',
+      description:
+        'Merges LangChain output streams into an existing data stream.',
+    },
+  ]}
+/>
+
+## Examples
+
+### Convert LangChain Expression Language Stream
+
+```tsx filename="app/api/completion/route.ts" highlight={"13"}
+import { toUIMessageStream } from '@ai-sdk/langchain';
+import { ChatOpenAI } from '@langchain/openai';
+import { createUIMessageStreamResponse } from 'ai';
+
+export async function POST(req: Request) {
+  const { prompt } = await req.json();
+
+  const model = new ChatOpenAI({
+    model: 'gpt-3.5-turbo-0125',
+    temperature: 0,
+  });
+
+  const stream = await model.stream(prompt);
+
+  return createUIMessageStreamResponse({
+    stream: toUIMessageStream(stream),
+  });
+}
+```
+
+### Convert StringOutputParser Stream
+
+```tsx filename="app/api/completion/route.ts" highlight={"16"}
+import { toUIMessageStream } from '@ai-sdk/langchain';
+import { StringOutputParser } from '@langchain/core/output_parsers';
+import { ChatOpenAI } from '@langchain/openai';
+import { createUIMessageStreamResponse } from 'ai';
+
+export async function POST(req: Request) {
+  const { prompt } = await req.json();
+
+  const model = new ChatOpenAI({
+    model: 'gpt-3.5-turbo-0125',
+    temperature: 0,
+  });
+
+  const parser = new StringOutputParser();
+
+  const stream = await model.pipe(parser).stream(prompt);
+
+  return createUIMessageStreamResponse({
+    stream: toUIMessageStream(stream),
+  });
+}
+```

package/docs/07-reference/04-stream-helpers/16-llamaindex-adapter.mdx

@@ -0,0 +1,70 @@
+---
+title: '@ai-sdk/llamaindex Adapter'
+description: API Reference for the LlamaIndex Adapter.
+---
+
+# `@ai-sdk/llamaindex`
+
+The `@ai-sdk/llamaindex` package provides helper functions to transform LlamaIndex output streams into data streams and data stream responses.
+See the [LlamaIndex Adapter documentation](/providers/adapters/llamaindex) for more information.
+
+It supports:
+
+- LlamaIndex ChatEngine streams
+- LlamaIndex QueryEngine streams
+
+## Import
+
+<Snippet
+  text={`import { toDataResponse } from "@ai-sdk/llamaindex"`}
+  prompt={false}
+/>
+
+## API Signature
+
+### Methods
+
+<PropertiesTable
+  content={[
+    {
+      name: 'toDataStream',
+      type: '(stream: AsyncIterable<EngineResponse>, AIStreamCallbacksAndOptions) => AIStream',
+      description: 'Converts LlamaIndex output streams to data stream.',
+    },
+    {
+      name: 'toDataStreamResponse',
+      type: '(stream: AsyncIterable<EngineResponse>, options?: {init?: ResponseInit, data?: StreamData, callbacks?: AIStreamCallbacksAndOptions}) => Response',
+      description:
+        'Converts LlamaIndex output streams to data stream response.',
+    },
+    {
+      name: 'mergeIntoDataStream',
+      type: '(stream: AsyncIterable<EngineResponse>, options: { dataStream: DataStreamWriter; callbacks?: StreamCallbacks }) => void',
+      description:
+        'Merges LlamaIndex output streams into an existing data stream.',
+    },
+  ]}
+/>
+
+## Examples
+
+### Convert LlamaIndex ChatEngine Stream
+
+```tsx filename="app/api/completion/route.ts" highlight="15"
+import { OpenAI, SimpleChatEngine } from 'llamaindex';
+import { toDataStreamResponse } from '@ai-sdk/llamaindex';
+
+export async function POST(req: Request) {
+  const { prompt } = await req.json();
+
+  const llm = new OpenAI({ model: 'gpt-4o' });
+  const chatEngine = new SimpleChatEngine({ llm });
+
+  const stream = await chatEngine.chat({
+    message: prompt,
+    stream: true,
+  });
+
+  return toDataStreamResponse(stream);
+}
+```

package/docs/07-reference/04-stream-helpers/17-mistral-stream.mdx

@@ -0,0 +1,81 @@
+---
+title: MistralStream
+description: Learn to use MistralStream helper function in your application.
+---
+
+# `MistralStream`
+
+<Note type="warning">MistralStream has been removed in AI SDK 4.0.</Note>
+
+<Note type="warning">
+  MistralStream is part of the legacy Mistral integration. It is not compatible
+  with the AI SDK 3.1 functions. It is recommended to use the [AI SDK Mistral
+  Provider](/providers/ai-sdk-providers/mistral) instead.
+</Note>
+
+Transforms the output from Mistral's language models into a ReadableStream.
+
+This works with the official Mistral API, and it's supported in both Node.js, the Edge Runtime, and browser environments.
+
+## Import
+
+### React
+
+<Snippet text={`import { MistralStream } 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/18-replicate-stream.mdx

@@ -0,0 +1,83 @@
+---
+title: ReplicateStream
+description: Learn to use ReplicateStream helper function in your application.
+---
+
+# `ReplicateStream`
+
+<Note type="warning">ReplicateStream has been removed in AI SDK 4.0.</Note>
+
+<Note type="warning">
+  ReplicateStream is part of the legacy Replicate integration. It is not
+  compatible with the AI SDK 3.1 functions.
+</Note>
+
+The ReplicateStream function is a utility that handles extracting the stream from the output of [Replicate](https://replicate.com)'s API. It expects a Prediction object as returned by the [Replicate JavaScript SDK](https://github.com/replicate/replicate-javascript), and returns a ReadableStream. Unlike other wrappers, ReplicateStream returns a Promise because it makes a fetch call to the [Replicate streaming API](https://github.com/replicate/replicate-javascript#streaming) under the hood.
+
+## Import
+
+### React
+
+<Snippet text={`import { ReplicateStream } from "ai"`} prompt={false} />
+
+## API Signature
+
+### Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'pre',
+      type: 'Prediction',
+      description: 'Object returned by the Replicate JavaScript 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.",
+            },
+          ],
+        },
+      ],
+    },
+    {
+      name: 'options',
+      type: '{ headers?: Record<string, string> }',
+      isOptiona: true,
+      description: 'An optional parameter for passing additional headers.',
+    },
+  ]}
+/>
+
+### Returns
+
+A `ReadableStream` wrapped in a promise.

package/docs/07-reference/04-stream-helpers/19-inkeep-stream.mdx

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

@@ -0,0 +1,103 @@
+---
+title: Stream Helpers
+description: Learn to use help functions that help stream generations from different providers.
+collapsed: true
+---
+
+<IndexCards
+  cards={[
+    {
+      title: 'AIStream',
+      description: 'Create a readable stream for AI responses.',
+      href: '/docs/reference/stream-helpers/ai-stream',
+    },
+    {
+      title: 'StreamingTextResponse',
+      description: 'Create a streaming response for text generations.',
+      href: '/docs/reference/stream-helpers/streaming-text-response',
+    },
+    {
+      title: 'streamtoResponse',
+      description: 'Pipe a ReadableStream to a Node.js ServerResponse object.',
+      href: '/docs/reference/stream-helpers/stream-to-response',
+    },
+    {
+      title: 'OpenAIStream',
+      description:
+        "Transforms the response from OpenAI's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/openai-stream',
+    },
+    {
+      title: 'AnthropicStream',
+      description:
+        "Transforms the response from Anthropic's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/anthropic-stream',
+    },
+    {
+      title: 'AWSBedrockStream',
+      description:
+        "Transforms the response from AWS Bedrock's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/aws-bedrock-stream',
+    },
+    {
+      title: 'AWSBedrockMessagesStream',
+      description:
+        "Transforms the response from AWS Bedrock Message's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/aws-bedrock-messages-stream',
+    },
+    {
+      title: 'AWSBedrockCohereStream',
+      description:
+        "Transforms the response from AWS Bedrock Cohere's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/aws-bedrock-cohere-stream',
+    },
+    {
+      title: 'AWSBedrockLlama-2Stream',
+      description:
+        "Transforms the response from AWS Bedrock Llama-2's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/aws-bedrock-llama-2-stream',
+    },
+    {
+      title: 'CohereStream',
+      description:
+        "Transforms the response from Cohere's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/cohere-stream',
+    },
+    {
+      title: 'GoogleGenerativeAIStream',
+      description:
+        "Transforms the response from Google's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/google-generative-ai-stream',
+    },
+    {
+      title: 'HuggingFaceStream',
+      description:
+        "Transforms the response from Hugging Face's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/hugging-face-stream',
+    },
+    {
+      title: 'LangChainStream',
+      description:
+        "Transforms the response from LangChain's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/langchain-adapter',
+    },
+    {
+      title: 'MistralStream',
+      description:
+        "Transforms the response from Mistral's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/mistral-stream',
+    },
+    {
+      title: 'ReplicateStream',
+      description:
+        "Transforms the response from Replicate's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/replicate-stream',
+    },
+    {
+      title: 'InkeepsStream',
+      description:
+        "Transforms the response from Inkeeps's language models into a readable stream.",
+      href: '/docs/reference/stream-helpers/inkeep-stream',
+    },
+  ]}
+/>