openai 0.68.0 → 0.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5ff11b5e599c4ebd4c202e215b46f943356f3fc91dcf1ce7e3210b647bc3676
-  data.tar.gz: 3359efbf0d523d7e31f2153b012b993c30e8ed3617ff07e00ca5580bbc414c0c
+  metadata.gz: bbc95cabd7267bdcb79b50ffebb3e11579e47ccbe7d4e1c3a619647908a68abe
+  data.tar.gz: 3db020bf00a1ff077a23842a0391e388a0a7ca0070af312e100e8b866630127e
 SHA512:
-  metadata.gz: db46f5c0c9f949924bdc8d39f53e0419bcf05c4fbd6ba60cd0b5619d692c25698a3b4611c0dd5058c8e96e270bf0c6a05806cd2ff6b0010dc494a6891588083b
-  data.tar.gz: 1323527f82c69f1f84a6143cd5af7514bbf4ed5626dfaedc8eae2a75107a60b19d0218da149d598a31eb6a3e9e5a9d3e6c9497f05e1c758d3513d8421de4852b
+  metadata.gz: 7a357a83fe7d2db2cf7091e0c7eaff4f09520bcb464594f21cdab1904ba9487b71fec7ac5a0c970db4f9a1be7e135d8b1ec79776d60646dca0eea70cec48567c
+  data.tar.gz: c82dbd05da4e69a2ec45d36e1ee67f7bbdb31c45f851984a91553a0784004696cb53f6fac30ceb0d504713a39170e548c50f4e693bddd0ce51407108c7085b5a

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.69.0 (2026-07-09)
+
+Full Changelog: [v0.68.0...v0.69.0](https://github.com/openai/openai-ruby/compare/v0.68.0...v0.69.0)
+
+### Features
+
+* **api:** manual updates ([a5825fe](https://github.com/openai/openai-ruby/commit/a5825fe26c63e1669a0bae38321b0d8825700d87))
+
+
+### Bug Fixes
+
+* multipart filename quoting ([#279](https://github.com/openai/openai-ruby/issues/279)) ([0c2c79a](https://github.com/openai/openai-ruby/commit/0c2c79a03df51e56b8f34bbf905c5798536d9ed8))
+
+
+### Chores
+
+* **internal:** bound formatter parallelism to CPU count ([3f18a30](https://github.com/openai/openai-ruby/commit/3f18a305b3c854e190b332862e7faa991910fa02))
+
+
+### Documentation
+
+* fix wording in Sorbet example ([#290](https://github.com/openai/openai-ruby/issues/290)) ([2f34487](https://github.com/openai/openai-ruby/commit/2f34487e709761320107e142e6bfbbd0dfc82ba0))
+
 ## 0.68.0 (2026-06-17)
 
 Full Changelog: [v0.67.0...v0.68.0](https://github.com/openai/openai-ruby/compare/v0.67.0...v0.68.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.68.0"
+gem "openai", "~> 0.69.0"
 ```
 
 <!-- x-release-please-end -->
@@ -558,11 +558,11 @@ 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
-puts(OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::IN_MEMORY)
+# :none
+puts(OpenAI::ReasoningEffort::NONE)
 
-# Revealed type: `T.all(OpenAI::Chat::CompletionCreateParams::PromptCacheRetention, Symbol)`
-T.reveal_type(OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::IN_MEMORY)
+# Revealed type: `T.all(OpenAI::ReasoningEffort, Symbol)`
+T.reveal_type(OpenAI::ReasoningEffort::NONE)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
@@ -570,13 +570,13 @@ Enum parameters have a "relaxed" type, so you can either pass in enum constants
 ```ruby
 # Using the enum constants preserves the tagged type information:
 openai.chat.completions.create(
-  prompt_cache_retention: OpenAI::Chat::CompletionCreateParams::PromptCacheRetention::IN_MEMORY,
+  reasoning_effort: OpenAI::ReasoningEffort::NONE,
   # …
 )
 
 # Literal values are also permissible:
 openai.chat.completions.create(
-  prompt_cache_retention: :in_memory,
+  reasoning_effort: :none,
   # …
 )
 ```

data/lib/openai/internal/type/enum.rb

@@ -19,11 +19,11 @@ module OpenAI
       # @example
       #   # `chat_model` is a `OpenAI::ChatModel`
       #   case chat_model
-      #   when OpenAI::ChatModel::GPT_5_4
+      #   when OpenAI::ChatModel::GPT_5_6_SOL
       #     # ...
-      #   when OpenAI::ChatModel::GPT_5_4_MINI
+      #   when OpenAI::ChatModel::GPT_5_6_TERRA
       #     # ...
-      #   when OpenAI::ChatModel::GPT_5_4_NANO
+      #   when OpenAI::ChatModel::GPT_5_6_LUNA
       #     # ...
       #   else
       #     puts(chat_model)
@@ -31,11 +31,11 @@ module OpenAI
       #
       # @example
       #   case chat_model
-      #   in :"gpt-5.4"
+      #   in :"gpt-5.6-sol"
       #     # ...
-      #   in :"gpt-5.4-mini"
+      #   in :"gpt-5.6-terra"
       #     # ...
-      #   in :"gpt-5.4-nano"
+      #   in :"gpt-5.6-luna"
       #     # ...
       #   else
       #     puts(chat_model)

data/lib/openai/internal/util.rb

@@ -573,6 +573,18 @@ module OpenAI
           y << "\r\n"
         end
 
+        # @api private
+        #
+        # Multipart filenames are quoted-strings, not URI path segments. Escape header
+        # delimiters and remove CR/LF without encoding ordinary filename characters.
+        #
+        # @param filename [Pathname, String]
+        #
+        # @return [String]
+        private def escape_multipart_filename(filename)
+          filename.to_s.gsub(/["\\]/) { "\\#{_1}" }.delete("\r\n").b
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]
@@ -590,10 +602,10 @@ module OpenAI
 
           case val
           in OpenAI::FilePart unless val.filename.nil?
-            filename = encode_path(val.filename)
+            filename = escape_multipart_filename(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = encode_path(::File.basename(val.to_path))
+            filename = escape_multipart_filename(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end

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

@@ -49,19 +49,12 @@ module OpenAI
         optional :name, String, nil?: true
 
         # @!attribute reasoning_effort
-        #   Constrains effort on reasoning for
-        #   [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-        #   supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`.
-        #   Reducing reasoning effort can result in faster responses and fewer tokens used
-        #   on reasoning in a response.
-        #
-        #   - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported
-        #     reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool
-        #     calls are supported for all reasoning values in gpt-5.1.
-        #   - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
-        #     support `none`.
-        #   - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
-        #   - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
+        #   Constrains effort on reasoning for reasoning models. Currently supported values
+        #   are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
+        #   reasoning effort can result in faster responses and fewer tokens used on
+        #   reasoning in a response. Not all reasoning models support every value. See the
+        #   [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+        #   model-specific support.
         #
         #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
         optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -140,7 +133,7 @@ module OpenAI
         #
         #   @param name [String, nil] The name of the assistant. The maximum length is 256 characters.
         #
-        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
+        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
         #
         #   @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil] Specifies the format that the model must output. Compatible with [GPT-4o](https:
         #

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

@@ -54,19 +54,12 @@ module OpenAI
         optional :name, String, nil?: true
 
         # @!attribute reasoning_effort
-        #   Constrains effort on reasoning for
-        #   [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-        #   supported values are `none`, `minimal`, `low`, `medium`, `high`, and `xhigh`.
-        #   Reducing reasoning effort can result in faster responses and fewer tokens used
-        #   on reasoning in a response.
-        #
-        #   - `gpt-5.1` defaults to `none`, which does not perform reasoning. The supported
-        #     reasoning values for `gpt-5.1` are `none`, `low`, `medium`, and `high`. Tool
-        #     calls are supported for all reasoning values in gpt-5.1.
-        #   - All models before `gpt-5.1` default to `medium` reasoning effort, and do not
-        #     support `none`.
-        #   - The `gpt-5-pro` model defaults to (and only supports) `high` reasoning effort.
-        #   - `xhigh` is supported for all models after `gpt-5.1-codex-max`.
+        #   Constrains effort on reasoning for reasoning models. Currently supported values
+        #   are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing
+        #   reasoning effort can result in faster responses and fewer tokens used on
+        #   reasoning in a response. Not all reasoning models support every value. See the
+        #   [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for
+        #   model-specific support.
         #
         #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
         optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -147,7 +140,7 @@ module OpenAI
         #
         #   @param name [String, nil] The name of the assistant. The maximum length is 256 characters.
         #
-        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
+        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for reasoning models. Currently supported
         #
         #   @param response_format [Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil] Specifies the format that the model must output. Compatible with [GPT-4o](https:
         #

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaApplyPatchTool < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the tool. Always `apply_patch`.
+        #
+        #   @return [Symbol, :apply_patch]
+        required :type, const: :apply_patch
+
+        # @!attribute allowed_callers
+        #   The tool invocation context(s).
+        #
+        #   @return [Array<Symbol, OpenAI::Models::Beta::BetaApplyPatchTool::AllowedCaller>, nil]
+        optional :allowed_callers,
+                 -> {
+                   OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::BetaApplyPatchTool::AllowedCaller]
+                 },
+                 nil?: true
+
+        # @!method initialize(allowed_callers: nil, type: :apply_patch)
+        #   Allows the assistant to create, delete, or update files using unified diffs.
+        #
+        #   @param allowed_callers [Array<Symbol, OpenAI::Models::Beta::BetaApplyPatchTool::AllowedCaller>, nil] The tool invocation context(s).
+        #
+        #   @param type [Symbol, :apply_patch] The type of the tool. Always `apply_patch`.
+
+        module AllowedCaller
+          extend OpenAI::Internal::Type::Enum
+
+          DIRECT = :direct
+          PROGRAMMATIC = :programmatic
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaApplyPatchTool = Beta::BetaApplyPatchTool
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Responses#compact
+      class BetaCompactedResponse < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the compacted response.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   Unix timestamp (in seconds) when the compacted conversation was created.
+        #
+        #   @return [Integer]
+        required :created_at, Integer
+
+        # @!attribute object
+        #   The object type. Always `response.compaction`.
+        #
+        #   @return [Symbol, :"response.compaction"]
+        required :object, const: :"response.compaction"
+
+        # @!attribute output
+        #   The compacted list of output items. This is a list of all user messages,
+        #   followed by a single compaction item.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem>]
+        required :output, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaResponseOutputItem] }
+
+        # @!attribute usage
+        #   Token accounting for the compaction pass, including cached, reasoning, and total
+        #   tokens.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseUsage]
+        required :usage, -> { OpenAI::Beta::BetaResponseUsage }
+
+        # @!method initialize(id:, created_at:, output:, usage:, object: :"response.compaction")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaCompactedResponse} for more details.
+        #
+        #   @param id [String] The unique identifier for the compacted response.
+        #
+        #   @param created_at [Integer] Unix timestamp (in seconds) when the compacted conversation was created.
+        #
+        #   @param output [Array<OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem>] The compacted list of output items. This is a list of all user messages, followe
+        #
+        #   @param usage [OpenAI::Models::Beta::BetaResponseUsage] Token accounting for the compaction pass, including cached, reasoning, and total
+        #
+        #   @param object [Symbol, :"response.compaction"] The object type. Always `response.compaction`.
+      end
+    end
+
+    BetaCompactedResponse = Beta::BetaCompactedResponse
+  end
+end