ai 6.0.0-beta.135 → 6.0.0-beta.136

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 6.0.0-beta.136
+
+### Patch Changes
+
+- 3d83f38: chore(ai): improve addToolInputExamplesMiddleware
+
 ## 6.0.0-beta.135
 
 ### Patch Changes

package/dist/index.d.mts

@@ -4754,10 +4754,10 @@ declare function simulateStreamingMiddleware(): LanguageModelMiddleware;
  * property. The middleware serializes examples into the tool's description text.
  *
  * @param options - Configuration options for the middleware.
- * @param options.examplesPrefix - A prefix to prepend before the examples.
- * @param options.formatExample - Optional custom formatter for each example.
+ * @param options.prefix - A prefix to prepend before the examples. Default: 'Input Examples:'
+ * @param options.format - Optional custom formatter for each example.
  *   Receives the example object and its index. Default: JSON.stringify(example.input)
- * @param options.removeInputExamples - Whether to remove the inputExamples property
+ * @param options.remove - Whether to remove the inputExamples property
  *   after adding them to the description. Default: true
  *
  * @example
@@ -4766,30 +4766,28 @@ declare function simulateStreamingMiddleware(): LanguageModelMiddleware;
  *
  * const model = wrapLanguageModel({
  *   model: yourModel,
- *   middleware: addToolInputExamplesMiddleware({
- *     examplesPrefix: 'Input Examples:',
- *   }),
+ *   middleware: addToolInputExamplesMiddleware(),
  * });
  * ```
  */
-declare function addToolInputExamplesMiddleware({ examplesPrefix, formatExample, removeInputExamples, }: {
+declare function addToolInputExamplesMiddleware({ prefix, format, remove, }?: {
     /**
-     * A prefix/header to prepend before the examples.
+     * A prefix to prepend before the examples.
      */
-    examplesPrefix: string;
+    prefix?: string;
     /**
      * Optional custom formatter for each example.
      * Receives the example object and its index.
      * Default: JSON.stringify(example.input)
      */
-    formatExample?: (example: {
+    format?: (example: {
         input: JSONObject;
     }, index: number) => string;
     /**
      * Whether to remove the inputExamples property after adding them to the description.
      * Default: true
      */
-    removeInputExamples?: boolean;
+    remove?: boolean;
 }): LanguageModelMiddleware;
 
 /**

package/dist/index.d.ts

@@ -4754,10 +4754,10 @@ declare function simulateStreamingMiddleware(): LanguageModelMiddleware;
  * property. The middleware serializes examples into the tool's description text.
  *
  * @param options - Configuration options for the middleware.
- * @param options.examplesPrefix - A prefix to prepend before the examples.
- * @param options.formatExample - Optional custom formatter for each example.
+ * @param options.prefix - A prefix to prepend before the examples. Default: 'Input Examples:'
+ * @param options.format - Optional custom formatter for each example.
  *   Receives the example object and its index. Default: JSON.stringify(example.input)
- * @param options.removeInputExamples - Whether to remove the inputExamples property
+ * @param options.remove - Whether to remove the inputExamples property
  *   after adding them to the description. Default: true
  *
  * @example
@@ -4766,30 +4766,28 @@ declare function simulateStreamingMiddleware(): LanguageModelMiddleware;
  *
  * const model = wrapLanguageModel({
  *   model: yourModel,
- *   middleware: addToolInputExamplesMiddleware({
- *     examplesPrefix: 'Input Examples:',
- *   }),
+ *   middleware: addToolInputExamplesMiddleware(),
  * });
  * ```
  */
-declare function addToolInputExamplesMiddleware({ examplesPrefix, formatExample, removeInputExamples, }: {
+declare function addToolInputExamplesMiddleware({ prefix, format, remove, }?: {
     /**
-     * A prefix/header to prepend before the examples.
+     * A prefix to prepend before the examples.
      */
-    examplesPrefix: string;
+    prefix?: string;
     /**
      * Optional custom formatter for each example.
      * Receives the example object and its index.
      * Default: JSON.stringify(example.input)
      */
-    formatExample?: (example: {
+    format?: (example: {
         input: JSONObject;
     }, index: number) => string;
     /**
      * Whether to remove the inputExamples property after adding them to the description.
      * Default: true
      */
-    removeInputExamples?: boolean;
+    remove?: boolean;
 }): LanguageModelMiddleware;
 
 /**

package/dist/index.js

@@ -909,7 +909,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.135" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.136" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -9948,10 +9948,10 @@ function defaultFormatExample(example) {
   return JSON.stringify(example.input);
 }
 function addToolInputExamplesMiddleware({
-  examplesPrefix,
-  formatExample = defaultFormatExample,
-  removeInputExamples = true
-}) {
+  prefix = "Input Examples:",
+  format = defaultFormatExample,
+  remove = true
+} = {}) {
   return {
     specificationVersion: "v3",
     transformParams: async ({ params }) => {
@@ -9964,8 +9964,8 @@ function addToolInputExamplesMiddleware({
         if (tool2.type !== "function" || !((_a16 = tool2.inputExamples) == null ? void 0 : _a16.length)) {
           return tool2;
         }
-        const formattedExamples = tool2.inputExamples.map((example, index) => formatExample(example, index)).join("\n");
-        const examplesSection = `${examplesPrefix}
+        const formattedExamples = tool2.inputExamples.map((example, index) => format(example, index)).join("\n");
+        const examplesSection = `${prefix}
 ${formattedExamples}`;
         const toolDescription = tool2.description ? `${tool2.description}
 
@@ -9973,7 +9973,7 @@ ${examplesSection}` : examplesSection;
         return {
           ...tool2,
           description: toolDescription,
-          inputExamples: removeInputExamples ? void 0 : tool2.inputExamples
+          inputExamples: remove ? void 0 : tool2.inputExamples
         };
       });
       return {