openai 0.58.0 → 0.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73c6650d695d8ce23e2049359d56d6d4d2ae68971afb993c362f09b2f7bcfa37
-  data.tar.gz: 7a47b51f536ab52ce437c98663f56642d67638a187cba7055be29b79185630a0
+  metadata.gz: 8a23e970e2907a5c12466a0fe422f2474e22f139cb1ef3236c28cbd7580b25b4
+  data.tar.gz: 56cbf7ddbb893e7df07214f85e564f8471c97117f0f0c59664b4970cc0d1177b
 SHA512:
-  metadata.gz: 84bf4110e464bab432883383984801d45c6cc9dc9dc40d23a8b70c1ceda3c498d7a835fb55773f9734e7f0891bf763d2fb71d213539b04993027518b158eb9ce
-  data.tar.gz: fa6a7d0c969bb6a6b70779e827cb5756e8420c21b986a313bd7d8e7d00663f6f300f75d61a51156831080f6510579a79523e2433189c356d63d9ba739f9021b7
+  metadata.gz: 13460eb99f7d27be65434cc9e46d965ee6f2a07f93b970b42eab04c1377e61d042db5efee2ddb55e7b238baf607f4485308defdf96a4301c119b96364809a423
+  data.tar.gz: 11d8b7275d1beb13c65b30722d55df7aa0c6231cd9edfb74b1d053bdf3604b78157afb713e066bff1cd9a47e1940e95d88471320086a49bc467d2d4067fb345e

data/CHANGELOG.md

@@ -1,5 +1,47 @@
 # Changelog
 
