1. Account Administration
  2. Account Setup
  3. NetSuite Company Settings
  4. Manage AI in NetSuite
  5. Manage AI Preferences
  6. Configure OCI Credentials for AI

Configure OCI Credentials for AI

If your company needs more than the free monthly usage for AI features in NetSuite, you can set up NetSuite to access Oracle Cloud Infrastructure (OCI) services with your own Oracle Cloud account. After you set up your account-level OCI credentials, you can enable Text Enhance, Prompt Studio, and SuiteScript modules with AI (N/llm and N/documentCapture) to use them.

If you set up the unlimited use model with your company’s Oracle Cloud account, your company pays for the OCI services it uses. These services include OCI Generative AI and, if you use the N/documentCapture module in SuiteScript, OCI Document Understanding. For more information, refer to the Calculating Cost in Generative AI section and the Billing and Cost Management section of the Oracle Cloud Infrastructure Documentation.

See these sections to manage your company's OCI configuration for AI features:

Before You Begin

Note:

Refer to the Oracle Cloud Infrastructure Documentation for the linked topics in this section.

If your company wants to set up unlimited usage but doesn't have an Oracle Cloud account yet, refer to Get an Oracle Cloud Account.

After you have an Oracle Cloud account, add the following services:

After you add the OCI services you need, get the OCI configuration details from your Oracle Cloud account.

The configuration details you'll need are:

  • User OCID: For more information, refer to Managing Users.

  • Compartment OCID: For more information, refer to Managing Compartments.

  • Tenancy OCID: For more information, refer to Viewing Tenancy Details.

  • Fingerprint: The OCI fingerprint of the public key. For more information about the OCI fingerprint, refer to Required Keys and OCIDs.

  • Private Key: The OCI user's private key, which will be in a PEM file (for example, oci_api_key.pem). For more information about the OCI user's private key, refer to Required Keys and OCIDs.

  • Endpoint ID: Only needed if you've set up a dedicated AI cluster through Oracle Cloud. For more information, refer to Managing Endpoints.

If you plan to use your Oracle Cloud account for asynchronous document capture requests with the N/documentCapture module, you'll also need the following details. These details help the service find the documents you want to process and the place to store the output when your request is completed.

  • OCI Object Storage Namespace: This is the top-level container in your Oracle Cloud account that holds buckets and objects for other OCI services. A bucket inside an Object Storage namespace stores objects, such as files and documents. For more information, refer to Object Storage Namespaces

  • OCI Input Bucket: Name of the bucket where the service can find the inputs to be processed. For more information, refer to Object Storage Buckets

  • OCI Output Bucket: Name of the bucket where the service will store the outputs from processing. For more information, refer to Object Storage Buckets

Enable and Configure OCI Credentials for AI in NetSuite

Use the OCI configuration details from your Oracle Cloud account, described in the Before You Begin section, to complete the steps below.

