ai 4.1.10 → 4.1.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "4.1.10",
+  "version": "4.1.11",
   "description": "AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript",
   "license": "Apache-2.0",
   "sideEffects": false,

package/rsc/dist/index.d.ts

@@ -205,11 +205,19 @@ type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'requ
 };
 
 /**
-Additional provider-specific metadata. They are passed through
-to the provider from the AI SDK and enable provider-specific
-functionality that can be fully encapsulated in the provider.
+Additional provider-specific metadata that is returned from the provider.
+
+This is needed to enable provider-specific functionality that can be
+fully encapsulated in the provider.
  */
 type ProviderMetadata = LanguageModelV1ProviderMetadata;
+/**
+Additional provider-specific options.
+
+They are passed through to the provider from the AI SDK and enable
+provider-specific functionality that can be fully encapsulated in the provider.
+ */
+type ProviderOptions = LanguageModelV1ProviderMetadata;
 
 /**
 Represents the number of tokens used in a prompt and completion.
@@ -256,6 +264,10 @@ interface TextPart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -279,6 +291,10 @@ interface ImagePart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -302,6 +318,10 @@ interface FilePart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -326,6 +346,10 @@ interface ToolCallPart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -358,6 +382,10 @@ interface ToolResultPart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -376,6 +404,10 @@ type CoreSystemMessage = {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 };
@@ -390,6 +422,10 @@ type CoreUserMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -407,6 +443,10 @@ type CoreAssistantMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -424,6 +464,10 @@ type CoreToolMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -500,7 +544,7 @@ type RenderResult = {
  */
 declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
-} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, initial, text, experimental_providerMetadata: providerMetadata, onFinish, ...settings }: CallSettings & Prompt & {
+} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, initial, text, experimental_providerMetadata, providerOptions, onFinish, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -518,10 +562,14 @@ declare function streamUI<TOOLS extends {
     text?: RenderText;
     initial?: ReactNode;
     /**
-Additional provider-specific metadata. They are passed through
+Additional provider-specific options. They are passed through
 to the provider from the AI SDK and enable provider-specific
 functionality that can be fully encapsulated in the provider.
  */
+    providerOptions?: ProviderOptions;
+    /**
+@deprecated Use `providerOptions` instead.
+*/
     experimental_providerMetadata?: ProviderMetadata;
     /**
      * Callback that is called when the LLM response and the final object validation are finished.

package/rsc/dist/rsc-server.d.mts

@@ -203,11 +203,19 @@ type ToolChoice<TOOLS extends Record<string, unknown>> = 'auto' | 'none' | 'requ
 };
 
 /**
-Additional provider-specific metadata. They are passed through
-to the provider from the AI SDK and enable provider-specific
-functionality that can be fully encapsulated in the provider.
+Additional provider-specific metadata that is returned from the provider.
+
+This is needed to enable provider-specific functionality that can be
+fully encapsulated in the provider.
  */
 type ProviderMetadata = LanguageModelV1ProviderMetadata;
+/**
+Additional provider-specific options.
+
+They are passed through to the provider from the AI SDK and enable
+provider-specific functionality that can be fully encapsulated in the provider.
+ */
+type ProviderOptions = LanguageModelV1ProviderMetadata;
 
 /**
 Represents the number of tokens used in a prompt and completion.
@@ -254,6 +262,10 @@ interface TextPart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -277,6 +289,10 @@ interface ImagePart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -300,6 +316,10 @@ interface FilePart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -324,6 +344,10 @@ interface ToolCallPart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -356,6 +380,10 @@ interface ToolResultPart {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 }
@@ -374,6 +402,10 @@ type CoreSystemMessage = {
   Additional provider-specific metadata. They are passed through
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
+   */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
    */
     experimental_providerMetadata?: ProviderMetadata;
 };
