openai 0.89.0 → 0.90.0

data/rbi/openai/helpers/agents.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module OpenAI
+  module Helpers
+    module Agents
+      ToolOutput = T.type_alias {
+        T.nilable(
+          T.any(
+            String,
+            OpenAI::Internal::AnyHash,
+            T::Array[T.any(OpenAI::Models::Beta::InputContentParam::Variants, OpenAI::Internal::AnyHash)]
+          )
+        )
+      }
+      ToolHandler = T.type_alias { T.proc.params(arguments: T::Hash[String, T.untyped]).returns(ToolOutput) }
+
+      class SessionStream
+        include Enumerable
+        Elem = type_member { {fixed: OpenAI::Models::Beta::AgentSessionEvent::Variants} }
+
+        sig {
+          params(block: T.nilable(T.proc.params(event: OpenAI::Models::Beta::AgentSessionEvent::Variants).void)).returns(
+            T.any(T.self_type, T::Enumerator[OpenAI::Models::Beta::AgentSessionEvent::Variants])
+          )
+        }
+        def each(&block)
+        end
+
+        sig { void }
+        def close
+        end
+
+        sig { returns(T.self_type) }
+        def until_done
+        end
+      end
+    end
+  end
+
+  module Resources
+    class Beta
+      class Agents
+        class Sessions
+          sig do
+            params(
+              session_id: String,
+              input: T.any(String, T::Array[OpenAI::Models::Beta::AgentSessionInputMessageParam::OrHash]),
+              tool_handlers: T::Hash[String, OpenAI::Helpers::Agents::ToolHandler],
+              idempotency_key: T.nilable(String),
+              request_options: T.nilable(OpenAI::RequestOptions::OrHash),
+              block: T.nilable(T.proc.params(stream: OpenAI::Helpers::Agents::SessionStream).void)
+            )
+              .returns(OpenAI::Helpers::Agents::SessionStream)
+          end
+          def stream(session_id, input:, tool_handlers: {}, idempotency_key: nil, request_options: {}, &block)
+          end
+        end
+      end
+    end
+  end
+
+  module Models
+    module Beta
+      class AgentSessionMessage < OpenAI::Internal::Type::BaseModel
+        sig { returns(String) }
+        def output_text
+        end
+      end
+    end
+  end
+end

data/rbi/openai/internal/token_page.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module OpenAI
+  module Internal
+    class TokenPage
+      include OpenAI::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(T.nilable(T::Array[Elem])) }
+      attr_accessor :data
+
+      sig { returns(T::Boolean) }
+      attr_accessor :has_more
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :next_
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+    end
+  end
+end

data/rbi/openai/models/beta/agent.rbi

