openai 0.20.0 → 0.21.0

data/rbi/openai/models/responses/response_create_params.rbi

@@ -304,7 +304,7 @@ module OpenAI
         # An array of tools the model may call while generating a response. You can
         # specify which tool to use by setting the `tool_choice` parameter.
         #
-        # The two categories of tools you can provide the model are:
+        # We support the following categories of tools:
         #
         # - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
         #   capabilities, like
@@ -312,6 +312,9 @@ module OpenAI
         #   [file search](https://platform.openai.com/docs/guides/tools-file-search).
         #   Learn more about
         #   [built-in tools](https://platform.openai.com/docs/guides/tools).
+        # - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
+        #   predefined connectors such as Google Drive and Notion. Learn more about
+        #   [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp).
         # - **Function calls (custom tools)**: Functions that are defined by you, enabling
         #   the model to call your own code with strongly typed arguments and outputs.
         #   Learn more about
@@ -330,8 +333,8 @@ module OpenAI
                   OpenAI::Responses::Tool::ImageGeneration,
                   OpenAI::Responses::Tool::LocalShell,
                   OpenAI::Responses::CustomTool,
-                  OpenAI::Responses::Tool::WebSearchTool,
-                  OpenAI::Responses::WebSearchTool
+                  OpenAI::Responses::WebSearchTool,
+                  OpenAI::Responses::WebSearchPreviewTool
                 )
               ]
             )
@@ -352,8 +355,8 @@ module OpenAI
                   OpenAI::Responses::Tool::ImageGeneration::OrHash,
                   OpenAI::Responses::Tool::LocalShell::OrHash,
                   OpenAI::Responses::CustomTool::OrHash,
-                  OpenAI::Responses::Tool::WebSearchTool::OrHash,
-                  OpenAI::Responses::WebSearchTool::OrHash
+                  OpenAI::Responses::WebSearchTool::OrHash,
+                  OpenAI::Responses::WebSearchPreviewTool::OrHash
                 )
               ]
           ).void
@@ -462,8 +465,8 @@ module OpenAI
                   OpenAI::Responses::Tool::ImageGeneration::OrHash,
                   OpenAI::Responses::Tool::LocalShell::OrHash,
                   OpenAI::Responses::CustomTool::OrHash,
-                  OpenAI::Responses::Tool::WebSearchTool::OrHash,
-                  OpenAI::Responses::WebSearchTool::OrHash
+                  OpenAI::Responses::WebSearchTool::OrHash,
+                  OpenAI::Responses::WebSearchPreviewTool::OrHash
                 )
               ],
             top_logprobs: T.nilable(Integer),
@@ -606,7 +609,7 @@ module OpenAI
           # An array of tools the model may call while generating a response. You can
           # specify which tool to use by setting the `tool_choice` parameter.
           #
-          # The two categories of tools you can provide the model are:
+          # We support the following categories of tools:
           #
           # - **Built-in tools**: Tools that are provided by OpenAI that extend the model's
           #   capabilities, like
@@ -614,6 +617,9 @@ module OpenAI
           #   [file search](https://platform.openai.com/docs/guides/tools-file-search).
           #   Learn more about
           #   [built-in tools](https://platform.openai.com/docs/guides/tools).
+          # - **MCP Tools**: Integrations with third-party systems via custom MCP servers or
+          #   predefined connectors such as Google Drive and Notion. Learn more about
+          #   [MCP Tools](https://platform.openai.com/docs/guides/tools-connectors-mcp).
           # - **Function calls (custom tools)**: Functions that are defined by you, enabling
           #   the model to call your own code with strongly typed arguments and outputs.
           #   Learn more about
@@ -707,8 +713,8 @@ module OpenAI
                     OpenAI::Responses::Tool::ImageGeneration,
                     OpenAI::Responses::Tool::LocalShell,
                     OpenAI::Responses::CustomTool,
-                    OpenAI::Responses::Tool::WebSearchTool,
-                    OpenAI::Responses::WebSearchTool
+                    OpenAI::Responses::WebSearchTool,
+                    OpenAI::Responses::WebSearchPreviewTool
                   )
                 ],
               top_logprobs: T.nilable(Integer),

data/rbi/openai/models/responses/tool.rbi

