openai 0.16.0 → 0.17.0

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

@@ -56,11 +56,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(content:, refusal:, annotations: nil, audio: nil, function_call: nil, tool_calls: nil, role: :assistant)
         #   Some parameter documentations has been truncated, see
@@ -78,7 +76,7 @@ module OpenAI
         #
         #   @param function_call [OpenAI::Models::Chat::ChatCompletionMessage::FunctionCall] Deprecated and replaced by `tool_calls`. The name and arguments of a function th
         #
-        #   @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 author of this message.
 

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Chat
+      class ChatCompletionMessageCustomToolCall < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the tool call.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute custom
+        #   The custom tool that the model called.
+        #
+        #   @return [OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall::Custom]
+        required :custom, -> { OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom }
+
+        # @!attribute type
+        #   The type of the tool. Always `custom`.
+        #
+        #   @return [Symbol, :custom]
+        required :type, const: :custom
+
+        # @!method initialize(id:, custom:, type: :custom)
+        #   A call to a custom tool created by the model.
+        #
+        #   @param id [String] The ID of the tool call.
+        #
+        #   @param custom [OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall::Custom] The custom tool that the model called.
+        #
+        #   @param type [Symbol, :custom] The type of the tool. Always `custom`.
+
+        # @see OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall#custom
+        class Custom < OpenAI::Internal::Type::BaseModel
+          # @!attribute input
+          #   The input for the custom tool call generated by the model.
+          #
+          #   @return [String]
+          required :input, String
+
+          # @!attribute name
+          #   The name of the custom tool to call.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(input:, name:)
+          #   The custom tool that the model called.
+          #
+          #   @param input [String] The input for the custom tool call generated by the model.
+          #
+          #   @param name [String] The name of the custom tool to call.
+        end
+      end
+    end
+
+    ChatCompletionMessageCustomToolCall = Chat::ChatCompletionMessageCustomToolCall
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Chat
+      class ChatCompletionMessageFunctionToolCall < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the tool call.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute function
+        #   The function that the model called.
+        #
+        #   @return [OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall::Function]
+        required :function, -> { OpenAI::Chat::ChatCompletionMessageFunctionToolCall::Function }
+
+        # @!attribute type
+        #   The type of the tool. Currently, only `function` is supported.
+        #
+        #   @return [Symbol, :function]
+        required :type, const: :function
+
+        # @!method initialize(id:, function:, type: :function)
+        #   A call to a function tool created by the model.
+        #
+        #   @param id [String] The ID of the tool call.
+        #
+        #   @param function [OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall::Function] The function that the model called.
+        #
+        #   @param type [Symbol, :function] The type of the tool. Currently, only `function` is supported.
+
+        # @see OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall#function
+        class Function < OpenAI::Internal::Type::BaseModel
+          # @!attribute arguments
+          #   The arguments to call the function with, as generated by the model in JSON
+          #   format. Note that the model does not always generate valid JSON, and may
+          #   hallucinate parameters not defined by your function schema. Validate the
+          #   arguments in your code before calling your function.
+          #
+          #   @return [String]
+          required :arguments, String
+
+          # @!attribute parsed
+          #   The parsed contents of the arguments.
+          #
+          #   @return [Object, nil]
+          required :parsed, OpenAI::StructuredOutput::ParsedJson
+
+          # @!attribute name
+          #   The name of the function to call.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(arguments:, name:)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall::Function} for more
+          #   details.
+          #
+          #   The function that the model called.
+          #
+          #   @param arguments [String] The arguments to call the function with, as generated by the model in JSON forma
+          #
+          #   @param name [String] The name of the function to call.
+        end
+      end
+    end
+
+    ChatCompletionMessageFunctionToolCall = Chat::ChatCompletionMessageFunctionToolCall
+  end
+end

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

@@ -3,66 +3,20 @@
 module OpenAI
   module Models
     module Chat
