FieldLabel Object Members for SuiteScript 2.1

TL;DR Opening

The FieldLabel Object in SuiteScript 2.1 introduces two key properties: confidence and name, which facilitate the reliable extraction of field labels from documents. Utilizing these properties can greatly improve the accuracy of automated document processing in your scripts.

What are FieldLabel Object Members?

The FieldLabel object encompasses essential properties used in server scripts to evaluate and handle field labels derived from documents processed through the document capture functionality. The two main properties of the FieldLabel object are:

FieldLabel Properties

Understanding the Confidence Level

The confidence property is a numerical indicator (between 0 and 1) that reflects how accurate the system believes the extracted name is. For example:

• A confidence of 0.95 signifies a 95% certainty in the accuracy of the name.
• This value can guide script decisions; set a threshold (like 0.90) to only accept highly confident name extractions, thus reducing potential errors.

Example Syntax

Below is a sample code snippet demonstrating how to utilize the FieldLabel object properties in SuiteScript:

1// Add additional code
2...
3 
4const extractedData = documentCapture.documentToStructure({
5    file: file.load("SuiteScripts/sample_tax_form.pdf"),
6    documentType: documentCapture.DocumentType.TAX_FORM,
7    features: [documentCapture.Feature.FIELD_EXTRACTION]
8});
9 
10const fieldLabelToProcess = extractedData.pages[0].fields[0].label;
11 
12if (fieldLabelToProcess.confidence > 0.9) {
13    // Accept the field name
14} else {
15    // Reject the field name
16}
17 
18...
19// Add additional code

Important Errors

When working with FieldLabel object members, note that attempting to set the value for the properties will throw a READ_ONLY error. This indicates that the properties can only be accessed but not modified.

Who This Affects

• Developers: Utilize these properties for enhanced document processing capabilities in server scripts.
• Administrators: Manage and oversee implementations that involve document capture and processing.

Key Takeaways

• The FieldLabel object improves document processing accuracy through confidence and name properties.
• Employ confidence levels to filter and validate extracted names effectively.
• Scripts must handle READ_ONLY errors when managing FieldLabel properties.