openai 0.89.0 → 0.91.0

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class HostedEnvironmentFileID < OpenAI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The session-scoped ID of the file in the execution environment.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute file_id
+        #   The ID of the uploaded file.
+        #
+        #   @return [String]
+        required :file_id, String
+
+        # @!attribute path
+        #   The file's absolute path inside the environment.
+        #
+        #   @return [String]
+        required :path, String
+
+        # @!attribute size_bytes
+        #   The decoded file size in bytes.
+        #
+        #   @return [Integer]
+        required :size_bytes, Integer
+
+        # @!attribute type
+        #   The type of the object. Always `file_id`.
+        #
+        #   @return [Symbol, :file_id]
+        required :type, const: :file_id
+
+        # @!method initialize(id:, file_id:, path:, size_bytes:, type: :file_id)
+        #   A file copied from the OpenAI Files API.
+        #
+        #   @param id [String]
+        #     The session-scoped ID of the file in the execution environment.
+        #
+        #   @param file_id [String]
+        #     The ID of the uploaded file.
+        #
+        #   @param path [String]
+        #     The file's absolute path inside the environment.
+        #
+        #   @param size_bytes [Integer]
+        #     The decoded file size in bytes.
+        #
+        #   @param type [Symbol, :file_id]
+        #     The type of the object. Always `file_id`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A file materialized in an OpenAI-hosted execution environment.
+      module HostedEnvironmentFileParam
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A file previously uploaded through the OpenAI Files API.
+        variant :file_id, -> { OpenAI::Beta::HostedEnvironmentFileParam::FileID }
+
+        # A file supplied directly as standard-base64 data.
+        variant :inline, -> { OpenAI::Beta::HostedEnvironmentFileParam::Inline }
+
+        class FileID < OpenAI::Internal::Type::BaseModel
+          # @!attribute file_id
+          #   The ID of the uploaded file.
+          #
+          #   @return [String]
+          required :file_id, String
+
+          # @!attribute path
+          #   The absolute destination path inside `/workspace`.
+          #
+          #   @return [String]
+          required :path, String
+
+          # @!attribute type
+          #   The type of the object. Always `file_id`.
+          #
+          #   @return [Symbol, :file_id]
+          required :type, const: :file_id
+
+          # @!method initialize(file_id:, path:, type: :file_id)
+          #   A file previously uploaded through the OpenAI Files API.
+          #
+          #   @param file_id [String]
+          #     The ID of the uploaded file.
+          #
+          #   @param path [String]
+          #     The absolute destination path inside `/workspace`.
+          #
+          #   @param type [Symbol, :file_id]
+          #     The type of the object. Always `file_id`.
+        end
+
+        class Inline < OpenAI::Internal::Type::BaseModel
+          # @!attribute data
+          #   The standard-base64-encoded file contents.
+          #
+          #   @return [String]
+          required :data, String
+
+          # @!attribute path
+          #   The absolute destination path inside `/workspace`.
+          #
+          #   @return [String]
+          required :path, String
+
+          # @!attribute type
+          #   The type of the object. Always `inline`.
+          #
+          #   @return [Symbol, :inline]
+          required :type, const: :inline
+
+          # @!method initialize(data:, path:, type: :inline)
+          #   A file supplied directly as standard-base64 data.
+          #
+          #   @param data [String]
+          #     The standard-base64-encoded file contents.
+          #
+          #   @param path [String]
+          #     The absolute destination path inside `/workspace`.
+          #
+          #   @param type [Symbol, :inline]
+          #     The type of the object. Always `inline`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::HostedEnvironmentFileParam::FileID, OpenAI::Models::Beta::HostedEnvironmentFileParam::Inline)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class HostedPlugin < OpenAI::Internal::Type::BaseModel
+        # @!attribute description
+        #   The installed plugin description.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute name
+        #   The installed plugin name.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   The type of the object. Always `inline`.
+        #
+        #   @return [Symbol, :inline]
+        required :type, const: :inline
+
+        # @!method initialize(description:, name:, type: :inline)
+        #   A plugin installed from an inline ZIP archive.
+        #
+        #   @param description [String]
+        #     The installed plugin description.
+        #
+        #   @param name [String]
+        #     The installed plugin name.
+        #
+        #   @param type [Symbol, :inline]
+        #     The type of the object. Always `inline`.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      class HostedPluginParam < OpenAI::Internal::Type::BaseModel
+        # @!attribute description
+        #   The plugin description declared in `.codex-plugin/plugin.json`.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute name
+        #   The plugin name declared in `.codex-plugin/plugin.json`.
+        #
+        #   @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 plugin ZIP directly in the session request.
+        #
+        #   @param description [String]
+        #     The plugin description declared in `.codex-plugin/plugin.json`.
+        #
+        #   @param name [String]
+        #     The plugin name declared in `.codex-plugin/plugin.json`.
+        #
+        #   @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
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Beta
+      # A skill installed in an OpenAI-hosted environment.
+      module HostedSkill
+        extend OpenAI::Internal::Type::Union
+
+        discriminator :type
+
+        # A skill installed from the Skills API.
+        variant :skill_reference, -> { OpenAI::Beta::HostedSkillReference }
+
+        # A skill installed from an inline ZIP archive.
+        variant :inline, -> { OpenAI::Beta::HostedSkill::Inline }
+
+        class Inline < 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 type
+          #   The type of the object. Always `inline`.
+          #
+          #   @return [Symbol, :inline]
+          required :type, const: :inline
+
+          # @!method initialize(description:, name:, type: :inline)
+          #   A skill installed from an inline ZIP archive.
+          #
+          #   @param description [String]
+          #     The installed skill description.
+          #
+          #   @param name [String]
+          #     The installed skill name.
+          #
+          #   @param type [Symbol, :inline]
+          #     The type of the object. Always `inline`.
+        end
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::Beta::HostedSkillReference, OpenAI::Models::Beta::HostedSkill::Inline)]
+      end
+    end
+  end
+end

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