@ai-sdk/provider-utils 4.0.0-beta.42 → 4.0.0-beta.43

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @ai-sdk/provider-utils
 
+## 4.0.0-beta.43
+
+### Patch Changes
+
+- dce03c4: feat: tool input examples
+- Updated dependencies [dce03c4]
+  - @ai-sdk/provider@3.0.0-beta.24
+
 ## 4.0.0-beta.42
 
 ### Patch Changes

package/dist/index.d.mts

@@ -944,13 +944,22 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      */
     providerOptions?: ProviderOptions;
     /**
-  The schema of the input that the tool expects. The language model will use this to generate the input.
-  It is also used to validate the output of the language model.
-  Use descriptions to make the input understandable for the language model.
+     * The schema of the input that the tool expects.
+     * The language model will use this to generate the input.
+     * It is also used to validate the output of the language model.
+     *
+     * You can use descriptions on the schema properties to make the input understandable for the language model.
      */
     inputSchema: FlexibleSchema<INPUT>;
     /**
-  Whether the tool needs approval before it can be executed.
+     * An optional list of input examples that show the language
+     * model what the input should look like.
+     */
+    inputExamples?: Array<{
+        input: INPUT;
+    }>;
+    /**
+     * Whether the tool needs approval before it can be executed.
      */
     needsApproval?: boolean | ToolNeedsApprovalFunction<[INPUT] extends [never] ? unknown : INPUT>;
     /**

package/dist/index.d.ts

@@ -944,13 +944,22 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      */
     providerOptions?: ProviderOptions;
     /**
-  The schema of the input that the tool expects. The language model will use this to generate the input.
-  It is also used to validate the output of the language model.
-  Use descriptions to make the input understandable for the language model.
+     * The schema of the input that the tool expects.
+     * The language model will use this to generate the input.
+     * It is also used to validate the output of the language model.
+     *
+     * You can use descriptions on the schema properties to make the input understandable for the language model.
      */
     inputSchema: FlexibleSchema<INPUT>;
     /**
-  Whether the tool needs approval before it can be executed.
+     * An optional list of input examples that show the language
+     * model what the input should look like.
+     */
+    inputExamples?: Array<{
+        input: INPUT;
+    }>;
+    /**
+     * Whether the tool needs approval before it can be executed.
      */
     needsApproval?: boolean | ToolNeedsApprovalFunction<[INPUT] extends [never] ? unknown : INPUT>;
     /**

package/dist/index.js

@@ -378,7 +378,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "4.0.0-beta.42" : "0.0.0-test";
+var VERSION = true ? "4.0.0-beta.43" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;