ComPDFKit API
Try Now
On this page

Trim Correction ​

With the Trim Correction tool of ComPDFKit Document AI, you can trim all the extra parts in your Images. The following examples show how to upload a JPG file and run the Trim Correction feature using Java, PHP, C#, Python, and Swift programming languages. Then, output a JSON file.

Java
// Create a client
CPDFClient client = new CPDFClient(publicKey,secretKey);

// Create a task
// Create an example of a DocumentAI Trim Correction task
CPDFCreateTaskResult result = client.createTask(CPDFDocumentAIEnum.DEWARP);

// Get a task id
String taskId = result.getTaskId();

// File handling parameter settings
CPDFTrimCorrectionParameter fileParameter = new CPDFTrimCorrectionParameter();

// Upload files
client.uploadFile(new File("test.jpg"), taskId, fileParameter);

// Execute task
client.executeTask(taskId);

// Query TaskInfo
CPDFTaskInfoResult taskInfo = client.getTaskInfo(taskId);
PHP
// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a DocumentAI Trim Correction task
$taskInfo = $client->createTask(CPDFDocumentAI::DEWARP);

// Upload files
$fileInfo = $client->addFile('test.jpg')->uploadFile($taskInfo['taskId']);

// Execute task
$client->executeTask($taskInfo['taskId']);

// Query TaskInfo
$taskInfo = $client->getTaskInfo($taskInfo['taskId']);
C#
// Create a client
CPDFClient client = new CPDFClient(publicKey,secretKey);

// Create a task
// Create an example of a DocumentAI Trim Correction task
CPDFCreateTaskResult result = client.CreateTask(CPDFDocumentAIEnum.DEWARP);

// Get a task id
string taskId = result.TaskId;

// File handling parameter settings
CPDFTrimCorrectionParameter fileParameter = new CPDFTrimCorrectionParameter();

// Upload files
client.UploadFile(new FileInfo("test.jpg"), taskId, fileParameter);

// Execute task
client.ExecuteTask(taskId);

// Query TaskInfo
CPDFTaskInfoResult taskInfo = client.GetTaskInfo(taskId);
Python
# Create a client
client = CPDFClient(public_key, secret_key)

# Create a task
# Create an example of a DocumentAI Trim Correction task
create_task_result = client.create_task(CPDFDocumentAIEnum.DEWARP)

# Get a task id
task_id = create_task_result.task_id

# File handling parameter settings
file_parameter = CPDFTrimCorrectionParameter()

# Upload files
client.upload_file('test.jpg', task_id, file_parameter)

# Execute task
client.execute_task(task_id)

# Query TaskInfo
task_info = client.get_task_info(task_id)
Swift
// Create a client
let client: CPDFClient = CPDFClient(publicKey: public_key, secretKey: secret_key)

Task { @MainActor in
    // Create a task
    // Create an example of a DocumentAI Trim Correction task
    let taskModel = await client.createTask(url: CPDFDocumentAI.DEWARP)
    
    // Get a task id
    let taskId = taskModel?.taskId ?? ""

    // Upload files
    let path = Bundle.main.path(forResource: "test2", ofType: "jpg")
    let uploadFileModel = await client.uploadFile(filepath: path ?? "", params: [:], taskId: taskId)
    
    // Execute task
    let _ = await client.processFiles(taskId: taskId)
    
    // Query TaskInfo
    let taskInfoModel = await client.getTaskInfo(taskId: taskId)
}

Result:

File TypeDescription
.pngThe image file after edge trimming correction.