Class: OpenAI::Resources::Beta::Agents::Environments::Templates

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/beta/agents/environments/templates.rb,
sig/openai/resources/beta/agents/environments/templates.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Templates

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Templates.

Parameters:



201
202
203
 
# File 'lib/openai/resources/beta/agents/environments/templates.rb', line 201

def initialize(client:)
  @client = client
end

Instance Method Details

#create(capability_directories: nil, env: nil, files: nil, name: nil, network: nil, packages: nil, plugins: nil, setup_commands: nil, skills: nil, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate

Creates reusable environment configuration without returning confidential setup commands or environment values. See reusing a hosted setup.

Parameters:

Returns:

See Also:



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/openai/resources/beta/agents/environments/templates.rb', line 50

def create(params = {})
  parsed, options = OpenAI::Beta::Agents::Environments::TemplateCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "agents/environments/templates",
    body: parsed,
    model: OpenAI::Beta::Agents::Environments::EnvironmentTemplate,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end

#delete(environment_template_id, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplateDeleted

Deletes reusable environment configuration and all confidential template inputs. See reusing a hosted setup.

Parameters:

  • environment_template_id (String) —

    The ID of the reusable environment template.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



188
189
190
191
192
193
194
195
196
 
# File 'lib/openai/resources/beta/agents/environments/templates.rb', line 188

def delete(environment_template_id, params = {})
  @client.request(
    method: :delete,
    path: ["agents/environments/templates/%1$s", environment_template_id],
    model: OpenAI::Beta::Agents::Environments::EnvironmentTemplateDeleted,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
  )
end

#list(after: nil, limit: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate>

Lists reusable environment templates without returning confidential values. See reusing a hosted setup.

Parameters:

Returns:

See Also:



160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/openai/resources/beta/agents/environments/templates.rb', line 160

def list(params = {})
  parsed, options = OpenAI::Beta::Agents::Environments::TemplateListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "agents/environments/templates",
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Beta::Agents::Environments::EnvironmentTemplate,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end

#retrieve(environment_template_id, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate

Retrieves reusable environment configuration without returning confidential values. See reusing a hosted setup.

Parameters:

  • environment_template_id (String) —

    The ID of the reusable environment template.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



76
77
78
79
80
81
82
83
84
 
# File 'lib/openai/resources/beta/agents/environments/templates.rb', line 76

def retrieve(environment_template_id, params = {})
  @client.request(
    method: :get,
    path: ["agents/environments/templates/%1$s", environment_template_id],
    model: OpenAI::Beta::Agents::Environments::EnvironmentTemplate,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **params[:request_options].to_h}
  )
end

#update(environment_template_id, capability_directories: nil, env: nil, files: nil, name: nil, network: nil, packages: nil, plugins: nil, setup_commands: nil, skills: nil, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate

Updates reusable environment configuration without returning confidential values. See reusing a hosted setup.

Parameters:

Returns:

See Also:



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/openai/resources/beta/agents/environments/templates.rb', line 129

def update(environment_template_id, params = {})
  parsed, options = OpenAI::Beta::Agents::Environments::TemplateUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["agents/environments/templates/%1$s", environment_template_id],
    body: parsed,
    model: OpenAI::Beta::Agents::Environments::EnvironmentTemplate,
    security: {bearer_auth: true},
    options: {extra_headers: {"OpenAI-Beta" => "agents=v1"}, **options}
  )
end