ai 6.0.93 → 6.0.95

package/docs/03-ai-sdk-core/55-testing.mdx

@@ -99,14 +99,14 @@ const result = streamText({
 });
 ```
 
-### generateObject
+### generateText with Output
 
 ```ts
-import { generateObject } from 'ai';
+import { generateText, Output } from 'ai';
 import { MockLanguageModelV3 } from 'ai/test';
 import { z } from 'zod';
 
-const result = await generateObject({
+const result = await generateText({
   model: new MockLanguageModelV3({
     doGenerate: async () => ({
       content: [{ type: 'text', text: `{"content":"Hello, world!"}` }],
@@ -127,19 +127,19 @@ const result = await generateObject({
       warnings: [],
     }),
   }),
-  schema: z.object({ content: z.string() }),
+  output: Output.object({ schema: z.object({ content: z.string() }) }),
   prompt: 'Hello, test!',
 });
 ```
 
-### streamObject
+### streamText with Output
 
 ```ts
-import { streamObject, simulateReadableStream } from 'ai';
+import { streamText, Output, simulateReadableStream } from 'ai';
 import { MockLanguageModelV3 } from 'ai/test';
 import { z } from 'zod';
 
-const result = streamObject({
+const result = streamText({
   model: new MockLanguageModelV3({
     doStream: async () => ({
       stream: simulateReadableStream({
@@ -174,7 +174,7 @@ const result = streamObject({
       }),
     }),
   }),
-  schema: z.object({ content: z.string() }),
+  output: Output.object({ schema: z.object({ content: z.string() }) }),
   prompt: 'Hello, test!',
 });
 ```

package/docs/03-ai-sdk-core/60-telemetry.mdx

@@ -151,60 +151,21 @@ const result = await generateText({
 
 It also records a `ai.stream.firstChunk` event when the first chunk of the stream is received.
 
-### generateObject function
+### Deprecated object APIs
 
-`generateObject` records 2 types of spans:
-
-- `ai.generateObject` (span): the full length of the generateObject call. It contains 1 or more `ai.generateObject.doGenerate` spans.
-  It contains the [basic LLM span information](#basic-llm-span-information) and the following attributes:
-
-  - `operation.name`: `ai.generateObject` and the functionId that was set through `telemetry.functionId`
-  - `ai.operationId`: `"ai.generateObject"`
-  - `ai.prompt`: the prompt that was used when calling `generateObject`
-  - `ai.schema`: Stringified JSON schema version of the schema that was passed into the `generateObject` function
-  - `ai.schema.name`: the name of the schema that was passed into the `generateObject` function
-  - `ai.schema.description`: the description of the schema that was passed into the `generateObject` function
-  - `ai.response.object`: the object that was generated (stringified JSON)
-  - `ai.settings.output`: the output type that was used, e.g. `object` or `no-schema`
-
-- `ai.generateObject.doGenerate` (span): a provider doGenerate call.
-  It contains the [call LLM span information](#call-llm-span-information) and the following attributes:
-
-  - `operation.name`: `ai.generateObject.doGenerate` and the functionId that was set through `telemetry.functionId`
-  - `ai.operationId`: `"ai.generateObject.doGenerate"`
-  - `ai.prompt.messages`: the messages that were passed into the provider
-  - `ai.response.object`: the object that was generated (stringified JSON)
-  - `ai.response.finishReason`: the reason why the generation finished
-
-### streamObject function
-
-`streamObject` records 2 types of spans and 1 type of event:
-
-- `ai.streamObject` (span): the full length of the streamObject call. It contains 1 or more `ai.streamObject.doStream` spans.
-  It contains the [basic LLM span information](#basic-llm-span-information) and the following attributes:
+<Note type="warning">
+  `generateObject` and `streamObject` are deprecated. Use `generateText` and
+  `streamText` with the `output` property instead.
+</Note>
 
-  - `operation.name`: `ai.streamObject` and the functionId that was set through `telemetry.functionId`
-  - `ai.operationId`: `"ai.streamObject"`
-  - `ai.prompt`: the prompt that was used when calling `streamObject`
-  - `ai.schema`: Stringified JSON schema version of the schema that was passed into the `streamObject` function
-  - `ai.schema.name`: the name of the schema that was passed into the `streamObject` function
-  - `ai.schema.description`: the description of the schema that was passed into the `streamObject` function
-  - `ai.response.object`: the object that was generated (stringified JSON)
-  - `ai.settings.output`: the output type that was used, e.g. `object` or `no-schema`
-
-- `ai.streamObject.doStream` (span): a provider doStream call.
-  This span contains an `ai.stream.firstChunk` event.
-  It contains the [call LLM span information](#call-llm-span-information) and the following attributes:
+If you still run deprecated object APIs, you will see legacy span names:
 
-  - `operation.name`: `ai.streamObject.doStream` and the functionId that was set through `telemetry.functionId`
-  - `ai.operationId`: `"ai.streamObject.doStream"`
-  - `ai.prompt.messages`: the messages that were passed into the provider
-  - `ai.response.object`: the object that was generated (stringified JSON)
-  - `ai.response.msToFirstChunk`: the time it took to receive the first chunk
-  - `ai.response.finishReason`: the reason why the generation finished
+- `generateObject`: `ai.generateObject`, `ai.generateObject.doGenerate`
+- `streamObject`: `ai.streamObject`, `ai.streamObject.doStream`, `ai.stream.firstChunk`
 
-- `ai.stream.firstChunk` (event): an event that is emitted when the first chunk of the stream is received.
-  - `ai.response.msToFirstChunk`: the time it took to receive the first chunk
+Legacy object spans include the same core metadata as other LLM spans, plus
+object-specific attributes such as `ai.schema.*`, `ai.response.object`, and
+`ai.settings.output`.
 
 ### embed function
 
@@ -250,8 +211,7 @@ It also records a `ai.stream.firstChunk` event when the first chunk of the strea
 
 ### Basic LLM span information
 
-Many spans that use LLMs (`ai.generateText`, `ai.generateText.doGenerate`, `ai.streamText`, `ai.streamText.doStream`,
-`ai.generateObject`, `ai.generateObject.doGenerate`, `ai.streamObject`, `ai.streamObject.doStream`) contain the following attributes:
+Many spans that use LLMs (`ai.generateText`, `ai.generateText.doGenerate`, `ai.streamText`, `ai.streamText.doStream`) contain the following attributes:
 
 - `resource.name`: the functionId that was set through `telemetry.functionId`
 - `ai.model.id`: the id of the model
@@ -266,7 +226,7 @@ Many spans that use LLMs (`ai.generateText`, `ai.generateText.doGenerate`, `ai.s
 
 ### Call LLM span information
 
-Spans that correspond to individual LLM calls (`ai.generateText.doGenerate`, `ai.streamText.doStream`, `ai.generateObject.doGenerate`, `ai.streamObject.doStream`) contain
+Spans that correspond to individual LLM calls (`ai.generateText.doGenerate`, `ai.streamText.doStream`) contain
 [basic LLM span information](#basic-llm-span-information) and the following attributes:
 
 - `ai.response.model`: the model that was used to generate the response. This can be different from the model that was requested if the provider supports aliases.

package/docs/05-ai-sdk-rsc/02-streaming-react-components.mdx

@@ -18,7 +18,7 @@ import { Weather } from '@/components/home/weather';
 
 The RSC API allows you to stream React components from the server to the client with the [`streamUI`](/docs/reference/ai-sdk-rsc/stream-ui) function. This is useful when you want to go beyond raw text and stream components to the client in real-time.
 
-Similar to [ AI SDK Core ](/docs/ai-sdk-core/overview) APIs (like [ `streamText` ](/docs/reference/ai-sdk-core/stream-text) and [ `streamObject` ](/docs/reference/ai-sdk-core/stream-object)), `streamUI` provides a single function to call a model and allow it to respond with React Server Components.
+Similar to [ AI SDK Core ](/docs/ai-sdk-core/overview) APIs (like [ `streamText` ](/docs/reference/ai-sdk-core/stream-text)), `streamUI` provides a single function to call a model and allow it to respond with React Server Components.
 It supports the same model interfaces as AI SDK Core APIs.
 
 ### Concepts

package/docs/05-ai-sdk-rsc/05-streaming-values.mdx

@@ -20,9 +20,8 @@ The RSC API provides several utility functions to allow you to stream values fro
 
 <Note>
   These utilities can also be paired with [AI SDK Core](/docs/ai-sdk-core)
-  functions like [`streamText`](/docs/reference/ai-sdk-core/stream-text) and
-  [`streamObject`](/docs/reference/ai-sdk-core/stream-object) to easily stream
-  LLM generations from the server to the client.
+  functions like [`streamText`](/docs/reference/ai-sdk-core/stream-text) to
+  easily stream LLM generations from the server to the client.
 </Note>
 
 There are two functions provided by the RSC API that allow you to create streamable values:

package/docs/05-ai-sdk-rsc/10-migrating-to-ui.mdx

@@ -598,12 +598,12 @@ export function Chat({
 
 ## Streaming Object Generation
 
-The `createStreamableValue` function streams any serializable data from the server to the client. As a result, this function allows you to stream object generations from the server to the client when paired with `streamObject`.
+The `createStreamableValue` function streams any serializable data from the server to the client. As a result, this function allows you to stream object generations from the server to the client when paired with `streamText` and `Output`.
 
 #### Before: Use streamable value to stream object generations
 
 ```ts filename="@/app/actions.ts"
-import { streamObject } from 'ai';
+import { Output, streamText } from 'ai';
 import { openai } from '@ai-sdk/openai';
 import { createStreamableValue } from '@ai-sdk/rsc';
 import { notificationsSchema } from '@/utils/schemas';
@@ -614,14 +614,14 @@ export async function generateSampleNotifications() {
   const stream = createStreamableValue();
 
   (async () => {
-    const { partialObjectStream } = streamObject({
+    const { partialOutputStream } = streamText({
       model: __MODEL__,
       system: 'generate sample ios messages for testing',
       prompt: 'messages from a family group chat during diwali, max 4',
-      schema: notificationsSchema,
+      output: Output.object({ schema: notificationsSchema }),
     });
 
-    for await (const partialObject of partialObjectStream) {
+    for await (const partialObject of partialOutputStream) {
       stream.update(partialObject);
     }
   })();
@@ -667,21 +667,21 @@ export default function Page() {
 }
 ```
 
-To migrate to AI SDK UI, you should use the `useObject` hook and implement `streamObject` within your route handler.
+To migrate to AI SDK UI, you should use the `useObject` hook and implement `streamText` with `Output` within your route handler.
 
 #### After: Replace with route handler and stream text response
 
 ```ts filename="@/app/api/object/route.ts"
-import { streamObject } from 'ai';
+import { Output, streamText } from 'ai';
 import { openai } from '@ai-sdk/openai';
 import { notificationSchema } from '@/utils/schemas';
 
 export async function POST(req: Request) {
   const context = await req.json();
 
-  const result = streamObject({
+  const result = streamText({
     model: __MODEL__,
-    schema: notificationSchema,
+    output: Output.object({ schema: notificationSchema }),
     prompt:
       `Generate 3 notifications for a messages app in this context:` + context,
   });

package/docs/06-advanced/04-caching.mdx

@@ -110,7 +110,7 @@ export const cacheMiddleware: LanguageModelV3Middleware = {
   responses but you can use any KV storage provider you would like.
 </Note>
 
-`LanguageModelV3Middleware` has two methods: `wrapGenerate` and `wrapStream`. `wrapGenerate` is called when using [`generateText`](/docs/reference/ai-sdk-core/generate-text) and [`generateObject`](/docs/reference/ai-sdk-core/generate-object), while `wrapStream` is called when using [`streamText`](/docs/reference/ai-sdk-core/stream-text) and [`streamObject`](/docs/reference/ai-sdk-core/stream-object).
+`LanguageModelV3Middleware` has two methods: `wrapGenerate` and `wrapStream`. `wrapGenerate` is called when using [`generateText`](/docs/reference/ai-sdk-core/generate-text), while `wrapStream` is called when using [`streamText`](/docs/reference/ai-sdk-core/stream-text).
 
 For `wrapGenerate`, you can cache the response directly. Instead, for `wrapStream`, you cache an array of the stream parts, which can then be used with [`simulateReadableStream`](/docs/ai-sdk-core/testing#simulate-data-stream-protocol-responses) function to create a simulated `ReadableStream` that returns the cached response. In this way, the cached response is returned chunk-by-chunk as if it were being generated by the model. You can control the initial delay and delay between chunks by adjusting the `initialDelayInMs` and `chunkDelayInMs` parameters of `simulateReadableStream`.
 

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

@@ -25,14 +25,9 @@ AI SDK Core contains the following main functions:
       href: '/docs/reference/ai-sdk-core/stream-text',
     },
     {
-      title: 'generateObject()',
-      description: 'Generate structured data from a language model.',
-      href: '/docs/reference/ai-sdk-core/generate-object',
-    },
-    {
-      title: 'streamObject()',
-      description: 'Stream structured data from a language model.',
-      href: '/docs/reference/ai-sdk-core/stream-object',
+      title: 'Output',
+      description: 'Structured output types for generateText and streamText.',
+      href: '/docs/reference/ai-sdk-core/output',
     },
     {
       title: 'embed()',

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

@@ -26,10 +26,10 @@ It can arise due to the following reasons:
 You can check if an error is an instance of `AI_NoObjectGeneratedError` using:
 
 ```typescript
-import { generateObject, NoObjectGeneratedError } from 'ai';
+import { generateText, NoObjectGeneratedError, Output } from 'ai';
 
 try {
-  await generateObject({ model, schema, prompt });
+  await generateText({ model, output: Output.object({ schema }), prompt });
 } catch (error) {
   if (NoObjectGeneratedError.isInstance(error)) {
     console.log('NoObjectGeneratedError');

package/docs/09-troubleshooting/09-client-stream-error.mdx

@@ -7,7 +7,7 @@ description: Troubleshooting errors related to using AI SDK Core functions with
 
 ## Issue
 
-I am using [`streamText`](/docs/reference/ai-sdk-core/stream-text) or [`streamObject`](/docs/reference/ai-sdk-core/stream-object) with Server Actions, and I am getting a `"only plain objects and a few built ins can be passed from client components"` error.
+I am using [`streamText`](/docs/reference/ai-sdk-core/stream-text) with Server Actions, and I am getting a `"only plain objects and a few built ins can be passed from client components"` error.
 
 ## Background
 

package/docs/09-troubleshooting/14-tool-calling-with-structured-outputs.mdx

@@ -1,13 +1,13 @@
 ---
-title: Tool calling with generateObject and streamObject
-description: Troubleshooting tool calling when combined with generateObject and streamObject
+title: Tool calling with structured outputs
+description: Troubleshooting tool calling when combined with structured output generation
 ---
 
-# Tool calling with generateObject and streamObject (structured outputs)
+# Tool calling with structured outputs
 
 ## Issue
 
-You may want to combine tool calling with structured output generation. While `generateObject` and `streamObject` are designed specifically for structured outputs, they don't support tool calling.
+You may want to combine tool calling with structured output generation.
 
 ## Background
 

package/docs/09-troubleshooting/20-no-object-generated-content-filter.mdx

@@ -7,20 +7,22 @@ description: Troubleshooting NoObjectGeneratedError with finish-reason content-f
 
 ## Issue
 
-When using `generateObject` or `streamObject` with OpenAI's structured output generation, you may encounter a `NoObjectGeneratedError` with the finish reason `content-filter`. This error occurs when your Zod schema contains incompatible types that OpenAI's structured output feature cannot process.
+When using structured output generation with OpenAI, you may encounter a `NoObjectGeneratedError` with the finish reason `content-filter`. This error occurs when your Zod schema contains incompatible types that OpenAI's structured output feature cannot process.
 
 ```typescript
 // Problematic code - incompatible schema types
-import { generateObject } from 'ai';
+import { generateText, Output } from 'ai';
 import { openai } from '@ai-sdk/openai';
 import { z } from 'zod';
 
-const result = await generateObject({
+const result = await generateText({
   model: openai('gpt-4o-2024-08-06'),
-  schema: z.object({
-    name: z.string().nullish(), // ❌ .nullish() is not supported
-    email: z.string().optional(), // ❌ .optional() is not supported
-    age: z.number().nullable(), // ✅ .nullable() is supported
+  output: Output.object({
+    schema: z.object({
+      name: z.string().nullish(), // ❌ .nullish() is not supported
+      email: z.string().optional(), // ❌ .optional() is not supported
+      age: z.number().nullable(), // ✅ .nullable() is supported
+    }),
   }),
   prompt: 'Generate a user profile',
 });
@@ -38,22 +40,24 @@ OpenAI's structured output generation uses JSON Schema under the hood and has sp
 Replace `.nullish()` and `.optional()` with `.nullable()` in your Zod schemas when using structured output generation with OpenAI models.
 
 ```typescript
-import { generateObject } from 'ai';
+import { generateText, Output } from 'ai';
 import { openai } from '@ai-sdk/openai';
 import { z } from 'zod';
 
 // Correct approach - use .nullable()
-const result = await generateObject({
+const result = await generateText({
   model: openai('gpt-4o-2024-08-06'),
-  schema: z.object({
-    name: z.string().nullable(), // ✅ Use .nullable() instead of .nullish()
-    email: z.string().nullable(), // ✅ Use .nullable() instead of .optional()
-    age: z.number().nullable(),
+  output: Output.object({
+    schema: z.object({
+      name: z.string().nullable(), // ✅ Use .nullable() instead of .nullish()
+      email: z.string().nullable(), // ✅ Use .nullable() instead of .optional()
+      age: z.number().nullable(),
+    }),
   }),
   prompt: 'Generate a user profile',
 });
 
-console.log(result.object);
+console.log(result.output);
 // { name: "John Doe", email: "john@example.com", age: 30 }
 // or { name: null, email: null, age: 25 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "6.0.93",
+  "version": "6.0.95",
   "description": "AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@opentelemetry/api": "1.9.0",
-    "@ai-sdk/gateway": "3.0.51",
+    "@ai-sdk/gateway": "3.0.53",
     "@ai-sdk/provider": "3.0.8",
     "@ai-sdk/provider-utils": "4.0.15"
   },