RubyGems - openai - Versions diffs - 0.92.0 → 0.93.0 - Mend

openai 0.92.0 → 0.93.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1311) hide show

data/sig/openai/models/beta/agents/environments/environment_template.rbs CHANGED Viewed

@@ -21,28 +21,61 @@ module OpenAI
             }
           class EnvironmentTemplate < OpenAI::Internal::Type::BaseModel
+            # The ID of the reusable environment template.
             attr_accessor id: String
+            # Directories that expose capabilities to the agent.
             attr_accessor capability_directories: ::Array[String]
+            # The Unix timestamp, in seconds, when the template was created.
             attr_accessor created_at: Integer
+            # Safe file metadata, excluding contents and session-scoped file IDs.
             attr_accessor files: ::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::file]
+            # An optional human-readable display name for the template.
             attr_accessor name: String?
+            # Runtime network access for each OpenAI-hosted environment.
             attr_accessor network: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Network
+            # The object type. Always `agent.environment.template`.
             attr_accessor object: :"agent.environment.template"
+            # Packages installed in each fresh OpenAI-hosted environment.
             attr_accessor packages: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Packages
+            # Safe plugin metadata, excluding inline archive contents.
             attr_accessor plugins: ::Array[OpenAI::Beta::HostedPlugin]
+            # Safe skill metadata, preserving unresolved version selectors.
             attr_accessor skills: ::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::skill]
+            # The Unix timestamp, in seconds, when the template was last updated.
             attr_accessor updated_at: Integer
