AustraliaREFERENCE GUIDE

RegressionSolutionVersion - Global

ServiceNow documentation·7 min readView source ↗

On this page

RegressionSolutionVersion- Global

The RegressionSolutionVersion API is a scriptable object used in Predictive Intelligence stores.

This API requires the Predictive Intelligence plugin (com.glide.platform_ml) and is provided within the sn_ml namespace.

Use this API when working with solution versions based on RegressionSolution API objects in the RegressionSolution store.

The system creates a solution version each time you train a solution definition. Most versions are created during scheduled solution training.

Methods in this API are accessible using the following RegressionSolution methods:

Parent Topic:Server API reference

RegressionSolutionVersion - getProperties()

Gets solution object properties and version number.

Name Type Description None

Type

</th><th>

Description

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

Object

</td><td>

Contents of the Dataset and RegressionSolution version details. Results vary by object property setup. { "datasetProperties": {Object}, "domainName": "String", "encoder": {Object}, "inputFieldNames": [Array], "isActive": Boolean, "label": "String", "name": "String", "predictedFieldName": "String", "predictedInterval": [Array], "processingLanguage": "String", "scope": "String", "stopwords": [Array], "versionNumber": "Number" }

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

<Object>.datasetProperties

</td><td>

Lists the properties of the DatasetDefinition() object associated with the solution.

{ "encodedQuery": "String", "fieldDetails": [Array], "fieldNames": [Array], "tableName": "String" }

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

<Object>.datasetProperties.tableName

</td><td>

Name of the table for the dataset. For example, "tableName" : "Incident". Data type: String.

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

<Object>.datasetProperties.fieldNames

</td><td>

List of field names from the specified table as strings. For example, "fieldNames" : ["short_description", "priority"]. Data type: Array.

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

<Object>.datasetProperties.fieldNames.fieldDetails

</td><td>

List of JavaScript objects that specify field properties. [ { "name": "String", "type": "String" } ]

Data type: Array.

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

<Object>.datasetProperties.fieldNames.fieldDetails.<object>.name

</td><td>

Name of the field defining the type of information to restrict this dataset to. Data type: String.

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

<Object>.datasetProperties.fieldDetails.<object>.type

</td><td>

Machine-learning field type. Data type: String.

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

<Object>.datasetProperties.fieldDetails.encodedQuery

</td><td>

Encoded query string in the standard platform format. See Encoded query strings.Data type: String.

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

<Object>.domainName

</td><td>

Domain name associated with this dataset. See Domain separation and Predictive Intelligence.Type: String

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

<Object>.encoder

</td><td>

Encoder object assigned to this solution. See Encoder - Encoder(Object config).Data type: Object.

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

<Object>.inputFieldNames

</td><td>

List of input field names as strings. The model uses these fields used to make predictions. Data type: String.

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

<Object>.isActive

</td><td>

Flag that indicates whether this version is active.Valid values:

true: Version is active.
false: Version is not active.

Data type: String

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

<Object>.label

</td><td>

Identifies the prediction task. { "label": "my first prediction" }

Data type: String.

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

<Object>.name

</td><td>

System-assigned name. Data type: String.

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

<Object>.predictedFieldName

</td><td>

Identifies a field to be trained for predictability. Data type: String.

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

<Object>.predictedInterval

</td><td>

Range of values specifying the prediction confidence level.Data type: Array

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

<Object>.processingLanguage

</td><td>

Processing language in two-letter ISO 639-1 language code format. Data type: String.

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

<Object>.scope

</td><td>

Object scope. Currently the only valid value is global.Data type: String

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

<Object>.stopwords

</td><td>

Optional. Preset list of strings that the system automatically generates based on the language property setting. For details, see Create a custom stopwords list. Data type: Array.

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

<Object>.versionNumber

</td><td>

Version number of the RegressionSolution object.

</td></tr></tbody> </table>The following example gets properties of the active object version in the store.

// Get properties
var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getProperties()), null, 2));

