update to new async iterable pattern

update types

start setting up tests

get non streaming working

begin work on modifying anthropic tests to openai

update models

Author: 404Wolf

examples/tool-calls-beta-zod.ts

@@ -2,7 +2,6 @@
 
 import OpenAI from 'openai';
 import { betaZodTool } from 'openai/helpers/beta/zod';
-// import { BetaToolUseBlock } from 'openai/helpers/beta';
 import { z } from 'zod';
 
 const client = new OpenAI();
@@ -12,7 +11,7 @@ async function main() {
     messages: [
       {
         role: 'user',
-        content: `I'm planning a trip to San Francisco and I need some information. Can you help me with the weather, current time, and currency exchange rates (from EUR)? Please use parallel tool use`,
+        content: `I'm planning a trip to San Francisco and I need some information. Can you help me with the weather, current time, and currency exchange rates (from EUR)? Please use parallel tool use.`,
       },
     ],
     tools: [
@@ -57,6 +56,8 @@ async function main() {
   console.log(`\n🚀 Running tools...\n`);
 
   for await (const message of runner) {
+    if (!message) continue;
+
     console.log(`┌─ Message ${message.id} `.padEnd(process.stdout.columns, '─'));
     console.log();
 
@@ -99,8 +100,6 @@ async function main() {
       console.log();
     }
   }
-
-  console.log(JSON.stringify(runner.params, null, 2));
 }
 
 main();

package.json

@@ -26,18 +26,20 @@
     "lint": "./scripts/lint",
     "fix": "./scripts/format"
   },
-  "dependencies": {},
+  "dependencies": {
+    "nock": "^14.0.10"
+  },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.0",
     "@swc/core": "^1.3.102",
     "@swc/jest": "^0.2.29",
     "@types/jest": "^29.4.0",
-    "@types/ws": "^8.5.13",
     "@types/node": "^20.17.6",
+    "@types/ws": "^8.5.13",
     "@typescript-eslint/eslint-plugin": "8.31.1",
     "@typescript-eslint/parser": "8.31.1",
-    "deep-object-diff": "^1.1.9",
     "@typescript-eslint/typescript-estree": "8.31.1",
+    "deep-object-diff": "^1.1.9",
     "eslint": "^9.20.1",
     "eslint-plugin-prettier": "^5.4.1",
     "eslint-plugin-unused-imports": "^4.1.4",
@@ -53,9 +55,9 @@
     "tsconfig-paths": "^4.0.0",
     "tslib": "^2.8.1",
     "typescript": "5.8.3",
+    "typescript-eslint": "8.31.1",
     "ws": "^8.18.0",
-    "zod": "^3.25 || ^4.0",
-    "typescript-eslint": "8.31.1"
+    "zod": "^3.25 || ^4.0"
   },
   "bin": {
     "openai": "bin/cli"

src/lib/beta/BetaToolRunner.ts

@@ -1,10 +1,11 @@
-import type { OpenAI } from '../..';
+import { OpenAI } from '../..';
 import { OpenAIError } from '../../core/error';
 import { buildHeaders } from '../../internal/headers';
 import type { RequestOptions } from '../../internal/request-options';
 import type {
   ChatCompletion,
   ChatCompletionCreateParams,
+  ChatCompletionMessage,
   ChatCompletionMessageParam,
   ChatCompletionStream,
   ChatCompletionTool,
@@ -45,14 +46,18 @@ export class BetaToolRunner<Stream extends boolean> {
   /** Current state containing the request parameters */
   #state: { params: BetaToolRunnerParams };
   #options: BetaToolRunnerRequestOptions;
-  /** Promise for the last message received from the assistant */
-  #message?: Promise<ChatCompletion> | undefined;
+  /**
+   * Promise for the last message received from the assistant.
+   *
+   * This resolves to undefined in non-streaming mode if there are no choices provided.
+   */
+  #message?: Promise<ChatCompletionMessage> | undefined;
   /** Cached tool response to avoid redundant executions */
   #toolResponse?: Promise<null | ChatCompletionToolMessageParam[]> | undefined;
   /** Promise resolvers for waiting on completion */
   #completion: {
-    promise: Promise<ChatCompletion>;
-    resolve: (value: ChatCompletion) => void;
+    promise: Promise<ChatCompletionMessage>;
+    resolve: (value: ChatCompletionMessage) => void;
     reject: (reason?: any) => void;
   };
   /** Number of iterations (API requests) made so far */
@@ -83,8 +88,7 @@ export class BetaToolRunner<Stream extends boolean> {
   async *[Symbol.asyncIterator](): AsyncIterator<
     Stream extends true ?
       ChatCompletionStream // TODO: for now!
-    : Stream extends false ? ChatCompletion
-    : ChatCompletionCreateParams | ChatCompletionCreateParams
+    : ChatCompletion | undefined
   > {
     if (this.#consumed) {
       throw new OpenAIError('Cannot iterate over a consumed stream');
@@ -96,7 +100,7 @@ export class BetaToolRunner<Stream extends boolean> {
 
     try {
       while (true) {
-        let stream: any;
+        let stream: ChatCompletionStream<null> | undefined;
         try {
           if (
             this.#state.params.max_iterations &&
@@ -111,44 +115,48 @@ export class BetaToolRunner<Stream extends boolean> {
           this.#iterationCount++;
 
           const { ...params } = this.#state.params;
+          const apiParams = { ...params };
+          delete apiParams.max_iterations; // our own param
+
           if (params.stream) {
-            stream = this.client.beta.chat.completions.stream({ ...params, stream: true }, this.#options);
+            stream = this.client.beta.chat.completions.stream({ ...apiParams, stream: true }, this.#options);
             this.#message = stream.finalMessage();
+
             // Make sure that this promise doesn't throw before we get the option to do something about it.
             // Error will be caught when we call await this.#message ultimately
             this.#message?.catch(() => {});
             yield stream as any;
           } else {
-            this.#message = this.client.beta.chat.completions.create(
+            const currentCompletion = this.client.beta.chat.completions.create(
               {
+                ...apiParams, // spread and explicit so we get better types
                 stream: false,
                 tools: params.tools,
                 messages: params.messages,
                 model: params.model,
               },
               this.#options,
             );
-            yield this.#message as any;
-          }
 
-          if (!this.#message) {
-            throw new Error('No message created'); // TODO: use better error
+            yield currentCompletion as any;
+
+            this.#message = currentCompletion.then((resp) => resp.choices.at(0)!.message);
           }
 
-          // TODO: we should probably hit the user with a callback or somehow offer for them to choice between the choices
-          if (!this.#message) {
-            throw new Error('No choices found in message'); // TODO: use better error
+          const prevMessage = await this.#message;
+
+          if (!prevMessage) {
+            throw new OpenAIError('ToolRunner concluded without a message from the server');
           }
 
           if (!this.#mutated) {
-            const completion = await this.#message;
             // TODO: what if it is empty?
-            if (completion?.choices && completion.choices.length > 0 && completion.choices[0]!.message) {
-              this.#state.params.messages.push(completion.choices[0]!.message);
+            if (prevMessage) {
+              this.#state.params.messages.push(prevMessage);
             }
           }
 
-          const toolMessages = await this.#generateToolResponse(await this.#message);
+          const toolMessages = await this.#generateToolResponse(prevMessage);
           if (toolMessages) {
             for (const toolMessage of toolMessages) {
               this.#state.params.messages.push(toolMessage);
@@ -228,15 +236,16 @@ export class BetaToolRunner<Stream extends boolean> {
    * }
    */
   async generateToolResponse() {
-    const message = (await this.#message) ?? this.params.messages.at(-1);
+    // The most recent message from the assistant. This prev had this.params.messages.at(-1) but I think that's wrong.
+    const message = await this.#message;
     if (!message) {
       return null;
     }
     return this.#generateToolResponse(message);
   }
 
-  async #generateToolResponse(lastMessage: ChatCompletion | ChatCompletionMessageParam) {
-    if (this.#toolResponse !== undefined) {
+  async #generateToolResponse(lastMessage: ChatCompletionMessage) {
+    if (this.#toolResponse) {
       return this.#toolResponse;
     }
     const toolsResponse = generateToolResponse(
@@ -263,8 +272,8 @@ export class BetaToolRunner<Stream extends boolean> {
    * const finalMessage = await runner.done();
    * console.log('Final response:', finalMessage.content);
    */
-  done(): Promise<ChatCompletion> {
-    return this.#completion.promise;
+  done(): Promise<ChatCompletionMessage> {
+    return this.#completion.promise; // TODO: find a more type safe way to do this
   }
 
   /**
@@ -280,7 +289,7 @@ export class BetaToolRunner<Stream extends boolean> {
    * const finalMessage = await runner.runUntilDone();
    * console.log('Final response:', finalMessage.content);
    */
-  async runUntilDone(): Promise<ChatCompletion> {
+  async runUntilDone(): Promise<ChatCompletionMessage> {
     // If not yet consumed, start consuming and wait for completion
     if (!this.#consumed) {
       for await (const _ of this) {
@@ -334,27 +343,18 @@ export class BetaToolRunner<Stream extends boolean> {
    * Makes the ToolRunner directly awaitable, equivalent to calling .runUntilDone()
    * This allows using `await runner` instead of `await runner.runUntilDone()`
    */
-  then<TResult1 = ChatCompletion, TResult2 = never>(
-    onfulfilled?: ((value: ChatCompletion) => TResult1 | PromiseLike<TResult1>) | undefined | null,
+  then<TResult1 = ChatCompletionMessage, TResult2 = never>( // TODO: make sure these types are OK
+    onfulfilled?: ((value: ChatCompletionMessage) => TResult1 | PromiseLike<TResult1>) | undefined | null,
     onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null,
   ): Promise<TResult1 | TResult2> {
     return this.runUntilDone().then(onfulfilled, onrejected);
   }
 }
 
 async function generateToolResponse(
-  params: ChatCompletion | ChatCompletionMessageParam,
+  lastMessage: ChatCompletionMessage,
   tools: BetaRunnableTool<any>[],
 ): Promise<null | ChatCompletionToolMessageParam[]> {
-  if (!('choices' in params)) {
-    return null;
-  }
-  const { choices } = params;
-  const lastMessage = choices[0]?.message;
-  if (!lastMessage) {
-    return null;
-  }
-
   // Only process if the last message is from the assistant and has tool use blocks
   if (
     !lastMessage ||

src/resources/beta/beta.ts

@@ -93,6 +93,7 @@ import {
   ThreadUpdateParams,
   Threads,
 } from './threads/threads';
+import { Chat } from './../chat';
 
 export class Beta extends APIResource {
   realtime: RealtimeAPI.Realtime = new RealtimeAPI.Realtime(this._client);
@@ -106,8 +107,11 @@ Beta.Realtime = Realtime;
 Beta.ChatKit = ChatKit;
 Beta.Assistants = Assistants;
 Beta.Threads = Threads;
+Beta.Chat = Chat;
 
 export declare namespace Beta {
+  export { Chat };
+
   export {
     Realtime as Realtime,
     type ConversationCreatedEvent as ConversationCreatedEvent,

src/resources/chat/completions/completions.ts

@@ -19,7 +19,11 @@ import { ChatCompletionToolRunnerParams } from '../../../lib/ChatCompletionRunne
 import { ChatCompletionStreamingToolRunnerParams } from '../../../lib/ChatCompletionStreamingRunner';
 import { ChatCompletionStream, type ChatCompletionStreamParams } from '../../../lib/ChatCompletionStream';
 import { ExtractParsedContentFromParams, parseChatCompletion, validateInputTools } from '../../../lib/parser';
-import { BetaToolRunner, BetaToolRunnerRequestOptions, type BetaToolRunnerParams } from '../../../lib/beta/BetaToolRunner';
+import {
+  BetaToolRunner,
+  type BetaToolRunnerRequestOptions,
+  type BetaToolRunnerParams,
+} from '../../../lib/beta/BetaToolRunner';
 import type OpenAI from '../../../index';
 
 export class Completions extends APIResource {
@@ -1998,6 +2002,7 @@ export interface ChatCompletionListParams extends CursorPageParams {
 }
 
 Completions.Messages = Messages;
+Completions.BetaToolRunner = BetaToolRunner;
 
 export declare namespace Completions {
   export {
@@ -2047,4 +2052,6 @@ export declare namespace Completions {
   };
 
   export { Messages as Messages, type MessageListParams as MessageListParams };
+
+  export { BetaToolRunner };
 }