openai 0.114.0 → 0.115.1

data/lib/openai/models/beta/beta_response.rb

@@ -319,6 +319,23 @@ module OpenAI
         #   @return [OpenAI::Models::Beta::BetaResponseTextConfig, nil]
         optional :text, -> { OpenAI::Beta::BetaResponseTextConfig }
 
+        # @!attribute tool_usage
+        #   Usage reported by hosted tools, separate from base model `usage`. The field can
+        #   be omitted when tool usage is unavailable. When present, tool families with no
+        #   recorded usage have zero counts.
+        #
+        #   `image_gen` sums available token counts across image generation calls. Calls
+        #   with missing or incomplete usage records may be skipped. Output token details
+        #   and cached input counts can be omitted. An omitted cache count means cache usage
+        #   is unknown.
+        #
+        #   `web_search.num_requests` counts billable searches. Discounted searches and
+        #   actions such as opening a page are excluded. Use billing records to reconcile
+        #   final charges.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponse::ToolUsage, nil]
+        optional :tool_usage, -> { OpenAI::Beta::BetaResponse::ToolUsage }
+
         # @!attribute top_logprobs
         #   An integer between 0 and 20 specifying the maximum number of most likely tokens
         #   to return at each token position, each with an associated log probability. In
@@ -358,7 +375,7 @@ module OpenAI
         #   @return [String, nil]
         optional :user, String
 
-        # @!method initialize(id:, access_programs:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, completed_at: nil, conversation: nil, max_output_tokens: nil, max_tool_calls: nil, moderation: nil, previous_response_id: nil, prompt: nil, prompt_cache_diagnostics: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, status: nil, text: nil, top_logprobs: nil, truncation: nil, usage: nil, user: nil, object: :response)
+        # @!method initialize(id:, access_programs:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, completed_at: nil, conversation: nil, max_output_tokens: nil, max_tool_calls: nil, moderation: nil, previous_response_id: nil, prompt: nil, prompt_cache_diagnostics: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, status: nil, text: nil, tool_usage: nil, top_logprobs: nil, truncation: nil, usage: nil, user: nil, object: :response)
         #   @param id [String]
         #     Unique identifier for this Response.
         #
@@ -566,6 +583,20 @@ module OpenAI
         #     - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
         #     - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
         #
+        #   @param tool_usage [OpenAI::Models::Beta::BetaResponse::ToolUsage]
+        #     Usage reported by hosted tools, separate from base model `usage`. The field can
+        #     be omitted when tool usage is unavailable. When present, tool families with no
+        #     recorded usage have zero counts.
+        #
+        #     `image_gen` sums available token counts across image generation calls. Calls
+        #     with missing or incomplete usage records may be skipped. Output token details
+        #     and cached input counts can be omitted. An omitted cache count means cache usage
+        #     is unknown.
+        #
+        #     `web_search.num_requests` counts billable searches. Discounted searches and
+        #     actions such as opening a page are excluded. Use billing records to reconcile
+        #     final charges.
+        #
         #   @param top_logprobs [Integer, nil]
         #     An integer between 0 and 20 specifying the maximum number of most likely tokens
         #     to return at each token position, each with an associated log probability. In
@@ -942,6 +973,9 @@ module OpenAI
           # replacements.
           GPT_5_4_NANO = :"gpt-5.4-nano"
           GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
+          # @deprecated Announced shutdown date: 2027-04-01. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
           # @deprecated Announced shutdown date: 2026-08-10. See
           # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -959,6 +993,9 @@ module OpenAI
           # https://developers.openai.com/api/docs/deprecations for details and recommended
           # replacements.
           GPT_5_1 = :"gpt-5.1"
+          # @deprecated Announced shutdown date: 2027-04-01. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
           # @deprecated Announced shutdown date: 2026-07-23. See
           # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -2108,6 +2145,192 @@ module OpenAI
           #   @return [Array<Symbol>]
         end
 
