fix(api): correct types for message attachment tools (#787)

openai · Apr 19, 2024 · 8626884 · 8626884
1 parent 7325009
commit 8626884
Show file tree

Hide file tree

Showing 6 changed files with 269 additions and 40 deletions.
diff --git a/src/resources/beta/threads/messages.ts b/src/resources/beta/threads/messages.ts
@@ -4,6 +4,7 @@ import * as Core from 'openai/core';
 import { APIResource } from 'openai/resource';
 import { isRequestOptions } from 'openai/core';
 import * as MessagesAPI from 'openai/resources/beta/threads/messages';
+import * as AssistantsAPI from 'openai/resources/beta/assistants';
 import { CursorPage, type CursorPageParams } from 'openai/pagination';
 
 export class Messages extends APIResource {
@@ -374,7 +375,10 @@ export namespace Message {
      */
     file_id?: string;
 
-    tools?: Array<'file_search' | 'code_interpreter'>;
+    /**
+     * The tools to add this file to.
+     */
+    tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
   }
 
   /**
@@ -528,7 +532,10 @@ export namespace MessageCreateParams {
      */
     file_id?: string;
 
-    tools?: Array<'file_search' | 'code_interpreter'>;
+    /**
+     * The tools to add this file to.
+     */
+    tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
   }
 }
 

diff --git a/src/resources/beta/threads/runs/runs.ts b/src/resources/beta/threads/runs/runs.ts
@@ -780,7 +780,10 @@ export namespace RunCreateParams {
        */
       file_id?: string;
 
-      tools?: Array<'file_search' | 'code_interpreter'>;
+      /**
+       * The tools to add this file to.
+       */
+      tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
     }
   }
 
@@ -1028,7 +1031,10 @@ export namespace RunCreateAndPollParams {
        */
       file_id?: string;
 
-      tools?: Array<'file_search' | 'code_interpreter'>;
+      /**
+       * The tools to add this file to.
+       */
+      tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
     }
   }
 
@@ -1229,7 +1235,10 @@ export namespace RunCreateAndStreamParams {
        */
       file_id?: string;
 
-      tools?: Array<'file_search' | 'code_interpreter'>;
+      /**
+       * The tools to add this file to.
+       */
+      tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
     }
   }
 
@@ -1430,7 +1439,10 @@ export namespace RunStreamParams {
        */
       file_id?: string;
 
-      tools?: Array<'file_search' | 'code_interpreter'>;
+      /**
+       * The tools to add this file to.
+       */
+      tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
     }
   }
 

diff --git a/src/resources/beta/threads/threads.ts b/src/resources/beta/threads/threads.ts
@@ -318,7 +318,10 @@ export namespace ThreadCreateParams {
        */
       file_id?: string;
 
-      tools?: Array<'file_search' | 'code_interpreter'>;
+      /**
+       * The tools to add this file to.
+       */
+      tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
     }
   }
 
@@ -653,7 +656,10 @@ export namespace ThreadCreateAndRunParams {
          */
         file_id?: string;
 
-        tools?: Array<'file_search' | 'code_interpreter'>;
+        /**
+         * The tools to add this file to.
+         */
+        tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
       }
     }
 
@@ -999,7 +1005,10 @@ export namespace ThreadCreateAndRunPollParams {
          */
         file_id?: string;
 
-        tools?: Array<'file_search' | 'code_interpreter'>;
+        /**
+         * The tools to add this file to.
+         */
+        tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
       }
     }
 
@@ -1324,7 +1333,10 @@ export namespace ThreadCreateAndRunStreamParams {
          */
         file_id?: string;
 
-        tools?: Array<'file_search' | 'code_interpreter'>;
+        /**
+         * The tools to add this file to.
+         */
+        tools?: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.FileSearchTool>;
       }
     }
 

diff --git a/tests/api-resources/beta/threads/messages.test.ts b/tests/api-resources/beta/threads/messages.test.ts
@@ -25,9 +25,18 @@ describe('resource messages', () => {
       content: 'x',
       role: 'user',
       attachments: [
-        { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
-        { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
-        { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
+        {
+          file_id: 'string',
+          tools: [{ type: 'code_interpreter' }, { type: 'code_interpreter' }, { type: 'code_interpreter' }],
+        },
+        {
+          file_id: 'string',
+          tools: [{ type: 'code_interpreter' }, { type: 'code_interpreter' }, { type: 'code_interpreter' }],
+        },
+        {
+          file_id: 'string',
+          tools: [{ type: 'code_interpreter' }, { type: 'code_interpreter' }, { type: 'code_interpreter' }],
+        },
       ],
       metadata: {},
     });

diff --git a/tests/api-resources/beta/threads/runs/runs.test.ts b/tests/api-resources/beta/threads/runs/runs.test.ts
@@ -29,29 +29,92 @@ describe('resource runs', () => {
           role: 'user',
           content: 'x',
           attachments: [
-            { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
-            { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
-            { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
+            {
+              file_id: 'string',
+              tools: [
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+              ],
+            },
+            {
+              file_id: 'string',
+              tools: [
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+              ],
+            },
+            {
+              file_id: 'string',
+              tools: [
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+              ],
+            },
           ],
           metadata: {},
         },
         {
           role: 'user',
           content: 'x',
           attachments: [
-            { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
-            { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
-            { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
+            {
+              file_id: 'string',
+              tools: [
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+              ],
+            },
+            {
+              file_id: 'string',
+              tools: [
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+              ],
+            },
+            {
+              file_id: 'string',
+              tools: [
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+              ],
+            },
           ],
           metadata: {},
         },
         {
           role: 'user',
           content: 'x',
           attachments: [
-            { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
-            { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
-            { file_id: 'string', tools: ['file_search', 'code_interpreter'] },
+            {
+              file_id: 'string',
+              tools: [
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+              ],
+            },
+            {
+              file_id: 'string',
+              tools: [
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+              ],
+            },
+            {
+              file_id: 'string',
+              tools: [
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+                { type: 'code_interpreter' },
+              ],
+            },
           ],
           metadata: {},
         },