ai 3.3.31 → 3.3.32

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 3.3.32
+
+### Patch Changes
+
+- ce7a4af: feat (ai/core): support providerMetadata in functions
+
 ## 3.3.31
 
 ### Patch Changes

package/dist/index.d.mts

@@ -706,6 +706,12 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -762,6 +768,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -806,6 +818,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -836,6 +854,12 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -1033,6 +1057,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<OBJECT>;
@@ -1094,6 +1124,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<Array<ELEMENT>>;
@@ -1129,6 +1165,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<JSONValue>;
@@ -1434,7 +1476,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, experimental_telemetry: telemetry, _internal: { generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1469,6 +1511,12 @@ By default, it's set to 0, which will disable the feature.
      */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+ */
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -1732,7 +1780,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1763,6 +1811,12 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+ */
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
 Enable streaming of tool call deltas as they are generated. Disabled by default.
      */
     experimental_toolCallStreaming?: boolean;

package/dist/index.d.ts

@@ -706,6 +706,12 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -762,6 +768,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -806,6 +818,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -836,6 +854,12 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -1033,6 +1057,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<OBJECT>;
@@ -1094,6 +1124,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<Array<ELEMENT>>;
@@ -1129,6 +1165,12 @@ Optional telemetry configuration (experimental).
    */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+*/
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: OnFinishCallback<JSONValue>;
@@ -1434,7 +1476,7 @@ If set and supported by the model, calls will generate deterministic results.
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, experimental_telemetry: telemetry, _internal: { generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, _internal: { generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1469,6 +1511,12 @@ By default, it's set to 0, which will disable the feature.
      */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+ */
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
      * Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -1732,7 +1780,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxToolRoundtrips, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, onChunk, onFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1763,6 +1811,12 @@ Optional telemetry configuration (experimental).
      */
     experimental_telemetry?: TelemetrySettings;
     /**
+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.
+ */
+    experimental_providerMetadata?: ProviderMetadata;
+    /**
 Enable streaming of tool call deltas as they are generated. Disabled by default.
      */
     experimental_toolCallStreaming?: boolean;

package/dist/index.js

@@ -1852,6 +1852,7 @@ async function generateObject({
   abortSignal,
   headers,
   experimental_telemetry: telemetry,
+  experimental_providerMetadata: providerMetadata,
   _internal: {
     generateId: generateId3 = originalGenerateId,
     currentDate = () => /* @__PURE__ */ new Date()
@@ -1916,7 +1917,7 @@ async function generateObject({
       let rawResponse;
       let response;
       let logprobs;
-      let providerMetadata;
+      let resultProviderMetadata;
       switch (mode) {
         case "json": {
           const validatedPrompt = validatePrompt({
@@ -1974,6 +1975,7 @@ async function generateObject({
                   ...prepareCallSettings(settings),
                   inputFormat,
                   prompt: promptMessages,
+                  providerMetadata,
                   abortSignal,
                   headers
                 });
@@ -2018,7 +2020,7 @@ async function generateObject({
           warnings = generateResult.warnings;
           rawResponse = generateResult.rawResponse;
           logprobs = generateResult.logprobs;
-          providerMetadata = generateResult.providerMetadata;
+          resultProviderMetadata = generateResult.providerMetadata;
           response = generateResult.responseData;
           break;
         }
@@ -2078,6 +2080,7 @@ async function generateObject({
                   ...prepareCallSettings(settings),
                   inputFormat,
                   prompt: promptMessages,
+                  providerMetadata,
                   abortSignal,
                   headers
                 });
@@ -2123,7 +2126,7 @@ async function generateObject({
           warnings = generateResult.warnings;
           rawResponse = generateResult.rawResponse;
           logprobs = generateResult.logprobs;
-          providerMetadata = generateResult.providerMetadata;
+          resultProviderMetadata = generateResult.providerMetadata;
           response = generateResult.responseData;
           break;
         }
@@ -2175,7 +2178,7 @@ async function generateObject({
           headers: rawResponse == null ? void 0 : rawResponse.headers
         },
         logprobs,
-        providerMetadata
+        providerMetadata: resultProviderMetadata
       });
     }
   });
@@ -2333,6 +2336,7 @@ async function streamObject({
   abortSignal,
   headers,
   experimental_telemetry: telemetry,
+  experimental_providerMetadata: providerMetadata,
   onFinish,
   _internal: {
     generateId: generateId3 = originalGenerateId2,
@@ -2413,6 +2417,7 @@ async function streamObject({
               prompt: validatedPrompt,
               modelSupportsImageUrls: model.supportsImageUrls
             }),
+            providerMetadata,
             abortSignal,
             headers
           };
@@ -2454,6 +2459,7 @@ async function streamObject({
               prompt: validatedPrompt,
               modelSupportsImageUrls: model.supportsImageUrls
             }),
+            providerMetadata,
             abortSignal,
             headers
           };
@@ -3016,6 +3022,7 @@ async function generateText({
   maxAutomaticRoundtrips = 0,
   maxToolRoundtrips = maxAutomaticRoundtrips,
   experimental_telemetry: telemetry,
+  experimental_providerMetadata: providerMetadata,
   _internal: {
     generateId: generateId3 = originalGenerateId3,
     currentDate = () => /* @__PURE__ */ new Date()
@@ -3113,6 +3120,7 @@ async function generateText({
                 ...callSettings,
                 inputFormat: currentInputFormat,
                 prompt: promptMessages,
+                providerMetadata,
                 abortSignal,
                 headers
               });
@@ -3684,6 +3692,7 @@ async function streamText({
   headers,
   maxToolRoundtrips = 0,
   experimental_telemetry: telemetry,
+  experimental_providerMetadata: providerMetadata,
   experimental_toolCallStreaming: toolCallStreaming = false,
   onChunk,
   onFinish,
@@ -3770,6 +3779,7 @@ async function streamText({
                 ...prepareCallSettings(settings),
                 inputFormat: promptType,
                 prompt: promptMessages2,
+                providerMetadata,
                 abortSignal,
                 headers
               })