Page.words

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description

The extracted words from the page of a document.

This property has a value only when the documentCapture.Feature.TEXT_EXTRACTION feature is specified when you call documentCapture.documentToStructure(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).

Type

documentCapture.Word[]

Supported Script Types

Server scripts

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

Module

N/documentCapture Module

Parent Object

documentCapture.Page

Sibling Object Members

Page Object Members

Since

2025.2

Errors

Error Code	Thrown If
`READ_ONLY`	You try to set the value of this property.

Error Code

Thrown If

READ_ONLY

You try to set the value of this property.

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 pageWords = extractedData.pages[0].words;

...
// Add additional code

General Notices