openai-core/com.aallam.openai.api.file

Package-level declarations

Types

@Serializable

data class File(val id: FileId, val bytes: Int, val createdAt: Long, val filename: String, val purpose: Purpose, val status: Status? = null, val format: String? = null, val statusDetails: String? = null)

File details.

FileId

@Serializable

@JvmInline

value class FileId(val id: String)

File identifier.

FileSource

class FileSource(val name: String, val source: RawSource)

Represents a file resource.

FileSourceBuilder

class FileSourceBuilder

Builder of FileSource instances.

FileStatus

@Serializable

@JvmInline

value class FileStatus(val raw: String)

File status.

FileUpload

class FileUpload(val file: FileSource, val purpose: Purpose)

Request to upload a file.

FileUploadBuilder

class FileUploadBuilder

Builders of FileUpload instances.

Purpose

@Serializable

@JvmInline

value class Purpose(val raw: String)

File purpose.

Functions

fileSource

fun fileSource(block: FileSourceBuilder.() -> Unit): FileSource

Represents a file resource.

fileUpload

fun fileUpload(block: FileUploadBuilder.() -> Unit): FileUpload

Request to upload a file.