ai 6.0.0-beta.135 → 6.0.0-beta.137

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ai
 
+## 6.0.0-beta.137
+
+### Patch Changes
+
+- 9ba4324: feat(ai): support SystemModelMessage[] in system and instructions properties
+
+## 6.0.0-beta.136
+
+### Patch Changes
+
+- 3d83f38: chore(ai): improve addToolInputExamplesMiddleware
+
 ## 6.0.0-beta.135
 
 ### Patch Changes

package/dist/index.d.mts

@@ -902,7 +902,7 @@ type Prompt = {
     /**
   System message to include in the prompt. Can be used with `prompt` or `messages`.
      */
-    system?: string | SystemModelMessage;
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
 } & ({
     /**
 A prompt. It can be either a text prompt or a list of messages.
@@ -1013,7 +1013,7 @@ type PrepareStepResult<TOOLS extends Record<string, Tool> = Record<string, Tool>
     model?: LanguageModel;
     toolChoice?: ToolChoice<NoInfer<TOOLS>>;
     activeTools?: Array<keyof NoInfer<TOOLS>>;
-    system?: string | SystemModelMessage;
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
     messages?: Array<ModelMessage>;
 } | undefined;
 
@@ -1070,7 +1070,7 @@ declare const modelMessageSchema: z.ZodType<ModelMessage>;
  * @param options.error - The error that occurred while parsing the tool call.
  */
 type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
-    system: string | SystemModelMessage | undefined;
+    system: string | SystemModelMessage | Array<SystemModelMessage> | undefined;
     messages: ModelMessage[];
     toolCall: LanguageModelV3ToolCall;
     tools: TOOLS;
@@ -2637,7 +2637,7 @@ type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUT
      *
      * It can be a string, or, if you need to pass additional provider options (e.g. for caching), a `SystemModelMessage`.
      */
-    instructions?: string | SystemModelMessage;
+    instructions?: string | SystemModelMessage | Array<SystemModelMessage>;
     /**
   The language model to use.
      */
@@ -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

@@ -902,7 +902,7 @@ type Prompt = {
     /**
   System message to include in the prompt. Can be used with `prompt` or `messages`.
      */
-    system?: string | SystemModelMessage;
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
 } & ({
     /**
 A prompt. It can be either a text prompt or a list of messages.
@@ -1013,7 +1013,7 @@ type PrepareStepResult<TOOLS extends Record<string, Tool> = Record<string, Tool>
     model?: LanguageModel;
     toolChoice?: ToolChoice<NoInfer<TOOLS>>;
     activeTools?: Array<keyof NoInfer<TOOLS>>;
-    system?: string | SystemModelMessage;
+    system?: string | SystemModelMessage | Array<SystemModelMessage>;
     messages?: Array<ModelMessage>;
 } | undefined;
 
@@ -1070,7 +1070,7 @@ declare const modelMessageSchema: z.ZodType<ModelMessage>;
  * @param options.error - The error that occurred while parsing the tool call.
  */
 type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
-    system: string | SystemModelMessage | undefined;
+    system: string | SystemModelMessage | Array<SystemModelMessage> | undefined;
     messages: ModelMessage[];
     toolCall: LanguageModelV3ToolCall;
     tools: TOOLS;
@@ -2637,7 +2637,7 @@ type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUT
      *
      * It can be a string, or, if you need to pass additional provider options (e.g. for caching), a `SystemModelMessage`.
      */
-    instructions?: string | SystemModelMessage;
+    instructions?: string | SystemModelMessage | Array<SystemModelMessage>;
     /**
   The language model to use.
      */
@@ -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.137" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -1041,6 +1041,11 @@ function convertDataContentToUint8Array(content) {
   throw new InvalidDataContentError({ content });
 }
 
+// src/util/as-array.ts
+function asArray(value) {
+  return value === void 0 ? [] : Array.isArray(value) ? value : [value];
+}
+
 // src/prompt/convert-to-language-model-prompt.ts
 async function convertToLanguageModelPrompt({
   prompt,
@@ -1053,13 +1058,11 @@ async function convertToLanguageModelPrompt({
     supportedUrls
   );
   const messages = [
-    ...prompt.system != null ? typeof prompt.system === "string" ? [{ role: "system", content: prompt.system }] : [
-      {
-        role: "system",
-        content: prompt.system.content,
-        providerOptions: prompt.system.providerOptions
-      }
-    ] : [],
+    ...prompt.system != null ? typeof prompt.system === "string" ? [{ role: "system", content: prompt.system }] : asArray(prompt.system).map((message) => ({
+      role: "system",
+      content: message.content,
+      providerOptions: message.providerOptions
+    })) : [],
     ...prompt.messages.map(
       (message) => convertToLanguageModelMessage({ message, downloadedAssets })
     )
@@ -1713,10 +1716,12 @@ async function standardizePrompt(prompt) {
       message: "prompt and messages cannot be defined at the same time"
     });
   }
-  if (prompt.system != null && typeof prompt.system !== "string" && "role" in prompt.system && prompt.system.role !== "system") {
+  if (prompt.system != null && typeof prompt.system !== "string" && !asArray(prompt.system).every(
+    (message) => typeof message === "object" && message !== null && "role" in message && message.role === "system"
+  )) {
     throw new import_provider19.InvalidPromptError({
       prompt,
-      message: "system must be a string"
+      message: "system must be a string, SystemModelMessage, or array of SystemModelMessage"
     });
   }
   let messages;
@@ -2019,11 +2024,6 @@ function addImageModelUsage(usage1, usage2) {
   };
 }
 
-// src/util/as-array.ts
-function asArray(value) {
-  return value === void 0 ? [] : Array.isArray(value) ? value : [value];
-}
-
 // src/util/retry-with-exponential-backoff.ts
 var import_provider21 = require("@ai-sdk/provider");
 var import_provider_utils7 = require("@ai-sdk/provider-utils");
@@ -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 {