openai 0.89.0 → 0.90.0

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A skill installed in an OpenAI-hosted environment.
+      module HostedSkillParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # References a skill uploaded through the Skills API.
+        variant :skill_reference, -> { OpenAI::Beta::HostedSkillParam::SkillReference }
+
+        # Supplies a skill ZIP directly in the session request.
+        variant :inline, -> { OpenAI::Beta::HostedSkillParam::Inline }
+
+        class SkillReference < OpenAI::Internal::Type::BaseModel
+          # @!attribute skill_id
+          #   The ID of the skill created through `/v1/skills`.
+          #
+          #   @return [String]
+          required :skill_id, String
+
+          # @!attribute type
+          #   The type of the object. Always `skill_reference`.
+          #
+          #   @return [Symbol, :skill_reference]
+          required :type, const: :skill_reference
+
+          # @!attribute version
+          #   The skill version, a positive integer or `latest`; omission selects the default.
+          #
+          #   @return [String, nil]
+          optional :version, String, nil?: true
+
+          # @!method initialize(skill_id:, version: nil, type: :skill_reference)
+          #   References a skill uploaded through the Skills API.
+          #
+          #   @param skill_id [String]
+          #     The ID of the skill created through `/v1/skills`.
+          #
+          #   @param version [String, nil]
+          #     The skill version, a positive integer or `latest`; omission selects the default.
+          #
+          #   @param type [Symbol, :skill_reference]
+          #     The type of the object. Always `skill_reference`.
+        end
+
+        class Inline < OpenAI::Internal::Type::BaseModel
+          # @!attribute description
+          #   The skill description declared in `SKILL.md`.
+          #
+          #   @return [String]
+          required :description, String
+
+          # @!attribute name
+          #   The skill name declared in `SKILL.md`.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute source
+          #   Provides ZIP bytes encoded with standard base64.
+          #
+          #   @return [OpenAI::Models::Beta::InlineCapabilitySourceParam]
+          required :source, -> { OpenAI::Beta::InlineCapabilitySourceParam }
+
+          # @!attribute type
+          #   The type of the object. Always `inline`.
+          #
+          #   @return [Symbol, :inline]
+          required :type, const: :inline
+
+          # @!method initialize(description:, name:, source:, type: :inline)
+          #   Supplies a skill ZIP directly in the session request.
+          #
+          #   @param description [String]
+          #     The skill description declared in `SKILL.md`.
+          #
+          #   @param name [String]
+          #     The skill name declared in `SKILL.md`.
+          #
+          #   @param source [OpenAI::Models::Beta::InlineCapabilitySourceParam]
+          #     Provides ZIP bytes encoded with standard base64.
+          #
+          #   @param type [Symbol, :inline]
+          #     The type of the object. Always `inline`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::HostedSkillParam::SkillReference, OpenAI::Models::Beta::HostedSkillParam::Inline)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class HostedSkillReference < OpenAI::Internal::Type::BaseModel
+        # @!attribute description
+        #   The installed skill description.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute name
+        #   The installed skill name.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute skill_id
+        #   The referenced skill ID.
+        #
+        #   @return [String]
+        required :skill_id, String
+
+        # @!attribute type
+        #   The type of the object. Always `skill_reference`.
+        #
+        #   @return [Symbol, :skill_reference]
+        required :type, const: :skill_reference
+
+        # @!attribute version
+        #   The concrete skill version installed for this session.
+        #
+        #   @return [String]
+        required :version, String
+
+        # @!method initialize(description:, name:, skill_id:, version:, type: :skill_reference)
+        #   A skill installed from the Skills API.
+        #
+        #   @param description [String]
+        #     The installed skill description.
+        #
+        #   @param name [String]
+        #     The installed skill name.
+        #
+        #   @param skill_id [String]
+        #     The referenced skill ID.
+        #
+        #   @param version [String]
+        #     The concrete skill version installed for this session.
+        #
+        #   @param type [Symbol, :skill_reference]
+        #     The type of the object. Always `skill_reference`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class InlineCapabilitySourceParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute data
+        #   Standard-base64 encoded ZIP archive bytes.
+        #
+        #   @return [String]
+        required :data, String
+
+        # @!attribute media_type
+        #   The archive media type, always `application/zip`.
+        #
+        #   @return [Symbol, :"application/zip"]
+        required :media_type, const: :"application/zip"
+
+        # @!attribute type
+        #   The type of the object. Always `base64`.
+        #
+        #   @return [Symbol, :base64]
+        required :type, const: :base64
+
+        # @!method initialize(data:, media_type: :"application/zip", type: :base64)
+        #   Provides ZIP bytes encoded with standard base64.
+        #
+        #   @param data [String]
+        #     Standard-base64 encoded ZIP archive bytes.
+        #
+        #   @param media_type [Symbol, :"application/zip"]
+        #     The archive media type, always `application/zip`.
+        #
+        #   @param type [Symbol, :base64]
+        #     The type of the object. Always `base64`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # User-provided content recorded in a session item.
+      module InputContent
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Text input recorded in a session item.
+        variant :input_text, -> { OpenAI::Beta::InputContent::InputText }
+
+        # Image input recorded in a session item.
+        variant :input_image, -> { OpenAI::Beta::InputContent::InputImage }
+
+        class InputText < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The text supplied to the agent.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The type of the object. Always `input_text`.
+          #
+          #   @return [Symbol, :input_text]
+          required :type, const: :input_text
+
+          # @!method initialize(text:, type: :input_text)
+          #   Text input recorded in a session item.
+          #
+          #   @param text [String]
+          #     The text supplied to the agent.
+          #
+          #   @param type [Symbol, :input_text]
+          #     The type of the object. Always `input_text`.
+        end
+
+        class InputImage < OpenAI::Internal::Type::BaseModel
+          # @!attribute image_url
+          #   The URL of the image supplied to the agent, which may be a base64-encoded data
+          #   URL.
+          #
+          #   @return [String]
+          required :image_url, String
+
+          # @!attribute type
+          #   The type of the object. Always `input_image`.
+          #
+          #   @return [Symbol, :input_image]
+          required :type, const: :input_image
+
+          # @!method initialize(image_url:, type: :input_image)
+          #   Image input recorded in a session item.
+          #
+          #   @param image_url [String]
+          #     The URL of the image supplied to the agent, which may be a base64-encoded data
+          #     URL.
+          #
+          #   @param type [Symbol, :input_image]
+          #     The type of the object. Always `input_image`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::InputContent::InputText, OpenAI::Models::Beta::InputContent::InputImage)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # Content included in an input message.
+      module InputContentParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # Text input to the model.
+        variant :input_text, -> { OpenAI::Beta::InputContentParam::InputText }
+
+        # Image input to the model.
+        variant :input_image, -> { OpenAI::Beta::InputContentParam::InputImage }
+
+        class InputText < OpenAI::Internal::Type::BaseModel
+          # @!attribute text
+          #   The text sent to the model.
+          #
+          #   @return [String]
+          required :text, String
+
+          # @!attribute type
+          #   The type of the object. Always `input_text`.
+          #
+          #   @return [Symbol, :input_text]
+          required :type, const: :input_text
+
+          # @!method initialize(text:, type: :input_text)
+          #   Text input to the model.
+          #
+          #   @param text [String]
+          #     The text sent to the model.
+          #
+          #   @param type [Symbol, :input_text]
+          #     The type of the object. Always `input_text`.
+        end
+
+        class InputImage < OpenAI::Internal::Type::BaseModel
+          # @!attribute image_url
+          #   The URL of the image sent to the model.
+          #
+          #   @return [String]
+          required :image_url, String
+
+          # @!attribute type
+          #   The type of the object. Always `input_image`.
+          #
+          #   @return [Symbol, :input_image]
+          required :type, const: :input_image
+
+          # @!method initialize(image_url:, type: :input_image)
+          #   Image input to the model.
+          #
+          #   @param image_url [String]
+          #     The URL of the image sent to the model.
+          #
+          #   @param type [Symbol, :input_image]
+          #     The type of the object. Always `input_image`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::InputContentParam::InputText, OpenAI::Models::Beta::InputContentParam::InputImage)]
+      end
+    end
+  end
+end

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