Class: OpenAI::Models::Beta::EnvironmentParam::OpenAIHosted

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/environment_param.rb,
sig/openai/models/beta/environment_param.rbs

Defined Under Namespace

Classes: Network, Packages

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, #inspect, inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(capability_directories: nil, env: nil, environment_template_id: nil, files: nil, network: nil, packages: nil, plugins: nil, setup_commands: nil, skills: nil, type: :openai_hosted) ⇒ Object

Parameters:

  • capability_directories (defaults to: nil) —

    Directories that contain capabilities exposed to the agent. Defaults to an empty list.

  • env (defaults to: nil) —

    Environment variables made available to the agent.

  • environment_template_id (defaults to: nil) —

    A reusable hosted template applied before inline session configuration. Omitted fields inherit the template; network overrides cannot broaden its policy.

  • files (defaults to: nil) —

    Files available before the agent starts. Defaults to an empty list.

  • network (defaults to: nil) —

    Network access policy for the environment. Defaults to disabled for GA requests and enabled for alpha/beta requests.

  • packages (defaults to: nil) —

    Packages to install in the environment. Defaults to empty package lists.

  • plugins (defaults to: nil) —

    Plugins provided as inline ZIP archives. Defaults to an empty list.

  • setup_commands (defaults to: nil) —

    Ordered, confidential setup commands. Command bodies are never returned.

  • skills (defaults to: nil) —

    Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty list.

  • type (defaults to: :openai_hosted) —

    The type of the object. Always openai_hosted.




# File 'lib/openai/models/beta/environment_param.rb', line 118

Instance Attribute Details

#capability_directories ⇒ ::Array[String]?

Directories that contain capabilities exposed to the agent. Defaults to an empty list.

Returns:

  • (::Array[String], nil) 


47
 
# File 'lib/openai/models/beta/environment_param.rb', line 47

optional :capability_directories, OpenAI::Internal::Type::ArrayOf[String], nil?: true

#env ⇒ ::Hash[Symbol, String]?

Environment variables made available to the agent.

Returns:

  • (::Hash[Symbol, String], nil) 


53
 
# File 'lib/openai/models/beta/environment_param.rb', line 53

optional :env, OpenAI::Internal::Type::HashOf[String], nil?: true

#environment_template_id ⇒ String?

A reusable hosted template applied before inline session configuration. Omitted fields inherit the template; network overrides cannot broaden its policy.

Returns:

  • (String, nil) 


60
 
# File 'lib/openai/models/beta/environment_param.rb', line 60

optional :environment_template_id, String

#files ⇒ ::Array[OpenAI::Models::Beta::hosted_environment_file_param]?

Files available before the agent starts. Defaults to an empty list.

Returns:

  • (::Array[OpenAI::Models::Beta::hosted_environment_file_param], nil) 


66
67
68
69
70
 
# File 'lib/openai/models/beta/environment_param.rb', line 66

optional(
  :files,
  -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::HostedEnvironmentFileParam] },
  nil?: true
)

#network ⇒ OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network?

Network access policy for the environment. Defaults to disabled for GA requests and enabled for alpha/beta requests.

Returns:

  • (OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network, nil) 


77
 
# File 'lib/openai/models/beta/environment_param.rb', line 77

optional :network, -> { OpenAI::Beta::EnvironmentParam::OpenAIHosted::Network }, nil?: true

#packages ⇒ OpenAI::Beta::EnvironmentParam::OpenAIHosted::Packages?

Packages to install in the environment. Defaults to empty package lists.

Returns:

  • (OpenAI::Beta::EnvironmentParam::OpenAIHosted::Packages, nil) 


83
 
# File 'lib/openai/models/beta/environment_param.rb', line 83

optional :packages, -> { OpenAI::Beta::EnvironmentParam::OpenAIHosted::Packages }, nil?: true

#plugins ⇒ ::Array[OpenAI::Beta::HostedPluginParam]?

Plugins provided as inline ZIP archives. Defaults to an empty list.

Returns:

  • (::Array[OpenAI::Beta::HostedPluginParam], nil) 


89
90
91
92
93
94
95
 
# File 'lib/openai/models/beta/environment_param.rb', line 89

optional(
  :plugins,
  -> {
    OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::HostedPluginParam]
  },
  nil?: true
)

#setup_commands ⇒ ::Array[OpenAI::Beta::SetupCommandParam]?

Ordered, confidential setup commands. Command bodies are never returned.

Returns:

  • (::Array[OpenAI::Beta::SetupCommandParam], nil) 


101
102
103
104
105
 
# File 'lib/openai/models/beta/environment_param.rb', line 101

optional(
  :setup_commands,
  -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::SetupCommandParam] },
  nil?: true
)

#skills ⇒ ::Array[OpenAI::Models::Beta::hosted_skill_param]?

Skills referenced by ID or provided as inline ZIP archives. Defaults to an empty list.

Returns:

  • (::Array[OpenAI::Models::Beta::hosted_skill_param], nil) 


112
113
114
115
116
 
# File 'lib/openai/models/beta/environment_param.rb', line 112

optional(
  :skills,
  -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::HostedSkillParam] },
  nil?: true
)

#type ⇒ :openai_hosted

The type of the object. Always openai_hosted.

Returns:

  • (:openai_hosted) 


40
 
# File 'lib/openai/models/beta/environment_param.rb', line 40

required :type, const: :openai_hosted

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/environment_param.rb', line 194

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


115
 
# File 'sig/openai/models/beta/environment_param.rbs', line 115

def to_hash: -> {