openai 0.89.0 → 0.91.0

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The transport used to connect to an MCP server.
+      module McpTransport
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Connects to an MCP server over HTTP.
+        variant :http, -> { OpenAI::Beta::McpTransport::HTTP }
+
+        # Starts an MCP server as a local process.
+        variant :stdio, -> { OpenAI::Beta::McpTransport::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
+
+          # @!method initialize(server_url:, type: :http)
+          #   Connects to an MCP server over HTTP.
+          #
+          #   @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::McpTransport::HTTP, OpenAI::Models::Beta::McpTransport::Stdio)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # The transport used to connect to an MCP server.
+      module McpTransportParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Connects to an MCP server over HTTP.
+        variant :http, -> { OpenAI::Beta::McpTransportParam::HTTP }
+
+        # Starts an MCP server as a local process.
+        variant :stdio, -> { OpenAI::Beta::McpTransportParam::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 authorization
+          #   The authorization value sent to the MCP server, if any.
+          #
+          #   @return [String, nil]
+          optional :authorization, String, nil?: true
+
+          # @!attribute headers
+          #   Additional 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:, authorization: nil, headers: nil, type: :http)
+          #   Connects to an MCP server over HTTP.
+          #
+          #   @param server_url [String]
+          #     The URL of the MCP server.
+          #
+          #   @param authorization [String, nil]
+          #     The authorization value sent to the MCP server, if any.
+          #
+          #   @param headers [Hash{Symbol=>String}, nil]
+          #     Additional 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
+          #   Environment variables set for the MCP server process.
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :env, OpenAI::Internal::Type::HashOf[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: 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 [Hash{Symbol=>String}, nil]
+          #     Environment variables set for the MCP server process.
+          #
+          #   @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::McpTransportParam::HTTP, OpenAI::Models::Beta::McpTransportParam::Stdio)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class MultiAgentConfig < OpenAI::Internal::Type::BaseModel
+        # @!attribute enabled
+        #   Whether subagent tools are enabled. Defaults to false.
+        #
+        #   @return [Boolean]
+        required :enabled, OpenAI::Internal::Type::Boolean
+
+        # @!attribute max_concurrent_subagents
+        #   Maximum number of subagents that may run concurrently, or null when disabled.
+        #   Defaults to 6 when enabled.
+        #
+        #   @return [Integer, nil]
+        required :max_concurrent_subagents, Integer, nil?: true
+
+        # @!method initialize(enabled:, max_concurrent_subagents:)
+        #   The resolved configuration for creating and coordinating subagents.
+        #
+        #   @param enabled [Boolean]
+        #     Whether subagent tools are enabled. Defaults to false.
+        #
+        #   @param max_concurrent_subagents [Integer, nil]
+        #     Maximum number of subagents that may run concurrently, or null when disabled.
+        #     Defaults to 6 when enabled.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class MultiAgentConfigParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute enabled
+        #   Whether subagent tools are enabled.
+        #
+        #   @return [Boolean]
+        required :enabled, OpenAI::Internal::Type::Boolean
+
+        # @!attribute max_concurrent_subagents
+        #   Maximum number of subagents that may run concurrently. Defaults to 6.
+        #
+        #   @return [Integer, nil]
+        optional :max_concurrent_subagents, Integer
+
+        # @!method initialize(enabled:, max_concurrent_subagents: nil)
+        #   Explicit configuration for creating and coordinating subagents.
+        #
+        #   @param enabled [Boolean]
+        #     Whether subagent tools are enabled.
+        #
+        #   @param max_concurrent_subagents [Integer]
+        #     Maximum number of subagents that may run concurrently. Defaults to 6.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class OutputText < OpenAI::Internal::Type::BaseModel
+        # @!attribute text
+        #   The text produced by the agent.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The content type. Always `output_text`.
+        #
+        #   @return [Symbol, :output_text]
+        required :type, const: :output_text
+
+        # @!method initialize(text:, type: :output_text)
+        #   A text content part produced by the agent.
+        #
+        #   @param text [String]
+        #     The text produced by the agent.
+        #
+        #   @param type [Symbol, :output_text]
+        #     The content type. Always `output_text`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,329 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A credential-free tool available to a reusable agent.
+      module PersistedAgentTool
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A function defined by the application.
+        variant :function, -> { OpenAI::Beta::PersistedAgentTool::Function }
+
+        # Discovers deferred function tools and loads them into the model context.
+        variant :tool_search, -> { OpenAI::Beta::PersistedAgentTool::ToolSearch }
+
+        # Enables calling tools from model-generated code.
+        variant :programmatic_tool_calling, -> { OpenAI::Beta::PersistedAgentTool::ProgrammaticToolCalling }
+
+        # Tools provided by a remote MCP server without stored credentials.
+        variant :mcp, -> { OpenAI::Beta::PersistedAgentTool::Mcp }
+
+        # Web search.
+        variant :web_search, -> { OpenAI::Beta::PersistedAgentTool::WebSearch }
+
+        class Function < OpenAI::Internal::Type::BaseModel
+          # @!attribute defer_loading
+          #   Whether the function is deferred and discovered through tool search.
+          #
+          #   @return [Boolean]
+          required :defer_loading, OpenAI::Internal::Type::Boolean
+
+          # @!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
+
+          # @!method initialize(defer_loading:, description:, name:, parameters:, type: :function)
+          #   A function defined by the application.
+          #
+          #   @param defer_loading [Boolean]
+          #     Whether the function is deferred and discovered through tool search.
+          #
+          #   @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 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 enabled
+          #   Whether tools can be called from model-generated code.
+          #
+          #   @return [Boolean]
+          required :enabled, OpenAI::Internal::Type::Boolean
+
+          # @!attribute type
+          #   The type of the object. Always `programmatic_tool_calling`.
+          #
+          #   @return [Symbol, :programmatic_tool_calling]
+          required :type, const: :programmatic_tool_calling
+
+          # @!method initialize(enabled:, type: :programmatic_tool_calling)
+          #   Enables calling tools from model-generated code.
+          #
+          #   @param enabled [Boolean]
+          #     Whether tools can be called from model-generated code.
+          #
+          #   @param type [Symbol, :programmatic_tool_calling]
+          #     The type of the object. Always `programmatic_tool_calling`.
+        end
+
+        class Mcp < OpenAI::Internal::Type::BaseModel
+          # @!attribute allowed_tools
+          #   The MCP tools the agent may call, or null when all server tools are allowed.
+          #
+          #   @return [Array<String>, nil]
+          required :allowed_tools, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute connection_origin
+          #   Where outbound MCP HTTP connections originate.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::PersistedAgentTool::Mcp::ConnectionOrigin]
+          required :connection_origin, enum: -> { OpenAI::Beta::PersistedAgentTool::Mcp::ConnectionOrigin }
+
+          # @!attribute credential_id
+          #   The vault credential selected for this MCP server, if any.
+          #
+          #   @return [String, nil]
+          required :credential_id, String, nil?: true
+
+          # @!attribute request_metadata
+          #   Metadata included with requests to this MCP server.
+          #
+          #   @return [Hash{Symbol=>Object}]
+          required :request_metadata, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+
+          # @!attribute required
+          #   Whether this MCP server must initialize before the first turn.
+          #
+          #   @return [Boolean]
+          required :required, OpenAI::Internal::Type::Boolean
+
+          # @!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::PersistedMcpTransport::HTTP, OpenAI::Models::Beta::PersistedMcpTransport::Stdio]
+          required :transport, union: -> { OpenAI::Beta::PersistedMcpTransport }
+
+          # @!attribute type
+          #   The type of the object. Always `mcp`.
+          #
+          #   @return [Symbol, :mcp]
+          required :type, const: :mcp
+
+          # @!method initialize(allowed_tools:, connection_origin:, credential_id:, request_metadata:, required:, server_label:, transport:, type: :mcp)
+          #   Tools provided by a remote MCP server without stored credentials.
+          #
+          #   @param allowed_tools [Array<String>, nil]
+          #     The MCP tools the agent may call, or null when all server tools are allowed.
+          #
+          #   @param connection_origin [Symbol, OpenAI::Models::Beta::PersistedAgentTool::Mcp::ConnectionOrigin]
+          #     Where outbound MCP HTTP connections originate.
+          #
+          #   @param credential_id [String, nil]
+          #     The vault credential selected for this MCP server, if any.
+          #
+          #   @param request_metadata [Hash{Symbol=>Object}]
+          #     Metadata included with requests to this MCP server.
+          #
+          #   @param required [Boolean]
+          #     Whether this MCP server must initialize before the first turn.
+          #
+          #   @param server_label [String]
+          #     A label used to identify the MCP server in tool calls.
+          #
+          #   @param transport [OpenAI::Models::Beta::PersistedMcpTransport::HTTP, OpenAI::Models::Beta::PersistedMcpTransport::Stdio]
+          #     The credential-free transport used to connect to the MCP server.
+          #
+          #   @param type [Symbol, :mcp]
+          #     The type of the object. Always `mcp`.
+
+          # Where outbound MCP HTTP connections originate.
+          #
+          # @see OpenAI::Models::Beta::PersistedAgentTool::Mcp#connection_origin
+          module ConnectionOrigin
+            extend OpenAI::Internal::Type::Enum
+
+            SERVICE = :service
+            ENVIRONMENT = :environment
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class WebSearch < OpenAI::Internal::Type::BaseModel
+          # @!attribute allowed_domains
+          #   Allowed search domains, or `null` when the search is unrestricted.
+          #
+          #   @return [Array<String>, nil]
+          required :allowed_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute context_size
+          #   The amount of search context made available to the model. Defaults to `medium`.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::PersistedAgentTool::WebSearch::ContextSize]
+          required :context_size, enum: -> { OpenAI::Beta::PersistedAgentTool::WebSearch::ContextSize }
+
+          # @!attribute location
+          #   Approximate user location used to localize web search results.
+          #
+          #   @return [OpenAI::Models::Beta::PersistedAgentTool::WebSearch::Location, nil]
+          required :location, -> { OpenAI::Beta::PersistedAgentTool::WebSearch::Location }, nil?: true
+
+          # @!attribute mode
+          #   The source used for web search results.
+          #
+          #   @return [Symbol, OpenAI::Models::Beta::PersistedAgentTool::WebSearch::Mode]
+          required :mode, enum: -> { OpenAI::Beta::PersistedAgentTool::WebSearch::Mode }
+
+          # @!attribute type
+          #   The type of the object. Always `web_search`.
+          #
+          #   @return [Symbol, :web_search]
+          required :type, const: :web_search
+
+          # @!method initialize(allowed_domains:, context_size:, location:, mode:, type: :web_search)
+          #   Web search.
+          #
+          #   @param allowed_domains [Array<String>, nil]
+          #     Allowed search domains, or `null` when the search is unrestricted.
+          #
+          #   @param context_size [Symbol, OpenAI::Models::Beta::PersistedAgentTool::WebSearch::ContextSize]
+          #     The amount of search context made available to the model. Defaults to `medium`.
+          #
+          #   @param location [OpenAI::Models::Beta::PersistedAgentTool::WebSearch::Location, nil]
+          #     Approximate user location used to localize web search results.
+          #
+          #   @param mode [Symbol, OpenAI::Models::Beta::PersistedAgentTool::WebSearch::Mode]
+          #     The source used for web search results.
+          #
+          #   @param type [Symbol, :web_search]
+          #     The type of the object. Always `web_search`.
+
+          # The amount of search context made available to the model. Defaults to `medium`.
+          #
+          # @see OpenAI::Models::Beta::PersistedAgentTool::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::PersistedAgentTool::WebSearch#location
+          class Location < OpenAI::Internal::Type::BaseModel
+            # @!attribute city
+            #   The city name.
+            #
+            #   @return [String, nil]
+            required :city, String, nil?: true
+
+            # @!attribute country
+            #   The two-letter ISO country code, such as `US`.
+            #
+            #   @return [String, nil]
+            required :country, String, nil?: true
+
+            # @!attribute region
+            #   The region or state name.
+            #
+            #   @return [String, nil]
+            required :region, String, nil?: true
+
+            # @!attribute timezone
+            #   The IANA timezone, such as `America/Los_Angeles`.
+            #
+            #   @return [String, nil]
+            required :timezone, String, nil?: true
+
+            # @!method initialize(city:, country:, region:, timezone:)
+            #   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::PersistedAgentTool::WebSearch#mode
+          module Mode
+            extend OpenAI::Internal::Type::Enum
+
+            DISABLED = :disabled
+            CACHED = :cached
+            LIVE = :live
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::PersistedAgentTool::Function, OpenAI::Models::Beta::PersistedAgentTool::ToolSearch, OpenAI::Models::Beta::PersistedAgentTool::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentTool::Mcp, OpenAI::Models::Beta::PersistedAgentTool::WebSearch)]
+      end
+    end
+  end
+end