rename BetaRunnableTool

Author: 404Wolf

src/helpers/beta/json-schema.ts

@@ -1,5 +1,5 @@
 import type { FromSchema, JSONSchema } from 'json-schema-to-ts';
-import type { BetaRunnableTool, Promisable } from '../../lib/beta/BetaRunnableTool';
+import type { BetaRunnableChatCompletionFunctionTool, Promisable } from '../../lib/beta/BetaRunnableTool';
 import type { FunctionTool } from '../../resources/beta';
 import { OpenAIError } from '../../error';
 
@@ -15,7 +15,7 @@ export function betaTool<const Schema extends Exclude<JSONSchema, boolean> & { t
   inputSchema: Schema;
   description: string;
   run: (args: NoInfer<FromSchema<Schema>>) => Promisable<string | Array<FunctionTool>>;
-}): BetaRunnableTool<NoInfer<FromSchema<Schema>>> {
+}): BetaRunnableChatCompletionFunctionTool<NoInfer<FromSchema<Schema>>> {
   if (options.inputSchema.type !== 'object') {
     throw new OpenAIError(
       `JSON schema for tool "${options.name}" must be an object, but got ${options.inputSchema.type}`,

src/helpers/beta/zod.ts

@@ -1,6 +1,6 @@
 import type { infer as zodInfer, ZodType } from 'zod/v4';
 import * as z from 'zod/v4';
-import type { BetaRunnableTool, Promisable } from '../../lib/beta/BetaRunnableTool';
+import type { BetaRunnableChatCompletionFunctionTool, Promisable } from '../../lib/beta/BetaRunnableTool';
 import type { ChatCompletionContentPart } from '../../resources';
 
 /**
@@ -14,7 +14,7 @@ export function betaZodFunctionTool<InputSchema extends ZodType>(options: {
   parameters: InputSchema;
   description: string;
   run: (args: zodInfer<InputSchema>) => Promisable<string | ChatCompletionContentPart[]>;
-}): BetaRunnableTool<zodInfer<InputSchema>> {
+}): BetaRunnableChatCompletionFunctionTool<zodInfer<InputSchema>> {
   const jsonSchema = z.toJSONSchema(options.parameters, { reused: 'ref' });
 
   return {

src/lib/beta/BetaRunnableTool.ts

@@ -1,10 +1,10 @@
-import type { ChatCompletionContentPart, ChatCompletionTool } from '../../resources';
+import type { ChatCompletionContentPart, ChatCompletionFunctionTool } from '../../resources';
 
 export type Promisable<T> = T | Promise<T>;
 
-// this type is just an extension of BetaTool with a run and parse method
+// this type is just an extension of ChatCompletionFunctionTool with a run and parse method
 // that will be called by `toolRunner()` helpers
-export type BetaRunnableTool<Input = any> = ChatCompletionTool & {
+export type BetaRunnableChatCompletionFunctionTool<Input = any> = ChatCompletionFunctionTool & {
   run: (args: Input) => Promisable<string | ChatCompletionContentPart[]>;
   parse: (content: unknown) => Input;
 };

src/lib/beta/BetaToolRunner.ts

@@ -11,7 +11,7 @@ import type {
   ChatCompletionTool,
   ChatCompletionToolMessageParam,
 } from '../../resources/chat/completions';
-import type { BetaRunnableTool } from './BetaRunnableTool';
+import type { BetaRunnableChatCompletionFunctionTool } from './BetaRunnableTool';
 
 /**
  * Just Promise.withResolvers(), which is not available in all environments.
@@ -255,7 +255,10 @@ export class BetaToolRunner<Stream extends boolean>
     }
     const toolsResponse = generateToolResponse(
       lastMessage,
-      this.#state.params.tools.filter((tool): tool is BetaRunnableTool<any> => 'run' in tool),
+      this.#state.params.tools.filter(
+        (tool): tool is BetaRunnableChatCompletionFunctionTool<any> =>
+          'run' in tool && tool.type === 'function',
+      ),
     );
     this.#toolResponse = toolsResponse;
     return toolsResponse;
@@ -358,7 +361,7 @@ export class BetaToolRunner<Stream extends boolean>
 
 async function generateToolResponse(
   lastMessage: ChatCompletionMessage,
-  tools: BetaRunnableTool<any>[],
+  tools: BetaRunnableChatCompletionFunctionTool<any>[],
 ): Promise<null | ChatCompletionToolMessageParam[]> {
   // Only process if the last message is from the assistant and has tool use blocks
   if (
@@ -383,7 +386,7 @@ async function generateToolResponse(
 
         const tool = tools.find(
           (t) => t.type === 'function' && toolUse.function.name === t.function.name,
-        ) as BetaRunnableTool;
+        ) as BetaRunnableChatCompletionFunctionTool;
 
         if (!tool || !('run' in tool)) {
           return {
@@ -435,7 +438,7 @@ type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
  */
 export type BetaToolRunnerParams = Simplify<
   Omit<ChatCompletionCreateParams, 'tools'> & {
-    tools: (ChatCompletionTool | BetaRunnableTool<any>)[];
+    tools: (ChatCompletionTool | BetaRunnableChatCompletionFunctionTool<any>)[];
     /**
      * Maximum number of iterations (API requests) to make in the tool execution loop.
      * Each iteration consists of: assistant response → tool execution → tool results.

tests/lib/tools/BetaToolRunner.test.ts

@@ -1,6 +1,6 @@
 import OpenAI from 'openai';
 import { mockFetch } from '../../utils/mock-fetch';
-import type { BetaRunnableTool } from 'openai/lib/beta/BetaRunnableTool';
+import type { BetaRunnableChatCompletionFunctionTool } from 'openai/lib/beta/BetaRunnableTool';
 import type {
   ChatCompletion,
   ChatCompletionChunk,
@@ -11,9 +11,8 @@ import type {
 } from 'openai/resources';
 import type { Fetch } from 'openai/internal/builtin-types';
 import type { BetaToolRunnerParams } from 'openai/lib/beta/BetaToolRunner';
-import { betaZodFunctionTool } from 'openai/helpers/beta/zod';
 
-const weatherTool: BetaRunnableTool<{ location: string }> = {
+const weatherTool: BetaRunnableChatCompletionFunctionTool<{ location: string }> = {
   type: 'function',
   function: {
     name: 'getWeather',
@@ -29,7 +28,7 @@ const weatherTool: BetaRunnableTool<{ location: string }> = {
   parse: (input: unknown) => input as { location: string },
 };
 
-const calculatorTool: BetaRunnableTool<{ a: number; b: number; operation: string }> = {
+const calculatorTool: BetaRunnableChatCompletionFunctionTool<{ a: number; b: number; operation: string }> = {
   type: 'function',
   function: {
     name: 'calculate',
@@ -766,7 +765,7 @@ describe('ToolRunner', () => {
     });
 
     it('handles tool execution errors', async () => {
-      const errorTool: BetaRunnableTool<{ shouldFail: boolean }> = {
+      const errorTool: BetaRunnableChatCompletionFunctionTool<{ shouldFail: boolean }> = {
         type: 'function',
         function: {
           name: 'errorTool',
@@ -1010,7 +1009,7 @@ describe('ToolRunner', () => {
     });
 
     it('allows you to use non-string returning custom tools', async () => {
-      const customTool: BetaRunnableTool<{ location: string }> = {
+      const customTool: BetaRunnableChatCompletionFunctionTool<{ location: string }> = {
         type: 'function',
         function: {
           name: 'getWeather',
@@ -1140,7 +1139,7 @@ describe('ToolRunner', () => {
 
     it('calls tools at most once', async () => {
       let weatherToolCallCount = 0;
-      const trackingWeatherTool: BetaRunnableTool<{ location: string }> = {
+      const trackingWeatherTool: BetaRunnableChatCompletionFunctionTool<{ location: string }> = {
         type: 'function',
         function: {
           name: 'getWeather',