openai 0.15.0 → 0.17.0

data/rbi/openai/models/evals/run_retrieve_response.rbi

@@ -1176,6 +1176,7 @@ module OpenAI
                         OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                         OpenAI::Responses::Tool::ImageGeneration::OrHash,
                         OpenAI::Responses::Tool::LocalShell::OrHash,
+                        OpenAI::Responses::CustomTool::OrHash,
                         OpenAI::Responses::WebSearchTool::OrHash
                       )
                     ]
@@ -1207,6 +1208,7 @@ module OpenAI
                         OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                         OpenAI::Responses::Tool::ImageGeneration::OrHash,
                         OpenAI::Responses::Tool::LocalShell::OrHash,
+                        OpenAI::Responses::CustomTool::OrHash,
                         OpenAI::Responses::WebSearchTool::OrHash
                       )
                     ],

data/rbi/openai/models/reasoning.rbi

@@ -6,12 +6,11 @@ module OpenAI
       OrHash =
         T.type_alias { T.any(OpenAI::Reasoning, OpenAI::Internal::AnyHash) }
 
-      # **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.
       sig { returns(T.nilable(OpenAI::ReasoningEffort::OrSymbol)) }
       attr_accessor :effort
 
@@ -42,12 +41,11 @@ module OpenAI
         ).returns(T.attached_class)
       end
       def self.new(
-        # **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.
         effort: nil,
         # **Deprecated:** use `summary` instead.
         #

data/rbi/openai/models/reasoning_effort.rbi

@@ -2,18 +2,18 @@
 
 module OpenAI
   module Models
-    # **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.
     module ReasoningEffort
       extend OpenAI::Internal::Type::Enum
 
       TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::ReasoningEffort) }
       OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+      MINIMAL = T.let(:minimal, OpenAI::ReasoningEffort::TaggedSymbol)
       LOW = T.let(:low, OpenAI::ReasoningEffort::TaggedSymbol)
       MEDIUM = T.let(:medium, OpenAI::ReasoningEffort::TaggedSymbol)
       HIGH = T.let(:high, OpenAI::ReasoningEffort::TaggedSymbol)

