| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nsolution\\_name\n\n | \n\nName of solution to use for predictions. For example, `ml_incident_categorization`.Data type: String\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nSolution definition input field key-value pair\n\n | \n\nName-value pair of the solution input field. For example, enter the name: `short_description` and the value: `Unable to connect to VPN`. Data type: String\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nElement\n\n | \n\nDescription\n\n |
|---|---|
| \n\ninput\n\n | \n\nName-value pairs that were specified as input to the call.Data type: Object\n\n |
| \n\noutput\n\n | \n\nPredicted outcome values based on the specified solution.Data type: Object\n\n ```\n\"output\": {\n \"confidence\": Number\",\n \"outcome\": \"String\",\n \"threshold\": Number\"\n}\n```\n\n |
| \n\noutput.confidence\n\n | \n\nEstimated precision of the prediction as a percentage. For example, **53.84615375762915**.Data type: Number\n\n |
| \n\noutput.outcome\n\n | \n\nPrediction output field value. For example, an incident categorization solution would return an incident category such as **inquiry**.Data type: String\n\n |
| \n\noutput.threshold\n\n | \n\nValue of the configured threshold associated with the prediction. Data type: Number\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\napi\\_version\n\n | \n\nOptional. 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\n\n |
| \n\nParameter\n\n | \n\nDescription\n\n |
|---|---|
| \n\ninput\\_filter\n\n | \n\nRequired parameter if **input\\_table** is used, don't use this parameter with **input\\_maps** parameter. Filter to select records on which to run predictions. For example:```\nsys_id 0ef47232db801300864adfea5e961912\n```\n\nData type: String\n\n |
| \n\ninput\\_maps\n\n | \n\nRequired unless using **input\\_table** parameter. Array of input name-value pairs. For example: ```\n[{\"short_description\":\"my email is not working\"}, {\"short_description\":\"need help with password\"}]\n```\n\nData type: Array of Objects\n\n |
| \n\ninput\\_table\n\n | \n\nRequired unless using **input\\_maps** parameter. Table name on which you want to run predictions. For example:```\nincident\n```\n\nData type: String\n\n |
| \n\noptions\n\n | \n\nJSON object with optional arguments. For example:```\n{\"top_n\" : 5, \"apply_threshold\":false}\n```\n\nValid options:\n\n- top\\_n: Number. If provided, returns the top results, up to the specified number of predictions.\n- 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.\n- custom\\_results\\_filter: String. Similarity solutions only. Specifies the allowed set from which results are returned using an encoded query.\n\nData type: Object\n\n |
| \n\nsolution\\_names\n\n | \n\nRequired. Comma-separated list of solution names for which you want to run predictions. For example:```\nml_incident_categorization,ml_incident_assignment\n```\n\nData type: String\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n |
| \n\nElement\n\n | \n\nDescription\n\n |
|---|---|
| \n\nconfidence\n\n | \n\nValue of the confidence associated with the prediction. For example, 53.84. Data type: Number\n\n |
| \n\npredictedSysId\n\n | \n\nThe sys\\_id of the predicted value. Results can be from any table on which information is being predicted. Data type: String\n\n |
| \n\npredictedValue\n\n | \n\nValue representing the prediction result. Data type: String\n\n |
| \n\nthreshold\n\n | \n\nValue of the configured threshold associated with the prediction. Data type: Number\n\n |