AutoML Dataset Predictions

Download specification

Return a file containing the shapley values in coordinate form that are associated with a predictionId.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    Required

    The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

    format = "uuid"

Responses

200

text/csv

Stream of coordinate shap values returned successfully.

  • text/csvany

400

application/json

Received a bad argument

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring
        Required

        The unique code for the error

      • metaobject
        Show meta properties
        • detailsstring

          Extra details for what may have caused the error

        • errorIdstring

          The unique id of the error instance

        • argumentstring

          The argument

        • resourcestring

          The resource type that the error occurred on

        • resourceIdstring

          The resource id that the error occurred on
      • issuestring

        The issue code

      • titlestring

        A summary of what went wrong

      • errorIdstring

        The unique id of the error instance

      • argumentstring

        The argument

      • resourcestring

        The resource type that the error occurred on

      • resourceIdstring

        The resource id that the error occurred on

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

403

application/json

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

404

application/json

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

409

application/json

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

503

application/json

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
GET /v1/automl-predictions/{predictionId}/coordinate-shap 
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/coordinate-shap" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/coordinate-shap',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

Retrieve jobs that are associated with a prediction. Job with correlation type "prediction"

Facts

Rate limit Tier 2 (100 requests per minute)
Categories externalbuild

Path Parameters

  • predictionIdstring
    Required

    The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

    format = "uuid"

Responses

200

OK Response

400

application/json

Received a bad argument

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

403

application/json

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

404

application/json

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

409

application/json

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

503

application/json

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
POST /v1/automl-predictions/{predictionId}/jobs 
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/jobs" \
-X POST \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/jobs',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

Return a file containing any rows in a prediction operation where a prediction was unable to be produced.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    Required

    The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

    format = "uuid"

Responses

200

text/csv

Stream of not predicted reasons returned successfully.

  • text/csvany

400

application/json

Received a bad argument

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

403

application/json

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

404

application/json

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

409

application/json

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

503

application/json

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
GET /v1/automl-predictions/{predictionId}/not-predicted-reasons 
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/not-predicted-reasons" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/not-predicted-reasons',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

Return a file containing the predicted values that are associated with a predictionId.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    Required

    The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

    format = "uuid"

Responses

200

Prediction stream returned succesfully.

400

application/json

Received a bad argument

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

403

application/json

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

404

application/json

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

409

application/json

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

503

application/json

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
GET /v1/automl-predictions/{predictionId}/predictions 
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/predictions" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/predictions',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

Return a file containing the shapley values that are associated with a predictionId.

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    Required

    The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

    format = "uuid"

Responses

200

Stream of shap values returned successfully.

400

application/json

Received a bad argument

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

403

application/json

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

404

application/json

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

409

application/json

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

503

application/json

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
GET /v1/automl-predictions/{predictionId}/shap 
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/shap" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/shap',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli

Return a file containing the source values and an index field that are associated with a predictionId .

Facts

Rate limit Tier 1 (1000 requests per minute)
Categories externalbuild

Query Parameters

  • refIdstring

Path Parameters

  • predictionIdstring
    Required

    The ID of the prediction configuration object that provides parameters to be applied when the prediction is produced.

    format = "uuid"

Responses

200

text/csv

Stream of source values and index field returned successfully.

  • text/csvany

400

application/json

Received a bad argument

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

401

application/json

Unauthorized

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

403

application/json

Access forbidden

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

404

application/json

Resource not found.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

409

application/json

Resource conflict

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects

503

application/json

Resource unavailable

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
GET /v1/automl-predictions/{predictionId}/source 
curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/source" \
-H "Authorization: Bearer <API-key>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/automl-predictions/{predictionId}/source',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  

This API is not included yet in qlik-cli