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

An OpenAI-hosted environment, optionally based on a reusable template.

Parameters:




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

Instance Attribute Details

#capability_directories ⇒ Array<String>?

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

Parameters:

  • value (::Array[String], nil)

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.

Parameters:

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

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.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :environment_template_id, String

#files ⇒ Array<OpenAI::Models::Beta::HostedEnvironmentFileParam::FileID, OpenAI::Models::Beta::HostedEnvironmentFileParam::Inline>?

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

Parameters:

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

Returns:



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::Models::Beta::EnvironmentParam::OpenAIHosted::Network?

Network access for an OpenAI-hosted environment.

Parameters:

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

Returns:



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

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

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

Packages to install in an OpenAI-hosted environment.

Parameters:

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

Returns:



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

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

#plugins ⇒ Array<OpenAI::Models::Beta::HostedPluginParam>?

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

Parameters:

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

Returns:



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

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

#setup_commands ⇒ Array<OpenAI::Models::Beta::SetupCommandParam>?

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

Parameters:

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

Returns:



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

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

#skills ⇒ Array<OpenAI::Models::Beta::HostedSkillParam::SkillReference, OpenAI::Models::Beta::HostedSkillParam::Inline>?

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

Parameters:

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

Returns:



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

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

#type ⇒ Symbol, :openai_hosted

The type of the object. Always openai_hosted.

Parameters:

  • value (:openai_hosted)

Returns:

  • (Symbol, :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 191

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {