AutoML Dataset Predictions

Endpoints

Skip to section
GET/v1/automl-predictions/{predictionId}/coordinate-shap
POST/v1/automl-predictions/{predictionId}/jobs
GET/v1/automl-predictions/{predictionId}/not-predicted-reasons
GET/v1/automl-predictions/{predictionId}/predictions
GET/v1/automl-predictions/{predictionId}/shap
GET/v1/automl-predictions/{predictionId}/source

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

build

Facts GET /v1/automl-predictions/{predictionId}/coordinate-shap

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/automl-predictions/{predictionId}/coordinate-shap

predictionId

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

Query Parameters GET /v1/automl-predictions/{predictionId}/coordinate-shap

refId
optional

Responses GET /v1/automl-predictions/{predictionId}/coordinate-shap

200
optional, text/csv
object

Stream of coordinate shap values returned successfully.

400
optional, application/json

Received a bad argument

401
optional, application/json

Unauthorized

403
optional, application/json

Access forbidden

404
optional, application/json

Resource not found.

409
optional, application/json

Resource conflict

503
optional, application/json

Resource unavailable

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>"

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

build

Facts POST /v1/automl-predictions/{predictionId}/jobs

Rate limit
Tier 2 (100 requests per minute)

Path Parameters POST /v1/automl-predictions/{predictionId}/jobs

predictionId

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

Responses POST /v1/automl-predictions/{predictionId}/jobs

200
optional, application/json

OK Response

400
optional, application/json

Received a bad argument

401
optional, application/json

Unauthorized

403
optional, application/json

Access forbidden

404
optional, application/json

Resource not found.

409
optional, application/json

Resource conflict

503
optional, application/json

Resource unavailable

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>"

Response POST /v1/automl-predictions/{predictionId}/jobs

{
  "id": "string",
  "corrId": "string",
  "status": "pending",
  "jobType": "preprocess_dataset",
  "corrType": "experiment_version",
  "tenantId": "string",
  "createdAt": "2022-11-22T14:26:31.230Z",
  "createdBy": "string",
  "deletedAt": "2022-11-22T14:26:31.230Z",
  "updatedAt": "2022-11-22T14:26:31.230Z",
  "parentJobId": "string"
}

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

build

Facts GET /v1/automl-predictions/{predictionId}/not-predicted-reasons

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/automl-predictions/{predictionId}/not-predicted-reasons

predictionId

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

Query Parameters GET /v1/automl-predictions/{predictionId}/not-predicted-reasons

refId
optional

Responses GET /v1/automl-predictions/{predictionId}/not-predicted-reasons

200
optional, text/csv
object

Stream of not predicted reasons returned successfully.

400
optional, application/json

Received a bad argument

401
optional, application/json

Unauthorized

403
optional, application/json

Access forbidden

404
optional, application/json

Resource not found.

409
optional, application/json

Resource conflict

503
optional, application/json

Resource unavailable

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>"

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

build

Facts GET /v1/automl-predictions/{predictionId}/predictions

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/automl-predictions/{predictionId}/predictions

predictionId

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

Query Parameters GET /v1/automl-predictions/{predictionId}/predictions

refId
optional

Responses GET /v1/automl-predictions/{predictionId}/predictions

200
optional, text/csv
object

Prediction stream returned succesfully.

400
optional, application/json

Received a bad argument

401
optional, application/json

Unauthorized

403
optional, application/json

Access forbidden

404
optional, application/json

Resource not found.

409
optional, application/json

Resource conflict

503
optional, application/json

Resource unavailable

GET/v1/automl-predictions/{predictionId}/predictions

curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/predictions" \
 -H "Authorization: Bearer <API-key>"

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

build

Facts GET /v1/automl-predictions/{predictionId}/shap

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/automl-predictions/{predictionId}/shap

predictionId

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

Query Parameters GET /v1/automl-predictions/{predictionId}/shap

refId
optional

Responses GET /v1/automl-predictions/{predictionId}/shap

200
optional, text/csv
object

Stream of shap values returned successfully.

400
optional, application/json

Received a bad argument

401
optional, application/json

Unauthorized

403
optional, application/json

Access forbidden

404
optional, application/json

Resource not found.

409
optional, application/json

Resource conflict

503
optional, application/json

Resource unavailable

GET/v1/automl-predictions/{predictionId}/shap

curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/shap" \
 -H "Authorization: Bearer <API-key>"

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

build

Facts GET /v1/automl-predictions/{predictionId}/source

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/automl-predictions/{predictionId}/source

predictionId

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

Query Parameters GET /v1/automl-predictions/{predictionId}/source

refId
optional

Responses GET /v1/automl-predictions/{predictionId}/source

200
optional, text/csv
object

Stream of source values and index field returned successfully.

400
optional, application/json

Received a bad argument

401
optional, application/json

Unauthorized

403
optional, application/json

Access forbidden

404
optional, application/json

Resource not found.

409
optional, application/json

Resource conflict

503
optional, application/json

Resource unavailable

GET/v1/automl-predictions/{predictionId}/source

curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-predictions/{predictionId}/source" \
 -H "Authorization: Bearer <API-key>"

predictionId

string

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

refId

string

appErrorResponse

object

Properties

errors
optional

No description

automl-job

object

Properties

id
optional
string<uuid>

The unique ID of the job.

corrId
optional
string<uuid>

The ID of the correlation.

status
optional
string

The status of the job.

Enum:

pending

completed

cancelled

jobType
optional
string

The job type.

Enum:

preprocess_dataset

dataset_conversion

train_model

predict_dataset

prediction

data_sync

corrType
optional
string

The type of the correlation.

Enum:

experiment_version

model

prediction

deployment

realtime_prediction

tenantId
optional
string

The ID of the tenant that owns the job.

createdAt
optional
string<date-time>

The UTC timestamp when the job was created.

createdBy
optional
string

The user that created the job

deletedAt
optional
string<date-time>

The UTC timestamp when the job was deleted.

updatedAt
optional
string<date-time>

The UTC timestamp when the job was updated.

parentJobId
optional
string

The ID of the parent job.

error

object

Properties

code
string

The unique code for the error

issue
optional
string

The issue code

title
string

A summary of what went wrong

errorId
optional
string

The unique id of the error instance

argument
optional
string

The argument

resource
optional
string

The resource type that the error occurred on

resourceId
optional
string

The resource id that the error occurred on

v0.509.8
Was this page helpful?