SymetryML Documentation
Data drift

Create a drift calculator

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.

POST
/{user}/driftCalculator

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.

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

Query Parameters

id*string

Caller-supplied identifier for the new drift calculator

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/c1/driftCalculator?id=string" \  -H "Content-Type: application/json" \  -d '{    "mahalanobis": {      "extraParameters": {        "drift_metric": "mahalanobis"      }    }  }'
{  "statusCode": 201,  "statusString": "Drift Detector created with id [dc1] for customer [c1]",  "values": {    "string": "dc1"  }}

{  "statusCode": 500,  "statusString": "Generic Exception [java.lang.Exception: No id specified for DriftCalculator]",  "values": {}}