+        # @see OpenAI::Models::Beta::BetaResponse#tool_usage
+        class ToolUsage < OpenAI::Internal::Type::BaseModel
+          # @!attribute image_gen
+          #   Aggregated usage statistics for image generation tool calls.
+          #
+          #   @return [OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen]
+          required :image_gen, -> { OpenAI::Beta::BetaResponse::ToolUsage::ImageGen }
+
+          # @!attribute web_search
+          #   Aggregated billable usage statistics for web search tool calls.
+          #
+          #   @return [OpenAI::Models::Beta::BetaResponse::ToolUsage::WebSearch]
+          required :web_search, -> { OpenAI::Beta::BetaResponse::ToolUsage::WebSearch }
+
+          # @!method initialize(image_gen:, web_search:)
+          #   Usage reported by hosted tools, separate from base model `usage`. The field can
+          #   be omitted when tool usage is unavailable. When present, tool families with no
+          #   recorded usage have zero counts.
+          #
+          #   `image_gen` sums available token counts across image generation calls. Calls
+          #   with missing or incomplete usage records may be skipped. Output token details
+          #   and cached input counts can be omitted. An omitted cache count means cache usage
+          #   is unknown.
+          #
+          #   `web_search.num_requests` counts billable searches. Discounted searches and
+          #   actions such as opening a page are excluded. Use billing records to reconcile
+          #   final charges.
+          #
+          #   @param image_gen [OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen]
+          #     Aggregated usage statistics for image generation tool calls.
+          #
+          #   @param web_search [OpenAI::Models::Beta::BetaResponse::ToolUsage::WebSearch]
+          #     Aggregated billable usage statistics for web search tool calls.
+
+          # @see OpenAI::Models::Beta::BetaResponse::ToolUsage#image_gen
+          class ImageGen < OpenAI::Internal::Type::BaseModel
+            # @!attribute input_tokens
+            #   The number of tokens (images and text) in the input prompt.
+            #
+            #   @return [Integer]
+            required :input_tokens, Integer
+
+            # @!attribute input_tokens_details
+            #   The input tokens detailed information for the image generation.
+            #
+            #   @return [OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen::InputTokensDetails]
+            required :input_tokens_details, -> { OpenAI::Beta::BetaResponse::ToolUsage::ImageGen::InputTokensDetails }
+
+            # @!attribute output_tokens
+            #   The number of output tokens generated by the model.
+            #
+            #   @return [Integer]
+            required :output_tokens, Integer
+
+            # @!attribute total_tokens
+            #   The total number of tokens (images and text) used for the image generation.
+            #
+            #   @return [Integer]
+            required :total_tokens, Integer
+
+            # @!attribute cached_tokens
+            #
+            #   @return [Integer, nil]
+            optional :cached_tokens, Integer
+
+            # @!attribute cached_tokens_details
+            #
+            #   @return [OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen::CachedTokensDetails, nil]
+            optional(
+              :cached_tokens_details,
+              -> { OpenAI::Beta::BetaResponse::ToolUsage::ImageGen::CachedTokensDetails }
+            )
+
+            # @!attribute output_tokens_details
+            #   The output token details for the image generation.
+            #
+            #   @return [OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen::OutputTokensDetails, nil]
+            optional(
+              :output_tokens_details,
+              -> { OpenAI::Beta::BetaResponse::ToolUsage::ImageGen::OutputTokensDetails }
+            )
+
+            # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, total_tokens:, cached_tokens: nil, cached_tokens_details: nil, output_tokens_details: nil)
+            #   Aggregated usage statistics for image generation tool calls.
+            #
+            #   @param input_tokens [Integer]
+            #     The number of tokens (images and text) in the input prompt.
+            #
+            #   @param input_tokens_details [OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen::InputTokensDetails]
+            #     The input tokens detailed information for the image generation.
+            #
+            #   @param output_tokens [Integer]
+            #     The number of output tokens generated by the model.
+            #
+            #   @param total_tokens [Integer]
+            #     The total number of tokens (images and text) used for the image generation.
+            #
+            #   @param cached_tokens [Integer]
+            #
+            #   @param cached_tokens_details [OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen::CachedTokensDetails]
+            #
+            #   @param output_tokens_details [OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen::OutputTokensDetails]
+            #     The output token details for the image generation.
+
+            # @see OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen#input_tokens_details
+            class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+              # @!attribute image_tokens
+              #   The number of image tokens in the input prompt.
+              #
+              #   @return [Integer]
+              required :image_tokens, Integer
+
+              # @!attribute text_tokens
+              #   The number of text tokens in the input prompt.
+              #
+              #   @return [Integer]
+              required :text_tokens, Integer
+
+              # @!method initialize(image_tokens:, text_tokens:)
+              #   The input tokens detailed information for the image generation.
+              #
+              #   @param image_tokens [Integer]
+              #     The number of image tokens in the input prompt.
+              #
+              #   @param text_tokens [Integer]
+              #     The number of text tokens in the input prompt.
+            end
+
+            # @see OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen#cached_tokens_details
+            class CachedTokensDetails < OpenAI::Internal::Type::BaseModel
+              # @!attribute cached_image_tokens
+              #
+              #   @return [Integer]
+              required :cached_image_tokens, Integer
+
+              # @!attribute cached_text_tokens
+              #
+              #   @return [Integer]
+              required :cached_text_tokens, Integer
+
+              # @!method initialize(cached_image_tokens:, cached_text_tokens:)
+              #   @param cached_image_tokens [Integer]
+              #   @param cached_text_tokens [Integer]
+            end
+
+            # @see OpenAI::Models::Beta::BetaResponse::ToolUsage::ImageGen#output_tokens_details
+            class OutputTokensDetails < OpenAI::Internal::Type::BaseModel
+              # @!attribute image_tokens
+              #   The number of image output tokens generated by the model.
+              #
+              #   @return [Integer]
+              required :image_tokens, Integer
+
+              # @!attribute text_tokens
+              #   The number of text output tokens generated by the model.
+              #
+              #   @return [Integer]
+              required :text_tokens, Integer
+
+              # @!method initialize(image_tokens:, text_tokens:)
+              #   The output token details for the image generation.
+              #
+              #   @param image_tokens [Integer]
+              #     The number of image output tokens generated by the model.
+              #
+              #   @param text_tokens [Integer]
+              #     The number of text output tokens generated by the model.
+            end
+          end
+
+          # @see OpenAI::Models::Beta::BetaResponse::ToolUsage#web_search
+          class WebSearch < OpenAI::Internal::Type::BaseModel
+            # @!attribute num_requests
+            #   The number of billable web search requests issued.
+            #
+            #   @return [Integer]
+            required :num_requests, Integer
+
+            # @!method initialize(num_requests:)
+            #   Aggregated billable usage statistics for web search tool calls.
+            #
+            #   @param num_requests [Integer]
+            #     The number of billable web search requests issued.
+          end
+        end
+
         # The truncation strategy to use for the model response.
         #
         # - `auto`: If the input to this Response exceeds the model's context window size,

