@ai-sdk/provider-utils 5.0.0-canary.36 → 5.0.0-canary.38

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/provider-utils
 
+## 5.0.0-canary.38
+
+### Patch Changes
+
+- ca446f8: feat: flexible tool descriptions
+
+## 5.0.0-canary.37
+
+### Patch Changes
+
+- d848405: feat: add optional `abortSignal` parameters to sandbox command execution
+
 ## 5.0.0-canary.36
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1304,6 +1304,10 @@ type Sandbox = {
          * Working directory to execute the command in.
          */
         workingDirectory?: string;
+        /**
+         * Signal that can be used to abort the command.
+         */
+        abortSignal?: AbortSignal;
     }) => PromiseLike<{
         /**
          * Exit code returned by the command.
@@ -1509,10 +1513,19 @@ type BaseTool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JS
  */
 type BaseFunctionTool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONValue | unknown | never = any, CONTEXT extends Context | unknown | never = any> = BaseTool<INPUT, OUTPUT, CONTEXT> & {
     /**
-     * An optional description of what the tool does.
-     * Will be used by the language model to decide whether to use the tool.
-     */
-    description?: string;
+     * Optional description of what the tool does.
+     *
+     * Included in the tool definition sent to the language model so it can
+     * decide when and how to call the tool.
+     *
+     * Provide a string for a fixed description, or a function that returns a
+     * string from the current `context` (and optional `sandbox`) when the
+     * description should vary per call.
+     */
+    description?: string | ((options: {
+        context: NoInfer<CONTEXT>;
+        sandbox?: Sandbox;
+    }) => string);
     /**
      * Strict mode setting for the tool.
      *

package/dist/index.js

@@ -862,7 +862,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "5.0.0-canary.36" : "0.0.0-test";
+var VERSION = true ? "5.0.0-canary.38" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;