@@ -18,357 +18,11 @@ module OpenAI
               OpenAI::Responses::Tool::ImageGeneration,
               OpenAI::Responses::Tool::LocalShell,
               OpenAI::Responses::CustomTool,
-              OpenAI::Responses::Tool::WebSearchTool,
-              OpenAI::Responses::WebSearchTool
+              OpenAI::Responses::WebSearchTool,
+              OpenAI::Responses::WebSearchPreviewTool
             )
           end
 
-        class WebSearchTool < OpenAI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::Responses::Tool::WebSearchTool,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
-          sig do
-            returns(OpenAI::Responses::Tool::WebSearchTool::Type::OrSymbol)
-          end
-          attr_accessor :type
-
-          # Filters for the search.
-          sig do
-            returns(T.nilable(OpenAI::Responses::Tool::WebSearchTool::Filters))
-          end
-          attr_reader :filters
-
-          sig do
-            params(
-              filters:
-                T.nilable(
-                  OpenAI::Responses::Tool::WebSearchTool::Filters::OrHash
-                )
-            ).void
-          end
-          attr_writer :filters
-
-          # High level guidance for the amount of context window space to use for the
-          # search. One of `low`, `medium`, or `high`. `medium` is the default.
-          sig do
-            returns(
-              T.nilable(
-                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::OrSymbol
-              )
-            )
-          end
-          attr_reader :search_context_size
-
-          sig do
-            params(
-              search_context_size:
-                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::OrSymbol
-            ).void
-          end
-          attr_writer :search_context_size
-
-          # The approximate location of the user.
-          sig do
-            returns(
-              T.nilable(OpenAI::Responses::Tool::WebSearchTool::UserLocation)
-            )
-          end
-          attr_reader :user_location
-
-          sig do
-            params(
-              user_location:
-                T.nilable(
-                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::OrHash
-                )
-            ).void
-          end
-          attr_writer :user_location
-
-          # Search the Internet for sources related to the prompt. Learn more about the
-          # [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
-          sig do
-            params(
-              type: OpenAI::Responses::Tool::WebSearchTool::Type::OrSymbol,
-              filters:
-                T.nilable(
-                  OpenAI::Responses::Tool::WebSearchTool::Filters::OrHash
-                ),
-              search_context_size:
-                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::OrSymbol,
-              user_location:
-                T.nilable(
-                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::OrHash
-                )
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
-            type:,
-            # Filters for the search.
-            filters: nil,
-            # High level guidance for the amount of context window space to use for the
-            # search. One of `low`, `medium`, or `high`. `medium` is the default.
-            search_context_size: nil,
-            # The approximate location of the user.
-            user_location: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                type: OpenAI::Responses::Tool::WebSearchTool::Type::OrSymbol,
-                filters:
-                  T.nilable(OpenAI::Responses::Tool::WebSearchTool::Filters),
-                search_context_size:
-                  OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::OrSymbol,
-                user_location:
-                  T.nilable(
-                    OpenAI::Responses::Tool::WebSearchTool::UserLocation
-                  )
-              }
-            )
-          end
-          def to_hash
-          end
-
-          # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
-          module Type
-            extend OpenAI::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(Symbol, OpenAI::Responses::Tool::WebSearchTool::Type)
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            WEB_SEARCH =
-              T.let(
-                :web_search,
-                OpenAI::Responses::Tool::WebSearchTool::Type::TaggedSymbol
-              )
-            WEB_SEARCH_2025_08_26 =
-              T.let(
-                :web_search_2025_08_26,
-                OpenAI::Responses::Tool::WebSearchTool::Type::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  OpenAI::Responses::Tool::WebSearchTool::Type::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-
-          class Filters < OpenAI::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  OpenAI::Responses::Tool::WebSearchTool::Filters,
-                  OpenAI::Internal::AnyHash
-                )
-              end
-
-            # Allowed domains for the search. If not provided, all domains are allowed.
-            # Subdomains of the provided domains are allowed as well.
-            #
-            # Example: `["pubmed.ncbi.nlm.nih.gov"]`
-            sig { returns(T.nilable(T::Array[String])) }
-            attr_accessor :allowed_domains
-
-            # Filters for the search.
-            sig do
-              params(allowed_domains: T.nilable(T::Array[String])).returns(
-                T.attached_class
-              )
-            end
-            def self.new(
-              # Allowed domains for the search. If not provided, all domains are allowed.
-              # Subdomains of the provided domains are allowed as well.
-              #
-              # Example: `["pubmed.ncbi.nlm.nih.gov"]`
-              allowed_domains: nil
-            )
-            end
-
-            sig do
-              override.returns({ allowed_domains: T.nilable(T::Array[String]) })
-            end
-            def to_hash
-            end
-          end
-
-          # High level guidance for the amount of context window space to use for the
-          # search. One of `low`, `medium`, or `high`. `medium` is the default.
-          module SearchContextSize
-            extend OpenAI::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  OpenAI::Responses::Tool::WebSearchTool::SearchContextSize
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            LOW =
-              T.let(
-                :low,
-                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::TaggedSymbol
-              )
-            MEDIUM =
-              T.let(
-                :medium,
-                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::TaggedSymbol
-              )
-            HIGH =
-              T.let(
-                :high,
-                OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  OpenAI::Responses::Tool::WebSearchTool::SearchContextSize::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-
-          class UserLocation < OpenAI::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  OpenAI::Responses::Tool::WebSearchTool::UserLocation,
-                  OpenAI::Internal::AnyHash
-                )
-              end
-
-            # Free text input for the city of the user, e.g. `San Francisco`.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :city
-
-            # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
-            # the user, e.g. `US`.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :country
-
-            # Free text input for the region of the user, e.g. `California`.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :region
-
-            # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
-            # user, e.g. `America/Los_Angeles`.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :timezone
-
-            # The type of location approximation. Always `approximate`.
-            sig do
-              returns(
-                T.nilable(
-                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::OrSymbol
-                )
-              )
-            end
-            attr_reader :type
-
-            sig do
-              params(
-                type:
-                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::OrSymbol
-              ).void
-            end
-            attr_writer :type
-
-            # The approximate location of the user.
-            sig do
-              params(
-                city: T.nilable(String),
-                country: T.nilable(String),
-                region: T.nilable(String),
-                timezone: T.nilable(String),
-                type:
-                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::OrSymbol
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              # Free text input for the city of the user, e.g. `San Francisco`.
-              city: nil,
-              # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
-              # the user, e.g. `US`.
-              country: nil,
-              # Free text input for the region of the user, e.g. `California`.
-              region: nil,
-              # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
-              # user, e.g. `America/Los_Angeles`.
-              timezone: nil,
-              # The type of location approximation. Always `approximate`.
-              type: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  city: T.nilable(String),
-                  country: T.nilable(String),
-                  region: T.nilable(String),
-                  timezone: T.nilable(String),
-                  type:
-                    OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::OrSymbol
-                }
-              )
-            end
-            def to_hash
-            end
-
-            # The type of location approximation. Always `approximate`.
-            module Type
-              extend OpenAI::Internal::Type::Enum
-
-              TaggedSymbol =
-                T.type_alias do
-                  T.all(
-                    Symbol,
-                    OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type
-                  )
-                end
-              OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-              APPROXIMATE =
-                T.let(
-                  :approximate,
-                  OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::TaggedSymbol
-                )
-
-              sig do
-                override.returns(
-                  T::Array[
-                    OpenAI::Responses::Tool::WebSearchTool::UserLocation::Type::TaggedSymbol
-                  ]
-                )
-              end
-              def self.values
-              end
-            end
-          end
-        end
-
         class Mcp < OpenAI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/openai/models/responses/web_search_preview_tool.rbi

