ai 3.3.34 → 3.3.36

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # ai
 
+## 3.3.36
+
+### Patch Changes
+
+- a3882f5: feat (ai/core): add steps property to streamText result and onFinish callback
+- 1f590ef: chore (ai): rename roundtrips to steps
+- 7e82d36: fix (ai/core): pass topK to providers
+- Updated dependencies [54862e4]
+- Updated dependencies [1f590ef]
+  - @ai-sdk/react@0.0.58
+  - @ai-sdk/ui-utils@0.0.43
+  - @ai-sdk/solid@0.0.46
+  - @ai-sdk/svelte@0.0.48
+  - @ai-sdk/vue@0.0.48
+
+## 3.3.35
+
+### Patch Changes
+
+- 14210d5: feat (ai/core): add sendUsage information to streamText data stream methods
+- Updated dependencies [14210d5]
+  - @ai-sdk/ui-utils@0.0.42
+  - @ai-sdk/react@0.0.57
+  - @ai-sdk/solid@0.0.45
+  - @ai-sdk/svelte@0.0.47
+  - @ai-sdk/vue@0.0.47
+
 ## 3.3.34
 
 ### Patch Changes

package/dist/index.d.mts

@@ -355,8 +355,6 @@ type CallSettings = {
   
   The presence penalty is a number between -1 (increase repetition)
   and 1 (maximum penalty, decrease repetition). 0 means no penalty.
-  
-  @default 0
      */
     presencePenalty?: number;
     /**
@@ -365,8 +363,6 @@ type CallSettings = {
   
   The frequency penalty is a number between -1 (increase repetition)
   and 1 (maximum penalty, decrease repetition). 0 means no penalty.
-  
-  @default 0
      */
     frequencyPenalty?: number;
     /**
@@ -1315,6 +1311,53 @@ type ToToolResultObject<TOOLS extends Record<string, CoreTool>> = ValueOf<{
 type ToToolResult<TOOLS extends Record<string, CoreTool>> = ToToolResultObject<ToToolsWithDefinedExecute<ToToolsWithExecute<TOOLS>>>;
 type ToToolResultArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolResult<TOOLS>>;
 
+type StepResult<TOOLS extends Record<string, CoreTool>> = {
+    /**
+  The generated text.
+  */
+    readonly text: string;
+    /**
+  The tool calls that were made during the generation.
+  */
+    readonly toolCalls: ToToolCallArray<TOOLS>;
+    /**
+  The results of the tool calls.
+  */
+    readonly toolResults: ToToolResultArray<TOOLS>;
+    /**
+  The reason why the generation finished.
+  */
+    readonly finishReason: FinishReason;
+    /**
+  The token usage of the generated text.
+  */
+    readonly usage: LanguageModelUsage$1;
+    /**
+  Warnings from the model provider (e.g. unsupported settings)
+  */
+    readonly warnings: CallWarning[] | undefined;
+    /**
+  Logprobs for the completion.
+  `undefined` if the mode does not support logprobs or if was not enabled.
+  */
+    readonly logprobs: LogProbs | undefined;
+    /**
+  Optional raw response data.
+  
+  @deprecated Use `response.headers` instead.
+     */
+    readonly rawResponse?: {
+        /**
+    Response headers.
+    */
+        readonly headers?: Record<string, string>;
+    };
+    /**
+  Additional response information.
+  */
+    readonly response: LanguageModelResponseMetadataWithHeaders;
+};
+
 /**
 The result of a `generateText` call.
 It contains the generated text, the tool calls that were made during the generation, and the results of the tool calls.
@@ -1353,55 +1396,18 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
        */
     readonly responseMessages: Array<CoreAssistantMessage | CoreToolMessage>;
     /**
-    Response information for every roundtrip.
-    You can use this to get information about intermediate steps, such as the tool calls or the response headers.
+  Response information for every roundtrip.
+  You can use this to get information about intermediate steps, such as the tool calls or the response headers.
+  
+  @deprecated use `steps` instead.
      */
