documentCapture.Word

Note:

The content in this help topic pertains to SuiteScript 2.1.

Object Description

An extracted word from a document.

This object includes properties for the confidence level (Word.confidence) and text (Word.text) of the word.

Words are included in extracted content only when the documentCapture.Feature.TEXT_EXTRACTION feature is specified when you call documentCapture.documentToStructure(options) (or when you submit an asynchronous extraction task then parse the result using documentCapture.parseResult(options)). If you don't specify any features when you call this method, the TEXT_EXTRACTION feature is used by default (along with the TABLE_EXTRACTION feature).

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/documentCapture Module

Methods and Properties

Word Object Members

Since

2025.2

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/documentCapture Module Script Samples.

            // Add additional code
...

const extractedData = documentCapture.documentToStructure({
    file: file.load("SuiteScripts/sample_invoice.pdf"),
    documentType: documentCapture.DocumentType.INVOICE,
    features: [documentCapture.Feature.TEXT_EXTRACTION]
});

const word = extractedData.pages[0].words[0];

...
// Add additional code

Syntax

Related Topics