Class: OpenAI::Models::Beta::Agents::Environments::TemplateCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/beta/agents/environments/template_create_params.rb,
sig/openai/models/beta/agents/environments/template_create_params.rbs

Overview

See Also:

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

Defined Under Namespace

Classes: Network, Packages

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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 ⇒ Object

Parameters:

  • capability_directories —

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

  • env —

    Environment variables made available to the agent.

  • files —

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

  • name —

    An optional human-readable display name for the template.

  • network —

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

  • packages —

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

  • plugins —

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

  • setup_commands —

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

  • skills —

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



75
 
# File 'sig/openai/models/beta/agents/environments/template_create_params.rbs', line 75

def initialize: (

Instance Attribute Details

#capability_directories ⇒ ::Array[String]?

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

Returns:

  • (::Array[String], nil) 


18
 
# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 18

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) 


24
 
# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 24

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

#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) 


30
31
32
33
34
 
# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 30

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

#name ⇒ String?

An optional human-readable display name for the template.

Returns:

  • (String, nil) 


40
 
# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 40

optional :name, String, nil?: true

#network ⇒ OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network?

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

Returns:

  • (OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network, nil) 


47
48
49
50
51
52
53
 
# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 47

optional(
  :network,
  -> {
    OpenAI::Beta::Agents::Environments::TemplateCreateParams::Network
  },
  nil?: true
)

#packages ⇒ OpenAI::Beta::Agents::Environments::TemplateCreateParams::Packages?

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

Returns:

  • (OpenAI::Beta::Agents::Environments::TemplateCreateParams::Packages, nil) 


59
60
61
62
63
64
65
 
# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 59

optional(
  :packages,
  -> {
    OpenAI::Beta::Agents::Environments::TemplateCreateParams::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) 


71
72
73
74
75
76
77
 
# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 71

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) 


83
84
85
86
87
 
# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 83

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) 


94
95
96
97
98
 
# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 94

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/agents/environments/template_create_params.rb', line 171

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


88
 
# File 'sig/openai/models/beta/agents/environments/template_create_params.rbs', line 88

def to_hash: -> {