SymetryML Documentation
Data drift

List drift calculators

The response's `values.stringList` field is a `StringList`.

GET
/{user}/driftCalculators

The response's values.stringList field is a StringList.

Authorization

SymetryMLAuth
AuthorizationBearer <token>

HMAC-SHA256 signature-based authentication: requests are signed with your secret key and sent with the Customer-ID, Sym-date, Authorization, Content-MD5 and sym-version headers. See SymetryML REST API Security for the signature algorithm and a complete example.

In: header

Path Parameters

user*string

User/Customer identifier

Response Body

application/json

curl -X GET "https://example.com/c1/driftCalculators"
{  "statusCode": 200,  "statusString": "list returned",  "values": {    "stringList": {      "values": [        "dc1",        "dc2"      ]    }  }}

Create a drift calculator POST

Creates a named drift calculator that can later be fit against reference projects (`/fit`) and used to score other projects (`/calculate`). The request body is an inline object (not a named schema) carrying up to three independent `MLContext` configurations — one per drift metric the calculator should support — each keyed by metric name. All three are optional; omit any metric this calculator will not be used for. The response's `values.string` field is a plain string (the new drift calculator's id), not a named schema.

Analyze data drift between two projects POST

The request body is an `MLContext` whose `extraParameters` map carries: - **`drift_pref_project_name`** (required): the reference/baseline project. - **`drift_analysis_project_name`** (required): the project being analyzed for drift. May also be the literal value `rollingWindowEmbeddedProject`, to use the reference project's embedded rolling-window project. - **`drift_metric`** (optional, default `mahalanobis`): one of `mahalanobis`, `marginal_stat`, `marginal_non_stat`, or `pca_reconstruction_error`. - **`drift_confidence`** (optional, default `0.95`): applies to the `mahalanobis` and `marginal_stat` metrics. - Advanced `mahalanobis`-only tuning parameters, all optional: `drift_regularize`, `drift_force_spd`, `drift_filter_for_rank`, `drift_do_pca`, `drift_pca_explained_var`, `drift_sensitivity`, and `drift_do_frobenius`. `inputAttributeNames` is required (only the first name is used) when `drift_metric` is `marginal_stat` or `marginal_non_stat`. It is optional for `mahalanobis` and `pca_reconstruction_error`, where all attributes are used when omitted. The response's `KSVDMap` keys are metric-specific: each `drift_metric` returns a different set of score names, as shown in the examples below.