ai 6.0.0-beta.70 → 6.0.0-beta.71

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 6.0.0-beta.71
+
+### Patch Changes
+
+- 077aea3: feat(ai): stable structured output on generateText, streamText, and ToolLoopAgent
+
 ## 6.0.0-beta.70
 
 ### Patch Changes

package/dist/index.d.mts

@@ -632,9 +632,16 @@ interface GenerateTextResult<TOOLS extends ToolSet, OUTPUT> {
      */
     readonly steps: Array<StepResult<TOOLS>>;
     /**
-  The generated structured output. It uses the `experimental_output` specification.
+  The generated structured output. It uses the `output` specification.
+  
+  @deprecated Use `output` instead.
      */
     readonly experimental_output: OUTPUT;
+    /**
+  The generated structured output. It uses the `output` specification.
+  
+     */
+    readonly output: OUTPUT;
 }
 
 /**
@@ -1092,7 +1099,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1134,7 +1141,13 @@ changing the tool call and result types in the result.
     /**
 Optional specification for parsing structured outputs from the LLM response.
      */
-    experimental_output?: Output<OUTPUT, OUTPUT_PARTIAL>;
+    output?: Output<OUTPUT, PARTIAL_OUTPUT>;
+    /**
+Optional specification for parsing structured outputs from the LLM response.
+
+@deprecated Use `output` instead.
+     */
+    experimental_output?: Output<OUTPUT, PARTIAL_OUTPUT>;
     /**
 Custom download function to use for URLs.
 
@@ -1332,7 +1345,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1374,6 +1387,12 @@ functionality that can be fully encapsulated in the provider.
     /**
 Optional specification for parsing structured outputs from the LLM response.
      */
+    output?: Output<OUTPUT, PARTIAL_OUTPUT>;
+    /**
+Optional specification for parsing structured outputs from the LLM response.
+
+@deprecated Use `output` instead.
+ */
     experimental_output?: Output<OUTPUT, PARTIAL_OUTPUT>;
     /**
 Optional function that you can use to provide different settings for a step.
@@ -2301,10 +2320,16 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
        */
     readonly fullStream: AsyncIterableStream<TextStreamPart<TOOLS>>;
     /**
-  A stream of partial outputs. It uses the `experimental_output` specification.
+     * A stream of partial outputs. It uses the `output` specification.
+     *
+     * @deprecated Use `partialOutputStream` instead.
      */
     readonly experimental_partialOutputStream: AsyncIterableStream<PARTIAL_OUTPUT>;
     /**
+     * A stream of partial outputs. It uses the `output` specification.
+     */
+    readonly partialOutputStream: AsyncIterableStream<PARTIAL_OUTPUT>;
+    /**
   Consumes the stream without processing the parts.
   This is useful to force the stream to finish.
   It effectively removes the backpressure and allows the stream to finish,
@@ -2553,9 +2578,9 @@ type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUT
      */
     activeTools?: Array<keyof NoInfer<TOOLS>>;
     /**
-  Optional specification for parsing structured outputs from the LLM response.
+  Optional specification for generating structured outputs.
      */
-    experimental_output?: OUTPUT;
+    output?: OUTPUT;
     /**
   Optional function that you can use to provide different settings for a step.
     */

package/dist/index.d.ts

@@ -632,9 +632,16 @@ interface GenerateTextResult<TOOLS extends ToolSet, OUTPUT> {
      */
     readonly steps: Array<StepResult<TOOLS>>;
     /**
-  The generated structured output. It uses the `experimental_output` specification.
+  The generated structured output. It uses the `output` specification.
+  
+  @deprecated Use `output` instead.
      */
     readonly experimental_output: OUTPUT;
+    /**
+  The generated structured output. It uses the `output` specification.
+  
+     */
+    readonly output: OUTPUT;
 }
 
 /**
@@ -1092,7 +1099,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_download: download, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1134,7 +1141,13 @@ changing the tool call and result types in the result.
     /**
 Optional specification for parsing structured outputs from the LLM response.
      */
-    experimental_output?: Output<OUTPUT, OUTPUT_PARTIAL>;
+    output?: Output<OUTPUT, PARTIAL_OUTPUT>;
+    /**
+Optional specification for parsing structured outputs from the LLM response.
+
+@deprecated Use `output` instead.
+     */
+    experimental_output?: Output<OUTPUT, PARTIAL_OUTPUT>;
     /**
 Custom download function to use for URLs.
 
@@ -1332,7 +1345,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output, output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, experimental_download: download, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1374,6 +1387,12 @@ functionality that can be fully encapsulated in the provider.
     /**
 Optional specification for parsing structured outputs from the LLM response.
      */
+    output?: Output<OUTPUT, PARTIAL_OUTPUT>;
+    /**
+Optional specification for parsing structured outputs from the LLM response.
+
+@deprecated Use `output` instead.
+ */
     experimental_output?: Output<OUTPUT, PARTIAL_OUTPUT>;
     /**
 Optional function that you can use to provide different settings for a step.
@@ -2301,10 +2320,16 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
        */
     readonly fullStream: AsyncIterableStream<TextStreamPart<TOOLS>>;
     /**
-  A stream of partial outputs. It uses the `experimental_output` specification.
+     * A stream of partial outputs. It uses the `output` specification.
+     *
+     * @deprecated Use `partialOutputStream` instead.
      */
     readonly experimental_partialOutputStream: AsyncIterableStream<PARTIAL_OUTPUT>;
     /**
+     * A stream of partial outputs. It uses the `output` specification.
+     */
+    readonly partialOutputStream: AsyncIterableStream<PARTIAL_OUTPUT>;
+    /**
   Consumes the stream without processing the parts.
   This is useful to force the stream to finish.
   It effectively removes the backpressure and allows the stream to finish,
@@ -2553,9 +2578,9 @@ type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUT
      */
     activeTools?: Array<keyof NoInfer<TOOLS>>;
     /**
-  Optional specification for parsing structured outputs from the LLM response.
+  Optional specification for generating structured outputs.
      */
-    experimental_output?: OUTPUT;
+    output?: OUTPUT;
     /**
   Optional function that you can use to provide different settings for a step.
     */

package/dist/index.js

@@ -876,7 +876,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.70" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.71" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -2647,7 +2647,8 @@ async function generateText({
   abortSignal,
   headers,
   stopWhen = stepCountIs(1),
-  experimental_output: output,
+  experimental_output,
+  output = experimental_output,
   experimental_telemetry: telemetry,
   providerOptions,
   experimental_activeTools,
@@ -3158,6 +3159,9 @@ var DefaultGenerateTextResult = class {
     return this.finalStep.usage;
   }
   get experimental_output() {
+    return this.output;
+  }
+  get output() {
     if (this.resolvedOutput == null) {
       throw new NoOutputSpecifiedError();
     }
@@ -4937,7 +4941,8 @@ function streamText({
   abortSignal,
   headers,
   stopWhen = stepCountIs(1),
-  experimental_output: output,
+  experimental_output,
+  output = experimental_output,
   experimental_telemetry: telemetry,
   prepareStep,
   providerOptions,
@@ -5988,6 +5993,9 @@ var DefaultStreamTextResult = class {
     }
   }
   get experimental_partialOutputStream() {
+    return this.partialOutputStream;
+  }
+  get partialOutputStream() {
     if (this.output == null) {
       throw new NoOutputSpecifiedError();
     }