openai 0.89.0 → 0.90.0

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

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # @see OpenAI::Resources::Beta::Agents#update
+      class AgentUpdateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        # @!attribute agent_id
+        #
+        #   @return [String]
+        required :agent_id, String
+
+        # @!attribute instructions
+        #   Additional instructions appended to the agent's default base instructions. Omit
+        #   to leave unchanged.
+        #
+        #   @return [String, nil]
+        optional :instructions, String, nil?: true
+
+        # @!attribute metadata
+        #   Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
+        #   Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+        #   characters.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+        # @!attribute model
+        #   The model to use for the agent. The requested model name is preserved.
+        #
+        #   @return [String, nil]
+        optional :model, String
+
+        # @!attribute multi_agent
+        #   Explicit configuration for creating and coordinating subagents.
+        #
+        #   @return [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+        optional :multi_agent, -> { OpenAI::Beta::MultiAgentConfigParam }, nil?: true
+
+        # @!attribute name
+        #   A replacement name. Omit to leave unchanged, or pass null to clear it.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute reasoning
+        #   Reasoning configuration for the agent.
+        #
+        #   @return [OpenAI::Models::Beta::AgentReasoningParam, nil]
+        optional :reasoning, -> { OpenAI::Beta::AgentReasoningParam }, nil?: true
+
+        # @!attribute service_tier
+        #   The service tier used for model requests.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentUpdateParams::ServiceTier, nil]
+        optional :service_tier, enum: -> { OpenAI::Beta::AgentUpdateParams::ServiceTier }, nil?: true
+
+        # @!attribute text
+        #   Configuration for text generated by the agent.
+        #
+        #   @return [OpenAI::Models::Beta::AgentTextParam, nil]
+        optional :text, -> { OpenAI::Beta::AgentTextParam }, nil?: true
+
+        # @!attribute tools
+        #   Tools available to the agent.
+        #
+        #   @return [Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil]
+        optional(
+          :tools,
+          -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::PersistedAgentToolParam] },
+          nil?: true
+        )
+
+        # @!method initialize(agent_id:, instructions: nil, metadata: nil, model: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {})
+        #   @param agent_id [String]
+        #
+        #   @param instructions [String, nil]
+        #     Additional instructions appended to the agent's default base instructions. Omit
+        #     to leave unchanged.
+        #
+        #   @param metadata [Hash{Symbol=>String}, nil]
+        #     Replaces all metadata. Omit to leave unchanged, or pass null or {} to clear it.
+        #     Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+        #     characters.
+        #
+        #   @param model [String]
+        #     The model to use for the agent. The requested model name is preserved.
+        #
+        #   @param multi_agent [OpenAI::Models::Beta::MultiAgentConfigParam, nil]
+        #     Explicit configuration for creating and coordinating subagents.
+        #
+        #   @param name [String, nil]
+        #     A replacement name. Omit to leave unchanged, or pass null to clear it.
+        #
+        #   @param reasoning [OpenAI::Models::Beta::AgentReasoningParam, nil]
+        #     Reasoning configuration for the agent.
+        #
+        #   @param service_tier [Symbol, OpenAI::Models::Beta::AgentUpdateParams::ServiceTier, nil]
+        #     The service tier used for model requests.
+        #
+        #   @param text [OpenAI::Models::Beta::AgentTextParam, nil]
+        #     Configuration for text generated by the agent.
+        #
+        #   @param tools [Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil]
+        #     Tools available to the agent.
+        #
+        #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+        # The service tier used for model requests.
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          # Selects the service tier automatically.
+          AUTO = :auto
+
+          # Uses the default service tier.
+          DEFAULT = :default
+
+          # Uses the flex service tier.
+          FLEX = :flex
+
+          # Uses the priority service tier.
+          PRIORITY = :priority
+
+          # Uses the fast service tier.
+          FAST = :fast
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentWaitForSubagentsCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the tool call item.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute recipient_agent_ids
+        #   The IDs of the agents to wait for.
+        #
+        #   @return [Array<String>]
+        required :recipient_agent_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+        # @!attribute sender_agent_id
+        #   The ID of the agent waiting for results.
+        #
+        #   @return [String]
+        required :sender_agent_id, String
+
+        # @!attribute status
+        #   The status of the tool call.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        required :status, enum: -> { OpenAI::Beta::AgentFunctionCallStatus }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `wait_for_subagents_call`.
+        #
+        #   @return [Symbol, :wait_for_subagents_call]
+        required :type, const: :wait_for_subagents_call
+
+        # @!method initialize(id:, recipient_agent_ids:, sender_agent_id:, status:, turn_id:, type: :wait_for_subagents_call)
+        #   A request to wait for one or more subagents.
+        #
+        #   @param id [String]
+        #     The ID of the tool call item.
+        #
+        #   @param recipient_agent_ids [Array<String>]
+        #     The IDs of the agents to wait for.
+        #
+        #   @param sender_agent_id [String]
+        #     The ID of the agent waiting for results.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentFunctionCallStatus]
+        #     The status of the tool call.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :wait_for_subagents_call]
+        #     The item type. Always `wait_for_subagents_call`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class AgentWebSearchCallItem < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the web search call.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute action
+        #   An action performed by the web search tool.
+        #
+        #   @return [OpenAI::Models::Beta::WebSearchAction::Search, OpenAI::Models::Beta::WebSearchAction::OpenPage, OpenAI::Models::Beta::WebSearchAction::FindInPage, OpenAI::Models::Beta::WebSearchAction::Other, nil]
+        required :action, union: -> { OpenAI::Beta::WebSearchAction }, nil?: true
+
+        # @!attribute status
+        #   The status of the web search call.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::AgentOutputItemStatus]
+        required :status, enum: -> { OpenAI::Beta::AgentOutputItemStatus }
+
+        # @!attribute turn_id
+        #   The ID of the turn that contains this item.
+        #
+        #   @return [String]
+        required :turn_id, String
+
+        # @!attribute type
+        #   The item type. Always `web_search_call`.
+        #
+        #   @return [Symbol, :web_search_call]
+        required :type, const: :web_search_call
+
+        # @!method initialize(id:, action:, status:, turn_id:, type: :web_search_call)
+        #   A web search call produced by the agent.
+        #
+        #   @param id [String]
+        #     The ID of the web search call.
+        #
+        #   @param action [OpenAI::Models::Beta::WebSearchAction::Search, OpenAI::Models::Beta::WebSearchAction::OpenPage, OpenAI::Models::Beta::WebSearchAction::FindInPage, OpenAI::Models::Beta::WebSearchAction::Other, nil]
+        #     An action performed by the web search tool.
+        #
+        #   @param status [Symbol, OpenAI::Models::Beta::AgentOutputItemStatus]
+        #     The status of the web search call.
+        #
+        #   @param turn_id [String]
+        #     The ID of the turn that contains this item.
+        #
+        #   @param type [Symbol, :web_search_call]
+        #     The item type. Always `web_search_call`.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/environment_info.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Environments#retrieve
+        class EnvironmentInfo < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The ID of the environment.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute files
+          #   Files installed in the environment, without their contents.
+          #
+          #   @return [Array<OpenAI::Models::Beta::HostedEnvironmentFileID, OpenAI::Models::Beta::HostedEnvironmentFile::Inline>]
+          required :files, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::HostedEnvironmentFile] }
+
+          # @!attribute object
+          #   The object type. Always `agent.environment`.
+          #
+          #   @return [Symbol, :"agent.environment"]
+          required :object, const: :"agent.environment"
+
+          # @!attribute plugins
+          #   Plugins installed in the environment, without their archive contents.
+          #
+          #   @return [Array<OpenAI::Models::Beta::HostedPlugin>]
+          required :plugins, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::HostedPlugin] }
+
+          # @!attribute skills
+          #   Skills installed in the environment, without their archive contents.
+          #
+          #   @return [Array<OpenAI::Models::Beta::HostedSkillReference, OpenAI::Models::Beta::HostedSkill::Inline>]
+          required :skills, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::HostedSkill] }
+
+          # @!attribute status
+          #   The current environment connection status.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::Agents::EnvironmentInfo::Status]
+          required :status, enum: -> { OpenAI::Beta::Agents::EnvironmentInfo::Status }
+
+          # @!attribute type
+          #   Whether the environment is hosted by OpenAI or by the application.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::Agents::EnvironmentInfo::Type]
+          required :type, enum: -> { OpenAI::Beta::Agents::EnvironmentInfo::Type }
+
+          # @!method initialize(id:, files:, plugins:, skills:, status:, type:, object: :"agent.environment")
+          #   Safe metadata for a first-class execution environment.
+          #
+          #   @param id [String]
+          #     The ID of the environment.
+          #
+          #   @param files [Array<OpenAI::Models::Beta::HostedEnvironmentFileID, OpenAI::Models::Beta::HostedEnvironmentFile::Inline>]
+          #     Files installed in the environment, without their contents.
+          #
+          #   @param plugins [Array<OpenAI::Models::Beta::HostedPlugin>]
+          #     Plugins installed in the environment, without their archive contents.
+          #
+          #   @param skills [Array<OpenAI::Models::Beta::HostedSkillReference, OpenAI::Models::Beta::HostedSkill::Inline>]
+          #     Skills installed in the environment, without their archive contents.
+          #
+          #   @param status [Symbol, OpenAI::Models::Beta::Agents::EnvironmentInfo::Status]
+          #     The current environment connection status.
+          #
+          #   @param type [Symbol, OpenAI::Models::Beta::Agents::EnvironmentInfo::Type]
+          #     Whether the environment is hosted by OpenAI or by the application.
+          #
+          #   @param object [Symbol, :"agent.environment"]
+          #     The object type. Always `agent.environment`.
+
+          # The current environment connection status.
+          #
+          # @see OpenAI::Models::Beta::Agents::EnvironmentInfo#status
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            PENDING = :pending
+            CONNECTED = :connected
+            DISCONNECTED = :disconnected
+            EXPIRED = :expired
+            FAILED = :failed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Whether the environment is hosted by OpenAI or by the application.
+          #
+          # @see OpenAI::Models::Beta::Agents::EnvironmentInfo#type
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            OPENAI_HOSTED = :openai_hosted
+            SELF_HOSTED = :self_hosted
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/environment_retrieve_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        # @see OpenAI::Resources::Beta::Agents::Environments#retrieve
+        class EnvironmentRetrieveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute environment_id
+          #
+          #   @return [String]
+          required :environment_id, String
+
+          # @!method initialize(environment_id:, request_options: {})
+          #   @param environment_id [String]
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/beta/agents/environments/environment_file.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        module Environments
+          # @see OpenAI::Resources::Beta::Agents::Environments::Files#create
+          class EnvironmentFile < OpenAI::Internal::Type::BaseModel
+            # @!attribute environment_id
+            #   The ID of the environment containing this file.
+            #
+            #   @return [String]
+            required :environment_id, String
+
+            # @!attribute object
+            #   The object type. Always `agent.environment.file`.
+            #
+            #   @return [Symbol, :"agent.environment.file"]
+            required :object, const: :"agent.environment.file"
+
+            # @!attribute path
+            #   The absolute file path inside the environment's workspace.
+            #
+            #   @return [String]
+            required :path, String
+
+            # @!attribute size_bytes
+            #   The file size in bytes.
+            #
+            #   @return [Integer]
+            required :size_bytes, Integer
+
+            # @!method initialize(environment_id:, path:, size_bytes:, object: :"agent.environment.file")
+            #   A live file in an execution environment.
+            #
+            #   @param environment_id [String]
+            #     The ID of the environment containing this file.
+            #
+            #   @param path [String]
+            #     The absolute file path inside the environment's workspace.
+            #
+            #   @param size_bytes [Integer]
+            #     The file size in bytes.
+            #
+            #   @param object [Symbol, :"agent.environment.file"]
+            #     The object type. Always `agent.environment.file`.
+          end
+        end
+
+        EnvironmentFile = Environments::EnvironmentFile
+      end
+    end
+  end
+end