ai 6.0.238 → 6.0.240

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # ai
 
+## 6.0.240
+
+### Patch Changes
+
+- Updated dependencies [b28367e]
+  - @ai-sdk/gateway@3.0.162
+
+## 6.0.239
+
+### Patch Changes
+
+- Updated dependencies [d3d9e0b]
+  - @ai-sdk/gateway@3.0.161
+
 ## 6.0.238
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1170,8 +1170,10 @@ interface GenerateTextResult<TOOLS extends ToolSet, OUTPUT extends Output> {
      */
     readonly experimental_output: InferCompleteOutput<OUTPUT>;
     /**
-     * The generated structured output. It uses the `output` specification.
+     * The generated output according to the `output` specification.
      *
+     * @throws {NoOutputGeneratedError} When no output is available, for example
+     * when the final step does not finish with a `stop` reason.
      */
     readonly output: InferCompleteOutput<OUTPUT>;
 }

package/dist/index.d.ts

@@ -1170,8 +1170,10 @@ interface GenerateTextResult<TOOLS extends ToolSet, OUTPUT extends Output> {
      */
     readonly experimental_output: InferCompleteOutput<OUTPUT>;
     /**
-     * The generated structured output. It uses the `output` specification.
+     * The generated output according to the `output` specification.
      *
+     * @throws {NoOutputGeneratedError} When no output is available, for example
+     * when the final step does not finish with a `stop` reason.
      */
     readonly output: InferCompleteOutput<OUTPUT>;
 }

package/dist/index.js

