ai 6.0.0-beta.118 → 6.0.0-beta.119

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 6.0.0-beta.119
+
+### Patch Changes
+
+- b59d924: feat(ai): support SystemModelMessage in system and instructions properties
+
 ## 6.0.0-beta.118
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { GatewayModelId } from '@ai-sdk/gateway';
 export { GatewayModelId, createGateway, gateway } from '@ai-sdk/gateway';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
-import { Tool, InferToolInput, InferToolOutput, FlexibleSchema, InferSchema, AssistantModelMessage, ToolModelMessage, ReasoningPart, ModelMessage, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, MaybePromiseLike, TextPart, FilePart, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
+import { Tool, InferToolInput, InferToolOutput, FlexibleSchema, InferSchema, AssistantModelMessage, ToolModelMessage, ReasoningPart, SystemModelMessage, ModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, MaybePromiseLike, TextPart, FilePart, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
 export { AssistantContent, AssistantModelMessage, DataContent, FilePart, FlexibleSchema, IdGenerator, ImagePart, InferSchema, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolApprovalRequest, ToolApprovalResponse, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, dynamicTool, generateId, jsonSchema, parseJsonEventStream, tool, zodSchema } from '@ai-sdk/provider-utils';
 import * as _ai_sdk_provider from '@ai-sdk/provider';
 import { EmbeddingModelV3, EmbeddingModelV2, EmbeddingModelV3Embedding, ImageModelV3, ImageModelV2, ImageModelV3CallWarning, ImageModelV2CallWarning, ImageModelV3ProviderMetadata, ImageModelV2ProviderMetadata, JSONValue as JSONValue$1, LanguageModelV3, LanguageModelV2, LanguageModelV3FinishReason, LanguageModelV3CallWarning, LanguageModelV3Source, LanguageModelV3Middleware, EmbeddingModelV3Middleware, RerankingModelV3, SharedV3ProviderMetadata, SpeechModelV3, SpeechModelV2, SpeechModelV3CallWarning, TranscriptionModelV3, TranscriptionModelV2, TranscriptionModelV3CallWarning, LanguageModelV3Usage, ImageModelV3Usage, LanguageModelV3CallOptions, AISDKError, LanguageModelV3ToolCall, JSONSchema7, JSONParseError, TypeValidationError, JSONObject, SharedV3Warning, EmbeddingModelCallOptions, ProviderV3, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
@@ -911,7 +911,7 @@ type Prompt = {
     /**
   System message to include in the prompt. Can be used with `prompt` or `messages`.
      */
-    system?: string;
+    system?: string | SystemModelMessage;
 } & ({
     /**
 A prompt. It can be either a text prompt or a list of messages.
@@ -1022,7 +1022,7 @@ type PrepareStepResult<TOOLS extends Record<string, Tool> = Record<string, Tool>
     model?: LanguageModel;
     toolChoice?: ToolChoice<NoInfer<TOOLS>>;
     activeTools?: Array<keyof NoInfer<TOOLS>>;
-    system?: string;
+    system?: string | SystemModelMessage;
     messages?: Array<ModelMessage>;
 } | undefined;
 
@@ -1119,7 +1119,7 @@ declare const coreMessageSchema: z.ZodType<CoreMessage>;
  * @param options.error - The error that occurred while parsing the tool call.
  */
 type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
-    system: string | undefined;
+    system: string | SystemModelMessage | undefined;
     messages: ModelMessage[];
     toolCall: LanguageModelV3ToolCall;
     tools: TOOLS;
@@ -2683,8 +2683,10 @@ type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUT
     id?: string;
     /**
      * The instructions for the agent.
+     *
+     * It can be a string, or, if you need to pass additional provider options (e.g. for caching), a `SystemModelMessage`.
      */
-    instructions?: string;
+    instructions?: string | SystemModelMessage;
     /**
   The language model to use.
      */

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { GatewayModelId } from '@ai-sdk/gateway';
 export { GatewayModelId, createGateway, gateway } from '@ai-sdk/gateway';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
-import { Tool, InferToolInput, InferToolOutput, FlexibleSchema, InferSchema, AssistantModelMessage, ToolModelMessage, ReasoningPart, ModelMessage, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, MaybePromiseLike, TextPart, FilePart, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
+import { Tool, InferToolInput, InferToolOutput, FlexibleSchema, InferSchema, AssistantModelMessage, ToolModelMessage, ReasoningPart, SystemModelMessage, ModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, MaybePromiseLike, TextPart, FilePart, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
 export { AssistantContent, AssistantModelMessage, DataContent, FilePart, FlexibleSchema, IdGenerator, ImagePart, InferSchema, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolApprovalRequest, ToolApprovalResponse, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, dynamicTool, generateId, jsonSchema, parseJsonEventStream, tool, zodSchema } from '@ai-sdk/provider-utils';
 import * as _ai_sdk_provider from '@ai-sdk/provider';
 import { EmbeddingModelV3, EmbeddingModelV2, EmbeddingModelV3Embedding, ImageModelV3, ImageModelV2, ImageModelV3CallWarning, ImageModelV2CallWarning, ImageModelV3ProviderMetadata, ImageModelV2ProviderMetadata, JSONValue as JSONValue$1, LanguageModelV3, LanguageModelV2, LanguageModelV3FinishReason, LanguageModelV3CallWarning, LanguageModelV3Source, LanguageModelV3Middleware, EmbeddingModelV3Middleware, RerankingModelV3, SharedV3ProviderMetadata, SpeechModelV3, SpeechModelV2, SpeechModelV3CallWarning, TranscriptionModelV3, TranscriptionModelV2, TranscriptionModelV3CallWarning, LanguageModelV3Usage, ImageModelV3Usage, LanguageModelV3CallOptions, AISDKError, LanguageModelV3ToolCall, JSONSchema7, JSONParseError, TypeValidationError, JSONObject, SharedV3Warning, EmbeddingModelCallOptions, ProviderV3, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
@@ -911,7 +911,7 @@ type Prompt = {
     /**
   System message to include in the prompt. Can be used with `prompt` or `messages`.
      */
-    system?: string;
+    system?: string | SystemModelMessage;
 } & ({
     /**
 A prompt. It can be either a text prompt or a list of messages.
@@ -1022,7 +1022,7 @@ type PrepareStepResult<TOOLS extends Record<string, Tool> = Record<string, Tool>
     model?: LanguageModel;
     toolChoice?: ToolChoice<NoInfer<TOOLS>>;
     activeTools?: Array<keyof NoInfer<TOOLS>>;
-    system?: string;
+    system?: string | SystemModelMessage;
     messages?: Array<ModelMessage>;
 } | undefined;
 
@@ -1119,7 +1119,7 @@ declare const coreMessageSchema: z.ZodType<CoreMessage>;
  * @param options.error - The error that occurred while parsing the tool call.
  */
 type ToolCallRepairFunction<TOOLS extends ToolSet> = (options: {
-    system: string | undefined;
+    system: string | SystemModelMessage | undefined;
     messages: ModelMessage[];
     toolCall: LanguageModelV3ToolCall;
     tools: TOOLS;
@@ -2683,8 +2683,10 @@ type ToolLoopAgentSettings<CALL_OPTIONS = never, TOOLS extends ToolSet = {}, OUT
     id?: string;
     /**
      * The instructions for the agent.
+     *
+     * It can be a string, or, if you need to pass additional provider options (e.g. for caching), a `SystemModelMessage`.
      */
-    instructions?: string;
+    instructions?: string | SystemModelMessage;
     /**
   The language model to use.
      */

package/dist/index.js

@@ -884,7 +884,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.118" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.119" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -1028,7 +1028,13 @@ async function convertToLanguageModelPrompt({
     supportedUrls
   );
   const messages = [
-    ...prompt.system != null ? [{ role: "system", content: prompt.system }] : [],
+    ...prompt.system != null ? typeof prompt.system === "string" ? [{ role: "system", content: prompt.system }] : [
+      {
+        role: "system",
+        content: prompt.system.content,
+        providerOptions: prompt.system.providerOptions
+      }
+    ] : [],
     ...prompt.messages.map(
       (message) => convertToLanguageModelMessage({ message, downloadedAssets })
     )
@@ -1685,7 +1691,7 @@ async function standardizePrompt(prompt) {
       message: "prompt and messages cannot be defined at the same time"
     });
   }
-  if (prompt.system != null && typeof prompt.system !== "string") {
+  if (prompt.system != null && typeof prompt.system !== "string" && "role" in prompt.system && prompt.system.role !== "system") {
     throw new import_provider19.InvalidPromptError({
       prompt,
       message: "system must be a string"