-    readonly roundtrips: Array<{
-        /**
-      The generated text.
-       */
-        readonly text: string;
-        /**
-      The tool calls that were made during the generation.
-      */
-        readonly toolCalls: ToToolCallArray<TOOLS>;
-        /**
-      The results of the tool calls.
-      */
-        readonly toolResults: ToToolResultArray<TOOLS>;
-        /**
-      The reason why the generation finished.
-       */
-        readonly finishReason: FinishReason;
-        /**
-      The token usage of the generated text.
-      */
-        readonly usage: LanguageModelUsage$1;
-        /**
-      Warnings from the model provider (e.g. unsupported settings)
-       */
-        readonly warnings: CallWarning[] | undefined;
-        /**
-      Logprobs for the completion.
-      `undefined` if the mode does not support logprobs or if was not enabled.
-       */
-        readonly logprobs: LogProbs | undefined;
-        /**
-    Optional raw response data.
-    
-    @deprecated Use `response.headers` instead.
-       */
-        readonly rawResponse?: {
-            /**
-      Response headers.
-       */
-            readonly headers?: Record<string, string>;
-        };
-        /**
-    Additional response information.
+    readonly roundtrips: Array<StepResult<TOOLS>>;
+    /**
+  Details for all steps.
+  You can use this to get information about intermediate steps,
+  such as the tool calls or the response headers.
      */
-        readonly response: LanguageModelResponseMetadataWithHeaders;
-    }>;
+    readonly steps: Array<StepResult<TOOLS>>;
     /**
   Optional raw response data.
   
@@ -1419,7 +1425,7 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
     readonly response: LanguageModelResponseMetadataWithHeaders;
     /**
   Logprobs for the completion.
-  `undefined` if the mode does not support logprobs or if was not enabled.
+  `undefined` if the mode does not support logprobs or if it was not enabled.
   
   @deprecated Will become a provider extension in the future.
        */
@@ -1471,12 +1477,12 @@ If set and supported by the model, calls will generate deterministic results.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
 @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
-@param maxToolRoundtrips - Maximal number of automatic roundtrips for tool calls.
+@param maxSteps - Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
 
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1494,7 +1500,7 @@ The tool choice strategy. Default: 'auto'.
      */
     maxAutomaticRoundtrips?: number;
     /**
-Maximal number of automatic roundtrips for tool calls.
+Maximum number of automatic roundtrips for tool calls.
 
 An automatic tool call roundtrip is another LLM call with the
 tool call results when all tool calls of the last assistant
@@ -1504,9 +1510,19 @@ A maximum number is required to prevent infinite loops in the
 case of misconfigured tools.
 
 By default, it's set to 0, which will disable the feature.
+
+@deprecated Use `maxSteps` instead (which is `maxToolRoundtrips` + 1).
      */
     maxToolRoundtrips?: number;
     /**
+Maximum number of sequential LLM calls (steps), e.g. when you use tool calls. Must be at least 1.
+
+A maximum number is required to prevent infinite loops in the case of misconfigured tools.
+
+By default, it's set to 1, which means that only a single LLM call is made.
+     */
+    maxSteps?: number;
+    /**
      * Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
@@ -1534,42 +1550,42 @@ A result object for accessing different stream types and additional information.
  */
 interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
     /**
-  Warnings from the model provider (e.g. unsupported settings) for the first roundtrip.
+  Warnings from the model provider (e.g. unsupported settings) for the first step.
        */
     readonly warnings: CallWarning[] | undefined;
     /**
   The total token usage of the generated response.
-  When there are multiple roundtrips, the usage is the sum of all roundtrip usages.
+  When there are multiple steps, the usage is the sum of all step usages.
   
   Resolved when the response is finished.
        */
     readonly usage: Promise<LanguageModelUsage$1>;
     /**
-  The reason why the generation finished. Taken from the last roundtrip.
+  The reason why the generation finished. Taken from the last step.
   
   Resolved when the response is finished.
        */
     readonly finishReason: Promise<FinishReason>;
     /**
-  Additional provider-specific metadata from the last roundtrip.
+  Additional provider-specific metadata from the last step.
   Metadata is passed through from the provider to the AI SDK and
   enables provider-specific results that can be fully encapsulated in the provider.
      */
     readonly experimental_providerMetadata: Promise<ProviderMetadata | undefined>;
     /**
-  The full text that has been generated by the last roundtrip.
+  The full text that has been generated by the last step.
   
   Resolved when the response is finished.
        */
     readonly text: Promise<string>;
     /**
-  The tool calls that have been executed in the last roundtrip.
+  The tool calls that have been executed in the last step.
   
   Resolved when the response is finished.
        */
     readonly toolCalls: Promise<ToToolCall<TOOLS>[]>;
     /**
-  The tool results that have been generated in the last roundtrip.
+  The tool results that have been generated in the last step.
   
   Resolved when the all tool executions are finished.
        */
