openai 4.86.2 → 4.87.1

package/src/resources/shared.ts

@@ -1,5 +1,96 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+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'
+  | 'computer-use-preview'
+  | 'computer-use-preview-2025-02-04'
+  | 'computer-use-preview-2025-03-11'
+  | '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';
+
+/**
+ * A filter used to compare a specified attribute key to a given value using a
+ * defined comparison operation.
+ */
+export interface ComparisonFilter {
+  /**
+   * The key to compare against the value.
+   */
+  key: string;
+
+  /**
+   * Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`.
+   *
+   * - `eq`: equals
+   * - `ne`: not equal
+   * - `gt`: greater than
+   * - `gte`: greater than or equal
+   * - `lt`: less than
+   * - `lte`: less than or equal
+   */
+  type: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte';
+
+  /**
+   * The value to compare against the attribute key; supports string, number, or
+   * boolean types.
+   */
+  value: string | number | boolean;
+}
+
+/**
+ * Combine multiple filters using `and` or `or`.
+ */
+export interface CompoundFilter {
+  /**
+   * Array of filters to combine. Items can be `ComparisonFilter` or
+   * `CompoundFilter`.
+   */
+  filters: Array<ComparisonFilter | unknown>;
+
+  /**
+   * Type of operation: `and` or `or`.
+   */
+  type: 'and' | 'or';
+}
+
 export interface ErrorObject {
   code: string | null;
 
@@ -65,23 +156,76 @@ export type FunctionParameters = Record<string, unknown>;
  */
 export type Metadata = Record<string, string>;
 
+/**
+ * **o-series models only**
+ *
+ * Configuration options for
+ * [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+ */
+export interface Reasoning {
+  /**
+   * **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.
+   */
+  effort: ReasoningEffort | null;
+
+  /**
+   * **o-series models only**
+   *
+   * A summary of the reasoning performed by the model. This can be useful for
+   * debugging and understanding the model's reasoning process. One of `concise` or
+   * `detailed`.
+   */
+  generate_summary?: 'concise' | 'detailed' | null;
+}
+
+/**
+ * **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.
+ */
+export type ReasoningEffort = 'low' | 'medium' | 'high' | null;
+
+/**
+ * JSON object response format. An older method of generating JSON responses. Using
+ * `json_schema` is recommended for models that support it. Note that the model
+ * will not generate JSON without a system or user message instructing it to do so.
+ */
 export interface ResponseFormatJSONObject {
   /**
-   * The type of response format being defined: `json_object`
+   * The type of response format being defined. Always `json_object`.
    */
   type: 'json_object';
 }
 
+/**
+ * JSON Schema response format. Used to generate structured JSON responses. Learn
+ * more about
+ * [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
+ */
 export interface ResponseFormatJSONSchema {
+  /**
+   * Structured Outputs configuration options, including a JSON Schema.
+   */
   json_schema: ResponseFormatJSONSchema.JSONSchema;
 
   /**
-   * The type of response format being defined: `json_schema`
+   * The type of response format being defined. Always `json_schema`.
    */
   type: 'json_schema';
 }
 
 export namespace ResponseFormatJSONSchema {
+  /**
+   * Structured Outputs configuration options, including a JSON Schema.
+   */
   export interface JSONSchema {
     /**
      * The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores
@@ -96,7 +240,8 @@ export namespace ResponseFormatJSONSchema {
     description?: string;
 
     /**
-     * The schema for the response format, described as a JSON Schema object.
+     * The schema for the response format, described as a JSON Schema object. Learn how
+     * to build JSON schemas [here](https://json-schema.org/).
      */
     schema?: Record<string, unknown>;
 
@@ -111,9 +256,12 @@ export namespace ResponseFormatJSONSchema {
   }
 }
 
+/**
+ * Default response format. Used to generate text responses.
+ */
 export interface ResponseFormatText {
   /**
-   * The type of response format being defined: `text`
+   * The type of response format being defined. Always `text`.
    */
   type: 'text';
 }

package/src/resources/uploads/uploads.ts

@@ -22,10 +22,9 @@ export class Uploads extends APIResource {
    * contains all the parts you uploaded. This File is usable in the rest of our
    * platform as a regular File object.
    *
-   * For certain `purpose`s, the correct `mime_type` must be specified. Please refer
-   * to documentation for the supported MIME types for your use case:
-   *
-   * - [Assistants](https://platform.openai.com/docs/assistants/tools/file-search#supported-files)
+   * For certain `purpose` values, the correct `mime_type` must be specified. Please
+   * refer to documentation for the
+   * [supported MIME types for your use case](https://platform.openai.com/docs/assistants/tools/file-search#supported-files).
    *
    * For guidance on the proper filename extensions for each purpose, please follow
    * the documentation on

package/src/resources/{beta/vector-stores → vector-stores}/file-batches.ts

@@ -1,15 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import { isRequestOptions } from '../../../core';
-import { sleep } from '../../../core';
-import { Uploadable } from '../../../core';
-import { allSettledWithThrow } from '../../../lib/Util';
-import * as Core from '../../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import { sleep } from '../../core';
+import { Uploadable } from '../../core';
+import { allSettledWithThrow } from '../../lib/Util';
+import * as Core from '../../core';
 import * as FilesAPI from './files';
 import { VectorStoreFilesPage } from './files';
 import * as VectorStoresAPI from './vector-stores';
-import { type CursorPageParams } from '../../../pagination';
+import { type CursorPageParams } from '../../pagination';
 
 export class FileBatches extends APIResource {
   /**
@@ -265,6 +265,15 @@ export interface FileBatchCreateParams {
    */
   file_ids: Array<string>;
 
+  /**
+   * Set of 16 key-value pairs that can be attached to an object. This can be useful
+   * for storing additional information about the object in a structured format, and
+   * querying for objects via API or the dashboard. Keys are strings with a maximum
+   * length of 64 characters. Values are strings with a maximum length of 512
+   * characters, booleans, or numbers.
+   */
+  attributes?: Record<string, string | number | boolean> | null;
+
   /**
    * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
    * strategy. Only applicable if `file_ids` is non-empty.

package/src/resources/{beta/vector-stores → vector-stores}/files.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import { sleep, Uploadable, isRequestOptions } from '../../../core';
-import * as Core from '../../../core';
+import { APIResource } from '../../resource';
+import { sleep, Uploadable, isRequestOptions } from '../../core';
+import * as Core from '../../core';
 import * as VectorStoresAPI from './vector-stores';
-import { CursorPage, type CursorPageParams } from '../../../pagination';
+import { CursorPage, type CursorPageParams, Page } from '../../pagination';
 
 export class Files extends APIResource {
   /**
@@ -38,6 +38,22 @@ export class Files extends APIResource {
     });
   }
 
+  /**
+   * Update attributes on a vector store file.
+   */
+  update(
+    vectorStoreId: string,
+    fileId: string,
+    body: FileUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFile> {
+    return this._client.post(`/vector_stores/${vectorStoreId}/files/${fileId}`, {
+      body,
+      ...options,
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
+    });
+  }
+
   /**
    * Returns a list of vector store files.
    */
@@ -167,10 +183,30 @@ export class Files extends APIResource {
     const fileInfo = await this.upload(vectorStoreId, file, options);
     return await this.poll(vectorStoreId, fileInfo.id, options);
   }
+
+  /**
+   * Retrieve the parsed contents of a vector store file.
+   */
+  content(
+    vectorStoreId: string,
+    fileId: string,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<FileContentResponsesPage, FileContentResponse> {
+    return this._client.getAPIList(
+      `/vector_stores/${vectorStoreId}/files/${fileId}/content`,
+      FileContentResponsesPage,
+      { ...options, headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers } },
+    );
+  }
 }
 
 export class VectorStoreFilesPage extends CursorPage<VectorStoreFile> {}
 
+/**
+ * Note: no pagination actually occurs yet, this is for forwards-compatibility.
+ */
+export class FileContentResponsesPage extends Page<FileContentResponse> {}
+
 /**
  * A list of files attached to a vector store.
  */
@@ -217,6 +253,15 @@ export interface VectorStoreFile {
    */
   vector_store_id: string;
 
+  /**
+   * Set of 16 key-value pairs that can be attached to an object. This can be useful
+   * for storing additional information about the object in a structured format, and
+   * querying for objects via API or the dashboard. Keys are strings with a maximum
+   * length of 64 characters. Values are strings with a maximum length of 512
+   * characters, booleans, or numbers.
+   */
+  attributes?: Record<string, string | number | boolean> | null;
+
   /**
    * The strategy used to chunk the file.
    */
@@ -249,6 +294,18 @@ export interface VectorStoreFileDeleted {
   object: 'vector_store.file.deleted';
 }
 
+export interface FileContentResponse {
+  /**
+   * The text content
+   */
+  text?: string;
+
+  /**
+   * The content type (currently only `"text"`)
+   */
+  type?: string;
+}
+
 export interface FileCreateParams {
   /**
    * A [File](https://platform.openai.com/docs/api-reference/files) ID that the
@@ -257,6 +314,15 @@ export interface FileCreateParams {
    */
   file_id: string;
 
+  /**
+   * Set of 16 key-value pairs that can be attached to an object. This can be useful
+   * for storing additional information about the object in a structured format, and
+   * querying for objects via API or the dashboard. Keys are strings with a maximum
+   * length of 64 characters. Values are strings with a maximum length of 512
+   * characters, booleans, or numbers.
+   */
+  attributes?: Record<string, string | number | boolean> | null;
+
   /**
    * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
    * strategy. Only applicable if `file_ids` is non-empty.
@@ -264,6 +330,17 @@ export interface FileCreateParams {
   chunking_strategy?: VectorStoresAPI.FileChunkingStrategyParam;
 }
 
+export interface FileUpdateParams {
+  /**
+   * Set of 16 key-value pairs that can be attached to an object. This can be useful
+   * for storing additional information about the object in a structured format, and
+   * querying for objects via API or the dashboard. Keys are strings with a maximum
+   * length of 64 characters. Values are strings with a maximum length of 512
+   * characters, booleans, or numbers.
+   */
+  attributes: Record<string, string | number | boolean> | null;
+}
+
 export interface FileListParams extends CursorPageParams {
   /**
    * A cursor for use in pagination. `before` is an object ID that defines your place
@@ -286,13 +363,17 @@ export interface FileListParams extends CursorPageParams {
 }
 
 Files.VectorStoreFilesPage = VectorStoreFilesPage;
+Files.FileContentResponsesPage = FileContentResponsesPage;
 
 export declare namespace Files {
   export {
     type VectorStoreFile as VectorStoreFile,
     type VectorStoreFileDeleted as VectorStoreFileDeleted,
+    type FileContentResponse as FileContentResponse,
     VectorStoreFilesPage as VectorStoreFilesPage,
+    FileContentResponsesPage as FileContentResponsesPage,
     type FileCreateParams as FileCreateParams,
+    type FileUpdateParams as FileUpdateParams,
     type FileListParams as FileListParams,
   };
 }

package/src/resources/{beta/vector-stores → vector-stores}/index.ts

@@ -8,14 +8,18 @@ export {
 } from './file-batches';
 export {
   VectorStoreFilesPage,
+  FileContentResponsesPage,
   Files,
   type VectorStoreFile,
   type VectorStoreFileDeleted,
+  type FileContentResponse,
   type FileCreateParams,
+  type FileUpdateParams,
   type FileListParams,
 } from './files';
 export {
   VectorStoresPage,
+  VectorStoreSearchResponsesPage,
   VectorStores,
   type AutoFileChunkingStrategyParam,
   type FileChunkingStrategy,
@@ -26,7 +30,9 @@ export {
   type StaticFileChunkingStrategyObjectParam,
   type VectorStore,
   type VectorStoreDeleted,
+  type VectorStoreSearchResponse,
   type VectorStoreCreateParams,
   type VectorStoreUpdateParams,
   type VectorStoreListParams,
+  type VectorStoreSearchParams,
 } from './vector-stores';

package/src/resources/{beta/vector-stores → vector-stores}/vector-stores.ts

@@ -1,9 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import { isRequestOptions } from '../../../core';
-import * as Core from '../../../core';
-import * as Shared from '../../shared';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as Shared from '../shared';
 import * as FileBatchesAPI from './file-batches';
 import {
   FileBatchCreateParams,
@@ -13,14 +13,17 @@ import {
 } from './file-batches';
 import * as FilesAPI from './files';
 import {
+  FileContentResponse,
+  FileContentResponsesPage,
   FileCreateParams,
   FileListParams,
+  FileUpdateParams,
   Files,
   VectorStoreFile,
   VectorStoreFileDeleted,
   VectorStoreFilesPage,
 } from './files';
-import { CursorPage, type CursorPageParams } from '../../../pagination';
+import { CursorPage, type CursorPageParams, Page } from '../../pagination';
 
 export class VectorStores extends APIResource {
   files: FilesAPI.Files = new FilesAPI.Files(this._client);
@@ -93,10 +96,32 @@ export class VectorStores extends APIResource {
       headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
     });
   }
+
+  /**
+   * Search a vector store for relevant chunks based on a query and file attributes
+   * filter.
+   */
+  search(
+    vectorStoreId: string,
+    body: VectorStoreSearchParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<VectorStoreSearchResponsesPage, VectorStoreSearchResponse> {
+    return this._client.getAPIList(`/vector_stores/${vectorStoreId}/search`, VectorStoreSearchResponsesPage, {
+      body,
+      method: 'post',
+      ...options,
+      headers: { 'OpenAI-Beta': 'assistants=v2', ...options?.headers },
+    });
+  }
 }
 
 export class VectorStoresPage extends CursorPage<VectorStore> {}
 
+/**
+ * Note: no pagination actually occurs yet, this is for forwards-compatibility.
+ */
+export class VectorStoreSearchResponsesPage extends Page<VectorStoreSearchResponse> {}
+
 /**
  * The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
  * `800` and `chunk_overlap_tokens` of `400`.
@@ -155,6 +180,9 @@ export interface StaticFileChunkingStrategyObject {
   type: 'static';
 }
 
+/**
+ * Customize your own chunking strategy by setting chunk size and chunk overlap.
+ */
 export interface StaticFileChunkingStrategyObjectParam {
   static: StaticFileChunkingStrategy;
 
@@ -282,6 +310,51 @@ export interface VectorStoreDeleted {
   object: 'vector_store.deleted';
 }
 
+export interface VectorStoreSearchResponse {
+  /**
+   * Set of 16 key-value pairs that can be attached to an object. This can be useful
+   * for storing additional information about the object in a structured format, and
+   * querying for objects via API or the dashboard. Keys are strings with a maximum
+   * length of 64 characters. Values are strings with a maximum length of 512
+   * characters, booleans, or numbers.
+   */
+  attributes: Record<string, string | number | boolean> | null;
+
+  /**
+   * Content chunks from the file.
+   */
+  content: Array<VectorStoreSearchResponse.Content>;
+
+  /**
+   * The ID of the vector store file.
+   */
+  file_id: string;
+
+  /**
+   * The name of the vector store file.
+   */
+  filename: string;
+
+  /**
+   * The similarity score for the result.
+   */
+  score: number;
+}
+
+export namespace VectorStoreSearchResponse {
+  export interface Content {
+    /**
+     * The text content returned from search.
+     */
+    text: string;
+
+    /**
+     * The type of content.
+     */
+    type: 'text';
+  }
+}
+
 export interface VectorStoreCreateParams {
   /**
    * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
@@ -391,9 +464,50 @@ export interface VectorStoreListParams extends CursorPageParams {
   order?: 'asc' | 'desc';
 }
 
+export interface VectorStoreSearchParams {
+  /**
+   * A query string for a search
+   */
+  query: string | Array<string>;
+
+  /**
+   * A filter to apply based on file attributes.
+   */
+  filters?: Shared.ComparisonFilter | Shared.CompoundFilter;
+
+  /**
+   * The maximum number of results to return. This number should be between 1 and 50
+   * inclusive.
+   */
+  max_num_results?: number;
+
+  /**
+   * Ranking options for search.
+   */
+  ranking_options?: VectorStoreSearchParams.RankingOptions;
+
+  /**
+   * Whether to rewrite the natural language query for vector search.
+   */
+  rewrite_query?: boolean;
+}
+
+export namespace VectorStoreSearchParams {
+  /**
+   * Ranking options for search.
+   */
+  export interface RankingOptions {
+    ranker?: 'auto' | 'default-2024-11-15';
+
+    score_threshold?: number;
+  }
+}
+
 VectorStores.VectorStoresPage = VectorStoresPage;
+VectorStores.VectorStoreSearchResponsesPage = VectorStoreSearchResponsesPage;
 VectorStores.Files = Files;
 VectorStores.VectorStoreFilesPage = VectorStoreFilesPage;
+VectorStores.FileContentResponsesPage = FileContentResponsesPage;
 VectorStores.FileBatches = FileBatches;
 
 export declare namespace VectorStores {
@@ -407,18 +521,24 @@ export declare namespace VectorStores {
     type StaticFileChunkingStrategyObjectParam as StaticFileChunkingStrategyObjectParam,
     type VectorStore as VectorStore,
     type VectorStoreDeleted as VectorStoreDeleted,
+    type VectorStoreSearchResponse as VectorStoreSearchResponse,
     VectorStoresPage as VectorStoresPage,
+    VectorStoreSearchResponsesPage as VectorStoreSearchResponsesPage,
     type VectorStoreCreateParams as VectorStoreCreateParams,
     type VectorStoreUpdateParams as VectorStoreUpdateParams,
     type VectorStoreListParams as VectorStoreListParams,
+    type VectorStoreSearchParams as VectorStoreSearchParams,
   };
 
   export {
     Files as Files,
     type VectorStoreFile as VectorStoreFile,
     type VectorStoreFileDeleted as VectorStoreFileDeleted,
+    type FileContentResponse as FileContentResponse,
     VectorStoreFilesPage as VectorStoreFilesPage,
+    FileContentResponsesPage as FileContentResponsesPage,
     type FileCreateParams as FileCreateParams,
+    type FileUpdateParams as FileUpdateParams,
     type FileListParams as FileListParams,
   };
 

package/src/streaming.ts

@@ -41,7 +41,7 @@ export class Stream<Item> implements AsyncIterable<Item> {
             continue;
           }
 
-          if (sse.event === null) {
+          if (sse.event === null || sse.event.startsWith('response.')) {
             let data;
 
             try {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.86.2'; // x-release-please-version
+export const VERSION = '4.87.1'; // x-release-please-version

package/streaming.js

@@ -27,7 +27,7 @@ class Stream {
                         done = true;
                         continue;
                     }
-                    if (sse.event === null) {
+                    if (sse.event === null || sse.event.startsWith('response.')) {
                         let data;
                         try {
                             data = JSON.parse(sse.data);