SymetryML Job Information

Specific Job Information

This API function reports specific job information.

URL

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

HTTP Responses

HTTP Status Code	HTTP Status Message	Description
200	OK	Job has finished. {"statusCode":"OK","statusString":"Job is finished","values":{}}
202	ACCEPTED	Job is still running. {"statusCode":"ACCEPTED","statusString":"Job still running","values":{}}
400	BAD REQUEST	Invalid job ID. {"statusCode":"BAD_REQUEST","statusString":"No such job","values":{}}

HTTP Response Entity

HTTP Response Entity	Description The entity returned by the job depends on the type of job that just finished. For example:
AutoSelectJobs	The 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 Jobs	See Project Info endpoint. It returns a ProjectInfo response upon completion.
List Projects Info Jobs	See List All Projects Info endpoint. It returns a ProjectInfoList response upon completion.
DS Predict Jobs	See Predict API. It returns a DataFrame that contains the predictions.
ExploreJob	return 2 entities KSVDMap entity and a ProjectInfo entity. Please consult the Exploration HTTP Response Entity for details
SVDJob	returns a KSVSMap.
PCA Job	return 2 entities (pcaVectors and pcaValues) Both are DataFrame data structure.
AwsInfoJob	returns a AwsInfo datastructure
DSUpdateJob	returns ProjectInfo that reflects new state of the project.
SparkDSUpdateJob	returns ProjectInfo that reflects new state of the project.
ExploreVIFJob	returns a KSVSMap.
Optimized Kmeans Job	returns 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.
DSPredictDataFrameJob	returns 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 Code	HTTP Status Message	Description
200	OK	Job has finished. {"statusCode":"OK","statusString":"Job is finished","values":{}}

HTTP Response Entity

HTTP Response Entity	Description
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 Code	HTTP Status Message	Description
200	OK	Job was killed.
202	ACCEPTED	Job cannot be killed.
400	BAD REQUEST	Invalid job ID. {"statusCode":"BAD_REQUEST","statusString":"No such job","values":{}}