ML API 🟡 BETA

The ML API provides endpoints for machine learning operations, model training, and predictive analytics.

Status: Roadmap

This API is on the development roadmap. The endpoints documented below represent the planned interface design.

Base URL

http://localhost:9000/api/v1/ml

Authentication

Uses the standard botserver authentication mechanism with appropriate role-based permissions.

Endpoints

Dataset Management

Model Training

Predictions

Model Evaluation

Feature Engineering

Request Examples

Create Dataset

dataset = NEW OBJECT
dataset.name = "customer_churn"
dataset.source = "customers_table"
dataset.target_column = "churned"

result = POST "/api/v1/ml/datasets", dataset
TALK "Dataset created: " + result.id

Start Training Job

training_config = NEW OBJECT
training_config.dataset_id = "ds-123"
training_config.model_type = "classification"
training_config.algorithm = "random_forest"
training_config.parameters = {"n_estimators": 100, "max_depth": 10}

job = POST "/api/v1/ml/train", training_config
TALK "Training job started: " + job.job_id

Make Prediction

input = NEW OBJECT
input.model_id = "model-456"
input.features = {"age": 35, "tenure": 24, "monthly_charges": 75.50}

result = POST "/api/v1/ml/predict", input
TALK "Prediction: " + result.prediction
TALK "Confidence: " + result.confidence

Batch Predictions

batch_input = NEW OBJECT
batch_input.model_id = "model-456"
batch_input.data = [
    {"age": 25, "tenure": 12, "monthly_charges": 50.00},
    {"age": 45, "tenure": 36, "monthly_charges": 95.00},
    {"age": 30, "tenure": 6, "monthly_charges": 65.00}
]

results = POST "/api/v1/ml/batch-predict", batch_input
FOR EACH result IN results.predictions
    TALK result.id + ": " + result.prediction
NEXT

Get Model Metrics

metrics = GET "/api/v1/ml/models/model-456/metrics"
TALK "Accuracy: " + metrics.accuracy
TALK "Precision: " + metrics.precision
TALK "Recall: " + metrics.recall
TALK "F1 Score: " + metrics.f1_score

Supported Algorithms

Classification

Regression

Clustering

Response Codes

Job Status Values

Required Permissions