Package io.github.stefanbratanov.jvm.openai

Class FilesClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.FilesClient

public final class FilesClient
extends Object

Files are used to upload documents that can be used with features like Assistants and Fine-tuning.

Based on Files

Method Summary

Modifier and Type	Method	Description
DeletionStatus	deleteFile(String fileId)	Delete a file
List<File>	listFiles()	Returns a list of files that belong to the user's organization
File	retrieveFile(String fileId)	Returns information about a specific file
byte[]	retrieveFileContent(String fileId)	Returns the contents of the specified file
File	uploadFile(UploadFileRequest request)	Upload a file that can be used across various endpoints.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

uploadFile

public File uploadFile(UploadFileRequest request)

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB.

Throws:

OpenAIException - in case of API errors

listFiles

public List<File> listFiles()

Returns a list of files that belong to the user's organization

Throws:

OpenAIException - in case of API errors

retrieveFile

public File retrieveFile(String fileId)

Returns information about a specific file

Throws:

OpenAIException - in case of API errors

deleteFile

public DeletionStatus deleteFile(String fileId)

Delete a file

Throws:

OpenAIException - in case of API errors

retrieveFileContent

public byte[] retrieveFileContent(String fileId)

Returns the contents of the specified file

Throws:

OpenAIException - in case of API errors