Class: OpenAI::Resources::Containers::Files

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

Defined Under Namespace

Classes: Content

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Files

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

Parameters:



136
137
138
139
 
# File 'lib/openai/resources/containers/files.rb', line 136

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

Instance Attribute Details

#content ⇒ OpenAI::Resources::Containers::Files::Content (readonly)

Returns:



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

def content
  @content
end

Instance Method Details

#create(container_id, file: nil, file_id: nil, request_options: {}) ⇒ OpenAI::Models::Containers::FileCreateResponse

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

Create a Container File

You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.

String, StringIO, and pathless IO inputs are sent with generic upload metadata. Use OpenAI::FilePart when you need to override the filename or content type.

Parameters:

  • container_id (String)
  • file (Pathname, StringIO, IO, String, OpenAI::FilePart) —

    The File object (not file name) to be uploaded.

  • file_id (String) —

    Name of the file to create.

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

Returns:

See Also:



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/openai/resources/containers/files.rb', line 35

def create(container_id, params = {})
  parsed, options = OpenAI::Containers::FileCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["containers/%1$s/files", container_id],
    body: parsed,
    model: OpenAI::Models::Containers::FileCreateResponse,
    security: {bearer_auth: true},
    options: options
  )
end

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

Delete Container File

Parameters:

Returns:

  • (nil)

See Also:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/openai/resources/containers/files.rb', line 118

def delete(file_id, params)
  parsed, options = OpenAI::Containers::FileDeleteParams.dump_request(params)
  container_id =
    parsed.delete(:container_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["containers/%1$s/files/%2$s", container_id, file_id],
    model: NilClass,
    security: {bearer_auth: true},
    options: options
  )
end

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

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

List Container files

Parameters:

  • container_id (String)
  • 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::Containers::FileListParams::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:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/openai/resources/containers/files.rb', line 93

def list(container_id, params = {})
  parsed, options = OpenAI::Containers::FileListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["containers/%1$s/files", container_id],
    query: query,
    page: OpenAI::Internal::CursorPage,
    model: OpenAI::Models::Containers::FileListResponse,
    security: {bearer_auth: true},
    options: options
  )
end

#retrieve(file_id, container_id:, request_options: {}) ⇒ OpenAI::Models::Containers::FileRetrieveResponse

Retrieve Container File

Parameters:

Returns:

See Also:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/openai/resources/containers/files.rb', line 58

def retrieve(file_id, params)
  parsed, options = OpenAI::Containers::FileRetrieveParams.dump_request(params)
  container_id =
    parsed.delete(:container_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["containers/%1$s/files/%2$s", container_id, file_id],
    model: OpenAI::Models::Containers::FileRetrieveResponse,
    security: {bearer_auth: true},
    options: options
  )
end