ChatGPT-Java-API/com.cjcrafter.openai.files

Package-level declarations

Types

FileDeletionStatus

data class FileDeletionStatus(val id: String, val deleted: Boolean)

The returned result after attempting to delete a file.

interface FileHandler

Represents the handler for the files endpoint. This class holds all the actions that can be performed on a file.

FileHandlerImpl

class FileHandlerImpl(requestHelper: RequestHelper, endpoint: String) : FileHandler

data class FileObject(val id: String, val bytes: Int, val createdAt: Int, val fileName: String, val purpose: FilePurpose)

Represents a file uploaded to the OpenAI API.

enum FilePurpose : Enum<FilePurpose>

Represents the reason a file was uploaded to the OpenAI API.

ListFilesRequest

data class ListFilesRequest

Represents a request to the list files endpoint.

ListFilesResponse

data class ListFilesResponse(val hasMore: Boolean, val data: List<FileObject>)

Represents a response from the list files endpoint.

UploadFileRequest

data class UploadFileRequest

Functions

listFilesRequest

fun listFilesRequest(block: ListFilesRequest.Builder.() -> Unit): ListFilesRequest

Creates an ListFilesRequest using the ListFilesRequest.Builder using Kotlin DSL.

uploadFileRequest

fun uploadFileRequest(block: UploadFileRequest.Builder.() -> Unit): UploadFileRequest