openai 7.10.0 → 7.12.1

package/resources/beta/responses/responses.d.mts

@@ -999,6 +999,10 @@ export interface BetaResponse {
      * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
      */
     prompt?: BetaResponsePrompt | null;
+    /**
+     * Prompt cache diagnostics requested for this response.
+     */
+    prompt_cache_diagnostics?: BetaResponse.CacheMiss | BetaResponse.CacheHit | BetaResponse.ComparisonResponseNotFound | BetaResponse.Unavailable;
     /**
      * Used by OpenAI to cache responses for similar requests to optimize your cache
      * hit rates. Replaces the `user` field.
@@ -1267,6 +1271,31 @@ export declare namespace BetaResponse {
             type: 'error';
         }
     }
+    interface CacheMiss {
+        /**
+         * The estimated number of input tokens affected after the first detected
+         * divergence.
+         */
+        cache_missed_tokens: number;
+        /**
+         * The reason prompt cache reuse did not occur.
+         */
+        reason: 'model_changed' | 'prompt_cache_key_changed' | 'tools_changed' | 'text_format_changed' | 'reasoning_effort_changed' | 'verbosity_changed' | 'context_compacted' | 'input_changed' | 'service_tier_changed';
+        type: 'cache_miss';
+        /**
+         * The raw token count of the reusable prefix in the compared response.
+         */
+        comparison_reusable_tokens?: number;
+    }
+    interface CacheHit {
+        type: 'cache_hit';
+    }
+    interface ComparisonResponseNotFound {
+        type: 'comparison_response_not_found';
+    }
+    interface Unavailable {
+        type: 'unavailable';
+    }
     /**
      * The prompt-caching options that were applied to the response. Supported for
      * `gpt-5.6` and later models.
@@ -1280,6 +1309,10 @@ export declare namespace BetaResponse {
          * The minimum lifetime applied to each cache breakpoint.
          */
         ttl: '30m';
+        /**
+         * The response ID supplied as the prompt cache diagnostics comparison.
+         */
+        comparison_response_id?: string | null;
     }
     /**
      * Configuration options for
@@ -3056,10 +3089,6 @@ export interface BetaResponseFunctionCallArgumentsDoneEvent {
      * The ID of the item.
      */
     item_id: string;
-    /**
-     * The name of the function that was called.
-     */
-    name: string;
     /**
      * The index of the output item.
      */
