Using OCI Credentials to Obtain Additional Usage

NetSuite provides a free monthly usage pool of requests for the N/documentCapture module. Successful calls to documentCapture.documentToStructure(options) consume usage from this pool, and the pool is refreshed each month. You can track your current monthly usage on the AI Preferences page in NetSuite. For more information, see View SuiteScript AI Usage Limit and Usage. Calls to documentCapture.documentToText(options) don't consume usage from this pool.

Each SuiteApp installed in your account gets its own separate monthly usage pool for N/documentCapture methods, and these SuiteApp pools are independent from the usage pool for your regular (non-SuiteApp) scripts. For example, if you install two SuiteApps, each with scripts that use N/documentCapture methods, each SuiteApp draws from its own unique usage pool. This approach means you get twice the total SuiteApp usage (one pool per SuiteApp). Any other scripts outside of SuiteApps use a separate usage pool, and SuiteApp usage doesn't count against it. This setup ensures that SuiteApps can't use up all your monthly allocation and block your own scripts from calling N/documentCapture methods.

If you want more monthly usage, you can provide the Oracle Cloud Infrastructure (OCI) credentials for an Oracle Cloud account that includes the OCI Document Understanding service. When you provide these credentials, usage is consumed from the provided OCI account instead of the free usage pool provided by NetSuite. You can provide OCI configuration parameters in two ways:

Using the AI Preferences page in NetSuite. For more information, see Manage AI Preferences.
Using the options.ociConfig parameter of documentCapture.documentToStructure(options). When using this approach, the credentials you provide override any OCI credentials that are configured on the AI Preferences page. For more information, see Configure OCI Credentials for AI.

For a list of required OCI configuration parameters for synchronous requests, see documentCapture.documentToStructure(options). For asynchronous requests (those that use a document capture task in the N/task module), you must provide three additional OCI configuration parameters: objectStorageNamespace, outputBucketName, and inputBucketName. You can provide these additional parameters in two ways:

Using the fields in the Optional configuration for Asynchronous Document Capture section on the Settings subtab of the AI Preferences page.

Using the ociConfig property of the document capture task. When using this approach, the credentials you provide override any OCI credentials that are configured on the AI Preferences page. Here is the full list of parameters required in the object you provide for the ociConfig property:

              docTask.ociConfig = {
    userId: 'user-ocid',
    tenancyId: 'user-tenancy',
    compartmentId: 'user-compartment',
    fingerprint: 'custsecret_secret_fingerprint_id',
    privateKey: 'custsecret_secret_privatekey_id',
    objectStorageNamespace: 'oraclenetsuite',
    outputBucketName: 'in-bucket-name',
    inputBucketName: 'out-bucket-name'
};

Related Topics