module function · N/documentCapture
documentToStructure()
documentCapture.documentToStructure(options)
Extracts content from a document.
- Implementation
- Not started
- Design
- Open for proposals suggest how it should read
A
suitescript api
1documentCapture.documentToStructure({2 file: /* file.File, required */,3 features: /* string[], optional */,4 language: /* string, optional */,5 ociConfig: /* Object, optional */,6 timeout: /* number, optional */7});| Parameter | Type | Required | Description |
|---|---|---|---|
| options.file | file.File | required | The document file to extract content from. The specified file must be located in the NetSuite File Cabinet, be in PDF, JPG, PNG, or TIFF format, and be five pages in length or shorter. You can specify the file using its internal ID or the path to the file in the File Cabinet. For more information, see N/file Module . Encrypted files are not supported. |
| options.features | string[] | optional | The features to extract from the specified document. Use values from the documentCapture.Feature enum to set this property. If you don't specify any features when you call this method, the TEXT_EXTRACTION and TABLE_EXTRACTION features are used by default. |
| options.language | string | optional | The language of the specified document. Use values from the documentCapture.Language enum to set this property. If you don't specify a language when you call this method, the ENG (English) language is used by default. |
| options.ociConfig | Object | optional | Important: This object is no longer supported. Any values specified in this object are ignored. |
| options.timeout | number | optional | The timeout period to wait for a response from the service. By default, the timeout period is 30,000 milliseconds (30 seconds). You can specify a longer timeout period, but you can't specify one that's shorter than 30,000 milliseconds. If you try to specify a shorter timeout period, the default value of 30,000 milliseconds is used instead. |
B
mynt syntax
No Mynt syntax yet.
Nothing in the language compiles to documentCapture.documentToStructure(options) today. How should it read?
C
community proposals
Competing syntax for documentToStructure, from GitHub Discussions. Select two or more to compare them side by side.
Loading proposals from GitHub…
D
suggest an alternative
Write the Mynt you wish you could write.
A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.
- Clarity. Does it say what happens, without ceremony?
- Consistency. Does it read like
load,saveandRef[field]? - Expressiveness. Does it cover the cases people actually write?
- Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?