+            # @param id
+            #   The ID of the reusable environment template.
+            # @param capability_directories
+            #   Directories that expose capabilities to the agent.
+            # @param created_at
+            #   The Unix timestamp, in seconds, when the template was created.
+            # @param files
+            #   Safe file metadata, excluding contents and session-scoped file IDs.
+            # @param name
+            #   An optional human-readable display name for the template.
+            # @param network
+            #   Runtime network access for each OpenAI-hosted environment.
+            # @param packages
+            #   Packages installed in each fresh OpenAI-hosted environment.
+            # @param plugins
+            #   Safe plugin metadata, excluding inline archive contents.
+            # @param skills
+            #   Safe skill metadata, preserving unresolved version selectors.
+            # @param updated_at
+            #   The Unix timestamp, in seconds, when the template was last updated.
+            # @param object
+            #   The object type. Always `agent.environment.template`.
             def initialize: (
               id: String,
               capability_directories: ::Array[String],
@@ -81,12 +114,21 @@ module OpenAI
               type file_id = { file_id: String, path: String, ?type: :file_id }
               class FileID < OpenAI::Internal::Type::BaseModel
+                # The ID of the uploaded file.
                 attr_accessor file_id: String
+                # The file's absolute path inside the environment.
                 attr_accessor path: String
+                # The type of the object. Always `file_id`.
                 attr_accessor type: :file_id
+                # @param file_id
+                #   The ID of the uploaded file.
+                # @param path
+                #   The file's absolute path inside the environment.
+                # @param type
+                #   The type of the object. Always `file_id`.
                 def initialize: (
                   file_id: String,
                   path: String,
@@ -104,12 +146,21 @@ module OpenAI
                 { path: String, size_bytes: Integer, ?type: :inline }
               class Inline < OpenAI::Internal::Type::BaseModel
+                # The file's absolute path inside the environment.
                 attr_accessor path: String
+                # The decoded size of the inline file in bytes.
                 attr_accessor size_bytes: Integer
+                # The type of the object. Always `inline`.
                 attr_accessor type: :inline
+                # @param path
+                #   The file's absolute path inside the environment.
+                # @param size_bytes
+                #   The decoded size of the inline file in bytes.
+                # @param type
+                #   The type of the object. Always `inline`.
                 def initialize: (
                   path: String,
                   size_bytes: Integer,
@@ -133,10 +184,16 @@ module OpenAI
               }
             class Network < OpenAI::Internal::Type::BaseModel
+              # The environment's network access mode.
               attr_accessor access: OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::Network::access
+              # Domains the environment may access when network access is restricted.
               attr_accessor allowed_domains: ::Array[String]
+              # @param access
+              #   The environment's network access mode.
+              # @param allowed_domains
+              #   Domains the environment may access when network access is restricted.
               def initialize: (
                 access: OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::Network::access,
                 allowed_domains: ::Array[String]
@@ -173,12 +230,21 @@ module OpenAI
               }
             class Packages < OpenAI::Internal::Type::BaseModel
+              # npm packages installed globally in the environment.
               attr_accessor npm: ::Array[String]
+              # Python packages installed in the environment.
               attr_accessor python: ::Array[String]
+              # System packages installed in the environment.
               attr_accessor system_: ::Array[String]
+              # @param npm
+              #   npm packages installed globally in the environment.
+              # @param python
+              #   Python packages installed in the environment.
+              # @param system_
+              #   System packages installed in the environment.
               def initialize: (
                 npm: ::Array[String],
                 python: ::Array[String],
@@ -203,12 +269,21 @@ module OpenAI
                 { skill_id: String, ?type: :skill_reference, version: String? }
               class SkillReference < OpenAI::Internal::Type::BaseModel
+                # The referenced skill ID.
                 attr_accessor skill_id: String
+                # The type of the object. Always `skill_reference`.
                 attr_accessor type: :skill_reference
+                # The requested version selector, including `latest`.
                 attr_accessor version: String?
+                # @param skill_id
+                #   The referenced skill ID.
+                # @param version
+                #   The requested version selector, including `latest`.
+                # @param type
+                #   The type of the object. Always `skill_reference`.
                 def initialize: (
                   skill_id: String,
                   version: String?,
@@ -226,12 +301,21 @@ module OpenAI
                 { description: String, name: String, ?type: :inline }
               class Inline < OpenAI::Internal::Type::BaseModel
+                # The skill description declared in `SKILL.md`.
                 attr_accessor description: String
+                # The skill name declared in `SKILL.md`.
                 attr_accessor name: String
+                # The type of the object. Always `inline`.
                 attr_accessor type: :inline
+                # @param description
+                #   The skill description declared in `SKILL.md`.
+                # @param name
+                #   The skill name declared in `SKILL.md`.
+                # @param type
+                #   The type of the object. Always `inline`.
                 def initialize: (
                   description: String,
                   name: String,

data/sig/openai/models/beta/agents/environments/environment_template_deleted.rbs CHANGED Viewed

@@ -13,12 +13,21 @@ module OpenAI
             }
           class EnvironmentTemplateDeleted < OpenAI::Internal::Type::BaseModel
+            # The ID of the deleted environment template.
             attr_accessor id: String
+            # Whether the environment template was deleted. Always `true`.
             attr_accessor deleted: bool
+            # The object type. Always `agent.environment.template.deleted`.
             attr_accessor object: :"agent.environment.template.deleted"
+            # @param id
+            #   The ID of the deleted environment template.
+            # @param deleted
+            #   Whether the environment template was deleted. Always `true`.
+            # @param object
+            #   The object type. Always `agent.environment.template.deleted`.
             def initialize: (
               id: String,
               deleted: bool,

data/sig/openai/models/beta/agents/environments/file_list_params.rbs CHANGED Viewed

@@ -19,20 +19,34 @@ module OpenAI
             attr_accessor environment_id: String
+            # The maximum number of files to return, between 1 and 100.
             attr_accessor limit: Integer?
+            # Sort by case-sensitive path components. Defaults to descending.
             attr_reader order: OpenAI::Models::Beta::Agents::Environments::FileListParams::order?
+            # Sort by case-sensitive path components. Defaults to descending.
             def order=: (
               OpenAI::Models::Beta::Agents::Environments::FileListParams::order
             ) -> OpenAI::Models::Beta::Agents::Environments::FileListParams::order
+            # The opaque token from the previous page. Keep the same path, order, and limit.
             attr_reader page: String?
+            # The opaque token from the previous page. Keep the same path, order, and limit.
             def page=: (String) -> String
+            # Restrict the listing to this absolute workspace directory.
             attr_accessor path: String?
+            # @param limit
+            #   The maximum number of files to return, between 1 and 100.
+            # @param order
+            #   Sort by case-sensitive path components. Defaults to descending.
+            # @param page
+            #   The opaque token from the previous page. Keep the same path, order, and limit.
+            # @param path
+            #   Restrict the listing to this absolute workspace directory.
             def initialize: (
               environment_id: String,
               ?limit: Integer?,

data/sig/openai/models/beta/agents/environments/template_create_params.rbs CHANGED Viewed

@@ -21,24 +21,57 @@ module OpenAI
             extend OpenAI::Internal::Type::RequestParameters::Converter
             include OpenAI::Internal::Type::RequestParameters
+            # Directories that contain capabilities exposed to the agent. Defaults to an empty
+            # list.
             attr_accessor capability_directories: ::Array[String]?
+            # Environment variables made available to the agent.
             attr_accessor env: ::Hash[Symbol, String]?
+            # Files available before the agent starts. Defaults to an empty list.
             attr_accessor files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?
+            # An optional human-readable display name for the template.
             attr_accessor name: String?
+            # Network access policy for the environment. Defaults to disabled for GA requests
+            # and enabled for alpha/beta requests.
             attr_accessor network: OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network?
+            # Packages to install in the environment. Defaults to empty package lists.
             attr_accessor packages: OpenAI::Beta::Agents::Environments::TemplateCreateParams::Packages?
+            # Plugins provided as inline ZIP archives. Defaults to an empty list.
             attr_accessor plugins: ::Array[OpenAI::Beta::HostedPluginParam]?
+            # Ordered, confidential setup commands. Command bodies are never returned.
             attr_accessor setup_commands: ::Array[OpenAI::Beta::SetupCommandParam]?
+            # Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty
+            # list.
             attr_accessor skills: ::Array[OpenAI::Models::Beta::hosted_skill_param]?
+            # @param capability_directories
+            #   Directories that contain capabilities exposed to the agent. Defaults to an empty
+            #   list.
+            # @param env
+            #   Environment variables made available to the agent.
+            # @param files
+            #   Files available before the agent starts. Defaults to an empty list.
+            # @param name
+            #   An optional human-readable display name for the template.
+            # @param network
+            #   Network access policy for the environment. Defaults to disabled for GA requests
+            #   and enabled for alpha/beta requests.
+            # @param packages
+            #   Packages to install in the environment. Defaults to empty package lists.
+            # @param plugins
+            #   Plugins provided as inline ZIP archives. Defaults to an empty list.
+            # @param setup_commands
+            #   Ordered, confidential setup commands. Command bodies are never returned.
+            # @param skills
+            #   Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty
+            #   list.
             def initialize: (
               ?capability_directories: ::Array[String]?,
               ?env: ::Hash[Symbol, String]?,
@@ -72,10 +105,16 @@ module OpenAI
               }
             class Network < OpenAI::Internal::Type::BaseModel
+              # The environment's network access mode.
               attr_accessor access: OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network::access
+              # Domains the environment may access when network access is restricted.
               attr_accessor allowed_domains: ::Array[String]?
+              # @param access
+              #   The environment's network access mode.
+              # @param allowed_domains
+              #   Domains the environment may access when network access is restricted.
               def initialize: (
                 access: OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams::Network::access,
                 ?allowed_domains: ::Array[String]?
@@ -91,7 +130,7 @@ module OpenAI
               module Access
                 extend OpenAI::Internal::Type::Enum
-                # Allows unrestricted network access, matching an omitted network policy.
+                # Allows unrestricted network access.
                 ENABLED: :enabled
                 # Disables network access.
@@ -112,12 +151,21 @@ module OpenAI
               }
             class Packages < OpenAI::Internal::Type::BaseModel
+              # npm packages to install globally. Defaults to an empty list.
               attr_accessor npm: ::Array[String]?
+              # Python packages to install. Defaults to an empty list.
               attr_accessor python: ::Array[String]?
+              # System packages to install. Defaults to an empty list.
               attr_accessor system_: ::Array[String]?
+              # @param npm
+              #   npm packages to install globally. Defaults to an empty list.
+              # @param python
+              #   Python packages to install. Defaults to an empty list.
+              # @param system_
+              #   System packages to install. Defaults to an empty list.
               def initialize: (
                 ?npm: ::Array[String]?,
                 ?python: ::Array[String]?,

data/sig/openai/models/beta/agents/environments/template_list_params.rbs CHANGED Viewed

@@ -15,20 +15,32 @@ module OpenAI
             extend OpenAI::Internal::Type::RequestParameters::Converter
             include OpenAI::Internal::Type::RequestParameters
+            # Return resources after this resource ID in the selected order.
             attr_reader after: String?
+            # Return resources after this resource ID in the selected order.
             def after=: (String) -> String
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
             attr_reader limit: Integer?
+            # The maximum number of resources to return, between 1 and 100. Defaults to 20.
             def limit=: (Integer) -> Integer
+            # The order in which resources are returned. Defaults to `desc`.
             attr_reader order: OpenAI::Models::Beta::Agents::Environments::TemplateListParams::order?
+            # The order in which resources are returned. Defaults to `desc`.
             def order=: (
               OpenAI::Models::Beta::Agents::Environments::TemplateListParams::order
             ) -> OpenAI::Models::Beta::Agents::Environments::TemplateListParams::order
+            # @param after
+            #   Return resources after this resource ID in the selected order.
+            # @param limit
+            #   The maximum number of resources to return, between 1 and 100. Defaults to 20.
+            # @param order
+            #   The order in which resources are returned. Defaults to `desc`.
             def initialize: (
               ?after: String,
               ?limit: Integer,

data/sig/openai/models/beta/agents/environments/template_update_params.rbs CHANGED Viewed

@@ -24,24 +24,55 @@ module OpenAI
             attr_accessor environment_template_id: String
+            # Directories that expose capabilities to the agent.
             attr_accessor capability_directories: ::Array[String]?
+            # Replacement confidential environment values.
             attr_accessor env: ::Hash[Symbol, String]?
+            # Replacement file configuration materialized for each new session.
             attr_accessor files: ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?
+            # A replacement human-readable display name, or `null` to clear the name.
             attr_accessor name: String?
+            # Network access available after setup completes. Omit to preserve the current
+            # policy, or pass `null` to reset to disabled for GA requests or enabled for
+            # alpha/beta requests.
             attr_accessor network: OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Network?
+            # Packages installed before the runtime network policy applies.
             attr_accessor packages: OpenAI::Beta::Agents::Environments::TemplateUpdateParams::Packages?
+            # Replacement plugin configuration installed for each new session.
             attr_accessor plugins: ::Array[OpenAI::Beta::HostedPluginParam]?
+            # Replacement confidential setup commands, never included in returned resources.
             attr_accessor setup_commands: ::Array[OpenAI::Beta::SetupCommandParam]?
+            # Replacement skill configuration installed for each new session.
             attr_accessor skills: ::Array[OpenAI::Models::Beta::hosted_skill_param]?
+            # @param capability_directories
+            #   Directories that expose capabilities to the agent.
+            # @param env
+            #   Replacement confidential environment values.
+            # @param files
+            #   Replacement file configuration materialized for each new session.
+            # @param name
+            #   A replacement human-readable display name, or `null` to clear the name.
+            # @param network
+            #   Network access available after setup completes. Omit to preserve the current
+            #   policy, or pass `null` to reset to disabled for GA requests or enabled for
+            #   alpha/beta requests.
+            # @param packages
+            #   Packages installed before the runtime network policy applies.
+            # @param plugins
+            #   Replacement plugin configuration installed for each new session.
+            # @param setup_commands
+            #   Replacement confidential setup commands, never included in returned resources.
+            # @param skills
+            #   Replacement skill configuration installed for each new session.
             def initialize: (
               environment_template_id: String,
               ?capability_directories: ::Array[String]?,
@@ -77,10 +108,16 @@ module OpenAI
               }
             class Network < OpenAI::Internal::Type::BaseModel
+              # The environment's network access mode.
               attr_accessor access: OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network::access
+              # Domains the environment may access when network access is restricted.
               attr_accessor allowed_domains: ::Array[String]?
+              # @param access
+              #   The environment's network access mode.
+              # @param allowed_domains
+              #   Domains the environment may access when network access is restricted.
               def initialize: (
                 access: OpenAI::Models::Beta::Agents::Environments::TemplateUpdateParams::Network::access,
                 ?allowed_domains: ::Array[String]?
@@ -96,7 +133,7 @@ module OpenAI
               module Access
                 extend OpenAI::Internal::Type::Enum
-                # Allows unrestricted network access, matching an omitted network policy.
+                # Allows unrestricted network access.
                 ENABLED: :enabled
                 # Disables network access.
@@ -117,12 +154,21 @@ module OpenAI
               }
             class Packages < OpenAI::Internal::Type::BaseModel
+              # npm packages to install globally. Defaults to an empty list.
               attr_accessor npm: ::Array[String]?
+              # Python packages to install. Defaults to an empty list.
               attr_accessor python: ::Array[String]?
+              # System packages to install. Defaults to an empty list.
               attr_accessor system_: ::Array[String]?
+              # @param npm
+              #   npm packages to install globally. Defaults to an empty list.
+              # @param python
+              #   Python packages to install. Defaults to an empty list.
+              # @param system_
+              #   System packages to install. Defaults to an empty list.
               def initialize: (
                 ?npm: ::Array[String]?,
                 ?python: ::Array[String]?,

data/sig/openai/models/beta/agents/session_create_params.rbs CHANGED Viewed

@@ -17,24 +17,58 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # An inline execution environment or a reference to an environment template.
           attr_accessor environment: OpenAI::Models::Beta::environment_param
+          # Agent configuration. With `agent_id`, supplied fields override the saved agent
+          # for this session. Without `agent_id`, `model` is required.
           attr_reader agent: OpenAI::Beta::Agents::SessionCreateParams::Agent?
+          # Agent configuration. With `agent_id`, supplied fields override the saved agent
+          # for this session. Without `agent_id`, `model` is required.
           def agent=: (
             OpenAI::Beta::Agents::SessionCreateParams::Agent
           ) -> OpenAI::Beta::Agents::SessionCreateParams::Agent
+          # The ID of a saved reusable agent. Omit `agent` to use its configuration
+          # unchanged.
           attr_reader agent_id: String?
+          # The ID of a saved reusable agent. Omit `agent` to use its configuration
+          # unchanged.
           def agent_id=: (String) -> String
+          # Initial input to submit when the session is created. A string is shorthand for a
+          # single user message. Required when `environment.type` is `none`, or when
+          # `stream` is `true` for an environment that is not `self_hosted`; optional for
+          # self-hosted and non-streaming execution environments.
           attr_accessor input: OpenAI::Models::Beta::Agents::SessionCreateParams::input?
+          # Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+          # characters. Omission or null defaults to an empty map.
           attr_accessor metadata: ::Hash[Symbol, String]?
+          # The IDs of vaults made available to the session.
           attr_accessor vault_ids: ::Array[String]?
+          # @param environment
+          #   An inline execution environment or a reference to an environment template.
+          # @param agent
+          #   Agent configuration. With `agent_id`, supplied fields override the saved agent
+          #   for this session. Without `agent_id`, `model` is required.
+          # @param agent_id
+          #   The ID of a saved reusable agent. Omit `agent` to use its configuration
+          #   unchanged.
+          # @param input
+          #   Initial input to submit when the session is created. A string is shorthand for a
+          #   single user message. Required when `environment.type` is `none`, or when
+          #   `stream` is `true` for an environment that is not `self_hosted`; optional for
+          #   self-hosted and non-streaming execution environments.
+          # @param metadata
+          #   Up to 16 string key-value pairs, with keys up to 64 and values up to 512
+          #   characters. Omission or null defaults to an empty map.
+          # @param vault_ids
+          #   The IDs of vaults made available to the session.
           def initialize: (
             environment: OpenAI::Models::Beta::environment_param,
             ?agent: OpenAI::Beta::Agents::SessionCreateParams::Agent,
@@ -67,22 +101,48 @@ module OpenAI
             }
           class Agent < OpenAI::Internal::Type::BaseModel
+            # Additional instructions appended to the agent's default base instructions. Omit
+            # to leave unchanged.
             attr_accessor instructions: String?
+            # The model to use for the agent. The requested model name is preserved.
             attr_reader model: String?
+            # The model to use for the agent. The requested model name is preserved.
             def model=: (String) -> String
+            # Configuration for creating and coordinating subagents.
             attr_accessor multi_agent: OpenAI::Beta::MultiAgentConfigParam?
+            # Configuration for model reasoning. Omit to keep the current settings; pass
+            # `null` to reset to the model's default effort.
             attr_accessor reasoning: OpenAI::Beta::AgentReasoningParam?
+            # The service tier used for model requests.
             attr_accessor service_tier: OpenAI::Models::Beta::Agents::SessionCreateParams::Agent::service_tier?
+            # Configuration for text generated by the agent.
             attr_accessor text: OpenAI::Beta::AgentTextParam?
+            # Tools available to the agent. Omit to inherit, or pass null to clear them.
             attr_accessor tools: ::Array[OpenAI::Models::Beta::agent_tool_param]?
+            # @param instructions
+            #   Additional instructions appended to the agent's default base instructions. Omit
+            #   to leave unchanged.
+            # @param model
+            #   The model to use for the agent. The requested model name is preserved.
+            # @param multi_agent
+            #   Configuration for creating and coordinating subagents.
+            # @param reasoning
+            #   Configuration for model reasoning. Omit to keep the current settings; pass
+            #   `null` to reset to the model's default effort.
+            # @param service_tier
+            #   The service tier used for model requests.
+            # @param text
+            #   Configuration for text generated by the agent.
+            # @param tools
+            #   Tools available to the agent. Omit to inherit, or pass null to clear them.
             def initialize: (
               ?instructions: String?,
               ?model: String,

data/sig/openai/models/beta/agents/session_list_params.rbs CHANGED Viewed

@@ -15,22 +15,43 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
+          # Return resources after this resource ID in the selected order.
           attr_reader after: String?
+          # Return resources after this resource ID in the selected order.
           def after=: (String) -> String
+          # Only return sessions whose root agent has this ID. Omit to return sessions for
+          # all agents.
           attr_reader agent_id: String?
+          # Only return sessions whose root agent has this ID. Omit to return sessions for
+          # all agents.
           def agent_id=: (String) -> String
+          # The maximum number of resources to return.
           attr_accessor limit: Integer?
+          # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          # `desc` for descending order. Defaults to `desc`.
           attr_reader order: OpenAI::Models::Beta::Agents::SessionListParams::order?
+          # Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          # `desc` for descending order. Defaults to `desc`.
           def order=: (
             OpenAI::Models::Beta::Agents::SessionListParams::order
           ) -> OpenAI::Models::Beta::Agents::SessionListParams::order
+          # @param after
+          #   Return resources after this resource ID in the selected order.
+          # @param agent_id
+          #   Only return sessions whose root agent has this ID. Omit to return sessions for
+          #   all agents.
+          # @param limit
+          #   The maximum number of resources to return.
+          # @param order
+          #   Sort order by the `created_at` timestamp. Use `asc` for ascending order or
+          #   `desc` for descending order. Defaults to `desc`.
           def initialize: (
             ?after: String,
             ?agent_id: String,