openai 0.118.0 → 0.120.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e37e3fb7c53769a3fb7bbe6a79b7c3f5d4b9d5c3d5f13fb6c5317f489019086a
-  data.tar.gz: c9d804e63b8ff116a72bbc6c471ad398c303d7373af5fba01aa5bba7c3996297
+  metadata.gz: 9b74591c6b8e30d6e7eca63fbc88dd793ae02202cecb6d702dad6f64822ae0ab
+  data.tar.gz: 9fbcf7d70ec1521ab062a9b556154203933b1bd1aa161277b1f2d00bdbfe0efa
 SHA512:
-  metadata.gz: d991c961da46c6b12a857e0412afc71177ecef975a7b09a5ccfa93235678621a94d2c53614844f8e05f8f5194afbd24d39a11fa7d1c2558ab104e8e0fcb30a31
-  data.tar.gz: 9e9bf4dfd8ad78e2f2fda579f962cb105047c4b443bb81e88c19b61c7ed900260a4d31c85cc781a4e3005ad2c23c7c733c4e6eb37d4a110c6a524938bc08f53d
+  metadata.gz: 1370128e59bcd5e0249a94c1236ce20da128e74ec94777dfc8b0f9f74642e08e77fcfefdaa6c3b0141923550ef109fe8b5288cb06289d9015a681ea36bb9ae13
+  data.tar.gz: 693b68d2fa4d778f6d18485bf32b501596780d2dfb7fd9fead819a255a6e4a52b5997b37ad1f1d099a91a6acd6ef25ea8bb4cc13fc54d939b980b3f33bc778f2

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [0.120.0](https://github.com/openai/openai-ruby/compare/v0.119.0...v0.120.0) (2026-11-05)
+
+
+### Features
+
+* **api:** add a model option for Responses ([#1040](https://github.com/openai/openai-ruby/issues/1040)) ([54b9096](https://github.com/openai/openai-ruby/commit/54b9096aa813460ad5f6cd81b807386b2da7b50a))
+
+
+### Chores
+
+* **deps:** bump the codeql group with 2 updates ([#1035](https://github.com/openai/openai-ruby/issues/1035)) ([b39ac63](https://github.com/openai/openai-ruby/commit/b39ac637da1d0bf30cf119e799b523e990ecada1))
+* **deps:** bump the codeql group with 2 updates ([#1039](https://github.com/openai/openai-ruby/issues/1039)) ([402375e](https://github.com/openai/openai-ruby/commit/402375ee11d8c47a5ab5dac356d1e7017249f26c))
+
+## [0.119.0](https://github.com/openai/openai-ruby/compare/v0.118.0...v0.119.0) (2026-11-05)
+
+
+### Features
+
+* **api:** add Australia, India, and Japan residency options ([#1036](https://github.com/openai/openai-ruby/issues/1036)) ([643e5ca](https://github.com/openai/openai-ruby/commit/643e5ca4b4f80b1f6fde36e558216577df6ebfa1))
+* **api:** add GPT-6 Rosalind to the model catalog ([#1032](https://github.com/openai/openai-ruby/issues/1032)) ([8656953](https://github.com/openai/openai-ruby/commit/86569535a607f6492b990bdb3ac5fcda9202afd9))
+* **api:** add image complexity and GIF and SVG output controls ([#1037](https://github.com/openai/openai-ruby/issues/1037)) ([228e36a](https://github.com/openai/openai-ruby/commit/228e36acebfba78d722282dc1dc3afd514283c5c))
+* **api:** expand agent turn errors and image and audio options ([#1033](https://github.com/openai/openai-ruby/issues/1033)) ([2f3c069](https://github.com/openai/openai-ruby/commit/2f3c06928494d2b2ec8c5e58c7e3d7966439ab3f))
+
 ## [0.118.0](https://github.com/openai/openai-ruby/compare/v0.117.0...v0.118.0) (2026-11-03)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.118.0"
+gem "openai", "~> 0.120.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/openai/client.rb

@@ -206,7 +206,7 @@ module OpenAI
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["OPENAI_BASE_URL"]`
     #
-    # @param data_residency [Symbol, String, nil] Select `global`, `us`, `eu`, `ae`.
+    # @param data_residency [Symbol, String, nil] Select `global`, `us`, `eu`, `ae`, `au`, `in`, `jp`.
     #   Mutually exclusive with an explicit `base_url` or `provider`.
     #   This selects an endpoint; project and model eligibility still apply.
     #

data/lib/openai/helpers/data_residency.rb

@@ -9,7 +9,10 @@ module OpenAI
         "global" => "https://api.openai.com/v1",
         "us" => "https://us.api.openai.com/v1",
         "eu" => "https://eu.api.openai.com/v1",
-        "ae" => "https://ae.api.openai.com/v1"
+        "ae" => "https://ae.api.openai.com/v1",
+        "au" => "https://au.api.openai.com/v1",
+        "in" => "https://in.api.openai.com/v1",
+        "jp" => "https://jp.api.openai.com/v1"
       }.freeze
 
       class << self

data/lib/openai/models/all_models.rb

@@ -75,7 +75,9 @@ module OpenAI
         GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
         GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
         GPT_5_6_CYBER = :"gpt-5.6-cyber"
+        GPT_6_CYBER = :"gpt-6-cyber"
         GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
+        GPT_6_ROSALIND = :"gpt-6-rosalind"
 
         # @!method self.values
         #   @return [Array<Symbol>]

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

@@ -37,7 +37,12 @@ module OpenAI
         #   @return [OpenAI::Models::Beta::BetaResponseUsage]
         required :usage, -> { OpenAI::Beta::BetaResponseUsage }
 
-        # @!method initialize(id:, created_at:, output:, usage:, object: :"response.compaction")
+        # @!attribute image
+        #
+        #   @return [OpenAI::Models::Beta::BetaCompactedResponse::Image, nil]
+        optional :image, -> { OpenAI::Beta::BetaCompactedResponse::Image }
+
+        # @!method initialize(id:, created_at:, output:, usage:, image: nil, object: :"response.compaction")
         #   @param id [String]
         #     The unique identifier for the compacted response.
         #
@@ -52,8 +57,36 @@ module OpenAI
         #     Token accounting for the compaction pass, including cached, reasoning, and total
         #     tokens.
         #
+        #   @param image [OpenAI::Models::Beta::BetaCompactedResponse::Image]
+        #
         #   @param object [Symbol, :"response.compaction"]
         #     The object type. Always `response.compaction`.
+
+        # @see OpenAI::Models::Beta::BetaCompactedResponse#image
+        class Image < OpenAI::Internal::Type::BaseModel
+          # @!attribute context_compression
+          #   Effective image context optimization policy.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaCompactedResponse::Image::ContextCompression]
+          required :context_compression, enum: -> { OpenAI::Beta::BetaCompactedResponse::Image::ContextCompression }
+
+          # @!method initialize(context_compression:)
+          #   @param context_compression [Symbol, OpenAI::Models::Beta::BetaCompactedResponse::Image::ContextCompression]
+          #     Effective image context optimization policy.
+
+          # Effective image context optimization policy.
+          #
+          # @see OpenAI::Models::Beta::BetaCompactedResponse::Image#context_compression
+          module ContextCompression
+            extend OpenAI::Internal::Type::Enum
+
+            ENABLED = :enabled
+            DISABLED = :disabled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
     end
 

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

@@ -164,6 +164,11 @@ module OpenAI
         #   @return [OpenAI::Models::Beta::BetaResponse::Conversation, nil]
         optional :conversation, -> { OpenAI::Beta::BetaResponse::Conversation }, nil?: true
 
+        # @!attribute image
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponse::Image, nil]
+        optional :image, -> { OpenAI::Beta::BetaResponse::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::Beta::BetaResponse::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
@@ -943,6 +950,8 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_5_6_CYBER }
 
+          variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_6_CYBER }
+
           variant const: -> { OpenAI::Models::Beta::BetaResponse::Model::GPT_ROSALIND_RESEARCH }
 
           variant String
@@ -1324,6 +1333,7 @@ module OpenAI
           GPT_DAYBREAK_BLUE_LATEST = :"gpt-daybreak-blue-latest"
           GPT_DAYBREAK_RED_LATEST = :"gpt-daybreak-red-latest"
           GPT_5_6_CYBER = :"gpt-5.6-cyber"
+          GPT_6_CYBER = :"gpt-6-cyber"
           GPT_ROSALIND_RESEARCH = :"gpt-rosalind-research"
 
           # @!endgroup
@@ -1403,6 +1413,32 @@ module OpenAI
           #     The unique ID of the conversation that this response was associated with.
         end
 
+        # @see OpenAI::Models::Beta::BetaResponse#image
+        class Image < OpenAI::Internal::Type::BaseModel
+          # @!attribute context_compression
+          #   Effective image context optimization policy.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::BetaResponse::Image::ContextCompression]
+          required :context_compression, enum: -> { OpenAI::Beta::BetaResponse::Image::ContextCompression }
+
+          # @!method initialize(context_compression:)
+          #   @param context_compression [Symbol, OpenAI::Models::Beta::BetaResponse::Image::ContextCompression]
+          #     Effective image context optimization policy.
+
+          # Effective image context optimization policy.
+          #
+          # @see OpenAI::Models::Beta::BetaResponse::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::Beta::BetaResponse#moderation
         class Moderation < OpenAI::Internal::Type::BaseModel
           # @!attribute input

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

@@ -1366,7 +1366,12 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(id:, result:, status:, action: nil, agent: 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::Beta::BetaResponseInputItem::ImageGenerationCall::SvgUsage, nil]
+          optional :svg_usage, -> { OpenAI::Beta::BetaResponseInputItem::ImageGenerationCall::SvgUsage }
+
+          # @!method initialize(id:, result:, status:, action: nil, agent: 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]
@@ -1403,6 +1408,8 @@ module OpenAI
           #   @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
+          #   @param svg_usage [OpenAI::Models::Beta::BetaResponseInputItem::ImageGenerationCall::SvgUsage]
+          #
           #   @param type [Symbol, :image_generation_call]
           #     The type of the image generation call. Always `image_generation_call`.
 
@@ -1570,6 +1577,8 @@ module OpenAI
             PNG = :png
             WEBP = :webp
             JPEG = :jpeg
+            GIF = :gif
+            SVG = :svg
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -1630,6 +1639,41 @@ module OpenAI
 
             # @!endgroup
           end
+
+          # @see OpenAI::Models::Beta::BetaResponseInputItem::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/beta/beta_response_item.rb

@@ -946,7 +946,12 @@ module OpenAI
           #   @return [String, Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size, nil]
           optional :size, union: -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::Size }, nil?: true
 
-          # @!method initialize(id:, result:, status:, action: nil, agent: 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::Beta::BetaResponseItem::ImageGenerationCall::SvgUsage, nil]
+          optional :svg_usage, -> { OpenAI::Beta::BetaResponseItem::ImageGenerationCall::SvgUsage }
+
+          # @!method initialize(id:, result:, status:, action: nil, agent: 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]
@@ -983,6 +988,8 @@ module OpenAI
           #   @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
+          #   @param svg_usage [OpenAI::Models::Beta::BetaResponseItem::ImageGenerationCall::SvgUsage]
+          #
           #   @param type [Symbol, :image_generation_call]
           #     The type of the image generation call. Always `image_generation_call`.
 
@@ -1150,6 +1157,8 @@ module OpenAI
             PNG = :png
             WEBP = :webp
             JPEG = :jpeg
+            GIF = :gif
+            SVG = :svg
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -1202,6 +1211,41 @@ module OpenAI
 
             # @!endgroup
           end
+
+          # @see OpenAI::Models::Beta::BetaResponseItem::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/beta/beta_response_output_item.rb

@@ -947,7 +947,12 @@ module OpenAI
             nil?: true
           )
 
-          # @!method initialize(id:, result:, status:, action: nil, agent: 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::Beta::BetaResponseOutputItem::ImageGenerationCall::SvgUsage, nil]
+          optional :svg_usage, -> { OpenAI::Beta::BetaResponseOutputItem::ImageGenerationCall::SvgUsage }
+
+          # @!method initialize(id:, result:, status:, action: nil, agent: 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]
@@ -984,6 +989,8 @@ module OpenAI
           #   @param size [String, Symbol, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::Size, nil]
           #     The image dimensions as a `WIDTHxHEIGHT` string, for example `1536x864`.
           #
+          #   @param svg_usage [OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall::SvgUsage]
+          #
           #   @param type [Symbol, :image_generation_call]
           #     The type of the image generation call. Always `image_generation_call`.
 
@@ -1151,6 +1158,8 @@ module OpenAI
             PNG = :png
             WEBP = :webp
             JPEG = :jpeg
+            GIF = :gif
+            SVG = :svg
 
             # @!method self.values
             #   @return [Array<Symbol>]
@@ -1211,6 +1220,41 @@ module OpenAI
 
             # @!endgroup
           end
+
+          # @see OpenAI::Models::Beta::BetaResponseOutputItem::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