openai 0.19.0 → 0.20.0

data/rbi/openai/models/evals/run_create_params.rbi

@@ -1126,6 +1126,7 @@ module OpenAI
                         OpenAI::Responses::Tool::ImageGeneration,
                         OpenAI::Responses::Tool::LocalShell,
                         OpenAI::Responses::CustomTool,
+                        OpenAI::Responses::Tool::WebSearchTool,
                         OpenAI::Responses::WebSearchTool
                       )
                     ]
@@ -1147,6 +1148,7 @@ 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
                       )
                     ]
@@ -1179,6 +1181,7 @@ 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
                       )
                     ],
@@ -1237,6 +1240,7 @@ module OpenAI
                           OpenAI::Responses::Tool::ImageGeneration,
                           OpenAI::Responses::Tool::LocalShell,
                           OpenAI::Responses::CustomTool,
+                          OpenAI::Responses::Tool::WebSearchTool,
                           OpenAI::Responses::WebSearchTool
                         )
                       ],

data/rbi/openai/models/evals/run_create_response.rbi

@@ -1175,6 +1175,7 @@ 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
                       )
                     ]
@@ -1207,6 +1208,7 @@ 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
                       )
                     ],

data/rbi/openai/models/evals/run_list_response.rbi

@@ -1171,6 +1171,7 @@ 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
                       )
                     ]
@@ -1203,6 +1204,7 @@ 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
                       )
                     ],

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

@@ -1177,6 +1177,7 @@ 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
                       )
                     ]
@@ -1209,6 +1210,7 @@ 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
                       )
                     ],

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

@@ -349,6 +349,7 @@ 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
                 )
               ],

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

@@ -36,6 +36,8 @@ module OpenAI
         # Specify additional output data to include in the model response. Currently
         # supported values are:
         #
+        # - `web_search_call.action.sources`: Include the sources of the web search tool
+        #   call.
         # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
         #   in code interpreter tool call items.
         # - `computer_call_output.output.image_url`: Include image urls from the computer
@@ -328,6 +330,7 @@ module OpenAI
                   OpenAI::Responses::Tool::ImageGeneration,
                   OpenAI::Responses::Tool::LocalShell,
                   OpenAI::Responses::CustomTool,
+                  OpenAI::Responses::Tool::WebSearchTool,
                   OpenAI::Responses::WebSearchTool
                 )
               ]
@@ -349,6 +352,7 @@ 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
                 )
               ]
@@ -458,6 +462,7 @@ 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
                 )
               ],
@@ -483,6 +488,8 @@ module OpenAI
           # Specify additional output data to include in the model response. Currently
           # supported values are:
           #
+          # - `web_search_call.action.sources`: Include the sources of the web search tool
+          #   call.
           # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
           #   in code interpreter tool call items.
           # - `computer_call_output.output.image_url`: Include image urls from the computer
@@ -700,6 +707,7 @@ module OpenAI
                     OpenAI::Responses::Tool::ImageGeneration,
                     OpenAI::Responses::Tool::LocalShell,
                     OpenAI::Responses::CustomTool,
+                    OpenAI::Responses::Tool::WebSearchTool,
                     OpenAI::Responses::WebSearchTool
                   )
                 ],

data/rbi/openai/models/responses/response_function_web_search.rbi

@@ -121,21 +121,97 @@ module OpenAI
             sig { returns(Symbol) }
             attr_accessor :type
 
+            # The sources used in the search.
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source
+                  ]
+                )
+              )
+            end
+            attr_reader :sources
+
+            sig do
+              params(
+                sources:
+                  T::Array[
+                    OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source::OrHash
+                  ]
+              ).void
+            end
+            attr_writer :sources
+
             # Action type "search" - Performs a web search query.
             sig do
-              params(query: String, type: Symbol).returns(T.attached_class)
+              params(
+                query: String,
+                sources:
+                  T::Array[
+                    OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source::OrHash
+                  ],
+                type: Symbol
+              ).returns(T.attached_class)
             end
             def self.new(
               # The search query.
               query:,
+              # The sources used in the search.
+              sources: nil,
               # The action type.
               type: :search
             )
             end
 
-            sig { override.returns({ query: String, type: Symbol }) }
+            sig do
+              override.returns(
+                {
+                  query: String,
+                  type: Symbol,
+                  sources:
+                    T::Array[
+                      OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source
+                    ]
+                }
+              )
+            end
             def to_hash
             end
+
+            class Source < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              # The type of source. Always `url`.
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # The URL of the source.
+              sig { returns(String) }
+              attr_accessor :url
+
+              # A source used in the search.
+              sig do
+                params(url: String, type: Symbol).returns(T.attached_class)
+              end
+              def self.new(
+                # The URL of the source.
+                url:,
+                # The type of source. Always `url`.
+                type: :url
+              )
+              end
+
+              sig { override.returns({ type: Symbol, url: String }) }
+              def to_hash
+              end
+            end
           end
 
           class OpenPage < OpenAI::Internal::Type::BaseModel

data/rbi/openai/models/responses/response_includable.rbi

@@ -6,6 +6,8 @@ module OpenAI
       # Specify additional output data to include in the model response. Currently
       # supported values are:
       #
+      # - `web_search_call.action.sources`: Include the sources of the web search tool
+      #   call.
       # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
       #   in code interpreter tool call items.
       # - `computer_call_output.output.image_url`: Include image urls from the computer

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

@@ -18,10 +18,357 @@ module OpenAI
               OpenAI::Responses::Tool::ImageGeneration,
               OpenAI::Responses::Tool::LocalShell,
               OpenAI::Responses::CustomTool,
+              OpenAI::Responses::Tool::WebSearchTool,
               OpenAI::Responses::WebSearchTool
             )
           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/resources/conversations/items.rbi

@@ -99,6 +99,8 @@ module OpenAI
           # Specify additional output data to include in the model response. Currently
           # supported values are:
           #
+          # - `web_search_call.action.sources`: Include the sources of the web search tool
+          #   call.
           # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
           #   in code interpreter tool call items.
           # - `computer_call_output.output.image_url`: Include image urls from the computer

data/rbi/openai/resources/conversations.rbi

@@ -6,7 +6,7 @@ module OpenAI
       sig { returns(OpenAI::Resources::Conversations::Items) }
       attr_reader :items
 
-      # Create a conversation with the given ID.
+      # Create a conversation.
       sig do
         params(
           items:

data/rbi/openai/resources/responses.rbi

@@ -85,6 +85,7 @@ 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
               )
             ],
@@ -111,6 +112,8 @@ module OpenAI
         # Specify additional output data to include in the model response. Currently
         # supported values are:
         #
+        # - `web_search_call.action.sources`: Include the sources of the web search tool
+        #   call.
         # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
         #   in code interpreter tool call items.
         # - `computer_call_output.output.image_url`: Include image urls from the computer
@@ -352,6 +355,7 @@ 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
               )
             ],
@@ -382,6 +386,8 @@ module OpenAI
         # Specify additional output data to include in the model response. Currently
         # supported values are:
         #
+        # - `web_search_call.action.sources`: Include the sources of the web search tool
+        #   call.
         # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
         #   in code interpreter tool call items.
         # - `computer_call_output.output.image_url`: Include image urls from the computer