openai 0.119.0 → 0.121.0

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

@@ -0,0 +1,255 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        class AutomationAgentConfig < OpenAI::Internal::Type::BaseModel
+
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::Agents::AutomationAgentConfig,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # Custom instructions, or null when absent.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :instructions
+
+          # The requested model name.
+          sig { returns(String) }
+          attr_accessor :model
+
+          # The configuration for creating and coordinating subagents.
+          sig { returns(OpenAI::Beta::MultiAgentConfig) }
+          attr_reader :multi_agent
+
+          sig { params(multi_agent: OpenAI::Beta::MultiAgentConfig::OrHash).void }
+          attr_writer :multi_agent
+
+          # The configured reasoning policy.
+          sig { returns(OpenAI::Beta::AgentReasoning) }
+          attr_reader :reasoning
+
+          sig { params(reasoning: OpenAI::Beta::AgentReasoning::OrHash).void }
+          attr_writer :reasoning
+
+          # The configured service-tier policy.
+          sig { returns(OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::TaggedSymbol) }
+          attr_accessor :service_tier
+
+          # The configured output format and verbosity.
+          sig { returns(OpenAI::Beta::AgentText) }
+          attr_reader :text
+
+          sig { params(text: OpenAI::Beta::AgentText::OrHash).void }
+          attr_writer :text
+
+          # Configured tools, excluding confidential credentials.
+          sig { returns(T::Array[OpenAI::Beta::AgentTool::Variants]) }
+          attr_accessor :tools
+
+          # The effective context compaction settings.
+          sig { returns(T.nilable(OpenAI::Beta::Agents::AutomationAgentConfig::Compaction)) }
+          attr_reader :compaction
+
+          sig { params(compaction: OpenAI::Beta::Agents::AutomationAgentConfig::Compaction::OrHash).void }
+          attr_writer :compaction
+
+          # The effective experimental settings for the agent.
+          sig { returns(T.nilable(OpenAI::Beta::Agents::AutomationAgentConfig::Experimental)) }
+          attr_reader :experimental
+
+          sig { params(experimental: OpenAI::Beta::Agents::AutomationAgentConfig::Experimental::OrHash).void }
+          attr_writer :experimental
+
+          # Inline agent configuration without a generated session-local identity.
+          sig do
+            params(
+
+              instructions: T.nilable(String),
+
+              model: String,
+
+              multi_agent: OpenAI::Beta::MultiAgentConfig::OrHash,
+
+              reasoning: OpenAI::Beta::AgentReasoning::OrHash,
+
+              service_tier: OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::OrSymbol,
+
+              text: OpenAI::Beta::AgentText::OrHash,
+
+              tools: T::Array[
+                T.any(
+                  OpenAI::Beta::AgentTool::Function::OrHash,
+                  OpenAI::Beta::AgentTool::ProgrammaticToolCalling::OrHash,
+                  OpenAI::Beta::AgentTool::Mcp::OrHash,
+                  OpenAI::Beta::AgentTool::WebSearch::OrHash,
+                  OpenAI::Beta::AgentTool::ComputerUse::OrHash,
+                  OpenAI::Beta::AgentTool::Automations::OrHash
+                )
+              ],
+
+              compaction: OpenAI::Beta::Agents::AutomationAgentConfig::Compaction::OrHash,
+
+              experimental: OpenAI::Beta::Agents::AutomationAgentConfig::Experimental::OrHash
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # Custom instructions, or null when absent.
+            instructions:,
+
+            # The requested model name.
+            model:,
+
+            # The configuration for creating and coordinating subagents.
+            multi_agent:,
+
+            # The configured reasoning policy.
+            reasoning:,
+
+            # The configured service-tier policy.
+            service_tier:,
+
+            # The configured output format and verbosity.
+            text:,
+
+            # Configured tools, excluding confidential credentials.
+            tools:,
+
+            # The effective context compaction settings.
+            compaction: nil,
+
+            # The effective experimental settings for the agent.
+
+            experimental: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                instructions: T.nilable(String),
+                model: String,
+                multi_agent: OpenAI::Beta::MultiAgentConfig,
+                reasoning: OpenAI::Beta::AgentReasoning,
+                service_tier: OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::TaggedSymbol,
+                text: OpenAI::Beta::AgentText,
+                tools: T::Array[OpenAI::Beta::AgentTool::Variants],
+                compaction: OpenAI::Beta::Agents::AutomationAgentConfig::Compaction,
+                experimental: OpenAI::Beta::Agents::AutomationAgentConfig::Experimental
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The configured service-tier policy.
+          module ServiceTier
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            AUTO = T.let(:auto, OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::TaggedSymbol)
+            DEFAULT = T.let(:default, OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::TaggedSymbol)
+            FLEX = T.let(:flex, OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::TaggedSymbol)
+            PRIORITY = T.let(:priority, OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::TaggedSymbol)
+            FAST = T.let(:fast, OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::TaggedSymbol)
+            ULTRAFAST = T.let(:ultrafast, OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::TaggedSymbol)
+
+            sig { override.returns(T::Array[OpenAI::Beta::Agents::AutomationAgentConfig::ServiceTier::TaggedSymbol]) }
+            def self.values
+            end
+          end
+
+          class Compaction < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::AutomationAgentConfig::Compaction,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # Whether context is compacted in the background. Defaults to true.
+            sig { returns(T::Boolean) }
+            attr_accessor :async
+
+            # The effective context compaction settings.
+            sig do
+              params(
+
+                async: T::Boolean
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # Whether context is compacted in the background. Defaults to true.
+
+              async:
+            )
+            end
+
+            sig do
+              override.returns(
+                {async: T::Boolean}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+          class Experimental < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::AutomationAgentConfig::Experimental,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # Whether the model receives periodic current-time reminders.
+            sig { returns(T::Boolean) }
+            attr_accessor :time_awareness
+
+            # The effective experimental settings for the agent.
+            sig do
+              params(
+
+                time_awareness: T::Boolean
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # Whether the model receives periodic current-time reminders.
+
+              time_awareness:
+            )
+            end
+
+            sig do
+              override.returns(
+                {time_awareness: T::Boolean}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,75 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        class AutomationCreateParams < 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::AutomationCreateParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # Creates an automation without invoking it immediately.
+          sig {
+            returns(
+              T.any(
+                OpenAI::Beta::Agents::AutomationScheduleParam::Periodic,
+                OpenAI::Beta::Agents::AutomationScheduleParam::Once
+              )
+            )
+          }
+          attr_accessor :create_automation_params
+
+          sig do
+            params(
+
+              create_automation_params: T.any(
+                OpenAI::Beta::Agents::AutomationScheduleParam::Periodic::OrHash,
+                OpenAI::Beta::Agents::AutomationScheduleParam::Once::OrHash
+              ),
+
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # Creates an automation without invoking it immediately.
+            create_automation_params:,
+
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                create_automation_params: T.any(
+                  OpenAI::Beta::Agents::AutomationScheduleParam::Periodic,
+                  OpenAI::Beta::Agents::AutomationScheduleParam::Once
+                ),
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,124 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        # How the automation was created, independently of how an invocation started.
+        module AutomationCreatedBy
+          extend OpenAI::Internal::Type::Union
+
+          Variants = T.type_alias do
+            T.any(
+              OpenAI::Beta::Agents::AutomationCreatedBy::Developer,
+              OpenAI::Beta::Agents::AutomationCreatedBy::Agent
+            )
+          end
+
+          class Developer < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::AutomationCreatedBy::Developer,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The type of the object. Always `developer`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The type of the object. Always `developer`.
+
+              type: :developer
+            )
+            end
+
+            sig do
+              override.returns(
+                {type: Symbol}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+          class Agent < OpenAI::Internal::Type::BaseModel
+            OrHash = T.type_alias do
+              T.any(
+                OpenAI::Beta::Agents::AutomationCreatedBy::Agent,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+            # The creator session, which is also the automation's target.
+            sig { returns(String) }
+            attr_accessor :session_id
+
+            # The tool call that created the automation.
+            sig { returns(String) }
+            attr_accessor :tool_call_id
+
+            # The type of the object. Always `agent`.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(
+
+                session_id: String,
+
+                tool_call_id: String,
+
+                type: Symbol
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+
+              # The creator session, which is also the automation's target.
+              session_id:,
+
+              # The tool call that created the automation.
+              tool_call_id:,
+
+              # The type of the object. Always `agent`.
+
+              type: :agent
+            )
+            end
+
+            sig do
+              override.returns(
+                {session_id: String, tool_call_id: String, type: Symbol}
+              )
+            end
+            def to_hash
+            end
+
+          end
+
+          sig { override.returns(T::Array[OpenAI::Beta::Agents::AutomationCreatedBy::Variants]) }
+          def self.variants
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,57 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        class AutomationDeleteParams < 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::AutomationDeleteParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          sig { returns(String) }
+          attr_accessor :automation_id
+
+          sig do
+            params(
+
+              automation_id: String,
+
+              request_options: OpenAI::RequestOptions::OrHash
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            automation_id:,
+
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {automation_id: String, request_options: OpenAI::RequestOptions}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,71 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      module Agents
+
+        class AutomationDeleted < OpenAI::Internal::Type::BaseModel
+
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::Agents::AutomationDeleted,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The deleted automation ID.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Always true.
+          sig { returns(T::Boolean) }
+          attr_accessor :deleted
+
+          # Always `agent.automation.deleted`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          sig do
+            params(
+
+              id: String,
+
+              deleted: T::Boolean,
+
+              object: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The deleted automation ID.
+            id:,
+
+            # Always true.
+            deleted:,
+
+            # Always `agent.automation.deleted`.
+
+            object: :"agent.automation.deleted"
+          )
+          end
+
+          sig do
+            override.returns(
+              {id: String, deleted: T::Boolean, object: Symbol}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+end