feat(api): add file search result details to run steps (#1023)

openai · Aug 29, 2024 · d9acd0a · d9acd0a
1 parent 081e21a
commit d9acd0a
Show file tree

Hide file tree

Showing 12 changed files with 400 additions and 91 deletions.
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 68
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-8ff62fa1091460d68fbd36d72c17d91b709917bebf2983c9c4de5784bc384a2e.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-1dbac0e95bdb5a89a0dd3d93265475a378214551b7d8c22862928e0d87ace94b.yml
diff --git a/api.md b/api.md
@@ -339,14 +339,15 @@ Types:
 - <code><a href="./src/resources/beta/threads/runs/steps.ts">RunStepDelta</a></code>
 - <code><a href="./src/resources/beta/threads/runs/steps.ts">RunStepDeltaEvent</a></code>
 - <code><a href="./src/resources/beta/threads/runs/steps.ts">RunStepDeltaMessageDelta</a></code>
+- <code><a href="./src/resources/beta/threads/runs/steps.ts">RunStepInclude</a></code>
 - <code><a href="./src/resources/beta/threads/runs/steps.ts">ToolCall</a></code>
 - <code><a href="./src/resources/beta/threads/runs/steps.ts">ToolCallDelta</a></code>
 - <code><a href="./src/resources/beta/threads/runs/steps.ts">ToolCallDeltaObject</a></code>
 - <code><a href="./src/resources/beta/threads/runs/steps.ts">ToolCallsStepDetails</a></code>
 
 Methods:
 
-- <code title="get /threads/{thread_id}/runs/{run_id}/steps/{step_id}">client.beta.threads.runs.steps.<a href="./src/resources/beta/threads/runs/steps.ts">retrieve</a>(threadId, runId, stepId) -> RunStep</code>
+- <code title="get /threads/{thread_id}/runs/{run_id}/steps/{step_id}">client.beta.threads.runs.steps.<a href="./src/resources/beta/threads/runs/steps.ts">retrieve</a>(threadId, runId, stepId, { ...params }) -> RunStep</code>
 - <code title="get /threads/{thread_id}/runs/{run_id}/steps">client.beta.threads.runs.steps.<a href="./src/resources/beta/threads/runs/steps.ts">list</a>(threadId, runId, { ...params }) -> RunStepsPage</code>
 
 ### Messages

diff --git a/package.json b/package.json
@@ -26,11 +26,13 @@
   "dependencies": {
     "@types/node": "^18.11.18",
     "@types/node-fetch": "^2.6.4",
+    "@types/qs": "^6.9.7",
     "abort-controller": "^3.0.0",
     "agentkeepalive": "^4.2.1",
     "form-data-encoder": "1.7.2",
     "formdata-node": "^4.3.2",
-    "node-fetch": "^2.6.7"
+    "node-fetch": "^2.6.7",
+    "qs": "^6.10.3"
   },
   "devDependencies": {
     "@swc/core": "^1.3.102",

diff --git a/src/index.ts b/src/index.ts
@@ -2,7 +2,10 @@
 
 import * as Errors from './error';
 import * as Uploads from './uploads';
+
 import { type Agent, type RequestInit } from './_shims/index';
+import * as qs from 'qs';
+
 import * as Core from './core';
 import * as Pagination from './pagination';
 import * as API from './resources/index';
@@ -183,6 +186,10 @@ export class OpenAI extends Core.APIClient {
     return { Authorization: `Bearer ${this.apiKey}` };
   }
 
+  protected override stringifyQuery(query: Record<string, unknown>): string {
+    return qs.stringify(query, { arrayFormat: 'brackets' });
+  }
+
   static OpenAI = this;
   static DEFAULT_TIMEOUT = 600000; // 10 minutes
 

diff --git a/src/resources/beta/assistants.ts b/src/resources/beta/assistants.ts
@@ -441,8 +441,8 @@ export namespace AssistantStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object) is
-   * created.
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
+   * is created.
    */
   export interface ThreadRunStepCreated {
     /**
@@ -455,7 +455,7 @@ export namespace AssistantStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object)
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
    * moves to an `in_progress` state.
    */
   export interface ThreadRunStepInProgress {
@@ -469,8 +469,8 @@ export namespace AssistantStreamEvent {
 
   /**
    * Occurs when parts of a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object) are
-   * being streamed.
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
+   * are being streamed.
    */
   export interface ThreadRunStepDelta {
     /**
@@ -484,8 +484,8 @@ export namespace AssistantStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object) is
-   * completed.
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
+   * is completed.
    */
   export interface ThreadRunStepCompleted {
     /**
@@ -498,7 +498,7 @@ export namespace AssistantStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object)
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
    * fails.
    */
   export interface ThreadRunStepFailed {
@@ -512,8 +512,8 @@ export namespace AssistantStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object) is
-   * cancelled.
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
+   * is cancelled.
    */
   export interface ThreadRunStepCancelled {
     /**
@@ -526,7 +526,7 @@ export namespace AssistantStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object)
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
    * expires.
    */
   export interface ThreadRunStepExpired {
@@ -658,10 +658,42 @@ export namespace FileSearchTool {
      *
      * Note that the file search tool may output fewer than `max_num_results` results.
      * See the
-     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/number-of-chunks-returned)
+     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings)
      * for more information.
      */
     max_num_results?: number;
+
+    /**
+     * The ranking options for the file search.
+     *
+     * See the
+     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings)
+     * for more information.
+     */
+    ranking_options?: FileSearch.RankingOptions;
+  }
+
+  export namespace FileSearch {
+    /**
+     * The ranking options for the file search.
+     *
+     * See the
+     * [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search/customizing-file-search-settings)
+     * for more information.
+     */
+    export interface RankingOptions {
+      /**
+       * The ranker to use for the file search. If not specified will use the `auto`
+       * ranker.
+       */
+      ranker?: 'auto' | 'default_2024_08_21';
+
+      /**
+       * The score threshold for the file search. All values must be a floating point
+       * number between 0 and 1.
+       */
+      score_threshold?: number;
+    }
   }
 }
 
@@ -765,8 +797,8 @@ export namespace MessageStreamEvent {
 
 /**
  * Occurs when a
- * [run step](https://platform.openai.com/docs/api-reference/runs/step-object) is
- * created.
+ * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
+ * is created.
  */
 export type RunStepStreamEvent =
   | RunStepStreamEvent.ThreadRunStepCreated
@@ -780,8 +812,8 @@ export type RunStepStreamEvent =
 export namespace RunStepStreamEvent {
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object) is
-   * created.
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
+   * is created.
    */
   export interface ThreadRunStepCreated {
     /**
@@ -794,7 +826,7 @@ export namespace RunStepStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object)
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
    * moves to an `in_progress` state.
    */
   export interface ThreadRunStepInProgress {
@@ -808,8 +840,8 @@ export namespace RunStepStreamEvent {
 
   /**
    * Occurs when parts of a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object) are
-   * being streamed.
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
+   * are being streamed.
    */
   export interface ThreadRunStepDelta {
     /**
@@ -823,8 +855,8 @@ export namespace RunStepStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object) is
-   * completed.
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
+   * is completed.
    */
   export interface ThreadRunStepCompleted {
     /**
@@ -837,7 +869,7 @@ export namespace RunStepStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object)
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
    * fails.
    */
   export interface ThreadRunStepFailed {
@@ -851,8 +883,8 @@ export namespace RunStepStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object) is
-   * cancelled.
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
+   * is cancelled.
    */
   export interface ThreadRunStepCancelled {
     /**
@@ -865,7 +897,7 @@ export namespace RunStepStreamEvent {
 
   /**
    * Occurs when a
-   * [run step](https://platform.openai.com/docs/api-reference/runs/step-object)
+   * [run step](https://platform.openai.com/docs/api-reference/run-steps/step-object)
    * expires.
    */
   export interface ThreadRunStepExpired {

diff --git a/src/resources/beta/threads/runs/index.ts b/src/resources/beta/threads/runs/index.ts
@@ -14,10 +14,12 @@ export {
   RunStepDelta,
   RunStepDeltaEvent,
   RunStepDeltaMessageDelta,
+  RunStepInclude,
   ToolCall,
   ToolCallDelta,
   ToolCallDeltaObject,
   ToolCallsStepDetails,
+  StepRetrieveParams,
   StepListParams,
   RunStepsPage,
   Steps,