data/rbi/openai/models/response_format_text_grammar.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class ResponseFormatTextGrammar < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::ResponseFormatTextGrammar, OpenAI::Internal::AnyHash)
+        end
+
+      # The custom grammar for the model to follow.
+      sig { returns(String) }
+      attr_accessor :grammar
+
+      # The type of response format being defined. Always `grammar`.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # A custom grammar for the model to follow when generating text. Learn more in the
+      # [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars).
+      sig { params(grammar: String, type: Symbol).returns(T.attached_class) }
+      def self.new(
+        # The custom grammar for the model to follow.
+        grammar:,
+        # The type of response format being defined. Always `grammar`.
+        type: :grammar
+      )
+      end
+
+      sig { override.returns({ grammar: String, type: Symbol }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openai/models/response_format_text_python.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    class ResponseFormatTextPython < OpenAI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(OpenAI::ResponseFormatTextPython, OpenAI::Internal::AnyHash)
+        end
+
+      # The type of response format being defined. Always `python`.
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Configure the model to generate valid Python code. See the
+      # [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars)
+      # for more details.
+      sig { params(type: Symbol).returns(T.attached_class) }
+      def self.new(
+        # The type of response format being defined. Always `python`.
+        type: :python
+      )
+      end
+
+      sig { override.returns({ type: Symbol }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/openai/models/responses/custom_tool.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class CustomTool < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Responses::CustomTool, OpenAI::Internal::AnyHash)
+          end
+
+        # The name of the custom tool, used to identify it in tool calls.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The type of the custom tool. Always `custom`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Optional description of the custom tool, used to provide more context.
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # The input format for the custom tool. Default is unconstrained text.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                OpenAI::CustomToolInputFormat::Text,
+                OpenAI::CustomToolInputFormat::Grammar
+              )
+            )
+          )
+        end
+        attr_reader :format_
+
+        sig do
+          params(
+            format_:
+              T.any(
+                OpenAI::CustomToolInputFormat::Text::OrHash,
+                OpenAI::CustomToolInputFormat::Grammar::OrHash
+              )
+          ).void
+        end
+        attr_writer :format_
+
+        # A custom tool that processes input using a specified format. Learn more about
+        # [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools).
+        sig do
+          params(
+            name: String,
+            description: String,
+            format_:
+              T.any(
+                OpenAI::CustomToolInputFormat::Text::OrHash,
+                OpenAI::CustomToolInputFormat::Grammar::OrHash
+              ),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The name of the custom tool, used to identify it in tool calls.
+          name:,
+          # Optional description of the custom tool, used to provide more context.
+          description: nil,
+          # The input format for the custom tool. Default is unconstrained text.
+          format_: nil,
+          # The type of the custom tool. Always `custom`.
+          type: :custom
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              name: String,
+              type: Symbol,
+              description: String,
+              format_:
+                T.any(
+                  OpenAI::CustomToolInputFormat::Text,
+                  OpenAI::CustomToolInputFormat::Grammar
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -116,8 +116,10 @@ module OpenAI
         #   Learn more about
         #   [built-in tools](https://platform.openai.com/docs/guides/tools).
         # - **Function calls (custom tools)**: Functions that are defined by you, enabling
-        #   the model to call your own code. Learn more about
+        #   the model to call your own code with strongly typed arguments and outputs.
+        #   Learn more about
         #   [function calling](https://platform.openai.com/docs/guides/function-calling).
+        #   You can also use custom tools to call your own code.
         sig { returns(T::Array[OpenAI::Responses::Tool::Variants]) }
         attr_accessor :tools
 
@@ -165,6 +167,15 @@ module OpenAI
         end
         attr_writer :prompt
 
+        # Used by OpenAI to cache responses for similar requests to optimize your cache
+        # hit rates. Replaces the `user` field.
+        # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+        sig { returns(T.nilable(String)) }
+        attr_reader :prompt_cache_key
+
+        sig { params(prompt_cache_key: String).void }
+        attr_writer :prompt_cache_key
+
         # **o-series models only**
         #
         # Configuration options for
@@ -175,6 +186,17 @@ module OpenAI
         sig { params(reasoning: T.nilable(OpenAI::Reasoning::OrHash)).void }
         attr_writer :reasoning
 
+        # A stable identifier used to help detect users of your application that may be
+        # violating OpenAI's usage policies. The IDs should be a string that uniquely
+        # identifies each user. We recommend hashing their username or email address, in
+        # order to avoid sending us any identifying information.
+        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+        sig { returns(T.nilable(String)) }
+        attr_reader :safety_identifier
+
+        sig { params(safety_identifier: String).void }
+        attr_writer :safety_identifier
+
         # Specifies the processing type used for serving the request.
         #
         # - If set to 'auto', then the request will be processed with the service tier
@@ -247,9 +269,11 @@ module OpenAI
         sig { params(usage: OpenAI::Responses::ResponseUsage::OrHash).void }
         attr_writer :usage
 
-        # A stable identifier for your end-users. Used to boost cache hit rates by better
-        # bucketing similar requests and to help OpenAI detect and prevent abuse.
-        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+        # This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+        # `prompt_cache_key` instead to maintain caching optimizations. A stable
+        # identifier for your end-users. Used to boost cache hit rates by better bucketing
+        # similar requests and to help OpenAI detect and prevent abuse.
+        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
         sig { returns(T.nilable(String)) }
         attr_reader :user
 
@@ -286,7 +310,8 @@ module OpenAI
                   OpenAI::Responses::ResponseOutputItem::LocalShellCall::OrHash,
                   OpenAI::Responses::ResponseOutputItem::McpCall::OrHash,
                   OpenAI::Responses::ResponseOutputItem::McpListTools::OrHash,
-                  OpenAI::Responses::ResponseOutputItem::McpApprovalRequest::OrHash
+                  OpenAI::Responses::ResponseOutputItem::McpApprovalRequest::OrHash,
+                  OpenAI::Responses::ResponseCustomToolCall::OrHash
                 )
               ],
             parallel_tool_calls: T::Boolean,