-      class ChatCompletionMessageToolCall < OpenAI::Internal::Type::BaseModel
-        # @!attribute id
-        #   The ID of the tool call.
-        #
-        #   @return [String]
-        required :id, String
+      # A call to a function tool created by the model.
+      module ChatCompletionMessageToolCall
+        extend OpenAI::Internal::Type::Union
 
-        # @!attribute function
-        #   The function that the model called.
-        #
-        #   @return [OpenAI::Models::Chat::ChatCompletionMessageToolCall::Function]
-        required :function, -> { OpenAI::Chat::ChatCompletionMessageToolCall::Function }
+        discriminator :type
 
-        # @!attribute type
-        #   The type of the tool. Currently, only `function` is supported.
-        #
-        #   @return [Symbol, :function]
-        required :type, const: :function
+        # A call to a function tool created by the model.
+        variant :function, -> { OpenAI::Chat::ChatCompletionMessageFunctionToolCall }
 
-        # @!method initialize(id:, function:, type: :function)
-        #   @param id [String] The ID of the tool call.
-        #
-        #   @param function [OpenAI::Models::Chat::ChatCompletionMessageToolCall::Function] The function that the model called.
-        #
-        #   @param type [Symbol, :function] The type of the tool. Currently, only `function` is supported.
+        # A call to a custom tool created by the model.
+        variant :custom, -> { OpenAI::Chat::ChatCompletionMessageCustomToolCall }
 
-        # @see OpenAI::Models::Chat::ChatCompletionMessageToolCall#function
-        class Function < OpenAI::Internal::Type::BaseModel
-          # @!attribute arguments
-          #   The arguments to call the function with, as generated by the model in JSON
-          #   format. Note that the model does not always generate valid JSON, and may
-          #   hallucinate parameters not defined by your function schema. Validate the
-          #   arguments in your code before calling your function.
-          #
-          #   @return [String]
-          required :arguments, String
-
-          # @!attribute parsed
-          #   The parsed contents of the arguments.
-          #
-          #   @return [Object, nil]
-          required :parsed, OpenAI::StructuredOutput::ParsedJson
-
-          # @!attribute name
-          #   The name of the function to call.
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!method initialize(arguments:, name:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletionMessageToolCall::Function} for more
-          #   details.
-          #
-          #   The function that the model called.
-          #
-          #   @param arguments [String] The arguments to call the function with, as generated by the model in JSON forma
-          #
-          #   @param name [String] The name of the function to call.
-        end
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall, OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall)]
       end
     end
 

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

@@ -10,7 +10,7 @@ module OpenAI
         required :function, -> { OpenAI::Chat::ChatCompletionNamedToolChoice::Function }
 
         # @!attribute type
-        #   The type of the tool. Currently, only `function` is supported.
+        #   For function calling, the type is always `function`.
         #
         #   @return [Symbol, :function]
         required :type, const: :function
@@ -21,7 +21,7 @@ module OpenAI
         #
         #   @param function [OpenAI::Models::Chat::ChatCompletionNamedToolChoice::Function]
         #
-        #   @param type [Symbol, :function] The type of the tool. Currently, only `function` is supported.
+        #   @param type [Symbol, :function] For function calling, the type is always `function`.
 
         # @see OpenAI::Models::Chat::ChatCompletionNamedToolChoice#function
         class Function < OpenAI::Internal::Type::BaseModel

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Chat
+      class ChatCompletionNamedToolChoiceCustom < OpenAI::Internal::Type::BaseModel
+        # @!attribute custom
+        #
+        #   @return [OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom::Custom]
+        required :custom, -> { OpenAI::Chat::ChatCompletionNamedToolChoiceCustom::Custom }
+
+        # @!attribute type
+        #   For custom tool calling, the type is always `custom`.
+        #
+        #   @return [Symbol, :custom]
+        required :type, const: :custom
+
+        # @!method initialize(custom:, type: :custom)
+        #   Specifies a tool the model should use. Use to force the model to call a specific
+        #   custom tool.
+        #
+        #   @param custom [OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom::Custom]
+        #
+        #   @param type [Symbol, :custom] For custom tool calling, the type is always `custom`.
+
+        # @see OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom#custom
+        class Custom < OpenAI::Internal::Type::BaseModel
+          # @!attribute name
+          #   The name of the custom tool to call.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(name:)
+          #   @param name [String] The name of the custom tool to call.
+        end
+      end
+    end
+
+    ChatCompletionNamedToolChoiceCustom = Chat::ChatCompletionNamedToolChoiceCustom
+  end
+end

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

@@ -4,6 +4,17 @@ module OpenAI
   module Models
     module Chat
       class ChatCompletionStreamOptions < OpenAI::Internal::Type::BaseModel
+        # @!attribute include_obfuscation
+        #   When true, stream obfuscation will be enabled. Stream obfuscation adds random
+        #   characters to an `obfuscation` field on streaming delta events to normalize
+        #   payload sizes as a mitigation to certain side-channel attacks. These obfuscation
+        #   fields are included by default, but add a small amount of overhead to the data
+        #   stream. You can set `include_obfuscation` to false to optimize for bandwidth if
+        #   you trust the network links between your application and the OpenAI API.
+        #
+        #   @return [Boolean, nil]
+        optional :include_obfuscation, OpenAI::Internal::Type::Boolean
+
         # @!attribute include_usage
         #   If set, an additional chunk will be streamed before the `data: [DONE]` message.
         #   The `usage` field on this chunk shows the token usage statistics for the entire
@@ -16,12 +27,14 @@ module OpenAI
         #   @return [Boolean, nil]
         optional :include_usage, OpenAI::Internal::Type::Boolean
 
-        # @!method initialize(include_usage: nil)
+        # @!method initialize(include_obfuscation: nil, include_usage: nil)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Chat::ChatCompletionStreamOptions} for more details.
         #
         #   Options for streaming response. Only set this when you set `stream: true`.
         #
+        #   @param include_obfuscation [Boolean] When true, stream obfuscation will be enabled. Stream obfuscation adds
+        #
         #   @param include_usage [Boolean] If set, an additional chunk will be streamed before the `data: [DONE]`
       end
     end

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

@@ -3,22 +3,20 @@
 module OpenAI
   module Models
     module Chat
-      class ChatCompletionTool < OpenAI::Internal::Type::BaseModel
-        # @!attribute function
-        #
-        #   @return [OpenAI::Models::FunctionDefinition]
-        required :function, -> { OpenAI::FunctionDefinition }
+      # A function tool that can be used to generate a response.
+      module ChatCompletionTool
+        extend OpenAI::Internal::Type::Union
 
-        # @!attribute type
-        #   The type of the tool. Currently, only `function` is supported.
-        #
-        #   @return [Symbol, :function]
-        required :type, const: :function
+        discriminator :type
 
-        # @!method initialize(function:, type: :function)
-        #   @param function [OpenAI::Models::FunctionDefinition]
-        #
-        #   @param type [Symbol, :function] The type of the tool. Currently, only `function` is supported.
+        # A function tool that can be used to generate a response.
+        variant :function, -> { OpenAI::Chat::ChatCompletionFunctionTool }
+
+        # A custom tool that processes input using a specified format.
+        variant :custom, -> { OpenAI::Chat::ChatCompletionCustomTool }
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Chat::ChatCompletionFunctionTool, OpenAI::Models::Chat::ChatCompletionCustomTool)]
       end
     end
 

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

@@ -18,9 +18,15 @@ module OpenAI
         # `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools.
         variant enum: -> { OpenAI::Chat::ChatCompletionToolChoiceOption::Auto }
 
