Qlik Sense Predictions API

The predictions API from Qlik Sense — 6 operation(s) for predictions.

Documentation GitHub OpenAPI

Business capability

Artificial Intelligence Management BC-610.60

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/v1/ml/deployments/{deploymentId}/aliases/{aliasName}/realtime-predictions/actions/run Get real-time predictions via a deployment alias · Generate predictions in a synchronous request/response #

Ask an LLM

“Can I call a deployed model through an alias to get instant predictions?”

“How do I score rows in real time using a named alias like production?”

Tell an agent

Run real-time predictions on {rows} using alias {aliasName} of deployment {deploymentId}.

Predict through alias {aliasName} on deployment {deploymentId} with SHAP set to {includeShap}.

GET /api/v1/ml/deployments/{deploymentId}/batch-predictions List batch prediction configurations · List batch prediction configurations #

Ask an LLM

“What batch prediction jobs are set up for my deployment?”

“Can I filter batch prediction configurations on a deployment?”

Tell an agent

List batch prediction configurations for deployment {deploymentId}.

Show batch predictions on deployment {deploymentId} matching {filter}.

POST /api/v1/ml/deployments/{deploymentId}/batch-predictions Create a batch prediction configuration · Create a prediction configuration #

Ask an LLM

“How do I set up a batch prediction job for a deployed model?”

“Can I configure predictions to run over a whole dataset?”

Tell an agent

Create a batch prediction configuration on deployment {deploymentId}.

Set up a batch prediction for deployment {deploymentId} with {data}.

GET /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId} Get a batch prediction · Retrieve a batch prediction #

Ask an LLM

“Where can I see the configuration and status of one batch prediction?”

“What does a particular batch prediction job look like?”

Tell an agent

Get batch prediction {batchPredictionId} on deployment {deploymentId}.

Show details of batch prediction {batchPredictionId} for deployment {deploymentId}.

PATCH /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId} Update a batch prediction · Updates a batch prediction #

Ask an LLM

“Can I change the settings of an existing batch prediction?”

“How do I edit a batch prediction configuration?”

Tell an agent

Update batch prediction {batchPredictionId} on deployment {deploymentId}.

Edit the configuration of batch prediction {batchPredictionId} in {deploymentId}.

DELETE /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId} Delete a batch prediction · Delete a batch prediction #

Ask an LLM

“How do I remove a batch prediction job I no longer need?”

“Can I delete a batch prediction configuration from a deployment?”

Tell an agent destructive · confirm first

Delete batch prediction {batchPredictionId} from deployment {deploymentId}.

Remove the batch prediction job {batchPredictionId} on {deploymentId}.

POST /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/actions/predict Run a batch prediction now · Run a batch prediction #

Ask an LLM

“How do I trigger a batch prediction to run immediately?”

“Can I run a configured batch prediction on demand?”

Tell an agent

Run batch prediction {batchPredictionId} on deployment {deploymentId}.

Execute the batch prediction job {batchPredictionId} for {deploymentId} now.

GET /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule Get a batch prediction schedule · Get a batch prediction schedule #

Ask an LLM

“When is my batch prediction scheduled to run?”

“What schedule is attached to a batch prediction?”

Tell an agent

Show the schedule of batch prediction {batchPredictionId} on deployment {deploymentId}.

Get when batch prediction {batchPredictionId} in {deploymentId} runs.

PATCH /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule Update a batch prediction schedule · Update a batch prediction schedule #

Ask an LLM

“Can I change how often a scheduled batch prediction runs?”

“How do I edit the existing schedule on a batch prediction?”

Tell an agent

Update the schedule of batch prediction {batchPredictionId} on deployment {deploymentId}.

Change when batch prediction {batchPredictionId} in {deploymentId} is scheduled.

PUT /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule Add a schedule to a batch prediction · Add a batch prediction schedule #

Ask an LLM

“How do I make a batch prediction run on a recurring schedule?”

“Can I schedule a batch prediction that has no schedule yet?”

Tell an agent

Add a schedule {data} to batch prediction {batchPredictionId} on deployment {deploymentId}.

Schedule batch prediction {batchPredictionId} in {deploymentId} to run regularly.

DELETE /api/v1/ml/deployments/{deploymentId}/batch-predictions/{batchPredictionId}/schedule Remove a batch prediction schedule · Delete a batch prediction schedule #

Ask an LLM

“How do I stop a batch prediction from running on a schedule?”

“Can I unschedule a batch prediction but keep the job?”

Tell an agent destructive · confirm first

Delete the schedule of batch prediction {batchPredictionId} on deployment {deploymentId}.

Unschedule batch prediction {batchPredictionId} in {deploymentId}.

POST /api/v1/ml/deployments/{deploymentId}/realtime-predictions/actions/run Get real-time predictions from a deployment · Generate predictions in a synchronous request/response #

Ask an LLM

“How do I get instant predictions straight from a deployed model?”

“Can real-time predictions explain why a row was not predicted?”

Tell an agent

Run real-time predictions on {rows} with deployment {deploymentId}.

Score rows directly against deployment {deploymentId} including SHAP values {includeShap}.

Qlik Sense Predictions API

Operations 12

Documentation

Specifications

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification