AutoML Real time Predictions

Endpoints

Skip to section
POST/v1/automl-deployments/{deploymentId}/realtime-predictions

Generate predictions in a synchronous request and response.

build

Facts POST /v1/automl-deployments/{deploymentId}/realtime-predictions

Rate limit
Tier 2 (100 requests per minute)

Path Parameters POST /v1/automl-deployments/{deploymentId}/realtime-predictions

deploymentId

The ID of the ML deployed model that will be employed to produce predictions.

Query Parameters POST /v1/automl-deployments/{deploymentId}/realtime-predictions

includeNotPredictedReason
optional
boolean

If true, will include a column with the reason why a prediction was not produced.

includeShap
optional
boolean

If true, the shapley values will be included in the response.

includeSource
optional
boolean

If true, the source data will be included in the response

index
optional
string

The name of the feature in the source data to use as an index in the response data. The column will be included with its original name and values. This is intended to allow the caller to join results with source data.

Request Body POST /v1/automl-deployments/{deploymentId}/realtime-predictions

optional, application/json

No description

Responses POST /v1/automl-deployments/{deploymentId}/realtime-predictions

200
optional, application/parquet
object

Stream of combined prediction output 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

POST/v1/automl-deployments/{deploymentId}/realtime-predictions

curl "https://your-tenant.us.qlikcloud.com/api/v1/automl-deployments/{deploymentId}/realtime-predictions" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"schema":{"rows":[],"schema":[{"name":"string"}]}}'

Request POST /v1/automl-deployments/{deploymentId}/realtime-predictions

{
  "schema": {
    "rows": [],
    "schema": [
      {
        "name": "string"
      }
    ]
  }
}

deploymentId

string

The ID of the ML deployed model that will be employed to produce predictions.

appErrorResponse

object

Properties

errors
optional

No description

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

realtimePredictionInput

object

Properties

schema
optional

No description

realTimePredictionInputSchema

object

Properties

name
optional
string

The name of a feature in the dataset.

v0.509.8
Was this page helpful?