openai 0.16.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78e829792412e459c6e623de5db5f553d7d1325fa28300ae94c62103d511c946
-  data.tar.gz: e7711af3f619a26ac688445353ee83b8ca250cad3feb84358f0a556650662e0b
+  metadata.gz: f9090d21fb7dcdd5e12c607bbe02aa7c1e7336e02148fec0465b21cc43bb9d45
+  data.tar.gz: 61662c62cde77fefb5bec16ce51127efd60b4f71542d2bcf2c48f0225ecb29f9
 SHA512:
-  metadata.gz: 3a6d15ee5239db7f9f8fe2494169ce279c26435bc7b83a5b8ecb2dfde47da5f6636f6db49a29f429b7fca35b58d90136d06f7de4e49677ee37fb94b899f518da
-  data.tar.gz: 1f6659074cc6e2317b47e0677a928765d9d8b73e898f7c2ee0eb435dc1fa0728df18f64859a6a732ec3beaaa1db16a5e96176eb1bdda174ac9368cccd0a243a2
+  metadata.gz: '08c00969160cc09128778848c99704501b192ca61ed7a845f5d9ead7a59eedd7762b5c0e3e941b4b016b2baa935200d59e8d480a55b82dbd5ebeeb58d94660a4'
+  data.tar.gz: 3386e4858cfe7ce20c46b10ac51f2cfa403f963bf0ef33e1eedb70f8eeb14076f539729700f442f65b6535bea30b8a9638e8c43bc79e6a7af56a8efaaf26f907

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 0.17.1 (2025-08-09)
+
+Full Changelog: [v0.17.0...v0.17.1](https://github.com/openai/openai-ruby/compare/v0.17.0...v0.17.1)
+
+### Chores
+
+* collect metadata from type DSL ([d63cb9e](https://github.com/openai/openai-ruby/commit/d63cb9eb8efc60d43bd17c96bb6dc1e3b4254b26))
+* **internal:** update comment in script ([a08be47](https://github.com/openai/openai-ruby/commit/a08be4787dfc910a7c9cc06bc72f9c40b40250a4))
+
+## 0.17.0 (2025-08-08)
+
+Full Changelog: [v0.16.0...v0.17.0](https://github.com/openai/openai-ruby/compare/v0.16.0...v0.17.0)
+
+### Features
+
+* **api:** adds GPT-5 and new API features: platform.openai.com/docs/guides/gpt-5 ([068a381](https://github.com/openai/openai-ruby/commit/068a381a17dd2d60865e67fcd17fa84d919f3f5c))
+* **api:** manual updates ([1d79621](https://github.com/openai/openai-ruby/commit/1d79621120fbccc8dd41f5af6df5a9b1a9018e73))
+
+
+### Bug Fixes
+
+* **client:** dont try to parse if content is missing ([#770](https://github.com/openai/openai-ruby/issues/770)) ([7f8f2d3](https://github.com/openai/openai-ruby/commit/7f8f2d32863fafc39ee4a884937673a2ad9be358))
+* **client:** fix verbosity parameter location in Responses ([a6b7ae8](https://github.com/openai/openai-ruby/commit/a6b7ae8b568c2214d4883fad44c9cf2e8a7d53e2))
+* **internal:** fix rbi error ([803f20b](https://github.com/openai/openai-ruby/commit/803f20ba0c3751d28175dca99853783f0d851645))
+* **respones:** undo accidently deleted fields ([#177](https://github.com/openai/openai-ruby/issues/177)) ([90a7c3a](https://github.com/openai/openai-ruby/commit/90a7c3ac8d22cc90b8ecaa3b091598ea3bc73029))
+* **responses:** remove incorrect verbosity param ([127e2d1](https://github.com/openai/openai-ruby/commit/127e2d1b96b72307178446f0aa8acc1d3ad31367))
+
+
+### Chores
+
+* **internal:** increase visibility of internal helper method ([eddbcda](https://github.com/openai/openai-ruby/commit/eddbcda189ac0a864fc3dadc5dd3578d730c491f))
+* update @stainless-api/prism-cli to v5.15.0 ([aaa7d89](https://github.com/openai/openai-ruby/commit/aaa7d895a3dba31f32cf5f4373a49d1571667fc6))
+
 ## 0.16.0 (2025-07-30)
 
 Full Changelog: [v0.15.0...v0.16.0](https://github.com/openai/openai-ruby/compare/v0.15.0...v0.16.0)

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.16.0"
+gem "openai", "~> 0.17.1"
 ```
 
 <!-- x-release-please-end -->
@@ -30,10 +30,7 @@ openai = OpenAI::Client.new(
   api_key: ENV["OPENAI_API_KEY"] # This is the default and can be omitted
 )
 
-chat_completion = openai.chat.completions.create(
-  messages: [{role: "user", content: "Say this is a test"}],
-  model: :"gpt-4.1"
-)
+chat_completion = openai.chat.completions.create(messages: [{role: "user", content: "Say this is a test"}], model: :"gpt-5")
 
 puts(chat_completion)
 ```
@@ -45,7 +42,7 @@ We provide support for streaming responses using Server-Sent Events (SSE).
 ```ruby
 stream = openai.responses.stream(
   input: "Write a haiku about OpenAI.",
-  model: :"gpt-4.1"
+  model: :"gpt-5"
 )
 
 stream.each do |event|
@@ -343,7 +340,7 @@ openai = OpenAI::Client.new(
 # Or, configure per-request:
 openai.chat.completions.create(
   messages: [{role: "user", content: "How can I get the name of the current day in JavaScript?"}],
-  model: :"gpt-4.1",
+  model: :"gpt-5",
   request_options: {max_retries: 5}
 )
 ```
@@ -361,7 +358,7 @@ openai = OpenAI::Client.new(
 # Or, configure per-request:
 openai.chat.completions.create(
   messages: [{role: "user", content: "How can I list all files in a directory using Python?"}],
-  model: :"gpt-4.1",
+  model: :"gpt-5",
   request_options: {timeout: 5}
 )
 ```
@@ -396,7 +393,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 chat_completion =
   openai.chat.completions.create(
     messages: [{role: "user", content: "How can I get the name of the current day in JavaScript?"}],
-    model: :"gpt-4.1",
+    model: :"gpt-5",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -444,7 +441,7 @@ You can provide typesafe request parameters like so:
 ```ruby
 openai.chat.completions.create(
   messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(content: "Say this is a test")],
-  model: :"gpt-4.1"
+  model: :"gpt-5"
 )
 ```
 
@@ -452,15 +449,12 @@ Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-openai.chat.completions.create(
-  messages: [{role: "user", content: "Say this is a test"}],
-  model: :"gpt-4.1"
-)
+openai.chat.completions.create(messages: [{role: "user", content: "Say this is a test"}], model: :"gpt-5")
 
 # You can also splat a full Params class:
 params = OpenAI::Chat::CompletionCreateParams.new(
   messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(content: "Say this is a test")],
-  model: :"gpt-4.1"
+  model: :"gpt-5"
 )
 openai.chat.completions.create(**params)
 ```
@@ -470,11 +464,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
-# :low
-puts(OpenAI::ReasoningEffort::LOW)
+# :minimal
+puts(OpenAI::ReasoningEffort::MINIMAL)
 
 # Revealed type: `T.all(OpenAI::ReasoningEffort, Symbol)`
-T.reveal_type(OpenAI::ReasoningEffort::LOW)
+T.reveal_type(OpenAI::ReasoningEffort::MINIMAL)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
@@ -482,13 +476,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(
-  reasoning_effort: OpenAI::ReasoningEffort::LOW,
+  reasoning_effort: OpenAI::ReasoningEffort::MINIMAL,
   # …
 )
 
 # Literal values are also permissible:
 openai.chat.completions.create(
-  reasoning_effort: :low,
+  reasoning_effort: :minimal,
   # …
 )
 ```

data/lib/openai/internal/transport/base_client.rb

@@ -365,7 +365,7 @@ module OpenAI
         #
         # @raise [OpenAI::Errors::APIError]
         # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
-        private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
+        def send_request(request, redirect_count:, retry_count:, send_retry_header:)
           url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
           input = {**request.except(:timeout), deadline: OpenAI::Internal::Util.monotonic_secs + timeout}
 

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

@@ -148,6 +148,7 @@ module OpenAI
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = OpenAI::Internal::Type::Converter.type_info(type_info || spec)
+          @meta = OpenAI::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 

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

@@ -52,6 +52,7 @@ module OpenAI
           #
           #   @option spec [Boolean] :"nil?"
           private def add_field(name_sym, required:, type_info:, spec:)
+            meta = OpenAI::Internal::Type::Converter.meta_info(type_info, spec)
             type_fn, info =
               case type_info
               in Proc | OpenAI::Internal::Type::Converter | Class
@@ -74,7 +75,8 @@ module OpenAI
                 required: required,
                 nilable: nilable,
                 const: const,
-                type_fn: type_fn
+                type_fn: type_fn,
+                meta: meta
               }
 
             define_method(setter) do |value|

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

@@ -98,6 +98,33 @@ module OpenAI
             end
           end
 
+          # @api private
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, OpenAI::Internal::Type::Converter, Class] .
+          #
+          #   @option type_info [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
+          #
+          #   @option type_info [Proc] :enum
+          #
+          #   @option type_info [Proc] :union
+          #
+          #   @option type_info [Boolean] :"nil?"
+          #
+          # @param spec [Hash{Symbol=>Object}, Proc, OpenAI::Internal::Type::Converter, Class] .
+          #
+          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
+          #
+          #   @option spec [Proc] :enum
+          #
+          #   @option spec [Proc] :union
+          #
+          #   @option spec [Boolean] :"nil?"
+          #
+          # @return [Hash{Symbol=>Object}]
+          def meta_info(type_info, spec)
+            [spec, type_info].grep(Hash).first.to_h.except(:const, :enum, :union, :nil?)
+          end
+
           # @api private
           #
           # @param translate_names [Boolean]

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_4_1
+      #   when OpenAI::ChatModel::GPT_5
       #     # ...
-      #   when OpenAI::ChatModel::GPT_4_1_MINI
+      #   when OpenAI::ChatModel::GPT_5_MINI
       #     # ...
-      #   when OpenAI::ChatModel::GPT_4_1_NANO
+      #   when OpenAI::ChatModel::GPT_5_NANO
       #     # ...
       #   else
       #     puts(chat_model)
@@ -31,11 +31,11 @@ module OpenAI
       #
       # @example
       #   case chat_model
-      #   in :"gpt-4.1"
+      #   in :"gpt-5"
       #     # ...
-      #   in :"gpt-4.1-mini"
+      #   in :"gpt-5-mini"
       #     # ...
-      #   in :"gpt-4.1-nano"
+      #   in :"gpt-5-nano"
       #     # ...
       #   else
       #     puts(chat_model)

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

@@ -168,6 +168,7 @@ module OpenAI
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = OpenAI::Internal::Type::Converter.type_info(type_info || spec)
+          @meta = OpenAI::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 

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

@@ -6,28 +6,24 @@ module OpenAI
       # @api private
       #
       # @example
-      #   # `chat_completion_content_part` is a `OpenAI::Chat::ChatCompletionContentPart`
-      #   case chat_completion_content_part
-      #   when OpenAI::Chat::ChatCompletionContentPartText
-      #     puts(chat_completion_content_part.text)
-      #   when OpenAI::Chat::ChatCompletionContentPartImage
-      #     puts(chat_completion_content_part.image_url)
-      #   when OpenAI::Chat::ChatCompletionContentPartInputAudio
-      #     puts(chat_completion_content_part.input_audio)
+      #   # `custom_tool_input_format` is a `OpenAI::CustomToolInputFormat`
+      #   case custom_tool_input_format
+      #   when OpenAI::CustomToolInputFormat::Text
+      #     puts(custom_tool_input_format.type)
+      #   when OpenAI::CustomToolInputFormat::Grammar
+      #     puts(custom_tool_input_format.definition)
       #   else
-      #     puts(chat_completion_content_part)
+      #     puts(custom_tool_input_format)
       #   end
       #
       # @example
-      #   case chat_completion_content_part
-      #   in {type: :text, text: text}
-      #     puts(text)
-      #   in {type: :image_url, image_url: image_url}
-      #     puts(image_url)
-      #   in {type: :input_audio, input_audio: input_audio}
-      #     puts(input_audio)
+      #   case custom_tool_input_format
+      #   in {type: :text}
+      #     # ...
+      #   in {type: :grammar, definition: definition, syntax: syntax}
+      #     puts(definition)
       #   else
-      #     puts(chat_completion_content_part)
+      #     puts(custom_tool_input_format)
       #   end
       module Union
         include OpenAI::Internal::Type::Converter
@@ -37,20 +33,20 @@ module OpenAI
         #
         # All of the specified variant info for this union.
         #
-        # @return [Array<Array(Symbol, Proc)>]
+        # @return [Array<Array(Symbol, Proc, Hash{Symbol=>Object})>]
         private def known_variants = (@known_variants ||= [])
 
         # @api private
         #
-        # @return [Array<Array(Symbol, Object)>]
+        # @return [Array<Array(Symbol, Object, Hash{Symbol=>Object})>]
         protected def derefed_variants
-          known_variants.map { |key, variant_fn| [key, variant_fn.call] }
+          known_variants.map { |key, variant_fn, meta| [key, variant_fn.call, meta] }
         end
 
         # All of the specified variants for this union.
         #
         # @return [Array<Object>]
-        def variants = derefed_variants.map(&:last)
+        def variants = derefed_variants.map { _2 }
 
         # @api private
         #
@@ -76,12 +72,13 @@ module OpenAI
         #
         #   @option spec [Boolean] :"nil?"
         private def variant(key, spec = nil)
+          meta = OpenAI::Internal::Type::Converter.meta_info(nil, spec)
           variant_info =
             case key
             in Symbol
-              [key, OpenAI::Internal::Type::Converter.type_info(spec)]
+              [key, OpenAI::Internal::Type::Converter.type_info(spec), meta]
             in Proc | OpenAI::Internal::Type::Converter | Class | Hash
-              [nil, OpenAI::Internal::Type::Converter.type_info(key)]
+              [nil, OpenAI::Internal::Type::Converter.type_info(key), meta]
             end
 
           known_variants << variant_info
@@ -104,7 +101,8 @@ module OpenAI
             return nil if key == OpenAI::Internal::OMIT
 
             key = key.to_sym if key.is_a?(String)
-            known_variants.find { |k,| k == key }&.last&.call
+            _, found = known_variants.find { |k,| k == key }
+            found&.call
           else
             nil
           end

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

@@ -49,12 +49,11 @@ module OpenAI
         optional :name, String, nil?: true
 
         # @!attribute reasoning_effort
-        #   **o-series models only**
-        #
         #   Constrains effort on reasoning for
         #   [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-        #   supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-        #   result in faster responses and fewer tokens used on reasoning in a response.
+        #   supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+        #   effort can result in faster responses and fewer tokens used on reasoning in a
+        #   response.
         #
         #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
         optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -133,7 +132,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] **o-series models only**
+        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
         #
         #   @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

@@ -49,12 +49,11 @@ module OpenAI
         optional :name, String, nil?: true
 
         # @!attribute reasoning_effort
-        #   **o-series models only**
-        #
         #   Constrains effort on reasoning for
         #   [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-        #   supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-        #   result in faster responses and fewer tokens used on reasoning in a response.
+        #   supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+        #   effort can result in faster responses and fewer tokens used on reasoning in a
+        #   response.
         #
         #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
         optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -133,7 +132,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] **o-series models only**
+        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
         #
         #   @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:
         #
@@ -157,6 +156,18 @@ module OpenAI
 
           variant String
 
+          variant const: -> { OpenAI::Models::Beta::AssistantUpdateParams::Model::GPT_5 }
+
+          variant const: -> { OpenAI::Models::Beta::AssistantUpdateParams::Model::GPT_5_MINI }
+
+          variant const: -> { OpenAI::Models::Beta::AssistantUpdateParams::Model::GPT_5_NANO }
+
+          variant const: -> { OpenAI::Models::Beta::AssistantUpdateParams::Model::GPT_5_2025_08_07 }
+
+          variant const: -> { OpenAI::Models::Beta::AssistantUpdateParams::Model::GPT_5_MINI_2025_08_07 }
+
+          variant const: -> { OpenAI::Models::Beta::AssistantUpdateParams::Model::GPT_5_NANO_2025_08_07 }
+
           variant const: -> { OpenAI::Models::Beta::AssistantUpdateParams::Model::GPT_4_1 }
 
           variant const: -> { OpenAI::Models::Beta::AssistantUpdateParams::Model::GPT_4_1_MINI }
@@ -238,6 +249,12 @@ module OpenAI
 
           # @!group
 
+          GPT_5 = :"gpt-5"
+          GPT_5_MINI = :"gpt-5-mini"
+          GPT_5_NANO = :"gpt-5-nano"
+          GPT_5_2025_08_07 = :"gpt-5-2025-08-07"
+          GPT_5_MINI_2025_08_07 = :"gpt-5-mini-2025-08-07"
+          GPT_5_NANO_2025_08_07 = :"gpt-5-nano-2025-08-07"
           GPT_4_1 = :"gpt-4.1"
           GPT_4_1_MINI = :"gpt-4.1-mini"
           GPT_4_1_NANO = :"gpt-4.1-nano"

data/lib/openai/models/beta/threads/run_create_params.rb

@@ -107,12 +107,11 @@ module OpenAI
           optional :parallel_tool_calls, OpenAI::Internal::Type::Boolean
 
           # @!attribute reasoning_effort
-          #   **o-series models only**
-          #
           #   Constrains effort on reasoning for
           #   [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
-          #   supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
-          #   result in faster responses and fewer tokens used on reasoning in a response.
+          #   supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
+          #   effort can result in faster responses and fewer tokens used on reasoning in a
+          #   response.
           #
           #   @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
           optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -216,7 +215,7 @@ module OpenAI
           #
           #   @param parallel_tool_calls [Boolean] Whether to enable [parallel function calling](https://platform.openai.com/docs/g
           #
-          #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] **o-series models only**
+          #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
           #
           #   @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/chat/chat_completion_allowed_tool_choice.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Chat
+      class ChatCompletionAllowedToolChoice < OpenAI::Internal::Type::BaseModel
+        # @!attribute allowed_tools
+        #   Constrains the tools available to the model to a pre-defined set.
+        #
+        #   @return [OpenAI::Models::Chat::ChatCompletionAllowedTools]
+        required :allowed_tools, -> { OpenAI::Chat::ChatCompletionAllowedTools }
+
+        # @!attribute type
+        #   Allowed tool configuration type. Always `allowed_tools`.
+        #
+        #   @return [Symbol, :allowed_tools]
+        required :type, const: :allowed_tools
+
+        # @!method initialize(allowed_tools:, type: :allowed_tools)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Chat::ChatCompletionAllowedToolChoice} for more details.
+        #
+        #   Constrains the tools available to the model to a pre-defined set.
+        #
+        #   @param allowed_tools [OpenAI::Models::Chat::ChatCompletionAllowedTools] Constrains the tools available to the model to a pre-defined set.
+        #
+        #   @param type [Symbol, :allowed_tools] Allowed tool configuration type. Always `allowed_tools`.
+      end
+    end
+
+    ChatCompletionAllowedToolChoice = Chat::ChatCompletionAllowedToolChoice
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Chat
+      class ChatCompletionAllowedTools < OpenAI::Internal::Type::BaseModel
+        # @!attribute mode
+        #   Constrains the tools available to the model to a pre-defined set.
+        #
+        #   `auto` allows the model to pick from among the allowed tools and generate a
+        #   message.
+        #
+        #   `required` requires the model to call one or more of the allowed tools.
+        #
+        #   @return [Symbol, OpenAI::Models::Chat::ChatCompletionAllowedTools::Mode]
+        required :mode, enum: -> { OpenAI::Chat::ChatCompletionAllowedTools::Mode }
+
+        # @!attribute tools
+        #   A list of tool definitions that the model should be allowed to call.
+        #
+        #   For the Chat Completions API, the list of tool definitions might look like:
+        #
+        #   ```json
+        #   [
+        #     { "type": "function", "function": { "name": "get_weather" } },
+        #     { "type": "function", "function": { "name": "get_time" } }
+        #   ]
+        #   ```
+        #
+        #   @return [Array<Hash{Symbol=>Object}>]
+        required :tools,
+                 OpenAI::Internal::Type::ArrayOf[OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]]
+
+        # @!method initialize(mode:, tools:)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Chat::ChatCompletionAllowedTools} for more details.
+        #
+        #   Constrains the tools available to the model to a pre-defined set.
+        #
+        #   @param mode [Symbol, OpenAI::Models::Chat::ChatCompletionAllowedTools::Mode] Constrains the tools available to the model to a pre-defined set.
+        #
+        #   @param tools [Array<Hash{Symbol=>Object}>] A list of tool definitions that the model should be allowed to call.
+
+        # Constrains the tools available to the model to a pre-defined set.
+        #
+        # `auto` allows the model to pick from among the allowed tools and generate a
+        # message.
+        #
+        # `required` requires the model to call one or more of the allowed tools.
+        #
+        # @see OpenAI::Models::Chat::ChatCompletionAllowedTools#mode
+        module Mode
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO = :auto
+          REQUIRED = :required
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -55,11 +55,9 @@ module OpenAI
         # @!attribute tool_calls
         #   The tool calls generated by the model, such as function calls.
         #
-        #   @return [Array<OpenAI::Models::Chat::ChatCompletionMessageToolCall>, nil]
+        #   @return [Array<OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall, OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall>, nil]
         optional :tool_calls,
-                 -> {
-                   OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionMessageToolCall]
-                 }
+                 -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Chat::ChatCompletionMessageToolCall] }
 
         # @!method initialize(audio: nil, content: nil, function_call: nil, name: nil, refusal: nil, tool_calls: nil, role: :assistant)
         #   Some parameter documentations has been truncated, see
@@ -77,7 +75,7 @@ module OpenAI
         #
         #   @param refusal [String, nil] The refusal message by the assistant.
         #
-        #   @param tool_calls [Array<OpenAI::Models::Chat::ChatCompletionMessageToolCall>] The tool calls generated by the model, such as function calls.
+        #   @param tool_calls [Array<OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall, OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall>] The tool calls generated by the model, such as function calls.
         #
         #   @param role [Symbol, :assistant] The role of the messages author, in this case `assistant`.