Predictive Intelligence API

</td></tr><tr><td>

output.confidence

</td><td>Estimated precision of the prediction as a percentage. For example, <strong>53.84615375762915</strong>.Data type: Number</td></tr><tr><td>

output.outcome

</td><td>Prediction output field value. For example, an incident categorization solution would return an incident category such as <strong>inquiry</strong>.Data type: String</td></tr><tr><td>

output.threshold

</td><td>

Value of the configured threshold associated with the prediction. Data type: Number

</td></tr></tbody>
</table>

### Sample cURL request

## Predictive Intelligence - GET /agent\_intelligence/solution/prediction

Returns predictions for multiple solutions.

**Note:** Outcome result objects are grouped by solution name and sys\_id in the format `result.<solutionname>.<sys_id>.[{ <result1> },{ <result2>}]`.

For customization information, see [MLSolutionFactory scriptable objects](../../intelligent-experiences/predictive-intelligence/using-ml-apis-mlsolutionfactory.md).

### URL format

Versioned URL: `/now/{api_version}/agent_intelligence/solution/prediction`

Default URL: `/now/agent_intelligence/solution/prediction`

**Note:** Available versions are specified in the [REST API Explorer](../rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](../rest-api-explorer/c_CustomWebServices.md).

### Supported request parameters

<table class="rest_api_path_parameters"><thead><tr><th>

Name

</th><th>

Description

</th></tr></thead><tbody><tr><td>

api\_version

</td><td id="version-entry-RESTAPI">

Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String

</td></tr></tbody>
</table>

<table class="rest_api_query_parameters"><thead><tr><th>

Parameter

</th><th>

Description

</th></tr></thead><tbody><tr><td>

input\_filter

</td><td><p>Required parameter if <strong>input_table</strong> is used, don't use this parameter with <strong>input_maps</strong> parameter. Filter to select records on which to run predictions. For example:<code>sys_id 0ef47232db801300864adfea5e961912</code></p>
<p>Data type: String</p></td></tr><tr><td>

input\_maps

</td><td><p>Required unless using <strong>input_table</strong> parameter. Array of input name-value pairs. For example: <code>[{"short_description":"my email is not working"}, {"short_description":"need help with password"}]</code></p>
<p>Data type: Array of Objects</p></td></tr><tr><td>

input\_table

</td><td><p>Required unless using <strong>input_maps</strong> parameter. Table name on which you want to run predictions. For example:<code>incident</code></p>
<p>Data type: String</p></td></tr><tr><td>

options

</td><td>

JSON object with optional arguments. For example:

Valid options:

-   top\_n: Number. If provided, returns the top results, up to the specified number of predictions.
-   apply\_threshold: Boolean. Checks the threshold value for the solution and applies it to the result set. The threshold value is solution threshold for similarity or class-level threshold for classification. Default value is true.
-   custom\_results\_filter: String. Similarity solutions only. Specifies the allowed set from which results are returned using an encoded query.

Data type: Object

</td></tr><tr><td>

solution\_names

</td><td>

Required. Comma-separated list of solution names for which you want to run predictions. For example:

Data type: String

</td></tr></tbody>
</table>

|Name|Description|
|----|-----------|
|None| |

### Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](../rest-api-explorer/c_RESTAPI.md).

<table class="rest_api_request_headers"><thead><tr><th>

Header

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Accept

</td><td id="accept-entry-RESTAPI">Data format of the response body. Supported types: <strong>application/json</strong> or <strong>application/xml</strong>. Default: <strong>application/json</strong></td></tr></tbody>
</table>

|Header|Description|
|------|-----------|
|None| |

### Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](../rest-api-explorer/c_RESTAPI.md).

|Status code|Description|
|-----------|-----------|
|200|Successful. The request was successfully processed.|
|401|Unauthorized. The user credentials are incorrect or have not been passed.|
|404|Not found. The requested item wasn't found.|
|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|

### Response body parameters \(JSON or XML\)

<table><thead><tr><th>

Element

</th><th>

Description

</th></tr></thead><tbody><tr><td>

confidence

</td><td>

Value of the confidence associated with the prediction. For example, 53.84. Data type: Number

</td></tr><tr><td>

predictedSysId

</td><td>

The sys\_id of the predicted value. Results can be from any table on which information is being predicted. Data type: String

</td></tr><tr><td>

predictedValue

</td><td>

Value representing the prediction result. Data type: String

</td></tr><tr><td>

threshold

</td><td>

Value of the configured threshold associated with the prediction. Data type: Number

</td></tr></tbody>
</table>

### Sample cURL request