@@ -388,6 +420,10 @@ type CoreUserMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -405,6 +441,10 @@ type CoreAssistantMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -422,6 +462,10 @@ type CoreToolMessage = {
   to the provider from the AI SDK and enable provider-specific
   functionality that can be fully encapsulated in the provider.
    */
+    providerOptions?: ProviderOptions;
+    /**
+  @deprecated Use `providerOptions` instead.
+  */
     experimental_providerMetadata?: ProviderMetadata;
 };
 /**
@@ -498,7 +542,7 @@ type RenderResult = {
  */
 declare function streamUI<TOOLS extends {
     [name: string]: z.ZodTypeAny;
-} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, initial, text, experimental_providerMetadata: providerMetadata, onFinish, ...settings }: CallSettings & Prompt & {
+} = {}>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, initial, text, experimental_providerMetadata, providerOptions, onFinish, ...settings }: CallSettings & Prompt & {
     /**
      * The language model to use.
      */
@@ -516,10 +560,14 @@ declare function streamUI<TOOLS extends {
     text?: RenderText;
     initial?: ReactNode;
     /**
-Additional provider-specific metadata. They are passed through
+Additional provider-specific options. They are passed through
 to the provider from the AI SDK and enable provider-specific
 functionality that can be fully encapsulated in the provider.
  */
+    providerOptions?: ProviderOptions;
+    /**
+@deprecated Use `providerOptions` instead.
+*/
     experimental_providerMetadata?: ProviderMetadata;
     /**
      * Callback that is called when the LLM response and the final object validation are finished.

package/rsc/dist/rsc-server.mjs

@@ -421,13 +421,14 @@ async function convertToLanguageModelPrompt({
   ];
 }
 function convertToLanguageModelMessage(message, downloadedAssets) {
+  var _a9, _b, _c, _d, _e, _f;
   const role = message.role;
   switch (role) {
     case "system": {
       return {
         role: "system",
         content: message.content,
-        providerMetadata: message.experimental_providerMetadata
+        providerMetadata: (_a9 = message.providerOptions) != null ? _a9 : message.experimental_providerMetadata
       };
     }
     case "user": {
@@ -435,13 +436,13 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
         return {
           role: "user",
           content: [{ type: "text", text: message.content }],
-          providerMetadata: message.experimental_providerMetadata
+          providerMetadata: (_b = message.providerOptions) != null ? _b : message.experimental_providerMetadata
         };
       }
       return {
         role: "user",
         content: message.content.map((part) => convertPartToLanguageModelPart(part, downloadedAssets)).filter((part) => part.type !== "text" || part.text !== ""),
-        providerMetadata: message.experimental_providerMetadata
+        providerMetadata: (_c = message.providerOptions) != null ? _c : message.experimental_providerMetadata
       };
     }
     case "assistant": {
@@ -449,7 +450,7 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
         return {
           role: "assistant",
           content: [{ type: "text", text: message.content }],
-          providerMetadata: message.experimental_providerMetadata
+          providerMetadata: (_d = message.providerOptions) != null ? _d : message.experimental_providerMetadata
         };
       }
       return {
@@ -458,28 +459,31 @@ function convertToLanguageModelMessage(message, downloadedAssets) {
           // remove empty text parts:
           (part) => part.type !== "text" || part.text !== ""
         ).map((part) => {
-          const { experimental_providerMetadata, ...rest } = part;
+          const { experimental_providerMetadata, providerOptions, ...rest } = part;
           return {
             ...rest,
-            providerMetadata: experimental_providerMetadata
+            providerMetadata: providerOptions != null ? providerOptions : experimental_providerMetadata
           };
         }),
-        providerMetadata: message.experimental_providerMetadata
+        providerMetadata: (_e = message.providerOptions) != null ? _e : message.experimental_providerMetadata
       };
     }
     case "tool": {
       return {
         role: "tool",
-        content: message.content.map((part) => ({
-          type: "tool-result",
-          toolCallId: part.toolCallId,
-          toolName: part.toolName,
-          result: part.result,
-          content: part.experimental_content,
-          isError: part.isError,
-          providerMetadata: part.experimental_providerMetadata
-        })),
-        providerMetadata: message.experimental_providerMetadata
+        content: message.content.map((part) => {
+          var _a10;
+          return {
+            type: "tool-result",
+            toolCallId: part.toolCallId,
+            toolName: part.toolName,
+            result: part.result,
+            content: part.experimental_content,
+            isError: part.isError,
+            providerMetadata: (_a10 = part.providerOptions) != null ? _a10 : part.experimental_providerMetadata
+          };
+        }),
+        providerMetadata: (_f = message.providerOptions) != null ? _f : message.experimental_providerMetadata
       };
     }
     default: {
@@ -1082,7 +1086,7 @@ function detectSingleMessageCharacteristics(message) {
   "experimental_attachments" in message)) {
     return "has-ui-specific-parts";
   } else if (typeof message === "object" && message !== null && "content" in message && (Array.isArray(message.content) || // Core messages can have array content
-  "experimental_providerMetadata" in message)) {
+  "experimental_providerMetadata" in message || "providerOptions" in message)) {
     return "has-core-specific-parts";
   } else if (typeof message === "object" && message !== null && "role" in message && "content" in message && typeof message.content === "string" && ["system", "user", "assistant", "tool"].includes(message.role)) {
     return "message";
@@ -1136,25 +1140,30 @@ var toolResultContentSchema = z4.array(
 var textPartSchema = z5.object({
   type: z5.literal("text"),
   text: z5.string(),
+  providerOptions: providerMetadataSchema.optional(),
   experimental_providerMetadata: providerMetadataSchema.optional()
 });
 var imagePartSchema = z5.object({
   type: z5.literal("image"),
   image: z5.union([dataContentSchema, z5.instanceof(URL)]),
   mimeType: z5.string().optional(),
+  providerOptions: providerMetadataSchema.optional(),
   experimental_providerMetadata: providerMetadataSchema.optional()
 });
 var filePartSchema = z5.object({
   type: z5.literal("file"),
   data: z5.union([dataContentSchema, z5.instanceof(URL)]),
   mimeType: z5.string(),
+  providerOptions: providerMetadataSchema.optional(),
   experimental_providerMetadata: providerMetadataSchema.optional()
 });
 var toolCallPartSchema = z5.object({
   type: z5.literal("tool-call"),
   toolCallId: z5.string(),
   toolName: z5.string(),
-  args: z5.unknown()
+  args: z5.unknown(),
+  providerOptions: providerMetadataSchema.optional(),
+  experimental_providerMetadata: providerMetadataSchema.optional()
 });
 var toolResultPartSchema = z5.object({
   type: z5.literal("tool-result"),
@@ -1163,6 +1172,7 @@ var toolResultPartSchema = z5.object({
   result: z5.unknown(),
   content: toolResultContentSchema.optional(),
   isError: z5.boolean().optional(),
+  providerOptions: providerMetadataSchema.optional(),
   experimental_providerMetadata: providerMetadataSchema.optional()
 });
 
@@ -1170,6 +1180,7 @@ var toolResultPartSchema = z5.object({
 var coreSystemMessageSchema = z6.object({
   role: z6.literal("system"),
   content: z6.string(),
+  providerOptions: providerMetadataSchema.optional(),
   experimental_providerMetadata: providerMetadataSchema.optional()
 });
 var coreUserMessageSchema = z6.object({
@@ -1178,6 +1189,7 @@ var coreUserMessageSchema = z6.object({
     z6.string(),
     z6.array(z6.union([textPartSchema, imagePartSchema, filePartSchema]))
   ]),
+  providerOptions: providerMetadataSchema.optional(),
   experimental_providerMetadata: providerMetadataSchema.optional()
 });
 var coreAssistantMessageSchema = z6.object({
@@ -1186,11 +1198,13 @@ var coreAssistantMessageSchema = z6.object({
     z6.string(),
     z6.array(z6.union([textPartSchema, toolCallPartSchema]))
   ]),
+  providerOptions: providerMetadataSchema.optional(),
   experimental_providerMetadata: providerMetadataSchema.optional()
 });
 var coreToolMessageSchema = z6.object({
   role: z6.literal("tool"),
   content: z6.array(toolResultPartSchema),
+  providerOptions: providerMetadataSchema.optional(),
   experimental_providerMetadata: providerMetadataSchema.optional()
 });
 var coreMessageSchema = z6.union([
@@ -1466,7 +1480,8 @@ async function streamUI({
   headers,
   initial,
   text,
-  experimental_providerMetadata: providerMetadata,
+  experimental_providerMetadata,
+  providerOptions = experimental_providerMetadata,
   onFinish,
   ...settings
 }) {
@@ -1554,7 +1569,7 @@ async function streamUI({
         modelSupportsImageUrls: model.supportsImageUrls,
         modelSupportsUrl: model.supportsUrl
       }),
-      providerMetadata,
+      providerMetadata: providerOptions,
       abortSignal,
       headers
     })