/**
* Publish the model to ML registry
*
* @param modelId Unique id of the model to be published
* @return JSON of {@link org.wso2.carbon.ml.rest.api.model.MLResponseBean} containing the
* published location of the model
*/
@POST
@Path("/{modelId}/publish")
@Produces("application/json")
@Consumes("application/json")
public Response publishModel(@PathParam("modelId") long modelId) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
String registryPath = mlModelHandler.publishModel(tenantId, userName, modelId);
return Response.ok(new MLResponseBean(registryPath)).build();
} catch (InvalidRequestException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while publishing the model [id] %s of tenant [id] %s and [user] %s .",
modelId, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.BAD_REQUEST)
.entity(new MLErrorBean(e.getMessage()))
.build();
} catch (MLModelPublisherException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while publishing the model [id] %s of tenant [id] %s and [user] %s .",
modelId, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Predict using a file and return as a list of predicted values.
*
* @param modelId Unique id of the model
* @param dataFormat Data format of the file (CSV or TSV)
* @param inputStream File input stream generated from the file used for predictions
* @return JSON array of predictions
*/
@POST
@Path("/predict")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.MULTIPART_FORM_DATA)
public Response predict(
@Multipart("modelId") long modelId,
@Multipart("dataFormat") String dataFormat,
@Multipart("file") InputStream inputStream) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
// validate input parameters
// if it is a file upload, check whether the file is sent
if (inputStream == null || inputStream.available() == 0) {
String msg =
String.format(
"Error occurred while reading the file for model [id] %s of tenant [id] %s and [user] %s .",
modelId, tenantId, userName);
logger.error(msg);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(msg))
.build();
}
List<?> predictions =
mlModelHandler.predict(tenantId, userName, modelId, dataFormat, inputStream);
return Response.ok(predictions).build();
} catch (IOException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while reading the file for model [id] %s of tenant [id] %s and [user] %s.",
modelId, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.BAD_REQUEST)
.entity(new MLErrorBean(e.getMessage()))
.build();
} catch (MLModelHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while predicting from model [id] %s of tenant [id] %s and [user] %s.",
modelId, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Create a new Project. No validation happens here. Please call {@link #getProject(String)}
* before this.
*
* @param project {@link org.wso2.carbon.ml.commons.domain.MLProject} object
*/
@POST
@Produces("application/json")
@Consumes("application/json")
public Response createProject(MLProject project) {
if (project.getName() == null
|| project.getName().isEmpty()
|| project.getDatasetName() == null
|| project.getDatasetName().isEmpty()) {
logger.error("Required parameters missing");
return Response.status(Response.Status.BAD_REQUEST)
.entity("Required parameters missing")
.build();
}
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
project.setTenantId(tenantId);
project.setUserName(userName);
mlProjectHandler.createProject(project);
return Response.ok().build();
} catch (MLProjectHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while creating a [project] %s of tenant [id] %s and [user] %s .",
project, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Delete a project
*
* @param projectId Unique id of the project
*/
@DELETE
@Path("/{projectId}")
@Produces("application/json")
public Response deleteProject(@PathParam("projectId") long projectId) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
mlProjectHandler.deleteProject(tenantId, userName, projectId);
auditLog.info(
String.format(
"User [name] %s of tenant [id] %s deleted a project [id] %s ",
userName, tenantId, projectId));
return Response.ok().build();
} catch (MLProjectHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while deleting a project [id] %s of tenant [id] %s and [user] %s .",
projectId, tenantId, userName),
e);
logger.error(msg, e);
auditLog.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Get analysis of a project given the analysis name
*
* @param projectId Unique id of the project
* @param analysisName Name of the analysis
* @return JSON of {@link org.wso2.carbon.ml.commons.domain.MLAnalysis} object
*/
@GET
@Path("/{projectId}/analyses/{analysisName}")
@Produces("application/json")
public Response getAnalysisOfProject(
@PathParam("projectId") long projectId, @PathParam("analysisName") String analysisName) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
MLAnalysis analysis =
mlProjectHandler.getAnalysisOfProject(tenantId, userName, projectId, analysisName);
if (analysis == null) {
return Response.status(Response.Status.NOT_FOUND).build();
}
return Response.ok(analysis).build();
} catch (MLProjectHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while retrieving analysis with [name] %s of project [id] %s of tenant [id] %s and [user] %s .",
analysisName, projectId, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Create a new Model.
*
* @param model {@link org.wso2.carbon.ml.commons.domain.MLModelData} object
* @return JSON of {@link org.wso2.carbon.ml.commons.domain.MLModelData} object
*/
@POST
@Produces("application/json")
@Consumes("application/json")
public Response createModel(MLModelData model) {
if (model.getAnalysisId() == 0 || model.getVersionSetId() == 0) {
logger.error("Required parameters missing");
return Response.status(Response.Status.BAD_REQUEST)
.entity("Required parameters missing")
.build();
}
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
try {
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
model.setTenantId(tenantId);
model.setUserName(userName);
MLModelData insertedModel = mlModelHandler.createModel(model);
return Response.ok(insertedModel).build();
} catch (MLModelHandlerException e) {
String msg = MLUtils.getErrorMsg("Error occurred while creating a model : " + model, e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Get the model data
*
* @param modelName Name of the model
* @return JSON of {@link org.wso2.carbon.ml.commons.domain.MLModelData} object
*/
@GET
@Path("/{modelName}")
@Produces("application/json")
public Response getModel(@PathParam("modelName") String modelName) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
MLModelData model = mlModelHandler.getModel(tenantId, userName, modelName);
if (model == null) {
return Response.status(Response.Status.NOT_FOUND).build();
}
return Response.ok(model).build();
} catch (MLModelHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while retrieving a model [name] %s of tenant [id] %s and [user] %s .",
modelName, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Make predictions using a model
*
* @param modelId Unique id of the model
* @param data List of string arrays containing the feature values used for predictions
* @return JSON array of predicted values
*/
@POST
@Path("/{modelId}/predict")
@Produces("application/json")
@Consumes("application/json")
public Response predict(@PathParam("modelId") long modelId, List<String[]> data) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
long t1 = System.currentTimeMillis();
List<?> predictions = mlModelHandler.predict(tenantId, userName, modelId, data);
logger.info(
String.format(
"Prediction from model [id] %s finished in %s seconds.",
modelId, (System.currentTimeMillis() - t1) / 1000.0));
return Response.ok(predictions).build();
} catch (MLModelHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while predicting from model [id] %s of tenant [id] %s and [user] %s.",
modelId, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Get all projects created with the given dataset
*
* @param datasetName Name of the dataset
* @return JSON array of {@link org.wso2.carbon.ml.rest.api.model.MLProjectBean} objects
*/
@GET
@Path("/analyses")
@Produces("application/json")
public Response getAllProjectsWithAnalyses(@QueryParam("datasetName") String datasetName) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
List<MLProject> projects = mlProjectHandler.getAllProjects(tenantId, userName);
List<MLProjectBean> projectBeans = new ArrayList<MLProjectBean>();
for (MLProject mlProject : projects) {
if (!StringUtils.isEmpty(datasetName) && !datasetName.equals(mlProject.getDatasetName())) {
continue;
}
MLProjectBean projectBean = new MLProjectBean();
long projectId = mlProject.getId();
projectBean.setId(projectId);
projectBean.setCreatedTime(mlProject.getCreatedTime());
projectBean.setDatasetId(mlProject.getDatasetId());
projectBean.setDatasetName(mlProject.getDatasetName());
projectBean.setDatasetStatus(mlProject.getDatasetStatus());
projectBean.setDescription(mlProject.getDescription());
projectBean.setName(mlProject.getName());
List<MLAnalysisBean> analysisBeans = new ArrayList<MLAnalysisBean>();
List<MLAnalysis> analyses =
mlProjectHandler.getAllAnalysesOfProject(tenantId, userName, projectId);
for (MLAnalysis mlAnalysis : analyses) {
MLAnalysisBean analysisBean = new MLAnalysisBean();
analysisBean.setId(mlAnalysis.getId());
analysisBean.setName(mlAnalysis.getName());
analysisBean.setProjectId(mlAnalysis.getProjectId());
analysisBean.setComments(mlAnalysis.getComments());
analysisBeans.add(analysisBean);
}
projectBean.setAnalyses(analysisBeans);
projectBeans.add(projectBean);
}
return Response.ok(projectBeans).build();
} catch (MLProjectHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while retrieving all analyses of tenant [id] %s and [user] %s .",
tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Get all projects
*
* @return JSON array of {@link org.wso2.carbon.ml.commons.domain.MLProject} objects
*/
@GET
@Produces("application/json")
public Response getAllProjects() {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
List<MLProject> projects = mlProjectHandler.getAllProjects(tenantId, userName);
return Response.ok(projects).build();
} catch (MLProjectHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while retrieving all projects of tenant [id] %s and [user] %s .",
tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Download the model
*
* @param modelName Name of the model
* @return A {@link org.wso2.carbon.ml.commons.domain.MLModel} as a {@link
* javax.ws.rs.core.StreamingOutput}
*/
@GET
@Path("/{modelName}/export")
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response exportModel(@PathParam("modelName") String modelName) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
MLModelData model = mlModelHandler.getModel(tenantId, userName, modelName);
if (model != null) {
final MLModel generatedModel = mlModelHandler.retrieveModel(model.getId());
StreamingOutput stream =
new StreamingOutput() {
public void write(OutputStream outputStream) throws IOException {
ObjectOutputStream out = new ObjectOutputStream(outputStream);
out.writeObject(generatedModel);
}
};
return Response.ok(stream)
.header("Content-disposition", "attachment; filename=" + modelName)
.build();
} else {
return Response.status(Response.Status.NOT_FOUND).build();
}
} catch (MLModelHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while retrieving model [name] %s of tenant [id] %s and [user] %s .",
modelName, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Get the model summary
*
* @param modelId Unique id of the model
* @return JSON of {@link org.wso2.carbon.ml.commons.domain.ModelSummary} object
*/
@GET
@Path("/{modelId}/summary")
@Produces("application/json")
@Consumes("application/json")
public Response getModelSummary(@PathParam("modelId") long modelId) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
ModelSummary modelSummary = mlModelHandler.getModelSummary(modelId);
return Response.ok(modelSummary).build();
} catch (MLModelHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while retrieving summary of the model [id] %s of tenant [id] %s and [user] %s .",
modelId, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}
/**
* Predict using a file and return predictions as a CSV.
*
* @param modelId Unique id of the model
* @param dataFormat Data format of the file (CSV or TSV)
* @param columnHeader Whether the file contains the column header as the first row (YES or NO)
* @param inputStream Input stream generated from the file used for predictions
* @return A file as a {@link javax.ws.rs.core.StreamingOutput}
*/
@POST
@Path("/predictionStreams")
@Produces(MediaType.APPLICATION_OCTET_STREAM)
@Consumes(MediaType.MULTIPART_FORM_DATA)
public Response streamingPredict(
@Multipart("modelId") long modelId,
@Multipart("dataFormat") String dataFormat,
@Multipart("columnHeader") String columnHeader,
@Multipart("file") InputStream inputStream) {
PrivilegedCarbonContext carbonContext = PrivilegedCarbonContext.getThreadLocalCarbonContext();
int tenantId = carbonContext.getTenantId();
String userName = carbonContext.getUsername();
try {
// validate input parameters
// if it is a file upload, check whether the file is sent
if (inputStream == null || inputStream.available() == 0) {
String msg =
String.format(
"Error occurred while reading the file for model [id] %s of tenant [id] %s and [user] %s .",
modelId, tenantId, userName);
logger.error(msg);
return Response.status(Response.Status.BAD_REQUEST).entity(new MLErrorBean(msg)).build();
}
final String predictions =
mlModelHandler.streamingPredict(
tenantId, userName, modelId, dataFormat, columnHeader, inputStream);
StreamingOutput stream =
new StreamingOutput() {
@Override
public void write(OutputStream outputStream) throws IOException {
Writer writer =
new BufferedWriter(new OutputStreamWriter(outputStream, StandardCharsets.UTF_8));
writer.write(predictions);
writer.flush();
writer.close();
}
};
return Response.ok(stream)
.header(
"Content-disposition",
"attachment; filename=Predictions_"
+ modelId
+ "_"
+ MLUtils.getDate()
+ MLConstants.CSV)
.build();
} catch (IOException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while reading the file for model [id] %s of tenant [id] %s and [user] %s.",
modelId, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.BAD_REQUEST)
.entity(new MLErrorBean(e.getMessage()))
.build();
} catch (MLModelHandlerException e) {
String msg =
MLUtils.getErrorMsg(
String.format(
"Error occurred while predicting from model [id] %s of tenant [id] %s and [user] %s.",
modelId, tenantId, userName),
e);
logger.error(msg, e);
return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
.entity(new MLErrorBean(e.getMessage()))
.build();
}
}