Alibaba Cloud Model Studio:Use API to upload files

About online debugging and sample code

You can debug online and generate multi-language code samples in real-time.

The FileName field must match the document name

The FileName in the request parameters of ApplyFileUploadLease must match the actual document name, including the suffix. Otherwise an error will occur.

About the MD5 field value

The Md5 in the request parameters of ApplyFileUploadLease represents the MD5 hash of your document. It is used for integrity verification. You can use hashlib of Python or MessageDigest of Java to calculate this value. Use similar methods for other languages.

Expand the panel below to view sample code for generating document MD5 value in Python and Java.

# Sample code is for reference only. Do not use it directly in production environments
import hashlib
def calculate_md5(file_path):
    """Calculate the MD5 value of a document.

    Args:
        file_path (str): The path of the document.

    Returns:
        str: The MD5 value of the document.
    """
    md5_hash = hashlib.md5()

    # Read the file in binary form
    with open(file_path, "rb") as f:
        # Read the file in chunks to avoid excessive memory usage for large files
        for chunk in iter(lambda: f.read(4096), b""):
            md5_hash.update(chunk)

    return md5_hash.hexdigest()

# Usage example
file_path = "Replace with the actual local path of the document you need to upload, for example, /Users/Bailian/Desktop/Bailian Series Mobile Product Introduction.docx"
md5_value = calculate_md5(file_path)
print(f"The MD5 value of the document is: {md5_value}")

// Sample code is for reference only. Do not use it directly in production environments
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.security.MessageDigest;

public class Md5Utils {

    private static String getFileMd5(String filePath) throws Exception {
        MessageDigest digest = MessageDigest.getInstance("MD5");
        try (InputStream is = Files.newInputStream(Paths.get(filePath))) {
            byte[] buffer = new byte[1024];
            int read;
            while ((read = is.read(buffer)) > 0) {
                digest.update(buffer, 0, read);
            }
        }
        byte[] md5Bytes = digest.digest();

        StringBuilder md5String = new StringBuilder();
        for (byte b : md5Bytes) {
            md5String.append(String.format("%02x", b));
        }

        return md5String.toString();
    }

    public static void main(String[] args) throws Exception {

        String filePath = "Replace with the actual local path of the document you need to upload, for example, /Users/Bailian/Desktop/Bailian Series Mobile Product Introduction.docx";
        String md5 = getFileMd5(filePath);

        System.out.println("The MD5 value of the document is: " + md5);
    }
}

The above sample code returns the MD5 value of the target document. For example:

The MD5 value of the document is: c0c07fb456057128540a91ea9b06666c

Sample response for a successful ApplyFileUploadLease call

• Keep the values of Data.FileUploadLeaseId, Data.Param.Method, Data.Param.Url, as well as X-bailian-extra and Content-Type of Data.Param.Headers from the response for later use.

• Data.Param.Url is the lease. It is valid for a few minutes. Upload the document promptly.

• To update a document in the knowledge base, call ApplyFileUploadLease again for a new set of request parameters. Take the following steps to upload the updated document and then, import it into the knowledge base.

{
  "RequestId": "778C0B3B-59C2-5FC1-A947-36EDD1xxxxxx",
  "Success": true,
  "Message": "",
  "Code": "success",
  "Status": "200",
  "Data": {
    "FileUploadLeaseId": "1e6a159107384782be5e45ac4759b247.1719325231035",
    "Type": "HTTP",
    "Param": {
      "Method": "PUT",
      "Url": "https://bailian-datahub-data-origin-prod.oss-cn-hangzhou.aliyuncs.com/1005426495169178/10024405/68abd1dea7b6404d8f7d7b9f7fbd332d.1716698936847.pdf?Expires=1716699536&OSSAccessKeyId=TestID&Signature=HfwPUZo4pR6DatSDym0zFKVh9Wg%3D",
      "Headers": "        \"X-bailian-extra\": \"MTAwNTQyNjQ5NTE2OTE3OA==\",\n        \"Content-Type\": \"application/pdf\""
    }
  }
}

No online debugging

This step's code is not included in the SDK, so online debugging and automatic generation of multi-language sample code are not available. You need to manually write the code, referring to the sample code below.

About pre_signed_url

The pre_signed_url shown in the sample code below represents the Url field in Data.Param returned by ApplyFileUploadLease in step 1.

About online debugging and sample code

You can debug online and generate multi-language code samples in real-time.

About LeaseId in the request parameters

The LeaseId in the request parameters of AddFile is the Data.FileUploadLeaseId returned by ApplyFileUploadLease.

About CategoryType in the request parameters

Because the document is for knowledge base building, CategoryType can be omitted or set to UNSTRUCTURED.

Do not submit again

Once AddFile is successfully called, the LeaseId becomes invalid immediately. Do not resubmit using the same lease ID.

About online debugging and sample code

You can debug online and generate multi-language code samples in real-time.