@@ -1304,7 +1304,7 @@ function detectMediaType({
 var import_provider_utils3 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.238" : "0.0.0-test";
+var VERSION = true ? "6.0.240" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({

package/dist/index.mjs

@@ -1193,7 +1193,7 @@ import {
 } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "6.0.238" : "0.0.0-test";
+var VERSION = true ? "6.0.240" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({

package/dist/internal/index.js

@@ -164,7 +164,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.238" : "0.0.0-test";
+var VERSION = true ? "6.0.240" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({

package/dist/internal/index.mjs

@@ -144,7 +144,7 @@ import {
 } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "6.0.238" : "0.0.0-test";
+var VERSION = true ? "6.0.240" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({

package/docs/03-ai-sdk-core/10-generating-structured-data.mdx

@@ -415,16 +415,22 @@ console.log(result.reasoningText);
 
 ## Error Handling
 
-When `generateText` with structured output cannot generate a valid object, it throws a [`AI_NoObjectGeneratedError`](/docs/reference/ai-sdk-errors/ai-no-object-generated-error).
+`generateText` can report structured output failures in two ways:
 
-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:
+- If the model response cannot be parsed or validated against the schema,
+  `generateText` rejects with an
+  [`AI_NoObjectGeneratedError`](/docs/reference/ai-sdk-errors/ai-no-object-generated-error).
+- If `generateText` returns a result without an output, accessing `result.output`
+  throws an
+  [`AI_NoOutputGeneratedError`](/docs/reference/ai-sdk-errors/ai-no-output-generated-error).
+  This can happen when the final step does not finish with a `stop` reason, for
+  example when it finishes with `tool-calls`.
 
-- 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.
+The `output` property is a getter, so destructuring it also triggers this
+access.
 
-The error preserves the following information to help you log the issue:
+`NoObjectGeneratedError` preserves the following information to help you log
+the issue:
 
 - `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.
 - `response`: Metadata about the language model response, including response id, timestamp, and model.
@@ -432,14 +438,21 @@ The error preserves the following information to help you log the issue:
 - `cause`: The cause of the error (e.g. a JSON parsing error). You can use this for more detailed error handling.
 
 ```ts
-import { generateText, Output, NoObjectGeneratedError } from 'ai';
+import {
+  generateText,
+  NoObjectGeneratedError,
+  NoOutputGeneratedError,
+  Output,
+} from 'ai';
 
 try {
-  await generateText({
+  const result = await generateText({
     model,
     output: Output.object({ schema }),
     prompt,
   });
+
+  console.log(result.output);
 } catch (error) {
   if (NoObjectGeneratedError.isInstance(error)) {
     console.log('NoObjectGeneratedError');
@@ -447,6 +460,8 @@ try {
     console.log('Text:', error.text);
     console.log('Response:', error.response);
     console.log('Usage:', error.usage);
+  } else if (NoOutputGeneratedError.isInstance(error)) {
+    console.log('NoOutputGeneratedError');
   }
 }
 ```

package/docs/07-reference/01-ai-sdk-core/01-generate-text.mdx

@@ -2396,9 +2396,9 @@ To see `generateText` in action, check out [these examples](#examples).
     },
     {
       name: 'output',
-      type: 'Output',
-      isOptional: true,
-      description: 'Experimental setting for generating structured outputs.',
+      type: 'InferCompleteOutput<OUTPUT>',
+      description:
+        'The generated output according to the `output` specification. Accessing this property throws `NoOutputGeneratedError` when no output is available, for example when the final step does not finish with a `stop` reason.',
     },
     {
       name: 'steps',

package/docs/07-reference/01-ai-sdk-core/23-create-mcp-client.mdx

@@ -120,6 +120,13 @@ It currently does not support accepting notifications from an MCP server, and cu
                 },
               ],
             },
+            {
+              name: 'initializationOptions',
+              type: 'RequestOptions',
+              isOptional: true,
+              description:
+                'Optional signal and timeout settings that bound transport startup and the initialize request. A timeout or abort closes the transport and rejects createMCPClient.',
+            },
             {
               name: 'clientName',
               type: 'string',

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

@@ -7,6 +7,11 @@ description: Learn how to fix AI_NoOutputGeneratedError
 
 This error is thrown when no LLM output was generated, e.g. because of errors.
 
+For `generateText`, accessing `result.output` throws this error when the result
+does not contain an output. This can happen when the final step does not finish
+with a `stop` reason, for example when it finishes with `tool-calls`. The
+`output` property is a getter, so destructuring it also triggers this access.
+
 ## Properties
 
 - `message`: The error message (optional, defaults to `'No output generated.'`)

package/docs/08-migration-guides/26-migration-guide-5-0.mdx

@@ -2069,11 +2069,48 @@ import { useAssistant } from '@ai-sdk/react';
 ```
 
 ```tsx filename="AI SDK 5.0"
-// useAssistant has been removed
-// Use useChat with appropriate configuration instead
+import { useChat } from '@ai-sdk/react';
+import { DefaultChatTransport } from 'ai';
+
+function Chat() {
+  const { messages, sendMessage } = useChat({
+    transport: new DefaultChatTransport({
+      api: '/api/chat',
+    }),
+  });
+
+  // ...
+}
 ```
 
-For an implementation of the assistant functionality with AI SDK v5, see this [example repository](https://github.com/vercel-labs/ai-sdk-openai-assistants-api).
+The `useAssistant` hook was specific to the OpenAI Assistants API. OpenAI has
+deprecated that API in favor of the Responses API. Configure `useChat` for your
+route as shown above, then return a UI message stream from the route:
+
+```tsx filename="app/api/chat/route.ts"
+import { openai } from '@ai-sdk/openai';
+import { convertToModelMessages, streamText, type UIMessage } from 'ai';
+
+export async function POST(req: Request) {
+  const { messages }: { messages: UIMessage[] } = await req.json();
+
+  const result = streamText({
+    model: openai.responses('gpt-4o-mini'),
+    prompt: convertToModelMessages(messages),
+  });
+
+  return result.toUIMessageStreamResponse();
+}
+```
+
+For persistent conversation state and built-in tools, see the
+[OpenAI Responses API guide](/cookbook/guides/openai-responses).
+
+If you need to connect `useChat` to another backend, see the
+[transport documentation](/docs/ai-sdk-ui/transport) and
+[stream protocol](/docs/ai-sdk-ui/stream-protocol). For migrating existing
+OpenAI Assistants data and API calls, see OpenAI's
+[Assistants migration guide](https://platform.openai.com/docs/assistants/migration).
 
 #### Attachments → File Parts
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "6.0.238",
+  "version": "6.0.240",
   "description": "AI SDK by Vercel - build apps like ChatGPT, Claude, Gemini, and more with a single interface for any model using the Vercel AI Gateway or go direct to OpenAI, Anthropic, Google, or any other model provider.",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@ai-sdk/gateway": "3.0.160",
+    "@ai-sdk/gateway": "3.0.162",
     "@ai-sdk/provider": "3.0.14",
     "@ai-sdk/provider-utils": "4.0.41"
   },

package/src/generate-text/generate-text-result.ts

@@ -167,8 +167,10 @@ export interface GenerateTextResult<
   readonly experimental_output: InferCompleteOutput<OUTPUT>;
 
   /**
-   * The generated structured output. It uses the `output` specification.
+   * The generated output according to the `output` specification.
    *
+   * @throws {NoOutputGeneratedError} When no output is available, for example
+   * when the final step does not finish with a `stop` reason.
    */
   readonly output: InferCompleteOutput<OUTPUT>;
 }