openai 0.68.0 → 0.69.0

data/lib/openai/models/beta/beta_response_tool_search_call.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseToolSearchCall < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the tool search call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute arguments
+        #   Arguments used for the tool search call.
+        #
+        #   @return [Object]
+        required :arguments, OpenAI::Internal::Type::Unknown
+
+        # @!attribute call_id
+        #   The unique ID of the tool search call generated by the model.
+        #
+        #   @return [String, nil]
+        required :call_id, String, nil?: true
+
+        # @!attribute execution
+        #   Whether tool search was executed by the server or by the client.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchCall::Execution]
+        required :execution, enum: -> { OpenAI::Beta::BetaResponseToolSearchCall::Execution }
+
+        # @!attribute status
+        #   The status of the tool search call item that was recorded.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchCall::Status]
+        required :status, enum: -> { OpenAI::Beta::BetaResponseToolSearchCall::Status }
+
+        # @!attribute type
+        #   The type of the item. Always `tool_search_call`.
+        #
+        #   @return [Symbol, :tool_search_call]
+        required :type, const: :tool_search_call
+
+        # @!attribute agent
+        #   The agent that produced this item.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseToolSearchCall::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseToolSearchCall::Agent }
+
+        # @!attribute created_by
+        #   The identifier of the actor that created the item.
+        #
+        #   @return [String, nil]
+        optional :created_by, String
+
+        # @!method initialize(id:, arguments:, call_id:, execution:, status:, agent: nil, created_by: nil, type: :tool_search_call)
+        #   @param id [String] The unique ID of the tool search call item.
+        #
+        #   @param arguments [Object] Arguments used for the tool search call.
+        #
+        #   @param call_id [String, nil] The unique ID of the tool search call generated by the model.
+        #
+        #   @param execution [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchCall::Execution] Whether tool search was executed by the server or by the client.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchCall::Status] The status of the tool search call item that was recorded.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseToolSearchCall::Agent] The agent that produced this item.
+        #
+        #   @param created_by [String] The identifier of the actor that created the item.
+        #
+        #   @param type [Symbol, :tool_search_call] The type of the item. Always `tool_search_call`.
+
+        # Whether tool search was executed by the server or by the client.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseToolSearchCall#execution
+        module Execution
+          extend OpenAI::Internal::Type::Enum
+
+          SERVER = :server
+          CLIENT = :client
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the tool search call item that was recorded.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseToolSearchCall#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseToolSearchCall#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that produced this item.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseToolSearchCall = Beta::BetaResponseToolSearchCall
+  end
+end

data/lib/openai/models/beta/beta_response_tool_search_output_item.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseToolSearchOutputItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique ID of the tool search output item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute call_id
+        #   The unique ID of the tool search call generated by the model.
+        #
+        #   @return [String, nil]
+        required :call_id, String, nil?: true
+
+        # @!attribute execution
+        #   Whether tool search was executed by the server or by the client.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem::Execution]
+        required :execution, enum: -> { OpenAI::Beta::BetaResponseToolSearchOutputItem::Execution }
+
+        # @!attribute status
+        #   The status of the tool search output item that was recorded.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem::Status]
+        required :status, enum: -> { OpenAI::Beta::BetaResponseToolSearchOutputItem::Status }
+
+        # @!attribute tools
+        #   The loaded tool definitions returned by tool search.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>]
+        required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaTool] }
+
+        # @!attribute type
+        #   The type of the item. Always `tool_search_output`.
+        #
+        #   @return [Symbol, :tool_search_output]
+        required :type, const: :tool_search_output
+
+        # @!attribute agent
+        #   The agent that produced this item.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseToolSearchOutputItem::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseToolSearchOutputItem::Agent }
+
+        # @!attribute created_by
+        #   The identifier of the actor that created the item.
+        #
+        #   @return [String, nil]
+        optional :created_by, String
+
+        # @!method initialize(id:, call_id:, execution:, status:, tools:, agent: nil, created_by: nil, type: :tool_search_output)
+        #   @param id [String] The unique ID of the tool search output item.
+        #
+        #   @param call_id [String, nil] The unique ID of the tool search call generated by the model.
+        #
+        #   @param execution [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem::Execution] Whether tool search was executed by the server or by the client.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem::Status] The status of the tool search output item that was recorded.
+        #
+        #   @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>] The loaded tool definitions returned by tool search.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseToolSearchOutputItem::Agent] The agent that produced this item.
+        #
+        #   @param created_by [String] The identifier of the actor that created the item.
+        #
+        #   @param type [Symbol, :tool_search_output] The type of the item. Always `tool_search_output`.
+
+        # Whether tool search was executed by the server or by the client.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseToolSearchOutputItem#execution
+        module Execution
+          extend OpenAI::Internal::Type::Enum
+
+          SERVER = :server
+          CLIENT = :client
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the tool search output item that was recorded.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseToolSearchOutputItem#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseToolSearchOutputItem#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that produced this item.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseToolSearchOutputItem = Beta::BetaResponseToolSearchOutputItem
+  end
+end

data/lib/openai/models/beta/beta_response_tool_search_output_item_param.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseToolSearchOutputItemParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute tools
+        #   The loaded tool definitions returned by the tool search output.
+        #
+        #   @return [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>]
+        required :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::BetaTool] }
+
+        # @!attribute type
+        #   The item type. Always `tool_search_output`.
+        #
+        #   @return [Symbol, :tool_search_output]
+        required :type, const: :tool_search_output
+
+        # @!attribute id
+        #   The unique ID of this tool search output.
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute agent
+        #   The agent that produced this item.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Agent }, nil?: true
+
+        # @!attribute call_id
+        #   The unique ID of the tool search call generated by the model.
+        #
+        #   @return [String, nil]
+        optional :call_id, String, nil?: true
+
+        # @!attribute execution
+        #   Whether tool search was executed by the server or by the client.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Execution, nil]
+        optional :execution, enum: -> { OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Execution }
+
+        # @!attribute status
+        #   The status of the tool search output.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Status, nil]
+        optional :status, enum: -> { OpenAI::Beta::BetaResponseToolSearchOutputItemParam::Status }, nil?: true
+
+        # @!method initialize(tools:, id: nil, agent: nil, call_id: nil, execution: nil, status: nil, type: :tool_search_output)
+        #   @param tools [Array<OpenAI::Models::Beta::BetaFunctionTool, OpenAI::Models::Beta::BetaFileSearchTool, OpenAI::Models::Beta::BetaComputerTool, OpenAI::Models::Beta::BetaComputerUsePreviewTool, OpenAI::Models::Beta::BetaTool::Mcp, OpenAI::Models::Beta::BetaTool::CodeInterpreter, OpenAI::Models::Beta::BetaTool::ProgrammaticToolCalling, OpenAI::Models::Beta::BetaTool::ImageGeneration, OpenAI::Models::Beta::BetaTool::LocalShell, OpenAI::Models::Beta::BetaFunctionShellTool, OpenAI::Models::Beta::BetaCustomTool, OpenAI::Models::Beta::BetaNamespaceTool, OpenAI::Models::Beta::BetaToolSearchTool, OpenAI::Models::Beta::BetaApplyPatchTool, OpenAI::Models::Beta::BetaWebSearchTool, OpenAI::Models::Beta::BetaWebSearchPreviewTool>] The loaded tool definitions returned by the tool search output.
+        #
+        #   @param id [String, nil] The unique ID of this tool search output.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Agent, nil] The agent that produced this item.
+        #
+        #   @param call_id [String, nil] The unique ID of the tool search call generated by the model.
+        #
+        #   @param execution [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Execution] Whether tool search was executed by the server or by the client.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam::Status, nil] The status of the tool search output.
+        #
+        #   @param type [Symbol, :tool_search_output] The item type. Always `tool_search_output`.
+
+        # @see OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that produced this item.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+
+        # Whether tool search was executed by the server or by the client.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam#execution
+        module Execution
+          extend OpenAI::Internal::Type::Enum
+
+          SERVER = :server
+          CLIENT = :client
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the tool search output.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseToolSearchOutputItemParam#status
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaResponseToolSearchOutputItemParam = Beta::BetaResponseToolSearchOutputItemParam
+  end
+end

data/lib/openai/models/beta/beta_response_usage.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseUsage < OpenAI::Internal::Type::BaseModel
+        # @!attribute input_tokens
+        #   The number of input tokens.
+        #
+        #   @return [Integer]
+        required :input_tokens, Integer
+
+        # @!attribute input_tokens_details
+        #   A detailed breakdown of the input tokens.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseUsage::InputTokensDetails]
+        required :input_tokens_details, -> { OpenAI::Beta::BetaResponseUsage::InputTokensDetails }
+
+        # @!attribute output_tokens
+        #   The number of output tokens.
+        #
+        #   @return [Integer]
+        required :output_tokens, Integer
+
+        # @!attribute output_tokens_details
+        #   A detailed breakdown of the output tokens.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseUsage::OutputTokensDetails]
+        required :output_tokens_details, -> { OpenAI::Beta::BetaResponseUsage::OutputTokensDetails }
+
+        # @!attribute total_tokens
+        #   The total number of tokens used.
+        #
+        #   @return [Integer]
+        required :total_tokens, Integer
+
+        # @!method initialize(input_tokens:, input_tokens_details:, output_tokens:, output_tokens_details:, total_tokens:)
+        #   Represents token usage details including input tokens, output tokens, a
+        #   breakdown of output tokens, and the total tokens used.
+        #
+        #   @param input_tokens [Integer] The number of input tokens.
+        #
+        #   @param input_tokens_details [OpenAI::Models::Beta::BetaResponseUsage::InputTokensDetails] A detailed breakdown of the input tokens.
+        #
+        #   @param output_tokens [Integer] The number of output tokens.
+        #
+        #   @param output_tokens_details [OpenAI::Models::Beta::BetaResponseUsage::OutputTokensDetails] A detailed breakdown of the output tokens.
+        #
+        #   @param total_tokens [Integer] The total number of tokens used.
+
+        # @see OpenAI::Models::Beta::BetaResponseUsage#input_tokens_details
+        class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute cache_write_tokens
+          #   The number of input tokens that were written to the cache.
+          #
+          #   @return [Integer]
+          required :cache_write_tokens, Integer
+
+          # @!attribute cached_tokens
+          #   The number of tokens that were retrieved from the cache.
+          #   [More on prompt caching](https://platform.openai.com/docs/guides/prompt-caching).
+          #
+          #   @return [Integer]
+          required :cached_tokens, Integer
+
+          # @!method initialize(cache_write_tokens:, cached_tokens:)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Beta::BetaResponseUsage::InputTokensDetails} for more details.
+          #
+          #   A detailed breakdown of the input tokens.
+          #
+          #   @param cache_write_tokens [Integer] The number of input tokens that were written to the cache.
+          #
+          #   @param cached_tokens [Integer] The number of tokens that were retrieved from the cache.
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseUsage#output_tokens_details
+        class OutputTokensDetails < OpenAI::Internal::Type::BaseModel
+          # @!attribute reasoning_tokens
+          #   The number of reasoning tokens.
+          #
+          #   @return [Integer]
+          required :reasoning_tokens, Integer
+
+          # @!method initialize(reasoning_tokens:)
+          #   A detailed breakdown of the output tokens.
+          #
+          #   @param reasoning_tokens [Integer] The number of reasoning tokens.
+        end
+      end
+    end
+
+    BetaResponseUsage = Beta::BetaResponseUsage
+  end
+end

