5.8.2.1 Datasets
The Datasets domain of ai-model-platform. Datasets for model work: a named selection of canonical data, built at a write number into immutable versions of Parquet files in the datasets bucket. Data scientists define and build them in the Console, request variants, and read versions from notebooks by manifest; nothing is downloaded or uploaded by hand. It is one API, with its own contract and its own version.
5.8.2.1.1 Versions¶
| Version | Status | Prod URL | Contract |
|---|---|---|---|
v1 |
Proposed | https://ai-model-platform.moonitoring.com/datasets/v1 |
datasets/v1/openapi.yaml |
The resources follow the data model. Follows the entities; a build is a BuildRequest, a variant a VariantRequest, both answered 202.
5.8.2.1.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 datasets | GET /datasets |
Staff | ai-model-platform.datasets.read |
| Create a dataset | POST /datasets |
Staff | ai-model-platform.datasets.manage |
| Read a dataset | GET /datasets/{dataset_id} |
Staff | ai-model-platform.datasets.read |
| Update a dataset | PATCH /datasets/{dataset_id} |
Staff | ai-model-platform.datasets.manage |
| Archive a dataset | POST /datasets/{dataset_id}/archive |
Staff | ai-model-platform.datasets.manage |
| List a dataset's versions | GET /datasets/{dataset_id}/versions |
Staff | ai-model-platform.datasets.read |
| Build a version | POST /datasets/{dataset_id}/versions |
Staff | ai-model-platform.datasets.manage |
| Read a version | GET /versions/{version_id} |
Staff | ai-model-platform.datasets.read |
| Delete a version | DELETE /versions/{version_id} |
Staff | ai-model-platform.datasets.manage |
| Build a variant | POST /versions/{version_id}/variants |
Staff | ai-model-platform.datasets.manage |
| Read the manifest location | POST /versions/{version_id}/manifest-url |
Staff | ai-model-platform.datasets.read |
| List a version's files | GET /versions/{version_id}/files |
Staff | ai-model-platform.datasets.read |
5.8.2.1.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.