@@ -1586,6 +1602,12 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         headers?: Record<string, string>;
     };
     /**
+  Details for all steps.
+  You can use this to get information about intermediate steps,
+  such as the tool calls or the response headers.
+     */
+    readonly steps: Promise<Array<StepResult<TOOLS>>>;
+    /**
   Additional response information.
    */
     readonly response: Promise<LanguageModelResponseMetadataWithHeaders>;
@@ -1619,12 +1641,14 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
     @param data an optional StreamData object that will be merged into the stream.
     @param getErrorMessage an optional function that converts an error to an error message.
+    @param sendUsage whether to send the usage information to the client. Defaults to true.
   
     @return A data stream.
        */
     toDataStream(options?: {
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
+        sendUsage?: boolean;
     }): ReadableStream<Uint8Array>;
     /**
     Writes stream data output to a Node.js response-like object.
@@ -1651,6 +1675,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         init?: ResponseInit;
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
+        sendUsage?: boolean;
     }): void;
     /**
     Writes text delta output to a Node.js response-like object.
@@ -1689,6 +1714,7 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
         init?: ResponseInit;
         data?: StreamData;
         getErrorMessage?: (error: unknown) => string;
+        sendUsage?: boolean;
     }): Response;
     /**
     Creates a simple text stream response.
@@ -1716,7 +1742,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
 } | ({
     type: 'tool-result';
 } & ToToolResult<TOOLS>) | {
-    type: 'roundtrip-finish';
+    type: 'step-finish';
     finishReason: FinishReason;
     logprobs?: LogProbs;
     usage: LanguageModelUsage$1;
@@ -1771,7 +1797,7 @@ If set and supported by the model, calls will generate deterministic results.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
 @param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
-@param maxToolRoundtrips - Maximal number of automatic roundtrips for tool calls.
+@param maxSteps - Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
 
 @param onChunk - Callback that is called for each chunk of the stream. The stream processing will pause until the callback promise is resolved.
 @param onFinish - Callback that is called when the LLM response and all request tool executions
@@ -1780,7 +1806,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 Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, maxSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1794,7 +1820,7 @@ The tool choice strategy. Default: 'auto'.
      */
     toolChoice?: CoreToolChoice<TOOLS>;
     /**
-Maximal number of automatic roundtrips for tool calls.
+Maximum number of automatic roundtrips for tool calls.
 
 An automatic tool call roundtrip is another LLM call with the
 tool call results when all tool calls of the last assistant
@@ -1804,9 +1830,19 @@ A maximum number is required to prevent infinite loops in the
 case of misconfigured tools.
 
 By default, it's set to 0, which will disable the feature.
+
+@deprecated Use `maxSteps` instead (which is `maxToolRoundtrips` + 1).
      */
     maxToolRoundtrips?: number;
     /**
+Maximum number of sequential LLM calls (steps), e.g. when you use tool calls. Must be at least 1.
+
+A maximum number is required to prevent infinite loops in the case of misconfigured tools.
+
+By default, it's set to 1, which means that only a single LLM call is made.
+ */
+    maxSteps?: number;
+    /**
 Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
@@ -1869,6 +1905,10 @@ Callback that is called when the LLM response and all request tool executions
          */
         response: LanguageModelResponseMetadataWithHeaders;
         /**
+  Details for all steps.
+         */
+        steps: StepResult<TOOLS>[];
+        /**
   Warnings from the model provider (e.g. unsupported settings).
          */
         warnings?: CallWarning[];