openai 0.89.0 → 0.90.0

data/sig/openai/models/beta/agent_tool_param.rbs

@@ -0,0 +1,251 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_tool_param =
+        OpenAI::Beta::AgentToolParam::Function
+        | OpenAI::Beta::AgentToolParam::ToolSearch
+        | OpenAI::Beta::AgentToolParam::ProgrammaticToolCalling
+        | OpenAI::Beta::AgentToolParam::Mcp
+        | OpenAI::Beta::AgentToolParam::WebSearch
+
+      module AgentToolParam
+        extend OpenAI::Internal::Type::Union
+
+        type function =
+          {
+            description: String,
+            name: String,
+            parameters: ::Hash[Symbol, top],
+            ?type: :function,
+            ?defer_loading: bool
+          }
+
+        class Function < OpenAI::Internal::Type::BaseModel
+          attr_accessor description: String
+
+          attr_accessor name: String
+
+          attr_accessor parameters: ::Hash[Symbol, top]
+
+          attr_accessor type: :function
+
+          attr_reader defer_loading: bool?
+
+          def defer_loading=: (bool) -> bool
+
+          def initialize: (
+            description: String,
+            name: String,
+            parameters: ::Hash[Symbol, top],
+            ?defer_loading: bool,
+            ?type: :function
+          ) -> void
+
+          def to_hash: -> {
+            description: String,
+            name: String,
+            parameters: ::Hash[Symbol, top],
+            ?type: :function,
+            ?defer_loading: bool
+          }
+        end
+
+        type tool_search = { ?type: :tool_search }
+
+        class ToolSearch < OpenAI::Internal::Type::BaseModel
+          attr_accessor type: :tool_search
+
+          def initialize: (?type: :tool_search) -> void
+
+          def to_hash: -> { ?type: :tool_search }
+        end
+
+        type programmatic_tool_calling =
+          { ?type: :programmatic_tool_calling, ?enabled: bool }
+
+        class ProgrammaticToolCalling < OpenAI::Internal::Type::BaseModel
+          attr_accessor type: :programmatic_tool_calling
+
+          attr_reader enabled: bool?
+
+          def enabled=: (bool) -> bool
+
+          def initialize: (
+            ?enabled: bool,
+            ?type: :programmatic_tool_calling
+          ) -> void
+
+          def to_hash: -> { ?type: :programmatic_tool_calling, ?enabled: bool }
+        end
+
+        type mcp =
+          {
+            server_label: String,
+            transport: OpenAI::Models::Beta::mcp_transport_param,
+            ?type: :mcp,
+            ?allowed_tools: ::Array[String]?,
+            ?connection_origin: OpenAI::Models::Beta::AgentToolParam::Mcp::connection_origin?,
+            ?credential_id: String?,
+            ?request_metadata: ::Hash[Symbol, top]?,
+            ?required: bool
+          }
+
+        class Mcp < OpenAI::Internal::Type::BaseModel
+          attr_accessor server_label: String
+
+          attr_accessor transport: OpenAI::Models::Beta::mcp_transport_param
+
+          attr_accessor type: :mcp
+
+          attr_accessor allowed_tools: ::Array[String]?
+
+          attr_accessor connection_origin: OpenAI::Models::Beta::AgentToolParam::Mcp::connection_origin?
+
+          attr_accessor credential_id: String?
+
+          attr_accessor request_metadata: ::Hash[Symbol, top]?
+
+          attr_reader required: bool?
+
+          def required=: (bool) -> bool
+
+          def initialize: (
+            server_label: String,
+            transport: OpenAI::Models::Beta::mcp_transport_param,
+            ?allowed_tools: ::Array[String]?,
+            ?connection_origin: OpenAI::Models::Beta::AgentToolParam::Mcp::connection_origin?,
+            ?credential_id: String?,
+            ?request_metadata: ::Hash[Symbol, top]?,
+            ?required: bool,
+            ?type: :mcp
+          ) -> void
+
+          def to_hash: -> {
+            server_label: String,
+            transport: OpenAI::Models::Beta::mcp_transport_param,
+            ?type: :mcp,
+            ?allowed_tools: ::Array[String]?,
+            ?connection_origin: OpenAI::Models::Beta::AgentToolParam::Mcp::connection_origin?,
+            ?credential_id: String?,
+            ?request_metadata: ::Hash[Symbol, top]?,
+            ?required: bool
+          }
+
+          type connection_origin = :service | :environment
+
+          module ConnectionOrigin
+            extend OpenAI::Internal::Type::Enum
+
+            # Uses the Managed Agents service network.
+            SERVICE: :service
+
+            # Uses the session's execution environment.
+            ENVIRONMENT: :environment
+
+            def self?.values: -> ::Array[OpenAI::Models::Beta::AgentToolParam::Mcp::connection_origin]
+          end
+        end
+
+        type web_search =
+          {
+            ?type: :web_search,
+            ?allowed_domains: ::Array[String]?,
+            ?context_size: OpenAI::Models::Beta::AgentToolParam::WebSearch::context_size?,
+            ?location: OpenAI::Beta::AgentToolParam::WebSearch::Location?,
+            ?mode: OpenAI::Models::Beta::AgentToolParam::WebSearch::mode?
+          }
+
+        class WebSearch < OpenAI::Internal::Type::BaseModel
+          attr_accessor type: :web_search
+
+          attr_accessor allowed_domains: ::Array[String]?
+
+          attr_accessor context_size: OpenAI::Models::Beta::AgentToolParam::WebSearch::context_size?
+
+          attr_accessor location: OpenAI::Beta::AgentToolParam::WebSearch::Location?
+
+          attr_accessor mode: OpenAI::Models::Beta::AgentToolParam::WebSearch::mode?
+
+          def initialize: (
+            ?allowed_domains: ::Array[String]?,
+            ?context_size: OpenAI::Models::Beta::AgentToolParam::WebSearch::context_size?,
+            ?location: OpenAI::Beta::AgentToolParam::WebSearch::Location?,
+            ?mode: OpenAI::Models::Beta::AgentToolParam::WebSearch::mode?,
+            ?type: :web_search
+          ) -> void
+
+          def to_hash: -> {
+            ?type: :web_search,
+            ?allowed_domains: ::Array[String]?,
+            ?context_size: OpenAI::Models::Beta::AgentToolParam::WebSearch::context_size?,
+            ?location: OpenAI::Beta::AgentToolParam::WebSearch::Location?,
+            ?mode: OpenAI::Models::Beta::AgentToolParam::WebSearch::mode?
+          }
+
+          type context_size = :low | :medium | :high
+
+          module ContextSize
+            extend OpenAI::Internal::Type::Enum
+
+            LOW: :low
+            MEDIUM: :medium
+            HIGH: :high
+
+            def self?.values: -> ::Array[OpenAI::Models::Beta::AgentToolParam::WebSearch::context_size]
+          end
+
+          type location =
+            {
+              ?city: String?,
+              ?country: String?,
+              ?region: String?,
+              ?timezone: String?
+            }
+
+          class Location < OpenAI::Internal::Type::BaseModel
+            attr_accessor city: String?
+
+            attr_accessor country: String?
+
+            attr_accessor region: String?
+
+            attr_accessor timezone: String?
+
+            def initialize: (
+              ?city: String?,
+              ?country: String?,
+              ?region: String?,
+              ?timezone: String?
+            ) -> void
+
+            def to_hash: -> {
+              ?city: String?,
+              ?country: String?,
+              ?region: String?,
+              ?timezone: String?
+            }
+          end
+
+          type mode = :disabled | :cached | :live
+
+          module Mode
+            extend OpenAI::Internal::Type::Enum
+
+            # Disables web search.
+            DISABLED: :disabled
+
+            # Uses cached search results.
+            CACHED: :cached
+
+            # Searches the live web.
+            LIVE: :live
+
+            def self?.values: -> ::Array[OpenAI::Models::Beta::AgentToolParam::WebSearch::mode]
+          end
+        end
+
+        def self?.variants: -> ::Array[OpenAI::Models::Beta::agent_tool_param]
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agent_update_params.rbs

