openai 4.47.3 → 4.48.2

package/src/resources/beta/vector-stores/files.ts

@@ -217,6 +217,11 @@ export interface VectorStoreFile {
    * attached to.
    */
   vector_store_id: string;
+
+  /**
+   * The strategy used to chunk the file.
+   */
+  chunking_strategy?: VectorStoreFile.Static | VectorStoreFile.Other;
 }
 
 export namespace VectorStoreFile {
@@ -235,6 +240,44 @@ export namespace VectorStoreFile {
      */
     message: string;
   }
+
+  export interface Static {
+    static: Static.Static;
+
+    /**
+     * Always `static`.
+     */
+    type: 'static';
+  }
+
+  export namespace Static {
+    export interface Static {
+      /**
+       * The number of tokens that overlap between chunks. The default value is `400`.
+       *
+       * Note that the overlap must not exceed half of `max_chunk_size_tokens`.
+       */
+      chunk_overlap_tokens: number;
+
+      /**
+       * The maximum number of tokens in each chunk. The default value is `800`. The
+       * minimum value is `100` and the maximum value is `4096`.
+       */
+      max_chunk_size_tokens: number;
+    }
+  }
+
+  /**
+   * This is returned when the chunking strategy is unknown. Typically, this is
+   * because the file was indexed before the `chunking_strategy` concept was
+   * introduced in the API.
+   */
+  export interface Other {
+    /**
+     * Always `other`.
+     */
+    type: 'other';
+  }
 }
 
 export interface VectorStoreFileDeleted {
@@ -252,6 +295,53 @@ export interface FileCreateParams {
    * files.
    */
   file_id: string;
+
+  /**
+   * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+   * strategy.
+   */
+  chunking_strategy?:
+    | FileCreateParams.AutoChunkingStrategyRequestParam
+    | FileCreateParams.StaticChunkingStrategyRequestParam;
+}
+
+export namespace FileCreateParams {
+  /**
+   * The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
+   * `800` and `chunk_overlap_tokens` of `400`.
+   */
+  export interface AutoChunkingStrategyRequestParam {
+    /**
+     * Always `auto`.
+     */
+    type: 'auto';
+  }
+
+  export interface StaticChunkingStrategyRequestParam {
+    static: StaticChunkingStrategyRequestParam.Static;
+
+    /**
+     * Always `static`.
+     */
+    type: 'static';
+  }
+
+  export namespace StaticChunkingStrategyRequestParam {
+    export interface Static {
+      /**
+       * The number of tokens that overlap between chunks. The default value is `400`.
+       *
+       * Note that the overlap must not exceed half of `max_chunk_size_tokens`.
+       */
+      chunk_overlap_tokens: number;
+
+      /**
+       * The maximum number of tokens in each chunk. The default value is `800`. The
+       * minimum value is `100` and the maximum value is `4096`.
+       */
+      max_chunk_size_tokens: number;
+    }
+  }
 }
 
 export interface FileListParams extends CursorPageParams {

package/src/resources/beta/vector-stores/vector-stores.ts

@@ -200,6 +200,12 @@ export interface VectorStoreDeleted {
 }
 
 export interface VectorStoreCreateParams {
+  /**
+   * 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.
+   */
+  chunking_strategy?: VectorStoreCreateParams.Auto | VectorStoreCreateParams.Static;
+
   /**
    * The expiration policy for a vector store.
    */
@@ -227,6 +233,43 @@ export interface VectorStoreCreateParams {
 }
 
 export namespace VectorStoreCreateParams {
+  /**
+   * The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
+   * `800` and `chunk_overlap_tokens` of `400`.
+   */
+  export interface Auto {
+    /**
+     * Always `auto`.
+     */
+    type: 'auto';
+  }
+
+  export interface Static {
+    static: Static.Static;
+
+    /**
+     * Always `static`.
+     */
+    type: 'static';
+  }
+
+  export namespace Static {
+    export interface Static {
+      /**
+       * The number of tokens that overlap between chunks. The default value is `400`.
+       *
+       * Note that the overlap must not exceed half of `max_chunk_size_tokens`.
+       */
+      chunk_overlap_tokens: number;
+
+      /**
+       * The maximum number of tokens in each chunk. The default value is `800`. The
+       * minimum value is `100` and the maximum value is `4096`.
+       */
+      max_chunk_size_tokens: number;
+    }
+  }
+
   /**
    * The expiration policy for a vector store.
    */

package/src/resources/chat/completions.ts

@@ -137,7 +137,7 @@ export interface ChatCompletionAssistantMessageParam {
    * @deprecated: Deprecated and replaced by `tool_calls`. The name and arguments of
    * a function that should be called, as generated by the model.
    */
-  function_call?: ChatCompletionAssistantMessageParam.FunctionCall;
+  function_call?: ChatCompletionAssistantMessageParam.FunctionCall | null;
 
   /**
    * An optional name for the participant. Provides the model information to
@@ -885,8 +885,8 @@ export namespace ChatCompletionCreateParams {
 
     /**
      * The parameters the functions accepts, described as a JSON Schema object. See the
-     * [guide](https://platform.openai.com/docs/guides/text-generation/function-calling)
-     * for examples, and the
+     * [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
+     * and the
      * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
      * documentation about the format.
      *

package/src/resources/files.ts

@@ -21,9 +21,15 @@ export class Files extends APIResource {
    * [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
    * details.
    *
-   * The Fine-tuning API only supports `.jsonl` files.
+   * The Fine-tuning API only supports `.jsonl` files. The input also has certain
+   * required formats for fine-tuning
+   * [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
+   * [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
+   * models.
    *
-   * The Batch API only supports `.jsonl` files up to 100 MB in size.
+   * The Batch API only supports `.jsonl` files up to 100 MB in size. The input also
+   * has a specific required
+   * [format](https://platform.openai.com/docs/api-reference/batch/request-input).
    *
    * Please [contact us](https://help.openai.com/) if you need to increase these
    * storage limits.
@@ -194,7 +200,7 @@ export interface FileCreateParams {
    * [Batch API](https://platform.openai.com/docs/guides/batch), and "fine-tune" for
    * [Fine-tuning](https://platform.openai.com/docs/api-reference/fine-tuning).
    */
-  purpose: 'assistants' | 'batch' | 'fine-tune';
+  purpose: 'assistants' | 'batch' | 'fine-tune' | 'vision';
 }
 
 export interface FileListParams {

package/src/resources/fine-tuning/jobs/jobs.ts

@@ -312,6 +312,11 @@ export interface JobCreateParams {
    * Your dataset must be formatted as a JSONL file. Additionally, you must upload
    * your file with the purpose `fine-tune`.
    *
+   * The contents of the file should differ depending on if the model uses the
+   * [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
+   * [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
+   * format.
+   *
    * See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
    * for more details.
    */

package/src/resources/shared.ts

@@ -25,8 +25,8 @@ export interface FunctionDefinition {
 
   /**
    * The parameters the functions accepts, described as a JSON Schema object. See the
-   * [guide](https://platform.openai.com/docs/guides/text-generation/function-calling)
-   * for examples, and the
+   * [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
+   * and the
    * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
    * documentation about the format.
    *
@@ -37,8 +37,8 @@ export interface FunctionDefinition {
 
 /**
  * The parameters the functions accepts, described as a JSON Schema object. See the
- * [guide](https://platform.openai.com/docs/guides/text-generation/function-calling)
- * for examples, and the
+ * [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
+ * and the
  * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
  * documentation about the format.
  *

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.47.3'; // x-release-please-version
+export const VERSION = '4.48.2'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.47.3";
+export declare const VERSION = "4.48.2";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.47.3'; // x-release-please-version
+exports.VERSION = '4.48.2'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.47.3'; // x-release-please-version
+export const VERSION = '4.48.2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map