openai 4.35.0 → 4.37.0

package/src/resources/beta/threads/{messages/messages.ts → messages.ts}

@@ -1,15 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from "../../../../core";
-import { APIResource } from "../../../../resource";
-import { isRequestOptions } from "../../../../core";
+import * as Core from "../../../core";
+import { APIResource } from "../../../resource";
+import { isRequestOptions } from "../../../core";
 import * as MessagesAPI from "./messages";
-import * as FilesAPI from "./files";
-import { CursorPage, type CursorPageParams } from "../../../../pagination";
+import { CursorPage, type CursorPageParams } from "../../../pagination";
 
 export class Messages extends APIResource {
-  files: FilesAPI.Files = new FilesAPI.Files(this._client);
-
   /**
    * Create a message.
    */
@@ -21,7 +18,7 @@ export class Messages extends APIResource {
     return this._client.post(`/threads/${threadId}/messages`, {
       body,
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 
@@ -31,7 +28,7 @@ export class Messages extends APIResource {
   retrieve(threadId: string, messageId: string, options?: Core.RequestOptions): Core.APIPromise<Message> {
     return this._client.get(`/threads/${threadId}/messages/${messageId}`, {
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 
@@ -47,7 +44,7 @@ export class Messages extends APIResource {
     return this._client.post(`/threads/${threadId}/messages/${messageId}`, {
       body,
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 
@@ -71,7 +68,7 @@ export class Messages extends APIResource {
     return this._client.getAPIList(`/threads/${threadId}/messages`, MessagesPage, {
       query,
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 }
@@ -81,21 +78,21 @@ export class MessagesPage extends CursorPage<Message> {}
 /**
  * A citation within the message that points to a specific quote from a specific
  * File associated with the assistant or the message. Generated when the assistant
- * uses the "retrieval" tool to search files.
+ * uses the "file_search" tool to search files.
  */
 export type Annotation = FileCitationAnnotation | FilePathAnnotation;
 
 /**
  * A citation within the message that points to a specific quote from a specific
  * File associated with the assistant or the message. Generated when the assistant
- * uses the "retrieval" tool to search files.
+ * uses the "file_search" tool to search files.
  */
 export type AnnotationDelta = FileCitationDeltaAnnotation | FilePathDeltaAnnotation;
 
 /**
  * A citation within the message that points to a specific quote from a specific
  * File associated with the assistant or the message. Generated when the assistant
- * uses the "retrieval" tool to search files.
+ * uses the "file_search" tool to search files.
  */
 export interface FileCitationAnnotation {
   end_index: number;
@@ -132,7 +129,7 @@ export namespace FileCitationAnnotation {
 /**
  * A citation within the message that points to a specific quote from a specific
  * File associated with the assistant or the message. Generated when the assistant
- * uses the "retrieval" tool to search files.
+ * uses the "file_search" tool to search files.
  */
 export interface FileCitationDeltaAnnotation {
   /**
@@ -302,6 +299,11 @@ export interface Message {
    */
   assistant_id: string | null;
 
+  /**
+   * A list of files attached to the message, and the tools they were added to.
+   */
+  attachments: Array<Message.Attachment> | null;
+
   /**
    * The Unix timestamp (in seconds) for when the message was completed.
    */
@@ -317,13 +319,6 @@ export interface Message {
    */
   created_at: number;
 
-  /**
-   * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs that
-   * the assistant should use. Useful for tools like retrieval and code_interpreter
-   * that can access files. A maximum of 10 files can be attached to a message.
-   */
-  file_ids: Array<string>;
-
   /**
    * The Unix timestamp (in seconds) for when the message was marked as incomplete.
    */
@@ -373,6 +368,15 @@ export interface Message {
 }
 
 export namespace Message {
+  export interface Attachment {
+    add_to?: Array<'file_search' | 'code_interpreter'>;
+
+    /**
+     * The ID of the file to attach to the message.
+     */
+    file_id?: string;
+  }
+
   /**
    * On an incomplete message, details about why the message is incomplete.
    */
@@ -413,13 +417,6 @@ export interface MessageDelta {
    */
   content?: Array<MessageContentDelta>;
 
-  /**
-   * A list of [file](https://platform.openai.com/docs/api-reference/files) IDs that
-   * the assistant should use. Useful for tools like retrieval and code_interpreter
-   * that can access files. A maximum of 10 files can be attached to a message.
-   */
-  file_ids?: Array<string>;
-
   /**
    * The entity that produced the message. One of `user` or `assistant`.
    */
@@ -511,12 +508,9 @@ export interface MessageCreateParams {
   role: 'user' | 'assistant';
 
   /**
-   * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-   * the message should use. There can be a maximum of 10 files attached to a
-   * message. Useful for tools like `retrieval` and `code_interpreter` that can
-   * access and use files.
+   * A list of files attached to the message, and the tools they should be added to.
    */
-  file_ids?: Array<string>;
+  attachments?: Array<MessageCreateParams.Attachment> | null;
 
   /**
    * Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -527,6 +521,17 @@ export interface MessageCreateParams {
   metadata?: unknown | null;
 }
 
+export namespace MessageCreateParams {
+  export interface Attachment {
+    add_to?: Array<'file_search' | 'code_interpreter'>;
+
+    /**
+     * The ID of the file to attach to the message.
+     */
+    file_id?: string;
+  }
+}
+
 export interface MessageUpdateParams {
   /**
    * Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -583,8 +588,4 @@ export namespace Messages {
   export import MessageCreateParams = MessagesAPI.MessageCreateParams;
   export import MessageUpdateParams = MessagesAPI.MessageUpdateParams;
   export import MessageListParams = MessagesAPI.MessageListParams;
-  export import Files = FilesAPI.Files;
-  export import MessageFile = FilesAPI.MessageFile;
-  export import MessageFilesPage = FilesAPI.MessageFilesPage;
-  export import FileListParams = FilesAPI.FileListParams;
 }

package/src/resources/beta/threads/runs/index.ts

@@ -5,11 +5,11 @@ export {
   CodeInterpreterOutputImage,
   CodeInterpreterToolCall,
   CodeInterpreterToolCallDelta,
+  FileSearchToolCall,
+  FileSearchToolCallDelta,
   FunctionToolCall,
   FunctionToolCallDelta,
   MessageCreationStepDetails,
-  RetrievalToolCall,
-  RetrievalToolCallDelta,
   RunStep,
   RunStepDelta,
   RunStepDeltaEvent,

package/src/resources/beta/threads/runs/runs.ts

@@ -8,7 +8,7 @@ import { AssistantStream, RunCreateParamsBaseStream } from "../../../../lib/Assi
 import { sleep } from "../../../../core";
 import { RunSubmitToolOutputsParamsStream } from "../../../../lib/AssistantStream";
 import * as RunsAPI from "./runs";
-import * as AssistantsAPI from "../../assistants/assistants";
+import * as AssistantsAPI from "../../assistants";
 import * as ThreadsAPI from "../threads";
 import * as StepsAPI from "./steps";
 import { CursorPage, type CursorPageParams } from "../../../../pagination";
@@ -39,7 +39,7 @@ export class Runs extends APIResource {
     return this._client.post(`/threads/${threadId}/runs`, {
       body,
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
       stream: body.stream ?? false,
     }) as APIPromise<Run> | APIPromise<Stream<AssistantsAPI.AssistantStreamEvent>>;
   }
@@ -50,7 +50,7 @@ export class Runs extends APIResource {
   retrieve(threadId: string, runId: string, options?: Core.RequestOptions): Core.APIPromise<Run> {
     return this._client.get(`/threads/${threadId}/runs/${runId}`, {
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 
@@ -66,7 +66,7 @@ export class Runs extends APIResource {
     return this._client.post(`/threads/${threadId}/runs/${runId}`, {
       body,
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 
@@ -90,7 +90,7 @@ export class Runs extends APIResource {
     return this._client.getAPIList(`/threads/${threadId}/runs`, RunsPage, {
       query,
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 
@@ -100,7 +100,7 @@ export class Runs extends APIResource {
   cancel(threadId: string, runId: string, options?: Core.RequestOptions): Core.APIPromise<Run> {
     return this._client.post(`/threads/${threadId}/runs/${runId}/cancel`, {
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 
@@ -224,7 +224,7 @@ export class Runs extends APIResource {
     return this._client.post(`/threads/${threadId}/runs/${runId}/submit_tool_outputs`, {
       body,
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
       stream: body.stream ?? false,
     }) as APIPromise<Run> | APIPromise<Stream<AssistantsAPI.AssistantStreamEvent>>;
   }
@@ -350,13 +350,6 @@ export interface Run {
    */
   failed_at: number | null;
 
-  /**
-   * The list of [File](https://platform.openai.com/docs/api-reference/files) IDs the
-   * [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
-   * this run.
-   */
-  file_ids: Array<string>;
-
   /**
    * Details on why the run is incomplete. Will be `null` if the run is not
    * incomplete.
@@ -478,6 +471,11 @@ export interface Run {
    * The sampling temperature used for this run. If not set, defaults to 1.
    */
   temperature?: number | null;
+
+  /**
+   * The nucleus sampling value used for this run. If not set, defaults to 1.
+   */
+  top_p?: number | null;
 }
 
 export namespace Run {
@@ -720,6 +718,13 @@ export interface RunCreateParamsBase {
    */
   tools?: Array<AssistantsAPI.AssistantTool> | null;
 
+  /**
+   * An alternative to sampling with temperature, called nucleus sampling, where the
+   * model considers the results of the tokens with top_p probability mass. So 0.1
+   * means only the tokens comprising the top 10% probability mass are considered.
+   */
+  top_p?: number | null;
+
   truncation_strategy?: RunCreateParams.TruncationStrategy | null;
 }
 
@@ -741,12 +746,9 @@ export namespace RunCreateParams {
     role: 'user' | 'assistant';
 
     /**
-     * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-     * the message should use. There can be a maximum of 10 files attached to a
-     * message. Useful for tools like `retrieval` and `code_interpreter` that can
-     * access and use files.
+     * A list of files attached to the message, and the tools they should be added to.
      */
-    file_ids?: Array<string>;
+    attachments?: Array<AdditionalMessage.Attachment> | null;
 
     /**
      * Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -757,6 +759,17 @@ export namespace RunCreateParams {
     metadata?: unknown | null;
   }
 
+  export namespace AdditionalMessage {
+    export interface Attachment {
+      add_to?: Array<'file_search' | 'code_interpreter'>;
+
+      /**
+       * The ID of the file to attach to the message.
+       */
+      file_id?: string;
+    }
+  }
+
   export interface TruncationStrategy {
     /**
      * The truncation strategy to use for the thread. The default is `auto`. If set to
@@ -943,6 +956,13 @@ export interface RunCreateAndPollParams {
    */
   tools?: Array<AssistantsAPI.AssistantTool> | null;
 
+  /**
+   * An alternative to sampling with temperature, called nucleus sampling, where the
+   * model considers the results of the tokens with top_p probability mass. So 0.1
+   * means only the tokens comprising the top 10% probability mass are considered.
+   */
+  top_p?: number | null;
+
   truncation_strategy?: RunCreateAndPollParams.TruncationStrategy | null;
 }
 
@@ -964,12 +984,9 @@ export namespace RunCreateAndPollParams {
     role: 'user' | 'assistant';
 
     /**
-     * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-     * the message should use. There can be a maximum of 10 files attached to a
-     * message. Useful for tools like `retrieval` and `code_interpreter` that can
-     * access and use files.
+     * A list of files attached to the message, and the tools they should be added to.
      */
-    file_ids?: Array<string>;
+    attachments?: Array<AdditionalMessage.Attachment> | null;
 
     /**
      * Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -980,6 +997,17 @@ export namespace RunCreateAndPollParams {
     metadata?: unknown | null;
   }
 
+  export namespace AdditionalMessage {
+    export interface Attachment {
+      add_to?: Array<'file_search' | 'code_interpreter'>;
+
+      /**
+       * The ID of the file to attach to the message.
+       */
+      file_id?: string;
+    }
+  }
+
   export interface TruncationStrategy {
     /**
      * The truncation strategy to use for the thread. The default is `auto`. If set to
@@ -1119,6 +1147,13 @@ export interface RunCreateAndStreamParams {
    */
   tools?: Array<AssistantsAPI.AssistantTool> | null;
 
+  /**
+   * An alternative to sampling with temperature, called nucleus sampling, where the
+   * model considers the results of the tokens with top_p probability mass. So 0.1
+   * means only the tokens comprising the top 10% probability mass are considered.
+   */
+  top_p?: number | null;
+
   truncation_strategy?: RunCreateAndStreamParams.TruncationStrategy | null;
 }
 
@@ -1140,12 +1175,9 @@ export namespace RunCreateAndStreamParams {
     role: 'user' | 'assistant';
 
     /**
-     * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-     * the message should use. There can be a maximum of 10 files attached to a
-     * message. Useful for tools like `retrieval` and `code_interpreter` that can
-     * access and use files.
+     * A list of files attached to the message, and the tools they should be added to.
      */
-    file_ids?: Array<string>;
+    attachments?: Array<AdditionalMessage.Attachment> | null;
 
     /**
      * Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -1156,6 +1188,17 @@ export namespace RunCreateAndStreamParams {
     metadata?: unknown | null;
   }
 
+  export namespace AdditionalMessage {
+    export interface Attachment {
+      add_to?: Array<'file_search' | 'code_interpreter'>;
+
+      /**
+       * The ID of the file to attach to the message.
+       */
+      file_id?: string;
+    }
+  }
+
   export interface TruncationStrategy {
     /**
      * The truncation strategy to use for the thread. The default is `auto`. If set to
@@ -1295,6 +1338,13 @@ export interface RunStreamParams {
    */
   tools?: Array<AssistantsAPI.AssistantTool> | null;
 
+  /**
+   * An alternative to sampling with temperature, called nucleus sampling, where the
+   * model considers the results of the tokens with top_p probability mass. So 0.1
+   * means only the tokens comprising the top 10% probability mass are considered.
+   */
+  top_p?: number | null;
+
   truncation_strategy?: RunStreamParams.TruncationStrategy | null;
 }
 
@@ -1316,12 +1366,9 @@ export namespace RunStreamParams {
     role: 'user' | 'assistant';
 
     /**
-     * A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
-     * the message should use. There can be a maximum of 10 files attached to a
-     * message. Useful for tools like `retrieval` and `code_interpreter` that can
-     * access and use files.
+     * A list of files attached to the message, and the tools they should be added to.
      */
-    file_ids?: Array<string>;
+    attachments?: Array<AdditionalMessage.Attachment> | null;
 
     /**
      * Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -1332,6 +1379,17 @@ export namespace RunStreamParams {
     metadata?: unknown | null;
   }
 
+  export namespace AdditionalMessage {
+    export interface Attachment {
+      add_to?: Array<'file_search' | 'code_interpreter'>;
+
+      /**
+       * The ID of the file to attach to the message.
+       */
+      file_id?: string;
+    }
+  }
+
   export interface TruncationStrategy {
     /**
      * The truncation strategy to use for the thread. The default is `auto`. If set to
@@ -1470,11 +1528,11 @@ export namespace Runs {
   export import CodeInterpreterOutputImage = StepsAPI.CodeInterpreterOutputImage;
   export import CodeInterpreterToolCall = StepsAPI.CodeInterpreterToolCall;
   export import CodeInterpreterToolCallDelta = StepsAPI.CodeInterpreterToolCallDelta;
+  export import FileSearchToolCall = StepsAPI.FileSearchToolCall;
+  export import FileSearchToolCallDelta = StepsAPI.FileSearchToolCallDelta;
   export import FunctionToolCall = StepsAPI.FunctionToolCall;
   export import FunctionToolCallDelta = StepsAPI.FunctionToolCallDelta;
   export import MessageCreationStepDetails = StepsAPI.MessageCreationStepDetails;
-  export import RetrievalToolCall = StepsAPI.RetrievalToolCall;
-  export import RetrievalToolCallDelta = StepsAPI.RetrievalToolCallDelta;
   export import RunStep = StepsAPI.RunStep;
   export import RunStepDelta = StepsAPI.RunStepDelta;
   export import RunStepDeltaEvent = StepsAPI.RunStepDeltaEvent;

package/src/resources/beta/threads/runs/steps.ts

@@ -18,7 +18,7 @@ export class Steps extends APIResource {
   ): Core.APIPromise<RunStep> {
     return this._client.get(`/threads/${threadId}/runs/${runId}/steps/${stepId}`, {
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 
@@ -48,7 +48,7 @@ export class Steps extends APIResource {
     return this._client.getAPIList(`/threads/${threadId}/runs/${runId}/steps`, RunStepsPage, {
       query,
       ...options,
-      headers: { 'OpenAI-Beta': 'assistants=v1', ...options?.headers },
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
 }
@@ -220,6 +220,47 @@ export namespace CodeInterpreterToolCallDelta {
   }
 }
 
+export interface FileSearchToolCall {
+  /**
+   * The ID of the tool call object.
+   */
+  id: string;
+
+  /**
+   * For now, this is always going to be an empty object.
+   */
+  file_search: unknown;
+
+  /**
+   * The type of tool call. This is always going to be `file_search` for this type of
+   * tool call.
+   */
+  type: 'file_search';
+}
+
+export interface FileSearchToolCallDelta {
+  /**
+   * For now, this is always going to be an empty object.
+   */
+  file_search: unknown;
+
+  /**
+   * The index of the tool call in the tool calls array.
+   */
+  index: number;
+
+  /**
+   * The type of tool call. This is always going to be `file_search` for this type of
+   * tool call.
+   */
+  type: 'file_search';
+
+  /**
+   * The ID of the tool call object.
+   */
+  id?: string;
+}
+
 export interface FunctionToolCall {
   /**
    * The ID of the tool call object.
@@ -330,47 +371,6 @@ export namespace MessageCreationStepDetails {
   }
 }
 
-export interface RetrievalToolCall {
-  /**
-   * The ID of the tool call object.
-   */
-  id: string;
-
-  /**
-   * For now, this is always going to be an empty object.
-   */
-  retrieval: unknown;
-
-  /**
-   * The type of tool call. This is always going to be `retrieval` for this type of
-   * tool call.
-   */
-  type: 'retrieval';
-}
-
-export interface RetrievalToolCallDelta {
-  /**
-   * The index of the tool call in the tool calls array.
-   */
-  index: number;
-
-  /**
-   * The type of tool call. This is always going to be `retrieval` for this type of
-   * tool call.
-   */
-  type: 'retrieval';
-
-  /**
-   * The ID of the tool call object.
-   */
-  id?: string;
-
-  /**
-   * For now, this is always going to be an empty object.
-   */
-  retrieval?: unknown;
-}
-
 /**
  * Represents a step in execution of a run.
  */
@@ -561,12 +561,12 @@ export namespace RunStepDeltaMessageDelta {
 /**
  * Details of the Code Interpreter tool call the run step was involved in.
  */
-export type ToolCall = CodeInterpreterToolCall | RetrievalToolCall | FunctionToolCall;
+export type ToolCall = CodeInterpreterToolCall | FileSearchToolCall | FunctionToolCall;
 
 /**
  * Details of the Code Interpreter tool call the run step was involved in.
  */
-export type ToolCallDelta = CodeInterpreterToolCallDelta | RetrievalToolCallDelta | FunctionToolCallDelta;
+export type ToolCallDelta = CodeInterpreterToolCallDelta | FileSearchToolCallDelta | FunctionToolCallDelta;
 
 /**
  * Details of the tool call.
@@ -579,7 +579,7 @@ export interface ToolCallDeltaObject {
 
   /**
    * An array of tool calls the run step was involved in. These can be associated
-   * with one of three types of tools: `code_interpreter`, `retrieval`, or
+   * with one of three types of tools: `code_interpreter`, `file_search`, or
    * `function`.
    */
   tool_calls?: Array<ToolCallDelta>;
@@ -591,7 +591,7 @@ export interface ToolCallDeltaObject {
 export interface ToolCallsStepDetails {
   /**
    * An array of tool calls the run step was involved in. These can be associated
-   * with one of three types of tools: `code_interpreter`, `retrieval`, or
+   * with one of three types of tools: `code_interpreter`, `file_search`, or
    * `function`.
    */
   tool_calls: Array<ToolCall>;
@@ -623,11 +623,11 @@ export namespace Steps {
   export import CodeInterpreterOutputImage = StepsAPI.CodeInterpreterOutputImage;
   export import CodeInterpreterToolCall = StepsAPI.CodeInterpreterToolCall;
   export import CodeInterpreterToolCallDelta = StepsAPI.CodeInterpreterToolCallDelta;
+  export import FileSearchToolCall = StepsAPI.FileSearchToolCall;
+  export import FileSearchToolCallDelta = StepsAPI.FileSearchToolCallDelta;
   export import FunctionToolCall = StepsAPI.FunctionToolCall;
   export import FunctionToolCallDelta = StepsAPI.FunctionToolCallDelta;
   export import MessageCreationStepDetails = StepsAPI.MessageCreationStepDetails;
-  export import RetrievalToolCall = StepsAPI.RetrievalToolCall;
-  export import RetrievalToolCallDelta = StepsAPI.RetrievalToolCallDelta;
   export import RunStep = StepsAPI.RunStep;
   export import RunStepDelta = StepsAPI.RunStepDelta;
   export import RunStepDeltaEvent = StepsAPI.RunStepDeltaEvent;