+        # Constrains the tools available to the model to a pre-defined set.
+        variant -> { OpenAI::Chat::ChatCompletionAllowedToolChoice }
+
         # Specifies a tool the model should use. Use to force the model to call a specific function.
         variant -> { OpenAI::Chat::ChatCompletionNamedToolChoice }
 
+        # Specifies a tool the model should use. Use to force the model to call a specific custom tool.
+        variant -> { OpenAI::Chat::ChatCompletionNamedToolChoiceCustom }
+
         # `none` means the model will not call any tool and instead generates a message.
         # `auto` means the model can pick between generating a message or calling one or
         # more tools. `required` means the model must call one or more tools.
@@ -36,7 +42,7 @@ module OpenAI
         end
 
         # @!method self.variants
-        #   @return [Array(Symbol, OpenAI::Models::Chat::ChatCompletionToolChoiceOption::Auto, OpenAI::Models::Chat::ChatCompletionNamedToolChoice)]
+        #   @return [Array(Symbol, OpenAI::Models::Chat::ChatCompletionToolChoiceOption::Auto, OpenAI::Models::Chat::ChatCompletionAllowedToolChoice, OpenAI::Models::Chat::ChatCompletionNamedToolChoice, OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom)]
       end
     end
 

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

@@ -191,12 +191,11 @@ module OpenAI
         optional :prompt_cache_key, String
 
         # @!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
@@ -303,13 +302,13 @@ module OpenAI
         #   `none` is the default when no tools are present. `auto` is the default if tools
         #   are present.
         #
-        #   @return [Symbol, OpenAI::Models::Chat::ChatCompletionToolChoiceOption::Auto, OpenAI::Models::Chat::ChatCompletionNamedToolChoice, nil]
+        #   @return [Symbol, OpenAI::Models::Chat::ChatCompletionToolChoiceOption::Auto, OpenAI::Models::Chat::ChatCompletionAllowedToolChoice, OpenAI::Models::Chat::ChatCompletionNamedToolChoice, OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom, nil]
         optional :tool_choice, union: -> { OpenAI::Chat::ChatCompletionToolChoiceOption }
 
         # @!attribute tools
-        #   A list of tools the model may call. Currently, only functions are supported as a
-        #   tool. Use this to provide a list of functions the model may generate JSON inputs
-        #   for. A max of 128 functions are supported.
+        #   A list of tools the model may call. You can provide either
+        #   [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)
+        #   or [function tools](https://platform.openai.com/docs/guides/function-calling).
         #
         #   @return [Array<OpenAI::Models::Chat::ChatCompletionTool, OpenAI::StructuredOutput::JsonSchemaConverter>, nil]
         optional :tools,
@@ -349,6 +348,14 @@ module OpenAI
         #   @return [String, nil]
         optional :user, String
 
+        # @!attribute verbosity
+        #   Constrains the verbosity of the model's response. Lower values will result in
+        #   more concise responses, while higher values will result in more verbose
+        #   responses. Currently supported values are `low`, `medium`, and `high`.
+        #
+        #   @return [Symbol, OpenAI::Models::Chat::CompletionCreateParams::Verbosity, nil]
+        optional :verbosity, enum: -> { OpenAI::Chat::CompletionCreateParams::Verbosity }, nil?: true
+
         # @!attribute web_search_options
         #   This tool searches the web for relevant results to use in a response. Learn more
         #   about the
@@ -357,7 +364,7 @@ module OpenAI
         #   @return [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions, nil]
         optional :web_search_options, -> { OpenAI::Chat::CompletionCreateParams::WebSearchOptions }
 
-        # @!method initialize(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, prompt_cache_key: nil, reasoning_effort: nil, response_format: nil, safety_identifier: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, web_search_options: nil, request_options: {})
+        # @!method initialize(messages:, model:, audio: nil, frequency_penalty: nil, function_call: nil, functions: nil, logit_bias: nil, logprobs: nil, max_completion_tokens: nil, max_tokens: nil, metadata: nil, modalities: nil, n: nil, parallel_tool_calls: nil, prediction: nil, presence_penalty: nil, prompt_cache_key: nil, reasoning_effort: nil, response_format: nil, safety_identifier: nil, seed: nil, service_tier: nil, stop: nil, store: nil, stream_options: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, user: nil, verbosity: nil, web_search_options: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Chat::CompletionCreateParams} for more details.
         #