Output:

{
  "datasetProperties": {
    "encodedQuery": "",
    "fieldNames": [
      "short_description",
      "sourcedc",
      "targetdc",
      "dbsize",
      "duration"
    ],
    "tableName": "cloudinfratext"
  },
  "domainName": "global",
  "encoderProperties": {
    "datasetsProperties": [],
    "name": "wc_regression"
  },
  "inputFieldNames": [
    "short_description",
    "sourcedc",
    "targetdc",
    "dbsize"
  ],
  "isActive": "true",
  "label": "Regression Test for DB Restore",
  "name": "ml_x_snc_global_global_regression",
  "predictedFieldName": "duration",
  "processingLanguage": "en",
  "stopwords": [
    "Default English Stopwords"
  ],
  "versionNumber": "1"
}

RegressionSolutionVersion - getStatus(Boolean includeDetails)

Gets training completion status.

Name

</th><th>

Type

</th><th>

Description

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

includeDetails

</td><td>

Boolean

</td><td>

Flag that indicates whether to return status details.Valid values:

true: Return additional details.
false: Don’t return additional details.

Default: False

</td></tr></tbody> </table><table id=“table_yfh_vbw_plb” class=“returns”><thead><tr><th>

Type

</th><th>

Description

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

Object

</td><td>

JavaScript object containing training status information for a RegressionSolution object. { "state": "String", "percentComplete": "Number as a String", "hasJobEnded": "Boolean value as a String", "details": {Object} }

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

<Object>.state

</td><td>

Training completion state. If the training job reaches a terminal state, the job does not leave that state. If the state is terminal, the hasJobEnded property is set to true.Possible values:

fetching_files_for_training
preparing_data
retry
solution_cancelled (terminal)
solution_complete(terminal)
solution_error (terminal)
solution_incomplete
training_request_received
training_request_timed_out (terminal)
training_solution
uploading_solution
waiting_for_training

Data type: String

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

<Object>.hasJobEnded

</td><td>

Flag that indicates whether training is complete.Valid values:

true: Training is complete.
false: Training is incomplete.

Data type: Boolean value as a String

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

<Object>.percentComplete

</td><td>

Training percent complete. If the completion percentage is less than 100, the job might be in a terminal state. For example, if training times out.Data type: Number as a String

Range: 0 thru 100

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

<Object>.details

</td><td>

Object containing a list of additional training details.Data type: Object

</td></tr></tbody> </table>The following example shows a successful result with training complete.

// Get status
var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');

gs.print(JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getStatus(true), null, 2)));

Output:

{
 "state":"solution_complete",
 "percentComplete":"100",
 "hasJobEnded":"true",
 "details":{"stepLabel":"Solution Complete"} // This information is only returned if getStatus(true);
}

The following example shows an unsuccessful result with training complete.

// Get status
var solutionName = 'ml_x_snc_global_global_regression_solution';
var mlSolution = sn_ml.RegressionSolutionStore.get(solutionName);
var trainingStatus = mlSolution.getLatestVersion().getStatus();

gs.print(JSON.stringify(JSON.parse(trainingStatus), null, 2));

Output:

{
 "state":"solution_error",
 "percentComplete":"100",
 "hasJobEnded":"true"
}

RegressionSolutionVersion - getVersionNumber()

Gets the version number of a solution object.

Name Type Description None Type Description String Version number.

The following example shows how to get a version number.

// Get version number
var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');

gs.print("Version number: "+JSON.stringify(JSON.parse(mlSolution.getActiveVersion().getVersionNumber()), null, 2));

Output:

Version number: 1

RegressionSolutionVersion - predict(Object input, Object options)

Gets the input data for a prediction.

Name

</th><th>

Type

</th><th>

Description

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

input

</td><td>

Object

</td><td>

GlideRecord or array of JSON objects containing field names and values as key-value pairs.

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

options

</td><td>

Object

</td><td>

