The available functions

The TIM SSE for Qlik Sense supports RTInstantML, as well as the functionality to look inside the forecasting models to derive additional insights from them. This section desribes the different functions that are provided and explains which input data they expect, which output data they produce and which purpose they serve.

RTInstantML

There are three functions related to making a RTInstantML forecast; all three of them are described below.

GetUUID (timeStamps, target, predictors*, offset)

Functionality

This function is used to make the actual RTInstantML request. Therefore, it should always be the first function that is used. The output of this function is used as input for any other function, thus moving on without it is not possible.

Input parameters

As input parameters, this function should receive all of the information needed for making the RTInstantML request. These input parameters are:

  • timeStamps: the timestamps corresponding to the input variables,

  • target: the target variable data (i.e. the reference to the target variable in your Qlik Sense app data),

  • predictors*: the predictor variable(s) you want to include - this parameter is optional as it is possible to make a RTInstantML request without including any additional predictors, and

  • offset: the number of samples into the future you want to make a forecast for.

Output data

This function returns a UUID (Universally Unique IDentifier) that identifies the RTInstantML request that was made. This UUID can subsequently be used to retrieve other information, such as the forecast and feature importances.

GETTimeStamps (uuid)

Functionality

This function is used to retrieve the timestamps corresponding to the requested RTInstantML forecast.

Input parameters

As input parameter, this function should receive the UUID that was returned by the GetUUID function.

Output data

This function returns the timestamps of the forecast corresponding to the UUID that was passed as an input parameter.

GetPrediction (uuid)

Functionality

This function is used to retrieve the actual forecast that is calculated based on the RTInstantML request.

Input parameters

As input parameter, this function should receive the UUID that was returned by the GetUUID function.

Output data

This function returns the actual forecast corresponding to the UUID that was passed as an input parameter.

Simple Model Treemaps

GetSimpleFeatures (uuid)

Functionality

This function is used to retrieve the simple model features on which the model calculation was based, i.e. only the features that were actually passed as input variables.

Input parameters

As input parameter, this function should receive the UUID that was returned by the GetUUID function.

Output data

This function returns the simple model features on which the model calculation - corresponding to the UUID that was passed as an input parameter - was based.

GetSimpleImportances (uuid)

Functionality

This function is used to retrieve the relative importances of the different simple model features on which the model calculation was based.

Input parameters

As input parameter, this function should receive the UUID that was returned by the GetUUID function.

Output data

This function returns the relative importances of the different simple model features on which the model calculation - corresponding to the UUID that was passed as an input parameter - was based.

Extended Model Treemaps

GetExtendedFeatures (uuid)

Functionality

This function is used to retrieve the extended model features on which the model calculation was based, i.e. both the features that were actually passed as input variables and the features that were extracted and added by the TIM Engine to optimise forecasting results.

Input parameters

As input parameter, this function should receive the UUID that was returned by the GetUUID function.

Output data

This function returns the extended model features on which the model calculation - corresponding to the UUID that was passed as an input parameter - was based.

GetExtendedImportances (uuid)

Functionality

This function is used to retrieve the relative importances of the different extended model features on which the model calculation was based.

Input parameters

As input parameter, this function should receive the UUID that was returned by the GetUUID function.

Output data

This function returns the relative importances of the different extended model features on which the model calculation - corresponding to the UUID that was passed as an input parameter - was based.