Package io.github.stefanbratanov.jvm.openai

Class UploadsClient

java.lang.Object
io.github.stefanbratanov.jvm.openai.UploadsClient
public final class UploadsClient extends Object
Allows you to upload large files in multiple parts.

Based on Uploads

  • Method Details

    • createUpload

      public Upload createUpload(CreateUploadRequest request)
      Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.

      Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.

      Throws:
      OpenAIException - in case of API errors

    • addUploadPart

      public UploadPart addUploadPart(String uploadId, Path data)
      Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload.

      Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.

      It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload.

      Parameters:
      uploadId - The ID of the Upload.
      data - The chunk of bytes for this Part.
      Throws:
      OpenAIException - in case of API errors

    • completeUpload

      public Upload completeUpload(String uploadId, CompleteUploadRequest request)
      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.

      Parameters:
      uploadId - The ID of the Upload.
      Throws:
      OpenAIException - in case of API errors

    • cancelUpload

      public Upload cancelUpload(String uploadId)
      Cancels the Upload. No Parts may be added after an Upload is cancelled.
      Parameters:
      uploadId - The ID of the Upload.
      Throws:
      OpenAIException - in case of API errors