ai 4.0.6 → 4.0.8

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ai
 
+## 4.0.8
+
+### Patch Changes
+
+- a803d76: feat (ai/core): pass toolCallId option into tool execute function
+
+## 4.0.7
+
+### Patch Changes
+
+- 5b4f07b: fix (ai/core): change default error message for data streams to "An error occurred."
+
 ## 4.0.6
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1178,6 +1178,21 @@ Callback that is called when the LLM response and the final object validation ar
 
 type Parameters = z.ZodTypeAny | Schema<any>;
 type inferParameters<PARAMETERS extends Parameters> = PARAMETERS extends Schema<any> ? PARAMETERS['_type'] : PARAMETERS extends z.ZodTypeAny ? z.infer<PARAMETERS> : never;
+interface ToolExecutionOptions {
+    /**
+     * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
+     */
+    toolCallId: string;
+    /**
+     * Messages that were sent to the language model to initiate the response that contained the tool call.
+     * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
+     */
+    messages: CoreMessage[];
+    /**
+     * An optional abort signal that indicates that the overall operation should be aborted.
+     */
+    abortSignal?: AbortSignal;
+}
 /**
 A tool contains the description and the schema of the input that the tool expects.
 This enables the language model to generate the input.
@@ -1202,17 +1217,7 @@ type CoreTool<PARAMETERS extends Parameters = any, RESULT = any> = {
   @args is the input of the tool call.
   @options.abortSignal is a signal that can be used to abort the tool call.
      */
-    execute?: (args: inferParameters<PARAMETERS>, options: {
-        /**
-         * Messages that were sent to the language model to initiate the response that contained the tool call.
-         * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
-         */
-        messages: CoreMessage[];
-        /**
-         * An optional abort signal that indicates that the overall operation should be aborted.
-         */
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<RESULT>;
+    execute?: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
 } & ({
     /**
 Function tool.
@@ -1240,15 +1245,9 @@ The arguments for configuring the tool. Must match the expected arguments define
 Helper function for inferring the execute args of a tool.
  */
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>, options: {
-        messages: CoreMessage[];
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<RESULT>;
+    execute: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
 }): CoreTool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>, options: {
-        messages: CoreMessage[];
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<RESULT>;
+    execute: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
 };
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
     execute?: undefined;
@@ -2289,4 +2288,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolContent, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };

package/dist/index.d.ts

@@ -1178,6 +1178,21 @@ Callback that is called when the LLM response and the final object validation ar
 
 type Parameters = z.ZodTypeAny | Schema<any>;
 type inferParameters<PARAMETERS extends Parameters> = PARAMETERS extends Schema<any> ? PARAMETERS['_type'] : PARAMETERS extends z.ZodTypeAny ? z.infer<PARAMETERS> : never;
+interface ToolExecutionOptions {
+    /**
+     * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
+     */
+    toolCallId: string;
+    /**
+     * Messages that were sent to the language model to initiate the response that contained the tool call.
+     * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
+     */
+    messages: CoreMessage[];
+    /**
+     * An optional abort signal that indicates that the overall operation should be aborted.
+     */
+    abortSignal?: AbortSignal;
+}
 /**
 A tool contains the description and the schema of the input that the tool expects.
 This enables the language model to generate the input.
@@ -1202,17 +1217,7 @@ type CoreTool<PARAMETERS extends Parameters = any, RESULT = any> = {
   @args is the input of the tool call.
   @options.abortSignal is a signal that can be used to abort the tool call.
      */
-    execute?: (args: inferParameters<PARAMETERS>, options: {
-        /**
-         * Messages that were sent to the language model to initiate the response that contained the tool call.
-         * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
-         */
-        messages: CoreMessage[];
-        /**
-         * An optional abort signal that indicates that the overall operation should be aborted.
-         */
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<RESULT>;
+    execute?: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
 } & ({
     /**
 Function tool.
@@ -1240,15 +1245,9 @@ The arguments for configuring the tool. Must match the expected arguments define
 Helper function for inferring the execute args of a tool.
  */
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>, options: {
-        messages: CoreMessage[];
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<RESULT>;
+    execute: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
 }): CoreTool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>, options: {
-        messages: CoreMessage[];
-        abortSignal?: AbortSignal;
-    }) => PromiseLike<RESULT>;
+    execute: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
 };
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
     execute?: undefined;
@@ -2289,4 +2288,4 @@ declare namespace llamaindexAdapter {
   };
 }
 
-export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };
+export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolContent, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createStreamDataTransformer, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_wrapLanguageModel, generateObject, generateText, streamObject, streamText, tool };

package/dist/index.js

@@ -3564,8 +3564,8 @@ async function executeTools({
   abortSignal
 }) {
   const toolResults = await Promise.all(
-    toolCalls.map(async (toolCall) => {
-      const tool2 = tools[toolCall.toolName];
+    toolCalls.map(async ({ toolCallId, toolName, args }) => {
+      const tool2 = tools[toolName];
       if ((tool2 == null ? void 0 : tool2.execute) == null) {
         return void 0;
       }
@@ -3578,16 +3578,17 @@ async function executeTools({
               operationId: "ai.toolCall",
               telemetry
             }),
-            "ai.toolCall.name": toolCall.toolName,
-            "ai.toolCall.id": toolCall.toolCallId,
+            "ai.toolCall.name": toolName,
+            "ai.toolCall.id": toolCallId,
             "ai.toolCall.args": {
-              output: () => JSON.stringify(toolCall.args)
+              output: () => JSON.stringify(args)
             }
           }
         }),
         tracer,
         fn: async (span) => {
-          const result2 = await tool2.execute(toolCall.args, {
+          const result2 = await tool2.execute(args, {
+            toolCallId,
             messages,
             abortSignal
           });
@@ -3608,9 +3609,9 @@ async function executeTools({
         }
       });
       return {
-        toolCallId: toolCall.toolCallId,
-        toolName: toolCall.toolName,
-        args: toolCall.args,
+        toolCallId,
+        toolName,
+        args,
         result
       };
     })
@@ -3833,6 +3834,7 @@ function runToolsTransformation({
                 }),
                 tracer,
                 fn: async (span) => tool2.execute(toolCall.args, {
+                  toolCallId: toolCall.toolCallId,
                   messages,
                   abortSignal
                 }).then(
@@ -4558,7 +4560,7 @@ var DefaultStreamTextResult = class {
     });
   }
   toDataStreamInternal({
-    getErrorMessage: getErrorMessage3 = () => "",
+    getErrorMessage: getErrorMessage3 = () => "An error occurred.",
     // mask error messages for safety by default
     sendUsage = true
   } = {}) {