@@ -395,7 +402,7 @@ module OpenAI
         #
         #   @param prompt_cache_key [String] Used by OpenAI to cache responses for similar requests to optimize your cache hi
         #
-        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] **o-series models only**
+        #   @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
         #
         #   @param response_format [OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::ResponseFormatJSONObject] An object specifying the format that the model must output.
         #
@@ -413,9 +420,9 @@ module OpenAI
         #
         #   @param temperature [Float, nil] What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
         #
-        #   @param tool_choice [Symbol, OpenAI::Models::Chat::ChatCompletionToolChoiceOption::Auto, OpenAI::Models::Chat::ChatCompletionNamedToolChoice] Controls which (if any) tool is called by the model.
+        #   @param tool_choice [Symbol, OpenAI::Models::Chat::ChatCompletionToolChoiceOption::Auto, OpenAI::Models::Chat::ChatCompletionAllowedToolChoice, OpenAI::Models::Chat::ChatCompletionNamedToolChoice, OpenAI::Models::Chat::ChatCompletionNamedToolChoiceCustom] Controls which (if any) tool is called by the model.
         #
-        #   @param tools [Array<OpenAI::Models::Chat::ChatCompletionTool, OpenAI::StructuredOutput::JsonSchemaConverter>] A list of tools the model may call. Currently, only functions are supported as a
+        #   @param tools [Array<OpenAI::StructuredOutput::JsonSchemaConverter, OpenAI::Models::Chat::ChatCompletionFunctionTool, OpenAI::Models::Chat::ChatCompletionCustomTool>] A list of tools the model may call. You can provide either
         #
         #   @param top_logprobs [Integer, nil] An integer between 0 and 20 specifying the number of most likely tokens to
         #
@@ -423,6 +430,8 @@ module OpenAI
         #
         #   @param user [String] This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
         #
+        #   @param verbosity [Symbol, OpenAI::Models::Chat::CompletionCreateParams::Verbosity, nil] Constrains the verbosity of the model's response. Lower values will result in
+        #
         #   @param web_search_options [OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions] This tool searches the web for relevant results to use in a response.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
@@ -622,6 +631,20 @@ module OpenAI
           StringArray = OpenAI::Internal::Type::ArrayOf[String]
         end
 
+        # Constrains the verbosity of the model's response. Lower values will result in
+        # more concise responses, while higher values will result in more verbose
+        # responses. Currently supported values are `low`, `medium`, and `high`.
+        module Verbosity
+          extend OpenAI::Internal::Type::Enum
+
+          LOW = :low
+          MEDIUM = :medium
+          HIGH = :high
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         class WebSearchOptions < OpenAI::Internal::Type::BaseModel
           # @!attribute search_context_size
           #   High level guidance for the amount of context window space to use for the

data/lib/openai/models/chat_model.rb

@@ -5,6 +5,13 @@ module OpenAI
     module ChatModel
       extend OpenAI::Internal::Type::Enum
 
+      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_5_CHAT_LATEST = :"gpt-5-chat-latest"
       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/custom_tool_input_format.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # The input format for the custom tool. Default is unconstrained text.
