openai 0.118.0 → 0.119.0

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

@@ -164,6 +164,11 @@ module OpenAI
         #   @return [OpenAI::Models::Responses::Response::Conversation, nil]
         optional :conversation, -> { OpenAI::Responses::Response::Conversation }, nil?: true
 
+        # @!attribute image
+        #
+        #   @return [OpenAI::Models::Responses::Response::Image, nil]
+        optional :image, -> { OpenAI::Responses::Response::Image }
+
         # @!attribute max_output_tokens
         #   An upper bound for the number of tokens that can be generated for a response,
         #   including visible output tokens and
@@ -375,7 +380,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, tool_usage: 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, image: 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.
         #
@@ -476,6 +481,8 @@ module OpenAI
         #     The conversation that this response belonged to. Input items and output items
         #     from this response were automatically added to this conversation.
         #
+        #   @param image [OpenAI::Models::Responses::Response::Image]
+        #
         #   @param max_output_tokens [Integer, nil]
         #     An upper bound for the number of tokens that can be generated for a response,
         #     including visible output tokens and
@@ -787,6 +794,32 @@ module OpenAI
           #     The unique ID of the conversation that this response was associated with.
         end
 
+        # @see OpenAI::Models::Responses::Response#image
+        class Image < OpenAI::Internal::Type::BaseModel
+          # @!attribute context_compression
+          #   Effective image context optimization policy.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::Response::Image::ContextCompression]
+          required :context_compression, enum: -> { OpenAI::Responses::Response::Image::ContextCompression }
+
+          # @!method initialize(context_compression:)
+          #   @param context_compression [Symbol, OpenAI::Models::Responses::Response::Image::ContextCompression]
+          #     Effective image context optimization policy.
+
+          # Effective image context optimization policy.
+          #
+          # @see OpenAI::Models::Responses::Response::Image#context_compression
+          module ContextCompression
+            extend OpenAI::Internal::Type::Enum
+
+            ENABLED = :enabled
+            DISABLED = :disabled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # @see OpenAI::Models::Responses::Response#moderation
         class Moderation < OpenAI::Internal::Type::BaseModel
           # @!attribute input

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

@@ -18,6 +18,12 @@ module OpenAI
         #   @return [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil]
         required :model, union: -> { OpenAI::Responses::ResponseCompactParams::Model }, nil?: true
 
+        # @!attribute image
+        #   Request level image options.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseCompactParams::Image, nil]
+        optional :image, -> { OpenAI::Responses::ResponseCompactParams::Image }
+
         # @!attribute input
         #   Text, image, or file inputs to the model, used to generate a response
         #
@@ -99,7 +105,7 @@ module OpenAI
         #   @return [Symbol, OpenAI::Models::Responses::ResponseCompactParams::ServiceTier, nil]
         optional :service_tier, enum: -> { OpenAI::Responses::ResponseCompactParams::ServiceTier }, nil?: true
 
-        # @!method initialize(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, service_tier: nil, request_options: {})
+        # @!method initialize(model:, image: nil, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, service_tier: nil, request_options: {})
         #   @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil]
         #     Model ID used to generate the response, like `gpt-6-astra`. OpenAI offers a wide
         #     range of models with different capabilities, performance characteristics, and
@@ -107,6 +113,9 @@ module OpenAI
         #     [model guide](https://developers.openai.com/api/docs/models) to browse and
         #     compare available models.
         #
+        #   @param image [OpenAI::Models::Responses::ResponseCompactParams::Image]
+        #     Request level image options.
+        #
         #   @param input [String, Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseInputItem::ToolSearchCall, OpenAI::Models::Responses::ResponseToolSearchOutputItemParam, OpenAI::Models::Responses::ResponseInputItem::AdditionalTools, OpenAI::Models::Responses::ResponseConfigurationUpdateItemParam, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseCompactionItemParam, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ShellCall, OpenAI::Models::Responses::ResponseInputItem::ShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCall, OpenAI::Models::Responses::ResponseInputItem::ApplyPatchCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::CompactionTrigger, OpenAI::Models::Responses::ResponseInputItem::ItemReference, OpenAI::Models::Responses::ResponseInputItem::Program, OpenAI::Models::Responses::ResponseInputItem::ProgramOutput>, nil]
         #     Text, image, or file inputs to the model, used to generate a response
         #
