Class: OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate

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

Overview

See Also:

  • OpenAI::Resources::Beta::Agents::Environments::Templates#create

Defined Under Namespace

Modules: File, Skill 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(npm:, python:, system_:) ⇒ Object

Packages installed in each fresh OpenAI-hosted environment.

Parameters:

  • npm (Array<String>) —

    npm packages installed globally in the environment.

  • python (Array<String>) —

    Python packages installed in the environment.

  • system_ (Array<String>) —

    System packages installed in the environment.




# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 86

Instance Attribute Details

#capability_directories ⇒ Array<String>

Directories that expose capabilities to the agent.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


20
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 20

required :capability_directories, OpenAI::Internal::Type::ArrayOf[String]

#created_at ⇒ Integer

The Unix timestamp, in seconds, when the template was created.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


26
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 26

required :created_at, Integer

#files ⇒ Array<OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::File::FileID, OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::File::Inline>

Safe file metadata, excluding contents and session-scoped file IDs.

Parameters:

  • value (::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::file])

Returns:



32
33
34
35
36
37
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 32

required(
  :files,
  -> {
    OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::File]
  }
)

#id ⇒ String

The ID of the reusable environment template.

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 14

required :id, String

#name ⇒ String?

An optional human-readable display name for the template.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


43
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 43

required :name, String, nil?: true

#network ⇒ OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::Network

Runtime network access for each OpenAI-hosted environment.

Parameters:

  • value (OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Network)

Returns:



49
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 49

required :network, -> { OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Network }

#object ⇒ Symbol, :"agent.environment.template"

The object type. Always agent.environment.template.

Parameters:

  • value (:"agent.environment.template")

Returns:

  • (Symbol, :"agent.environment.template") 


55
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 55

required :object, const: :"agent.environment.template"

#packages ⇒ OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::Packages

Packages installed in each fresh OpenAI-hosted environment.

Parameters:

  • value (OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Packages)

Returns:



61
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 61

required :packages, -> { OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Packages }

#plugins ⇒ Array<OpenAI::Models::Beta::HostedPlugin>

Safe plugin metadata, excluding inline archive contents.

Parameters:

  • value (::Array[OpenAI::Beta::HostedPlugin])

Returns:



67
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 67

required :plugins, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::HostedPlugin] }

#skills ⇒ Array<OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::Skill::SkillReference, OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::Skill::Inline>

Safe skill metadata, preserving unresolved version selectors.

Parameters:

  • value (::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::skill])

Returns:



73
74
75
76
77
78
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 73

required(
  :skills,
  -> {
    OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::Agents::Environments::EnvironmentTemplate::Skill]
  }
)

#updated_at ⇒ Integer

The Unix timestamp, in seconds, when the template was last updated.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


84
 
# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 84

required :updated_at, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 241

.variants ⇒ Array(OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::File::FileID, OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::File::Inline)

Returns:




# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 199

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


60
 
# File 'sig/openai/models/beta/agents/environments/environment_template.rbs', line 60

def to_hash: -> {