@@ -0,0 +1,98 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_update_params =
+        {
+          agent_id: String,
+          ?instructions: String?,
+          ?metadata: ::Hash[Symbol, String]?,
+          ?model: String,
+          ?multi_agent: OpenAI::Beta::MultiAgentConfigParam?,
+          ?name: String?,
+          ?reasoning: OpenAI::Beta::AgentReasoningParam?,
+          ?service_tier: OpenAI::Models::Beta::AgentUpdateParams::service_tier?,
+          ?text: OpenAI::Beta::AgentTextParam?,
+          ?tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]?,
+          ?request_options: OpenAI::request_opts
+        }
+
+      class AgentUpdateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor agent_id: String
+
+        attr_accessor instructions: String?
+
+        attr_accessor metadata: ::Hash[Symbol, String]?
+
+        attr_reader model: String?
+
+        def model=: (String) -> String
+
+        attr_accessor multi_agent: OpenAI::Beta::MultiAgentConfigParam?
+
+        attr_accessor name: String?
+
+        attr_accessor reasoning: OpenAI::Beta::AgentReasoningParam?
+
+        attr_accessor service_tier: OpenAI::Models::Beta::AgentUpdateParams::service_tier?
+
+        attr_accessor text: OpenAI::Beta::AgentTextParam?
+
+        attr_accessor tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]?
+
+        def initialize: (
+          agent_id: String,
+          ?instructions: String?,
+          ?metadata: ::Hash[Symbol, String]?,
+          ?model: String,
+          ?multi_agent: OpenAI::Beta::MultiAgentConfigParam?,
+          ?name: String?,
+          ?reasoning: OpenAI::Beta::AgentReasoningParam?,
+          ?service_tier: OpenAI::Models::Beta::AgentUpdateParams::service_tier?,
+          ?text: OpenAI::Beta::AgentTextParam?,
+          ?tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]?,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          agent_id: String,
+          ?instructions: String?,
+          ?metadata: ::Hash[Symbol, String]?,
+          ?model: String,
+          ?multi_agent: OpenAI::Beta::MultiAgentConfigParam?,
+          ?name: String?,
+          ?reasoning: OpenAI::Beta::AgentReasoningParam?,
+          ?service_tier: OpenAI::Models::Beta::AgentUpdateParams::service_tier?,
+          ?text: OpenAI::Beta::AgentTextParam?,
+          ?tools: ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]?,
+          ?request_options: OpenAI::RequestOptions
+        }
+
+        type service_tier = :auto | :default | :flex | :priority | :fast
+
+        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
+
+          def self?.values: -> ::Array[OpenAI::Models::Beta::AgentUpdateParams::service_tier]
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agent_wait_for_subagents_call_item.rbs

@@ -0,0 +1,47 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_wait_for_subagents_call_item =
+        {
+          id: String,
+          recipient_agent_ids: ::Array[String],
+          sender_agent_id: String,
+          status: OpenAI::Models::Beta::agent_function_call_status,
+          turn_id: String,
+          ?type: :wait_for_subagents_call
+        }
+
+      class AgentWaitForSubagentsCallItem < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor recipient_agent_ids: ::Array[String]
+
+        attr_accessor sender_agent_id: String
+
+        attr_accessor status: OpenAI::Models::Beta::agent_function_call_status
+
+        attr_accessor turn_id: String
+
+        attr_accessor type: :wait_for_subagents_call
+
+        def initialize: (
+          id: String,
+          recipient_agent_ids: ::Array[String],
+          sender_agent_id: String,
+          status: OpenAI::Models::Beta::agent_function_call_status,
+          turn_id: String,
+          ?type: :wait_for_subagents_call
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          recipient_agent_ids: ::Array[String],
+          sender_agent_id: String,
+          status: OpenAI::Models::Beta::agent_function_call_status,
+          turn_id: String,
+          ?type: :wait_for_subagents_call
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agent_web_search_call_item.rbs

@@ -0,0 +1,42 @@
+module OpenAI
+  module Models
+    module Beta
+      type agent_web_search_call_item =
+        {
+          id: String,
+          action: OpenAI::Models::Beta::web_search_action?,
+          status: OpenAI::Models::Beta::agent_output_item_status,
+          turn_id: String,
+          ?type: :web_search_call
+        }
+
+      class AgentWebSearchCallItem < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor action: OpenAI::Models::Beta::web_search_action?
+
+        attr_accessor status: OpenAI::Models::Beta::agent_output_item_status
+
+        attr_accessor turn_id: String
+
+        attr_accessor type: :web_search_call
+
+        def initialize: (
+          id: String,
+          action: OpenAI::Models::Beta::web_search_action?,
+          status: OpenAI::Models::Beta::agent_output_item_status,
+          turn_id: String,
+          ?type: :web_search_call
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          action: OpenAI::Models::Beta::web_search_action?,
+          status: OpenAI::Models::Beta::agent_output_item_status,
+          turn_id: String,
+          ?type: :web_search_call
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agents/environment_info.rbs

@@ -0,0 +1,80 @@
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        type environment_info =
+          {
+            id: String,
+            files: ::Array[OpenAI::Models::Beta::hosted_environment_file],
+            ?object: :"agent.environment",
+            plugins: ::Array[OpenAI::Beta::HostedPlugin],
+            skills: ::Array[OpenAI::Models::Beta::hosted_skill],
+            status: OpenAI::Models::Beta::Agents::EnvironmentInfo::status,
+            type: OpenAI::Models::Beta::Agents::EnvironmentInfo::type_
+          }
+
+        class EnvironmentInfo < OpenAI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor files: ::Array[OpenAI::Models::Beta::hosted_environment_file]
+
+          attr_accessor object: :"agent.environment"
+
+          attr_accessor plugins: ::Array[OpenAI::Beta::HostedPlugin]
+
+          attr_accessor skills: ::Array[OpenAI::Models::Beta::hosted_skill]
+
+          attr_accessor status: OpenAI::Models::Beta::Agents::EnvironmentInfo::status
+
+          attr_accessor type: OpenAI::Models::Beta::Agents::EnvironmentInfo::type_
+
+          def initialize: (
+            id: String,
+            files: ::Array[OpenAI::Models::Beta::hosted_environment_file],
+            plugins: ::Array[OpenAI::Beta::HostedPlugin],
+            skills: ::Array[OpenAI::Models::Beta::hosted_skill],
+            status: OpenAI::Models::Beta::Agents::EnvironmentInfo::status,
+            type: OpenAI::Models::Beta::Agents::EnvironmentInfo::type_,
+            ?object: :"agent.environment"
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            files: ::Array[OpenAI::Models::Beta::hosted_environment_file],
+            ?object: :"agent.environment",
+            plugins: ::Array[OpenAI::Beta::HostedPlugin],
+            skills: ::Array[OpenAI::Models::Beta::hosted_skill],
+            status: OpenAI::Models::Beta::Agents::EnvironmentInfo::status,
+            type: OpenAI::Models::Beta::Agents::EnvironmentInfo::type_
+          }
+
+          type status =
+            :pending | :connected | :disconnected | :expired | :failed
+
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            PENDING: :pending
+            CONNECTED: :connected
+            DISCONNECTED: :disconnected
+            EXPIRED: :expired
+            FAILED: :failed
+
+            def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::EnvironmentInfo::status]
+          end
+
+          type type_ = :openai_hosted | :self_hosted
+
+          module Type
+            extend OpenAI::Internal::Type::Enum
+
+            OPENAI_HOSTED: :openai_hosted
+            SELF_HOSTED: :self_hosted
+
+            def self?.values: -> ::Array[OpenAI::Models::Beta::Agents::EnvironmentInfo::type_]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agents/environment_retrieve_params.rbs

@@ -0,0 +1,27 @@
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        type environment_retrieve_params =
+          { environment_id: String, ?request_options: OpenAI::request_opts }
+
+        class EnvironmentRetrieveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor environment_id: String
+
+          def initialize: (
+            environment_id: String,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            environment_id: String,
+            ?request_options: OpenAI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

data/sig/openai/models/beta/agents/environments/environment_file.rbs

@@ -0,0 +1,43 @@
+module OpenAI
+  module Models
+    module Beta
+      module Agents
+        class EnvironmentFile = Environments::EnvironmentFile
+
+        module Environments
+          type environment_file =
+            {
+              environment_id: String,
+              ?object: :"agent.environment.file",
+              path: String,
+              size_bytes: Integer
+            }
+
+          class EnvironmentFile < OpenAI::Internal::Type::BaseModel
+            attr_accessor environment_id: String
+
+            attr_accessor object: :"agent.environment.file"
+
+            attr_accessor path: String
+
+            attr_accessor size_bytes: Integer
+
+            def initialize: (
+              environment_id: String,
+              path: String,
+              size_bytes: Integer,
+              ?object: :"agent.environment.file"
+            ) -> void
+
+            def to_hash: -> {
+              environment_id: String,
+              ?object: :"agent.environment.file",
+              path: String,
+              size_bytes: Integer
+            }
+          end
+        end
+      end
+    end
+  end
+end