To enable and configure OCI credentials:

  1. Go to Setup > Company > AI > AI Preferences.

  2. On the Settings subtab of the AI Preferences page, check the Use OCI Configuration to Get Unlimited Usage box.

    After you check the box, you'll see the OCI configuration fields.

  3. Fill in these fields with values from your Oracle Cloud account:

    • User OCID

    • Compartment OCID

    • Tenancy OCID

  4. Next, you'll need to create NetSuite API secrets for the OCI fingerprint and OCI private key. Storing the OCI fingerprint and OCI private key as API secrets enhances security of these OCI credentials in NetSuite.

    1. Click Create your API secrets here. The API Secrets page opens in a new browser tab.

    2. Click Create New. The Create New Secret dialog opens. Create the API secret for the OCI fingerprint as described below, then click Save.

      • On the Details tab:

        • Make sure the ID starts with an underscore, because the system adds a prefix custsecret when you save. For example, if you enter _oci_config_fingerprint, the ID will be custsecret_oci_config_fingerprint after you save.

        • Enter the OCI public key fingerprint value in both the Password and Confirm Password fields.

        Create New Secrets dialog, Details tab, completed for the OCI fingerprint as described in the procedure.

      • On the Restrictions tab, use the following settings so that any of the AI features managed from the AI Preferences page can use the API secret:

        • Check the Allow for All Scripts box.

        • Enter _none_ in the Restrict to Domains field.

        Create New Secrets dialog, Restrictions tab, completed for the OCI fingerprint as described in the procedure.

    3. To create the API secret for the OCI private key, click Create New again. The Create New Secret dialog opens. Complete the fields as described below, then click Save.

      • On the Details tab, complete Name and ID similarly to how you did for the fingerprint, but upload the private key file instead of entering values in the Password and Confirm Password fields.

      • Use the same settings on the Restrictions tab.

      Create New Secrets dialog, Details tab, completed for the OCI private key as described in the procedure.

    After you create the API secrets, they are shown on the API Secrets page.

    API Secrets management page showing example secrets created for the OCI fingerprint and OCI private key.

  5. Go back to the AI Preferences page and enter the IDs of the API secrets in the API Secret for Fingerprint and API Secret for Private Key fields.

  6. Fill in the Optional configuration for Asynchronous Document Capture fields if you plan to use asynchronous options for N/documentCapture. Use these values from your Oracle Cloud account:

    • OCI Object Storage Namespace

    • OCI Input Bucket

    • OCI Output Bucket

    Note:

    Storing OCI configuration for asynchronous document capture is useful, but optional if:

    • You only want to provide credentials for other AI services on this page (such as Text Enhance or the SuiteScript N/llm module).

    • You only plan to use synchronous options for the N/documentCapture module.

    • You prefer to provide OCI details directly in your script as part of an ociConfig object. If you do, your script overrides the configuration stored here.

  7. Click Validate credentials to test the OCI credentials you entered.

    • If everything's set up correctly, a confirmation message ("Credentials were successfully validated") is displayed.

    • If there are errors in the setup, an error message is displayed. Errors are displayed one at a time. Correct the error and click Validate credentials to test again. Repeat until the confirmation message is displayed.

    Note:

    Each successful validation counts as one use of the OCI Generative AI service.

  8. Click Save.

  9. Next, set up the AI features to use the OCI credentials. Go to the subtab on the AI Preferences page to enable the feature to use the OCI credentials. You can choose to have some, all, or none of the AI features use OCI credentials.

    For example, to use OCI credentials for Text Enhance, click the Text Enhance subtab on the AI Preferences page, check the Use OCI Credentials for Text Enhance box, and click Save.

    For each feature you set up to use OCI credentials, NetSuite stops using the limited, free usage mode. NetSuite switches to the paid, unlimited usage mode through your Oracle Cloud account with OCI services.

    For more information, see the following topics:

  10. For each feature you set up to use OCI credentials, test the new setup.

    For example, if you've set up Text Enhance to use OCI credentials: Go to a page that has a field with Text Enhance and try a valid action. For more information, see Text Enhance.

    • If everything's set up correctly, the Text Enhance action works, and your current month's free usage count should remain the same.

    • If there's a problem with the setup, you'll see a Task Unavailable error. Go back to the AI Preferences page, Settings tab. Click Validate credentials. Fix the error shown and repeat until you receive a successful confirmation message.

      Common errors and how to resolve them:

      • On the AI Preferences page, Settings tab, verify that the OCI configuration parameters have the correct values for your Oracle Cloud account.

      • On the AI Preferences page, Settings tab, verify that NetSuite API Secret IDs entered correctly. Also verify that they match the secret IDs (not the secret names) shown on the API Secrets page.

      • On the API Secrets page, verify that the OCI fingerprint and OCI private key secrets were created correctly.

Disable OCI Credentials for AI in NetSuite

You can disable OCI use by all NetSuite AI features managed from the AI Preferences page. This overrides all Use OCI credentials settings on the features' subtabs.

To disable OCI credentials:

  1. Go to Setup > Company > AI > AI Preferences.

  2. From the Settings subtab on the AI Preferences page, clear the Use OCI Configuration to Get Unlimited Usage box.

    Note:

    The OCI configuration fields are hidden on the Settings subtab, but they're not deleted. If you check the Use OCI Configuration to Get Unlimited Usage box again, the fields are shown with your last saved values still there. If you want to remove the OCI credentials completely, clear each field one by one, then disable the OCI credentials.

  3. Click Save.

    • After you disable OCI use on the Settings subtab, NetSuite goes back to the free, limited usage mode for all AI features managed from the AI Preferences page, no matter what each feature's setting is. You'll see the monthly free usage limits and used quantities in the usage tables on each feature's subtab.

    • When the OCI credentials are disabled, you can't change the Use OCI credentials settings for individual features. The settings on the feature subtabs are still shown, but they're overridden when OCI use is disabled on the Settings subtab.

Related Topics

General Notices