Class: OpenAI::Resources::Files

Inherits:

Object

• Object
• OpenAI::Resources::Files

Defined in:

lib/openai/resources/files.rb

Instance Method Summary

• #content(file_id, request_options: {}) ⇒ StringIO

  Returns the contents of the specified file.

• #create(file:, purpose:, expires_after: nil, request_options: {}) ⇒ OpenAI::Models::FileObject

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

• #delete(file_id, request_options: {}) ⇒ OpenAI::Models::FileDeleted

  Delete a file and remove it from all vector stores.

• #initialize(client:) ⇒ Files constructor private

  A new instance of Files.

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

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

• #retrieve(file_id, request_options: {}) ⇒ OpenAI::Models::FileObject

  Returns information about a specific file.

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:

• client (OpenAI::Client)

# File 'lib/openai/resources/files.rb', line 151

def initialize(client:)
  @client = client
end

Instance Method Details

#content(file_id, request_options: {}) ⇒ StringIO

Returns the contents of the specified file.

Parameters:

• file_id (String) —

  The ID of the file to use for this request.

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

Returns:

• (StringIO)

See Also:

• Models::FileContentParams

# File 'lib/openai/resources/files.rb', line 138

def content(file_id, params = {})
  @client.request(
    method: :get,
    path: ["files/%1$s/content", file_id],
    headers: {"accept" => "application/binary"},
    model: StringIO,
    options: params[:request_options]
  )
end

#create(file:, purpose:, expires_after: nil, request_options: {}) ⇒ OpenAI::Models::FileObject

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

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and each project can store up to 2.5 TB of files in total. There is no organization-wide storage limit.

• The Assistants API supports files up to 2 million tokens and of specific file types. See the [Assistants Tools guide](platform.openai.com/docs/assistants/tools) for details.

• The Fine-tuning API only supports ‘.jsonl` files. The input also has certain required formats for fine-tuning [chat](platform.openai.com/docs/api-reference/fine-tuning/chat-input) or [completions](platform.openai.com/docs/api-reference/fine-tuning/completions-input) models.

• The Batch API only supports ‘.jsonl` files up to 200 MB in size. The input also has a specific required [format](platform.openai.com/docs/api-reference/batch/request-input).

Please [contact us](help.openai.com/) if you need to increase these storage limits.

Parameters:

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

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

• purpose (Symbol, OpenAI::Models::FilePurpose) —

  The intended purpose of the uploaded file. One of:

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

  The expiration policy for a file. By default, files with ‘purpose=batch` expire

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

Returns:

• (OpenAI::Models::FileObject)

See Also:

• Models::FileCreateParams

# File 'lib/openai/resources/files.rb', line 43

def create(params)
  parsed, options = OpenAI::FileCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "files",
    headers: {"content-type" => "multipart/form-data"},
    body: parsed,
    model: OpenAI::FileObject,
    options: options
  )
end

#delete(file_id, request_options: {}) ⇒ OpenAI::Models::FileDeleted

Delete a file and remove it from all vector stores.

Parameters:

• file_id (String) —

  The ID of the file to use for this request.

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

Returns:

• (OpenAI::Models::FileDeleted)

See Also:

• Models::FileDeleteParams

# File 'lib/openai/resources/files.rb', line 118

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

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

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

Returns a list of files.

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::FileListParams::Order) —

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

• purpose (String) —

  Only return files with the given purpose.

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

Returns:

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

See Also:

• Models::FileListParams

# File 'lib/openai/resources/files.rb', line 95

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

#retrieve(file_id, request_options: {}) ⇒ OpenAI::Models::FileObject

Returns information about a specific file.

Parameters:

• file_id (String) —

  The ID of the file to use for this request.

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

Returns:

• (OpenAI::Models::FileObject)

See Also:

• Models::FileRetrieveParams

# File 'lib/openai/resources/files.rb', line 66

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