ai 5.0.0-alpha.10 → 5.0.0-alpha.12

package/dist/internal/index.d.mts

@@ -368,7 +368,7 @@ type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'requ
 };
 
 type ToolParameters<T = JSONObject> = z4.$ZodType<T> | z3.Schema<T> | Schema<T>;
-interface ToolExecutionOptions {
+interface ToolCallOptions {
     /**
      * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
      */
@@ -412,11 +412,30 @@ If not provided, the tool will not be executed automatically.
 @args is the input of the tool call.
 @options.abortSignal is a signal that can be used to abort the tool call.
     */
-    execute: (args: [PARAMETERS] extends [never] ? undefined : PARAMETERS, options: ToolExecutionOptions) => PromiseLike<RESULT>;
+    execute: (args: [PARAMETERS] extends [never] ? undefined : PARAMETERS, options: ToolCallOptions) => PromiseLike<RESULT>;
     /**
 Optional conversion function that maps the tool result to multi-part tool content for LLMs.
     */
     experimental_toToolResultContent?: (result: RESULT) => ToolResultContent;
+    /**
+     * Optional function that is called when the argument streaming starts.
+     * Only called when the tool is used in a streaming context.
+     */
+    onArgsStreamingStart?: (options: ToolCallOptions) => void | PromiseLike<void>;
+    /**
+     * Optional function that is called when an argument streaming delta is available.
+     * Only called when the tool is used in a streaming context.
+     */
+    onArgsStreamingDelta?: (options: {
+        argsTextDelta: string;
+    } & ToolCallOptions) => void | PromiseLike<void>;
+    /**
+     * Optional function that is called when a tool call can be started,
+     * even if the execute function is not provided.
+     */
+    onArgsAvailable?: (options: {
+        args: [PARAMETERS] extends [never] ? undefined : PARAMETERS;
+    } & ToolCallOptions) => void | PromiseLike<void>;
 }> & ({
     /**
 Function tool.
@@ -437,7 +456,7 @@ The arguments for configuring the tool. Must match the expected arguments define
     args: Record<string, unknown>;
 });
 
-type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute'>>;
+type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute' | 'onArgsAvailable' | 'onArgsStreamingStart' | 'onArgsStreamingDelta'>>;
 
 declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolChoice, activeTools, }: {
     tools: TOOLS | undefined;

package/dist/internal/index.d.ts

@@ -368,7 +368,7 @@ type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'requ
 };
 
 type ToolParameters<T = JSONObject> = z4.$ZodType<T> | z3.Schema<T> | Schema<T>;
-interface ToolExecutionOptions {
+interface ToolCallOptions {
     /**
      * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
      */
@@ -412,11 +412,30 @@ If not provided, the tool will not be executed automatically.
 @args is the input of the tool call.
 @options.abortSignal is a signal that can be used to abort the tool call.
     */
-    execute: (args: [PARAMETERS] extends [never] ? undefined : PARAMETERS, options: ToolExecutionOptions) => PromiseLike<RESULT>;
+    execute: (args: [PARAMETERS] extends [never] ? undefined : PARAMETERS, options: ToolCallOptions) => PromiseLike<RESULT>;
     /**
 Optional conversion function that maps the tool result to multi-part tool content for LLMs.
     */
     experimental_toToolResultContent?: (result: RESULT) => ToolResultContent;
+    /**
+     * Optional function that is called when the argument streaming starts.
+     * Only called when the tool is used in a streaming context.
+     */
+    onArgsStreamingStart?: (options: ToolCallOptions) => void | PromiseLike<void>;
+    /**
+     * Optional function that is called when an argument streaming delta is available.
+     * Only called when the tool is used in a streaming context.
+     */
+    onArgsStreamingDelta?: (options: {
+        argsTextDelta: string;
+    } & ToolCallOptions) => void | PromiseLike<void>;
+    /**
+     * Optional function that is called when a tool call can be started,
+     * even if the execute function is not provided.
+     */
+    onArgsAvailable?: (options: {
+        args: [PARAMETERS] extends [never] ? undefined : PARAMETERS;
+    } & ToolCallOptions) => void | PromiseLike<void>;
 }> & ({
     /**
 Function tool.
@@ -437,7 +456,7 @@ The arguments for configuring the tool. Must match the expected arguments define
     args: Record<string, unknown>;
 });
 
-type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute'>>;
+type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute' | 'onArgsAvailable' | 'onArgsStreamingStart' | 'onArgsStreamingDelta'>>;
 
 declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolChoice, activeTools, }: {
     tools: TOOLS | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "5.0.0-alpha.10",
+  "version": "5.0.0-alpha.12",
   "description": "AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -42,9 +42,9 @@
   },
   "dependencies": {
     "@opentelemetry/api": "1.9.0",
-    "@ai-sdk/gateway": "1.0.0-alpha.10",
-    "@ai-sdk/provider": "2.0.0-alpha.10",
-    "@ai-sdk/provider-utils": "3.0.0-alpha.10"
+    "@ai-sdk/gateway": "1.0.0-alpha.12",
+    "@ai-sdk/provider": "2.0.0-alpha.12",
+    "@ai-sdk/provider-utils": "3.0.0-alpha.12"
   },
   "devDependencies": {
     "@types/json-schema": "7.0.15",