openai 0.113.0 → 0.115.0

data/lib/openai/models/realtime/realtime_session.rb

@@ -433,8 +433,14 @@ module OpenAI
 
           # @!group
 
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME = :"gpt-realtime"
           GPT_REALTIME_1_5 = :"gpt-realtime-1.5"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME_2025_08_28 = :"gpt-realtime-2025-08-28"
           GPT_4O_REALTIME_PREVIEW = :"gpt-4o-realtime-preview"
           GPT_4O_REALTIME_PREVIEW_2024_10_01 = :"gpt-4o-realtime-preview-2024-10-01"
@@ -442,12 +448,24 @@ module OpenAI
           GPT_4O_REALTIME_PREVIEW_2025_06_03 = :"gpt-4o-realtime-preview-2025-06-03"
           GPT_4O_MINI_REALTIME_PREVIEW = :"gpt-4o-mini-realtime-preview"
           GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17 = :"gpt-4o-mini-realtime-preview-2024-12-17"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME_MINI = :"gpt-realtime-mini"
           GPT_REALTIME_MINI_2025_10_06 = :"gpt-realtime-mini-2025-10-06"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME_MINI_2025_12_15 = :"gpt-realtime-mini-2025-12-15"
           GPT_AUDIO_1_5 = :"gpt-audio-1.5"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_AUDIO_MINI = :"gpt-audio-mini"
           GPT_AUDIO_MINI_2025_10_06 = :"gpt-audio-mini-2025-10-06"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
 
           # @!endgroup

data/lib/openai/models/realtime/realtime_session_create_request.rb

@@ -332,11 +332,17 @@ module OpenAI
 
           # @!group
 
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME = :"gpt-realtime"
           GPT_REALTIME_1_5 = :"gpt-realtime-1.5"
           GPT_REALTIME_2 = :"gpt-realtime-2"
           GPT_REALTIME_2_1 = :"gpt-realtime-2.1"
           GPT_REALTIME_2_1_MINI = :"gpt-realtime-2.1-mini"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME_2025_08_28 = :"gpt-realtime-2025-08-28"
           GPT_4O_REALTIME_PREVIEW = :"gpt-4o-realtime-preview"
           GPT_4O_REALTIME_PREVIEW_2024_10_01 = :"gpt-4o-realtime-preview-2024-10-01"
@@ -344,12 +350,24 @@ module OpenAI
           GPT_4O_REALTIME_PREVIEW_2025_06_03 = :"gpt-4o-realtime-preview-2025-06-03"
           GPT_4O_MINI_REALTIME_PREVIEW = :"gpt-4o-mini-realtime-preview"
           GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17 = :"gpt-4o-mini-realtime-preview-2024-12-17"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME_MINI = :"gpt-realtime-mini"
           GPT_REALTIME_MINI_2025_10_06 = :"gpt-realtime-mini-2025-10-06"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME_MINI_2025_12_15 = :"gpt-realtime-mini-2025-12-15"
           GPT_AUDIO_1_5 = :"gpt-audio-1.5"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_AUDIO_MINI = :"gpt-audio-mini"
           GPT_AUDIO_MINI_2025_10_06 = :"gpt-audio-mini-2025-10-06"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
 
           # @!endgroup

data/lib/openai/models/realtime/realtime_session_create_response.rb

@@ -840,11 +840,17 @@ module OpenAI
 
           # @!group
 
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME = :"gpt-realtime"
           GPT_REALTIME_1_5 = :"gpt-realtime-1.5"
           GPT_REALTIME_2 = :"gpt-realtime-2"
           GPT_REALTIME_2_1 = :"gpt-realtime-2.1"
           GPT_REALTIME_2_1_MINI = :"gpt-realtime-2.1-mini"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME_2025_08_28 = :"gpt-realtime-2025-08-28"
           GPT_4O_REALTIME_PREVIEW = :"gpt-4o-realtime-preview"
           GPT_4O_REALTIME_PREVIEW_2024_10_01 = :"gpt-4o-realtime-preview-2024-10-01"
@@ -852,12 +858,24 @@ module OpenAI
           GPT_4O_REALTIME_PREVIEW_2025_06_03 = :"gpt-4o-realtime-preview-2025-06-03"
           GPT_4O_MINI_REALTIME_PREVIEW = :"gpt-4o-mini-realtime-preview"
           GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17 = :"gpt-4o-mini-realtime-preview-2024-12-17"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME_MINI = :"gpt-realtime-mini"
           GPT_REALTIME_MINI_2025_10_06 = :"gpt-realtime-mini-2025-10-06"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_REALTIME_MINI_2025_12_15 = :"gpt-realtime-mini-2025-12-15"
           GPT_AUDIO_1_5 = :"gpt-audio-1.5"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_AUDIO_MINI = :"gpt-audio-mini"
           GPT_AUDIO_MINI_2025_10_06 = :"gpt-audio-mini-2025-10-06"
+          # @deprecated Announced shutdown date: 2027-01-20. See
+          # https://developers.openai.com/api/docs/deprecations for details and recommended
+          # replacements.
           GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
 
           # @!endgroup