+    module CustomToolInputFormat
+      extend OpenAI::Internal::Type::Union
+
+      discriminator :type
+
+      # Unconstrained free-form text.
+      variant :text, -> { OpenAI::CustomToolInputFormat::Text }
+
+      # A grammar defined by the user.
+      variant :grammar, -> { OpenAI::CustomToolInputFormat::Grammar }
+
+      class Text < OpenAI::Internal::Type::BaseModel
+        # @!attribute type
+        #   Unconstrained text format. Always `text`.
+        #
+        #   @return [Symbol, :text]
+        required :type, const: :text
+
+        # @!method initialize(type: :text)
+        #   Unconstrained free-form text.
+        #
+        #   @param type [Symbol, :text] Unconstrained text format. Always `text`.
+      end
+
+      class Grammar < OpenAI::Internal::Type::BaseModel
+        # @!attribute definition
+        #   The grammar definition.
+        #
+        #   @return [String]
+        required :definition, String
+
+        # @!attribute syntax
+        #   The syntax of the grammar definition. One of `lark` or `regex`.
+        #
+        #   @return [Symbol, OpenAI::Models::CustomToolInputFormat::Grammar::Syntax]
+        required :syntax, enum: -> { OpenAI::CustomToolInputFormat::Grammar::Syntax }
+
+        # @!attribute type
+        #   Grammar format. Always `grammar`.
+        #
+        #   @return [Symbol, :grammar]
+        required :type, const: :grammar
+
+        # @!method initialize(definition:, syntax:, type: :grammar)
+        #   A grammar defined by the user.
+        #
+        #   @param definition [String] The grammar definition.
+        #
+        #   @param syntax [Symbol, OpenAI::Models::CustomToolInputFormat::Grammar::Syntax] The syntax of the grammar definition. One of `lark` or `regex`.
+        #
+        #   @param type [Symbol, :grammar] Grammar format. Always `grammar`.
+
+        # The syntax of the grammar definition. One of `lark` or `regex`.
+        #
+        # @see OpenAI::Models::CustomToolInputFormat::Grammar#syntax
+        module Syntax
+          extend OpenAI::Internal::Type::Enum
+
+          LARK = :lark
+          REGEX = :regex
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(OpenAI::Models::CustomToolInputFormat::Text, OpenAI::Models::CustomToolInputFormat::Grammar)]
+    end
+  end
+end

data/lib/openai/models/evals/create_eval_completions_run_data_source.rb

@@ -512,8 +512,8 @@ module OpenAI
           #   tool. Use this to provide a list of functions the model may generate JSON inputs
           #   for. A max of 128 functions are supported.
           #
-          #   @return [Array<OpenAI::Models::Chat::ChatCompletionTool>, nil]
-          optional :tools, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionTool] }
+          #   @return [Array<OpenAI::Models::Chat::ChatCompletionFunctionTool>, nil]
+          optional :tools, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionFunctionTool] }
 
           # @!attribute top_p
           #   An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
@@ -534,7 +534,7 @@ module OpenAI
           #
           #   @param temperature [Float] A higher temperature increases randomness in the outputs.
           #
-          #   @param tools [Array<OpenAI::Models::Chat::ChatCompletionTool>] A list of tools the model may call. Currently, only functions are supported as a
+          #   @param tools [Array<OpenAI::Models::Chat::ChatCompletionFunctionTool>] A list of tools the model may call. Currently, only functions are supported as a
           #
           #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
 

data/lib/openai/models/evals/run_cancel_response.rb

@@ -686,7 +686,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
               # @!attribute top_p
@@ -708,7 +708,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunCancelResponse::DataSource::Responses::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.
 

data/lib/openai/models/evals/run_create_params.rb

@@ -650,7 +650,7 @@ module OpenAI
               #     the model to call your own code. Learn more about
               #     [function calling](https://platform.openai.com/docs/guides/function-calling).
               #
-              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>, nil]
+              #   @return [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool>, nil]
               optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }
 
               # @!attribute top_p
@@ -672,7 +672,7 @@ module OpenAI
               #
               #   @param text [OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text] Configuration options for a text response from the model. Can be plain
               #
-              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
+              #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::WebSearchTool>] An array of tools the model may call while generating a response. You
               #
               #   @param top_p [Float] An alternative to temperature for nucleus sampling; 1.0 includes all tokens.