openai 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 587849393c8641bc5b059ed67e67f4120602c00b390850aab0d1b4907b3efadb
-  data.tar.gz: bee86e5269aa8d64b4ddcda8bc8397bf00fa9ea0582b0dadd5c7b9ddb62f6d37
+  metadata.gz: 78e829792412e459c6e623de5db5f553d7d1325fa28300ae94c62103d511c946
+  data.tar.gz: e7711af3f619a26ac688445353ee83b8ca250cad3feb84358f0a556650662e0b
 SHA512:
-  metadata.gz: 51e7b1be33acdfcb0f3f2a51c3ef99dcb8e563e39eff974d14143e77576c74a6dae46a301817cd25a3179a2ea8a1d995d0bfee2169ad7798c3a2bb5e4635f6d9
-  data.tar.gz: aae8aad8f1b91ccf0d7b9b970fe43b3a04fb1a830fee1d22395ac95a74bc2940bef4279b869ccb6aa2a103f8171cd63ce2a887891b58d8ae79281477422f7ff4
+  metadata.gz: 3a6d15ee5239db7f9f8fe2494169ce279c26435bc7b83a5b8ecb2dfde47da5f6636f6db49a29f429b7fca35b58d90136d06f7de4e49677ee37fb94b899f518da
+  data.tar.gz: 1f6659074cc6e2317b47e0677a928765d9d8b73e898f7c2ee0eb435dc1fa0728df18f64859a6a732ec3beaaa1db16a5e96176eb1bdda174ac9368cccd0a243a2

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## 0.16.0 (2025-07-30)
+
+Full Changelog: [v0.15.0...v0.16.0](https://github.com/openai/openai-ruby/compare/v0.15.0...v0.16.0)
+
+### Features
+
+* add output_text method for non-streaming responses ([#757](https://github.com/openai/openai-ruby/issues/757)) ([50cf119](https://github.com/openai/openai-ruby/commit/50cf119106f9e16d9ac6a9898028b6d563a6f809))
+* **api:** manual updates ([e9fa8a0](https://github.com/openai/openai-ruby/commit/e9fa8a08d6ecebdd06212eaf6b9103082b7d67aa))
+
+
+### Bug Fixes
+
+* **internal:** ensure sorbet test always runs serially ([0601061](https://github.com/openai/openai-ruby/commit/0601061047525d16cc2afac64e5a4de0dd9de2e5))
+* provide parsed outputs for resumed streams ([#756](https://github.com/openai/openai-ruby/issues/756)) ([82254f9](https://github.com/openai/openai-ruby/commit/82254f980ccc0affa2555a81b0d8ed5aa0290835))
+* union definition re-using ([#760](https://github.com/openai/openai-ruby/issues/760)) ([3046c28](https://github.com/openai/openai-ruby/commit/3046c28935ca925c2f399f0350937d04eab54c0a))
+
+
+### Chores
+
+* extract reused JSON schema references even in unions ([#761](https://github.com/openai/openai-ruby/issues/761)) ([e17d3bf](https://github.com/openai/openai-ruby/commit/e17d3bf1fdf241f7a78ed72a39ddecabeb5877c8))
+* **internal:** refactor variable name ([#762](https://github.com/openai/openai-ruby/issues/762)) ([7e15b07](https://github.com/openai/openai-ruby/commit/7e15b0745dcbd3bf7fc4c1899d9d76e0a9ab1e48))
+* update contribute.md ([b4a0297](https://github.com/openai/openai-ruby/commit/b4a029775bb52d5db2f3fac235595f37b6746a61))
+
+## 0.15.0 (2025-07-21)
+
+Full Changelog: [v0.14.0...v0.15.0](https://github.com/openai/openai-ruby/compare/v0.14.0...v0.15.0)
+
+### Features
+
+* **api:** manual updates ([fb53071](https://github.com/openai/openai-ruby/commit/fb530713d08a4ba49e8bdaecd9848674bb35c333))
+
+
+### Bug Fixes
+
+* **internal:** tests should use normalized property names ([801e9c2](https://github.com/openai/openai-ruby/commit/801e9c29f65e572a3b49f5cf7891d3053e1d087f))
+
+
+### Chores
+
+* **api:** event shapes more accurate ([29f32ce](https://github.com/openai/openai-ruby/commit/29f32cedf6112d38fe8de454658a5afd7ad0d2cb))
+
 ## 0.14.0 (2025-07-16)
 
 Full Changelog: [v0.13.1...v0.14.0](https://github.com/openai/openai-ruby/compare/v0.13.1...v0.14.0)

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.14.0"
+gem "openai", "~> 0.16.0"
 ```
 
 <!-- x-release-please-end -->
@@ -443,7 +443,7 @@ You can provide typesafe request parameters like so:
 
 ```ruby
 openai.chat.completions.create(
-  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
+  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 ```
@@ -459,7 +459,7 @@ openai.chat.completions.create(
 
 # You can also splat a full Params class:
 params = OpenAI::Chat::CompletionCreateParams.new(
-  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
+  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 openai.chat.completions.create(**params)

data/lib/openai/helpers/structured_output/json_schema_converter.rb

@@ -6,15 +6,9 @@ module OpenAI
       # To customize the JSON schema conversion for a type, implement the `JsonSchemaConverter` interface.
       module JsonSchemaConverter
         # @api private
-        POINTER = Object.new.tap do
+        POINTERS = Object.new.tap do
           _1.define_singleton_method(:inspect) do
-            "#<#{OpenAI::Helpers::StructuredOutput::JsonSchemaConverter}::POINTER>"
-          end
-        end.freeze
-        # @api private
-        COUNTER = Object.new.tap do
-          _1.define_singleton_method(:inspect) do
-            "#<#{OpenAI::Helpers::StructuredOutput::JsonSchemaConverter}::COUNTER>"
+            "#<#{OpenAI::Helpers::StructuredOutput::JsonSchemaConverter}::POINTERS>"
           end
         end.freeze
         # @api private
@@ -81,14 +75,15 @@ module OpenAI
           def cache_def!(state, type:, &blk)
             defs, path = state.fetch_values(:defs, :path)
             if (stored = defs[type])
-              stored[OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::COUNTER] += 1
-              stored.fetch(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTER)
+              pointers = stored.fetch(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTERS)
+              pointers.first.except(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::NO_REF).tap do
+                pointers << _1
+              end
             else
               ref_path = String.new
               ref = {"$ref": ref_path}
               stored = {
-                OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTER => ref,
-                OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::COUNTER => 1
+                OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTERS => [ref]
               }
               defs.store(type, stored)
               schema = blk.call
@@ -112,17 +107,21 @@ module OpenAI
             )
             reused_defs = {}
             defs.each_value do |acc|
-              ref = acc.fetch(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTER)
-              if (no_ref = ref.delete(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::NO_REF))
-                acc[OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::COUNTER] -= 1
+              sch = acc.except(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTERS)
+              pointers = acc.fetch(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTERS)
+
+              no_refs, refs = pointers.partition do
+                _1.delete(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::NO_REF)
               end
-              cnt = acc.fetch(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::COUNTER)
 
-              sch = acc.except(
-                OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTER,
-                OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::COUNTER
-              )
-              cnt > 1 && !no_ref ? reused_defs.store(ref.fetch(:$ref), sch) : ref.replace(sch)
+              case refs
+              in [ref]
+                ref.replace(sch)
+              in [_, ref, *]
+                reused_defs.store(ref.fetch(:$ref), sch)
+              else
+              end
+              no_refs.each { _1.replace(sch) }
             end
 
             xformed = reused_defs.transform_keys { _1.delete_prefix("#/$defs/") }

data/lib/openai/helpers/structured_output/union_of.rb

@@ -36,7 +36,17 @@ module OpenAI
               mergeable_keys.each_key { mergeable_keys[_1] += 1 if schema.keys == _1 }
             end
             mergeable = mergeable_keys.any? { _1.last == schemas.length }
-            mergeable ? OpenAI::Internal::Util.deep_merge(*schemas, concat: true) : {anyOf: schemas}
+            if mergeable
+              OpenAI::Internal::Util.deep_merge(*schemas, concat: true)
+            else
+              {
+                anyOf: schemas.each do
+                  if _1.key?(:$ref)
+                    _1.update(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::NO_REF => true)
+                  end
+                end
+              }
+            end
           end
         end
 

data/lib/openai/models/audio/speech_create_params.rb

@@ -111,12 +111,6 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::ECHO }
 
-          variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::FABLE }
-
-          variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::ONYX }
-
-          variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::NOVA }
-
           variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::SAGE }
 
           variant const: -> { OpenAI::Models::Audio::SpeechCreateParams::Voice::SHIMMER }
@@ -137,9 +131,6 @@ module OpenAI
           BALLAD = :ballad
           CORAL = :coral
           ECHO = :echo
-          FABLE = :fable
-          ONYX = :onyx
-          NOVA = :nova
           SAGE = :sage
           SHIMMER = :shimmer
           VERSE = :verse

data/lib/openai/models/chat/chat_completion.rb

@@ -44,7 +44,7 @@ module OpenAI
         #   - If set to 'auto', then the request will be processed with the service tier
         #     configured in the Project settings. Unless otherwise configured, the Project
         #     will use 'default'.
-        #   - If set to 'default', then the requset will be processed with the standard
+        #   - If set to 'default', then the request will be processed with the standard
         #     pricing and performance for the selected model.
         #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #     'priority', then the request will be processed with the corresponding service
@@ -193,7 +193,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/lib/openai/models/chat/chat_completion_audio_param.rb

@@ -67,12 +67,6 @@ module OpenAI
 
           variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::ECHO }
 
-          variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::FABLE }
-
-          variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::ONYX }
-
-          variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::NOVA }
-
           variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::SAGE }
 
           variant const: -> { OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::SHIMMER }
@@ -93,9 +87,6 @@ module OpenAI
           BALLAD = :ballad
           CORAL = :coral
           ECHO = :echo
-          FABLE = :fable
-          ONYX = :onyx
-          NOVA = :nova
           SAGE = :sage
           SHIMMER = :shimmer
           VERSE = :verse

data/lib/openai/models/chat/chat_completion_chunk.rb

@@ -43,7 +43,7 @@ module OpenAI
         #   - If set to 'auto', then the request will be processed with the service tier
         #     configured in the Project settings. Unless otherwise configured, the Project
         #     will use 'default'.
-        #   - If set to 'default', then the requset will be processed with the standard
+        #   - If set to 'default', then the request will be processed with the standard
         #     pricing and performance for the selected model.
         #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #     'priority', then the request will be processed with the corresponding service
@@ -376,7 +376,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/lib/openai/models/chat/chat_completion_store_message.rb

@@ -10,10 +10,41 @@ module OpenAI
         #   @return [String]
         required :id, String
 
-        # @!method initialize(id:)
+        # @!attribute content_parts
+        #   If a content parts array was provided, this is an array of `text` and
+        #   `image_url` parts. Otherwise, null.
+        #
+        #   @return [Array<OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartImage>, nil]
+        optional :content_parts,
+                 -> {
+                   OpenAI::Internal::Type::ArrayOf[union: OpenAI::Chat::ChatCompletionStoreMessage::ContentPart]
+                 },
+                 nil?: true
+
+        # @!method initialize(id:, content_parts: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Chat::ChatCompletionStoreMessage} for more details.
+        #
         #   A chat completion message generated by the model.
         #
         #   @param id [String] The identifier of the chat message.
+        #
+        #   @param content_parts [Array<OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartImage>, nil] If a content parts array was provided, this is an array of `text` and `image_url
+
+        # Learn about
+        # [text inputs](https://platform.openai.com/docs/guides/text-generation).
+        module ContentPart
+          extend OpenAI::Internal::Type::Union
+
+          # Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation).
+          variant -> { OpenAI::Chat::ChatCompletionContentPartText }
+
+          # Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
+          variant -> { OpenAI::Chat::ChatCompletionContentPartImage }
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartImage)]
+        end
       end
     end
 

data/lib/openai/models/chat/completion_create_params.rb

@@ -182,6 +182,14 @@ module OpenAI
         #   @return [Float, nil]
         optional :presence_penalty, Float, nil?: true
 
+        # @!attribute prompt_cache_key
+        #   Used by OpenAI to cache responses for similar requests to optimize your cache
+        #   hit rates. Replaces the `user` field.
+        #   [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+        #
+        #   @return [String, nil]
+        optional :prompt_cache_key, String
+
         # @!attribute reasoning_effort
         #   **o-series models only**
         #
@@ -208,6 +216,16 @@ module OpenAI
         #   @return [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::ResponseFormatJSONObject, nil]
         optional :response_format, union: -> { OpenAI::Chat::CompletionCreateParams::ResponseFormat }
 
+        # @!attribute safety_identifier
+        #   A stable identifier used to help detect users of your application that may be
+        #   violating OpenAI's usage policies. The IDs should be a string that uniquely
+        #   identifies each user. We recommend hashing their username or email address, in
+        #   order to avoid sending us any identifying information.
+        #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+        #
+        #   @return [String, nil]
+        optional :safety_identifier, String
+
         # @!attribute seed
         #   This feature is in Beta. If specified, our system will make a best effort to
         #   sample deterministically, such that repeated requests with the same `seed` and
@@ -224,7 +242,7 @@ module OpenAI
         #   - If set to 'auto', then the request will be processed with the service tier
         #     configured in the Project settings. Unless otherwise configured, the Project
         #     will use 'default'.
-        #   - If set to 'default', then the requset will be processed with the standard
+        #   - If set to 'default', then the request will be processed with the standard
         #     pricing and performance for the selected model.
         #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #     'priority', then the request will be processed with the corresponding service
@@ -320,9 +338,13 @@ module OpenAI
         optional :top_p, Float, nil?: true
 
         # @!attribute user
-        #   A stable identifier for your end-users. Used to boost cache hit rates by better
-        #   bucketing similar requests and to help OpenAI detect and prevent abuse.
-        #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+        #   @deprecated
+        #
+        #   This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+        #   `prompt_cache_key` instead to maintain caching optimizations. A stable
+        #   identifier for your end-users. Used to boost cache hit rates by better bucketing
+        #   similar requests and to help OpenAI detect and prevent abuse.
+        #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
         #
         #   @return [String, nil]
         optional :user, String
@@ -335,7 +357,7 @@ module OpenAI
         #   @return [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions, nil]
         optional :web_search_options, -> { OpenAI::Chat::CompletionCreateParams::WebSearchOptions }
 
-        # @!method initialize(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, reasoning_effort: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, web_search_options: nil, request_options: {})
+        # @!method initialize(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, prompt_cache_key: nil, reasoning_effort: nil, response_format: nil, safety_identifier: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, web_search_options: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Chat::CompletionCreateParams} for more details.
         #
@@ -371,10 +393,14 @@ module OpenAI
         #
         #   @param presence_penalty [Float, nil] Number between -2.0 and 2.0. Positive values penalize new tokens based on
         #
+        #   @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+        #
         #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] **o-series models only**
         #
         #   @param response_format [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::ResponseFormatJSONObject] An object specifying the format that the model must output.
         #
+        #   @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+        #
         #   @param seed [Integer, nil] This feature is in Beta.
         #
         #   @param service_tier [Symbol, OpenAI::Models::Chat::CompletionCreateParams::ServiceTier, nil] Specifies the processing type used for serving the request.
@@ -395,7 +421,7 @@ module OpenAI
         #
         #   @param top_p [Float, nil] An alternative to sampling with temperature, called nucleus sampling,
         #
-        #   @param user [String] A stable identifier for your end-users.
+        #   @param user [String] This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
         #
         #   @param web_search_options [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions] This tool searches the web for relevant results to use in a response.
         #
@@ -553,7 +579,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

data/lib/openai/models/function_definition.rb

@@ -34,7 +34,7 @@ module OpenAI
       #   set to true, the model will follow the exact schema defined in the `parameters`
       #   field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn
       #   more about Structured Outputs in the
-      #   [function calling guide](docs/guides/function-calling).
+      #   [function calling guide](https://platform.openai.com/docs/guides/function-calling).
       #
       #   @return [Boolean, nil]
       optional :strict, OpenAI::Internal::Type::Boolean, nil?: true

data/lib/openai/models/image_edit_params.rb

@@ -4,7 +4,7 @@ module OpenAI
   module Models
     # @see OpenAI::Resources::Images#edit
     #
-    # @see OpenAI::Resources::Images#stream_raw
+    # @see OpenAI::Resources::Images#edit_stream_raw
     class ImageEditParams < OpenAI::Internal::Type::BaseModel
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
@@ -92,6 +92,9 @@ module OpenAI
       #   responses that return partial images. Value must be between 0 and 3. When set to
       #   0, the response will be a single image sent in one streaming event.
       #
+      #   Note that the final image may be sent before the full number of partial images
+      #   are generated if the full image is generated more quickly.
+      #
       #   @return [Integer, nil]
       optional :partial_images, Integer, nil?: true
 

data/lib/openai/models/image_generate_params.rb

@@ -4,7 +4,7 @@ module OpenAI
   module Models
     # @see OpenAI::Resources::Images#generate
     #
-    # @see OpenAI::Resources::Images#stream_raw
+    # @see OpenAI::Resources::Images#generate_stream_raw
     class ImageGenerateParams < OpenAI::Internal::Type::BaseModel
       extend OpenAI::Internal::Type::RequestParameters::Converter
       include OpenAI::Internal::Type::RequestParameters
@@ -71,6 +71,9 @@ module OpenAI
       #   responses that return partial images. Value must be between 0 and 3. When set to
       #   0, the response will be a single image sent in one streaming event.
       #
+      #   Note that the final image may be sent before the full number of partial images
+      #   are generated if the full image is generated more quickly.
+      #
       #   @return [Integer, nil]
       optional :partial_images, Integer, nil?: true
 

data/lib/openai/models/images_response.rb

@@ -140,7 +140,7 @@ module OpenAI
         required :input_tokens_details, -> { OpenAI::ImagesResponse::Usage::InputTokensDetails }
 
         # @!attribute output_tokens
-        #   The number of image tokens in the output image.
+        #   The number of output tokens generated by the model.
         #
         #   @return [Integer]
         required :output_tokens, Integer
@@ -152,16 +152,13 @@ module OpenAI
         required :total_tokens, Integer
 
         # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, total_tokens:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::ImagesResponse::Usage} for more details.
-        #
         #   For `gpt-image-1` only, the token usage information for the image generation.
         #
         #   @param input_tokens [Integer] The number of tokens (images and text) in the input prompt.
         #
         #   @param input_tokens_details [OpenAI::Models::ImagesResponse::Usage::InputTokensDetails] The input tokens detailed information for the image generation.
         #
-        #   @param output_tokens [Integer] The number of image tokens in the output image.
+        #   @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.
 

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

@@ -171,6 +171,14 @@ module OpenAI
         #   @return [OpenAI::Models::Responses::ResponsePrompt, nil]
         optional :prompt, -> { OpenAI::Responses::ResponsePrompt }, nil?: true
 
+        # @!attribute prompt_cache_key
+        #   Used by OpenAI to cache responses for similar requests to optimize your cache
+        #   hit rates. Replaces the `user` field.
+        #   [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+        #
+        #   @return [String, nil]
+        optional :prompt_cache_key, String
+
         # @!attribute reasoning
         #   **o-series models only**
         #
@@ -180,13 +188,23 @@ module OpenAI
         #   @return [OpenAI::Models::Reasoning, nil]
         optional :reasoning, -> { OpenAI::Reasoning }, nil?: true
 
+        # @!attribute safety_identifier
+        #   A stable identifier used to help detect users of your application that may be
+        #   violating OpenAI's usage policies. The IDs should be a string that uniquely
+        #   identifies each user. We recommend hashing their username or email address, in
+        #   order to avoid sending us any identifying information.
+        #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+        #
+        #   @return [String, nil]
+        optional :safety_identifier, String
+
         # @!attribute service_tier
         #   Specifies the processing type used for serving the request.
         #
         #   - If set to 'auto', then the request will be processed with the service tier
         #     configured in the Project settings. Unless otherwise configured, the Project
         #     will use 'default'.
-        #   - If set to 'default', then the requset will be processed with the standard
+        #   - If set to 'default', then the request will be processed with the standard
         #     pricing and performance for the selected model.
         #   - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #     'priority', then the request will be processed with the corresponding service
@@ -246,13 +264,37 @@ module OpenAI
         optional :usage, -> { OpenAI::Responses::ResponseUsage }
 
         # @!attribute user
-        #   A stable identifier for your end-users. Used to boost cache hit rates by better
-        #   bucketing similar requests and to help OpenAI detect and prevent abuse.
-        #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+        #   @deprecated
+        #
+        #   This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+        #   `prompt_cache_key` instead to maintain caching optimizations. A stable
+        #   identifier for your end-users. Used to boost cache hit rates by better bucketing
+        #   similar requests and to help OpenAI detect and prevent abuse.
+        #   [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
         #
         #   @return [String, nil]
         optional :user, String
 
+        # Convenience property that aggregates all `output_text` items from the `output` list.
+        #
+        # If no `output_text` content blocks exist, then an empty string is returned.
+        #
+        # @return [String]
+        def output_text
+          texts = []
+
+          output.each do |item|
+            next unless item.type == :message
+            item.content.each do |content|
+              if content.type == :output_text
+                texts << content.text
+              end
+            end
+          end
+
+          texts.join
+        end
+
         # @!method initialize(id:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, max_output_tokens: nil, max_tool_calls: nil, previous_response_id: nil, prompt: nil, reasoning: nil, service_tier: nil, status: nil, text: nil, top_logprobs: nil, truncation: nil, usage: nil, user: nil, object: :response)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::Response} for more details.
@@ -293,8 +335,12 @@ module OpenAI
         #
         #   @param prompt [OpenAI::Models::Responses::ResponsePrompt, nil] Reference to a prompt template and its variables.
         #
+        #   @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
+        #
         #   @param reasoning [OpenAI::Models::Reasoning, nil] **o-series models only**
         #
+        #   @param safety_identifier [String] A stable identifier used to help detect users of your application that may be vi
+        #
         #   @param service_tier [Symbol, OpenAI::Models::Responses::Response::ServiceTier, nil] Specifies the processing type used for serving the request.
         #
         #   @param status [Symbol, OpenAI::Models::Responses::ResponseStatus] The status of the response generation. One of `completed`, `failed`,
@@ -307,7 +353,7 @@ module OpenAI
         #
         #   @param usage [OpenAI::Models::Responses::ResponseUsage] Represents token usage details including input tokens, output tokens,
         #
-        #   @param user [String] A stable identifier for your end-users.
+        #   @param user [String] This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
         #
         #   @param object [Symbol, :response] The object type of this resource - always set to `response`.
 
@@ -401,7 +447,7 @@ module OpenAI
         # - If set to 'auto', then the request will be processed with the service tier
         #   configured in the Project settings. Unless otherwise configured, the Project
         #   will use 'default'.
-        # - If set to 'default', then the requset will be processed with the standard
+        # - If set to 'default', then the request will be processed with the standard
         #   pricing and performance for the selected model.
         # - If set to '[flex](https://platform.openai.com/docs/guides/flex-processing)' or
         #   'priority', then the request will be processed with the corresponding service

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

@@ -34,7 +34,8 @@ module OpenAI
                  nil?: true
 
         # @!attribute status
-        #   The status of the code interpreter tool call.
+        #   The status of the code interpreter tool call. Valid values are `in_progress`,
+        #   `completed`, `incomplete`, `interpreting`, and `failed`.
         #
         #   @return [Symbol, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Status]
         required :status, enum: -> { OpenAI::Responses::ResponseCodeInterpreterToolCall::Status }
@@ -59,7 +60,7 @@ module OpenAI
         #
         #   @param outputs [Array<OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Output::Logs, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Output::Image>, nil] The outputs generated by the code interpreter, such as logs or images.
         #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Status] The status of the code interpreter tool call.
+        #   @param status [Symbol, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Status] The status of the code interpreter tool call. Valid values are `in_progress`, `c
         #
         #   @param type [Symbol, :code_interpreter_call] The type of the code interpreter tool call. Always `code_interpreter_call`.
 
@@ -121,7 +122,8 @@ module OpenAI
           #   @return [Array(OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Output::Logs, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall::Output::Image)]
         end
 
-        # The status of the code interpreter tool call.
+        # The status of the code interpreter tool call. Valid values are `in_progress`,
+        # `completed`, `incomplete`, `interpreting`, and `failed`.
         #
         # @see OpenAI::Models::Responses::ResponseCodeInterpreterToolCall#status
         module Status