openai 0.88.0 → 0.90.0

data/lib/openai/models/beta/persisted_agent_tool_param.rb

@@ -0,0 +1,355 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A tool that can be stored on a reusable agent without session credentials.
+      module PersistedAgentToolParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A function defined by the application.
+        variant :function, -> { OpenAI::Beta::PersistedAgentToolParam::Function }
+
+        # Discovers deferred function tools and loads them into the model context.
+        variant :tool_search, -> { OpenAI::Beta::PersistedAgentToolParam::ToolSearch }
+
+        # Enables calling tools from model-generated code.
+        variant :programmatic_tool_calling, -> { OpenAI::Beta::PersistedAgentToolParam::ProgrammaticToolCalling }
+
+        # Tools provided by a remote MCP server without stored credentials.
+        variant :mcp, -> { OpenAI::Beta::PersistedAgentToolParam::Mcp }
+
+        # Web search.
+        variant :web_search, -> { OpenAI::Beta::PersistedAgentToolParam::WebSearch }
+
+        class Function < OpenAI::Internal::Type::BaseModel
+          # @!attribute description
+          #   A description of what the function does.
+          #
+          #   @return [String]
+          required :description, String
+
+          # @!attribute name
+          #   The name of the function.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute parameters
+          #   A JSON Schema object describing the function's arguments.
+          #
+          #   @return [Hash{Symbol=>Object}]
+          required :parameters, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+          # @!attribute type
+          #   The type of the object. Always `function`.
+          #
+          #   @return [Symbol, :function]
+          required :type, const: :function
+
+          # @!attribute defer_loading
+          #   Whether this function is deferred and discovered through tool search. Defaults
+          #   to `false`.
+          #
+          #   @return [Boolean, nil]
+          optional :defer_loading, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(description:, name:, parameters:, defer_loading: nil, type: :function)
+          #   A function defined by the application.
+          #
+          #   @param description [String]
+          #     A description of what the function does.
+          #
+          #   @param name [String]
+          #     The name of the function.
+          #
+          #   @param parameters [Hash{Symbol=>Object}]
+          #     A JSON Schema object describing the function's arguments.
+          #
+          #   @param defer_loading [Boolean]
+          #     Whether this function is deferred and discovered through tool search. Defaults
+          #     to `false`.
+          #
+          #   @param type [Symbol, :function]
+          #     The type of the object. Always `function`.
+        end
+
+        class ToolSearch < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `tool_search`.
+          #
+          #   @return [Symbol, :tool_search]
+          required :type, const: :tool_search
+
+          # @!method initialize(type: :tool_search)
+          #   Discovers deferred function tools and loads them into the model context.
+          #
+          #   @param type [Symbol, :tool_search]
+          #     The type of the object. Always `tool_search`.
+        end
+
+        class ProgrammaticToolCalling < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `programmatic_tool_calling`.
+          #
+          #   @return [Symbol, :programmatic_tool_calling]
+          required :type, const: :programmatic_tool_calling
+
+          # @!attribute enabled
+          #   Whether tools can be called from model-generated code. Defaults to `true`.
+          #
+          #   @return [Boolean, nil]
+          optional :enabled, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(enabled: nil, type: :programmatic_tool_calling)
+          #   Enables calling tools from model-generated code.
+          #
+          #   @param enabled [Boolean]
+          #     Whether tools can be called from model-generated code. Defaults to `true`.
+          #
+          #   @param type [Symbol, :programmatic_tool_calling]
+          #     The type of the object. Always `programmatic_tool_calling`.
+        end
+
+        class Mcp < OpenAI::Internal::Type::BaseModel
+          # @!attribute server_label
+          #   A label used to identify the MCP server in tool calls.
+          #
+          #   @return [String]
+          required :server_label, String
+
+          # @!attribute transport
+          #   The credential-free transport used to connect to the MCP server.
+          #
+          #   @return [OpenAI::Models::Beta::PersistedMcpTransportParam::HTTP, OpenAI::Models::Beta::PersistedMcpTransportParam::Stdio]
+          required :transport, union: -> { OpenAI::Beta::PersistedMcpTransportParam }
+
+          # @!attribute type
+          #   The type of the object. Always `mcp`.
+          #
+          #   @return [Symbol, :mcp]
+          required :type, const: :mcp
+
+          # @!attribute allowed_tools
+          #   The MCP tools the agent may call. All server tools are allowed when omitted.
+          #
+          #   @return [Array<String>, nil]
+          optional :allowed_tools, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute connection_origin
+          #   Where outbound MCP HTTP connections originate.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp::ConnectionOrigin, nil]
+          optional(
+            :connection_origin,
+            enum: -> { OpenAI::Beta::PersistedAgentToolParam::Mcp::ConnectionOrigin },
+            nil?: true
+          )
+
+          # @!attribute credential_id
+          #   The vault credential selected for this MCP server. Optional when exactly one
+          #   attached credential matches the server URL.
+          #
+          #   @return [String, nil]
+          optional :credential_id, String, nil?: true
+
+          # @!attribute request_metadata
+          #   Metadata included with requests to this MCP server.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional(
+            :request_metadata,
+            OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown],
+            nil?: true
+          )
+
+          # @!attribute required
+          #   Whether this MCP server must initialize before the first turn. Defaults to
+          #   `false`.
+          #
+          #   @return [Boolean, nil]
+          optional :required, OpenAI::Internal::Type::Boolean
+
+          # @!method initialize(server_label:, transport:, allowed_tools: nil, connection_origin: nil, credential_id: nil, request_metadata: nil, required: nil, type: :mcp)
+          #   Tools provided by a remote MCP server without stored credentials.
+          #
+          #   @param server_label [String]
+          #     A label used to identify the MCP server in tool calls.
+          #
+          #   @param transport [OpenAI::Models::Beta::PersistedMcpTransportParam::HTTP, OpenAI::Models::Beta::PersistedMcpTransportParam::Stdio]
+          #     The credential-free transport used to connect to the MCP server.
+          #
+          #   @param allowed_tools [Array<String>, nil]
+          #     The MCP tools the agent may call. All server tools are allowed when omitted.
+          #
+          #   @param connection_origin [Symbol, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp::ConnectionOrigin, nil]
+          #     Where outbound MCP HTTP connections originate.
+          #
+          #   @param credential_id [String, nil]
+          #     The vault credential selected for this MCP server. Optional when exactly one
+          #     attached credential matches the server URL.
+          #
+          #   @param request_metadata [Hash{Symbol=>Object}, nil]
+          #     Metadata included with requests to this MCP server.
+          #
+          #   @param required [Boolean]
+          #     Whether this MCP server must initialize before the first turn. Defaults to
+          #     `false`.
+          #
+          #   @param type [Symbol, :mcp]
+          #     The type of the object. Always `mcp`.
+
+          # Where outbound MCP HTTP connections originate.
+          #
+          # @see OpenAI::Models::Beta::PersistedAgentToolParam::Mcp#connection_origin
+          module ConnectionOrigin
+            extend OpenAI::Internal::Type::Enum
+
+            # Uses the Managed Agents service network.
+            SERVICE = :service
+
+            # Uses the session's execution environment.
+            ENVIRONMENT = :environment
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class WebSearch < OpenAI::Internal::Type::BaseModel
+          # @!attribute type
+          #   The type of the object. Always `web_search`.
+          #
+          #   @return [Symbol, :web_search]
+          required :type, const: :web_search
+
+          # @!attribute allowed_domains
+          #   Domains the search may include.
+          #
+          #   @return [Array<String>, nil]
+          optional :allowed_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute context_size
+          #   The amount of web search context made available to the model.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::ContextSize, nil]
+          optional(
+            :context_size,
+            enum: -> { OpenAI::Beta::PersistedAgentToolParam::WebSearch::ContextSize },
+            nil?: true
+          )
+
+          # @!attribute location
+          #   Approximate user location used to localize web search results.
+          #
+          #   @return [OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::Location, nil]
+          optional :location, -> { OpenAI::Beta::PersistedAgentToolParam::WebSearch::Location }, nil?: true
+
+          # @!attribute mode
+          #   The source used for web search results.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::Mode, nil]
+          optional :mode, enum: -> { OpenAI::Beta::PersistedAgentToolParam::WebSearch::Mode }, nil?: true
+
+          # @!method initialize(allowed_domains: nil, context_size: nil, location: nil, mode: nil, type: :web_search)
+          #   Web search.
+          #
+          #   @param allowed_domains [Array<String>, nil]
+          #     Domains the search may include.
+          #
+          #   @param context_size [Symbol, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::ContextSize, nil]
+          #     The amount of web search context made available to the model.
+          #
+          #   @param location [OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::Location, nil]
+          #     Approximate user location used to localize web search results.
+          #
+          #   @param mode [Symbol, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::Mode, nil]
+          #     The source used for web search results.
+          #
+          #   @param type [Symbol, :web_search]
+          #     The type of the object. Always `web_search`.
+
+          # The amount of web search context made available to the model.
+          #
+          # @see OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch#context_size
+          module ContextSize
+            extend OpenAI::Internal::Type::Enum
+
+            LOW = :low
+            MEDIUM = :medium
+            HIGH = :high
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch#location
+          class Location < OpenAI::Internal::Type::BaseModel
+            # @!attribute city
+            #   The city name.
+            #
+            #   @return [String, nil]
+            optional :city, String, nil?: true
+
+            # @!attribute country
+            #   The two-letter ISO country code, such as `US`.
+            #
+            #   @return [String, nil]
+            optional :country, String, nil?: true
+
+            # @!attribute region
+            #   The region or state name.
+            #
+            #   @return [String, nil]
+            optional :region, String, nil?: true
+
+            # @!attribute timezone
+            #   The IANA timezone, such as `America/Los_Angeles`.
+            #
+            #   @return [String, nil]
+            optional :timezone, String, nil?: true
+
+            # @!method initialize(city: nil, country: nil, region: nil, timezone: nil)
+            #   Approximate user location used to localize web search results.
+            #
+            #   @param city [String, nil]
+            #     The city name.
+            #
+            #   @param country [String, nil]
+            #     The two-letter ISO country code, such as `US`.
+            #
+            #   @param region [String, nil]
+            #     The region or state name.
+            #
+            #   @param timezone [String, nil]
+            #     The IANA timezone, such as `America/Los_Angeles`.
+          end
+
+          # The source used for web search results.
+          #
+          # @see OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch#mode
+          module Mode
+            extend OpenAI::Internal::Type::Enum
+
+            # Disables web search.
+            DISABLED = :disabled
+
+            # Uses cached search results.
+            CACHED = :cached
+
+            # Searches the live web.
+            LIVE = :live
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch)]
+      end
+    end
+  end
+end

