Machine learning
This topic describes the operations and methods available to create and manipulate the
quests, endpoints, as well as custom algorithms.
Quests
| Method | Path | Description |
|---|---|---|
| GET | /mlquests/{questName} |
Retrieves a quest as a JSON object. |
| PUT | /mlquests/{questName} |
Updates a training and production (if present) quest from the provided JSON object. |
| DELETE | /mlquests/{questName} |
Deletes a quest. |
| PUT | |
Updates a production quest with the latest trained model from a training quest. |
| POST | /mlquests |
Creates a new training quest from a JSON object. Also creates a production quest if present in the JSON object. |
| POST | /mlquests/{questName}/trainingrun |
Runs a training quest. |
| POST | /mlquests/{questName}/productionrun |
Runs a production quest. |
| POST | /mlquests/{questName}/endpoint/redeploy |
Redeploys (updates) a realtime production endpoint. |
| POST | /mlquests/{questName}/endpoint/deploy |
Creates (deploys) a realtime production endpoint from a quest. |
| POST | /mlquests/query |
Returns a list of quests. |
| GET | /mlquests/{questName}/{trainingActivityName}/output |
Downloads custom training activity output stored by custom algorithm. |
| GET | /mlquests/{questName}/status |
Gets quest status. |
| GET | /mlquests/{questName}/endpoint/status |
Returns status of a realtime production endpoint created from a quest. |
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /mlendpoints/{endpointName}/deactivate |
Deactivates endpoint. |
| POST | /mlendpoints/{endpointName}/activate |
Activates endpoint. |
| GET | /mlendpoints/{endpointName}/status |
Gets endpoint status. |
| DELETE | /mlendpoints/{endpointName}/status |
Deletes endpoint. |
Custom algorithms
| Method | Path | Description |
|---|---|---|
| GET | /mlcustomalgorithms/{customAlgorithmName} |
Gets custom algorithm properties. |
| PUT | /mlcustomalgorithms/{customAlgorithmName} |
Updates custom algorithm. |
| DELETE | /mlcustomalgorithms/{customAlgorithmName} |
Deletes custom algorithm. |
| POST | /mlcustomalgorithms |
Creates a new custom algorithm. |
| POST | /mlcustomalgorithms/{customAlgorithmName}/hyperparameters |
Uploads the hyperparameters definition CSV file. |
| POST | /mlcustomalgorithms/{customAlgorithmName}/deploy |
Deploys a custom algorithm. |
| POST | /mlcustomalgorithms/{customAlgorithmName}/code |
Uploads a custom algorithm code ZIP archive. |
| POST | /mlcustomalgorithms/query |
Lists custom algorithms. |
| GET | /mlcustomalgorithms/{customAlgorithmName}/usage |
Gets usage in quests. |