openai 0.89.0 → 0.90.0

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

@@ -0,0 +1,251 @@
+module OpenAI
+  module Models
+    module Beta
+      type persisted_agent_tool_param =
+        OpenAI::Beta::PersistedAgentToolParam::Function
+        | OpenAI::Beta::PersistedAgentToolParam::ToolSearch
+        | OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling
+        | OpenAI::Beta::PersistedAgentToolParam::Mcp
+        | OpenAI::Beta::PersistedAgentToolParam::WebSearch
+
+      module PersistedAgentToolParam
+        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::persisted_mcp_transport_param,
+            ?type: :mcp,
+            ?allowed_tools: ::Array[String]?,
+            ?connection_origin: OpenAI::Models::Beta::PersistedAgentToolParam::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::persisted_mcp_transport_param
+
+          attr_accessor type: :mcp
+
+          attr_accessor allowed_tools: ::Array[String]?
+
+          attr_accessor connection_origin: OpenAI::Models::Beta::PersistedAgentToolParam::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::persisted_mcp_transport_param,
+            ?allowed_tools: ::Array[String]?,
+            ?connection_origin: OpenAI::Models::Beta::PersistedAgentToolParam::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::persisted_mcp_transport_param,
+            ?type: :mcp,
+            ?allowed_tools: ::Array[String]?,
+            ?connection_origin: OpenAI::Models::Beta::PersistedAgentToolParam::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::PersistedAgentToolParam::Mcp::connection_origin]
+          end
+        end
+
+        type web_search =
+          {
+            ?type: :web_search,
+            ?allowed_domains: ::Array[String]?,
+            ?context_size: OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::context_size?,
+            ?location: OpenAI::Beta::PersistedAgentToolParam::WebSearch::Location?,
+            ?mode: OpenAI::Models::Beta::PersistedAgentToolParam::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::PersistedAgentToolParam::WebSearch::context_size?
+
+          attr_accessor location: OpenAI::Beta::PersistedAgentToolParam::WebSearch::Location?
+
+          attr_accessor mode: OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::mode?
+
+          def initialize: (
+            ?allowed_domains: ::Array[String]?,
+            ?context_size: OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::context_size?,
+            ?location: OpenAI::Beta::PersistedAgentToolParam::WebSearch::Location?,
+            ?mode: OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::mode?,
+            ?type: :web_search
+          ) -> void
+
+          def to_hash: -> {
+            ?type: :web_search,
+            ?allowed_domains: ::Array[String]?,
+            ?context_size: OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::context_size?,
+            ?location: OpenAI::Beta::PersistedAgentToolParam::WebSearch::Location?,
+            ?mode: OpenAI::Models::Beta::PersistedAgentToolParam::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::PersistedAgentToolParam::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::PersistedAgentToolParam::WebSearch::mode]
+          end
+        end
+
+        def self?.variants: -> ::Array[OpenAI::Models::Beta::persisted_agent_tool_param]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module OpenAI
+  module Models
+    module Beta
+      type persisted_mcp_transport =
+        OpenAI::Beta::PersistedMcpTransport::HTTP
+        | OpenAI::Beta::PersistedMcpTransport::Stdio
+
+      module PersistedMcpTransport
+        extend OpenAI::Internal::Type::Union
+
+        type http =
+          { headers: ::Hash[Symbol, String], server_url: String, ?type: :http }
+
+        class HTTP < OpenAI::Internal::Type::BaseModel
+          attr_accessor headers: ::Hash[Symbol, String]
+
+          attr_accessor server_url: String
+
+          attr_accessor type: :http
+
+          def initialize: (
+            headers: ::Hash[Symbol, String],
+            server_url: String,
+            ?type: :http
+          ) -> void
+
+          def to_hash: -> {
+            headers: ::Hash[Symbol, String],
+            server_url: String,
+            ?type: :http
+          }
+        end
+
+        type stdio =
+          {
+            args: ::Array[String],
+            command: String,
+            cwd: String,
+            env_vars: ::Array[String],
+            ?type: :stdio
+          }
+
+        class Stdio < OpenAI::Internal::Type::BaseModel
+          attr_accessor args: ::Array[String]
+
+          attr_accessor command: String
+
+          attr_accessor cwd: String
+
+          attr_accessor env_vars: ::Array[String]
+
+          attr_accessor type: :stdio
+
+          def initialize: (
+            args: ::Array[String],
+            command: String,
+            cwd: String,
+            env_vars: ::Array[String],
+            ?type: :stdio
+          ) -> void
+
+          def to_hash: -> {
+            args: ::Array[String],
+            command: String,
+            cwd: String,
+            env_vars: ::Array[String],
+            ?type: :stdio
+          }
+        end
+
+        def self?.variants: -> ::Array[OpenAI::Models::Beta::persisted_mcp_transport]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+module OpenAI
+  module Models
+    module Beta
+      type persisted_mcp_transport_param =
+        OpenAI::Beta::PersistedMcpTransportParam::HTTP
+        | OpenAI::Beta::PersistedMcpTransportParam::Stdio
+
+      module PersistedMcpTransportParam
+        extend OpenAI::Internal::Type::Union
+
+        type http =
+          {
+            server_url: String,
+            ?type: :http,
+            ?headers: ::Hash[Symbol, String]?
+          }
+
+        class HTTP < OpenAI::Internal::Type::BaseModel
+          attr_accessor server_url: String
+
+          attr_accessor type: :http
+
+          attr_accessor headers: ::Hash[Symbol, String]?
+
+          def initialize: (
+            server_url: String,
+            ?headers: ::Hash[Symbol, String]?,
+            ?type: :http
+          ) -> void
+
+          def to_hash: -> {
+            server_url: String,
+            ?type: :http,
+            ?headers: ::Hash[Symbol, String]?
+          }
+        end
+
+        type stdio =
+          {
+            command: String,
+            cwd: String,
+            ?type: :stdio,
+            ?args: ::Array[String]?,
+            ?env_vars: ::Array[String]?
+          }
+
+        class Stdio < OpenAI::Internal::Type::BaseModel
+          attr_accessor command: String
+
+          attr_accessor cwd: String
+
+          attr_accessor type: :stdio
+
+          attr_accessor args: ::Array[String]?
+
+          attr_accessor env_vars: ::Array[String]?
+
+          def initialize: (
+            command: String,
+            cwd: String,
+            ?args: ::Array[String]?,
+            ?env_vars: ::Array[String]?,
+            ?type: :stdio
+          ) -> void
+
+          def to_hash: -> {
+            command: String,
+            cwd: String,
+            ?type: :stdio,
+            ?args: ::Array[String]?,
+            ?env_vars: ::Array[String]?
+          }
+        end
+
+        def self?.variants: -> ::Array[OpenAI::Models::Beta::persisted_mcp_transport_param]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module OpenAI
+  module Models
+    module Beta
+      type session_error =
+        { code: String?, message: String, param: String?, type: String }
+
+      class SessionError < OpenAI::Internal::Type::BaseModel
+        attr_accessor code: String?
+
+        attr_accessor message: String
+
+        attr_accessor param: String?
+
+        attr_accessor type: String
+
+        def initialize: (
+          code: String?,
+          message: String,
+          param: String?,
+          type: String
+        ) -> void
+
+        def to_hash: -> {
+          code: String?,
+          message: String,
+          param: String?,
+          type: String
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+module OpenAI
+  module Models
+    module Beta
+      type session_turn_error =
+        { code: OpenAI::Models::Beta::SessionTurnError::code, message: String }
+
+      class SessionTurnError < OpenAI::Internal::Type::BaseModel
+        attr_accessor code: OpenAI::Models::Beta::SessionTurnError::code
+
+        attr_accessor message: String
+
+        def initialize: (
+          code: OpenAI::Models::Beta::SessionTurnError::code,
+          message: String
+        ) -> void
+
+        def to_hash: -> {
+          code: OpenAI::Models::Beta::SessionTurnError::code,
+          message: String
+        }
+
+        type code =
+          :context_length_exceeded
+          | :session_budget_exceeded
+          | :usage_limit_exceeded
+          | :rate_limit_exceeded
+          | :server_overloaded
+          | :cyber_policy
+          | :connection_failed
+          | :server_error
+          | :authentication_error
+          | :invalid_request
+          | :resource_not_found
+          | :sandbox_error
+          | :executor_version_incompatible
+          | :active_turn_not_steerable
+          | :request_timeout
+          | :internal_error
+
+        module Code
+          extend OpenAI::Internal::Type::Enum
+
+          # The request exceeds the model's context window.
+          CONTEXT_LENGTH_EXCEEDED: :context_length_exceeded
+
+          # The session has reached its usage budget.
+          SESSION_BUDGET_EXCEEDED: :session_budget_exceeded
+
+          # The organization has reached a usage, plan, or billing limit.
+          USAGE_LIMIT_EXCEEDED: :usage_limit_exceeded
+
+          # The request exceeds the available rate limit.
+          RATE_LIMIT_EXCEEDED: :rate_limit_exceeded
+
+          # The model service is temporarily overloaded.
+          SERVER_OVERLOADED: :server_overloaded
+
+          # The request was rejected by a safety policy.
+          CYBER_POLICY: :cyber_policy
+
+          # The request could not connect to the model service.
+          CONNECTION_FAILED: :connection_failed
+
+          # The model service encountered an unexpected error.
+          SERVER_ERROR: :server_error
+
+          # The API credentials are invalid or lack the required access.
+          AUTHENTICATION_ERROR: :authentication_error
+
+          # The request contains invalid input or configuration.
+          INVALID_REQUEST: :invalid_request
+
+          # The requested model or resource is unavailable.
+          RESOURCE_NOT_FOUND: :resource_not_found
+
+          # The request could not complete in its execution environment.
+          SANDBOX_ERROR: :sandbox_error
+
+          # The executor must be upgraded before it can run this turn.
+          EXECUTOR_VERSION_INCOMPATIBLE: :executor_version_incompatible
+
+          # The session cannot accept additional input while a request is running.
+          ACTIVE_TURN_NOT_STEERABLE: :active_turn_not_steerable
+
+          # The request timed out before the model service responded.
+          REQUEST_TIMEOUT: :request_timeout
+
+          # An unexpected internal error prevented the session request from completing.
+          INTERNAL_ERROR: :internal_error
+
+          def self?.values: -> ::Array[OpenAI::Models::Beta::SessionTurnError::code]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Beta
+      type setup_command_param = { command: String, ?cwd: String? }
+
+      class SetupCommandParam < OpenAI::Internal::Type::BaseModel
+        attr_accessor command: String
+
+        attr_accessor cwd: String?
+
+        def initialize: (command: String, ?cwd: String?) -> void
+
+        def to_hash: -> { command: String, ?cwd: String? }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+module OpenAI
+  module Models
+    module Beta
+      type subagent =
+        {
+          id: String,
+          closed_at: Integer?,
+          instructions: ::Array[OpenAI::Models::Beta::agent_content]?,
+          name: String?,
+          ?object: :"agent.session.subagent",
+          opened_at: Integer,
+          parent_agent_id: String,
+          session_id: String,
+          status: OpenAI::Models::Beta::Subagent::status
+        }
+
+      class Subagent < OpenAI::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor closed_at: Integer?
+
+        attr_accessor instructions: ::Array[OpenAI::Models::Beta::agent_content]?
+
+        attr_accessor name: String?
+
+        attr_accessor object: :"agent.session.subagent"
+
+        attr_accessor opened_at: Integer
+
+        attr_accessor parent_agent_id: String
+
+        attr_accessor session_id: String
+
+        attr_accessor status: OpenAI::Models::Beta::Subagent::status
+
+        def initialize: (
+          id: String,
+          closed_at: Integer?,
+          instructions: ::Array[OpenAI::Models::Beta::agent_content]?,
+          name: String?,
+          opened_at: Integer,
+          parent_agent_id: String,
+          session_id: String,
+          status: OpenAI::Models::Beta::Subagent::status,
+          ?object: :"agent.session.subagent"
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          closed_at: Integer?,
+          instructions: ::Array[OpenAI::Models::Beta::agent_content]?,
+          name: String?,
+          ?object: :"agent.session.subagent",
+          opened_at: Integer,
+          parent_agent_id: String,
+          session_id: String,
+          status: OpenAI::Models::Beta::Subagent::status
+        }
+
+        type status = :active | :closed
+
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          # The subagent remains available, including while idle between turns.
+          ACTIVE: :active
+
+          # The subagent is closed.
+          CLOSED: :closed
+
+          def self?.values: -> ::Array[OpenAI::Models::Beta::Subagent::status]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Beta
+      type summary_text = { text: String, ?type: :summary_text }
+
+      class SummaryText < OpenAI::Internal::Type::BaseModel
+        attr_accessor text: String
+
+        attr_accessor type: :summary_text
+
+        def initialize: (text: String, ?type: :summary_text) -> void
+
+        def to_hash: -> { text: String, ?type: :summary_text }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module OpenAI
+  module Models
+    module Beta
+      type text_format =
+        OpenAI::Beta::TextFormat::Text | OpenAI::Beta::TextFormat::JSONSchema
+
+      module TextFormat
+        extend OpenAI::Internal::Type::Union
+
+        type text = { ?type: :text }
+
+        class Text < OpenAI::Internal::Type::BaseModel
+          attr_accessor type: :text
+
+          def initialize: (?type: :text) -> void
+
+          def to_hash: -> { ?type: :text }
+        end
+
+        type json_schema = { schema: ::Hash[Symbol, top], ?type: :json_schema }
+
+        class JSONSchema < OpenAI::Internal::Type::BaseModel
+          attr_accessor schema: ::Hash[Symbol, top]
+
+          attr_accessor type: :json_schema
+
+          def initialize: (
+            schema: ::Hash[Symbol, top],
+            ?type: :json_schema
+          ) -> void
+
+          def to_hash: -> { schema: ::Hash[Symbol, top], ?type: :json_schema }
+        end
+
+        def self?.variants: -> ::Array[OpenAI::Models::Beta::text_format]
+      end
+    end
+  end
+end