Learn from a registered data source
Learns from a registered data source (as opposed to `learn`, which learns from a small `DataFrame` posted inline). Unlike `learn`, there is no `async` query parameter — this endpoint is **always** asynchronous: it immediately returns `202` with the job id in the `sym-job-id` response header and an empty body. Poll `GET /{user}/jobs/{jobId}` with that id for completion/progress; this endpoint's own response is never a job-status payload. The `DataFrame` request body carries no data rows — it only specifies the `attributeNames`/`attributeTypes` to use when learning from the data source's own data.
Learns from a registered data source (as opposed to learn, which
learns from a small DataFrame posted inline). Unlike learn,
there is no async query parameter — this endpoint is always
asynchronous: it immediately returns 202 with the job id in the
sym-job-id response header and an empty body. Poll GET /{user}/jobs/{jobId} with that id for completion/progress; this
endpoint's own response is never a job-status payload.
The DataFrame request body carries no data rows — it only
specifies the attributeNames/attributeTypes to use when
learning from the data source's own data.
Authorization
SymetryMLAuth 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/Customer identifier
Project identifier
Data source name
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/projects/nbra_prj_iris/dss/nbra_ds_sftp_iris/learn" \ -H "Content-Type: application/json" \ -d '{ "attributeNames": [ "sepal_length", "sepal_width", "petal_length", "petal_width", "Iris_setosa" ], "attributeTypes": [ "C", "C", "C", "C", "B" ] }'{ "statusCode": 202, "statusString": "Job Created", "values": {}}{ "statusCode": 400, "statusString": "DS 'unknownDs' not found", "values": {}}Forget data from a registered data source POST
Forgets from a registered data source — the inverse of `dss/{dsName}/learn`. Also always asynchronous: immediately returns `202` with the job id in the `sym-job-id` response header and an empty body. The `DataFrame` request body carries no data rows — it only specifies the `attributeNames`/`attributeTypes` to use when forgetting from the data source's own data.
Forget frame data POST
Forgets a raw `DataFrame` posted inline — the inverse of `learn`. Set `async=true` to run as a background job (`202`, job id in the `sym-job-id` header, empty body); without it, forgetting happens synchronously and the `200` response body has empty `values`. Not supported on `sequence`-type projects.