openai 0.89.0 → 0.90.0

data/rbi/openai/models/beta/agent_update_params.rbi

@@ -0,0 +1,225 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentUpdateParams < OpenAI::Internal::Type::BaseModel
+
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentUpdateParams,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        sig { returns(String) }
+        attr_accessor :agent_id
+
+        # Additional instructions appended to the agent's default base instructions. Omit
+        # to leave unchanged.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :instructions
+
+        # 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.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_accessor :metadata
+
+        # The model to use for the agent. The requested model name is preserved.
+        sig { returns(T.nilable(String)) }
+        attr_reader :model
+
+        sig { params(model: String).void }
+        attr_writer :model
+
+        # Explicit configuration for creating and coordinating subagents.
+        sig { returns(T.nilable(OpenAI::Beta::MultiAgentConfigParam)) }
+        attr_reader :multi_agent
+
+        sig { params(multi_agent: T.nilable(OpenAI::Beta::MultiAgentConfigParam::OrHash)).void }
+        attr_writer :multi_agent
+
+        # A replacement name. Omit to leave unchanged, or pass null to clear it.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # Reasoning configuration for the agent.
+        sig { returns(T.nilable(OpenAI::Beta::AgentReasoningParam)) }
+        attr_reader :reasoning
+
+        sig { params(reasoning: T.nilable(OpenAI::Beta::AgentReasoningParam::OrHash)).void }
+        attr_writer :reasoning
+
+        # The service tier used for model requests.
+        sig { returns(T.nilable(OpenAI::Beta::AgentUpdateParams::ServiceTier::OrSymbol)) }
+        attr_accessor :service_tier
+
+        # Configuration for text generated by the agent.
+        sig { returns(T.nilable(OpenAI::Beta::AgentTextParam)) }
+        attr_reader :text
+
+        sig { params(text: T.nilable(OpenAI::Beta::AgentTextParam::OrHash)).void }
+        attr_writer :text
+
+        # Tools available to the agent.
+        sig {
+          returns(
+            T.nilable(
+              T::Array[
+                T.any(
+                  OpenAI::Beta::PersistedAgentToolParam::Function,
+                  OpenAI::Beta::PersistedAgentToolParam::ToolSearch,
+                  OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling,
+                  OpenAI::Beta::PersistedAgentToolParam::Mcp,
+                  OpenAI::Beta::PersistedAgentToolParam::WebSearch
+                )
+              ]
+            )
+          )
+        }
+        attr_accessor :tools
+
+        sig do
+          params(
+
+            agent_id: String,
+
+            instructions: T.nilable(String),
+
+            metadata: T.nilable(T::Hash[Symbol, String]),
+
+            model: String,
+
+            multi_agent: T.nilable(OpenAI::Beta::MultiAgentConfigParam::OrHash),
+
+            name: T.nilable(String),
+
+            reasoning: T.nilable(OpenAI::Beta::AgentReasoningParam::OrHash),
+
+            service_tier: T.nilable(OpenAI::Beta::AgentUpdateParams::ServiceTier::OrSymbol),
+
+            text: T.nilable(OpenAI::Beta::AgentTextParam::OrHash),
+
+            tools: T.nilable(
+              T::Array[
+                T.any(
+                  OpenAI::Beta::PersistedAgentToolParam::Function::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::ToolSearch::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::Mcp::OrHash,
+                  OpenAI::Beta::PersistedAgentToolParam::WebSearch::OrHash
+                )
+              ]
+            ),
+
+            request_options: OpenAI::RequestOptions::OrHash
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          agent_id:,
+
+          # Additional instructions appended to the agent's default base instructions. Omit
+          # to leave unchanged.
+          instructions: 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.
+          metadata: nil,
+
+          # The model to use for the agent. The requested model name is preserved.
+          model: nil,
+
+          # Explicit configuration for creating and coordinating subagents.
+          multi_agent: nil,
+
+          # A replacement name. Omit to leave unchanged, or pass null to clear it.
+          name: nil,
+
+          # Reasoning configuration for the agent.
+          reasoning: nil,
+
+          # The service tier used for model requests.
+          service_tier: nil,
+
+          # Configuration for text generated by the agent.
+          text: nil,
+
+          # Tools available to the agent.
+          tools: nil,
+
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              agent_id: String,
+              instructions: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              model: String,
+              multi_agent: T.nilable(OpenAI::Beta::MultiAgentConfigParam),
+              name: T.nilable(String),
+              reasoning: T.nilable(OpenAI::Beta::AgentReasoningParam),
+              service_tier: T.nilable(OpenAI::Beta::AgentUpdateParams::ServiceTier::OrSymbol),
+              text: T.nilable(OpenAI::Beta::AgentTextParam),
+              tools: T.nilable(
+                T::Array[
+                  T.any(
+                    OpenAI::Beta::PersistedAgentToolParam::Function,
+                    OpenAI::Beta::PersistedAgentToolParam::ToolSearch,
+                    OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling,
+                    OpenAI::Beta::PersistedAgentToolParam::Mcp,
+                    OpenAI::Beta::PersistedAgentToolParam::WebSearch
+                  )
+                ]
+              ),
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The service tier used for model requests.
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::AgentUpdateParams::ServiceTier) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # Selects the service tier automatically.
+          AUTO = T.let(:auto, OpenAI::Beta::AgentUpdateParams::ServiceTier::TaggedSymbol)
+
+          # Uses the default service tier.
+          DEFAULT = T.let(:default, OpenAI::Beta::AgentUpdateParams::ServiceTier::TaggedSymbol)
+
+          # Uses the flex service tier.
+          FLEX = T.let(:flex, OpenAI::Beta::AgentUpdateParams::ServiceTier::TaggedSymbol)
+
+          # Uses the priority service tier.
+          PRIORITY = T.let(:priority, OpenAI::Beta::AgentUpdateParams::ServiceTier::TaggedSymbol)
+
+          # Uses the fast service tier.
+          FAST = T.let(:fast, OpenAI::Beta::AgentUpdateParams::ServiceTier::TaggedSymbol)
+
+          sig { override.returns(T::Array[OpenAI::Beta::AgentUpdateParams::ServiceTier::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_wait_for_subagents_call_item.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentWaitForSubagentsCallItem < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentWaitForSubagentsCallItem,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The ID of the tool call item.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The IDs of the agents to wait for.
+        sig { returns(T::Array[String]) }
+        attr_accessor :recipient_agent_ids
+
+        # The ID of the agent waiting for results.
+        sig { returns(String) }
+        attr_accessor :sender_agent_id
+
+        # The status of the tool call.
+        sig { returns(OpenAI::Beta::AgentFunctionCallStatus::TaggedSymbol) }
+        attr_accessor :status
+
+        # The ID of the turn that contains this item.
+        sig { returns(String) }
+        attr_accessor :turn_id
+
+        # The item type. Always `wait_for_subagents_call`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A request to wait for one or more subagents.
+        sig do
+          params(
+
+            id: String,
+
+            recipient_agent_ids: T::Array[String],
+
+            sender_agent_id: String,
+
+            status: OpenAI::Beta::AgentFunctionCallStatus::OrSymbol,
+
+            turn_id: String,
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The ID of the tool call item.
+          id:,
+
+          # The IDs of the agents to wait for.
+          recipient_agent_ids:,
+
+          # The ID of the agent waiting for results.
+          sender_agent_id:,
+
+          # The status of the tool call.
+          status:,
+
+          # The ID of the turn that contains this item.
+          turn_id:,
+
+          # The item type. Always `wait_for_subagents_call`.
+
+          type: :wait_for_subagents_call
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              recipient_agent_ids: T::Array[String],
+              sender_agent_id: String,
+              status: OpenAI::Beta::AgentFunctionCallStatus::TaggedSymbol,
+              turn_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_web_search_call_item.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentWebSearchCallItem < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentWebSearchCallItem,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The ID of the web search call.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # An action performed by the web search tool.
+        sig { returns(T.nilable(OpenAI::Beta::WebSearchAction::Variants)) }
+        attr_accessor :action
+
+        # The status of the web search call.
+        sig { returns(OpenAI::Beta::AgentOutputItemStatus::TaggedSymbol) }
+        attr_accessor :status
+
+        # The ID of the turn that contains this item.
+        sig { returns(String) }
+        attr_accessor :turn_id
+
+        # The item type. Always `web_search_call`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A web search call produced by the agent.
+        sig do
+          params(
+
+            id: String,
+
+            action: T.nilable(
+              T.any(
+                OpenAI::Beta::WebSearchAction::Search::OrHash,
+                OpenAI::Beta::WebSearchAction::OpenPage::OrHash,
+                OpenAI::Beta::WebSearchAction::FindInPage::OrHash,
+                OpenAI::Beta::WebSearchAction::Other::OrHash
+              )
+            ),
+
+            status: OpenAI::Beta::AgentOutputItemStatus::OrSymbol,
+
+            turn_id: String,
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The ID of the web search call.
+          id:,
+
+          # An action performed by the web search tool.
+          action:,
+
+          # The status of the web search call.
+          status:,
+
+          # The ID of the turn that contains this item.
+          turn_id:,
+
+          # The item type. Always `web_search_call`.
+
+          type: :web_search_call
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              action: T.nilable(OpenAI::Beta::WebSearchAction::Variants),
+              status: OpenAI::Beta::AgentOutputItemStatus::TaggedSymbol,
+              turn_id: String,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agents/environment_info.rbi

@@ -0,0 +1,156 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        class EnvironmentInfo < OpenAI::Internal::Type::BaseModel
+
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::Agents::EnvironmentInfo,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The ID of the environment.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Files installed in the environment, without their contents.
+          sig { returns(T::Array[OpenAI::Beta::HostedEnvironmentFile::Variants]) }
+          attr_accessor :files
+
+          # The object type. Always `agent.environment`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # Plugins installed in the environment, without their archive contents.
+          sig { returns(T::Array[OpenAI::Beta::HostedPlugin]) }
+          attr_accessor :plugins
+
+          # Skills installed in the environment, without their archive contents.
+          sig { returns(T::Array[OpenAI::Beta::HostedSkill::Variants]) }
+          attr_accessor :skills
+
+          # The current environment connection status.
+          sig { returns(OpenAI::Beta::Agents::EnvironmentInfo::Status::TaggedSymbol) }
+          attr_accessor :status
+
+          # Whether the environment is hosted by OpenAI or by the application.
+          sig { returns(OpenAI::Beta::Agents::EnvironmentInfo::Type::TaggedSymbol) }
+          attr_accessor :type
+
+          # Safe metadata for a first-class execution environment.
+          sig do
+            params(
+
+              id: String,
+
+              files: T::Array[
+                T.any(
+                  OpenAI::Beta::HostedEnvironmentFileID::OrHash,
+                  OpenAI::Beta::HostedEnvironmentFile::Inline::OrHash
+                )
+              ],
+
+              plugins: T::Array[OpenAI::Beta::HostedPlugin::OrHash],
+
+              skills: T::Array[
+                T.any(OpenAI::Beta::HostedSkillReference::OrHash, OpenAI::Beta::HostedSkill::Inline::OrHash)
+              ],
+
+              status: OpenAI::Beta::Agents::EnvironmentInfo::Status::OrSymbol,
+
+              type: OpenAI::Beta::Agents::EnvironmentInfo::Type::OrSymbol,
+
+              object: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The ID of the environment.
+            id:,
+
+            # Files installed in the environment, without their contents.
+            files:,
+
+            # Plugins installed in the environment, without their archive contents.
+            plugins:,
+
+            # Skills installed in the environment, without their archive contents.
+            skills:,
+
+            # The current environment connection status.
+            status:,
+
+            # Whether the environment is hosted by OpenAI or by the application.
+            type:,
+
+            # The object type. Always `agent.environment`.
+
+            object: :"agent.environment"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                files: T::Array[OpenAI::Beta::HostedEnvironmentFile::Variants],
+                object: Symbol,
+                plugins: T::Array[OpenAI::Beta::HostedPlugin],
+                skills: T::Array[OpenAI::Beta::HostedSkill::Variants],
+                status: OpenAI::Beta::Agents::EnvironmentInfo::Status::TaggedSymbol,
+                type: OpenAI::Beta::Agents::EnvironmentInfo::Type::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The current environment connection status.
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Agents::EnvironmentInfo::Status) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PENDING = T.let(:pending, OpenAI::Beta::Agents::EnvironmentInfo::Status::TaggedSymbol)
+            CONNECTED = T.let(:connected, OpenAI::Beta::Agents::EnvironmentInfo::Status::TaggedSymbol)
+            DISCONNECTED = T.let(:disconnected, OpenAI::Beta::Agents::EnvironmentInfo::Status::TaggedSymbol)
+            EXPIRED = T.let(:expired, OpenAI::Beta::Agents::EnvironmentInfo::Status::TaggedSymbol)
+            FAILED = T.let(:failed, OpenAI::Beta::Agents::EnvironmentInfo::Status::TaggedSymbol)
+
+            sig { override.returns(T::Array[OpenAI::Beta::Agents::EnvironmentInfo::Status::TaggedSymbol]) }
+            def self.values
+            end
+          end
+
+          # Whether the environment is hosted by OpenAI or by the application.
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Agents::EnvironmentInfo::Type) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            OPENAI_HOSTED = T.let(:openai_hosted, OpenAI::Beta::Agents::EnvironmentInfo::Type::TaggedSymbol)
+            SELF_HOSTED = T.let(:self_hosted, OpenAI::Beta::Agents::EnvironmentInfo::Type::TaggedSymbol)
+
+            sig { override.returns(T::Array[OpenAI::Beta::Agents::EnvironmentInfo::Type::TaggedSymbol]) }
+            def self.values
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agents/environment_retrieve_params.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        class EnvironmentRetrieveParams < OpenAI::Internal::Type::BaseModel
+
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::Agents::EnvironmentRetrieveParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig { returns(String) }
+          attr_accessor :environment_id
+
+          sig do
+            params(
+
+              environment_id: String,
+
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            environment_id:,
+
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {environment_id: String, request_options: OpenAI::RequestOptions}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end