@@ -0,0 +1,245 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class WebSearchPreviewTool < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::WebSearchPreviewTool,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The type of the web search tool. One of `web_search_preview` or
+        # `web_search_preview_2025_03_11`.
+        sig { returns(OpenAI::Responses::WebSearchPreviewTool::Type::OrSymbol) }
+        attr_accessor :type
+
+        # High level guidance for the amount of context window space to use for the
+        # search. One of `low`, `medium`, or `high`. `medium` is the default.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Responses::WebSearchPreviewTool::SearchContextSize::OrSymbol
+            )
+          )
+        end
+        attr_reader :search_context_size
+
+        sig do
+          params(
+            search_context_size:
+              OpenAI::Responses::WebSearchPreviewTool::SearchContextSize::OrSymbol
+          ).void
+        end
+        attr_writer :search_context_size
+
+        # The user's location.
+        sig do
+          returns(
+            T.nilable(OpenAI::Responses::WebSearchPreviewTool::UserLocation)
+          )
+        end
+        attr_reader :user_location
+
+        sig do
+          params(
+            user_location:
+              T.nilable(
+                OpenAI::Responses::WebSearchPreviewTool::UserLocation::OrHash
+              )
+          ).void
+        end
+        attr_writer :user_location
+
+        # This tool searches the web for relevant results to use in a response. Learn more
+        # about the
+        # [web search tool](https://platform.openai.com/docs/guides/tools-web-search).
+        sig do
+          params(
+            type: OpenAI::Responses::WebSearchPreviewTool::Type::OrSymbol,
+            search_context_size:
+              OpenAI::Responses::WebSearchPreviewTool::SearchContextSize::OrSymbol,
+            user_location:
+              T.nilable(
+                OpenAI::Responses::WebSearchPreviewTool::UserLocation::OrHash
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The type of the web search tool. One of `web_search_preview` or
+          # `web_search_preview_2025_03_11`.
+          type:,
+          # High level guidance for the amount of context window space to use for the
+          # search. One of `low`, `medium`, or `high`. `medium` is the default.
+          search_context_size: nil,
+          # The user's location.
+          user_location: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              type: OpenAI::Responses::WebSearchPreviewTool::Type::OrSymbol,
+              search_context_size:
+                OpenAI::Responses::WebSearchPreviewTool::SearchContextSize::OrSymbol,
+              user_location:
+                T.nilable(OpenAI::Responses::WebSearchPreviewTool::UserLocation)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of the web search tool. One of `web_search_preview` or
+        # `web_search_preview_2025_03_11`.
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Responses::WebSearchPreviewTool::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          WEB_SEARCH_PREVIEW =
+            T.let(
+              :web_search_preview,
+              OpenAI::Responses::WebSearchPreviewTool::Type::TaggedSymbol
+            )
+          WEB_SEARCH_PREVIEW_2025_03_11 =
+            T.let(
+              :web_search_preview_2025_03_11,
+              OpenAI::Responses::WebSearchPreviewTool::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::WebSearchPreviewTool::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # High level guidance for the amount of context window space to use for the
+        # search. One of `low`, `medium`, or `high`. `medium` is the default.
+        module SearchContextSize
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::WebSearchPreviewTool::SearchContextSize
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOW =
+            T.let(
+              :low,
+              OpenAI::Responses::WebSearchPreviewTool::SearchContextSize::TaggedSymbol
+            )
+          MEDIUM =
+            T.let(
+              :medium,
+              OpenAI::Responses::WebSearchPreviewTool::SearchContextSize::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              OpenAI::Responses::WebSearchPreviewTool::SearchContextSize::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::WebSearchPreviewTool::SearchContextSize::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class UserLocation < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::WebSearchPreviewTool::UserLocation,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The type of location approximation. Always `approximate`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Free text input for the city of the user, e.g. `San Francisco`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :city
+
+          # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+          # the user, e.g. `US`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :country
+
+          # Free text input for the region of the user, e.g. `California`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :region
+
+          # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+          # user, e.g. `America/Los_Angeles`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :timezone
+
+          # The user's location.
+          sig do
+            params(
+              city: T.nilable(String),
+              country: T.nilable(String),
+              region: T.nilable(String),
+              timezone: T.nilable(String),
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Free text input for the city of the user, e.g. `San Francisco`.
+            city: nil,
+            # The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of
+            # the user, e.g. `US`.
+            country: nil,
+            # Free text input for the region of the user, e.g. `California`.
+            region: nil,
+            # The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the
+            # user, e.g. `America/Los_Angeles`.
+            timezone: nil,
+            # The type of location approximation. Always `approximate`.
+            type: :approximate
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                type: Symbol,
+                city: T.nilable(String),
+                country: T.nilable(String),
+                region: T.nilable(String),
+                timezone: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end