{ "opencollection": "1.0.0", "info": { "name": "OpenMetadata APIs Agent Executions ML Model Services API", "version": "1.13" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "ML Model Services", "type": "folder" }, "items": [ { "info": { "name": "Add a follower", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/services/mlmodelServices/:id/followers", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the MlModel Service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a user identified by `userId` as followed of this MlModel service" }, { "info": { "name": "Add test connection result", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/services/mlmodelServices/:id/testConnectionResult", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add test connection result to the service." }, { "info": { "name": "List ML model services", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/mlmodelServices", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "domain", "value": "", "type": "query", "description": "Filter services by domain" }, { "name": "limit", "value": "", "type": "query", "description": "Limit number services returned. (1 to 1000000, default 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of services before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of services after this cursor" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." } ] }, "docs": "Get a list of mlModel services. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params." }, { "info": { "name": "Create an ML model service", "type": "http" }, "http": { "method": "POST", "url": "/api/v1/services/mlmodelServices", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new mlModel service." }, { "info": { "name": "Update ML model service", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/services/mlmodelServices", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new mlModel service or update an existing mlModel service identified by `Id`." }, { "info": { "name": "Get an ML model service by name", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/mlmodelServices/name/:name", "params": [ { "name": "name", "value": "", "type": "path", "description": "Name of the ML Model service" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." }, { "name": "includeRelations", "value": "", "type": "query", "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value." } ] }, "docs": "Get a mlModel service by the service `name`." }, { "info": { "name": "Delete an ML model service by name", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/services/mlmodelServices/name/:name", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "name", "value": "", "type": "path", "description": "Name of the ML Model service" } ] }, "docs": "Delete a mlModel services by `name`. If mlModels (and tasks) belong to the service, it can't be deleted." }, { "info": { "name": "Get an ML model service by Id", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/mlmodelServices/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the ML Model service" }, { "name": "fields", "value": "", "type": "query", "description": "Fields requested in the returned resource" }, { "name": "include", "value": "", "type": "query", "description": "Include all, deleted, or non-deleted entities." }, { "name": "includeRelations", "value": "", "type": "query", "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value." } ] }, "docs": "Get a mlModel service by `Id`." }, { "info": { "name": "Update an ML model service", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/services/mlmodelServices/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the ML Model service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing MlModelService service using JsonPatch." }, { "info": { "name": "Delete an ML model service by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/services/mlmodelServices/:id", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the ML Model service" } ] }, "docs": "Delete a mlModel services. If mlModels (and tasks) belong to the service, it can't be deleted." }, { "info": { "name": "Asynchronously delete an ML model service by Id", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/services/mlmodelServices/async/:id", "params": [ { "name": "recursive", "value": "", "type": "query", "description": "Recursively delete this entity and it's children. (Default `false`)" }, { "name": "hardDelete", "value": "", "type": "query", "description": "Hard delete the entity. (Default = `false`)" }, { "name": "id", "value": "", "type": "path", "description": "Id of the ML Model service" } ] }, "docs": "Asynchronously delete a mlModel services. If mlModels (and tasks) belong to the service, it can't be deleted." }, { "info": { "name": "Remove a follower", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v1/services/mlmodelServices/:id/followers/:userId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the Entity" }, { "name": "userId", "value": "", "type": "path", "description": "Id of the user being removed as follower" } ] }, "docs": "Remove the user identified `userId` as a follower of the entity." }, { "info": { "name": "Get a version of the ML model service", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/mlmodelServices/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the ML Model service" }, { "name": "version", "value": "", "type": "path", "description": "mlModel service version number in the form `major`.`minor`" } ] }, "docs": "Get a version of the mlModel service by given `Id`" }, { "info": { "name": "List all entity versions within a time range", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/mlmodelServices/history", "params": [ { "name": "startTs", "value": "", "type": "query", "description": "Start timestamp in milliseconds since epoch" }, { "name": "endTs", "value": "", "type": "query", "description": "End timestamp in milliseconds since epoch" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of entity returned (1 to 1000000, default = 10)" }, { "name": "before", "value": "", "type": "query", "description": "Returns list of entity versions before this cursor" }, { "name": "after", "value": "", "type": "query", "description": "Returns list of entity versions after this cursor" } ] }, "docs": "Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. " }, { "info": { "name": "List ML model service versions", "type": "http" }, "http": { "method": "GET", "url": "/api/v1/services/mlmodelServices/:id/versions", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the ML Model service" } ] }, "docs": "Get a list of all the versions of a mlModel service identified by `Id`" }, { "info": { "name": "Update an ML model service using name.", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v1/services/mlmodelServices/name/:fqn", "params": [ { "name": "fqn", "value": "", "type": "path", "description": "Name of the ML Model service" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing MlModelService service using JsonPatch." }, { "info": { "name": "Restore a soft deleted ML model service", "type": "http" }, "http": { "method": "PUT", "url": "/api/v1/services/mlmodelServices/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a soft deleted Ml model service." } ] } ], "bundled": true }