@@ -3501,7 +3530,7 @@ export interface BetaResponseFunctionWebSearch {
     /**
      * The status of the web search tool call.
      */
-    status: 'in_progress' | 'searching' | 'completed' | 'failed';
+    status: 'in_progress' | 'searching' | 'completed' | 'failed' | 'incomplete';
     /**
      * The type of the web search tool call. Always `web_search_call`.
      */
@@ -4650,6 +4679,15 @@ export declare namespace BetaResponseInputItem {
          * The agent that produced this item.
          */
         agent?: ImageGenerationCall.Agent | null;
+        /**
+         * The quality of the image generated by the image generation tool call. One of
+         * `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+         */
+        quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
+        /**
+         * The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+         */
+        size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | null;
     }
     namespace ImageGenerationCall {
         /**
@@ -5863,6 +5901,15 @@ export declare namespace BetaResponseItem {
          * The agent that produced this item.
          */
         agent?: ImageGenerationCall.Agent | null;
+        /**
+         * The quality of the image generated by the image generation tool call. One of
+         * `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+         */
+        quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
+        /**
+         * The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+         */
+        size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | null;
     }
     namespace ImageGenerationCall {
         /**
@@ -6844,6 +6891,15 @@ export declare namespace BetaResponseOutputItem {
          * The agent that produced this item.
          */
         agent?: ImageGenerationCall.Agent | null;
+        /**
+         * The quality of the image generated by the image generation tool call. One of
+         * `low`, `medium`, `high`, `xhigh`, `max`, or `auto`.
+         */
+        quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto' | null;
+        /**
+         * The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
+         */
+        size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | null;
     }
     namespace ImageGenerationCall {
         /**
@@ -9535,6 +9591,9 @@ export declare namespace BetaResponsesClientEvent {
         service_tier?: ResponsesAPI.BetaServiceTier | null;
         /**
          * Whether to store the generated model response for later retrieval via API.
+         * Defaults to true when omitted. If set to true, response data will be stored for
+         * at least 30 days, subject to the
+         * [data retention exceptions](/api/docs/guides/your-data#v1responses).
          */
         store?: boolean | null;
         /**
@@ -9719,6 +9778,11 @@ export declare namespace BetaResponsesClientEvent {
          * for current details.
          */
         interface PromptCacheOptions {
+            /**
+             * The ID of a response to compare when diagnosing prompt cache reuse. Supplying
+             * this field requests prompt cache diagnostics when the feature is enabled.
+             */
+            comparison_response_id?: string | null;
             /**
              * Controls whether OpenAI automatically creates an implicit cache breakpoint.
              * Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
@@ -10748,9 +10812,11 @@ export declare namespace BetaTool {
          * one of `transparent`, `opaque`, or `auto` (default value). When `auto` is used,
          * the model will automatically determine the best background for the image.
          *
-         * Transparent backgrounds are available for supported GPT Image models. For
-         * `gpt-image-2` and `gpt-image-2-2026-04-21`, this support is in preview. When
-         * using `transparent`, set the output format to `png` or `webp`.
+         * `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`, including their `2026-09-08`
+         * snapshots, support `opaque` and `transparent` backgrounds. Transparent
+         * backgrounds are available for supported GPT Image models. For `gpt-image-2` and
+         * `gpt-image-2-2026-04-21`, this support is in preview. When using `transparent`,
+         * set the output format to `png` or `webp`.
          */
         background?: 'transparent' | 'opaque' | 'auto';
         /**
@@ -10767,10 +10833,12 @@ export declare namespace BetaTool {
         input_image_mask?: ImageGeneration.InputImageMask;
         /**
          * The image generation model to use. One of `gpt-image-1`, `gpt-image-1-mini`,
-         * `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, or
+         * `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`,
+         * `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
+         * `gpt-image-2.5-flare`, `gpt-image-2.5-flare-2026-09-08`, or
          * `chatgpt-image-latest`. Default: `gpt-image-1`.
          */
-        model?: (string & {}) | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-2' | 'gpt-image-2-2026-04-21' | 'gpt-image-1.5' | 'chatgpt-image-latest';
+        model?: (string & {}) | 'gpt-image-1' | 'gpt-image-1-mini' | 'gpt-image-2' | 'gpt-image-2-2026-04-21' | 'gpt-image-2.5-sunburst' | 'gpt-image-2.5-sunburst-2026-09-08' | 'gpt-image-2.5-flare' | 'gpt-image-2.5-flare-2026-09-08' | 'gpt-image-1.5' | 'chatgpt-image-latest';
         /**
          * Moderation level for the generated image. Default: `auto`.
          */
@@ -10790,22 +10858,25 @@ export declare namespace BetaTool {
          */
         partial_images?: number;
         /**
-         * The quality of the generated image. One of `low`, `medium`, `high`, or `auto`.
-         * Default: `auto`.
-         */
-        quality?: 'low' | 'medium' | 'high' | 'auto';
-        /**
-         * The size of the generated images. For `gpt-image-2` and
-         * `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT`
-         * strings, for example `1536x864`. Width and height must both be divisible by 16
-         * and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above
-         * `2560x1440` are experimental, and the maximum supported resolution is
-         * `3840x2160`. The requested size must also satisfy the model's current pixel and
-         * edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are
-         * supported by the GPT image models; `auto` is supported for models that allow
-         * automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or
-         * `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or
-         * `1024x1792`.
+         * The quality of the generated image. The GPT image models support `low`,
+         * `medium`, and `high`. `gpt-image-2.5-sunburst` and `gpt-image-2.5-flare`,
+         * including their `2026-09-08` snapshots, also support `xhigh` and `max`. Default:
+         * `auto`.
+         */
+        quality?: 'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'auto';
+        /**
+         * The size of the generated images. For `gpt-image-2`, `gpt-image-2-2026-04-21`,
+         * `gpt-image-2.5-sunburst`, `gpt-image-2.5-sunburst-2026-09-08`,
+         * `gpt-image-2.5-flare`, and `gpt-image-2.5-flare-2026-09-08`, arbitrary
+         * resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`.
+         * Width and height must both be divisible by 16 and the requested aspect ratio
+         * must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and
+         * the maximum supported resolution is `3840x2160`. The requested size must also
+         * satisfy the model's current pixel and edge limits. The standard sizes
+         * `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models;
+         * `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use
+         * one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of
+         * `1024x1024`, `1792x1024`, or `1024x1792`.
          */
         size?: (string & {}) | '1024x1024' | '1024x1536' | '1536x1024' | 'auto';
     }
@@ -11304,7 +11375,9 @@ export interface ResponseCreateParamsBase {
     service_tier?: BetaServiceTier | null;
     /**
      * Body param: Whether to store the generated model response for later retrieval
-     * via API.
+     * via API. Defaults to true when omitted. If set to true, response data will be
+     * stored for at least 30 days, subject to the
+     * [data retention exceptions](/api/docs/guides/your-data#v1responses).
      */
     store?: boolean | null;
     /**
@@ -11488,6 +11561,11 @@ export declare namespace ResponseCreateParams {
      * for current details.
      */
     interface PromptCacheOptions {
+        /**
+         * The ID of a response to compare when diagnosing prompt cache reuse. Supplying
+         * this field requests prompt cache diagnostics when the feature is enabled.
+         */
+        comparison_response_id?: string | null;
         /**
          * Controls whether OpenAI automatically creates an implicit cache breakpoint.
          * Defaults to `implicit`. With `implicit`, OpenAI creates one implicit breakpoint
@@ -11729,12 +11807,13 @@ export interface ResponseCompactParams {
      * request will be processed with the Flex Processing service tier. - To opt-in to
      * [Fast mode](/api/docs/guides/fast-mode) at the request level, include the
      * `service_tier=fast` or `service_tier=priority` parameter for Responses or Chat
-     * Completions. The response will show `service_tier=priority` regardless of if you
-     * specify `service_tier=fast` or `priority` in your request. - When not set, the
-     * default behavior is 'auto'. When the `service_tier` parameter is set, the
-     * response body will include the `service_tier` value based on the processing mode
-     * actually used to serve the request. This response value may be different from
-     * the value set in the parameter.
+     * Completions. For models with a dedicated Fast tier, either value resolves to
+     * `service_tier=fast`; for other models, either value resolves to
+     * `service_tier=priority`. - When not set, the default behavior is 'auto'. When
+     * the `service_tier` parameter is set, the response body will include the
+     * `service_tier` value based on the processing mode actually used to serve the
+     * request. This response value may be different from the value set in the
+     * parameter.
      */
     service_tier?: 'auto' | 'default' | 'fast' | 'flex' | 'priority' | null;
     /**