Initiate Natural Language Processing Action | Industries Common Resources Developer Guide

This object is available in API version 60.0 and later.

Special Access Rules

To access the Initiate Natural Language Processing action, enable either IndustriesNLPInsightsAddOn or both IndustriesContractsAIAddOn and ContractsAIAddOn.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/initiateNaturalLangProcessing

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: GET, HEAD, POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Input	Type	Description
referenceRecordId	string	Required. The record ID with the text field that's processed by an AI natural language process request.
referenceRecordTextField	string	Required. The text field that's processed by an AI natural language process request.
serviceDetailsList	string	Required. A comma-delimited list containing the details of services that are used to process AI natural language process requests. The possible values are: `Amazon_Comprehend_Keyphrase_Extraction` `Amazon_Comprehend_Entity_Extraction` `OpenAIClauseExtraction` `OpenAIEntityExtraction` `GenAI_Assessment_Questions_Extraction`

Outputs

Input	Type	Description
aiNaturalLangProcRsltIdsList	string	A comma-delimited list containing the IDs of AI Natural Language Process Result records that store the result of the natural language process requests.

Example

Sample Request

JSON Request Body

1{
2  "inputs": [
3    {
4      "referenceRecordId": "a00SB000003Z2LPYA0",
5      "referenceRecordTextField": "Vehicle__c.Comments__c",
6      "serviceDetailsList": {
7        "serviceDetails": [
8          {
9            "serviceName": "Amazon_Comprehend_Keyphrase_Extraction",
10            "configurationApiName": "AWS_Keyphrase_Extraction"
11          }
12        ]
13      }
14    }
15  ]
16}

Sample Response

JSON Response Body

1[
2  {
3    "actionName": "initiateNaturalLangProcessing",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "aiNaturalLangProcRsltIds": {
8        "aiNaturalLangProcessResultIds": [
9          "7NPSB0000000g8v4AA"
10        ]
11      }
12    },
13    "version": 1
14  }
15]

Sample Error message when referenceRecordId is not provided

JSON Error Body

1[ {
2  "errorCode" : "METHOD_NOT_ALLOWED",
3  "message" : "HTTP Method 'POST' not allowed. Allowed are HEAD,GET"
4} ]