chore (core): rename CoreTool to Tool (#4548)

Author: lgrammel

.changeset/fluffy-snails-hide.md

@@ -0,0 +1,7 @@
+---
+'@ai-sdk/provider-utils': patch
+'@ai-sdk/ui-utils': patch
+'ai': patch
+---
+
+chore (core): rename CoreTool to Tool

content/docs/03-ai-sdk-core/05-generating-text.mdx

@@ -241,7 +241,7 @@ all text to uppercase:
 
 ```ts
 const upperCaseTransform =
-  <TOOLS extends Record<string, CoreTool>>() =>
+  <TOOLS extends ToolSet>() =>
   (options: { tools: TOOLS; stopStream: () => void }) =>
     new TransformStream<TextStreamPart<TOOLS>, TextStreamPart<TOOLS>>({
       transform(chunk, controller) {
@@ -263,7 +263,7 @@ and all callbacks are invoked.
 
 ```ts
 const stopWordTransform =
-  <TOOLS extends Record<string, CoreTool>>() =>
+  <TOOLS extends ToolSet>() =>
   ({ stopStream }: { stopStream: () => void }) =>
     new TransformStream<TextStreamPart<TOOLS>, TextStreamPart<TOOLS>>({
       // note: this is a simplified transformation for testing;

content/docs/03-ai-sdk-core/15-tools-and-tool-calling.mdx

@@ -304,18 +304,18 @@ To enable this, the AI SDK provides several helper types for tools, tool calls,
 You can use them to strongly type your variables, function parameters, and return types
 in parts of the code that are not directly related to `streamText` or `generateText`.
 
-Each tool call is typed with `CoreToolCall<NAME extends string, ARGS>`, depending
+Each tool call is typed with `ToolCall<NAME extends string, ARGS>`, depending
 on the tool that has been invoked.
-Similarly, the tool results are typed with `CoreToolResult<NAME extends string, ARGS, RESULT>`.
+Similarly, the tool results are typed with `ToolResult<NAME extends string, ARGS, RESULT>`.
 
-The tools in `streamText` and `generateText` are defined as a `Record<string, CoreTool>`.
-The type inference helpers `CoreToolCallUnion<TOOLS extends Record<string, CoreTool>>`
-and `CoreToolResultUnion<TOOLS extends Record<string, CoreTool>>` can be used to
+The tools in `streamText` and `generateText` are defined as a `ToolSet`.
+The type inference helpers `ToolCallUnion<TOOLS extends ToolSet>`
+and `ToolResultUnion<TOOLS extends ToolSet>` can be used to
 extract the tool call and tool result types from the tools.
 
 ```ts highlight="18-19,23-24"
 import { openai } from '@ai-sdk/openai';
-import { CoreToolCallUnion, CoreToolResultUnion, generateText, tool } from 'ai';
+import { ToolCallUnion, ToolResultUnion, generateText, tool } from 'ai';
 import { z } from 'zod';
 
 const myToolSet = {
@@ -331,8 +331,8 @@ const myToolSet = {
   }),
 };
 
-type MyToolCall = CoreToolCallUnion<typeof myToolSet>;
-type MyToolResult = CoreToolResultUnion<typeof myToolSet>;
+type MyToolCall = ToolCallUnion<typeof myToolSet>;
+type MyToolResult = ToolResultUnion<typeof myToolSet>;
 
 async function generateSomething(prompt: string): Promise<{
   text: string;

content/docs/07-reference/01-ai-sdk-core/01-generate-text.mdx

@@ -260,12 +260,12 @@ To see `generateText` in action, check out [these examples](#examples).
     },
     {
       name: 'tools',
-      type: 'Record<string, CoreTool>',
+      type: 'ToolSet',
       description:
         'Tools that are accessible to and can be called by the model. The model needs to support calling tools.',
       properties: [
         {
-          type: 'CoreTool',
+          type: 'Tool',
           parameters: [
             {
               name: 'description',

content/docs/07-reference/01-ai-sdk-core/02-stream-text.mdx

@@ -262,12 +262,12 @@ To see `streamText` in action, check out [these examples](#examples).
     },
     {
       name: 'tools',
-      type: 'Record<string, CoreTool>',
+      type: 'ToolSet',
       description:
         'Tools that are accessible to and can be called by the model. The model needs to support calling tools.',
       properties: [
         {
-          type: 'CoreTool',
+          type: 'Tool',
           parameters: [
             {
               name: 'description',

content/docs/07-reference/01-ai-sdk-core/20-tool.mdx

@@ -41,11 +41,11 @@ export const weatherTool = tool({
   content={[
     {
       name: 'tool',
-      type: 'CoreTool',
+      type: 'Tool',
       description: 'The tool definition.',
       properties: [
         {
-          type: 'CoreTool',
+          type: 'Tool',
           parameters: [
             {
               name: 'description',

content/docs/07-reference/02-ai-sdk-ui/31-convert-to-core-messages.mdx

@@ -46,7 +46,7 @@ export async function POST(req: Request) {
     },
     {
       name: 'options',
-      type: '{ tools?: Record<string, Tool> }',
+      type: '{ tools?: ToolSet }',
       description:
         'Optional configuration object. Provide tools to enable multi-modal tool responses.',
     },

content/docs/07-reference/03-ai-sdk-rsc/01-stream-ui.mdx

@@ -332,7 +332,7 @@ To see `streamUI` in action, check out [these examples](#examples).
     },
     {
       name: 'tools',
-      type: 'Record<string, Tool>',
+      type: 'ToolSet',
       description:
         'Tools that are accessible to and can be called by the model.',
       properties: [

content/docs/07-reference/03-ai-sdk-rsc/20-render.mdx

@@ -162,7 +162,7 @@ A helper function to create a streamable UI from LLM providers. This function is
     },
     {
       name: 'functions',
-      type: 'Record<string, Tool>',
+      type: 'ToolSet',
       isOptional: true,
       description:
         'Tools that are accessible to and can be called by the model.',
@@ -196,7 +196,7 @@ A helper function to create a streamable UI from LLM providers. This function is
     },
     {
       name: 'tools',
-      type: 'Record<string, Tool>',
+      type: 'ToolSet',
       isOptional: true,
       description:
         'Tools that are accessible to and can be called by the model.',

examples/ai-core/src/types/tool-set.ts

@@ -1,5 +1,5 @@
 import { openai } from '@ai-sdk/openai';
-import { CoreToolCallUnion, CoreToolResultUnion, generateText, tool } from 'ai';
+import { ToolCallUnion, ToolResultUnion, generateText, tool } from 'ai';
 import { z } from 'zod';
 
 const myToolSet = {
@@ -15,8 +15,8 @@ const myToolSet = {
   }),
 };
 
-type MyToolCall = CoreToolCallUnion<typeof myToolSet>;
-type MyToolResult = CoreToolResultUnion<typeof myToolSet>;
+type MyToolCall = ToolCallUnion<typeof myToolSet>;
+type MyToolResult = ToolResultUnion<typeof myToolSet>;
 
 async function generateSomething(prompt: string): Promise<{
   text: string;