SymetryML Documentation

SymetryML Job Information

Specific Job Information

This API function reports specific job information.

URL

GET /symetry/rest/{cid}/jobs/{jobid}

HTTP Responses

HTTP Status CodeHTTP Status MessageDescription
200OKJob has finished. {"statusCode":"OK","statusString":"Job is finished","values":{}}
202ACCEPTEDJob is still running. {"statusCode":"ACCEPTED","statusString":"Job still running","values":{}}
400BAD REQUESTInvalid job ID. {"statusCode":"BAD_REQUEST","statusString":"No such job","values":{}}

HTTP Response Entity

HTTP Response EntityDescription The entity returned by the job depends on the type of job that just finished. For example:
AutoSelectJobsThe JobInfo will contains many additional information in the details map. All the MLContext parameters are returned as well as the id of the data source being used for validation dataset or the first 5 lines of the Dataframe if an actual DataFrame was used instead of a data source id - depending on which REST method was used (With data source id or with a Dataframe)
Single ProjectInfo JobsSee Project Info endpoint. It returns a ProjectInfo response upon completion.
List Projects Info JobsSee List All Projects Info endpoint. It returns a ProjectInfoList response upon completion.
DS Predict JobsSee Predict API. It returns a DataFrame that contains the predictions.
ExploreJobreturn 2 entities KSVDMap entity and a ProjectInfo entity. Please consult the Exploration HTTP Response Entity for details
SVDJobreturns a KSVSMap.
PCA Jobreturn 2 entities (pcaVectors and pcaValues) Both are DataFrame data structure.
AwsInfoJobreturns a AwsInfo datastructure
DSUpdateJobreturns ProjectInfo that reflects new state of the project.
SparkDSUpdateJobreturns ProjectInfo that reflects new state of the project.
ExploreVIFJobreturns a KSVSMap.
Optimized Kmeans Jobreturns a KSVSMap. The returned keys are in the format kmeans_{N}_wssse and kmeans_{N}_silhouette where the corresponding values represent the respective WSSSE and Silhouette scores for a model build with N clusters.
DSPredictDataFrameJobreturns a DataFrame. The returned DataFrame contains the following information: id - row id res - anomaly flag via a simple rule q95 - 95% quantile of model scores q98 - 98% quantile of model scores q99 - 99% quantile of model scores evt - anomaly flag via Extreme Value Theory rule
Other jobs do not return any entity.If a job is not finished or has yet to be started, it returns a JobInfo entity that contains detailed information about a given job. See JobInfo.

List All Jobs

This API function lists all current jobs.

URL

GET /symetry/rest/{cid}/jobs

HTTP Responses

HTTP Status CodeHTTP Status MessageDescription
200OKJob has finished. {"statusCode":"OK","statusString":"Job is finished","values":{}}

HTTP Response Entity

HTTP Response EntityDescription
JobInfo []Response contains a list of all the currently created on the computer.

Kill a Job

This API function kills a job.

URL

DELETE /symetry/rest/{cid}/jobs/{jobid}

HTTP Responses

HTTP Status CodeHTTP Status MessageDescription
200OKJob was killed.
202ACCEPTEDJob cannot be killed.
400BAD REQUESTInvalid job ID. {"statusCode":"BAD_REQUEST","statusString":"No such job","values":{}}

On this page