openAIUploadFileRequest

Builds an OpenAIUploadFileRequest using a DSL-style builder.

Return

A fully-formed OpenAIUploadFileRequest.

Parameters

purpose

The intended purpose of the file. Defaults to OpenAIFilePurpose.FINE_TUNE.

block

Lambda for configuring the upload request.

Throws

Samples

// Creating openAI upload file request with DSL:
val uploadFileRequest = openAIUploadFileRequest(
    // You can set purpose using `purpose` field, example: purpose = OpenAIFilePurpose.FINE_TUNE
) {
    fileFromPath("path/to/file.ext") // This function load file from path.
}

// Example: send file request to OpenAI.
val response = client.uploadOpenAIFile(uploadFileRequest)