+## 0.60.0 (2026-04-28)
+
+Full Changelog: [v0.59.0...v0.60.0](https://github.com/openai/openai-ruby/compare/v0.59.0...v0.60.0)
+
+### Features
+
+* **api:** add prompt_cache_retention parameter to responses compact method ([a27cd24](https://github.com/openai/openai-ruby/commit/a27cd24ad266e52a3b3f3067158839ea570f15e1))
+* support setting headers via env ([334512e](https://github.com/openai/openai-ruby/commit/334512e35ea5f4701b1617b4268718df5fa75b12))
+
+
+### Bug Fixes
+
+* avoid gzip buffering during streaming ([ec1b1fa](https://github.com/openai/openai-ruby/commit/ec1b1fa435e2bc7f5a70b481081fc933d02ac253))
+* **types:** correct PromptCacheRetention IN_MEMORY enum value in chat/responses ([e81e954](https://github.com/openai/openai-ruby/commit/e81e9543ca20634c1e756822a6285cdc0c46d06f))
+
+
+### Chores
+
+* **ci:** remove release-doctor workflow ([0f371f5](https://github.com/openai/openai-ruby/commit/0f371f59552efd273d800570757ce61cd91b9709))
+* **internal:** more robust bootstrap script ([7bcbf5a](https://github.com/openai/openai-ruby/commit/7bcbf5aa493bb7c7f310a000735ad3ec3ae0b291))
+* **tests:** bump steady to v0.22.1 ([14594c1](https://github.com/openai/openai-ruby/commit/14594c1b3b84bf5bafc14a8c8779ea8b4507e7dc))
+
+
+### Documentation
+
+* **api:** add rate limit details to files.create documentation ([c7c9967](https://github.com/openai/openai-ruby/commit/c7c99675cd0d570d44db91a66ce8f50855a57c5d))
+* **api:** update rate limit documentation for files.create ([09e4d86](https://github.com/openai/openai-ruby/commit/09e4d86b590d0d9db32207fa9fd568bbd8025a6d))
+
+## 0.59.0 (2026-04-14)
+
+Full Changelog: [v0.58.0...v0.59.0](https://github.com/openai/openai-ruby/compare/v0.58.0...v0.59.0)
+
+### Features
+
+* **api:** Add detail to InputFileContent ([b747a16](https://github.com/openai/openai-ruby/commit/b747a16153e76eafadd54fd21a58db3f71d5e597))
+* **api:** add OAuthErrorCode type ([643311e](https://github.com/openai/openai-ruby/commit/643311e02e36e0cbd58f7ae954735e690d788db2))
+
+
+### Documentation
+
+* improve examples ([5aa2eba](https://github.com/openai/openai-ruby/commit/5aa2ebae024c57a4e577f52088dd5f86713da8f5))
+
 ## 0.58.0 (2026-04-08)
 
 Full Changelog: [v0.57.0...v0.58.0](https://github.com/openai/openai-ruby/compare/v0.57.0...v0.58.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.58.0"
+gem "openai", "~> 0.60.0"
 ```
 
 <!-- x-release-please-end -->
@@ -561,7 +561,7 @@ openai.chat.completions.create(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :"in-memory"
+# :in_memory
 puts(OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::IN_MEMORY)
 
 # Revealed type: `T.all(OpenAI::Chat::CompletionCreateParams::PromptCacheRetention, Symbol)`
@@ -579,7 +579,7 @@ openai.chat.completions.create(
 
 # Literal values are also permissible:
 openai.chat.completions.create(
-  prompt_cache_retention: :"in-memory",
+  prompt_cache_retention: :in_memory,
   # …
 )
 ```

data/lib/openai/client.rb

@@ -212,6 +212,17 @@ module OpenAI
         "openai-organization" => (@organization = organization&.to_s),
         "openai-project" => (@project = project&.to_s)
       }
+      custom_headers_env = ENV["OPENAI_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
 
       @api_key = api_key.to_s
       @webhook_secret = webhook_secret&.to_s

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

@@ -577,7 +577,7 @@ module OpenAI
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 
-          IN_MEMORY = :"in-memory"
+          IN_MEMORY = :in_memory
           PROMPT_CACHE_RETENTION_24H = :"24h"
 
           # @!method self.values

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

@@ -515,7 +515,7 @@ module OpenAI
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 
-          IN_MEMORY = :"in-memory"
+          IN_MEMORY = :in_memory
           PROMPT_CACHE_RETENTION_24H = :"24h"
 
           # @!method self.values

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

@@ -48,7 +48,15 @@ module OpenAI
         #   @return [String, nil]
         optional :prompt_cache_key, String, nil?: true
 
-        # @!method initialize(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, request_options: {})
+        # @!attribute prompt_cache_retention
+        #   How long to retain a prompt cache entry created by this request.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::ResponseCompactParams::PromptCacheRetention, nil]
+        optional :prompt_cache_retention,
+                 enum: -> { OpenAI::Responses::ResponseCompactParams::PromptCacheRetention },
+                 nil?: true
+
+        # @!method initialize(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_retention: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseCompactParams} for more details.
         #
@@ -62,6 +70,8 @@ module OpenAI
         #
         #   @param prompt_cache_key [String, nil] A key to use when reading from or writing to the prompt cache.
         #
+        #   @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCompactParams::PromptCacheRetention, nil] How long to retain a prompt cache entry created by this request.
+        #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
         # Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a
@@ -380,6 +390,17 @@ module OpenAI
           ResponseInputItemArray =
             OpenAI::Internal::Type::ArrayOf[union: -> { OpenAI::Responses::ResponseInputItem }]
         end
+
+        # How long to retain a prompt cache entry created by this request.
+        module PromptCacheRetention
+          extend OpenAI::Internal::Type::Enum
+
+          IN_MEMORY = :in_memory
+          PROMPT_CACHE_RETENTION_24H = :"24h"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

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

@@ -448,7 +448,7 @@ module OpenAI
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 
-          IN_MEMORY = :"in-memory"
+          IN_MEMORY = :in_memory
           PROMPT_CACHE_RETENTION_24H = :"24h"
 
           # @!method self.values

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

@@ -10,6 +10,14 @@ module OpenAI
         #   @return [Symbol, :input_file]
         required :type, const: :input_file
 
+        # @!attribute detail
+        #   The detail level of the file to be sent to the model. Use `low` for the default
+        #   rendering behavior, or `high` to render the file at higher quality. Defaults to
+        #   `low`.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::ResponseInputFile::Detail, nil]
+        optional :detail, enum: -> { OpenAI::Responses::ResponseInputFile::Detail }
+
         # @!attribute file_data
         #   The content of the file to be sent to the model.
         #
@@ -34,12 +42,14 @@ module OpenAI
         #   @return [String, nil]
         optional :filename, String
 
-        # @!method initialize(file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
+        # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::ResponseInputFile} for more details.
         #
         #   A file input to the model.
         #
+        #   @param detail [Symbol, OpenAI::Models::Responses::ResponseInputFile::Detail] The detail level of the file to be sent to the model. Use `low` for the default
+        #
         #   @param file_data [String] The content of the file to be sent to the model.
         #
         #   @param file_id [String, nil] The ID of the file to be sent to the model.
@@ -49,6 +59,21 @@ module OpenAI
         #   @param filename [String] The name of the file to be sent to the model.
         #
         #   @param type [Symbol, :input_file] The type of the input item. Always `input_file`.
+
+        # The detail level of the file to be sent to the model. Use `low` for the default
+        # rendering behavior, or `high` to render the file at higher quality. Defaults to
+        # `low`.
+        #
+        # @see OpenAI::Models::Responses::ResponseInputFile#detail
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          LOW = :low
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

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

@@ -10,6 +10,14 @@ module OpenAI
         #   @return [Symbol, :input_file]
         required :type, const: :input_file
 
+        # @!attribute detail
+        #   The detail level of the file to be sent to the model. Use `low` for the default
+        #   rendering behavior, or `high` to render the file at higher quality. Defaults to
+        #   `low`.
+        #
+        #   @return [Symbol, OpenAI::Models::Responses::ResponseInputFileContent::Detail, nil]
+        optional :detail, enum: -> { OpenAI::Responses::ResponseInputFileContent::Detail }
+
         # @!attribute file_data
         #   The base64-encoded data of the file to be sent to the model.
         #
@@ -34,9 +42,14 @@ module OpenAI
         #   @return [String, nil]
         optional :filename, String, nil?: true
 
-        # @!method initialize(file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
+        # @!method initialize(detail: nil, file_data: nil, file_id: nil, file_url: nil, filename: nil, type: :input_file)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Responses::ResponseInputFileContent} for more details.
+        #
         #   A file input to the model.
         #
+        #   @param detail [Symbol, OpenAI::Models::Responses::ResponseInputFileContent::Detail] The detail level of the file to be sent to the model. Use `low` for the default
+        #
         #   @param file_data [String, nil] The base64-encoded data of the file to be sent to the model.
         #
         #   @param file_id [String, nil] The ID of the file to be sent to the model.
@@ -46,6 +59,21 @@ module OpenAI
         #   @param filename [String, nil] The name of the file to be sent to the model.
         #
         #   @param type [Symbol, :input_file] The type of the input item. Always `input_file`.
+
+        # The detail level of the file to be sent to the model. Use `low` for the default
+        # rendering behavior, or `high` to render the file at higher quality. Defaults to
+        # `low`.
+        #
+        # @see OpenAI::Models::Responses::ResponseInputFileContent#detail
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          LOW = :low
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

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

@@ -461,7 +461,7 @@ module OpenAI
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 
-          IN_MEMORY = :"in-memory"
+          IN_MEMORY = :in_memory
           PROMPT_CACHE_RETENTION_24H = :"24h"
 
           # @!method self.values

data/lib/openai/resources/audio/transcriptions.rb

@@ -111,7 +111,11 @@ module OpenAI
           @client.request(
             method: :post,
             path: "audio/transcriptions",
-            headers: {"content-type" => "multipart/form-data", "accept" => "text/event-stream"},
+            headers: {
+              "content-type" => "multipart/form-data",
+              "accept" => "text/event-stream",
+              "accept-encoding" => "identity"
+            },
             body: parsed,
             stream: OpenAI::Internal::Stream,
             model: OpenAI::Audio::TranscriptionStreamEvent,

data/lib/openai/resources/beta/threads/runs.rb

@@ -149,7 +149,7 @@ module OpenAI
               method: :post,
               path: ["threads/%1$s/runs", thread_id],
               query: query,
-              headers: {"accept" => "text/event-stream"},
+              headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
               body: parsed.except(*query_params),
               stream: OpenAI::Internal::Stream,
               model: OpenAI::Beta::AssistantStreamEvent,
@@ -375,7 +375,7 @@ module OpenAI
             @client.request(
               method: :post,
               path: ["threads/%1$s/runs/%2$s/submit_tool_outputs", thread_id, run_id],
-              headers: {"accept" => "text/event-stream"},
+              headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
               body: parsed,
               stream: OpenAI::Internal::Stream,
               model: OpenAI::Beta::AssistantStreamEvent,

data/lib/openai/resources/beta/threads.rb

@@ -243,7 +243,7 @@ module OpenAI
           @client.request(
             method: :post,
             path: "threads/runs",
-            headers: {"accept" => "text/event-stream"},
+            headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
             body: parsed,
             stream: OpenAI::Internal::Stream,
             model: OpenAI::Beta::AssistantStreamEvent,

data/lib/openai/resources/chat/completions.rb

@@ -372,7 +372,7 @@ module OpenAI
           @client.request(
             method: :post,
             path: "chat/completions",
-            headers: {"accept" => "text/event-stream"},
+            headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
             body: parsed,
             stream: OpenAI::Internal::Stream,
             model: OpenAI::Chat::ChatCompletionChunk,

data/lib/openai/resources/completions.rb

@@ -132,7 +132,7 @@ module OpenAI
         @client.request(
           method: :post,
           path: "completions",
-          headers: {"accept" => "text/event-stream"},
+          headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
           body: parsed,
           stream: OpenAI::Internal::Stream,
           model: OpenAI::Completion,

data/lib/openai/resources/files.rb

@@ -10,7 +10,8 @@ module OpenAI
       #
       # Upload a file that can be used across various endpoints. Individual files can be
       # up to 512 MB, and each project can store up to 2.5 TB of files in total. There
-      # is no organization-wide storage limit.
+      # is no organization-wide storage limit. Uploads to this endpoint are rate-limited
+      # to 1,000 requests per minute per authenticated user.
       #
       # - The Assistants API supports files up to 2 million tokens and of specific file
       #   types. See the
@@ -25,6 +26,12 @@ module OpenAI
       # - The Batch API only supports `.jsonl` files up to 200 MB in size. The input
       #   also has a specific required
       #   [format](https://platform.openai.com/docs/api-reference/batch/request-input).
+      # - For Retrieval or `file_search` ingestion, upload files here first. If you need
+      #   to attach multiple uploaded files to the same vector store, use
+      #   [`/vector_stores/{vector_store_id}/file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+      #   instead of attaching them one by one. Vector store attachment has separate
+      #   limits from file upload, including 2,000 attached files per minute per
+      #   organization.
       #
       # Please [contact us](https://help.openai.com/) if you need to increase these
       # storage limits.

data/lib/openai/resources/images.rb

@@ -154,7 +154,11 @@ module OpenAI
         @client.request(
           method: :post,
           path: "images/edits",
-          headers: {"content-type" => "multipart/form-data", "accept" => "text/event-stream"},
+          headers: {
+            "content-type" => "multipart/form-data",
+            "accept" => "text/event-stream",
+            "accept-encoding" => "identity"
+          },
           body: parsed,
           stream: OpenAI::Internal::Stream,
           model: OpenAI::ImageEditStreamEvent,
@@ -269,7 +273,7 @@ module OpenAI
         @client.request(
           method: :post,
           path: "images/generations",
-          headers: {"accept" => "text/event-stream"},
+          headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
           body: parsed,
           stream: OpenAI::Internal::Stream,
           model: OpenAI::ImageGenStreamEvent,

data/lib/openai/resources/responses.rb

@@ -321,7 +321,7 @@ module OpenAI
         @client.request(
           method: :post,
           path: "responses",
-          headers: {"accept" => "text/event-stream"},
+          headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
           body: parsed,
           stream: OpenAI::Internal::Stream,
           model: OpenAI::Responses::ResponseStreamEvent,
@@ -401,7 +401,7 @@ module OpenAI
           method: :get,
           path: ["responses/%1$s", response_id],
           query: query,
-          headers: {"accept" => "text/event-stream"},
+          headers: {"accept" => "text/event-stream", "accept-encoding" => "identity"},
           stream: OpenAI::Internal::Stream,
           model: OpenAI::Responses::ResponseStreamEvent,
           options: options
@@ -475,7 +475,7 @@ module OpenAI
       # For ZDR-compatible compaction details, see
       # [Compaction (advanced)](https://platform.openai.com/docs/guides/conversation-state#compaction-advanced).
       #
-      # @overload compact(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, request_options: {})
+      # @overload compact(model:, input: nil, instructions: nil, previous_response_id: nil, prompt_cache_key: nil, prompt_cache_retention: nil, request_options: {})
       #
       # @param model [Symbol, String, OpenAI::Models::Responses::ResponseCompactParams::Model, nil] Model ID used to generate the response, like `gpt-5` or `o3`. OpenAI offers a wi
       #
@@ -487,6 +487,8 @@ module OpenAI
       #
       # @param prompt_cache_key [String, nil] A key to use when reading from or writing to the prompt cache.
       #
+      # @param prompt_cache_retention [Symbol, OpenAI::Models::Responses::ResponseCompactParams::PromptCacheRetention, nil] How long to retain a prompt cache entry created by this request.
+      #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [OpenAI::Models::Responses::CompactedResponse]

data/lib/openai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenAI
-  VERSION = "0.58.0"
+  VERSION = "0.60.0"
 end

data/rbi/openai/models/chat/completion_create_params.rbi

@@ -1118,7 +1118,7 @@ module OpenAI
 
           IN_MEMORY =
             T.let(
-              :"in-memory",
+              :in_memory,
               OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::TaggedSymbol
             )
           PROMPT_CACHE_RETENTION_24H =

data/rbi/openai/models/responses/response.rbi

@@ -837,7 +837,7 @@ module OpenAI
 
           IN_MEMORY =
             T.let(
-              :"in-memory",
+              :in_memory,
               OpenAI::Responses::Response::PromptCacheRetention::TaggedSymbol
             )
           PROMPT_CACHE_RETENTION_24H =

data/rbi/openai/models/responses/response_compact_params.rbi

@@ -58,6 +58,16 @@ module OpenAI
         sig { returns(T.nilable(String)) }
         attr_accessor :prompt_cache_key
 
+        # How long to retain a prompt cache entry created by this request.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::OrSymbol
+            )
+          )
+        end
+        attr_accessor :prompt_cache_retention
+
         sig do
           params(
             model:
@@ -74,6 +84,10 @@ module OpenAI
             instructions: T.nilable(String),
             previous_response_id: T.nilable(String),
             prompt_cache_key: T.nilable(String),
+            prompt_cache_retention:
+              T.nilable(
+                OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::OrSymbol
+              ),
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -98,6 +112,8 @@ module OpenAI
           previous_response_id: nil,
           # A key to use when reading from or writing to the prompt cache.
           prompt_cache_key: nil,
+          # How long to retain a prompt cache entry created by this request.
+          prompt_cache_retention: nil,
           request_options: {}
         )
         end
@@ -119,6 +135,10 @@ module OpenAI
               instructions: T.nilable(String),
               previous_response_id: T.nilable(String),
               prompt_cache_key: T.nilable(String),
+              prompt_cache_retention:
+                T.nilable(
+                  OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::OrSymbol
+                ),
               request_options: OpenAI::RequestOptions
             }
           )
@@ -650,6 +670,41 @@ module OpenAI
               OpenAI::Internal::Type::Converter
             )
         end
+
+        # How long to retain a prompt cache entry created by this request.
+        module PromptCacheRetention
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::ResponseCompactParams::PromptCacheRetention
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_MEMORY =
+            T.let(
+              :in_memory,
+              OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::TaggedSymbol
+            )
+          PROMPT_CACHE_RETENTION_24H =
+            T.let(
+              :"24h",
+              OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/openai/models/responses/response_create_params.rbi

@@ -922,7 +922,7 @@ module OpenAI
 
           IN_MEMORY =
             T.let(
-              :"in-memory",
+              :in_memory,
               OpenAI::Responses::ResponseCreateParams::PromptCacheRetention::TaggedSymbol
             )
           PROMPT_CACHE_RETENTION_24H =

data/rbi/openai/models/responses/response_input_file.rbi

@@ -16,6 +16,23 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
+        # The detail level of the file to be sent to the model. Use `low` for the default
+        # rendering behavior, or `high` to render the file at higher quality. Defaults to
+        # `low`.
+        sig do
+          returns(
+            T.nilable(OpenAI::Responses::ResponseInputFile::Detail::OrSymbol)
+          )
+        end
+        attr_reader :detail
+
+        sig do
+          params(
+            detail: OpenAI::Responses::ResponseInputFile::Detail::OrSymbol
+          ).void
+        end
+        attr_writer :detail
+
         # The content of the file to be sent to the model.
         sig { returns(T.nilable(String)) }
         attr_reader :file_data
@@ -44,6 +61,7 @@ module OpenAI
         # A file input to the model.
         sig do
           params(
+            detail: OpenAI::Responses::ResponseInputFile::Detail::OrSymbol,
             file_data: String,
             file_id: T.nilable(String),
             file_url: String,
@@ -52,6 +70,10 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
+          # The detail level of the file to be sent to the model. Use `low` for the default
+          # rendering behavior, or `high` to render the file at higher quality. Defaults to
+          # `low`.
+          detail: nil,
           # The content of the file to be sent to the model.
           file_data: nil,
           # The ID of the file to be sent to the model.
@@ -69,6 +91,7 @@ module OpenAI
           override.returns(
             {
               type: Symbol,
+              detail: OpenAI::Responses::ResponseInputFile::Detail::OrSymbol,
               file_data: String,
               file_id: T.nilable(String),
               file_url: String,
@@ -78,6 +101,40 @@ module OpenAI
         end
         def to_hash
         end
+
+        # The detail level of the file to be sent to the model. Use `low` for the default
+        # rendering behavior, or `high` to render the file at higher quality. Defaults to
+        # `low`.
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Responses::ResponseInputFile::Detail)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOW =
+            T.let(
+              :low,
+              OpenAI::Responses::ResponseInputFile::Detail::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              OpenAI::Responses::ResponseInputFile::Detail::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseInputFile::Detail::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/openai/models/responses/response_input_file_content.rbi

@@ -16,6 +16,26 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
+        # The detail level of the file to be sent to the model. Use `low` for the default
+        # rendering behavior, or `high` to render the file at higher quality. Defaults to
+        # `low`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Responses::ResponseInputFileContent::Detail::OrSymbol
+            )
+          )
+        end
+        attr_reader :detail
+
+        sig do
+          params(
+            detail:
+              OpenAI::Responses::ResponseInputFileContent::Detail::OrSymbol
+          ).void
+        end
+        attr_writer :detail
+
         # The base64-encoded data of the file to be sent to the model.
         sig { returns(T.nilable(String)) }
         attr_accessor :file_data
@@ -35,6 +55,8 @@ module OpenAI
         # A file input to the model.
         sig do
           params(
+            detail:
+              OpenAI::Responses::ResponseInputFileContent::Detail::OrSymbol,
             file_data: T.nilable(String),
             file_id: T.nilable(String),
             file_url: T.nilable(String),
@@ -43,6 +65,10 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
+          # The detail level of the file to be sent to the model. Use `low` for the default
+          # rendering behavior, or `high` to render the file at higher quality. Defaults to
+          # `low`.
+          detail: nil,
           # The base64-encoded data of the file to be sent to the model.
           file_data: nil,
           # The ID of the file to be sent to the model.
@@ -60,6 +86,8 @@ module OpenAI
           override.returns(
             {
               type: Symbol,
+              detail:
+                OpenAI::Responses::ResponseInputFileContent::Detail::OrSymbol,
               file_data: T.nilable(String),
               file_id: T.nilable(String),
               file_url: T.nilable(String),
@@ -69,6 +97,40 @@ module OpenAI
         end
         def to_hash
         end
+
+        # The detail level of the file to be sent to the model. Use `low` for the default
+        # rendering behavior, or `high` to render the file at higher quality. Defaults to
+        # `low`.
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Responses::ResponseInputFileContent::Detail)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOW =
+            T.let(
+              :low,
+              OpenAI::Responses::ResponseInputFileContent::Detail::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              OpenAI::Responses::ResponseInputFileContent::Detail::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseInputFileContent::Detail::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/openai/models/responses/responses_client_event.rbi

@@ -934,7 +934,7 @@ module OpenAI
 
           IN_MEMORY =
             T.let(
-              :"in-memory",
+              :in_memory,
               OpenAI::Responses::ResponsesClientEvent::PromptCacheRetention::TaggedSymbol
             )
           PROMPT_CACHE_RETENTION_24H =

data/rbi/openai/resources/files.rbi

@@ -7,7 +7,8 @@ module OpenAI
     class Files
       # Upload a file that can be used across various endpoints. Individual files can be
       # up to 512 MB, and each project can store up to 2.5 TB of files in total. There
-      # is no organization-wide storage limit.
+      # is no organization-wide storage limit. Uploads to this endpoint are rate-limited
+      # to 1,000 requests per minute per authenticated user.
       #
       # - The Assistants API supports files up to 2 million tokens and of specific file
       #   types. See the
@@ -22,6 +23,12 @@ module OpenAI
       # - The Batch API only supports `.jsonl` files up to 200 MB in size. The input
       #   also has a specific required
       #   [format](https://platform.openai.com/docs/api-reference/batch/request-input).
+      # - For Retrieval or `file_search` ingestion, upload files here first. If you need
+      #   to attach multiple uploaded files to the same vector store, use
+      #   [`/vector_stores/{vector_store_id}/file_batches`](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch)
+      #   instead of attaching them one by one. Vector store attachment has separate
+      #   limits from file upload, including 2,000 attached files per minute per
+      #   organization.
       #
       # Please [contact us](https://help.openai.com/) if you need to increase these
       # storage limits.

data/rbi/openai/resources/responses.rbi

@@ -988,6 +988,10 @@ module OpenAI
           instructions: T.nilable(String),
           previous_response_id: T.nilable(String),
           prompt_cache_key: T.nilable(String),
+          prompt_cache_retention:
+            T.nilable(
+              OpenAI::Responses::ResponseCompactParams::PromptCacheRetention::OrSymbol
+            ),
           request_options: OpenAI::RequestOptions::OrHash
         ).returns(OpenAI::Responses::CompactedResponse)
       end
@@ -1012,6 +1016,8 @@ module OpenAI
         previous_response_id: nil,
         # A key to use when reading from or writing to the prompt cache.
         prompt_cache_key: nil,
+        # How long to retain a prompt cache entry created by this request.
+        prompt_cache_retention: nil,
         request_options: {}
       )
       end

data/sig/openai/models/chat/completion_create_params.rbs

@@ -293,12 +293,12 @@ module OpenAI
           def self?.values: -> ::Array[OpenAI::Models::Chat::CompletionCreateParams::modality]
         end
 
-        type prompt_cache_retention = :"in-memory" | :"24h"
+        type prompt_cache_retention = :in_memory | :"24h"
 
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 
-          IN_MEMORY: :"in-memory"
+          IN_MEMORY: :in_memory
           PROMPT_CACHE_RETENTION_24H: :"24h"
 
           def self?.values: -> ::Array[OpenAI::Models::Chat::CompletionCreateParams::prompt_cache_retention]

data/sig/openai/models/responses/response.rbs

@@ -259,12 +259,12 @@ module OpenAI
           def to_hash: -> { id: String }
         end
 
-        type prompt_cache_retention = :"in-memory" | :"24h"
+        type prompt_cache_retention = :in_memory | :"24h"
 
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 
-          IN_MEMORY: :"in-memory"
+          IN_MEMORY: :in_memory
           PROMPT_CACHE_RETENTION_24H: :"24h"
 
           def self?.values: -> ::Array[OpenAI::Models::Responses::Response::prompt_cache_retention]

data/sig/openai/models/responses/response_compact_params.rbs

@@ -7,7 +7,8 @@ module OpenAI
           input: OpenAI::Models::Responses::ResponseCompactParams::input?,
           instructions: String?,
           previous_response_id: String?,
-          prompt_cache_key: String?
+          prompt_cache_key: String?,
+          prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?
         }
         & OpenAI::Internal::Type::request_parameters
 
@@ -25,12 +26,15 @@ module OpenAI
 
         attr_accessor prompt_cache_key: String?
 
+        attr_accessor prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?
+
         def initialize: (
           model: OpenAI::Models::Responses::ResponseCompactParams::model?,
           ?input: OpenAI::Models::Responses::ResponseCompactParams::input?,
           ?instructions: String?,
           ?previous_response_id: String?,
           ?prompt_cache_key: String?,
+          ?prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?,
           ?request_options: OpenAI::request_opts
         ) -> void
 
@@ -40,6 +44,7 @@ module OpenAI
           instructions: String?,
           previous_response_id: String?,
           prompt_cache_key: String?,
+          prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?,
           request_options: OpenAI::RequestOptions
         }
 
@@ -247,6 +252,17 @@ module OpenAI
 
           ResponseInputItemArray: OpenAI::Internal::Type::Converter
         end
+
+        type prompt_cache_retention = :in_memory | :"24h"
+
+        module PromptCacheRetention
+          extend OpenAI::Internal::Type::Enum
+
+          IN_MEMORY: :in_memory
+          PROMPT_CACHE_RETENTION_24H: :"24h"
+
+          def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention]
+        end
       end
     end
   end

data/sig/openai/models/responses/response_create_params.rbs

@@ -213,12 +213,12 @@ module OpenAI
           def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseCreateParams::input]
         end
 
-        type prompt_cache_retention = :"in-memory" | :"24h"
+        type prompt_cache_retention = :in_memory | :"24h"
 
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 
-          IN_MEMORY: :"in-memory"
+          IN_MEMORY: :in_memory
           PROMPT_CACHE_RETENTION_24H: :"24h"
 
           def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseCreateParams::prompt_cache_retention]

data/sig/openai/models/responses/response_input_file.rbs

@@ -4,6 +4,7 @@ module OpenAI
       type response_input_file =
         {
           type: :input_file,
+          detail: OpenAI::Models::Responses::ResponseInputFile::detail,
           file_data: String,
           file_id: String?,
           file_url: String,
@@ -13,6 +14,12 @@ module OpenAI
       class ResponseInputFile < OpenAI::Internal::Type::BaseModel
         attr_accessor type: :input_file
 
+        attr_reader detail: OpenAI::Models::Responses::ResponseInputFile::detail?
+
+        def detail=: (
+          OpenAI::Models::Responses::ResponseInputFile::detail
+        ) -> OpenAI::Models::Responses::ResponseInputFile::detail
+
         attr_reader file_data: String?
 
         def file_data=: (String) -> String
@@ -28,6 +35,7 @@ module OpenAI
         def filename=: (String) -> String
 
         def initialize: (
+          ?detail: OpenAI::Models::Responses::ResponseInputFile::detail,
           ?file_data: String,
           ?file_id: String?,
           ?file_url: String,
@@ -37,11 +45,23 @@ module OpenAI
 
         def to_hash: -> {
           type: :input_file,
+          detail: OpenAI::Models::Responses::ResponseInputFile::detail,
           file_data: String,
           file_id: String?,
           file_url: String,
           filename: String
         }
+
+        type detail = :low | :high
+
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          LOW: :low
+          HIGH: :high
+
+          def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseInputFile::detail]
+        end
       end
     end
   end

data/sig/openai/models/responses/response_input_file_content.rbs

@@ -4,6 +4,7 @@ module OpenAI
       type response_input_file_content =
         {
           type: :input_file,
+          detail: OpenAI::Models::Responses::ResponseInputFileContent::detail,
           file_data: String?,
           file_id: String?,
           file_url: String?,
@@ -13,6 +14,12 @@ module OpenAI
       class ResponseInputFileContent < OpenAI::Internal::Type::BaseModel
         attr_accessor type: :input_file
 
+        attr_reader detail: OpenAI::Models::Responses::ResponseInputFileContent::detail?
+
+        def detail=: (
+          OpenAI::Models::Responses::ResponseInputFileContent::detail
+        ) -> OpenAI::Models::Responses::ResponseInputFileContent::detail
+
         attr_accessor file_data: String?
 
         attr_accessor file_id: String?
@@ -22,6 +29,7 @@ module OpenAI
         attr_accessor filename: String?
 
         def initialize: (
+          ?detail: OpenAI::Models::Responses::ResponseInputFileContent::detail,
           ?file_data: String?,
           ?file_id: String?,
           ?file_url: String?,
@@ -31,11 +39,23 @@ module OpenAI
 
         def to_hash: -> {
           type: :input_file,
+          detail: OpenAI::Models::Responses::ResponseInputFileContent::detail,
           file_data: String?,
           file_id: String?,
           file_url: String?,
           filename: String?
         }
+
+        type detail = :low | :high
+
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          LOW: :low
+          HIGH: :high
+
+          def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseInputFileContent::detail]
+        end
       end
     end
   end

data/sig/openai/models/responses/responses_client_event.rbs

@@ -217,12 +217,12 @@ module OpenAI
           def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponsesClientEvent::input]
         end
 
-        type prompt_cache_retention = :"in-memory" | :"24h"
+        type prompt_cache_retention = :in_memory | :"24h"
 
         module PromptCacheRetention
           extend OpenAI::Internal::Type::Enum
 
-          IN_MEMORY: :"in-memory"
+          IN_MEMORY: :in_memory
           PROMPT_CACHE_RETENTION_24H: :"24h"
 
           def self?.values: -> ::Array[OpenAI::Models::Responses::ResponsesClientEvent::prompt_cache_retention]

data/sig/openai/resources/responses.rbs

@@ -129,6 +129,7 @@ module OpenAI
         ?instructions: String?,
         ?previous_response_id: String?,
         ?prompt_cache_key: String?,
+        ?prompt_cache_retention: OpenAI::Models::Responses::ResponseCompactParams::prompt_cache_retention?,
         ?request_options: OpenAI::request_opts
       ) -> OpenAI::Responses::CompactedResponse
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.58.0
+  version: 0.60.0
 platform: ruby
 authors:
 - OpenAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-08 00:00:00.000000000 Z
+date: 2026-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64