PR feedback

Author: 404Wolf

examples/tool-calls-beta-zod.ts

@@ -18,7 +18,7 @@ async function main() {
       betaZodTool({
         name: 'getWeather',
         description: 'Get the weather at a specific location',
-        inputSchema: z.object({
+        parameters: z.object({
           location: z.string().describe('The city and state, e.g. San Francisco, CA'),
         }),
         run: ({ location }) => {
@@ -28,7 +28,7 @@ async function main() {
       betaZodTool({
         name: 'getTime',
         description: 'Get the current time in a specific timezone',
-        inputSchema: z.object({
+        parameters: z.object({
           timezone: z.string().describe('The timezone, e.g. America/Los_Angeles'),
         }),
         run: ({ timezone }) => {
@@ -38,7 +38,7 @@ async function main() {
       betaZodTool({
         name: 'getCurrencyExchangeRate',
         description: 'Get the exchange rate between two currencies',
-        inputSchema: z.object({
+        parameters: z.object({
           from_currency: z.string().describe('The currency to convert from, e.g. USD'),
           to_currency: z.string().describe('The currency to convert to, e.g. EUR'),
         }),

examples/tool-helpers-advanced-streaming.ts

@@ -18,7 +18,7 @@ async function main() {
       betaZodTool({
         name: 'getWeather',
         description: 'Get the weather at a specific location',
-        inputSchema: z.object({
+        parameters: z.object({
           location: z.string().describe('The city and state, e.g. San Francisco, CA'),
         }),
         run: ({ location }) => {
@@ -28,7 +28,7 @@ async function main() {
       betaZodTool({
         name: 'getTime',
         description: 'Get the current time in a specific timezone',
-        inputSchema: z.object({
+        parameters: z.object({
           timezone: z.string().describe('The timezone, e.g. America/Los_Angeles'),
         }),
         run: ({ timezone }) => {
@@ -38,7 +38,7 @@ async function main() {
       betaZodTool({
         name: 'getCurrencyExchangeRate',
         description: 'Get the exchange rate between two currencies',
-        inputSchema: z.object({
+        parameters: z.object({
           from_currency: z.string().describe('The currency to convert from, e.g. USD'),
           to_currency: z.string().describe('The currency to convert to, e.g. EUR'),
         }),

examples/tool-helpers-advanced.ts

@@ -18,7 +18,7 @@ async function main() {
       betaZodTool({
         name: 'getWeather',
         description: 'Get the weather at a specific location',
-        inputSchema: z.object({
+        parameters: z.object({
           location: z.string().describe('The city and state, e.g. San Francisco, CA'),
         }),
         run: ({ location }) => {

src/helpers/beta/zod.ts

@@ -11,11 +11,11 @@ import type { FunctionTool } from '../../resources/beta';
  */
 export function betaZodTool<InputSchema extends ZodType>(options: {
   name: string;
-  inputSchema: InputSchema;
+  parameters: InputSchema;
   description: string;
   run: (args: zodInfer<InputSchema>) => Promisable<string | Array<FunctionTool>>; // TODO: I changed this but double check
 }): BetaRunnableTool<zodInfer<InputSchema>> {
-  const jsonSchema = z.toJSONSchema(options.inputSchema, { reused: 'ref' });
+  const jsonSchema = z.toJSONSchema(options.parameters, { reused: 'ref' });
 
   if (jsonSchema.type !== 'object') {
     throw new Error(`Zod schema for tool "${options.name}" must be an object, but got ${jsonSchema.type}`);
@@ -35,6 +35,6 @@ export function betaZodTool<InputSchema extends ZodType>(options: {
       },
     },
     run: options.run,
-    parse: (args: unknown) => options.inputSchema.parse(args) as zodInfer<InputSchema>,
+    parse: (args: unknown) => options.parameters.parse(args),
   };
 }

src/lib/beta/BetaToolRunner.ts

@@ -31,12 +31,14 @@ function promiseWithResolvers<T>(): {
 }
 
 /**
- * A ToolRunner handles the automatic conversation loop between the assistant and tools.
+ * A BetaToolRunner handles the automatic conversation loop between the assistant and tools.
  *
- * A ToolRunner is an async iterable that yields either BetaMessage or BetaMessageStream objects
- * depending on the streaming configuration.
+ * A BetaToolRunner is an async iterable that yields either ChatCompletion or
+ * ChatCompletionStream objects depending on the streaming configuration.
  */
-export class BetaToolRunner<Stream extends boolean> {
+export class BetaToolRunner<Stream extends boolean>
+  implements AsyncIterable<Stream extends true ? ChatCompletionStream : ChatCompletion>
+{
   /** Whether the async iterator has been consumed */
   #consumed = false;
   /** Whether parameters have been mutated since the last API call */
@@ -72,8 +74,7 @@ export class BetaToolRunner<Stream extends boolean> {
     params: BetaToolRunnerParams,
     options?: BetaToolRunnerRequestOptions,
   ) {
-    params.n ??= 1;
-    if (params && params.n > 1) {
+    if (params.n && params.n > 1) {
       throw new Error('BetaToolRunner does not support n > 1');
     }
 
@@ -97,7 +98,7 @@ export class BetaToolRunner<Stream extends boolean> {
   async *[Symbol.asyncIterator](): AsyncIterator<
     Stream extends true ?
       ChatCompletionStream // TODO: for now!
-    : ChatCompletion | undefined
+    : ChatCompletion
   > {
     if (this.#consumed) {
       throw new OpenAIError('Cannot iterate over a consumed stream');
@@ -123,26 +124,21 @@ export class BetaToolRunner<Stream extends boolean> {
           this.#toolResponse = undefined;
           this.#iterationCount++;
 
-          const { ...params } = this.#state.params;
-          const apiParams = { ...params };
-          delete apiParams.max_iterations; // our own param
+          const { max_iterations, ...params } = this.#state.params;
 
           if (params.stream) {
-            stream = this.client.beta.chat.completions.stream({ ...apiParams, stream: true }, this.#options);
+            stream = this.client.chat.completions.stream({ ...params, 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.#chatCompletion = this.client.beta.chat.completions.create(
+            this.#chatCompletion = this.client.chat.completions.create(
               {
-                ...apiParams, // spread and explicit so we get better types
+                ...params, // spread and explicit so we get better types
                 stream: false,
-                tools: params.tools,
-                messages: params.messages,
-                model: params.model,
               },
               this.#options,
             );
@@ -155,15 +151,8 @@ export class BetaToolRunner<Stream extends boolean> {
 
           const prevMessage = await this.#message;
 
-          if (!prevMessage) {
-            throw new OpenAIError('ToolRunner concluded without a message from the server');
-          }
-
           if (!this.#mutated) {
-            // TODO: what if it is empty?
-            if (prevMessage) {
-              this.#state.params.messages.push(prevMessage);
-            }
+            this.#state.params.messages.push(prevMessage);
           }
 
           const toolMessages = await this.#generateToolResponse(prevMessage);
@@ -173,7 +162,6 @@ export class BetaToolRunner<Stream extends boolean> {
             }
           }
 
-          // TODO: make sure this is correct?
           if (!toolMessages && !this.#mutated) {
             break;
           }
@@ -206,21 +194,28 @@ export class BetaToolRunner<Stream extends boolean> {
    *
    * @example
    * // Direct parameter update
-   * runner.setMessagesParams({
+   * runner.setChatParams({
    *   model: 'gpt-4o',
    *   max_tokens: 500,
    * });
    *
    * @example
    * // Using a mutator function
-   * runner.setMessagesParams((params) => ({
+   * runner.setChatParams((params) => ({
    *   ...params,
    *   max_tokens: 100,
    * }));
+   *
+   * @example
+   * // Appending a user message
+   * runner.setChatParams((params) => ({
+   *   ...params,
+   *   messages: [...params.messages, { role: 'user', content: 'What colour is the sky?' }],
+   * }));
    */
-  setMessagesParams(params: BetaToolRunnerParams): void;
-  setMessagesParams(mutator: (prevParams: BetaToolRunnerParams) => BetaToolRunnerParams): void;
-  setMessagesParams(
+  setChatParams(params: BetaToolRunnerParams): void;
+  setChatParams(mutator: (prevParams: BetaToolRunnerParams) => BetaToolRunnerParams): void;
+  setChatParams(
     paramsOrMutator: BetaToolRunnerParams | ((prevParams: BetaToolRunnerParams) => BetaToolRunnerParams),
   ) {
     if (typeof paramsOrMutator === 'function') {
@@ -343,7 +338,7 @@ export class BetaToolRunner<Stream extends boolean> {
    * );
    */
   pushMessages(...messages: ChatCompletionMessageParam[]) {
-    this.setMessagesParams((params) => ({
+    this.setChatParams((params) => ({
       ...params,
       messages: [...params.messages, ...messages],
     }));

src/resources/beta/chat.ts

@@ -4,9 +4,8 @@ import {
   type BetaToolRunnerParams,
   type BetaToolRunnerRequestOptions,
 } from '../../lib/beta/BetaToolRunner';
-import { Chat as ChatResource } from '../../resources';
 
-export class BetaCompletions extends ChatResource.Completions {
+export class BetaCompletions extends APIResource {
   toolRunner(
     body: BetaToolRunnerParams & { stream?: false },
     options?: BetaToolRunnerRequestOptions,

tests/lib/tools/ToolRunner.test.ts renamed to tests/lib/tools/BetaToolRunner.test.ts

@@ -942,7 +942,7 @@ describe('ToolRunner', () => {
       });
 
       // Update parameters before iteration
-      runner.setMessagesParams({
+      runner.setChatParams({
         messages: [{ role: 'user', content: 'Updated message' }],
         model: 'gpt-4o',
         max_tokens: 200,
@@ -981,7 +981,7 @@ describe('ToolRunner', () => {
       expect(toolResponse).toMatchObject([getWeatherToolResult('Paris')]);
 
       // Update params to append a custom tool_use block to messages
-      runner.setMessagesParams({
+      runner.setChatParams({
         ...runner.params,
         messages: [
           ...runner.params.messages,

tests/lib/tools/ToolRunnerE2E.test.ts renamed to tests/lib/tools/BetaToolRunnerE2E.test.ts

@@ -104,7 +104,7 @@ describe('toolRunner integration tests', () => {
   ) {
     return betaZodTool({
       name: 'test_tool',
-      inputSchema: z.object({ value: z.string() }),
+      parameters: z.object({ value: z.string() }),
       description: 'A test tool',
       run: () => 'Tool result',
       ...customConfig,
@@ -114,7 +114,7 @@ describe('toolRunner integration tests', () => {
   function createCounterTool() {
     return betaZodTool({
       name: 'test_tool',
-      inputSchema: z.object({ count: z.number() }),
+      parameters: z.object({ count: z.number() }),
       description: 'A test tool',
       run: (args) => `Called with ${args.count}`,
     });
@@ -259,7 +259,7 @@ describe('toolRunner integration tests', () => {
       });
 
       // Update parameters
-      runner.setMessagesParams({
+      runner.setChatParams({
         model: 'gpt-4o',
         max_tokens: 500,
         messages: [{ role: 'user', content: 'Updated message' }],