data/lib/openai/models/beta/persisted_mcp_transport.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A credential-free transport used to connect to an MCP server.
+      module PersistedMcpTransport
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Connects to an MCP server over HTTP.
+        variant :http, -> { OpenAI::Beta::PersistedMcpTransport::HTTP }
+
+        # Starts an MCP server as a local process.
+        variant :stdio, -> { OpenAI::Beta::PersistedMcpTransport::Stdio }
+
+        class HTTP < OpenAI::Internal::Type::BaseModel
+          # @!attribute headers
+          #   Non-secret HTTP headers sent to the MCP server.
+          #
+          #   @return [Hash{Symbol=>String}]
+          required :headers, OpenAI::Internal::Type::HashOf[String]
+
+          # @!attribute server_url
+          #   The URL of the MCP server.
+          #
+          #   @return [String]
+          required :server_url, String
+
+          # @!attribute type
+          #   The type of the object. Always `http`.
+          #
+          #   @return [Symbol, :http]
+          required :type, const: :http
+
+          # @!method initialize(headers:, server_url:, type: :http)
+          #   Connects to an MCP server over HTTP.
+          #
+          #   @param headers [Hash{Symbol=>String}]
+          #     Non-secret HTTP headers sent to the MCP server.
+          #
+          #   @param server_url [String]
+          #     The URL of the MCP server.
+          #
+          #   @param type [Symbol, :http]
+          #     The type of the object. Always `http`.
+        end
+
+        class Stdio < OpenAI::Internal::Type::BaseModel
+          # @!attribute args
+          #   Arguments passed to the MCP server command.
+          #
+          #   @return [Array<String>]
+          required :args, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute command
+          #   The command used to start the MCP server.
+          #
+          #   @return [String]
+          required :command, String
+
+          # @!attribute cwd
+          #   The working directory used to start the MCP server.
+          #
+          #   @return [String]
+          required :cwd, String
+
+          # @!attribute env_vars
+          #   Environment variable names inherited from the execution environment.
+          #
+          #   @return [Array<String>]
+          required :env_vars, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute type
+          #   The type of the object. Always `stdio`.
+          #
+          #   @return [Symbol, :stdio]
+          required :type, const: :stdio
+
+          # @!method initialize(args:, command:, cwd:, env_vars:, type: :stdio)
+          #   Starts an MCP server as a local process.
+          #
+          #   @param args [Array<String>]
+          #     Arguments passed to the MCP server command.
+          #
+          #   @param command [String]
+          #     The command used to start the MCP server.
+          #
+          #   @param cwd [String]
+          #     The working directory used to start the MCP server.
+          #
+          #   @param env_vars [Array<String>]
+          #     Environment variable names inherited from the execution environment.
+          #
+          #   @param type [Symbol, :stdio]
+          #     The type of the object. Always `stdio`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::PersistedMcpTransport::HTTP, OpenAI::Models::Beta::PersistedMcpTransport::Stdio)]
+      end
+    end
+  end
+end