data/lib/openai/models/beta/beta_response_configuration_update_item.rb

@@ -28,9 +28,15 @@ module OpenAI
         #   @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning, nil]
         optional :reasoning, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItem::Reasoning }
 
-        # @!method initialize(id:, agent: nil, reasoning: nil, type: :configuration_update)
-        #   A configuration update that applies to subsequent responses until it is replaced
-        #   by another configuration update.
+        # @!attribute text
+        #   The text output configuration for subsequent responses.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Text, nil]
+        optional :text, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItem::Text }
+
+        # @!method initialize(id:, agent: nil, reasoning: nil, text: nil, type: :configuration_update)
+        #   A configuration update for subsequent responses. Each setting stays in effect
+        #   until a later update replaces that setting.
         #
         #   @param id [String]
         #     The unique ID of the configuration update item.
@@ -41,6 +47,9 @@ module OpenAI
         #   @param reasoning [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Reasoning]
         #     The reasoning configuration applied by this update.
         #
+        #   @param text [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Text]
+        #     The text output configuration for subsequent responses.
+        #
         #   @param type [Symbol, :configuration_update]
         #     The item type. Always `configuration_update`.
 
@@ -98,6 +107,58 @@ module OpenAI
             #   @return [Array<Symbol>]
           end
         end
