openai 0.24.0 → 0.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9739da617fa34b8a5add655141558b5f984fa8c349236cf521605e748024cdb
-  data.tar.gz: 44064a7817af7fc80e2e9e7bf5bb1df722472d074cfc9daa3abb6ae3f877f25d
+  metadata.gz: 63b13ff3a6e853278bda7f2dec0bfdf3b4f32873eed07e63bb19c5ffabef4d28
+  data.tar.gz: 82d504549c8cefef90f5b7a846b11876c0f8910c6f2eec40e4a8e78edde3d9c4
 SHA512:
-  metadata.gz: 4067c143f59520175c9273966544511a35bb76690fa6685ee5292084714a3b81737ae0e8e689ce0294393ec57d3bfe355baf41159a0ba57a3e44908aef47618b
-  data.tar.gz: 86f95667cf0b219500e4a90480a4b81a1daa781dbf2239db5bade3604208e45fcca9ed6cdd25428a5f76956884548c9a01c9bc2d5f5da0f71f4f5453857d10c1
+  metadata.gz: 86e4af688a02efb6ab796bb12653c5155ba67e999343898cc2716ffbd2fd8424464ab553d7981503dfd553d79bad080a83ea69f34bf6a96db7050f5835df11cc
+  data.tar.gz: 8c28b2b5c642c86af7b95817dd535fdde8c4023f68988b7ffd456c9bf45f192a9ae056e61e84681702bb4b150600c1579ab039b3123bc1b5928aa4acbe2724af

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.25.1 (2025-09-22)
+
+Full Changelog: [v0.25.0...v0.25.1](https://github.com/openai/openai-ruby/compare/v0.25.0...v0.25.1)
+
+### Bug Fixes
+
+* **api:** fix mcp tool name ([25ec2ac](https://github.com/openai/openai-ruby/commit/25ec2aca164414f66a7d023c196ee6b1781c7146))
+
+
+### Chores
+
+* **api:** openapi updates for conversations ([ce76a59](https://github.com/openai/openai-ruby/commit/ce76a591d8c596d9eaeaa14077cec3146ffb1d0c))
+* do not install brew dependencies in ./scripts/bootstrap by default ([3afa532](https://github.com/openai/openai-ruby/commit/3afa53231a90968bec2d361363334800463b436d))
+* improve example values ([ad9a444](https://github.com/openai/openai-ruby/commit/ad9a4444e8a9af36f31368f19a095c1d4f4200ad))
+
+## 0.25.0 (2025-09-19)
+
+Full Changelog: [v0.24.0...v0.25.0](https://github.com/openai/openai-ruby/compare/v0.24.0...v0.25.0)
+
+### Features
+
+* **api:** add reasoning_text ([48073e9](https://github.com/openai/openai-ruby/commit/48073e955e50f7818fc0c422b7b5ce80c853536c))
+
 ## 0.24.0 (2025-09-17)
 
 Full Changelog: [v0.23.3...v0.24.0](https://github.com/openai/openai-ruby/compare/v0.23.3...v0.24.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.24.0"
+gem "openai", "~> 0.25.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/openai/models/conversations/conversation_create_params.rb

@@ -32,7 +32,7 @@ module OpenAI
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Conversations::ConversationCreateParams} for more details.
         #
-        #   @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context.
+        #   @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
         #
         #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
         #

data/lib/openai/models/conversations/conversation_update_params.rb

@@ -11,18 +11,19 @@ module OpenAI
         # @!attribute metadata
         #   Set of 16 key-value pairs that can be attached to an object. This can be useful
         #   for storing additional information about the object in a structured format, and
-        #   querying for objects via API or the dashboard. Keys are strings with a maximum
-        #   length of 64 characters. Values are strings with a maximum length of 512
-        #   characters.
+        #   querying for objects via API or the dashboard.
         #
-        #   @return [Hash{Symbol=>String}]
-        required :metadata, OpenAI::Internal::Type::HashOf[String]
+        #   Keys are strings with a maximum length of 64 characters. Values are strings with
+        #   a maximum length of 512 characters.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
 
         # @!method initialize(metadata:, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Conversations::ConversationUpdateParams} for more details.
         #
-        #   @param metadata [Hash{Symbol=>String}] Set of 16 key-value pairs that can be attached to an object. This can be
+        #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/openai/models/conversations/message.rb

@@ -13,7 +13,7 @@ module OpenAI
         # @!attribute content
         #   The content of the message
         #
-        #   @return [Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile>]
+        #   @return [Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Conversations::Message::Content::ReasoningText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile>]
         required :content, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Conversations::Message::Content] }
 
         # @!attribute role
@@ -44,7 +44,7 @@ module OpenAI
         #
         #   @param id [String] The unique ID of the message.
         #
-        #   @param content [Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile>] The content of the message
+        #   @param content [Array<OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Conversations::Message::Content::ReasoningText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile>] The content of the message
         #
         #   @param role [Symbol, OpenAI::Models::Conversations::Message::Role] The role of the message. One of `unknown`, `user`, `assistant`, `system`, `criti
         #
@@ -70,6 +70,9 @@ module OpenAI
           # A summary text from the model.
           variant :summary_text, -> { OpenAI::Conversations::SummaryTextContent }
 
+          # Reasoning text from the model.
+          variant :reasoning_text, -> { OpenAI::Conversations::Message::Content::ReasoningText }
+
           # A refusal from the model.
           variant :refusal, -> { OpenAI::Responses::ResponseOutputRefusal }
 
@@ -82,8 +85,29 @@ module OpenAI
           # A file input to the model.
           variant :input_file, -> { OpenAI::Responses::ResponseInputFile }
 
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            # @!attribute text
+            #   The reasoning text from the model.
+            #
+            #   @return [String]
+            required :text, String
+
+            # @!attribute type
+            #   The type of the reasoning text. Always `reasoning_text`.
+            #
+            #   @return [Symbol, :reasoning_text]
+            required :type, const: :reasoning_text
+
+            # @!method initialize(text:, type: :reasoning_text)
+            #   Reasoning text from the model.
+            #
+            #   @param text [String] The reasoning text from the model.
+            #
+            #   @param type [Symbol, :reasoning_text] The type of the reasoning text. Always `reasoning_text`.
+          end
+
           # @!method self.variants
-          #   @return [Array(OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile)]
+          #   @return [Array(OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Conversations::TextContent, OpenAI::Models::Conversations::SummaryTextContent, OpenAI::Models::Conversations::Message::Content::ReasoningText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Conversations::ComputerScreenshotContent, OpenAI::Models::Responses::ResponseInputFile)]
         end
 
         # The role of the message. One of `unknown`, `user`, `assistant`, `system`,

data/lib/openai/models/conversations/summary_text_content.rb

@@ -5,11 +5,13 @@ module OpenAI
     module Conversations
       class SummaryTextContent < OpenAI::Internal::Type::BaseModel
         # @!attribute text
+        #   A summary of the reasoning output from the model so far.
         #
         #   @return [String]
         required :text, String
 
         # @!attribute type
+        #   The type of the object. Always `summary_text`.
         #
         #   @return [Symbol, :summary_text]
         required :type, const: :summary_text
@@ -17,8 +19,9 @@ module OpenAI
         # @!method initialize(text:, type: :summary_text)
         #   A summary text from the model.
         #
-        #   @param text [String]
-        #   @param type [Symbol, :summary_text]
+        #   @param text [String] A summary of the reasoning output from the model so far.
+        #
+        #   @param type [Symbol, :summary_text] The type of the object. Always `summary_text`.
       end
     end
   end

data/lib/openai/models/realtime/conversation_item.rb

@@ -31,7 +31,7 @@ module OpenAI
         variant :mcp_list_tools, -> { OpenAI::Realtime::RealtimeMcpListTools }
 
         # A Realtime item representing an invocation of a tool on an MCP server.
-        variant :mcp_tool_call, -> { OpenAI::Realtime::RealtimeMcpToolCall }
+        variant :mcp_call, -> { OpenAI::Realtime::RealtimeMcpToolCall }
 
         # A Realtime item requesting human approval of a tool invocation.
         variant :mcp_approval_request, -> { OpenAI::Realtime::RealtimeMcpApprovalRequest }

data/lib/openai/models/realtime/realtime_mcp_tool_call.rb

@@ -29,10 +29,10 @@ module OpenAI
         required :server_label, String
 
         # @!attribute type
-        #   The type of the item. Always `mcp_tool_call`.
+        #   The type of the item. Always `mcp_call`.
         #
-        #   @return [Symbol, :mcp_tool_call]
-        required :type, const: :mcp_tool_call
+        #   @return [Symbol, :mcp_call]
+        required :type, const: :mcp_call
 
         # @!attribute approval_request_id
         #   The ID of an associated approval request, if any.
@@ -52,7 +52,7 @@ module OpenAI
         #   @return [String, nil]
         optional :output, String, nil?: true
 
-        # @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, type: :mcp_tool_call)
+        # @!method initialize(id:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, type: :mcp_call)
         #   A Realtime item representing an invocation of a tool on an MCP server.
         #
         #   @param id [String] The unique ID of the tool call.
@@ -69,7 +69,7 @@ module OpenAI
         #
         #   @param output [String, nil] The output from the tool call.
         #
-        #   @param type [Symbol, :mcp_tool_call] The type of the item. Always `mcp_tool_call`.
+        #   @param type [Symbol, :mcp_call] The type of the item. Always `mcp_call`.
 
         # The error from the tool call, if any.
         #

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

@@ -25,8 +25,32 @@ module OpenAI
         # A refusal from the model.
         variant -> { OpenAI::Responses::ResponseOutputRefusal }
 
+        # Reasoning text from the model.
+        variant -> { OpenAI::Responses::ResponseContent::ReasoningTextContent }
+
+        class ReasoningTextContent < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The reasoning text from the model.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The type of the reasoning text. Always `reasoning_text`.
+          #
+          #   @return [Symbol, :reasoning_text]
+          required :type, const: :reasoning_text
+
+          # @!method initialize(text:, type: :reasoning_text)
+          #   Reasoning text from the model.
+          #
+          #   @param text [String] The reasoning text from the model.
+          #
+          #   @param type [Symbol, :reasoning_text] The type of the reasoning text. Always `reasoning_text`.
+        end
+
         # @!method self.variants
-        #   @return [Array(OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile, OpenAI::Models::Responses::ResponseInputAudio, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal)]
+        #   @return [Array(OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile, OpenAI::Models::Responses::ResponseInputAudio, OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContent::ReasoningTextContent)]
       end
     end
   end

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

@@ -25,7 +25,7 @@ module OpenAI
         # @!attribute part
         #   The content part that was added.
         #
-        #   @return [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal]
+        #   @return [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartAddedEvent::Part::ReasoningText]
         required :part, union: -> { OpenAI::Responses::ResponseContentPartAddedEvent::Part }
 
         # @!attribute sequence_number
@@ -52,7 +52,7 @@ module OpenAI
         #
         #   @param output_index [Integer] The index of the output item that the content part was added to.
         #
-        #   @param part [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal] The content part that was added.
+        #   @param part [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartAddedEvent::Part::ReasoningText] The content part that was added.
         #
         #   @param sequence_number [Integer] The sequence number of this event.
         #
@@ -72,8 +72,32 @@ module OpenAI
           # A refusal from the model.
           variant :refusal, -> { OpenAI::Responses::ResponseOutputRefusal }
 
+          # Reasoning text from the model.
+          variant :reasoning_text, -> { OpenAI::Responses::ResponseContentPartAddedEvent::Part::ReasoningText }
+
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            # @!attribute text
+            #   The reasoning text from the model.
+            #
+            #   @return [String]
+            required :text, String
+
+            # @!attribute type
+            #   The type of the reasoning text. Always `reasoning_text`.
+            #
+            #   @return [Symbol, :reasoning_text]
+            required :type, const: :reasoning_text
+
+            # @!method initialize(text:, type: :reasoning_text)
+            #   Reasoning text from the model.
+            #
+            #   @param text [String] The reasoning text from the model.
+            #
+            #   @param type [Symbol, :reasoning_text] The type of the reasoning text. Always `reasoning_text`.
+          end
+
           # @!method self.variants
-          #   @return [Array(OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal)]
+          #   @return [Array(OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartAddedEvent::Part::ReasoningText)]
         end
       end
     end

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

@@ -25,7 +25,7 @@ module OpenAI
         # @!attribute part
         #   The content part that is done.
         #
-        #   @return [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal]
+        #   @return [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartDoneEvent::Part::ReasoningText]
         required :part, union: -> { OpenAI::Responses::ResponseContentPartDoneEvent::Part }
 
         # @!attribute sequence_number
@@ -52,7 +52,7 @@ module OpenAI
         #
         #   @param output_index [Integer] The index of the output item that the content part was added to.
         #
-        #   @param part [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal] The content part that is done.
+        #   @param part [OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartDoneEvent::Part::ReasoningText] The content part that is done.
         #
         #   @param sequence_number [Integer] The sequence number of this event.
         #
@@ -72,8 +72,32 @@ module OpenAI
           # A refusal from the model.
           variant :refusal, -> { OpenAI::Responses::ResponseOutputRefusal }
 
+          # Reasoning text from the model.
+          variant :reasoning_text, -> { OpenAI::Responses::ResponseContentPartDoneEvent::Part::ReasoningText }
+
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            # @!attribute text
+            #   The reasoning text from the model.
+            #
+            #   @return [String]
+            required :text, String
+
+            # @!attribute type
+            #   The type of the reasoning text. Always `reasoning_text`.
+            #
+            #   @return [Symbol, :reasoning_text]
+            required :type, const: :reasoning_text
+
+            # @!method initialize(text:, type: :reasoning_text)
+            #   Reasoning text from the model.
+            #
+            #   @param text [String] The reasoning text from the model.
+            #
+            #   @param type [Symbol, :reasoning_text] The type of the reasoning text. Always `reasoning_text`.
+          end
+
           # @!method self.variants
-          #   @return [Array(OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal)]
+          #   @return [Array(OpenAI::Models::Responses::ResponseOutputText, OpenAI::Models::Responses::ResponseOutputRefusal, OpenAI::Models::Responses::ResponseContentPartDoneEvent::Part::ReasoningText)]
         end
       end
     end

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

@@ -79,8 +79,7 @@ module OpenAI
           required :type, const: :summary_text
 
           # @!method initialize(text:, type: :summary_text)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseReasoningItem::Summary} for more details.
+          #   A summary text from the model.
           #
           #   @param text [String] A summary of the reasoning output from the model so far.
           #
@@ -89,24 +88,23 @@ module OpenAI
 
         class Content < OpenAI::Internal::Type::BaseModel
           # @!attribute text
-          #   Reasoning text output from the model.
+          #   The reasoning text from the model.
           #
           #   @return [String]
           required :text, String
 
           # @!attribute type
-          #   The type of the object. Always `reasoning_text`.
+          #   The type of the reasoning text. Always `reasoning_text`.
           #
           #   @return [Symbol, :reasoning_text]
           required :type, const: :reasoning_text
 
           # @!method initialize(text:, type: :reasoning_text)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseReasoningItem::Content} for more details.
+          #   Reasoning text from the model.
           #
-          #   @param text [String] Reasoning text output from the model.
+          #   @param text [String] The reasoning text from the model.
           #
-          #   @param type [Symbol, :reasoning_text] The type of the object. Always `reasoning_text`.
+          #   @param type [Symbol, :reasoning_text] The type of the reasoning text. Always `reasoning_text`.
         end
 
         # The status of the item. One of `in_progress`, `completed`, or `incomplete`.

data/lib/openai/resources/conversations.rb

@@ -13,7 +13,7 @@ module OpenAI
       #
       # @overload create(items: nil, metadata: nil, request_options: {})
       #
-      # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context.
+      # @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context. You may add up to 20 items
       #
       # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
       #
@@ -33,7 +33,7 @@ module OpenAI
         )
       end
 
-      # Get a conversation with the given ID.
+      # Get a conversation
       #
       # @overload retrieve(conversation_id, request_options: {})
       #
@@ -56,13 +56,13 @@ module OpenAI
       # Some parameter documentations has been truncated, see
       # {OpenAI::Models::Conversations::ConversationUpdateParams} for more details.
       #
-      # Update a conversation's metadata with the given ID.
+      # Update a conversation
       #
       # @overload update(conversation_id, metadata:, request_options: {})
       #
       # @param conversation_id [String] The ID of the conversation to update.
       #
-      # @param metadata [Hash{Symbol=>String}] Set of 16 key-value pairs that can be attached to an object. This can be
+      # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -80,7 +80,7 @@ module OpenAI
         )
       end
 
-      # Delete a conversation with the given ID.
+      # Delete a conversation. Items in the conversation will not be deleted.
       #
       # @overload delete(conversation_id, request_options: {})
       #

data/lib/openai/version.rb

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

data/rbi/openai/models/conversations/conversation_update_params.rbi

@@ -17,24 +17,26 @@ module OpenAI
 
         # Set of 16 key-value pairs that can be attached to an object. This can be useful
         # for storing additional information about the object in a structured format, and
-        # querying for objects via API or the dashboard. Keys are strings with a maximum
-        # length of 64 characters. Values are strings with a maximum length of 512
-        # characters.
-        sig { returns(T::Hash[Symbol, String]) }
+        # querying for objects via API or the dashboard.
+        #
+        # Keys are strings with a maximum length of 64 characters. Values are strings with
+        # a maximum length of 512 characters.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_accessor :metadata
 
         sig do
           params(
-            metadata: T::Hash[Symbol, String],
+            metadata: T.nilable(T::Hash[Symbol, String]),
             request_options: OpenAI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           # Set of 16 key-value pairs that can be attached to an object. This can be useful
           # for storing additional information about the object in a structured format, and
-          # querying for objects via API or the dashboard. Keys are strings with a maximum
-          # length of 64 characters. Values are strings with a maximum length of 512
-          # characters.
+          # querying for objects via API or the dashboard.
+          #
+          # Keys are strings with a maximum length of 64 characters. Values are strings with
+          # a maximum length of 512 characters.
           metadata:,
           request_options: {}
         )
@@ -43,7 +45,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              metadata: T::Hash[Symbol, String],
+              metadata: T.nilable(T::Hash[Symbol, String]),
               request_options: OpenAI::RequestOptions
             }
           )

data/rbi/openai/models/conversations/message.rbi

@@ -44,6 +44,7 @@ module OpenAI
                   OpenAI::Responses::ResponseOutputText::OrHash,
                   OpenAI::Conversations::TextContent::OrHash,
                   OpenAI::Conversations::SummaryTextContent::OrHash,
+                  OpenAI::Conversations::Message::Content::ReasoningText::OrHash,
                   OpenAI::Responses::ResponseOutputRefusal::OrHash,
                   OpenAI::Responses::ResponseInputImage::OrHash,
                   OpenAI::Conversations::ComputerScreenshotContent::OrHash,
@@ -97,6 +98,7 @@ module OpenAI
                 OpenAI::Responses::ResponseOutputText,
                 OpenAI::Conversations::TextContent,
                 OpenAI::Conversations::SummaryTextContent,
+                OpenAI::Conversations::Message::Content::ReasoningText,
                 OpenAI::Responses::ResponseOutputRefusal,
                 OpenAI::Responses::ResponseInputImage,
                 OpenAI::Conversations::ComputerScreenshotContent,
@@ -104,6 +106,38 @@ module OpenAI
               )
             end
 
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Conversations::Message::Content::ReasoningText,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The reasoning text from the model.
+            sig { returns(String) }
+            attr_accessor :text
+
+            # The type of the reasoning text. Always `reasoning_text`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Reasoning text from the model.
+            sig { params(text: String, type: Symbol).returns(T.attached_class) }
+            def self.new(
+              # The reasoning text from the model.
+              text:,
+              # The type of the reasoning text. Always `reasoning_text`.
+              type: :reasoning_text
+            )
+            end
+
+            sig { override.returns({ text: String, type: Symbol }) }
+            def to_hash
+            end
+          end
+
           sig do
             override.returns(
               T::Array[OpenAI::Conversations::Message::Content::Variants]

data/rbi/openai/models/conversations/summary_text_content.rbi

@@ -12,15 +12,22 @@ module OpenAI
             )
           end
 
+        # A summary of the reasoning output from the model so far.
         sig { returns(String) }
         attr_accessor :text
 
+        # The type of the object. Always `summary_text`.
         sig { returns(Symbol) }
         attr_accessor :type
 
         # A summary text from the model.
         sig { params(text: String, type: Symbol).returns(T.attached_class) }
-        def self.new(text:, type: :summary_text)
+        def self.new(
+          # A summary of the reasoning output from the model so far.
+          text:,
+          # The type of the object. Always `summary_text`.
+          type: :summary_text
+        )
         end
 
         sig { override.returns({ text: String, type: Symbol }) }

data/rbi/openai/models/realtime/realtime_mcp_tool_call.rbi

@@ -28,7 +28,7 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :server_label
 
-        # The type of the item. Always `mcp_tool_call`.
+        # The type of the item. Always `mcp_call`.
         sig { returns(Symbol) }
         attr_accessor :type
 
@@ -89,8 +89,8 @@ module OpenAI
           error: nil,
           # The output from the tool call.
           output: nil,
-          # The type of the item. Always `mcp_tool_call`.
-          type: :mcp_tool_call
+          # The type of the item. Always `mcp_call`.
+          type: :mcp_call
         )
         end
 

data/rbi/openai/models/responses/response_content.rbi

@@ -15,10 +15,43 @@ module OpenAI
               OpenAI::Responses::ResponseInputFile,
               OpenAI::Responses::ResponseInputAudio,
               OpenAI::Responses::ResponseOutputText,
-              OpenAI::Responses::ResponseOutputRefusal
+              OpenAI::Responses::ResponseOutputRefusal,
+              OpenAI::Responses::ResponseContent::ReasoningTextContent
             )
           end
 
+        class ReasoningTextContent < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseContent::ReasoningTextContent,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The reasoning text from the model.
+          sig { returns(String) }
+          attr_accessor :text
+
+          # The type of the reasoning text. Always `reasoning_text`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Reasoning text from the model.
+          sig { params(text: String, type: Symbol).returns(T.attached_class) }
+          def self.new(
+            # The reasoning text from the model.
+            text:,
+            # The type of the reasoning text. Always `reasoning_text`.
+            type: :reasoning_text
+          )
+          end
+
+          sig { override.returns({ text: String, type: Symbol }) }
+          def to_hash
+          end
+        end
+
         sig do
           override.returns(
             T::Array[OpenAI::Responses::ResponseContent::Variants]

data/rbi/openai/models/responses/response_content_part_added_event.rbi

@@ -49,7 +49,8 @@ module OpenAI
             part:
               T.any(
                 OpenAI::Responses::ResponseOutputText::OrHash,
-                OpenAI::Responses::ResponseOutputRefusal::OrHash
+                OpenAI::Responses::ResponseOutputRefusal::OrHash,
+                OpenAI::Responses::ResponseContentPartAddedEvent::Part::ReasoningText::OrHash
               ),
             sequence_number: Integer,
             type: Symbol
@@ -95,10 +96,43 @@ module OpenAI
             T.type_alias do
               T.any(
                 OpenAI::Responses::ResponseOutputText,
-                OpenAI::Responses::ResponseOutputRefusal
+                OpenAI::Responses::ResponseOutputRefusal,
+                OpenAI::Responses::ResponseContentPartAddedEvent::Part::ReasoningText
               )
             end
 
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseContentPartAddedEvent::Part::ReasoningText,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The reasoning text from the model.
+            sig { returns(String) }
+            attr_accessor :text
+
+            # The type of the reasoning text. Always `reasoning_text`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Reasoning text from the model.
+            sig { params(text: String, type: Symbol).returns(T.attached_class) }
+            def self.new(
+              # The reasoning text from the model.
+              text:,
+              # The type of the reasoning text. Always `reasoning_text`.
+              type: :reasoning_text
+            )
+            end
+
+            sig { override.returns({ text: String, type: Symbol }) }
+            def to_hash
+            end
+          end
+
           sig do
             override.returns(
               T::Array[

data/rbi/openai/models/responses/response_content_part_done_event.rbi

@@ -49,7 +49,8 @@ module OpenAI
             part:
               T.any(
                 OpenAI::Responses::ResponseOutputText::OrHash,
-                OpenAI::Responses::ResponseOutputRefusal::OrHash
+                OpenAI::Responses::ResponseOutputRefusal::OrHash,
+                OpenAI::Responses::ResponseContentPartDoneEvent::Part::ReasoningText::OrHash
               ),
             sequence_number: Integer,
             type: Symbol
@@ -95,10 +96,43 @@ module OpenAI
             T.type_alias do
               T.any(
                 OpenAI::Responses::ResponseOutputText,
-                OpenAI::Responses::ResponseOutputRefusal
+                OpenAI::Responses::ResponseOutputRefusal,
+                OpenAI::Responses::ResponseContentPartDoneEvent::Part::ReasoningText
               )
             end
 
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseContentPartDoneEvent::Part::ReasoningText,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The reasoning text from the model.
+            sig { returns(String) }
+            attr_accessor :text
+
+            # The type of the reasoning text. Always `reasoning_text`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Reasoning text from the model.
+            sig { params(text: String, type: Symbol).returns(T.attached_class) }
+            def self.new(
+              # The reasoning text from the model.
+              text:,
+              # The type of the reasoning text. Always `reasoning_text`.
+              type: :reasoning_text
+            )
+            end
+
+            sig { override.returns({ text: String, type: Symbol }) }
+            def to_hash
+            end
+          end
+
           sig do
             override.returns(
               T::Array[

data/rbi/openai/models/responses/response_reasoning_item.rbi

@@ -141,6 +141,7 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # A summary text from the model.
           sig { params(text: String, type: Symbol).returns(T.attached_class) }
           def self.new(
             # A summary of the reasoning output from the model so far.
@@ -164,19 +165,20 @@ module OpenAI
               )
             end
 
-          # Reasoning text output from the model.
+          # The reasoning text from the model.
           sig { returns(String) }
           attr_accessor :text
 
-          # The type of the object. Always `reasoning_text`.
+          # The type of the reasoning text. Always `reasoning_text`.
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Reasoning text from the model.
           sig { params(text: String, type: Symbol).returns(T.attached_class) }
           def self.new(
-            # Reasoning text output from the model.
+            # The reasoning text from the model.
             text:,
-            # The type of the object. Always `reasoning_text`.
+            # The type of the reasoning text. Always `reasoning_text`.
             type: :reasoning_text
           )
           end

data/rbi/openai/resources/conversations.rbi

@@ -56,7 +56,7 @@ module OpenAI
       )
       end
 
-      # Get a conversation with the given ID.
+      # Get a conversation
       sig do
         params(
           conversation_id: String,
@@ -70,11 +70,11 @@ module OpenAI
       )
       end
 
-      # Update a conversation's metadata with the given ID.
+      # Update a conversation
       sig do
         params(
           conversation_id: String,
-          metadata: T::Hash[Symbol, String],
+          metadata: T.nilable(T::Hash[Symbol, String]),
           request_options: OpenAI::RequestOptions::OrHash
         ).returns(OpenAI::Conversations::Conversation)
       end
@@ -83,15 +83,16 @@ module OpenAI
         conversation_id,
         # Set of 16 key-value pairs that can be attached to an object. This can be useful
         # for storing additional information about the object in a structured format, and
-        # querying for objects via API or the dashboard. Keys are strings with a maximum
-        # length of 64 characters. Values are strings with a maximum length of 512
-        # characters.
+        # querying for objects via API or the dashboard.
+        #
+        # Keys are strings with a maximum length of 64 characters. Values are strings with
+        # a maximum length of 512 characters.
         metadata:,
         request_options: {}
       )
       end
 
-      # Delete a conversation with the given ID.
+      # Delete a conversation. Items in the conversation will not be deleted.
       sig do
         params(
           conversation_id: String,

data/sig/openai/models/conversations/conversation_update_params.rbs

@@ -2,22 +2,22 @@ module OpenAI
   module Models
     module Conversations
       type conversation_update_params =
-        { metadata: ::Hash[Symbol, String] }
+        { metadata: OpenAI::Models::metadata? }
         & OpenAI::Internal::Type::request_parameters
 
       class ConversationUpdateParams < OpenAI::Internal::Type::BaseModel
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
-        attr_accessor metadata: ::Hash[Symbol, String]
+        attr_accessor metadata: OpenAI::Models::metadata?
 
         def initialize: (
-          metadata: ::Hash[Symbol, String],
+          metadata: OpenAI::Models::metadata?,
           ?request_options: OpenAI::request_opts
         ) -> void
 
         def to_hash: -> {
-          metadata: ::Hash[Symbol, String],
+          metadata: OpenAI::Models::metadata?,
           request_options: OpenAI::RequestOptions
         }
       end

data/sig/openai/models/conversations/message.rbs

@@ -42,6 +42,7 @@ module OpenAI
           | OpenAI::Responses::ResponseOutputText
           | OpenAI::Conversations::TextContent
           | OpenAI::Conversations::SummaryTextContent
+          | OpenAI::Conversations::Message::Content::ReasoningText
           | OpenAI::Responses::ResponseOutputRefusal
           | OpenAI::Responses::ResponseInputImage
           | OpenAI::Conversations::ComputerScreenshotContent
@@ -50,6 +51,18 @@ module OpenAI
         module Content
           extend OpenAI::Internal::Type::Union
 
+          type reasoning_text = { text: String, type: :reasoning_text }
+
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            attr_accessor text: String
+
+            attr_accessor type: :reasoning_text
+
+            def initialize: (text: String, ?type: :reasoning_text) -> void
+
+            def to_hash: -> { text: String, type: :reasoning_text }
+          end
+
           def self?.variants: -> ::Array[OpenAI::Models::Conversations::Message::content]
         end
 

data/sig/openai/models/realtime/realtime_mcp_tool_call.rbs

@@ -7,7 +7,7 @@ module OpenAI
           arguments: String,
           name: String,
           server_label: String,
-          type: :mcp_tool_call,
+          type: :mcp_call,
           approval_request_id: String?,
           error: OpenAI::Models::Realtime::RealtimeMcpToolCall::error?,
           output: String?
@@ -22,7 +22,7 @@ module OpenAI
 
         attr_accessor server_label: String
 
-        attr_accessor type: :mcp_tool_call
+        attr_accessor type: :mcp_call
 
         attr_accessor approval_request_id: String?
 
@@ -38,7 +38,7 @@ module OpenAI
           ?approval_request_id: String?,
           ?error: OpenAI::Models::Realtime::RealtimeMcpToolCall::error?,
           ?output: String?,
-          ?type: :mcp_tool_call
+          ?type: :mcp_call
         ) -> void
 
         def to_hash: -> {
@@ -46,7 +46,7 @@ module OpenAI
           arguments: String,
           name: String,
           server_label: String,
-          type: :mcp_tool_call,
+          type: :mcp_call,
           approval_request_id: String?,
           error: OpenAI::Models::Realtime::RealtimeMcpToolCall::error?,
           output: String?

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

@@ -8,10 +8,23 @@ module OpenAI
         | OpenAI::Responses::ResponseInputAudio
         | OpenAI::Responses::ResponseOutputText
         | OpenAI::Responses::ResponseOutputRefusal
+        | OpenAI::Responses::ResponseContent::ReasoningTextContent
 
       module ResponseContent
         extend OpenAI::Internal::Type::Union
 
+        type reasoning_text_content = { text: String, type: :reasoning_text }
+
+        class ReasoningTextContent < OpenAI::Internal::Type::BaseModel
+          attr_accessor text: String
+
+          attr_accessor type: :reasoning_text
+
+          def initialize: (text: String, ?type: :reasoning_text) -> void
+
+          def to_hash: -> { text: String, type: :reasoning_text }
+        end
+
         def self?.variants: -> ::Array[OpenAI::Models::Responses::response_content]
       end
     end

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

@@ -45,10 +45,23 @@ module OpenAI
         type part =
           OpenAI::Responses::ResponseOutputText
           | OpenAI::Responses::ResponseOutputRefusal
+          | OpenAI::Responses::ResponseContentPartAddedEvent::Part::ReasoningText
 
         module Part
           extend OpenAI::Internal::Type::Union
 
+          type reasoning_text = { text: String, type: :reasoning_text }
+
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            attr_accessor text: String
+
+            attr_accessor type: :reasoning_text
+
+            def initialize: (text: String, ?type: :reasoning_text) -> void
+
+            def to_hash: -> { text: String, type: :reasoning_text }
+          end
+
           def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseContentPartAddedEvent::part]
         end
       end

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

@@ -45,10 +45,23 @@ module OpenAI
         type part =
           OpenAI::Responses::ResponseOutputText
           | OpenAI::Responses::ResponseOutputRefusal
+          | OpenAI::Responses::ResponseContentPartDoneEvent::Part::ReasoningText
 
         module Part
           extend OpenAI::Internal::Type::Union
 
+          type reasoning_text = { text: String, type: :reasoning_text }
+
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            attr_accessor text: String
+
+            attr_accessor type: :reasoning_text
+
+            def initialize: (text: String, ?type: :reasoning_text) -> void
+
+            def to_hash: -> { text: String, type: :reasoning_text }
+          end
+
           def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseContentPartDoneEvent::part]
         end
       end

data/sig/openai/resources/conversations.rbs

@@ -16,7 +16,7 @@ module OpenAI
 
       def update: (
         String conversation_id,
-        metadata: ::Hash[Symbol, String],
+        metadata: OpenAI::Models::metadata?,
         ?request_options: OpenAI::request_opts
       ) -> OpenAI::Conversations::Conversation
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.1
 platform: ruby
 authors:
 - OpenAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-17 00:00:00.000000000 Z
+date: 2025-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool