openai 0.68.0 → 0.69.0

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

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseCustomToolCallOutput < OpenAI::Internal::Type::BaseModel
+        # @!attribute call_id
+        #   The call ID, used to map this custom tool call output to a custom tool call.
+        #
+        #   @return [String]
+        required :call_id, String
+
+        # @!attribute output
+        #   The output from the custom tool call generated by your code. Can be a string or
+        #   an list of output content.
+        #
+        #   @return [String, Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>]
+        required :output, union: -> { OpenAI::Beta::BetaResponseCustomToolCallOutput::Output }
+
+        # @!attribute type
+        #   The type of the custom tool call output. Always `custom_tool_call_output`.
+        #
+        #   @return [Symbol, :custom_tool_call_output]
+        required :type, const: :custom_tool_call_output
+
+        # @!attribute id
+        #   The unique ID of the custom tool call output in the OpenAI platform.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute agent
+        #   The agent that produced this item.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseCustomToolCallOutput::Agent }, nil?: true
+
+        # @!attribute caller_
+        #   The execution context that produced this tool call.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::Caller::Program, nil]
+        optional :caller_,
+                 union: -> { OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller },
+                 api_name: :caller,
+                 nil?: true
+
+        # @!method initialize(call_id:, output:, id: nil, agent: nil, caller_: nil, type: :custom_tool_call_output)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseCustomToolCallOutput} for more details.
+        #
+        #   The output of a custom tool call from your code, being sent back to the model.
+        #
+        #   @param call_id [String] The call ID, used to map this custom tool call output to a custom tool call.
+        #
+        #   @param output [String, Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>] The output from the custom tool call generated by your code.
+        #
+        #   @param id [String] The unique ID of the custom tool call output in the OpenAI platform.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::Agent, nil] The agent that produced this item.
+        #
+        #   @param caller_ [OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::Caller::Program, nil] The execution context that produced this tool call.
+        #
+        #   @param type [Symbol, :custom_tool_call_output] The type of the custom tool call output. Always `custom_tool_call_output`.
+
+        # The output from the custom tool call generated by your code. Can be a string or
+        # an list of output content.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseCustomToolCallOutput#output
+        module Output
+          extend OpenAI::Internal::Type::Union
+
+          # A string of the output of the custom tool call.
+          variant String
+
+          # Text, image, or file output of the custom tool call.
+          variant -> { OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::Output::OutputContentListArray }
+
+          # A text input to the model.
+          module OutputContentList
+            extend OpenAI::Internal::Type::Union
+
+            discriminator :type
+
+            # A text input to the model.
+            variant :input_text, -> { OpenAI::Beta::BetaResponseInputText }
+
+            # An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision).
+            variant :input_image, -> { OpenAI::Beta::BetaResponseInputImage }
+
+            # A file input to the model.
+            variant :input_file, -> { OpenAI::Beta::BetaResponseInputFile }
+
+            # @!method self.variants
+            #   @return [Array(OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile)]
+          end
+
+          # @!method self.variants
+          #   @return [Array(String, Array<OpenAI::Models::Beta::BetaResponseInputText, OpenAI::Models::Beta::BetaResponseInputImage, OpenAI::Models::Beta::BetaResponseInputFile>)]
+
+          # @type [OpenAI::Internal::Type::Converter]
+          OutputContentListArray =
+            OpenAI::Internal::Type::ArrayOf[union: -> {
+              OpenAI::Beta::BetaResponseCustomToolCallOutput::Output::OutputContentList
+            }]
+        end
+
+        # @see OpenAI::Models::Beta::BetaResponseCustomToolCallOutput#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
+
+        # The execution context that produced this tool call.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseCustomToolCallOutput#caller_
+        module Caller
+          extend OpenAI::Internal::Type::Union
+
+          discriminator :type
+
+          variant :direct, -> { OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Direct }
+
+          variant :program, -> { OpenAI::Beta::BetaResponseCustomToolCallOutput::Caller::Program }
+
+          class Direct < OpenAI::Internal::Type::BaseModel
+            # @!attribute type
+            #   The caller type. Always `direct`.
+            #
+            #   @return [Symbol, :direct]
+            required :type, const: :direct
+
+            # @!method initialize(type: :direct)
+            #   @param type [Symbol, :direct] The caller type. Always `direct`.
+          end
+
+          class Program < OpenAI::Internal::Type::BaseModel
+            # @!attribute caller_id
+            #   The call ID of the program item that produced this tool call.
+            #
+            #   @return [String]
+            required :caller_id, String
+
+            # @!attribute type
+            #   The caller type. Always `program`.
+            #
+            #   @return [Symbol, :program]
+            required :type, const: :program
+
+            # @!method initialize(caller_id:, type: :program)
+            #   @param caller_id [String] The call ID of the program item that produced this tool call.
+            #
+            #   @param type [Symbol, :program] The caller type. Always `program`.
+          end
+
+          # @!method self.variants
+          #   @return [Array(OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::Caller::Direct, OpenAI::Models::Beta::BetaResponseCustomToolCallOutput::Caller::Program)]
+        end
+      end
+    end
+
+    BetaResponseCustomToolCallOutput = Beta::BetaResponseCustomToolCallOutput
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseCustomToolCallOutputItem < OpenAI::Models::Beta::BetaResponseCustomToolCallOutput
+        # @!attribute id
+        #   The unique ID of the custom tool call output item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        #   Populated when items are returned via API.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem::Status]
+        required :status, enum: -> { OpenAI::Beta::BetaResponseCustomToolCallOutputItem::Status }
+
+        # @!attribute created_by
+        #   The identifier of the actor that created the item.
+        #
+        #   @return [String, nil]
+        optional :created_by, String
+
+        # @!method initialize(id:, status:, created_by: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem} for more details.
+        #
+        #   The output of a custom tool call from your code, being sent back to the model.
+        #
+        #   @param id [String] The unique ID of the custom tool call output item.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem::Status] The status of the item. One of `in_progress`, `completed`, or
+        #
+        #   @param created_by [String] The identifier of the actor that created the item.
+
+        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
+        # Populated when items are returned via API.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          COMPLETED = :completed
+          INCOMPLETE = :incomplete
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaResponseCustomToolCallOutputItem = Beta::BetaResponseCustomToolCallOutputItem
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseError < OpenAI::Internal::Type::BaseModel
+        # @!attribute code
+        #   The error code for the response.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::BetaResponseError::Code]
+        required :code, enum: -> { OpenAI::Beta::BetaResponseError::Code }
+
+        # @!attribute message
+        #   A human-readable description of the error.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!method initialize(code:, message:)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseError} for more details.
+        #
+        #   An error object returned when the model fails to generate a Response.
+        #
+        #   @param code [Symbol, OpenAI::Models::Beta::BetaResponseError::Code] The error code for the response.
+        #
+        #   @param message [String] A human-readable description of the error.
+
+        # The error code for the response.
+        #
+        # @see OpenAI::Models::Beta::BetaResponseError#code
+        module Code
+          extend OpenAI::Internal::Type::Enum
+
+          SERVER_ERROR = :server_error
+          RATE_LIMIT_EXCEEDED = :rate_limit_exceeded
+          INVALID_PROMPT = :invalid_prompt
+          BIO_POLICY = :bio_policy
+          VECTOR_STORE_TIMEOUT = :vector_store_timeout
+          INVALID_IMAGE = :invalid_image
+          INVALID_IMAGE_FORMAT = :invalid_image_format
+          INVALID_BASE64_IMAGE = :invalid_base64_image
+          INVALID_IMAGE_URL = :invalid_image_url
+          IMAGE_TOO_LARGE = :image_too_large
+          IMAGE_TOO_SMALL = :image_too_small
+          IMAGE_PARSE_ERROR = :image_parse_error
+          IMAGE_CONTENT_POLICY_VIOLATION = :image_content_policy_violation
+          INVALID_IMAGE_MODE = :invalid_image_mode
+          IMAGE_FILE_TOO_LARGE = :image_file_too_large
+          UNSUPPORTED_IMAGE_MEDIA_TYPE = :unsupported_image_media_type
+          EMPTY_IMAGE_FILE = :empty_image_file
+          FAILED_TO_DOWNLOAD_IMAGE = :failed_to_download_image
+          IMAGE_FILE_NOT_FOUND = :image_file_not_found
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaResponseError = Beta::BetaResponseError
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseErrorEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute code
+        #   The error code.
+        #
+        #   @return [String, nil]
+        required :code, String, nil?: true
+
+        # @!attribute message
+        #   The error message.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute param
+        #   The error parameter.
+        #
+        #   @return [String, nil]
+        required :param, String, nil?: true
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `error`.
+        #
+        #   @return [Symbol, :error]
+        required :type, const: :error
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseErrorEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseErrorEvent::Agent }, nil?: true
+
+        # @!method initialize(code:, message:, param:, sequence_number:, agent: nil, type: :error)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseErrorEvent} for more details.
+        #
+        #   Emitted when an error occurs.
+        #
+        #   @param code [String, nil] The error code.
+        #
+        #   @param message [String] The error message.
+        #
+        #   @param param [String, nil] The error parameter.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseErrorEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :error] The type of the event. Always `error`.
+
+        # @see OpenAI::Models::Beta::BetaResponseErrorEvent#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
+
+    BetaResponseErrorEvent = Beta::BetaResponseErrorEvent
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseFailedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute response
+        #   The response that failed.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponse]
+        required :response, -> { OpenAI::Beta::BetaResponse }
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.failed`.
+        #
+        #   @return [Symbol, :"response.failed"]
+        required :type, const: :"response.failed"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseFailedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseFailedEvent::Agent }, nil?: true
+
+        # @!method initialize(response:, sequence_number:, agent: nil, type: :"response.failed")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseFailedEvent} for more details.
+        #
+        #   An event that is emitted when a response fails.
+        #
+        #   @param response [OpenAI::Models::Beta::BetaResponse] The response that failed.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFailedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.failed"] The type of the event. Always `response.failed`.
+
+        # @see OpenAI::Models::Beta::BetaResponseFailedEvent#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
+
+    BetaResponseFailedEvent = Beta::BetaResponseFailedEvent
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseFileSearchCallCompletedEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the output item that the file search call is initiated.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that the file search call is initiated.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.file_search_call.completed`.
+        #
+        #   @return [Symbol, :"response.file_search_call.completed"]
+        required :type, const: :"response.file_search_call.completed"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseFileSearchCallCompletedEvent::Agent }, nil?: true
+
+        # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.file_search_call.completed")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent} for more
+        #   details.
+        #
+        #   Emitted when a file search call is completed (results found).
+        #
+        #   @param item_id [String] The ID of the output item that the file search call is initiated.
+        #
+        #   @param output_index [Integer] The index of the output item that the file search call is initiated.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.file_search_call.completed"] The type of the event. Always `response.file_search_call.completed`.
+
+        # @see OpenAI::Models::Beta::BetaResponseFileSearchCallCompletedEvent#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
+
+    BetaResponseFileSearchCallCompletedEvent = Beta::BetaResponseFileSearchCallCompletedEvent
+  end
+end

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

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

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class BetaResponseFileSearchCallSearchingEvent < OpenAI::Internal::Type::BaseModel
+        # @!attribute item_id
+        #   The ID of the output item that the file search call is initiated.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute output_index
+        #   The index of the output item that the file search call is searching.
+        #
+        #   @return [Integer]
+        required :output_index, Integer
+
+        # @!attribute sequence_number
+        #   The sequence number of this event.
+        #
+        #   @return [Integer]
+        required :sequence_number, Integer
+
+        # @!attribute type
+        #   The type of the event. Always `response.file_search_call.searching`.
+        #
+        #   @return [Symbol, :"response.file_search_call.searching"]
+        required :type, const: :"response.file_search_call.searching"
+
+        # @!attribute agent
+        #   The agent that owns this multi-agent streaming event.
+        #
+        #   @return [OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent::Agent, nil]
+        optional :agent, -> { OpenAI::Beta::BetaResponseFileSearchCallSearchingEvent::Agent }, nil?: true
+
+        # @!method initialize(item_id:, output_index:, sequence_number:, agent: nil, type: :"response.file_search_call.searching")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent} for more
+        #   details.
+        #
+        #   Emitted when a file search is currently searching.
+        #
+        #   @param item_id [String] The ID of the output item that the file search call is initiated.
+        #
+        #   @param output_index [Integer] The index of the output item that the file search call is searching.
+        #
+        #   @param sequence_number [Integer] The sequence number of this event.
+        #
+        #   @param agent [OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent::Agent, nil] The agent that owns this multi-agent streaming event.
+        #
+        #   @param type [Symbol, :"response.file_search_call.searching"] The type of the event. Always `response.file_search_call.searching`.
+
+        # @see OpenAI::Models::Beta::BetaResponseFileSearchCallSearchingEvent#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
+
+    BetaResponseFileSearchCallSearchingEvent = Beta::BetaResponseFileSearchCallSearchingEvent
+  end
+end