+
+        # @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem#text
+        class Text < OpenAI::Internal::Type::BaseModel
+          # @!attribute format_
+          #   Use a JSON schema for structured output or text to return to plain text.
+          #
+          #   @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Text::Format::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig]
+          required(
+            :format_,
+            union: -> { OpenAI::Beta::BetaResponseConfigurationUpdateItem::Text::Format },
+            api_name: :format
+          )
+
+          # @!method initialize(format_:)
+          #   The text output configuration for subsequent responses.
+          #
+          #   @param format_ [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Text::Format::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig]
+          #     Use a JSON schema for structured output or text to return to plain text.
+
+          # Use a JSON schema for structured output or text to return to plain text.
+          #
+          # @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Text#format_
+          module Format
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Default response format. Used to generate text responses.
+            variant :text, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItem::Text::Format::Text }
+
+            # JSON Schema response format. Used to generate structured JSON responses.
+            # Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
+            variant :json_schema, -> { OpenAI::Beta::BetaResponseFormatTextJSONSchemaConfig }
+
+            class Text < OpenAI::Internal::Type::BaseModel
+              # @!attribute type
+              #   The type of response format being defined. Always `text`.
+              #
+              #   @return [Symbol, :text]
+              required :type, const: :text
+
+              # @!method initialize(type: :text)
+              #   Default response format. Used to generate text responses.
+              #
+              #   @param type [Symbol, :text]
+              #     The type of response format being defined. Always `text`.
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::BetaResponseConfigurationUpdateItem::Text::Format::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig)]
+          end
+        end
       end
     end
 

data/lib/openai/models/beta/beta_response_configuration_update_item_param.rb

@@ -28,10 +28,15 @@ module OpenAI
         #   @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning, nil]
         optional :reasoning, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning }
 
-        # @!method initialize(id: nil, agent: nil, reasoning: nil, type: :configuration_update)
-        #   An update to the conversation's response configuration. The configuration
-        #   remains in effect for subsequent responses until it is replaced by another
-        #   configuration update.
+        # @!attribute text
+        #   The text output configuration for subsequent responses.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text, nil]
+        optional :text, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Text }
+
+        # @!method initialize(id: nil, agent: nil, reasoning: nil, text: nil, type: :configuration_update)
+        #   An update to the conversation's response configuration. Supply reasoning, text,
+        #   or both. Each setting stays in effect until a later update replaces it.
         #
         #   @param id [String, nil]
         #     The unique ID of the configuration update item.
@@ -42,6 +47,9 @@ module OpenAI
         #   @param reasoning [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Reasoning]
         #     Updates to reasoning configuration. Only effort is supported.
         #
+        #   @param text [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text]
+        #     The text output configuration for subsequent responses.
+        #
         #   @param type [Symbol, :configuration_update]
         #     The item type. Always `configuration_update`.
 
@@ -99,6 +107,58 @@ module OpenAI
             #   @return [Array<Symbol>]
           end
         end
+
+        # @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam#text
+        class Text < OpenAI::Internal::Type::BaseModel
+          # @!attribute format_
+          #   Use a JSON schema for structured output or text to return to plain text.
+          #
+          #   @return [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig]
+          required(
+            :format_,
+            union: -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format },
+            api_name: :format
+          )
+
+          # @!method initialize(format_:)
+          #   The text output configuration for subsequent responses.
+          #
+          #   @param format_ [OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig]
+          #     Use a JSON schema for structured output or text to return to plain text.
+
+          # Use a JSON schema for structured output or text to return to plain text.
+          #
+          # @see OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text#format_
+          module Format
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Default response format. Used to generate text responses.
+            variant :text, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format::Text }
+
+            # JSON Schema response format. Used to generate structured JSON responses.
+            # Learn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
+            variant :json_schema, -> { OpenAI::Beta::BetaResponseFormatTextJSONSchemaConfig }
+
+            class Text < OpenAI::Internal::Type::BaseModel
+              # @!attribute type
+              #   The type of response format being defined. Always `text`.
+              #
+              #   @return [Symbol, :text]
+              required :type, const: :text
+
+              # @!method initialize(type: :text)
+              #   Default response format. Used to generate text responses.
+              #
+              #   @param type [Symbol, :text]
+              #     The type of response format being defined. Always `text`.
+            end
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::BetaResponseConfigurationUpdateItemParam::Text::Format::Text, OpenAI::Models::Beta::BetaResponseFormatTextJSONSchemaConfig)]
+          end
+        end
       end
     end
 

data/lib/openai/models/beta/beta_response_input_item.rb

@@ -63,9 +63,8 @@ module OpenAI
 
         variant :additional_tools, -> { OpenAI::Beta::BetaResponseInputItem::AdditionalTools }
 
