openai 0.20.0 → 0.21.1

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

data/rbi/openai/models/responses/web_search_tool.rbi

@@ -9,11 +9,22 @@ module OpenAI
             T.any(OpenAI::Responses::WebSearchTool, OpenAI::Internal::AnyHash)
           end
 
-        # The type of the web search tool. One of `web_search_preview` or
-        # `web_search_preview_2025_03_11`.
+        # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
         sig { returns(OpenAI::Responses::WebSearchTool::Type::OrSymbol) }
         attr_accessor :type
 
+        # Filters for the search.
+        sig { returns(T.nilable(OpenAI::Responses::WebSearchTool::Filters)) }
+        attr_reader :filters
+
+        sig do
+          params(
+            filters:
+              T.nilable(OpenAI::Responses::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
@@ -33,7 +44,7 @@ module OpenAI
         end
         attr_writer :search_context_size
 
-        # The user's location.
+        # The approximate location of the user.
         sig do
           returns(T.nilable(OpenAI::Responses::WebSearchTool::UserLocation))
         end
@@ -47,12 +58,13 @@ module OpenAI
         end
         attr_writer :user_location
 
-        # This tool searches the web for relevant results to use in a response. Learn more
-        # about the
+        # 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::WebSearchTool::Type::OrSymbol,
+            filters:
+              T.nilable(OpenAI::Responses::WebSearchTool::Filters::OrHash),
             search_context_size:
               OpenAI::Responses::WebSearchTool::SearchContextSize::OrSymbol,
             user_location:
@@ -60,13 +72,14 @@ module OpenAI
           ).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`.
+          # 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 user's location.
+          # The approximate location of the user.
           user_location: nil
         )
         end
@@ -75,6 +88,7 @@ module OpenAI
           override.returns(
             {
               type: OpenAI::Responses::WebSearchTool::Type::OrSymbol,
+              filters: T.nilable(OpenAI::Responses::WebSearchTool::Filters),
               search_context_size:
                 OpenAI::Responses::WebSearchTool::SearchContextSize::OrSymbol,
               user_location:
@@ -85,8 +99,7 @@ module OpenAI
         def to_hash
         end
 
-        # The type of the web search tool. One of `web_search_preview` or
-        # `web_search_preview_2025_03_11`.
+        # The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
         module Type
           extend OpenAI::Internal::Type::Enum
 
@@ -96,14 +109,14 @@ module OpenAI
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          WEB_SEARCH_PREVIEW =
+          WEB_SEARCH =
             T.let(
-              :web_search_preview,
+              :web_search,
               OpenAI::Responses::WebSearchTool::Type::TaggedSymbol
             )
-          WEB_SEARCH_PREVIEW_2025_03_11 =
+          WEB_SEARCH_2025_08_26 =
             T.let(
-              :web_search_preview_2025_03_11,
+              :web_search_2025_08_26,
               OpenAI::Responses::WebSearchTool::Type::TaggedSymbol
             )
 
@@ -116,6 +129,44 @@ module OpenAI
           end
         end
 
+        class Filters < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::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
@@ -163,10 +214,6 @@ module OpenAI
               )
             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
@@ -185,14 +232,33 @@ module OpenAI
           sig { returns(T.nilable(String)) }
           attr_accessor :timezone
 
-          # The user's location.
+          # The type of location approximation. Always `approximate`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Responses::WebSearchTool::UserLocation::Type::OrSymbol
+              )
+            )
+          end
+          attr_reader :type
+
+          sig do
+            params(
+              type:
+                OpenAI::Responses::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: Symbol
+              type:
+                OpenAI::Responses::WebSearchTool::UserLocation::Type::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
@@ -207,23 +273,54 @@ module OpenAI
             # user, e.g. `America/Los_Angeles`.
             timezone: nil,
             # The type of location approximation. Always `approximate`.
-            type: :approximate
+            type: nil
           )
           end
 
           sig do
             override.returns(
               {
-                type: Symbol,
                 city: T.nilable(String),
                 country: T.nilable(String),
                 region: T.nilable(String),
-                timezone: T.nilable(String)
+                timezone: T.nilable(String),
+                type:
+                  OpenAI::Responses::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::WebSearchTool::UserLocation::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            APPROXIMATE =
+              T.let(
+                :approximate,
+                OpenAI::Responses::WebSearchTool::UserLocation::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::WebSearchTool::UserLocation::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
       end
     end