Optional values for filtering prediction results. { "apply_threshold": Boolean, "top_n": Number }

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

options.apply_threshold

</td><td>

Boolean

</td><td>

Flag that indicates whether to check the threshold value for the solution and apply it to the result set.Valid values:

true: Return results in which confidence is greater than threshold.
false: Return all results.

Default: True

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

options.top_n

</td><td>

Number

</td><td>

If provided, returns the top results, up to the specified number of predictions.

</td></tr></tbody> </table><table id=“table_xwz_pbw_plb” class=“returns”><thead><tr><th>

Type

</th><th>

Description

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

Object

</td><td>

JSON object containing the prediction results sorted by sys_id or record_number. { <identifier>: [Array] }

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

</td><td>

List of objects with details for each prediction result.Data type: Array of Objects

<identifier>: [
  {
    "confidence": Number,
    "predictedSysId": "String",
    "predictedValue": "String", 
    "threshold": Number
  }
]

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

<Object>.<identifier>.<object>.confidence

</td><td>

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

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

<Object>.<identifier>.<object>.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>

<Object>.<identifier>.<object>.predictedValue

</td><td>

Value representing the prediction result. Data type: String

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

<Object>.<identifier>.<object>.threshold

</td><td>

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

</td></tr></tbody> </table>The following example shows how to display prediction results for a predict() method that takes a GlideRecord by sys_id for input and includes optional parameters to restrict to top three results and exclude the threshold value.

var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');

// single GlideRecord input
var input = new GlideRecord("incident");
input.get("<sys_id>");

// configure optional parameters
var options = {};
options.top_n = 3;
options.apply_threshold = false;

var results = mlSolution.getVersion(1).predict(input, options);
// pretty print JSON results
gs.print(JSON.stringify(JSON.parse(results), null, 2));

{
        "<sys_id/now_GR>": [
    {
      "confidence": 62.10782320780268,
      "threshold": 20.36,
      "predictedValue": "Clone Issues",
      "predictedSysId": ""
    },
    {
      "confidence": 6.945237375770391,
      "threshold": 16.63,
      "predictedValue": "Instance Administration",
      "predictedSysId": ""
    },
    {
      "confidence": 5.321061076300759,
      "threshold": 23.7,
      "predictedValue": "Administration",
      "predictedSysId": ""
    }
  ]
}

The following example shows how to display prediction results for a predict() method that takes an array of field names as key-value pairs for input and includes optional parameters to restrict to top three results and exclude the threshold value.

var mlSolution = sn_ml.RegressionSolutionStore.get('ml_incident_categorization');
// key-value pairs input
var input = [{"short_description":"my email is not working"}, {short_description:"need help with password"}];
// configure optional parameters
var options = {};
options.top_n = 3;
options.apply_threshold = false;
var results = mlSolution.predict(input, options);
// pretty print JSON results
gs.print(JSON.stringify(JSON.parse(results), null, 2));

{
  "1": [
    {
      "confidence": 37.5023032262591,
      "threshold": 10.72,
      "predictedValue": "Authentication",
      "predictedSysId": ""
    },
    {
      "confidence": 24.439964862166583,
      "threshold": 23.7,
      "predictedValue": "Administration",
      "predictedSysId": ""
    },
    {
      "confidence": 11.736320486031047,
      "threshold": 100,
      "predictedValue": "Security",
      "predictedSysId": ""
    }
  ],
  "2": [
    {
      "confidence": 99,
      "threshold": 17.77,
      "predictedValue": "Email",
      "predictedSysId": ""
    },
    {
      "confidence": 3.182137005157543,
      "threshold": 10.72,
      "predictedValue": "Authentication",
      "predictedSysId": ""
    },
    {
      "confidence": 2.8773826570713514,
      "threshold": -1,
      "predictedValue": "Email (I/f)",
      "predictedSysId": ""
    }
  ]
}

Keep exploring.

Find another answer, or bring this documentation into your own tools.

Search the library →Read via the REST API ↗