data/lib/openai/models/realtime/response_output_item_added_event.rb

@@ -13,7 +13,7 @@ module OpenAI
         # @!attribute item
         #   A single item within a Realtime conversation.
         #
-        #   @return [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #   @return [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest, OpenAI::Realtime::ConversationItemWithReference]
         required :item, union: -> { OpenAI::Realtime::ConversationItem }
 
         # @!attribute output_index
@@ -40,7 +40,7 @@ module OpenAI
         #   @param event_id [String]
         #     The unique ID of the server event.
         #
-        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest, OpenAI::Realtime::ConversationItemWithReference]
         #     A single item within a Realtime conversation.
         #
         #   @param output_index [Integer]

data/lib/openai/models/realtime/response_output_item_done_event.rb

@@ -13,7 +13,7 @@ module OpenAI
         # @!attribute item
         #   A single item within a Realtime conversation.
         #
-        #   @return [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #   @return [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest, OpenAI::Realtime::ConversationItemWithReference]
         required :item, union: -> { OpenAI::Realtime::ConversationItem }
 
         # @!attribute output_index
@@ -41,7 +41,7 @@ module OpenAI
         #   @param event_id [String]
         #     The unique ID of the server event.
         #
-        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest]
+        #   @param item [OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest, OpenAI::Realtime::ConversationItemWithReference]
         #     A single item within a Realtime conversation.
         #
         #   @param output_index [Integer]

data/lib/openai/models/responses/response.rb

@@ -319,6 +319,23 @@ module OpenAI
         #   @return [OpenAI::Models::Responses::ResponseTextConfig, nil]
         optional :text, -> { OpenAI::Responses::ResponseTextConfig }
 
+        # @!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::Responses::Response::ToolUsage, nil]
+        optional :tool_usage, -> { OpenAI::Responses::Response::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::Responses::Response::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
@@ -1288,6 +1319,195 @@ module OpenAI
           #   @return [Array<Symbol>]
         end
 
+        # @see OpenAI::Models::Responses::Response#tool_usage
+        class ToolUsage < OpenAI::Internal::Type::BaseModel
+          # @!attribute image_gen
+          #   Aggregated usage statistics for image generation tool calls.
+          #
+          #   @return [OpenAI::Models::Responses::Response::ToolUsage::ImageGen]
+          required :image_gen, -> { OpenAI::Responses::Response::ToolUsage::ImageGen }
+
+          # @!attribute web_search
+          #   Aggregated billable usage statistics for web search tool calls.
+          #
+          #   @return [OpenAI::Models::Responses::Response::ToolUsage::WebSearch]
+          required :web_search, -> { OpenAI::Responses::Response::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::Responses::Response::ToolUsage::ImageGen]
+          #     Aggregated usage statistics for image generation tool calls.
+          #
+          #   @param web_search [OpenAI::Models::Responses::Response::ToolUsage::WebSearch]
+          #     Aggregated billable usage statistics for web search tool calls.
+
+          # @see OpenAI::Models::Responses::Response::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::Responses::Response::ToolUsage::ImageGen::InputTokensDetails]
+            required(
+              :input_tokens_details,
+              -> { OpenAI::Responses::Response::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::Responses::Response::ToolUsage::ImageGen::CachedTokensDetails, nil]
+            optional(
+              :cached_tokens_details,
+              -> { OpenAI::Responses::Response::ToolUsage::ImageGen::CachedTokensDetails }
+            )
+
+            # @!attribute output_tokens_details
+            #   The output token details for the image generation.
+            #
+            #   @return [OpenAI::Models::Responses::Response::ToolUsage::ImageGen::OutputTokensDetails, nil]
+            optional(
+              :output_tokens_details,
+              -> { OpenAI::Responses::Response::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::Responses::Response::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::Responses::Response::ToolUsage::ImageGen::CachedTokensDetails]
+            #
+            #   @param output_tokens_details [OpenAI::Models::Responses::Response::ToolUsage::ImageGen::OutputTokensDetails]
+            #     The output token details for the image generation.
+
+            # @see OpenAI::Models::Responses::Response::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::Responses::Response::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::Responses::Response::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::Responses::Response::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/responses/response_compact_params.rb

@@ -433,6 +433,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
@@ -450,6 +453,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/responses/response_configuration_update_item.rb

@@ -22,9 +22,15 @@ module OpenAI
         #   @return [OpenAI::Models::Responses::ResponseConfigurationUpdateItem::Reasoning, nil]
         optional :reasoning, -> { OpenAI::Responses::ResponseConfigurationUpdateItem::Reasoning }
 
-        # @!method initialize(id:, 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::Responses::ResponseConfigurationUpdateItem::Text, nil]
+        optional :text, -> { OpenAI::Responses::ResponseConfigurationUpdateItem::Text }
+
+        # @!method initialize(id:, 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.
@@ -32,6 +38,9 @@ module OpenAI
         #   @param reasoning [OpenAI::Models::Responses::ResponseConfigurationUpdateItem::Reasoning]
         #     The reasoning configuration applied by this update.
         #
+        #   @param text [OpenAI::Models::Responses::ResponseConfigurationUpdateItem::Text]
+        #     The text output configuration for subsequent responses.
+        #
         #   @param type [Symbol, :configuration_update]
         #     The item type. Always `configuration_update`.
 
@@ -51,6 +60,44 @@ module OpenAI
           #     The reasoning effort used for subsequent responses until another configuration
           #     update replaces it.
         end
+
+        # @see OpenAI::Models::Responses::ResponseConfigurationUpdateItem#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::ResponseFormatText, OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig]
+          required(
+            :format_,
+            union: -> { OpenAI::Responses::ResponseConfigurationUpdateItem::Text::Format },
+            api_name: :format
+          )
+
+          # @!method initialize(format_:)
+          #   The text output configuration for subsequent responses.
+          #
+          #   @param format_ [OpenAI::Models::ResponseFormatText, OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig]
+          #     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::Responses::ResponseConfigurationUpdateItem::Text#format_
+          module Format
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Default response format. Used to generate text responses.
+            variant :text, -> { OpenAI::ResponseFormatText }
+
+            # 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::Responses::ResponseFormatTextJSONSchemaConfig }
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::ResponseFormatText, OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig)]
+          end
+        end
       end
     end
   end

data/lib/openai/models/responses/response_configuration_update_item_param.rb

@@ -22,10 +22,15 @@ module OpenAI
         #   @return [OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam::Reasoning, nil]
         optional :reasoning, -> { OpenAI::Responses::ResponseConfigurationUpdateItemParam::Reasoning }
 
-        # @!method initialize(id: 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::Responses::ResponseConfigurationUpdateItemParam::Text, nil]
+        optional :text, -> { OpenAI::Responses::ResponseConfigurationUpdateItemParam::Text }
+
+        # @!method initialize(id: 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.
@@ -33,6 +38,9 @@ module OpenAI
         #   @param reasoning [OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam::Reasoning]
         #     Updates to reasoning configuration. Only effort is supported.
         #
+        #   @param text [OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam::Text]
+        #     The text output configuration for subsequent responses.
+        #
         #   @param type [Symbol, :configuration_update]
         #     The item type. Always `configuration_update`.
 
@@ -52,6 +60,44 @@ module OpenAI
           #     The reasoning effort to use for subsequent responses until another configuration
           #     update replaces it.
         end
+
+        # @see OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam#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::ResponseFormatText, OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig]
+          required(
+            :format_,
+            union: -> { OpenAI::Responses::ResponseConfigurationUpdateItemParam::Text::Format },
+            api_name: :format
+          )
+
+          # @!method initialize(format_:)
+          #   The text output configuration for subsequent responses.
+          #
+          #   @param format_ [OpenAI::Models::ResponseFormatText, OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig]
+          #     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::Responses::ResponseConfigurationUpdateItemParam::Text#format_
+          module Format
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # Default response format. Used to generate text responses.
+            variant :text, -> { OpenAI::ResponseFormatText }
+
+            # 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::Responses::ResponseFormatTextJSONSchemaConfig }
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::ResponseFormatText, OpenAI::Models::Responses::ResponseFormatTextJSONSchemaConfig)]
+          end
+        end
       end
     end
   end