data/lib/openai/models/beta/persisted_mcp_transport_param.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A credential-free transport used to connect to an MCP server.
+      module PersistedMcpTransportParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Connects to an MCP server over HTTP.
+        variant :http, -> { OpenAI::Beta::PersistedMcpTransportParam::HTTP }
+
+        # Starts an MCP server as a local process.
+        variant :stdio, -> { OpenAI::Beta::PersistedMcpTransportParam::Stdio }
+
+        class HTTP < OpenAI::Internal::Type::BaseModel
+          # @!attribute server_url
+          #   The URL of the MCP server.
+          #
+          #   @return [String]
+          required :server_url, String
+
+          # @!attribute type
+          #   The type of the object. Always `http`.
+          #
+          #   @return [Symbol, :http]
+          required :type, const: :http
+
+          # @!attribute headers
+          #   Non-secret HTTP headers sent to the MCP server.
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :headers, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+          # @!method initialize(server_url:, headers: nil, type: :http)
+          #   Connects to an MCP server over HTTP.
+          #
+          #   @param server_url [String]
+          #     The URL of the MCP server.
+          #
+          #   @param headers [Hash{Symbol=>String}, nil]
+          #     Non-secret HTTP headers sent to the MCP server.
+          #
+          #   @param type [Symbol, :http]
+          #     The type of the object. Always `http`.
+        end
+
+        class Stdio < OpenAI::Internal::Type::BaseModel
+          # @!attribute command
+          #   The command used to start the MCP server.
+          #
+          #   @return [String]
+          required :command, String
+
+          # @!attribute cwd
+          #   The working directory used to start the MCP server.
+          #
+          #   @return [String]
+          required :cwd, String
+
+          # @!attribute type
+          #   The type of the object. Always `stdio`.
+          #
+          #   @return [Symbol, :stdio]
+          required :type, const: :stdio
+
+          # @!attribute args
+          #   Arguments passed to the MCP server command.
+          #
+          #   @return [Array<String>, nil]
+          optional :args, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute env_vars
+          #   Environment variable names to inherit from the selected execution environment.
+          #
+          #   @return [Array<String>, nil]
+          optional :env_vars, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!method initialize(command:, cwd:, args: nil, env_vars: nil, type: :stdio)
+          #   Starts an MCP server as a local process.
+          #
+          #   @param command [String]
+          #     The command used to start the MCP server.
+          #
+          #   @param cwd [String]
+          #     The working directory used to start the MCP server.
+          #
+          #   @param args [Array<String>, nil]
+          #     Arguments passed to the MCP server command.
+          #
+          #   @param env_vars [Array<String>, nil]
+          #     Environment variable names to inherit from the selected execution environment.
+          #
+          #   @param type [Symbol, :stdio]
+          #     The type of the object. Always `stdio`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::PersistedMcpTransportParam::HTTP, OpenAI::Models::Beta::PersistedMcpTransportParam::Stdio)]
+      end
+    end
+  end
+end

