openai 0.19.0 → 0.21.0

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

data/rbi/openai/models/webhooks/realtime_call_incoming_webhook_event.rbi

@@ -0,0 +1,222 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class RealtimeCallIncomingWebhookEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the model response was completed.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig do
+          returns(OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data)
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # The type of the event. Always `realtime.call.incoming`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Object::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # Sent when Realtime API Receives a incoming SIP call.
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            data:
+              OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::OrHash,
+            object:
+              OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Object::OrSymbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the event.
+          id:,
+          # The Unix timestamp (in seconds) of when the model response was completed.
+          created_at:,
+          # Event data payload.
+          data:,
+          # The object of the event. Always `event`.
+          object: nil,
+          # The type of the event. Always `realtime.call.incoming`.
+          type: :"realtime.call.incoming"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data,
+              type: Symbol,
+              object:
+                OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of this call.
+          sig { returns(String) }
+          attr_accessor :call_id
+
+          # Headers from the SIP Invite.
+          sig do
+            returns(
+              T::Array[
+                OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::SipHeader
+              ]
+            )
+          end
+          attr_accessor :sip_headers
+
+          # Event data payload.
+          sig do
+            params(
+              call_id: String,
+              sip_headers:
+                T::Array[
+                  OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::SipHeader::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The unique ID of this call.
+            call_id:,
+            # Headers from the SIP Invite.
+            sip_headers:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                call_id: String,
+                sip_headers:
+                  T::Array[
+                    OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::SipHeader
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class SipHeader < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::SipHeader,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Name of the SIP Header.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # Value of the SIP Header.
+            sig { returns(String) }
+            attr_accessor :value
+
+            # A header from the SIP Invite.
+            sig do
+              params(name: String, value: String).returns(T.attached_class)
+            end
+            def self.new(
+              # Name of the SIP Header.
+              name:,
+              # Value of the SIP Header.
+              value:
+            )
+            end
+
+            sig { override.returns({ name: String, value: String }) }
+            def to_hash
+            end
+          end
+        end
+
+        # The object of the event. Always `event`.
+        module Object
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/webhooks/unwrap_webhook_event.rbi

@@ -20,6 +20,7 @@ module OpenAI
               OpenAI::Webhooks::FineTuningJobCancelledWebhookEvent,
               OpenAI::Webhooks::FineTuningJobFailedWebhookEvent,
               OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent,
+              OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent,
               OpenAI::Webhooks::ResponseCancelledWebhookEvent,
               OpenAI::Webhooks::ResponseCompletedWebhookEvent,
               OpenAI::Webhooks::ResponseFailedWebhookEvent,

data/rbi/openai/models.rbi

@@ -166,6 +166,8 @@ module OpenAI
   OtherFileChunkingStrategyObject =
     OpenAI::Models::OtherFileChunkingStrategyObject
 
+  Realtime = OpenAI::Models::Realtime
+
   Reasoning = OpenAI::Models::Reasoning
 
   ReasoningEffort = OpenAI::Models::ReasoningEffort

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/realtime/client_secrets.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Realtime
+      class ClientSecrets
+        # Create a Realtime session and client secret for either realtime or
+        # transcription.
+        sig do
+          params(
+            expires_after:
+              OpenAI::Realtime::ClientSecretCreateParams::ExpiresAfter::OrHash,
+            session:
+              T.any(
+                OpenAI::Realtime::RealtimeSessionCreateRequest::OrHash,
+                OpenAI::Realtime::RealtimeTranscriptionSessionCreateRequest::OrHash
+              ),
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(OpenAI::Models::Realtime::ClientSecretCreateResponse)
+        end
+        def create(
+          # Configuration for the ephemeral token expiration.
+          expires_after: nil,
+          # Session configuration to use for the client secret. Choose either a realtime
+          # session or a transcription session.
+          session: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/realtime.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Realtime
+      sig { returns(OpenAI::Resources::Realtime::ClientSecrets) }
+      attr_reader :client_secrets
+
+      # @api private
+      sig { params(client: OpenAI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/openai/resources/responses.rbi

@@ -85,7 +85,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),
@@ -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
@@ -227,7 +230,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
@@ -235,6 +238,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
@@ -352,7 +358,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),
@@ -382,6 +389,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
@@ -498,7 +507,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
@@ -506,6 +515,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

data/rbi/openai/resources/webhooks.rbi

@@ -21,6 +21,7 @@ module OpenAI
             OpenAI::Webhooks::FineTuningJobCancelledWebhookEvent,
             OpenAI::Webhooks::FineTuningJobFailedWebhookEvent,
             OpenAI::Webhooks::FineTuningJobSucceededWebhookEvent,
+            OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent,
             OpenAI::Webhooks::ResponseCancelledWebhookEvent,
             OpenAI::Webhooks::ResponseCompletedWebhookEvent,
             OpenAI::Webhooks::ResponseFailedWebhookEvent,

data/sig/openai/client.rbs

@@ -46,6 +46,8 @@ module OpenAI
 
     attr_reader responses: OpenAI::Resources::Responses
 
+    attr_reader realtime: OpenAI::Resources::Realtime
+
     attr_reader conversations: OpenAI::Resources::Conversations
 
     attr_reader evals: OpenAI::Resources::Evals

data/sig/openai/models/audio/speech_create_params.rbs

@@ -83,6 +83,8 @@ module OpenAI
           | :sage
           | :shimmer
           | :verse
+          | :marin
+          | :cedar
 
         module Voice
           extend OpenAI::Internal::Type::Union
@@ -97,6 +99,8 @@ module OpenAI
           SAGE: :sage
           SHIMMER: :shimmer
           VERSE: :verse
+          MARIN: :marin
+          CEDAR: :cedar
         end
 
         type response_format = :mp3 | :opus | :aac | :flac | :wav | :pcm