data/lib/openai/models/responses/response_input_file.rb

@@ -45,9 +45,9 @@ module OpenAI
         optional :filename, String
 
         # @!attribute prompt_cache_breakpoint
-        #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
-        #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
-        #   token block.
+        #   Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
+        #   breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
+        #   not rounded to a token block.
         #
         #   @return [OpenAI::Models::Responses::ResponseInputFile::PromptCacheBreakpoint, nil]
         optional :prompt_cache_breakpoint, -> { OpenAI::Responses::ResponseInputFile::PromptCacheBreakpoint }
@@ -75,9 +75,9 @@ module OpenAI
         #     The name of the file to be sent to the model.
         #
         #   @param prompt_cache_breakpoint [OpenAI::Models::Responses::ResponseInputFile::PromptCacheBreakpoint]
-        #     Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
-        #     from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
-        #     token block.
+        #     Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
+        #     breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
+        #     not rounded to a token block.
         #
         #   @param type [Symbol, :input_file]
         #     The type of the input item. Always `input_file`.
@@ -115,9 +115,9 @@ module OpenAI
           optional :ttl, enum: -> { OpenAI::Responses::ResponseInputFile::PromptCacheBreakpoint::Ttl }
 
           # @!method initialize(ttl: nil, mode: :explicit)
-          #   Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL
-          #   from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a
-          #   token block.
+          #   Marks the exact end of a reusable prompt prefix. When `ttl` is omitted, the
+          #   breakpoint inherits the request's `prompt_cache_options.ttl`; the boundary is
+          #   not rounded to a token block.
           #
           #   @param ttl [Symbol, OpenAI::Models::Responses::ResponseInputFile::PromptCacheBreakpoint::Ttl]
           #     The minimum lifetime of this cache breakpoint. Defaults to the request TTL.