-        # An update to the conversation's response configuration. The configuration
-        # remains in effect for subsequent responses until it is replaced by another
-        # configuration update.
+        # An update to the conversation's response configuration. Supply reasoning,
+        # text, or both. Each setting stays in effect until a later update replaces it.
         variant :configuration_update, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItemParam }
 
         # A description of the chain of thought used by a reasoning model while generating

data/lib/openai/models/beta/beta_response_item.rb

@@ -46,8 +46,8 @@ module OpenAI
 
         variant :additional_tools, -> { OpenAI::Beta::BetaResponseItem::AdditionalTools }
 
-        # A configuration update that applies to subsequent responses until it is
-        # replaced by another configuration update.
+        # A configuration update for subsequent responses. Each setting stays in effect
+        # until a later update replaces that setting.
         variant :configuration_update, -> { OpenAI::Beta::BetaResponseConfigurationUpdateItem }
 
         # A description of the chain of thought used by a reasoning model while generating

data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb

@@ -758,8 +758,8 @@ module OpenAI
             # @!attribute input_fidelity
             #   Control how much effort the model will exert to match the style and features,
             #   especially facial features, of input images. Supports `high` and `low` on
-            #   `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-            #   `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+            #   `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+            #   this parameter. Defaults to `low` on supported models.
             #
             #   @return [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Tool::ImageGeneration::InputFidelity, nil]
             optional(
@@ -878,8 +878,8 @@ module OpenAI
             #   @param input_fidelity [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Tool::ImageGeneration::InputFidelity, nil]
             #     Control how much effort the model will exert to match the style and features,
             #     especially facial features, of input images. Supports `high` and `low` on
-            #     `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-            #     `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+            #     `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+            #     this parameter. Defaults to `low` on supported models.
             #
             #   @param input_image_mask [OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Tool::ImageGeneration::InputImageMask]
             #     Optional mask for inpainting. Contains `image_url` (string, optional) and
@@ -968,8 +968,8 @@ module OpenAI
 
             # Control how much effort the model will exert to match the style and features,
             # especially facial features, of input images. Supports `high` and `low` on
-            # `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-            # `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+            # `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+            # this parameter. Defaults to `low` on supported models.
             #
             # @see OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Tool::ImageGeneration#input_fidelity
             module InputFidelity

data/lib/openai/models/beta/beta_responses_client_event.rb

@@ -99,6 +99,14 @@ module OpenAI
             nil?: true
           )
 
+          # @!attribute generate
+          #   Whether to generate output for this response. Defaults to true when omitted. Set
+          #   to false to prepare request state without model output; the response ID can be
+          #   used as previous_response_id on a later turn.
+          #
+          #   @return [Boolean, nil]
+          optional :generate, OpenAI::Internal::Type::Boolean
+
           # @!attribute include
           #   Specify additional output data to include in the model response. Currently
           #   supported values are:
@@ -482,7 +490,7 @@ module OpenAI
           #   @return [String, nil]
           optional :user, String
 
-          # @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
+          # @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, generate: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
           #   Client event for creating a response over a persistent WebSocket connection.
           #   This payload uses the same top-level fields as `POST /v1/responses`, plus
           #   WebSocket-only envelope metadata.
@@ -509,6 +517,11 @@ module OpenAI
           #     items from this response are automatically added to this conversation after this
           #     response completes.
           #
+          #   @param generate [Boolean]
+          #     Whether to generate output for this response. Defaults to true when omitted. Set
+          #     to false to prepare request state without model output; the response ID can be
+          #     used as previous_response_id on a later turn.
+          #
           #   @param include [Array<Symbol, OpenAI::Models::Beta::BetaResponseIncludable>, nil]
           #     Specify additional output data to include in the model response. Currently
           #     supported values are:
@@ -1329,6 +1342,9 @@ module OpenAI
             # replacements.
             GPT_5_4_NANO = :"gpt-5.4-nano"
             GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
+            # @deprecated Announced shutdown date: 2027-04-01. See
+            # https://developers.openai.com/api/docs/deprecations for details and recommended
+            # replacements.
             GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
             # @deprecated Announced shutdown date: 2026-08-10. See
             # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -1346,6 +1362,9 @@ module OpenAI
             # https://developers.openai.com/api/docs/deprecations for details and recommended
             # replacements.
             GPT_5_1 = :"gpt-5.1"
