Skip to main content
POST
/
v1
/
models
/
{model_id}
/
explain
Explain
curl --request POST \
  --url https://api.example.com/v1/models/{model_id}/explain \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataset": {
    "columns": [
      {
        "name": "<string>"
      }
    ],
    "connection_config": {
      "uri": "<string>",
      "connector_credential_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connector_credential_name": "<string>",
      "connector_type": "s3",
      "region": "<string>",
      "file_format": "<string>"
    },
    "filter": {
      "col": "<string>",
      "kind": "cmp",
      "value": "<string>"
    }
  },
  "include_rules": false,
  "max_rules": 2,
  "max_depth": 2,
  "min_support": 0.5,
  "max_features_considered": 2
}
'
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>"
}

Headers

​
authorization
string | null
​
refresh-token
string | null

Path Parameters

​
model_id
string<uuid>
required

Body

application/json

POST /v1/models/{model_id}/explain -- Batch local explanations.

​
dataset
Dataset · object
required

Inline dataset spec; rows are materialized inside the worker.

​
include_rules
boolean
default:false

When True, attach per-sample rule explanations to the response. Each rule is a small set of feature conditions that together characterize the model's prediction for that sample. When False, rules are skipped and the optional knobs below are inert.

​
max_rules
integer | null

Maximum number of rules returned per sample. Optional; the service default applies when unset.

Required range: x >= 1
​
max_depth
integer | null

Maximum number of feature conditions allowed in a single rule. Optional; the service default applies when unset.

Required range: x >= 1
​
min_support
number | null

Minimum fraction of the reference dataset a rule must match. Optional; the service default applies when unset.

Required range: 0 <= x <= 1
​
max_features_considered
integer | null

Maximum number of input features available to the rule computation per sample. Optional; the service default applies when unset.

Required range: x >= 1

Response

Successful Response

Base response returned by async job-submission endpoints.

Keyed on job_id. Model identity (when applicable) is materialized at completion and returned inside JobResultResponse.result_data.

​
job_id
required

Server-assigned id of the submitted job

​
status
enum<string>
required
Available options:
pending,
running,
completed,
failed
​
message
string
required