@@ -294,9 +319,11 @@ module OpenAI
             tool_choice:
               T.any(
                 OpenAI::Responses::ToolChoiceOptions::OrSymbol,
+                OpenAI::Responses::ToolChoiceAllowed::OrHash,
                 OpenAI::Responses::ToolChoiceTypes::OrHash,
                 OpenAI::Responses::ToolChoiceFunction::OrHash,
-                OpenAI::Responses::ToolChoiceMcp::OrHash
+                OpenAI::Responses::ToolChoiceMcp::OrHash,
+                OpenAI::Responses::ToolChoiceCustom::OrHash
               ),
             tools:
               T::Array[
@@ -308,6 +335,7 @@ module OpenAI
                   OpenAI::Responses::Tool::CodeInterpreter::OrHash,
                   OpenAI::Responses::Tool::ImageGeneration::OrHash,
                   OpenAI::Responses::Tool::LocalShell::OrHash,
+                  OpenAI::Responses::CustomTool::OrHash,
                   OpenAI::Responses::WebSearchTool::OrHash
                 )
               ],
@@ -317,7 +345,9 @@ module OpenAI
             max_tool_calls: T.nilable(Integer),
             previous_response_id: T.nilable(String),
             prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
+            prompt_cache_key: String,
             reasoning: T.nilable(OpenAI::Reasoning::OrHash),
+            safety_identifier: String,
             service_tier:
               T.nilable(OpenAI::Responses::Response::ServiceTier::OrSymbol),
             status: OpenAI::Responses::ResponseStatus::OrSymbol,
@@ -389,8 +419,10 @@ module OpenAI
           #   Learn more about
           #   [built-in tools](https://platform.openai.com/docs/guides/tools).
           # - **Function calls (custom tools)**: Functions that are defined by you, enabling
-          #   the model to call your own code. Learn more about
+          #   the model to call your own code with strongly typed arguments and outputs.
+          #   Learn more about
           #   [function calling](https://platform.openai.com/docs/guides/function-calling).
+          #   You can also use custom tools to call your own code.
           tools:,
           # An alternative to sampling with temperature, called nucleus sampling, where the
           # model considers the results of the tokens with top_p probability mass. So 0.1
@@ -417,11 +449,21 @@ module OpenAI
           # Reference to a prompt template and its variables.
           # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
           prompt: nil,
+          # Used by OpenAI to cache responses for similar requests to optimize your cache
+          # hit rates. Replaces the `user` field.
+          # [Learn more](https://platform.openai.com/docs/guides/prompt-caching).
+          prompt_cache_key: nil,
           # **o-series models only**
           #
           # Configuration options for
           # [reasoning models](https://platform.openai.com/docs/guides/reasoning).
           reasoning: nil,
+          # A stable identifier used to help detect users of your application that may be
+          # violating OpenAI's usage policies. The IDs should be a string that uniquely
+          # identifies each user. We recommend hashing their username or email address, in
+          # order to avoid sending us any identifying information.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
+          safety_identifier: nil,
           # Specifies the processing type used for serving the request.
           #
           # - If set to 'auto', then the request will be processed with the service tier
@@ -463,9 +505,11 @@ module OpenAI
           # Represents token usage details including input tokens, output tokens, a
           # breakdown of output tokens, and the total tokens used.
           usage: nil,
-          # A stable identifier for your end-users. Used to boost cache hit rates by better
-          # bucketing similar requests and to help OpenAI detect and prevent abuse.
-          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
+          # This field is being replaced by `safety_identifier` and `prompt_cache_key`. Use
+          # `prompt_cache_key` instead to maintain caching optimizations. A stable
+          # identifier for your end-users. Used to boost cache hit rates by better bucketing
+          # similar requests and to help OpenAI detect and prevent abuse.
+          # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#safety-identifiers).
           user: nil,
           # The object type of this resource - always set to `response`.
           object: :response
@@ -496,7 +540,9 @@ module OpenAI
               max_tool_calls: T.nilable(Integer),
               previous_response_id: T.nilable(String),
               prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
+              prompt_cache_key: String,
               reasoning: T.nilable(OpenAI::Reasoning),
+              safety_identifier: String,
               service_tier:
                 T.nilable(
                   OpenAI::Responses::Response::ServiceTier::TaggedSymbol
@@ -646,9 +692,11 @@ module OpenAI
             T.type_alias do
               T.any(
                 OpenAI::Responses::ToolChoiceOptions::TaggedSymbol,
+                OpenAI::Responses::ToolChoiceAllowed,
                 OpenAI::Responses::ToolChoiceTypes,
                 OpenAI::Responses::ToolChoiceFunction,
-                OpenAI::Responses::ToolChoiceMcp
+                OpenAI::Responses::ToolChoiceMcp,
+                OpenAI::Responses::ToolChoiceCustom
               )
             end