openai 0.19.0 → 0.21.0

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
@@ -302,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
@@ -310,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
@@ -328,7 +333,8 @@ module OpenAI
                   OpenAI::Responses::Tool::ImageGeneration,
                   OpenAI::Responses::Tool::LocalShell,
                   OpenAI::Responses::CustomTool,
-                  OpenAI::Responses::WebSearchTool
+                  OpenAI::Responses::WebSearchTool,
+                  OpenAI::Responses::WebSearchPreviewTool
                 )
               ]
             )
@@ -349,7 +355,8 @@ module OpenAI
                   OpenAI::Responses::Tool::ImageGeneration::OrHash,
                   OpenAI::Responses::Tool::LocalShell::OrHash,
                   OpenAI::Responses::CustomTool::OrHash,
-                  OpenAI::Responses::WebSearchTool::OrHash
+                  OpenAI::Responses::WebSearchTool::OrHash,
+                  OpenAI::Responses::WebSearchPreviewTool::OrHash
                 )
               ]
           ).void
@@ -458,7 +465,8 @@ module OpenAI
                   OpenAI::Responses::Tool::ImageGeneration::OrHash,
                   OpenAI::Responses::Tool::LocalShell::OrHash,
                   OpenAI::Responses::CustomTool::OrHash,
-                  OpenAI::Responses::WebSearchTool::OrHash
+                  OpenAI::Responses::WebSearchTool::OrHash,
+                  OpenAI::Responses::WebSearchPreviewTool::OrHash
                 )
               ],
             top_logprobs: T.nilable(Integer),
@@ -483,6 +491,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
@@ -599,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
@@ -607,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
@@ -700,7 +713,8 @@ module OpenAI
                     OpenAI::Responses::Tool::ImageGeneration,
                     OpenAI::Responses::Tool::LocalShell,
                     OpenAI::Responses::CustomTool,
-                    OpenAI::Responses::WebSearchTool
+                    OpenAI::Responses::WebSearchTool,
+                    OpenAI::Responses::WebSearchPreviewTool
                   )
                 ],
               top_logprobs: T.nilable(Integer),

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,7 +18,8 @@ module OpenAI
               OpenAI::Responses::Tool::ImageGeneration,
               OpenAI::Responses::Tool::LocalShell,
               OpenAI::Responses::CustomTool,
-              OpenAI::Responses::WebSearchTool
+              OpenAI::Responses::WebSearchTool,
+              OpenAI::Responses::WebSearchPreviewTool
             )
           end
 

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