Class: OpenAI::Resources::Containers

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/containers.rb,
lib/openai/resources/containers/files.rb,
lib/openai/resources/containers/files/content.rb

Defined Under Namespace

Classes: Files

Instance Attribute Summary collapse

Instance Method Summary collapse

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:



107
108
109
110
 
# File 'lib/openai/resources/containers.rb', line 107

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

Instance Attribute Details

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

Returns:



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

def files
  @files
end

Instance Method Details

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

Create Container

Parameters:

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/openai/resources/containers.rb', line 24

def create(params)
  parsed, options = OpenAI::ContainerCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "containers",
    body: parsed,
    model: OpenAI::Models::ContainerCreateResponse,
    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:



95
96
97
98
99
100
101
102
 
# File 'lib/openai/resources/containers.rb', line 95

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

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

Some parameter documentations has been truncated, see Models::ContainerListParams for more details.

List Containers

Parameters:

  • after (String) —

    A cursor for use in pagination. ‘after` is an object ID that defines your place

  • limit (Integer) —

    A limit on the number of objects to be returned. Limit can range between 1 and 1

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

    Sort order by the ‘created_at` timestamp of the objects. `asc` for ascending ord

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

Returns:

See Also:



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/openai/resources/containers.rb', line 72

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

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

Retrieve Container

Parameters:

Returns:

See Also:



45
46
47
48
49
50
51
52
 
# File 'lib/openai/resources/containers.rb', line 45

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