Search Contract Document Action

Search the latest contract document version based on the user’s query.

This action is available in API version 64.0 and later.

Special Access Rules

To use this action, Contracts AI User permission set is required.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/searchContractDocument

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Inputs

Input	Type	Description
`contractId`	string	Required. ID of the contract record to use for the search.
`searchQuery`	string	Required. Text-based query to use to search contract documents.
`resultLimit`	string	Required. Maximum number of text segments that can be returned from the contract search. Each segment represents a relevant portion of a contract document.

Outputs

Output	Type	Description
`searchResult`	string	Concatenated content of the top segments that match a user query.

Example

POST

This sample request is for the Search Contract Document action.

1{
2  "inputs": [
3    {
4      "contractId": "800VW000006142vYAA",
5      "searchQuery": "Show me the contract for paper packaging deliveries.",
6      "resultLimit": "1000"
7    }
8  ]
9}

This sample response is for the Search Contract Document action.

1{
2  "actionName": "searchContractDocument",
3  "errors": null,
4  "invocationId": null,
5  "isSuccess": true,
6  "outcome": null,
7  "outputValues": {
8    "searchResult": "AGREEMENT FOR DELIVERY OF PAPER PACKAGING MATERIALS\n\nThis Agreement...."
9  },
10  "sortOrder": -1,
11  "version": 1
12}