data/lib/openai/models/beta/beta_response_web_search_call_completed_event.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseWebSearchCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   Unique ID for the output item associated with the web search call.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that the web search call is associated with.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of the web search call being processed.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.web_search_call.completed`.
+        #
+        #   @return [Symbol, :"response.web_search_call.completed"]
+        required :type, const: :"response.web_search_call.completed"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseWebSearchCallCompletedEvent::Agent }, nil?: true
+
+        # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.web_search_call.completed")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent} for more
+        #   details.
+        #
+        #   Emitted when a web search call is completed.
+        #
+        #   @param item_id [String] Unique ID for the output item associated with the web search call.
+        #
+        #   @param output_index [Integer] The index of the output item that the web search call is associated with.
+        #
+        #   @param sequence_number [Integer] The sequence number of the web search call being processed.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.web_search_call.completed"] The type of the event. Always `response.web_search_call.completed`.
+
+        # @see OpenAI::Models::Beta::BetaResponseWebSearchCallCompletedEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that owns this multi-agent streaming event.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseWebSearchCallCompletedEvent = Beta::BetaResponseWebSearchCallCompletedEvent
+  end
+end

data/lib/openai/models/beta/beta_response_web_search_call_in_progress_event.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseWebSearchCallInProgressEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   Unique ID for the output item associated with the web search call.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that the web search call is associated with.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of the web search call being processed.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.web_search_call.in_progress`.
+        #
+        #   @return [Symbol, :"response.web_search_call.in_progress"]
+        required :type, const: :"response.web_search_call.in_progress"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseWebSearchCallInProgressEvent::Agent }, nil?: true
+
+        # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.web_search_call.in_progress")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent} for more
+        #   details.
+        #
+        #   Emitted when a web search call is initiated.
+        #
+        #   @param item_id [String] Unique ID for the output item associated with the web search call.
+        #
+        #   @param output_index [Integer] The index of the output item that the web search call is associated with.
+        #
+        #   @param sequence_number [Integer] The sequence number of the web search call being processed.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.web_search_call.in_progress"] The type of the event. Always `response.web_search_call.in_progress`.
+
+        # @see OpenAI::Models::Beta::BetaResponseWebSearchCallInProgressEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that owns this multi-agent streaming event.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseWebSearchCallInProgressEvent = Beta::BetaResponseWebSearchCallInProgressEvent
+  end
+end

data/lib/openai/models/beta/beta_response_web_search_call_searching_event.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseWebSearchCallSearchingEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   Unique ID for the output item associated with the web search call.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that the web search call is associated with.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of the web search call being processed.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.web_search_call.searching`.
+        #
+        #   @return [Symbol, :"response.web_search_call.searching"]
+        required :type, const: :"response.web_search_call.searching"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseWebSearchCallSearchingEvent::Agent }, nil?: true
+
+        # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.web_search_call.searching")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent} for more
+        #   details.
+        #
+        #   Emitted when a web search call is executing.
+        #
+        #   @param item_id [String] Unique ID for the output item associated with the web search call.
+        #
+        #   @param output_index [Integer] The index of the output item that the web search call is associated with.
+        #
+        #   @param sequence_number [Integer] The sequence number of the web search call being processed.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.web_search_call.searching"] The type of the event. Always `response.web_search_call.searching`.
+
+        # @see OpenAI::Models::Beta::BetaResponseWebSearchCallSearchingEvent#agent
+        class Agent < OpenAI::Internal::Type::BaseModel
+          # @!attribute agent_name
+          #   The canonical name of the agent that produced this item.
+          #
+          #   @return [String]
+          required :agent_name, String
+
+          # @!method initialize(agent_name:)
+          #   The agent that owns this multi-agent streaming event.
+          #
+          #   @param agent_name [String] The canonical name of the agent that produced this item.
+        end
+      end
+    end
+
+    BetaResponseWebSearchCallSearchingEvent = Beta::BetaResponseWebSearchCallSearchingEvent
+  end
+end