Complete upload
Upload uploads().complete(UploadCompleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
post /uploads/{upload_id}/complete
Completes the Upload.
Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform.
You can specify the order of the Parts by passing in an ordered list of the Part IDs.
The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
Returns the Upload object with status completed, including an additional file property containing the created usable File object.
Parameters
-
UploadCompleteParams params-
Optional<String> uploadId -
List<String> partIdsThe ordered list of Part IDs.
-
Optional<String> md5The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.
-
Returns
-
class Upload:The Upload object can accept byte chunks in the form of Parts.
-
String idThe Upload unique identifier, which can be referenced in API endpoints.
-
long bytesThe intended number of bytes to be uploaded.
-
long createdAtThe Unix timestamp (in seconds) for when the Upload was created.
-
long expiresAtThe Unix timestamp (in seconds) for when the Upload will expire.
-
String filenameThe name of the file to be uploaded.
-
JsonValue; object_ "upload"constantThe object type, which is always "upload".
UPLOAD("upload")
-
String purposeThe intended purpose of the file. Please refer here for acceptable values.
-
Status statusThe status of the Upload.
-
PENDING("pending") -
COMPLETED("completed") -
CANCELLED("cancelled") -
EXPIRED("expired")
-
-
Optional<FileObject> fileThe
Fileobject represents a document that has been uploaded to OpenAI.-
String idThe file identifier, which can be referenced in the API endpoints.
-
long bytesThe size of the file, in bytes.
-
long createdAtThe Unix timestamp (in seconds) for when the file was created.
-
String filenameThe name of the file.
-
JsonValue; object_ "file"constantThe object type, which is always
file.FILE("file")
-
Purpose purposeThe intended purpose of the file. Supported values are
assistants,assistants_output,batch,batch_output,fine-tune,fine-tune-results,vision, anduser_data.-
ASSISTANTS("assistants") -
ASSISTANTS_OUTPUT("assistants_output") -
BATCH("batch") -
BATCH_OUTPUT("batch_output") -
FINE_TUNE("fine-tune") -
FINE_TUNE_RESULTS("fine-tune-results") -
VISION("vision") -
USER_DATA("user_data")
-
-
Status statusDeprecated. The current status of the file, which can be either
uploaded,processed, orerror.-
UPLOADED("uploaded") -
PROCESSED("processed") -
ERROR("error")
-
-
Optional<Long> expiresAtThe Unix timestamp (in seconds) for when the file will expire.
-
Optional<String> statusDetailsDeprecated. For details on why a fine-tuning training file failed validation, see the
errorfield onfine_tuning.job.
-
-
Example
package com.openai.example;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.uploads.Upload;
import com.openai.models.uploads.UploadCompleteParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
UploadCompleteParams params = UploadCompleteParams.builder()
.uploadId("upload_abc123")
.addPartId("string")
.build();
Upload upload = client.uploads().complete(params);
}
}
Response
{
"id": "id",
"bytes": 0,
"created_at": 0,
"expires_at": 0,
"filename": "filename",
"object": "upload",
"purpose": "purpose",
"status": "pending",
"file": {
"id": "id",
"bytes": 0,
"created_at": 0,
"filename": "filename",
"object": "file",
"purpose": "assistants",
"status": "uploaded",
"expires_at": 0,
"status_details": "status_details"
}
}