openai 5.2.0 → 5.4.0

package/src/internal/qs/utils.ts

@@ -1,10 +1,13 @@
 import { RFC1738 } from './formats';
 import type { DefaultEncoder, Format } from './types';
+import { isArray } from '../utils/values';
 
-const has = Object.prototype.hasOwnProperty;
-const is_array = Array.isArray;
+export let has = (obj: object, key: PropertyKey): boolean => (
+  (has = (Object as any).hasOwn ?? Function.prototype.call.bind(Object.prototype.hasOwnProperty)),
+  has(obj, key)
+);
 
-const hex_table = (() => {
+const hex_table = /* @__PURE__ */ (() => {
   const array = [];
   for (let i = 0; i < 256; ++i) {
     array.push('%' + ((i < 16 ? '0' : '') + i.toString(16)).toUpperCase());
@@ -20,7 +23,7 @@ function compact_queue<T extends Record<string, any>>(queue: Array<{ obj: T; pro
 
     const obj = item.obj[item.prop];
 
-    if (is_array(obj)) {
+    if (isArray(obj)) {
       const compacted: unknown[] = [];
 
       for (let j = 0; j < obj.length; ++j) {
@@ -56,13 +59,10 @@ export function merge(
   }
 
   if (typeof source !== 'object') {
-    if (is_array(target)) {
+    if (isArray(target)) {
       target.push(source);
     } else if (target && typeof target === 'object') {
-      if (
-        (options && (options.plainObjects || options.allowPrototypes)) ||
-        !has.call(Object.prototype, source)
-      ) {
+      if ((options && (options.plainObjects || options.allowPrototypes)) || !has(Object.prototype, source)) {
         target[source] = true;
       }
     } else {
@@ -77,14 +77,14 @@ export function merge(
   }
 
   let mergeTarget = target;
-  if (is_array(target) && !is_array(source)) {
+  if (isArray(target) && !isArray(source)) {
     // @ts-ignore
     mergeTarget = array_to_object(target, options);
   }
 
-  if (is_array(target) && is_array(source)) {
+  if (isArray(target) && isArray(source)) {
     source.forEach(function (item, i) {
-      if (has.call(target, i)) {
+      if (has(target, i)) {
         const targetItem = target[i];
         if (targetItem && typeof targetItem === 'object' && item && typeof item === 'object') {
           target[i] = merge(targetItem, item, options);
@@ -101,7 +101,7 @@ export function merge(
   return Object.keys(source).reduce(function (acc, key) {
     const value = source[key];
 
-    if (has.call(acc, key)) {
+    if (has(acc, key)) {
       acc[key] = merge(acc[key], value, options);
     } else {
       acc[key] = value;
@@ -254,7 +254,7 @@ export function combine(a: any, b: any) {
 }
 
 export function maybe_map<T>(val: T[], fn: (v: T) => T) {
-  if (is_array(val)) {
+  if (isArray(val)) {
     const mapped = [];
     for (let i = 0; i < val.length; i += 1) {
       mapped.push(fn(val[i]!));

package/src/internal/request-options.ts

@@ -21,6 +21,7 @@ export type RequestOptions = {
   fetchOptions?: MergedRequestInit;
   signal?: AbortSignal | undefined | null;
   idempotencyKey?: string;
+  defaultBaseURL?: string | undefined;
 
   __metadata?: Record<string, unknown>;
   __binaryResponse?: boolean | undefined;

package/src/internal/uploads.ts

@@ -90,7 +90,7 @@ export const multipartFormRequestOptions = async (
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
 
-const supportsFormDataMap = new WeakMap<Fetch, Promise<boolean>>();
+const supportsFormDataMap = /** @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
 
 /**
  * node-fetch doesn't support the global FormData object in recent node versions. Instead of sending

package/src/internal/utils/log.ts

@@ -58,7 +58,7 @@ const noopLogger = {
   debug: noop,
 };
 
-let cachedLoggers = new WeakMap<Logger, [LogLevel, Logger]>();
+let cachedLoggers = /** @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
 export function loggerFor(client: OpenAI): Logger {
   const logger = client.logger;

package/src/internal/utils/path.ts

@@ -60,4 +60,4 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
 /**
  * URI-encodes path params and ensures no unsafe /./ or /../ path segments are introduced.
  */
-export const path = createPathTagFunction(encodeURIPath);
+export const path = /* @__PURE__ */ createPathTagFunction(encodeURIPath);

package/src/internal/utils/values.ts

@@ -9,6 +9,9 @@ export const isAbsoluteURL = (url: string): boolean => {
   return startsWithSchemeRegexp.test(url);
 };
 
+export let isArray = (val: unknown): val is unknown[] => ((isArray = Array.isArray), isArray(val));
+export let isReadonlyArray = isArray as (val: unknown) => val is readonly unknown[];
+
 /** Returns an object if the given value isn't an object, otherwise returns as-is */
 export function maybeObj(x: unknown): object {
   if (typeof x !== 'object') {

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

@@ -291,7 +291,7 @@ export interface ChatCompletion {
    * When this parameter is set, the response body will include the `service_tier`
    * utilized.
    */
-  service_tier?: 'auto' | 'default' | 'flex' | null;
+  service_tier?: 'auto' | 'default' | 'flex' | 'scale' | null;
 
   /**
    * This fingerprint represents the backend configuration that the model runs with.
@@ -542,7 +542,7 @@ export interface ChatCompletionChunk {
    * When this parameter is set, the response body will include the `service_tier`
    * utilized.
    */
-  service_tier?: 'auto' | 'default' | 'flex' | null;
+  service_tier?: 'auto' | 'default' | 'flex' | 'scale' | null;
 
   /**
    * This fingerprint represents the backend configuration that the model runs with.
@@ -1464,7 +1464,7 @@ export interface ChatCompletionCreateParamsBase {
    * When this parameter is set, the response body will include the `service_tier`
    * utilized.
    */
-  service_tier?: 'auto' | 'default' | 'flex' | null;
+  service_tier?: 'auto' | 'default' | 'flex' | 'scale' | null;
 
   /**
    * Not supported with latest reasoning models `o3` and `o4-mini`.

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

@@ -25,7 +25,7 @@ export class Jobs extends APIResource {
    * Response includes details of the enqueued job including job status and the name
    * of the fine-tuned models once complete.
    *
-   * [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
+   * [Learn more about fine-tuning](https://platform.openai.com/docs/guides/model-optimization)
    *
    * @example
    * ```ts
@@ -42,7 +42,7 @@ export class Jobs extends APIResource {
   /**
    * Get info about a fine-tuning job.
    *
-   * [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
+   * [Learn more about fine-tuning](https://platform.openai.com/docs/guides/model-optimization)
    *
    * @example
    * ```ts
@@ -449,7 +449,8 @@ export interface JobCreateParams {
    * [preference](https://platform.openai.com/docs/api-reference/fine-tuning/preference-input)
    * format.
    *
-   * See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+   * See the
+   * [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization)
    * for more details.
    */
   training_file: string;
@@ -508,7 +509,8 @@ export interface JobCreateParams {
    * Your dataset must be formatted as a JSONL file. You must upload your file with
    * the purpose `fine-tune`.
    *
-   * See the [fine-tuning guide](https://platform.openai.com/docs/guides/fine-tuning)
+   * See the
+   * [fine-tuning guide](https://platform.openai.com/docs/guides/model-optimization)
    * for more details.
    */
   validation_file?: string | null;

package/src/resources/images.ts

@@ -237,6 +237,20 @@ export interface ImageEditParams {
    */
   n?: number | null;
 
+  /**
+   * The compression level (0-100%) for the generated images. This parameter is only
+   * supported for `gpt-image-1` with the `webp` or `jpeg` output formats, and
+   * defaults to 100.
+   */
+  output_compression?: number | null;
+
+  /**
+   * The format in which the generated images are returned. This parameter is only
+   * supported for `gpt-image-1`. Must be one of `png`, `jpeg`, or `webp`. The
+   * default value is `png`.
+   */
+  output_format?: 'png' | 'jpeg' | 'webp' | null;
+
   /**
    * The quality of the image that will be generated. `high`, `medium` and `low` are
    * only supported for `gpt-image-1`. `dall-e-2` only supports `standard` quality.

package/src/resources/responses/responses.ts

@@ -358,14 +358,13 @@ export interface Response {
   incomplete_details: Response.IncompleteDetails | null;
 
   /**
-   * Inserts a system (or developer) message as the first item in the model's
-   * context.
+   * A system (or developer) message inserted into the model's context.
    *
    * When using along with `previous_response_id`, the instructions from a previous
    * response will not be carried over to the next response. This makes it simple to
    * swap out system (or developer) messages in new responses.
    */
-  instructions: string | null;
+  instructions: string | Array<ResponseInputItem> | null;
 
   /**
    * Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -469,6 +468,12 @@ export interface Response {
    */
   previous_response_id?: string | null;
 
+  /**
+   * Reference to a prompt template and its variables.
+   * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+   */
+  prompt?: ResponsePrompt | null;
+
   /**
    * **o-series models only**
    *
@@ -496,7 +501,7 @@ export interface Response {
    * When this parameter is set, the response body will include the `service_tier`
    * utilized.
    */
-  service_tier?: 'auto' | 'default' | 'flex' | null;
+  service_tier?: 'auto' | 'default' | 'flex' | 'scale' | null;
 
   /**
    * The status of the response generation. One of `completed`, `failed`,
@@ -3483,6 +3488,29 @@ export interface ResponseOutputTextAnnotationAddedEvent {
   type: 'response.output_text_annotation.added';
 }
 
+/**
+ * Reference to a prompt template and its variables.
+ * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+ */
+export interface ResponsePrompt {
+  /**
+   * The unique identifier of the prompt template to use.
+   */
+  id: string;
+
+  /**
+   * Optional map of values to substitute in for variables in your prompt. The
+   * substitution values can either be strings, or other Response input types like
+   * images or files.
+   */
+  variables?: Record<string, string | ResponseInputText | ResponseInputImage | ResponseInputFile> | null;
+
+  /**
+   * Optional version of the prompt template.
+   */
+  version?: string | null;
+}
+
 /**
  * Emitted when a response is queued and waiting to be processed.
  */
@@ -4612,8 +4640,7 @@ export interface ResponseCreateParamsBase {
   include?: Array<ResponseIncludable> | null;
 
   /**
-   * Inserts a system (or developer) message as the first item in the model's
-   * context.
+   * A system (or developer) message inserted into the model's context.
    *
    * When using along with `previous_response_id`, the instructions from a previous
    * response will not be carried over to the next response. This makes it simple to
@@ -4650,6 +4677,12 @@ export interface ResponseCreateParamsBase {
    */
   previous_response_id?: string | null;
 
+  /**
+   * Reference to a prompt template and its variables.
+   * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+   */
+  prompt?: ResponsePrompt | null;
+
   /**
    * **o-series models only**
    *
@@ -4677,7 +4710,7 @@ export interface ResponseCreateParamsBase {
    * When this parameter is set, the response body will include the `service_tier`
    * utilized.
    */
-  service_tier?: 'auto' | 'default' | 'flex' | null;
+  service_tier?: 'auto' | 'default' | 'flex' | 'scale' | null;
 
   /**
    * Whether to store the generated model response for later retrieval via API.
@@ -4922,6 +4955,7 @@ export declare namespace Responses {
     type ResponseOutputRefusal as ResponseOutputRefusal,
     type ResponseOutputText as ResponseOutputText,
     type ResponseOutputTextAnnotationAddedEvent as ResponseOutputTextAnnotationAddedEvent,
+    type ResponsePrompt as ResponsePrompt,
     type ResponseQueuedEvent as ResponseQueuedEvent,
     type ResponseReasoningDeltaEvent as ResponseReasoningDeltaEvent,
     type ResponseReasoningDoneEvent as ResponseReasoningDoneEvent,

package/src/resources/shared.ts

@@ -5,6 +5,8 @@ export type AllModels =
   | ChatModel
   | 'o1-pro'
   | 'o1-pro-2025-03-19'
+  | 'o3-pro'
+  | 'o3-pro-2025-06-10'
   | 'computer-use-preview'
   | 'computer-use-preview-2025-03-11';
 
@@ -297,5 +299,7 @@ export type ResponsesModel =
   | ChatModel
   | 'o1-pro'
   | 'o1-pro-2025-03-19'
+  | 'o3-pro'
+  | 'o3-pro-2025-06-10'
   | 'computer-use-preview'
   | 'computer-use-preview-2025-03-11';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.2.0'; // x-release-please-version
+export const VERSION = '5.4.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.2.0";
+export declare const VERSION = "5.4.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.2.0";
+export declare const VERSION = "5.4.0";
 //# 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 = '5.2.0'; // x-release-please-version
+exports.VERSION = '5.4.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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