@@ -405,6 +414,8 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_ROSALIND_RESEARCH }
 
+          variant const: -> { OpenAI::Models::Responses::ResponseCompactParams::Model::GPT_6_ROSALIND }
+
           variant String
 
           # @!method self.variants
@@ -785,10 +796,48 @@ module OpenAI
           GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
           GPT_5_6_CYBER = :"gpt-5.6-cyber"
           GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
+          GPT_6_ROSALIND = :"gpt-6-rosalind"
 
           # @!endgroup
         end
 
+        class Image < OpenAI::Internal::Type::BaseModel
+          # @!attribute context_compression
+          #   Controls image context optimization. Defaults to `auto`, which uses the model,
+          #   transport, and input to select a policy. Use `enabled` to require compression
+          #   support or `disabled` to turn it off.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseCompactParams::Image::ContextCompression, nil]
+          optional(
+            :context_compression,
+            enum: -> { OpenAI::Responses::ResponseCompactParams::Image::ContextCompression }
+          )
+
+          # @!method initialize(context_compression: nil)
+          #   Request level image options.
+          #
+          #   @param context_compression [Symbol, OpenAI::Models::Responses::ResponseCompactParams::Image::ContextCompression]
+          #     Controls image context optimization. Defaults to `auto`, which uses the model,
+          #     transport, and input to select a policy. Use `enabled` to require compression
+          #     support or `disabled` to turn it off.
+
+          # Controls image context optimization. Defaults to `auto`, which uses the model,
+          # transport, and input to select a policy. Use `enabled` to require compression
+          # support or `disabled` to turn it off.
+          #
+          # @see OpenAI::Models::Responses::ResponseCompactParams::Image#context_compression
+          module ContextCompression
+            extend OpenAI::Internal::Type::Enum
+
+            AUTO = :auto
+            ENABLED = :enabled
+            DISABLED = :disabled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # Text, image, or file inputs to the model, used to generate a response
         module Input
           extend OpenAI::Internal::Type::Union

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

@@ -50,6 +50,12 @@ module OpenAI
           nil?: true
         )
 
+        # @!attribute image
+        #   Request level image options.
+        #
+        #   @return [OpenAI::Models::Responses::ResponseCreateParams::Image, nil]
+        optional :image, -> { OpenAI::Responses::ResponseCreateParams::Image }
+
         # @!attribute include
         #   Specify additional output data to include in the model response. Currently
         #   supported values are:
@@ -382,7 +388,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, 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_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
+        # @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, image: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: 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_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, request_options: {})
         #   @param access_programs [OpenAI::Models::Responses::ResponseCreateParams::AccessPrograms]
         #     Domain-specific access programs to use for this request.
         #
@@ -399,6 +405,9 @@ module OpenAI
         #     items from this response are automatically added to this conversation after this
         #     response completes.
         #
+        #   @param image [OpenAI::Models::Responses::ResponseCreateParams::Image]
+        #     Request level image options.
+        #
         #   @param include [Array<Symbol, OpenAI::Models::Responses::ResponseIncludable>, nil]
         #     Specify additional output data to include in the model response. Currently
         #     supported values are:
@@ -726,6 +735,43 @@ module OpenAI
           #   @return [Array(String, OpenAI::Models::Responses::ResponseConversationParam)]
         end
 
