ai 3.4.13 → 3.4.15

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # ai
 
+## 3.4.15
+
+### Patch Changes
+
+- Updated dependencies [98a3b08]
+  - @ai-sdk/react@0.0.64
+
+## 3.4.14
+
+### Patch Changes
+
+- e930f40: feat (ai/core): expose core tool result and tool call types
+
 ## 3.4.13
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1317,7 +1317,25 @@ onlyBar('bar');
 */
 type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
-type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
+/**
+Typed tool call that is returned by `generateText` and `streamText`.
+It contains the tool call ID, the tool name, and the tool arguments.
+ */
+interface ToolCall<NAME extends string, ARGS> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+}
+type ToolCallUnion<TOOLS extends Record<string, CoreTool>> = ValueOf<{
     [NAME in keyof TOOLS]: {
         type: 'tool-call';
         toolCallId: string;
@@ -1325,8 +1343,30 @@ type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
         args: inferParameters<TOOLS[NAME]['parameters']>;
     };
 }>;
-type ToToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolCall<TOOLS>>;
+type ToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToolCallUnion<TOOLS>>;
 
+/**
+Typed tool result that is returned by `generateText` and `streamText`.
+It contains the tool call ID, the tool name, the tool arguments, and the tool result.
+ */
+interface ToolResult<NAME extends string, ARGS, RESULT> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that was called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+    /**
+  Result of the tool call. This is the result of the tool's execution.
+     */
+    result: RESULT;
+}
 type ToToolsWithExecute<TOOLS extends Record<string, CoreTool>> = {
     [K in keyof TOOLS as TOOLS[K] extends {
         execute: any;
@@ -1344,8 +1384,8 @@ type ToToolResultObject<TOOLS extends Record<string, CoreTool>> = ValueOf<{
         result: Awaited<ReturnType<Exclude<TOOLS[NAME]['execute'], undefined>>>;
     };
 }>;
-type ToToolResult<TOOLS extends Record<string, CoreTool>> = ToToolResultObject<ToToolsWithDefinedExecute<ToToolsWithExecute<TOOLS>>>;
-type ToToolResultArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolResult<TOOLS>>;
+type ToolResultUnion<TOOLS extends Record<string, CoreTool>> = ToToolResultObject<ToToolsWithDefinedExecute<ToToolsWithExecute<TOOLS>>>;
+type ToolResultArray<TOOLS extends Record<string, CoreTool>> = Array<ToolResultUnion<TOOLS>>;
 
 /**
  * The result of a single step in the generation process.
@@ -1358,11 +1398,11 @@ type StepResult<TOOLS extends Record<string, CoreTool>> = {
     /**
   The tool calls that were made during the generation.
   */
-    readonly toolCalls: ToToolCallArray<TOOLS>;
+    readonly toolCalls: ToolCallArray<TOOLS>;
     /**
   The results of the tool calls.
   */
-    readonly toolResults: ToToolResultArray<TOOLS>;
+    readonly toolResults: ToolResultArray<TOOLS>;
     /**
   The reason why the generation finished.
   */
@@ -1425,11 +1465,11 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
     /**
     The tool calls that were made during the generation.
      */
-    readonly toolCalls: ToToolCallArray<TOOLS>;
+    readonly toolCalls: ToolCallArray<TOOLS>;
     /**
     The results of the tool calls.
      */
-    readonly toolResults: ToToolResultArray<TOOLS>;
+    readonly toolResults: ToolResultArray<TOOLS>;
     /**
     The reason why the generation finished.
      */
@@ -1655,13 +1695,13 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
   Resolved when the response is finished.
        */
-    readonly toolCalls: Promise<ToToolCall<TOOLS>[]>;
+    readonly toolCalls: Promise<ToolCallUnion<TOOLS>[]>;
     /**
   The tool results that have been generated in the last step.
   
   Resolved when the all tool executions are finished.
        */
-    readonly toolResults: Promise<ToToolResult<TOOLS>[]>;
+    readonly toolResults: Promise<ToolResultUnion<TOOLS>[]>;
     /**
   Optional raw response data.
   
@@ -1813,7 +1853,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
     textDelta: string;
 } | ({
     type: 'tool-call';
-} & ToToolCall<TOOLS>) | {
+} & ToolCallUnion<TOOLS>) | {
     type: 'tool-call-streaming-start';
     toolCallId: string;
     toolName: string;
@@ -1824,7 +1864,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
     argsTextDelta: string;
 } | ({
     type: 'tool-result';
-} & ToToolResult<TOOLS>) | {
+} & ToolResultUnion<TOOLS>) | {
     type: 'step-finish';
     finishReason: FinishReason;
     logprobs?: LogProbs;
@@ -3191,4 +3231,4 @@ declare const generateId: (size?: number) => string;
  */
 declare const nanoid: (size?: number) => string;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LanguageModelResponseMetadata, LanguageModelResponseMetadataWithHeaders, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, MistralStream, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, Provider, ProviderMetadata, ReplicateStream, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, experimental_wrapLanguageModel, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCall as CoreToolCall, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResult as CoreToolResult, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LanguageModelResponseMetadata, LanguageModelResponseMetadataWithHeaders, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, MistralStream, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, Provider, ProviderMetadata, ReplicateStream, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, experimental_wrapLanguageModel, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };

package/dist/index.d.ts

@@ -1317,7 +1317,25 @@ onlyBar('bar');
 */
 type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
-type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
+/**
+Typed tool call that is returned by `generateText` and `streamText`.
+It contains the tool call ID, the tool name, and the tool arguments.
+ */
+interface ToolCall<NAME extends string, ARGS> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that is being called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+}
+type ToolCallUnion<TOOLS extends Record<string, CoreTool>> = ValueOf<{
     [NAME in keyof TOOLS]: {
         type: 'tool-call';
         toolCallId: string;
@@ -1325,8 +1343,30 @@ type ToToolCall<TOOLS extends Record<string, CoreTool>> = ValueOf<{
         args: inferParameters<TOOLS[NAME]['parameters']>;
     };
 }>;
-type ToToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolCall<TOOLS>>;
+type ToolCallArray<TOOLS extends Record<string, CoreTool>> = Array<ToolCallUnion<TOOLS>>;
 
+/**
+Typed tool result that is returned by `generateText` and `streamText`.
+It contains the tool call ID, the tool name, the tool arguments, and the tool result.
+ */
+interface ToolResult<NAME extends string, ARGS, RESULT> {
+    /**
+  ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
+    toolCallId: string;
+    /**
+  Name of the tool that was called.
+   */
+    toolName: NAME;
+    /**
+  Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+     */
+    args: ARGS;
+    /**
+  Result of the tool call. This is the result of the tool's execution.
+     */
+    result: RESULT;
+}
 type ToToolsWithExecute<TOOLS extends Record<string, CoreTool>> = {
     [K in keyof TOOLS as TOOLS[K] extends {
         execute: any;
@@ -1344,8 +1384,8 @@ type ToToolResultObject<TOOLS extends Record<string, CoreTool>> = ValueOf<{
         result: Awaited<ReturnType<Exclude<TOOLS[NAME]['execute'], undefined>>>;
     };
 }>;
-type ToToolResult<TOOLS extends Record<string, CoreTool>> = ToToolResultObject<ToToolsWithDefinedExecute<ToToolsWithExecute<TOOLS>>>;
-type ToToolResultArray<TOOLS extends Record<string, CoreTool>> = Array<ToToolResult<TOOLS>>;
+type ToolResultUnion<TOOLS extends Record<string, CoreTool>> = ToToolResultObject<ToToolsWithDefinedExecute<ToToolsWithExecute<TOOLS>>>;
+type ToolResultArray<TOOLS extends Record<string, CoreTool>> = Array<ToolResultUnion<TOOLS>>;
 
 /**
  * The result of a single step in the generation process.
@@ -1358,11 +1398,11 @@ type StepResult<TOOLS extends Record<string, CoreTool>> = {
     /**
   The tool calls that were made during the generation.
   */
-    readonly toolCalls: ToToolCallArray<TOOLS>;
+    readonly toolCalls: ToolCallArray<TOOLS>;
     /**
   The results of the tool calls.
   */
-    readonly toolResults: ToToolResultArray<TOOLS>;
+    readonly toolResults: ToolResultArray<TOOLS>;
     /**
   The reason why the generation finished.
   */
@@ -1425,11 +1465,11 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>> {
     /**
     The tool calls that were made during the generation.
      */
-    readonly toolCalls: ToToolCallArray<TOOLS>;
+    readonly toolCalls: ToolCallArray<TOOLS>;
     /**
     The results of the tool calls.
      */
-    readonly toolResults: ToToolResultArray<TOOLS>;
+    readonly toolResults: ToolResultArray<TOOLS>;
     /**
     The reason why the generation finished.
      */
@@ -1655,13 +1695,13 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
   
   Resolved when the response is finished.
        */
-    readonly toolCalls: Promise<ToToolCall<TOOLS>[]>;
+    readonly toolCalls: Promise<ToolCallUnion<TOOLS>[]>;
     /**
   The tool results that have been generated in the last step.
   
   Resolved when the all tool executions are finished.
        */
-    readonly toolResults: Promise<ToToolResult<TOOLS>[]>;
+    readonly toolResults: Promise<ToolResultUnion<TOOLS>[]>;
     /**
   Optional raw response data.
   
@@ -1813,7 +1853,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
     textDelta: string;
 } | ({
     type: 'tool-call';
-} & ToToolCall<TOOLS>) | {
+} & ToolCallUnion<TOOLS>) | {
     type: 'tool-call-streaming-start';
     toolCallId: string;
     toolName: string;
@@ -1824,7 +1864,7 @@ type TextStreamPart<TOOLS extends Record<string, CoreTool>> = {
     argsTextDelta: string;
 } | ({
     type: 'tool-result';
-} & ToToolResult<TOOLS>) | {
+} & ToolResultUnion<TOOLS>) | {
     type: 'step-finish';
     finishReason: FinishReason;
     logprobs?: LogProbs;
@@ -3191,4 +3231,4 @@ declare const generateId: (size?: number) => string;
  */
 declare const nanoid: (size?: number) => string;
 
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, CoreToolChoice, CoreToolMessage, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LanguageModelResponseMetadata, LanguageModelResponseMetadataWithHeaders, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, MistralStream, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, Provider, ProviderMetadata, ReplicateStream, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, experimental_wrapLanguageModel, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicMessagesStream, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantContent, AssistantResponse, CallWarning, CohereStream, CompletionTokenUsage, CompletionUsage, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCall as CoreToolCall, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResult as CoreToolResult, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, EmbeddingTokenUsage, ExperimentalAssistantMessage, ExperimentalMessage, ExperimentalTool, ExperimentalToolMessage, ExperimentalUserMessage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, FunctionCallPayload, GenerateObjectResult, GenerateTextResult, GoogleGenerativeAIStream, HuggingFaceStream, ImagePart, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LangChainStream, LanguageModel, LanguageModelResponseMetadata, LanguageModelResponseMetadataWithHeaders, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, MistralStream, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, OpenAIStream, OpenAIStreamCallbacks, Provider, ProviderMetadata, ReplicateStream, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, StreamingTextResponse, TextPart$1 as TextPart, TextStreamPart, TokenUsage, ToolCallPart, ToolCallPayload, ToolContent, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createCallbacksTransformer, createEventStreamTransformer, createStreamDataTransformer, embed, embedMany, experimental_AssistantResponse, experimental_ModelRegistry, experimental_Provider, experimental_ProviderRegistry, experimental_StreamData, experimental_createModelRegistry, experimental_createProviderRegistry, experimental_customProvider, experimental_generateObject, experimental_generateText, experimental_streamObject, experimental_streamText, experimental_wrapLanguageModel, generateId, generateObject, generateText, nanoid, readableFromAsyncIterable, streamObject, streamText, streamToResponse, tool, trimStartOfStreamHelper };