openai 4.86.2 → 4.87.0

package/src/resources/chat/chat.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as Shared from '../shared';
 import * as CompletionsAPI from './completions/completions';
 import {
   ChatCompletion,
@@ -52,48 +53,7 @@ export class Chat extends APIResource {
   completions: CompletionsAPI.Completions = new CompletionsAPI.Completions(this._client);
 }
 
-export type ChatModel =
-  | 'o3-mini'
-  | 'o3-mini-2025-01-31'
-  | 'o1'
-  | 'o1-2024-12-17'
-  | 'o1-preview'
-  | 'o1-preview-2024-09-12'
-  | 'o1-mini'
-  | 'o1-mini-2024-09-12'
-  | 'gpt-4.5-preview'
-  | 'gpt-4.5-preview-2025-02-27'
-  | 'gpt-4o'
-  | 'gpt-4o-2024-11-20'
-  | 'gpt-4o-2024-08-06'
-  | 'gpt-4o-2024-05-13'
-  | 'gpt-4o-audio-preview'
-  | 'gpt-4o-audio-preview-2024-10-01'
-  | 'gpt-4o-audio-preview-2024-12-17'
-  | 'gpt-4o-mini-audio-preview'
-  | 'gpt-4o-mini-audio-preview-2024-12-17'
-  | 'chatgpt-4o-latest'
-  | 'gpt-4o-mini'
-  | 'gpt-4o-mini-2024-07-18'
-  | 'gpt-4-turbo'
-  | 'gpt-4-turbo-2024-04-09'
-  | 'gpt-4-0125-preview'
-  | 'gpt-4-turbo-preview'
-  | 'gpt-4-1106-preview'
-  | 'gpt-4-vision-preview'
-  | 'gpt-4'
-  | 'gpt-4-0314'
-  | 'gpt-4-0613'
-  | 'gpt-4-32k'
-  | 'gpt-4-32k-0314'
-  | 'gpt-4-32k-0613'
-  | 'gpt-3.5-turbo'
-  | 'gpt-3.5-turbo-16k'
-  | 'gpt-3.5-turbo-0301'
-  | 'gpt-3.5-turbo-0613'
-  | 'gpt-3.5-turbo-1106'
-  | 'gpt-3.5-turbo-0125'
-  | 'gpt-3.5-turbo-16k-0613';
+export type ChatModel = Shared.ChatModel;
 
 Chat.Completions = Completions;
 Chat.ChatCompletionsPage = ChatCompletionsPage;
@@ -123,7 +83,6 @@ export declare namespace Chat {
     type ChatCompletionModality as ChatCompletionModality,
     type ChatCompletionNamedToolChoice as ChatCompletionNamedToolChoice,
     type ChatCompletionPredictionContent as ChatCompletionPredictionContent,
-    type ChatCompletionReasoningEffort as ChatCompletionReasoningEffort,
     type ChatCompletionRole as ChatCompletionRole,
     type ChatCompletionStoreMessage as ChatCompletionStoreMessage,
     type ChatCompletionStreamOptions as ChatCompletionStreamOptions,
@@ -134,6 +93,7 @@ export declare namespace Chat {
     type ChatCompletionToolMessageParam as ChatCompletionToolMessageParam,
     type ChatCompletionUserMessageParam as ChatCompletionUserMessageParam,
     type CreateChatCompletionRequestMessage as CreateChatCompletionRequestMessage,
+    type ChatCompletionReasoningEffort as ChatCompletionReasoningEffort,
     ChatCompletionsPage as ChatCompletionsPage,
     type ChatCompletionCreateParams as ChatCompletionCreateParams,
     type CompletionCreateParams as CompletionCreateParams,

package/src/resources/chat/completions/completions.ts

@@ -7,7 +7,6 @@ import * as Core from '../../../core';
 import * as CompletionsCompletionsAPI from './completions';
 import * as CompletionsAPI from '../../completions';
 import * as Shared from '../../shared';
-import * as ChatAPI from '../chat';
 import * as MessagesAPI from './messages';
 import { MessageListParams, Messages } from './messages';
 import { CursorPage, type CursorPageParams } from '../../../pagination';
@@ -17,6 +16,13 @@ export class Completions extends APIResource {
   messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
 
   /**
+   * **Starting a new project?** We recommend trying
+   * [Responses](https://platform.openai.com/docs/api-reference/responses) to take
+   * advantage of the latest OpenAI platform features. Compare
+   * [Chat Completions with Responses](https://platform.openai.com/docs/guides/responses-vs-chat-completions?api-mode=responses).
+   *
+   * ---
+   *
    * Creates a model response for the given chat conversation. Learn more in the
    * [text generation](https://platform.openai.com/docs/guides/text-generation),
    * [vision](https://platform.openai.com/docs/guides/vision), and
@@ -50,7 +56,7 @@ export class Completions extends APIResource {
   }
 
   /**
-   * Get a stored chat completion. Only chat completions that have been created with
+   * Get a stored chat completion. Only Chat Completions that have been created with
    * the `store` parameter set to `true` will be returned.
    */
   retrieve(completionId: string, options?: Core.RequestOptions): Core.APIPromise<ChatCompletion> {
@@ -58,7 +64,7 @@ export class Completions extends APIResource {
   }
 
   /**
-   * Modify a stored chat completion. Only chat completions that have been created
+   * Modify a stored chat completion. Only Chat Completions that have been created
    * with the `store` parameter set to `true` can be modified. Currently, the only
    * supported modification is to update the `metadata` field.
    */
@@ -71,7 +77,7 @@ export class Completions extends APIResource {
   }
 
   /**
-   * List stored chat completions. Only chat completions that have been stored with
+   * List stored Chat Completions. Only Chat Completions that have been stored with
    * the `store` parameter set to `true` will be returned.
    */
   list(
@@ -90,7 +96,7 @@ export class Completions extends APIResource {
   }
 
   /**
-   * Delete a stored chat completion. Only chat completions that have been created
+   * Delete a stored chat completion. Only Chat Completions that have been created
    * with the `store` parameter set to `true` can be deleted.
    */
   del(completionId: string, options?: Core.RequestOptions): Core.APIPromise<ChatCompletionDeleted> {
@@ -316,16 +322,16 @@ export interface ChatCompletionAudioParam {
   format: 'wav' | 'mp3' | 'flac' | 'opus' | 'pcm16';
 
   /**
-   * The voice the model uses to respond. Supported voices are `ash`, `ballad`,
-   * `coral`, `sage`, and `verse` (also supported but not recommended are `alloy`,
-   * `echo`, and `shimmer`; these voices are less expressive).
+   * The voice the model uses to respond. Supported voices are `alloy`, `ash`,
+   * `ballad`, `coral`, `echo`, `sage`, and `shimmer`.
    */
   voice: 'alloy' | 'ash' | 'ballad' | 'coral' | 'echo' | 'sage' | 'shimmer' | 'verse';
 }
 
 /**
- * Represents a streamed chunk of a chat completion response returned by model,
+ * Represents a streamed chunk of a chat completion response returned by the model,
  * based on the provided input.
+ * [Learn more](https://platform.openai.com/docs/guides/streaming-responses).
  */
 export interface ChatCompletionChunk {
   /**
@@ -512,7 +518,43 @@ export namespace ChatCompletionChunk {
 export type ChatCompletionContentPart =
   | ChatCompletionContentPartText
   | ChatCompletionContentPartImage
-  | ChatCompletionContentPartInputAudio;
+  | ChatCompletionContentPartInputAudio
+  | ChatCompletionContentPart.File;
+
+export namespace ChatCompletionContentPart {
+  /**
+   * Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text
+   * generation.
+   */
+  export interface File {
+    file: File.File;
+
+    /**
+     * The type of the content part. Always `file`.
+     */
+    type: 'file';
+  }
+
+  export namespace File {
+    export interface File {
+      /**
+       * The base64 encoded file data, used when passing the file to the model as a
+       * string.
+       */
+      file_data?: string;
+
+      /**
+       * The ID of an uploaded file to use as input.
+       */
+      file_id?: string;
+
+      /**
+       * The name of the file, used when passing the file to the model as a string.
+       */
+      file_name?: string;
+    }
+  }
+}
 
 /**
  * Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
@@ -685,6 +727,12 @@ export interface ChatCompletionMessage {
    */
   role: 'assistant';
 
+  /**
+   * Annotations for the message, when applicable, as when using the
+   * [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
+   */
+  annotations?: Array<ChatCompletionMessage.Annotation>;
+
   /**
    * If the audio output modality is requested, this object contains data about the
    * audio response from the model.
@@ -705,6 +753,48 @@ export interface ChatCompletionMessage {
 }
 
 export namespace ChatCompletionMessage {
+  /**
+   * A URL citation when using web search.
+   */
+  export interface Annotation {
+    /**
+     * The type of the URL citation. Always `url_citation`.
+     */
+    type: 'url_citation';
+
+    /**
+     * A URL citation when using web search.
+     */
+    url_citation: Annotation.URLCitation;
+  }
+
+  export namespace Annotation {
+    /**
+     * A URL citation when using web search.
+     */
+    export interface URLCitation {
+      /**
+       * The index of the last character of the URL citation in the message.
+       */
+      end_index: number;
+
+      /**
+       * The index of the first character of the URL citation in the message.
+       */
+      start_index: number;
+
+      /**
+       * The title of the web resource.
+       */
+      title: string;
+
+      /**
+       * The URL of the web resource.
+       */
+      url: string;
+    }
+  }
+
   /**
    * @deprecated Deprecated and replaced by `tool_calls`. The name and arguments of a
    * function that should be called, as generated by the model.
@@ -818,16 +908,6 @@ export interface ChatCompletionPredictionContent {
   type: 'content';
 }
 
-/**
- * **o1 and o3-mini models only**
- *
- * Constrains effort on reasoning for
- * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
- * supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
- * result in faster responses and fewer tokens used on reasoning in a response.
- */
-export type ChatCompletionReasoningEffort = 'low' | 'medium' | 'high' | null;
-
 /**
  * The role of the author of a message
  */
@@ -998,6 +1078,8 @@ export interface ChatCompletionUserMessageParam {
  */
 export type CreateChatCompletionRequestMessage = ChatCompletionMessageParam;
 
+export type ChatCompletionReasoningEffort = Shared.ReasoningEffort | null;
+
 export type ChatCompletionCreateParams =
   | ChatCompletionCreateParamsNonStreaming
   | ChatCompletionCreateParamsStreaming;
@@ -1014,11 +1096,13 @@ export interface ChatCompletionCreateParamsBase {
   messages: Array<ChatCompletionMessageParam>;
 
   /**
-   * ID of the model to use. See the
-   * [model endpoint compatibility](https://platform.openai.com/docs/models#model-endpoint-compatibility)
-   * table for details on which models work with the Chat API.
+   * Model ID used to generate the response, like `gpt-4o` or `o1`. OpenAI offers a
+   * wide range of models with different capabilities, performance characteristics,
+   * and price points. Refer to the
+   * [model guide](https://platform.openai.com/docs/models) to browse and compare
+   * available models.
    */
-  model: (string & {}) | ChatAPI.ChatModel;
+  model: (string & {}) | Shared.ChatModel;
 
   /**
    * Parameters for audio output. Required when audio output is requested with
@@ -1107,8 +1191,8 @@ export interface ChatCompletionCreateParamsBase {
   metadata?: Shared.Metadata | null;
 
   /**
-   * Output types that you would like the model to generate for this request. Most
-   * models are capable of generating text, which is the default:
+   * Output types that you would like the model to generate. Most models are capable
+   * of generating text, which is the default:
    *
    * `["text"]`
    *
@@ -1118,7 +1202,7 @@ export interface ChatCompletionCreateParamsBase {
    *
    * `["text", "audio"]`
    */
-  modalities?: Array<ChatCompletionModality> | null;
+  modalities?: Array<'text' | 'audio'> | null;
 
   /**
    * How many chat completion choices to generate for each input message. Note that
@@ -1148,14 +1232,14 @@ export interface ChatCompletionCreateParamsBase {
   presence_penalty?: number | null;
 
   /**
-   * **o1 and o3-mini models only**
+   * **o-series models only**
    *
    * Constrains effort on reasoning for
    * [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
    * supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
    * result in faster responses and fewer tokens used on reasoning in a response.
    */
-  reasoning_effort?: ChatCompletionReasoningEffort | null;
+  reasoning_effort?: Shared.ReasoningEffort | null;
 
   /**
    * An object specifying the format that the model must output.
@@ -1165,21 +1249,14 @@ export interface ChatCompletionCreateParamsBase {
    * in the
    * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
    *
-   * Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the
-   * message the model generates is valid JSON.
-   *
-   * **Important:** when using JSON mode, you **must** also instruct the model to
-   * produce JSON yourself via a system or user message. Without this, the model may
-   * generate an unending stream of whitespace until the generation reaches the token
-   * limit, resulting in a long-running and seemingly "stuck" request. Also note that
-   * the message content may be partially cut off if `finish_reason="length"`, which
-   * indicates the generation exceeded `max_tokens` or the conversation exceeded the
-   * max context length.
+   * Setting to `{ "type": "json_object" }` enables the older JSON mode, which
+   * ensures the message the model generates is valid JSON. Using `json_schema` is
+   * preferred for models that support it.
    */
   response_format?:
     | Shared.ResponseFormatText
-    | Shared.ResponseFormatJSONObject
-    | Shared.ResponseFormatJSONSchema;
+    | Shared.ResponseFormatJSONSchema
+    | Shared.ResponseFormatJSONObject;
 
   /**
    * This feature is in Beta. If specified, our system will make a best effort to
@@ -1198,15 +1275,19 @@ export interface ChatCompletionCreateParamsBase {
    *   utilize scale tier credits until they are exhausted.
    * - If set to 'auto', and the Project is not Scale tier enabled, the request will
    *   be processed using the default service tier with a lower uptime SLA and no
-   *   latency guarantee.
+   *   latency guarentee.
    * - If set to 'default', the request will be processed using the default service
-   *   tier with a lower uptime SLA and no latency guarantee.
+   *   tier with a lower uptime SLA and no latency guarentee.
    * - When not set, the default behavior is 'auto'.
+   *
+   * When this parameter is set, the response body will include the `service_tier`
+   * utilized.
    */
   service_tier?: 'auto' | 'default' | null;
 
   /**
-   * Up to 4 sequences where the API will stop generating further tokens.
+   * Up to 4 sequences where the API will stop generating further tokens. The
+   * returned text will not contain the stop sequence.
    */
   stop?: string | null | Array<string>;
 
@@ -1218,12 +1299,14 @@ export interface ChatCompletionCreateParamsBase {
   store?: boolean | null;
 
   /**
-   * If set, partial message deltas will be sent, like in ChatGPT. Tokens will be
-   * sent as data-only
-   * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
-   * as they become available, with the stream terminated by a `data: [DONE]`
-   * message.
-   * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
+   * If set to true, the model response data will be streamed to the client as it is
+   * generated using
+   * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
+   * See the
+   * [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming)
+   * for more information, along with the
+   * [streaming responses](https://platform.openai.com/docs/guides/streaming-responses)
+   * guide for more information on how to handle the streaming events.
    */
   stream?: boolean | null;
 
@@ -1282,6 +1365,13 @@ export interface ChatCompletionCreateParamsBase {
    * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
    */
   user?: string;
+
+  /**
+   * This tool searches the web for relevant results to use in a response. Learn more
+   * about the
+   * [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
+   */
+  web_search_options?: ChatCompletionCreateParams.WebSearchOptions;
 }
 
 export namespace ChatCompletionCreateParams {
@@ -1313,6 +1403,70 @@ export namespace ChatCompletionCreateParams {
     parameters?: Shared.FunctionParameters;
   }
 
+  /**
+   * This tool searches the web for relevant results to use in a response. Learn more
+   * about the
+   * [web search tool](https://platform.openai.com/docs/guides/tools-web-search?api-mode=chat).
+   */
+  export interface WebSearchOptions {
+    /**
+     * High level guidance for the amount of context window space to use for the
+     * search. One of `low`, `medium`, or `high`. `medium` is the default.
+     */
+    search_context_size?: 'low' | 'medium' | 'high';
+
+    /**
+     * Approximate location parameters for the search.
+     */
+    user_location?: WebSearchOptions.UserLocation | null;
+  }
+
+  export namespace WebSearchOptions {
+    /**
+     * Approximate location parameters for the search.
+     */
+    export interface UserLocation {
+      /**
+       * Approximate location parameters for the search.
+       */
+      approximate: UserLocation.Approximate;
+
+      /**
+       * The type of location approximation. Always `approximate`.
+       */
+      type: 'approximate';
+    }
+
+    export namespace UserLocation {
+      /**
+       * Approximate location parameters for the search.
+       */
+      export interface Approximate {
+        /**
+         * Free text input for the city of the user, e.g. `San Francisco`.
+         */
+        city?: string;
+
+        /**
+         * The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+         * the user, e.g. `US`.
+         */
+        country?: string;
+
+        /**
+         * Free text input for the region of the user, e.g. `California`.
+         */
+        region?: string;
+
+        /**
+         * The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+         * user, e.g. `America/Los_Angeles`.
+         */
+        timezone?: string;
+      }
+    }
+  }
+
   export type ChatCompletionCreateParamsNonStreaming =
     CompletionsCompletionsAPI.ChatCompletionCreateParamsNonStreaming;
   export type ChatCompletionCreateParamsStreaming =
@@ -1326,12 +1480,14 @@ export type CompletionCreateParams = ChatCompletionCreateParams;
 
 export interface ChatCompletionCreateParamsNonStreaming extends ChatCompletionCreateParamsBase {
   /**
-   * If set, partial message deltas will be sent, like in ChatGPT. Tokens will be
-   * sent as data-only
-   * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
-   * as they become available, with the stream terminated by a `data: [DONE]`
-   * message.
-   * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
+   * If set to true, the model response data will be streamed to the client as it is
+   * generated using
+   * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
+   * See the
+   * [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming)
+   * for more information, along with the
+   * [streaming responses](https://platform.openai.com/docs/guides/streaming-responses)
+   * guide for more information on how to handle the streaming events.
    */
   stream?: false | null;
 }
@@ -1343,12 +1499,14 @@ export type CompletionCreateParamsNonStreaming = ChatCompletionCreateParamsNonSt
 
 export interface ChatCompletionCreateParamsStreaming extends ChatCompletionCreateParamsBase {
   /**
-   * If set, partial message deltas will be sent, like in ChatGPT. Tokens will be
-   * sent as data-only
-   * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format)
-   * as they become available, with the stream terminated by a `data: [DONE]`
-   * message.
-   * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
+   * If set to true, the model response data will be streamed to the client as it is
+   * generated using
+   * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
+   * See the
+   * [Streaming section below](https://platform.openai.com/docs/api-reference/chat/streaming)
+   * for more information, along with the
+   * [streaming responses](https://platform.openai.com/docs/guides/streaming-responses)
+   * guide for more information on how to handle the streaming events.
    */
   stream: true;
 }
@@ -1377,19 +1535,19 @@ export type CompletionUpdateParams = ChatCompletionUpdateParams;
 
 export interface ChatCompletionListParams extends CursorPageParams {
   /**
-   * A list of metadata keys to filter the chat completions by. Example:
+   * A list of metadata keys to filter the Chat Completions by. Example:
    *
    * `metadata[key1]=value1&metadata[key2]=value2`
    */
   metadata?: Shared.Metadata | null;
 
   /**
-   * The model used to generate the chat completions.
+   * The model used to generate the Chat Completions.
    */
   model?: string;
 
   /**
-   * Sort order for chat completions by timestamp. Use `asc` for ascending order or
+   * Sort order for Chat Completions by timestamp. Use `asc` for ascending order or
    * `desc` for descending order. Defaults to `asc`.
    */
   order?: 'asc' | 'desc';
@@ -1425,7 +1583,6 @@ export declare namespace Completions {
     type ChatCompletionModality as ChatCompletionModality,
     type ChatCompletionNamedToolChoice as ChatCompletionNamedToolChoice,
     type ChatCompletionPredictionContent as ChatCompletionPredictionContent,
-    type ChatCompletionReasoningEffort as ChatCompletionReasoningEffort,
     type ChatCompletionRole as ChatCompletionRole,
     type ChatCompletionStoreMessage as ChatCompletionStoreMessage,
     type ChatCompletionStreamOptions as ChatCompletionStreamOptions,
@@ -1436,6 +1593,7 @@ export declare namespace Completions {
     type ChatCompletionToolMessageParam as ChatCompletionToolMessageParam,
     type ChatCompletionUserMessageParam as ChatCompletionUserMessageParam,
     type CreateChatCompletionRequestMessage as CreateChatCompletionRequestMessage,
+    type ChatCompletionReasoningEffort as ChatCompletionReasoningEffort,
     ChatCompletionsPage as ChatCompletionsPage,
     type ChatCompletionCreateParams as ChatCompletionCreateParams,
     type CompletionCreateParams as CompletionCreateParams,

package/src/resources/chat/completions/index.ts

@@ -24,7 +24,6 @@ export {
   type ChatCompletionModality,
   type ChatCompletionNamedToolChoice,
   type ChatCompletionPredictionContent,
-  type ChatCompletionReasoningEffort,
   type ChatCompletionRole,
   type ChatCompletionStoreMessage,
   type ChatCompletionStreamOptions,

package/src/resources/chat/completions/messages.ts

@@ -9,7 +9,7 @@ import { type CursorPageParams } from '../../../pagination';
 
 export class Messages extends APIResource {
   /**
-   * Get the messages in a stored chat completion. Only chat completions that have
+   * Get the messages in a stored chat completion. Only Chat Completions that have
    * been created with the `store` parameter set to `true` will be returned.
    */
   list(

package/src/resources/chat/index.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Chat, type ChatModel } from './chat';
+export { Chat } from './chat';
 export {
   ChatCompletionStoreMessagesPage,
   ChatCompletionsPage,
@@ -25,7 +25,6 @@ export {
   type ChatCompletionModality,
   type ChatCompletionNamedToolChoice,
   type ChatCompletionPredictionContent,
-  type ChatCompletionReasoningEffort,
   type ChatCompletionRole,
   type ChatCompletionStoreMessage,
   type ChatCompletionStreamOptions,

package/src/resources/files.ts

@@ -186,16 +186,12 @@ export interface FileObject {
 }
 
 /**
- * The intended purpose of the uploaded file.
- *
- * Use "assistants" for
- * [Assistants](https://platform.openai.com/docs/api-reference/assistants) and
- * [Message](https://platform.openai.com/docs/api-reference/messages) files,
- * "vision" for Assistants image file inputs, "batch" for
- * [Batch API](https://platform.openai.com/docs/guides/batch), and "fine-tune" for
- * [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning).
+ * The intended purpose of the uploaded file. One of: - `assistants`: Used in the
+ * Assistants API - `batch`: Used in the Batch API - `fine-tune`: Used for
+ * fine-tuning - `vision`: Images used for vision fine-tuning - `user_data`:
+ * Flexible file type for any purpose - `evals`: Used for eval data sets
  */
-export type FilePurpose = 'assistants' | 'batch' | 'fine-tune' | 'vision';
+export type FilePurpose = 'assistants' | 'batch' | 'fine-tune' | 'vision' | 'user_data' | 'evals';
 
 export interface FileCreateParams {
   /**
@@ -204,14 +200,10 @@ export interface FileCreateParams {
   file: Core.Uploadable;
 
   /**
-   * The intended purpose of the uploaded file.
-   *
-   * Use "assistants" for
-   * [Assistants](https://platform.openai.com/docs/api-reference/assistants) and
-   * [Message](https://platform.openai.com/docs/api-reference/messages) files,
-   * "vision" for Assistants image file inputs, "batch" for
-   * [Batch API](https://platform.openai.com/docs/guides/batch), and "fine-tune" for
-   * [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning).
+   * The intended purpose of the uploaded file. One of: - `assistants`: Used in the
+   * Assistants API - `batch`: Used in the Batch API - `fine-tune`: Used for
+   * fine-tuning - `vision`: Images used for vision fine-tuning - `user_data`:
+   * Flexible file type for any purpose - `evals`: Used for eval data sets
    */
   purpose: FilePurpose;
 }

package/src/resources/index.ts

@@ -60,4 +60,24 @@ export {
   type ModerationCreateResponse,
   type ModerationCreateParams,
 } from './moderations';
+export { Responses } from './responses/responses';
 export { Uploads, type Upload, type UploadCreateParams, type UploadCompleteParams } from './uploads/uploads';
+export {
+  VectorStoresPage,
+  VectorStoreSearchResponsesPage,
+  VectorStores,
+  type AutoFileChunkingStrategyParam,
+  type FileChunkingStrategy,
+  type FileChunkingStrategyParam,
+  type OtherFileChunkingStrategyObject,
+  type StaticFileChunkingStrategy,
+  type StaticFileChunkingStrategyObject,
+  type StaticFileChunkingStrategyObjectParam,
+  type VectorStore,
+  type VectorStoreDeleted,
+  type VectorStoreSearchResponse,
+  type VectorStoreCreateParams,
+  type VectorStoreUpdateParams,
+  type VectorStoreListParams,
+  type VectorStoreSearchParams,
+} from './vector-stores/vector-stores';