+            # @deprecated Announced shutdown date: 2027-04-01. See
+            # https://developers.openai.com/api/docs/deprecations for details and recommended
+            # replacements.
             GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
             # @deprecated Announced shutdown date: 2026-07-23. See
             # https://developers.openai.com/api/docs/deprecations for details and recommended

data/lib/openai/models/beta/beta_tool.rb

@@ -634,8 +634,8 @@ module OpenAI
           # @!attribute input_fidelity
           #   Control how much effort the model will exert to match the style and features,
           #   especially facial features, of input images. Supports `high` and `low` on
-          #   `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-          #   `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+          #   `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+          #   this parameter. Defaults to `low` on supported models.
           #
           #   @return [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::InputFidelity, nil]
           optional(
@@ -736,8 +736,8 @@ module OpenAI
           #   @param input_fidelity [Symbol, OpenAI::Models::Beta::BetaTool::ImageGeneration::InputFidelity, nil]
           #     Control how much effort the model will exert to match the style and features,
           #     especially facial features, of input images. Supports `high` and `low` on
-          #     `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-          #     `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+          #     `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+          #     this parameter. Defaults to `low` on supported models.
           #
           #   @param input_image_mask [OpenAI::Models::Beta::BetaTool::ImageGeneration::InputImageMask]
           #     Optional mask for inpainting. Contains `image_url` (string, optional) and
@@ -826,8 +826,8 @@ module OpenAI
 
           # Control how much effort the model will exert to match the style and features,
           # especially facial features, of input images. Supports `high` and `low` on
-          # `gpt-image-1` and `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For
-          # `gpt-image-2`, omit this parameter. Defaults to `low` on supported models.
+          # `gpt-image-1.5`; `gpt-image-1-mini` supports only `low`. For `gpt-image-2`, omit
+          # this parameter. Defaults to `low` on supported models.
           #
           # @see OpenAI::Models::Beta::BetaTool::ImageGeneration#input_fidelity
           module InputFidelity

data/lib/openai/models/beta/response_compact_params.rb

@@ -428,6 +428,9 @@ module OpenAI
           # replacements.
           GPT_5_4_NANO = :"gpt-5.4-nano"
           GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
+          # @deprecated Announced shutdown date: 2027-04-01. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
           # @deprecated Announced shutdown date: 2026-08-10. See
           # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -445,6 +448,9 @@ module OpenAI
           # https://developers.openai.com/api/docs/deprecations for details and recommended
           # replacements.
           GPT_5_1 = :"gpt-5.1"
+          # @deprecated Announced shutdown date: 2027-04-01. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
           # @deprecated Announced shutdown date: 2026-07-23. See
           # https://developers.openai.com/api/docs/deprecations for details and recommended

data/lib/openai/models/beta/response_create_params.rb

@@ -1013,6 +1013,9 @@ module OpenAI
           # replacements.
           GPT_5_4_NANO = :"gpt-5.4-nano"
           GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
+          # @deprecated Announced shutdown date: 2027-04-01. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
           # @deprecated Announced shutdown date: 2026-08-10. See
           # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -1030,6 +1033,9 @@ module OpenAI
           # https://developers.openai.com/api/docs/deprecations for details and recommended
           # replacements.
           GPT_5_1 = :"gpt-5.1"
+          # @deprecated Announced shutdown date: 2027-04-01. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
           # @deprecated Announced shutdown date: 2026-07-23. See
           # https://developers.openai.com/api/docs/deprecations for details and recommended

data/lib/openai/models/chat_model.rb

@@ -22,6 +22,9 @@ module OpenAI
       # replacements.
       GPT_5_4_NANO = :"gpt-5.4-nano"
       GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
+      # @deprecated Announced shutdown date: 2027-04-01. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
       # @deprecated Announced shutdown date: 2026-08-10. See
       # https://developers.openai.com/api/docs/deprecations for details and recommended
@@ -39,6 +42,9 @@ module OpenAI
       # https://developers.openai.com/api/docs/deprecations for details and recommended
       # replacements.
       GPT_5_1 = :"gpt-5.1"
+      # @deprecated Announced shutdown date: 2027-04-01. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
       # @deprecated Announced shutdown date: 2026-07-23. See
       # https://developers.openai.com/api/docs/deprecations for details and recommended