openai 0.89.0 → 0.90.0

data/rbi/openai/models/beta/agent_create_params.rbi

@@ -0,0 +1,212 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentCreateParams < OpenAI::Internal::Type::BaseModel
+
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentCreateParams,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The model to use for the agent. The requested model name is preserved.
+        sig { returns(String) }
+        attr_accessor :model
+
+        # Additional instructions appended to the agent's default base instructions. Omit
+        # or set to null to add no custom instructions.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :instructions
+
+        # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+        # characters. Omission or null defaults to an empty map.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_accessor :metadata
+
+        # 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 human-readable name for the agent. Omission or null leaves the agent unnamed.
+        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::AgentCreateParams::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. Defaults to an empty list.
+        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(
+
+            model: String,
+
+            instructions: T.nilable(String),
+
+            metadata: T.nilable(T::Hash[Symbol, 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::AgentCreateParams::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(
+
+          # The model to use for the agent. The requested model name is preserved.
+          model:,
+
+          # Additional instructions appended to the agent's default base instructions. Omit
+          # or set to null to add no custom instructions.
+          instructions: nil,
+
+          # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+          # characters. Omission or null defaults to an empty map.
+          metadata: nil,
+
+          # Explicit configuration for creating and coordinating subagents.
+          multi_agent: nil,
+
+          # A human-readable name for the agent. Omission or null leaves the agent unnamed.
+          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. Defaults to an empty list.
+          tools: nil,
+
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              model: String,
+              instructions: T.nilable(String),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              multi_agent: T.nilable(OpenAI::Beta::MultiAgentConfigParam),
+              name: T.nilable(String),
+              reasoning: T.nilable(OpenAI::Beta::AgentReasoningParam),
+              service_tier: T.nilable(OpenAI::Beta::AgentCreateParams::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::AgentCreateParams::ServiceTier) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # Selects the service tier automatically.
+          AUTO = T.let(:auto, OpenAI::Beta::AgentCreateParams::ServiceTier::TaggedSymbol)
+
+          # Uses the default service tier.
+          DEFAULT = T.let(:default, OpenAI::Beta::AgentCreateParams::ServiceTier::TaggedSymbol)
+
+          # Uses the flex service tier.
+          FLEX = T.let(:flex, OpenAI::Beta::AgentCreateParams::ServiceTier::TaggedSymbol)
+
+          # Uses the priority service tier.
+          PRIORITY = T.let(:priority, OpenAI::Beta::AgentCreateParams::ServiceTier::TaggedSymbol)
+
+          # Uses the fast service tier.
+          FAST = T.let(:fast, OpenAI::Beta::AgentCreateParams::ServiceTier::TaggedSymbol)
+
+          sig { override.returns(T::Array[OpenAI::Beta::AgentCreateParams::ServiceTier::TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_create_subagent_call_item.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentCreateSubagentCallItem < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentCreateSubagentCallItem,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The ID of the tool call item.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The ID of the agent that requested the subagent.
+        sig { returns(String) }
+        attr_accessor :agent_id
+
+        # The task given to the spawned agent.
+        sig { returns(T::Array[OpenAI::Beta::AgentContent::Variants]) }
+        attr_accessor :content
+
+        # The model requested for the spawned agent.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :model
+
+        # The reasoning effort requested for the spawned agent.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reasoning_effort
+
+        # 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 `create_subagent_call`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A request to spawn a subagent.
+        sig do
+          params(
+
+            id: String,
+
+            agent_id: String,
+
+            content: T::Array[
+              T.any(OpenAI::Beta::OutputText::OrHash, OpenAI::Beta::AgentContent::EncryptedContent::OrHash)
+            ],
+
+            model: T.nilable(String),
+
+            reasoning_effort: 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 tool call item.
+          id:,
+
+          # The ID of the agent that requested the subagent.
+          agent_id:,
+
+          # The task given to the spawned agent.
+          content:,
+
+          # The model requested for the spawned agent.
+          model:,
+
+          # The reasoning effort requested for the spawned agent.
+          reasoning_effort:,
+
+          # The status of the tool call.
+          status:,
+
+          # The ID of the turn that contains this item.
+          turn_id:,
+
+          # The item type. Always `create_subagent_call`.
+
+          type: :create_subagent_call
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              agent_id: String,
+              content: T::Array[OpenAI::Beta::AgentContent::Variants],
+              model: T.nilable(String),
+              reasoning_effort: 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_delete_params.rbi

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

data/rbi/openai/models/beta/agent_deleted.rbi

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

data/rbi/openai/models/beta/agent_function_call_item.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      class AgentFunctionCallItem < OpenAI::Internal::Type::BaseModel
+
+        OrHash = T.type_alias do
+          T.any(
+            OpenAI::Beta::AgentFunctionCallItem,
+            OpenAI::Internal::AnyHash
+          )
+        end
+
+        # The ID of the function call item.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The arguments to pass to the function.
+        sig { returns(T.anything) }
+        attr_accessor :arguments
+
+        # The ID used to submit the function result.
+        sig { returns(String) }
+        attr_accessor :call_id
+
+        # The name of the function to call.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # The status of the function 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 `function_call`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A function call produced by the agent.
+        sig do
+          params(
+
+            id: String,
+
+            arguments: T.anything,
+
+            call_id: String,
+
+            name: String,
+
+            status: OpenAI::Beta::AgentFunctionCallStatus::OrSymbol,
+
+            turn_id: String,
+
+            type: Symbol
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+
+          # The ID of the function call item.
+          id:,
+
+          # The arguments to pass to the function.
+          arguments:,
+
+          # The ID used to submit the function result.
+          call_id:,
+
+          # The name of the function to call.
+          name:,
+
+          # The status of the function call.
+          status:,
+
+          # The ID of the turn that contains this item.
+          turn_id:,
+
+          # The item type. Always `function_call`.
+
+          type: :function_call
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              arguments: T.anything,
+              call_id: String,
+              name: 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_function_call_output.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      # The text or model-input content supplied as a function result.
+      module AgentFunctionCallOutput
+        extend OpenAI::Internal::Type::Union
+
+        Variants = T.type_alias do
+          T.any(
+            String,
+            T::Array[OpenAI::Beta::InputContent::Variants]
+          )
+        end
+
+        sig { override.returns(T::Array[OpenAI::Beta::AgentFunctionCallOutput::Variants]) }
+        def self.variants
+        end
+
+        InputContentArray = T.let(
+          OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::InputContent],
+          OpenAI::Internal::Type::Converter
+        )
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_function_call_output_param.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      # A function result represented as text or supported model-input content.
+      module AgentFunctionCallOutputParam
+        extend OpenAI::Internal::Type::Union
+
+        Variants = T.type_alias do
+          T.any(
+            String,
+            T::Array[OpenAI::Beta::InputContentParam::Variants]
+          )
+        end
+
+        sig { override.returns(T::Array[OpenAI::Beta::AgentFunctionCallOutputParam::Variants]) }
+        def self.variants
+        end
+
+        InputContentParamArray = T.let(
+          OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::InputContentParam],
+          OpenAI::Internal::Type::Converter
+        )
+
+      end
+
+    end
+
+  end
+end

data/rbi/openai/models/beta/agent_function_call_status.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module OpenAI
+  module Models
+
+    module Beta
+
+      # The status of a tool call.
+      module AgentFunctionCallStatus
+        extend OpenAI::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Beta::AgentFunctionCallStatus) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # The call is in progress.
+        IN_PROGRESS = T.let(:in_progress, OpenAI::Beta::AgentFunctionCallStatus::TaggedSymbol)
+
+        # The call completed successfully.
+        COMPLETED = T.let(:completed, OpenAI::Beta::AgentFunctionCallStatus::TaggedSymbol)
+
+        # The call failed.
+        FAILED = T.let(:failed, OpenAI::Beta::AgentFunctionCallStatus::TaggedSymbol)
+
+        # The call stopped before completing.
+        INCOMPLETE = T.let(:incomplete, OpenAI::Beta::AgentFunctionCallStatus::TaggedSymbol)
+
+        sig { override.returns(T::Array[OpenAI::Beta::AgentFunctionCallStatus::TaggedSymbol]) }
+        def self.values
+        end
+      end
+
+    end
+
+  end
+end