openai 0.9.0 → 0.11.0

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

@@ -16,6 +16,19 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :id
 
+        # An object describing the specific action taken in this web search call. Includes
+        # details on how the model used the web (search, open_page, find).
+        sig do
+          returns(
+            T.any(
+              OpenAI::Responses::ResponseFunctionWebSearch::Action::Search,
+              OpenAI::Responses::ResponseFunctionWebSearch::Action::OpenPage,
+              OpenAI::Responses::ResponseFunctionWebSearch::Action::Find
+            )
+          )
+        end
+        attr_accessor :action
+
         # The status of the web search tool call.
         sig do
           returns(
@@ -34,6 +47,12 @@ module OpenAI
         sig do
           params(
             id: String,
+            action:
+              T.any(
+                OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::OrHash,
+                OpenAI::Responses::ResponseFunctionWebSearch::Action::OpenPage::OrHash,
+                OpenAI::Responses::ResponseFunctionWebSearch::Action::Find::OrHash
+              ),
             status:
               OpenAI::Responses::ResponseFunctionWebSearch::Status::OrSymbol,
             type: Symbol
@@ -42,6 +61,9 @@ module OpenAI
         def self.new(
           # The unique ID of the web search tool call.
           id:,
+          # An object describing the specific action taken in this web search call. Includes
+          # details on how the model used the web (search, open_page, find).
+          action:,
           # The status of the web search tool call.
           status:,
           # The type of the web search tool call. Always `web_search_call`.
@@ -53,6 +75,12 @@ module OpenAI
           override.returns(
             {
               id: String,
+              action:
+                T.any(
+                  OpenAI::Responses::ResponseFunctionWebSearch::Action::Search,
+                  OpenAI::Responses::ResponseFunctionWebSearch::Action::OpenPage,
+                  OpenAI::Responses::ResponseFunctionWebSearch::Action::Find
+                ),
               status:
                 OpenAI::Responses::ResponseFunctionWebSearch::Status::OrSymbol,
               type: Symbol
@@ -62,6 +90,141 @@ module OpenAI
         def to_hash
         end
 
+        # An object describing the specific action taken in this web search call. Includes
+        # details on how the model used the web (search, open_page, find).
+        module Action
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                OpenAI::Responses::ResponseFunctionWebSearch::Action::Search,
+                OpenAI::Responses::ResponseFunctionWebSearch::Action::OpenPage,
+                OpenAI::Responses::ResponseFunctionWebSearch::Action::Find
+              )
+            end
+
+          class Search < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseFunctionWebSearch::Action::Search,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The search query.
+            sig { returns(String) }
+            attr_accessor :query
+
+            # The action type.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Action type "search" - Performs a web search query.
+            sig do
+              params(query: String, type: Symbol).returns(T.attached_class)
+            end
+            def self.new(
+              # The search query.
+              query:,
+              # The action type.
+              type: :search
+            )
+            end
+
+            sig { override.returns({ query: String, type: Symbol }) }
+            def to_hash
+            end
+          end
+
+          class OpenPage < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseFunctionWebSearch::Action::OpenPage,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The action type.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # The URL opened by the model.
+            sig { returns(String) }
+            attr_accessor :url
+
+            # Action type "open_page" - Opens a specific URL from search results.
+            sig { params(url: String, type: Symbol).returns(T.attached_class) }
+            def self.new(
+              # The URL opened by the model.
+              url:,
+              # The action type.
+              type: :open_page
+            )
+            end
+
+            sig { override.returns({ type: Symbol, url: String }) }
+            def to_hash
+            end
+          end
+
+          class Find < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseFunctionWebSearch::Action::Find,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # The pattern or text to search for within the page.
+            sig { returns(String) }
+            attr_accessor :pattern
+
+            # The action type.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # The URL of the page searched for the pattern.
+            sig { returns(String) }
+            attr_accessor :url
+
+            # Action type "find": Searches for a pattern within a loaded page.
+            sig do
+              params(pattern: String, url: String, type: Symbol).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # The pattern or text to search for within the page.
+              pattern:,
+              # The URL of the page searched for the pattern.
+              url:,
+              # The action type.
+              type: :find
+            )
+            end
+
+            sig do
+              override.returns({ pattern: String, type: Symbol, url: String })
+            end
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseFunctionWebSearch::Action::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+
         # The status of the web search tool call.
         module Status
           extend OpenAI::Internal::Type::Enum

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

@@ -6,18 +6,19 @@ module OpenAI
       # Specify additional output data to include in the model response. Currently
       # supported values are:
       #
+      # - `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
+      #   call output.
       # - `file_search_call.results`: Include the search results of the file search tool
       #   call.
       # - `message.input_image.image_url`: Include image urls from the input message.
-      # - `computer_call_output.output.image_url`: Include image urls from the computer
-      #   call output.
+      # - `message.output_text.logprobs`: Include logprobs with assistant messages.
       # - `reasoning.encrypted_content`: Includes an encrypted version of reasoning
       #   tokens in reasoning item outputs. This enables reasoning items to be used in
       #   multi-turn conversations when using the Responses API statelessly (like when
       #   the `store` parameter is set to `false`, or when an organization is enrolled
       #   in the zero data retention program).
-      # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
-      #   in code interpreter tool call items.
       module ResponseIncludable
         extend OpenAI::Internal::Type::Enum
 
@@ -25,6 +26,16 @@ module OpenAI
           T.type_alias { T.all(Symbol, OpenAI::Responses::ResponseIncludable) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        CODE_INTERPRETER_CALL_OUTPUTS =
+          T.let(
+            :"code_interpreter_call.outputs",
+            OpenAI::Responses::ResponseIncludable::TaggedSymbol
+          )
+        COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL =
+          T.let(
+            :"computer_call_output.output.image_url",
+            OpenAI::Responses::ResponseIncludable::TaggedSymbol
+          )
         FILE_SEARCH_CALL_RESULTS =
           T.let(
             :"file_search_call.results",
@@ -35,9 +46,9 @@ module OpenAI
             :"message.input_image.image_url",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
-        COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL =
+        MESSAGE_OUTPUT_TEXT_LOGPROBS =
           T.let(
-            :"computer_call_output.output.image_url",
+            :"message.output_text.logprobs",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
         REASONING_ENCRYPTED_CONTENT =
@@ -45,11 +56,6 @@ module OpenAI
             :"reasoning.encrypted_content",
             OpenAI::Responses::ResponseIncludable::TaggedSymbol
           )
-        CODE_INTERPRETER_CALL_OUTPUTS =
-          T.let(
-            :"code_interpreter_call.outputs",
-            OpenAI::Responses::ResponseIncludable::TaggedSymbol
-          )
 
         sig do
           override.returns(

data/rbi/openai/models/responses/response_output_text.rbi

@@ -131,6 +131,10 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :file_id
 
+            # The filename of the file cited.
+            sig { returns(String) }
+            attr_accessor :filename
+
             # The index of the file in the list of files.
             sig { returns(Integer) }
             attr_accessor :index
@@ -141,13 +145,18 @@ module OpenAI
 
             # A citation to a file.
             sig do
-              params(file_id: String, index: Integer, type: Symbol).returns(
-                T.attached_class
-              )
+              params(
+                file_id: String,
+                filename: String,
+                index: Integer,
+                type: Symbol
+              ).returns(T.attached_class)
             end
             def self.new(
               # The ID of the file.
               file_id:,
+              # The filename of the file cited.
+              filename:,
               # The index of the file in the list of files.
               index:,
               # The type of the file citation. Always `file_citation`.
@@ -157,7 +166,12 @@ module OpenAI
 
             sig do
               override.returns(
-                { file_id: String, index: Integer, type: Symbol }
+                {
+                  file_id: String,
+                  filename: String,
+                  index: Integer,
+                  type: Symbol
+                }
               )
             end
             def to_hash
@@ -253,6 +267,10 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :file_id
 
+            # The filename of the container file cited.
+            sig { returns(String) }
+            attr_accessor :filename
+
             # The index of the first character of the container file citation in the message.
             sig { returns(Integer) }
             attr_accessor :start_index
@@ -267,6 +285,7 @@ module OpenAI
                 container_id: String,
                 end_index: Integer,
                 file_id: String,
+                filename: String,
                 start_index: Integer,
                 type: Symbol
               ).returns(T.attached_class)
@@ -278,6 +297,8 @@ module OpenAI
               end_index:,
               # The ID of the file.
               file_id:,
+              # The filename of the container file cited.
+              filename:,
               # The index of the first character of the container file citation in the message.
               start_index:,
               # The type of the container file citation. Always `container_file_citation`.
@@ -291,6 +312,7 @@ module OpenAI
                   container_id: String,
                   end_index: Integer,
                   file_id: String,
+                  filename: String,
                   start_index: Integer,
                   type: Symbol
                 }

data/rbi/openai/models/responses/tool_choice_mcp.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ToolChoiceMcp < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Responses::ToolChoiceMcp, OpenAI::Internal::AnyHash)
+          end
+
+        # The label of the MCP server to use.
+        sig { returns(String) }
+        attr_accessor :server_label
+
+        # For MCP tools, the type is always `mcp`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The name of the tool to call on the server.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # Use this option to force the model to call a specific tool on a remote MCP
+        # server.
+        sig do
+          params(
+            server_label: String,
+            name: T.nilable(String),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The label of the MCP server to use.
+          server_label:,
+          # The name of the tool to call on the server.
+          name: nil,
+          # For MCP tools, the type is always `mcp`.
+          type: :mcp
+        )
+        end
+
+        sig do
+          override.returns(
+            { server_label: String, type: Symbol, name: T.nilable(String) }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/responses/tool_choice_types.rbi

@@ -18,7 +18,6 @@ module OpenAI
         # - `web_search_preview`
         # - `computer_use_preview`
         # - `code_interpreter`
-        # - `mcp`
         # - `image_generation`
         sig { returns(OpenAI::Responses::ToolChoiceTypes::Type::OrSymbol) }
         attr_accessor :type
@@ -40,7 +39,6 @@ module OpenAI
           # - `web_search_preview`
           # - `computer_use_preview`
           # - `code_interpreter`
-          # - `mcp`
           # - `image_generation`
           type:
         )
@@ -63,7 +61,6 @@ module OpenAI
         # - `web_search_preview`
         # - `computer_use_preview`
         # - `code_interpreter`
-        # - `mcp`
         # - `image_generation`
         module Type
           extend OpenAI::Internal::Type::Enum
@@ -104,8 +101,6 @@ module OpenAI
               :code_interpreter,
               OpenAI::Responses::ToolChoiceTypes::Type::TaggedSymbol
             )
-          MCP =
-            T.let(:mcp, OpenAI::Responses::ToolChoiceTypes::Type::TaggedSymbol)
 
           sig do
             override.returns(

data/rbi/openai/models/responses_model.rbi

@@ -43,6 +43,26 @@ module OpenAI
             :"o3-pro-2025-06-10",
             OpenAI::ResponsesModel::ResponsesOnlyModel::TaggedSymbol
           )
+        O3_DEEP_RESEARCH =
+          T.let(
+            :"o3-deep-research",
+            OpenAI::ResponsesModel::ResponsesOnlyModel::TaggedSymbol
+          )
+        O3_DEEP_RESEARCH_2025_06_26 =
+          T.let(
+            :"o3-deep-research-2025-06-26",
+            OpenAI::ResponsesModel::ResponsesOnlyModel::TaggedSymbol
+          )
+        O4_MINI_DEEP_RESEARCH =
+          T.let(
+            :"o4-mini-deep-research",
+            OpenAI::ResponsesModel::ResponsesOnlyModel::TaggedSymbol
+          )
+        O4_MINI_DEEP_RESEARCH_2025_06_26 =
+          T.let(
+            :"o4-mini-deep-research-2025-06-26",
+            OpenAI::ResponsesModel::ResponsesOnlyModel::TaggedSymbol
+          )
         COMPUTER_USE_PREVIEW =
           T.let(
             :"computer-use-preview",

data/rbi/openai/models/webhooks/batch_cancelled_webhook_event.rbi

@@ -0,0 +1,154 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Webhooks
+      class BatchCancelledWebhookEvent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Webhooks::BatchCancelledWebhookEvent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the event.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp (in seconds) of when the batch API request was cancelled.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Event data payload.
+        sig { returns(OpenAI::Webhooks::BatchCancelledWebhookEvent::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: OpenAI::Webhooks::BatchCancelledWebhookEvent::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # The type of the event. Always `batch.cancelled`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The object of the event. Always `event`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Webhooks::BatchCancelledWebhookEvent::Object::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :object
+
+        sig do
+          params(
+            object:
+              OpenAI::Webhooks::BatchCancelledWebhookEvent::Object::OrSymbol
+          ).void
+        end
+        attr_writer :object
+
+        # Sent when a batch API request has been cancelled.
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            data: OpenAI::Webhooks::BatchCancelledWebhookEvent::Data::OrHash,
+            object:
+              OpenAI::Webhooks::BatchCancelledWebhookEvent::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 batch API request was cancelled.
+          created_at:,
+          # Event data payload.
+          data:,
+          # The object of the event. Always `event`.
+          object: nil,
+          # The type of the event. Always `batch.cancelled`.
+          type: :"batch.cancelled"
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              data: OpenAI::Webhooks::BatchCancelledWebhookEvent::Data,
+              type: Symbol,
+              object:
+                OpenAI::Webhooks::BatchCancelledWebhookEvent::Object::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Webhooks::BatchCancelledWebhookEvent::Data,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The unique ID of the batch API request.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Event data payload.
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # The unique ID of the batch API request.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          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::BatchCancelledWebhookEvent::Object
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              OpenAI::Webhooks::BatchCancelledWebhookEvent::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Webhooks::BatchCancelledWebhookEvent::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end