5.8.2.2 Model Runs
The Model Runs domain of ai-model-platform. Every use of the data by a model, so it can be rebuilt exactly: training, scoring, pricing and analyses, with the write number read, the feature code version, the rule set and the knowledge clock. Pipelines record their runs; farm records the runs of on-demand predictions through the gRPC service of the Models domain. It is one API, with its own contract and its own version.
5.8.2.2.1 Versions¶
| Version | Status | Prod URL | Contract |
|---|---|---|---|
v1 |
Proposed | https://ai-model-platform.moonitoring.com/runs/v1 |
runs/v1/openapi.yaml |
The resources follow the data model. Follows ModelRun. Runs of on-demand predictions are recorded by ai-model-platform itself when farm calls Predict.
5.8.2.2.2 Operations¶
Every operation names who calls it and the capability it checks (x-moonitoring-audience, x-moonitoring-capability in the contract); every capability is in the catalog of the data model (req 1002, 1006). Lists are paged by cursor, writes that create something carry an Idempotency-Key, errors are Problem Details.
| Operation | Request | Who | Capability |
|---|---|---|---|
| List model runs | GET /runs |
Staff | ai-model-platform.datasets.read or ai-model-platform.models.read |
| Record a model run | POST /runs |
Staff | ai-model-platform.models.manage or ai-model-platform.datasets.read |
| Read a model run | GET /runs/{run_id} |
Staff | ai-model-platform.datasets.read or ai-model-platform.models.read |
5.8.2.2.3 Contract v1¶
Proposed version
v1 is a proposal for review: its endpoints, errors and capabilities were designed from the requirements and the flows and are not confirmed. It leaves proposal with its first release; from then on it changes only as described in Every API Is Versioned.