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

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

Defined Under Namespace

Classes: Files, Templates

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Environments

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 Environments.

Parameters:



41
42
43
44
45
 
# File 'lib/openai/resources/beta/agents/environments.rb', line 41

def initialize(client:)
  @client = client
  @files = OpenAI::Resources::Beta::Agents::Environments::Files.new(client: client)
  @templates = OpenAI::Resources::Beta::Agents::Environments::Templates.new(client: client)
end

Instance Attribute Details

#files ⇒ OpenAI::Resources::Beta::Agents::Environments::Files (readonly)

Returns:



9
10
11
 
# File 'lib/openai/resources/beta/agents/environments.rb', line 9

def files
  @files
end

#templates ⇒ OpenAI::Resources::Beta::Agents::Environments::Templates (readonly)

Returns:



12
13
14
 
# File 'lib/openai/resources/beta/agents/environments.rb', line 12

def templates
  @templates
end

Instance Method Details

#retrieve(environment_id, request_options: {}) ⇒ OpenAI::Models::Beta::Agents::EnvironmentInfo

Retrieves an execution environment's connection status and safe installed metadata. See environment lifecycle.

Parameters:

  • environment_id (String) —

    The ID of the environment.

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

Returns:

See Also:



28
29
30
31
32
33
34
35
36
 
# File 'lib/openai/resources/beta/agents/environments.rb', line 28

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