Class: OpenAI::Resources::Containers

Inherits:

Object

• Object
• OpenAI::Resources::Containers

Defined in:

lib/openai/resources/containers.rb,
lib/openai/resources/containers/files.rb,
lib/openai/resources/containers/files/content.rb,
sig/openai/resources/containers.rbs,
sig/openai/resources/containers/files.rbs,
sig/openai/resources/containers/files/content.rbs

Defined Under Namespace

Classes: Files

Instance Attribute Summary

• #files ⇒ OpenAI::Resources::Containers::Files readonly

Instance Method Summary

• #create(name:, expires_after: nil, file_ids: nil, memory_limit: nil, network_policy: nil, skills: nil, request_options: {}) ⇒ OpenAI::Models::ContainerCreateResponse

  Create Container.

• #delete(container_id, request_options: {}) ⇒ nil

  Delete Container.

• #initialize(client:) ⇒ Containers constructor private

  A new instance of Containers.

• #list(after: nil, limit: nil, name: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::ContainerListResponse>

  List Containers.

• #retrieve(container_id, request_options: {}) ⇒ OpenAI::Models::ContainerRetrieveResponse

  Retrieve Container.

Constructor Details

#initialize(client:) ⇒ Containers

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

Parameters:

• client (OpenAI::Client)
• client: (OpenAI::Client)

# File 'lib/openai/resources/containers.rb', line 133

def initialize(client:)
  @client = client
  @files = OpenAI::Resources::Containers::Files.new(client: client)
end

Instance Attribute Details

#files ⇒ OpenAI::Resources::Containers::Files (readonly)

Returns:

• (OpenAI::Resources::Containers::Files)

# File 'lib/openai/resources/containers.rb', line 7

def files
  @files
end

Instance Method Details

#create(name:, expires_after: nil, file_ids: nil, memory_limit: nil, network_policy: nil, skills: nil, request_options: {}) ⇒ OpenAI::Models::ContainerCreateResponse

Create Container

Parameters:

• name (String) —

  Name of the container to create.

• expires_after (OpenAI::Models::ContainerCreateParams::ExpiresAfter) —

  Container expiration time in seconds relative to the 'anchor' time.

• file_ids (Array<String>) —

  IDs of files to copy to the container.

• memory_limit (Symbol, OpenAI::Models::ContainerCreateParams::MemoryLimit) —

  Optional memory limit for the container. Defaults to "1g".

• network_policy (OpenAI::Models::Responses::ContainerNetworkPolicyDisabled, OpenAI::Models::Responses::ContainerNetworkPolicyAllowlist) —

  Network access policy for the container.

• skills (Array<OpenAI::Models::Responses::SkillReference, OpenAI::Models::Responses::InlineSkill>) —

  An optional list of skills referenced by id or inline data.

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

Returns:

• (OpenAI::Models::ContainerCreateResponse)

See Also:

• Models::ContainerCreateParams

# File 'lib/openai/resources/containers.rb', line 36

def create(params)
  parsed, options = OpenAI::ContainerCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "containers",
    body: parsed,
    model: OpenAI::Models::ContainerCreateResponse,
    security: {bearer_auth: true},
    options: options
  )
end

#delete(container_id, request_options: {}) ⇒ nil

Delete Container

Parameters:

• container_id (String) —

  The ID of the container to delete.

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

Returns:

• (nil)

See Also:

• Models::ContainerDeleteParams

# File 'lib/openai/resources/containers.rb', line 120

def delete(container_id, params = {})
  @client.request(
    method: :delete,
    path: ["containers/%1$s", container_id],
    model: NilClass,
    security: {bearer_auth: true},
    options: params[:request_options]
  )
end

#list(after: nil, limit: nil, name: nil, order: nil, request_options: {}) ⇒ OpenAI::Internal::CursorPage<OpenAI::Models::ContainerListResponse>

List Containers

Parameters:

• after (String) —

  A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

• limit (Integer) —

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• name (String) —

  Filter results by container name.

• order (Symbol, OpenAI::Models::ContainerListParams::Order) —

  Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

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

Returns:

• (OpenAI::Internal::CursorPage<OpenAI::Models::ContainerListResponse>)

See Also:

• Models::ContainerListParams

# File 'lib/openai/resources/containers.rb', line 94

def list(params = {})
  parsed, options = OpenAI::ContainerListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "containers",
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Models::ContainerListResponse,
    security: {bearer_auth: true},
    options: options
  )
end

#retrieve(container_id, request_options: {}) ⇒ OpenAI::Models::ContainerRetrieveResponse

Retrieve Container

Parameters:

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

Returns:

• (OpenAI::Models::ContainerRetrieveResponse)

See Also:

• Models::ContainerRetrieveParams

# File 'lib/openai/resources/containers.rb', line 58

def retrieve(container_id, params = {})
  @client.request(
    method: :get,
    path: ["containers/%1$s", container_id],
    model: OpenAI::Models::ContainerRetrieveResponse,
    security: {bearer_auth: true},
    options: params[:request_options]
  )
end