+        class Image < OpenAI::Internal::Type::BaseModel
+          # @!attribute context_compression
+          #   Controls image context optimization. Defaults to `auto`, which uses the model,
+          #   transport, and input to select a policy. Use `enabled` to require compression
+          #   support or `disabled` to turn it off.
+          #
+          #   @return [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Image::ContextCompression, nil]
+          optional(
+            :context_compression,
+            enum: -> { OpenAI::Responses::ResponseCreateParams::Image::ContextCompression }
+          )
+
+          # @!method initialize(context_compression: nil)
+          #   Request level image options.
+          #
+          #   @param context_compression [Symbol, OpenAI::Models::Responses::ResponseCreateParams::Image::ContextCompression]
+          #     Controls image context optimization. Defaults to `auto`, which uses the model,
+          #     transport, and input to select a policy. Use `enabled` to require compression
+          #     support or `disabled` to turn it off.
+
+          # Controls image context optimization. Defaults to `auto`, which uses the model,
+          # transport, and input to select a policy. Use `enabled` to require compression
+          # support or `disabled` to turn it off.
+          #
+          # @see OpenAI::Models::Responses::ResponseCreateParams::Image#context_compression
+          module ContextCompression
+            extend OpenAI::Internal::Type::Enum
+
+            AUTO = :auto
+            ENABLED = :enabled
+            DISABLED = :disabled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # Text, image, or file inputs to the model, used to generate a response.
         #
         # Learn more:

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

@@ -719,7 +719,12 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(id:, result:, status:, action: nil, background: nil, error: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
+          # @!attribute svg_usage
+          #
+          #   @return [OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::SvgUsage, nil]
+          optional :svg_usage, -> { OpenAI::Responses::ResponseInputItem::ImageGenerationCall::SvgUsage }
+
+          # @!method initialize(id:, result:, status:, action: nil, background: nil, error: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, svg_usage: nil, type: :image_generation_call)
           #   An image generation request made by the model.
           #
           #   @param id [String]
@@ -753,6 +758,8 @@ module OpenAI
           #   @param size [String, Symbol, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
+          #   @param svg_usage [OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall::SvgUsage]
+          #
           #   @param type [Symbol, :image_generation_call]
           #     The type of the image generation call. Always `image_generation_call`.
 
@@ -905,6 +912,8 @@ module OpenAI
             PNG = :png
             WEBP = :webp
             JPEG = :jpeg
+            GIF = :gif
+            SVG = :svg
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -965,6 +974,41 @@ module OpenAI
 
             # @!endgroup
           end
+
+          # @see OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall#svg_usage
+          class SvgUsage < OpenAI::Internal::Type::BaseModel
+            # @!attribute input_tokens
+            #
+            #   @return [Integer]
+            required :input_tokens, Integer
+
+            # @!attribute model
+            #
+            #   @return [String]
+            required :model, String
+
+            # @!attribute output_tokens
+            #
+            #   @return [Integer]
+            required :output_tokens, Integer
+
+            # @!attribute reasoning_tokens
+            #
+            #   @return [Integer]
+            required :reasoning_tokens, Integer
+
+            # @!attribute total_tokens
+            #
+            #   @return [Integer]
+            required :total_tokens, Integer
+
+            # @!method initialize(input_tokens:, model:, output_tokens:, reasoning_tokens:, total_tokens:)
+            #   @param input_tokens [Integer]
+            #   @param model [String]
+            #   @param output_tokens [Integer]
+            #   @param reasoning_tokens [Integer]
+            #   @param total_tokens [Integer]
+          end
         end
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel

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

@@ -354,7 +354,12 @@ module OpenAI
           #   @return [String, Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Size, nil]
           optional :size, union: -> { OpenAI::Responses::ResponseItem::ImageGenerationCall::Size }, nil?: true
 
-          # @!method initialize(id:, result:, status:, action: nil, background: nil, error: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
+          # @!attribute svg_usage
+          #
+          #   @return [OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::SvgUsage, nil]
+          optional :svg_usage, -> { OpenAI::Responses::ResponseItem::ImageGenerationCall::SvgUsage }
+
+          # @!method initialize(id:, result:, status:, action: nil, background: nil, error: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, svg_usage: nil, type: :image_generation_call)
           #   An image generation request made by the model.
           #
           #   @param id [String]
@@ -388,6 +393,8 @@ module OpenAI
           #   @param size [String, Symbol, OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
+          #   @param svg_usage [OpenAI::Models::Responses::ResponseItem::ImageGenerationCall::SvgUsage]
+          #
           #   @param type [Symbol, :image_generation_call]
           #     The type of the image generation call. Always `image_generation_call`.
 
@@ -540,6 +547,8 @@ module OpenAI
             PNG = :png
             WEBP = :webp
             JPEG = :jpeg
+            GIF = :gif
+            SVG = :svg
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -592,6 +601,41 @@ module OpenAI
 
             # @!endgroup
           end
+
+          # @see OpenAI::Models::Responses::ResponseItem::ImageGenerationCall#svg_usage
+          class SvgUsage < OpenAI::Internal::Type::BaseModel
+            # @!attribute input_tokens
+            #
+            #   @return [Integer]
+            required :input_tokens, Integer
+
+            # @!attribute model
+            #
+            #   @return [String]
+            required :model, String
+
+            # @!attribute output_tokens
+            #
+            #   @return [Integer]
+            required :output_tokens, Integer
+
+            # @!attribute reasoning_tokens
+            #
+            #   @return [Integer]
+            required :reasoning_tokens, Integer
+
+            # @!attribute total_tokens
+            #
+            #   @return [Integer]
+            required :total_tokens, Integer
+
+            # @!method initialize(input_tokens:, model:, output_tokens:, reasoning_tokens:, total_tokens:)
+            #   @param input_tokens [Integer]
+            #   @param model [String]
+            #   @param output_tokens [Integer]
+            #   @param reasoning_tokens [Integer]
+            #   @param total_tokens [Integer]
+          end
         end
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel

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

@@ -350,7 +350,12 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(id:, result:, status:, action: nil, background: nil, error: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, type: :image_generation_call)
+          # @!attribute svg_usage
+          #
+          #   @return [OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::SvgUsage, nil]
+          optional :svg_usage, -> { OpenAI::Responses::ResponseOutputItem::ImageGenerationCall::SvgUsage }
+
+          # @!method initialize(id:, result:, status:, action: nil, background: nil, error: nil, output_format: nil, quality: nil, revised_prompt: nil, size: nil, svg_usage: nil, type: :image_generation_call)
           #   An image generation request made by the model.
           #
           #   @param id [String]
@@ -384,6 +389,8 @@ module OpenAI
           #   @param size [String, Symbol, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
+          #   @param svg_usage [OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall::SvgUsage]
+          #
           #   @param type [Symbol, :image_generation_call]
           #     The type of the image generation call. Always `image_generation_call`.
 
@@ -536,6 +543,8 @@ module OpenAI
             PNG = :png
             WEBP = :webp
             JPEG = :jpeg
+            GIF = :gif
+            SVG = :svg
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -596,6 +605,41 @@ module OpenAI
 
             # @!endgroup
           end
+
+          # @see OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall#svg_usage
+          class SvgUsage < OpenAI::Internal::Type::BaseModel
+            # @!attribute input_tokens
+            #
+            #   @return [Integer]
+            required :input_tokens, Integer
+
+            # @!attribute model
+            #
+            #   @return [String]
+            required :model, String
+
+            # @!attribute output_tokens
+            #
+            #   @return [Integer]
+            required :output_tokens, Integer
+
+            # @!attribute reasoning_tokens
+            #
+            #   @return [Integer]
+            required :reasoning_tokens, Integer
+
+            # @!attribute total_tokens
+            #
+            #   @return [Integer]
+            required :total_tokens, Integer
+
+            # @!method initialize(input_tokens:, model:, output_tokens:, reasoning_tokens:, total_tokens:)
+            #   @param input_tokens [Integer]
+            #   @param model [String]
+            #   @param output_tokens [Integer]
+            #   @param reasoning_tokens [Integer]
+            #   @param total_tokens [Integer]
+          end
         end
 
         class LocalShellCall < OpenAI::Internal::Type::BaseModel