@@ -0,0 +1,209 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class Agent < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::Agent,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The ID of the reusable agent.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The Unix timestamp, in seconds, when the agent was created.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # Custom instructions appended to the agent's default base instructions.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :instructions
+
+        # Custom string key-value pairs attached to the agent.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
+        # The requested model name used for inference.
+        sig { returns(String) }
+        attr_accessor :model
+
+        # The resolved 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
+
+        # A human-readable name for the agent, or null if it is unnamed.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The object type. Always `agent`.
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        # The resolved reasoning configuration, including the model default for an omitted
+        # effort.
+        sig { returns(OpenAI::Beta::AgentReasoning) }
+        attr_reader :reasoning
+
+        sig { params(reasoning: OpenAI::Beta::AgentReasoning::OrHash).void }
+        attr_writer :reasoning
+
+        # The resolved service-tier policy used for model requests.
+        sig { returns(OpenAI::Beta::Agent::ServiceTier::TaggedSymbol) }
+        attr_accessor :service_tier
+
+        # The resolved configuration for text generated by the agent.
+        sig { returns(OpenAI::Beta::AgentText) }
+        attr_reader :text
+
+        sig { params(text: OpenAI::Beta::AgentText::OrHash).void }
+        attr_writer :text
+
+        # Tools available to the agent.
+        sig { returns(T::Array[OpenAI::Beta::PersistedAgentTool::Variants]) }
+        attr_accessor :tools
+
+        # The Unix timestamp, in seconds, when the agent was last updated.
+        sig { returns(Integer) }
+        attr_accessor :updated_at
+
+        # A reusable agent scoped to the caller's project.
+        sig do
+          params(
+
+            id: String,
+
+            created_at: Integer,
+
+            instructions: T.nilable(String),
+
+            metadata: T::Hash[Symbol, String],
+
+            model: String,
+
+            multi_agent: OpenAI::Beta::MultiAgentConfig::OrHash,
+
+            name: T.nilable(String),
+
+            reasoning: OpenAI::Beta::AgentReasoning::OrHash,
+
+            service_tier: OpenAI::Beta::Agent::ServiceTier::OrSymbol,
+
+            text: OpenAI::Beta::AgentText::OrHash,
+
+            tools: T::Array[
+              T.any(
+                OpenAI::Beta::PersistedAgentTool::Function::OrHash,
+                OpenAI::Beta::PersistedAgentTool::ToolSearch::OrHash,
+                OpenAI::Beta::PersistedAgentTool::ProgrammaticToolCalling::OrHash,
+                OpenAI::Beta::PersistedAgentTool::Mcp::OrHash,
+                OpenAI::Beta::PersistedAgentTool::WebSearch::OrHash
+              )
+            ],
+
+            updated_at: Integer,
+
+            object: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The ID of the reusable agent.
+          id:,
+
+          # The Unix timestamp, in seconds, when the agent was created.
+          created_at:,
+
+          # Custom instructions appended to the agent's default base instructions.
+          instructions:,
+
+          # Custom string key-value pairs attached to the agent.
+          metadata:,
+
+          # The requested model name used for inference.
+          model:,
+
+          # The resolved configuration for creating and coordinating subagents.
+          multi_agent:,
+
+          # A human-readable name for the agent, or null if it is unnamed.
+          name:,
+
+          # The resolved reasoning configuration, including the model default for an omitted
+          # effort.
+          reasoning:,
+
+          # The resolved service-tier policy used for model requests.
+          service_tier:,
+
+          # The resolved configuration for text generated by the agent.
+          text:,
+
+          # Tools available to the agent.
+          tools:,
+
+          # The Unix timestamp, in seconds, when the agent was last updated.
+          updated_at:,
+
+          # The object type. Always `agent`.
+
+          object: :agent
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              instructions: T.nilable(String),
+              metadata: T::Hash[Symbol, String],
+              model: String,
+              multi_agent: OpenAI::Beta::MultiAgentConfig,
+              name: T.nilable(String),
+              object: Symbol,
+              reasoning: OpenAI::Beta::AgentReasoning,
+              service_tier: OpenAI::Beta::Agent::ServiceTier::TaggedSymbol,
+              text: OpenAI::Beta::AgentText,
+              tools: T::Array[OpenAI::Beta::PersistedAgentTool::Variants],
+              updated_at: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The resolved service-tier policy used for model requests.
+        module ServiceTier
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::Agent::ServiceTier) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AUTO = T.let(:auto, OpenAI::Beta::Agent::ServiceTier::TaggedSymbol)
+          DEFAULT = T.let(:default, OpenAI::Beta::Agent::ServiceTier::TaggedSymbol)
+          FLEX = T.let(:flex, OpenAI::Beta::Agent::ServiceTier::TaggedSymbol)
+          PRIORITY = T.let(:priority, OpenAI::Beta::Agent::ServiceTier::TaggedSymbol)
+          FAST = T.let(:fast, OpenAI::Beta::Agent::ServiceTier::TaggedSymbol)
+
+          sig { override.returns(T::Array[OpenAI::Beta::Agent::ServiceTier::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_close_subagent_call_item.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentCloseSubagentCallItem < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentCloseSubagentCallItem,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The ID of the tool call item.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The ID of the agent to close.
+        sig { returns(String) }
+        attr_accessor :recipient_agent_id
+
+        # The ID of the agent requesting the close.
+        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 `close_subagent_call`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A request to close a subagent.
+        sig do
+          params(
+
+            id: String,
+
+            recipient_agent_id: 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 ID of the agent to close.
+          recipient_agent_id:,
+
+          # The ID of the agent requesting the close.
+          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 `close_subagent_call`.
+
+          type: :close_subagent_call
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              recipient_agent_id: 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_command_execution_item.rbi

@@ -0,0 +1,132 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentCommandExecutionItem < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentCommandExecutionItem,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The ID of the command execution item.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The command that was executed.
+        sig { returns(String) }
+        attr_accessor :command
+
+        # The working directory used to execute the command.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :cwd
+
+        # The command duration in milliseconds.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :duration_ms
+
+        # The process exit code, if the command completed.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :exit_code
+
+        # The command output, if available.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :output
+
+        # The status of the command execution.
+        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 `command_execution`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A command execution produced by the agent.
+        sig do
+          params(
+
+            id: String,
+
+            command: String,
+
+            cwd: T.nilable(String),
+
+            duration_ms: T.nilable(Integer),
+
+            exit_code: T.nilable(Integer),
+
+            output: T.nilable(String),
+
+            status: OpenAI::Beta::AgentFunctionCallStatus::OrSymbol,
+
+            turn_id: String,
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The ID of the command execution item.
+          id:,
+
+          # The command that was executed.
+          command:,
+
+          # The working directory used to execute the command.
+          cwd:,
+
+          # The command duration in milliseconds.
+          duration_ms:,
+
+          # The process exit code, if the command completed.
+          exit_code:,
+
+          # The command output, if available.
+          output:,
+
+          # The status of the command execution.
+          status:,
+
+          # The ID of the turn that contains this item.
+          turn_id:,
+
+          # The item type. Always `command_execution`.
+
+          type: :command_execution
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              command: String,
+              cwd: T.nilable(String),
+              duration_ms: T.nilable(Integer),
+              exit_code: T.nilable(Integer),
+              output: T.nilable(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_content.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      # A plaintext or encrypted content part exchanged between agents.
+      module AgentContent
+        extend OpenAI::Internal::Type::Union
+
+        Variants = T.type_alias do
+          T.any(
+            OpenAI::Beta::OutputText,
+            OpenAI::Beta::AgentContent::EncryptedContent
+          )
+        end
+
+        class EncryptedContent < OpenAI::Internal::Type::BaseModel
+          OrHash = T.type_alias do
+            T.any(
+              OpenAI::Beta::AgentContent::EncryptedContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+          # The encrypted content payload.
+          sig { returns(String) }
+          attr_accessor :encrypted_content
+
+          # The content type. Always `encrypted_content`.
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Encrypted content exchanged between agents.
+          sig do
+            params(
+
+              encrypted_content: String,
+
+              type: Symbol
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+
+            # The encrypted content payload.
+            encrypted_content:,
+
+            # The content type. Always `encrypted_content`.
+
+            type: :encrypted_content
+          )
+          end
+
+          sig do
+            override.returns(
+              {encrypted_content: String, type: Symbol}
+            )
+          end
+          def to_hash
+          end
+
+        end
+
+        sig { override.returns(T::Array[OpenAI::Beta::AgentContent::Variants]) }
+        def self.variants
+        end
+
+      end
+
+    end
+
+  end
+end