data/lib/openai/models/beta/session_error.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class SessionError < OpenAI::Internal::Type::BaseModel
+        # @!attribute code
+        #   The machine-readable error code, if any.
+        #
+        #   @return [String, nil]
+        required :code, String, nil?: true
+
+        # @!attribute message
+        #   A customer-safe explanation of the error.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!attribute param
+        #   The request parameter associated with the error, if any.
+        #
+        #   @return [String, nil]
+        required :param, String, nil?: true
+
+        # @!attribute type
+        #   The error type.
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!method initialize(code:, message:, param:, type:)
+        #   An error payload with the same public fields as Responses API streaming errors.
+        #
+        #   @param code [String, nil]
+        #     The machine-readable error code, if any.
+        #
+        #   @param message [String]
+        #     A customer-safe explanation of the error.
+        #
+        #   @param param [String, nil]
+        #     The request parameter associated with the error, if any.
+        #
+        #   @param type [String]
+        #     The error type.
+      end
+    end
+  end
+end

data/lib/openai/models/beta/session_turn_error.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class SessionTurnError < OpenAI::Internal::Type::BaseModel
+        # @!attribute code
+        #   A stable, machine-readable failure category.
+        #
+        #   @return [Symbol, OpenAI::Models::Beta::SessionTurnError::Code]
+        required :code, enum: -> { OpenAI::Beta::SessionTurnError::Code }
+
+        # @!attribute message
+        #   A customer-safe explanation of the failure.
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!method initialize(code:, message:)
+        #   A customer-safe error describing why a session request failed.
+        #
+        #   @param code [Symbol, OpenAI::Models::Beta::SessionTurnError::Code]
+        #     A stable, machine-readable failure category.
+        #
+        #   @param message [String]
+        #     A customer-safe explanation of the failure.
+
+        # A stable, machine-readable failure category.
+        #
+        # @see OpenAI::Models::Beta::SessionTurnError#code
+        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
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end