ai 5.0.2 → 5.0.4

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # ai
 
+## 5.0.4
+
+### Patch Changes
+
+- Updated dependencies [444df49]
+  - @ai-sdk/gateway@1.0.2
+
+## 5.0.3
+
+### Patch Changes
+
+- 90d212f: feat (ai): add experimental tool call context
+- Updated dependencies [028fb9c]
+- Updated dependencies [90d212f]
+- Updated dependencies [6331826]
+  - @ai-sdk/gateway@1.0.1
+  - @ai-sdk/provider-utils@3.0.1
+
 ## 5.0.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -952,7 +952,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 ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1011,6 +1011,14 @@ A function that attempts to repair a tool call that failed to parse.
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
     onStepFinish?: GenerateTextOnStepFinishCallback<NoInfer<TOOLS>>;
+    /**
+     * Context that is passed into tool execution.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context?: unknown;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1157,7 +1165,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 ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1253,6 +1261,14 @@ Callback that is called when each step (LLM call) is finished, including interme
     */
     onStepFinish?: StreamTextOnStepFinishCallback<TOOLS>;
     /**
+     * Context that is passed into tool execution.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context?: unknown;
+    /**
 Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -2013,6 +2029,14 @@ type AgentSettings<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
     onStepFinish?: GenerateTextOnStepFinishCallback<NoInfer<TOOLS>>;
+    /**
+     * Context that is passed into tool calls.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context?: unknown;
     /**
      * Internal. For test use only. May change without notice.
      */

package/dist/index.d.ts

@@ -952,7 +952,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 ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>({ model: modelArg, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, providerOptions, experimental_activeTools, activeTools, experimental_prepareStep, prepareStep, experimental_repairToolCall: repairToolCall, experimental_context, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1011,6 +1011,14 @@ A function that attempts to repair a tool call that failed to parse.
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
     onStepFinish?: GenerateTextOnStepFinishCallback<NoInfer<TOOLS>>;
+    /**
+     * Context that is passed into tool execution.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context?: unknown;
     /**
      * Internal. For test use only. May change without notice.
      */
@@ -1157,7 +1165,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 ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, experimental_context, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1253,6 +1261,14 @@ Callback that is called when each step (LLM call) is finished, including interme
     */
     onStepFinish?: StreamTextOnStepFinishCallback<TOOLS>;
     /**
+     * Context that is passed into tool execution.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context?: unknown;
+    /**
 Internal. For test use only. May change without notice.
      */
     _internal?: {
@@ -2013,6 +2029,14 @@ type AgentSettings<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never
     Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
     onStepFinish?: GenerateTextOnStepFinishCallback<NoInfer<TOOLS>>;
+    /**
+     * Context that is passed into tool calls.
+     *
+     * Experimental (can break in patch releases).
+     *
+     * @default undefined
+     */
+    experimental_context?: unknown;
     /**
      * Internal. For test use only. May change without notice.
      */

package/dist/index.js

@@ -2038,6 +2038,7 @@ async function generateText({
   experimental_prepareStep,
   prepareStep = experimental_prepareStep,
   experimental_repairToolCall: repairToolCall,
+  experimental_context,
   _internal: {
     generateId: generateId3 = originalGenerateId,
     currentDate = () => /* @__PURE__ */ new Date()
@@ -2235,7 +2236,8 @@ async function generateText({
                 input: toolCall.input,
                 toolCallId: toolCall.toolCallId,
                 messages: stepInputMessages,
-                abortSignal
+                abortSignal,
+                experimental_context
               });
             }
           }
@@ -2248,7 +2250,8 @@ async function generateText({
             tracer,
             telemetry,
             messages: stepInputMessages,
-            abortSignal
+            abortSignal,
+            experimental_context
           });
           const stepContent = asContent({
             content: currentModelResponse.content,
@@ -2329,7 +2332,8 @@ async function executeTools({
   tracer,
   telemetry,
   messages,
-  abortSignal
+  abortSignal,
+  experimental_context
 }) {
   const toolOutputs = await Promise.all(
     toolCalls.map(async ({ toolCallId, toolName, input }) => {
@@ -2359,7 +2363,8 @@ async function executeTools({
             const output = await tool3.execute(input, {
               toolCallId,
               messages,
-              abortSignal
+              abortSignal,
+              experimental_context
             });
             try {
               span.setAttributes(
@@ -3923,7 +3928,8 @@ function runToolsTransformation({
   system,
   messages,
   abortSignal,
-  repairToolCall
+  repairToolCall,
+  experimental_context
 }) {
   let toolResultsStreamController = null;
   const toolResultsStream = new ReadableStream({
@@ -4000,7 +4006,8 @@ function runToolsTransformation({
                 input: toolCall.input,
                 toolCallId: toolCall.toolCallId,
                 messages,
-                abortSignal
+                abortSignal,
+                experimental_context
               });
             }
             if (tool3.execute != null && toolCall.providerExecuted !== true) {
@@ -4029,7 +4036,8 @@ function runToolsTransformation({
                     output = await tool3.execute(toolCall.input, {
                       toolCallId: toolCall.toolCallId,
                       messages,
-                      abortSignal
+                      abortSignal,
+                      experimental_context
                     });
                   } catch (error) {
                     recordErrorOnSpan(span, error);
@@ -4163,6 +4171,7 @@ function streamText({
   onFinish,
   onAbort,
   onStepFinish,
+  experimental_context,
   _internal: {
     now: now2 = now,
     generateId: generateId3 = originalGenerateId2,
@@ -4197,7 +4206,8 @@ function streamText({
     onStepFinish,
     now: now2,
     currentDate,
-    generateId: generateId3
+    generateId: generateId3,
+    experimental_context
   });
 }
 function createOutputTransformStream(output) {
@@ -4293,7 +4303,8 @@ var DefaultStreamTextResult = class {
     onError,
     onFinish,
     onAbort,
-    onStepFinish
+    onStepFinish,
+    experimental_context
   }) {
     this._totalUsage = new DelayedPromise();
     this._finishReason = new DelayedPromise();
@@ -4672,7 +4683,8 @@ var DefaultStreamTextResult = class {
             system,
             messages: stepInputMessages,
             repairToolCall,
-            abortSignal
+            abortSignal,
+            experimental_context
           });
           const stepRequest = request != null ? request : {};
           const stepToolCalls = [];
@@ -4800,7 +4812,8 @@ var DefaultStreamTextResult = class {
                         await tool3.onInputStart({
                           toolCallId: chunk.id,
                           messages: stepInputMessages,
-                          abortSignal
+                          abortSignal,
+                          experimental_context
                         });
                       }
                       controller.enqueue({
@@ -4822,7 +4835,8 @@ var DefaultStreamTextResult = class {
                           inputTextDelta: chunk.delta,
                           toolCallId: chunk.id,
                           messages: stepInputMessages,
-                          abortSignal
+                          abortSignal,
+                          experimental_context
                         });
                       }
                       controller.enqueue(chunk);