All URIs are relative to http://localhost:8080/api/2.1/unity-catalog
| Method | HTTP request | Description |
|---|---|---|
| createRegisteredModel | POST /models | Create a model. WARNING: This API is experimental and will change in future versions. |
| deleteRegisteredModel | DELETE /models/{full_name} | Delete a specified registered model. |
| getRegisteredModel | GET /models/{full_name} | Get a specified registered model |
| listRegisteredModels | GET /models | List models |
| updateRegisteredModel | PATCH /models/{full_name} | Update a registered model |
RegisteredModelInfo createRegisteredModel(CreateRegisteredModel)
Create a model. WARNING: This API is experimental and will change in future versions.
Creates a new model instance. WARNING: This API is experimental and will change in future versions.
| Name | Type | Description | Notes |
|---|---|---|---|
| CreateRegisteredModel | CreateRegisteredModel | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
oas_any_type_not_mapped deleteRegisteredModel(full_name, force)
Delete a specified registered model.
Deletes a fully specified registered model. All versions of the model must have already been deleted.
| Name | Type | Description | Notes |
|---|---|---|---|
| full_name | String | Full name of the model. | [default to null] |
| force | Boolean | Force deletion even if the registered model still has model versions. | [optional] [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
RegisteredModelInfo getRegisteredModel(full_name)
Get a specified registered model
Gets a fully specified registered model.
| Name | Type | Description | Notes |
|---|---|---|---|
| full_name | String | Full name of the model. | [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
ListRegisteredModelsResponse listRegisteredModels(catalog_name, schema_name, max_results, page_token)
List models
Gets a paginated list of all available models either under the specified parent catalog and schema, or all models stored in UC. There is no guarantee of a specific ordering of the elements in the array.
| Name | Type | Description | Notes |
|---|---|---|---|
| catalog_name | String | Name of parent catalog for models of interest. | [optional] [default to null] |
| schema_name | String | Name of parent schema for models of interest. | [optional] [default to null] |
| max_results | Integer | Maximum number of models to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned; | [optional] [default to null] |
| page_token | String | Opaque token to send for the next page of results (pagination). | [optional] [default to null] |
No authorization required
- Content-Type: Not defined
- Accept: application/json
RegisteredModelInfo updateRegisteredModel(full_name, UpdateRegisteredModel)
Update a registered model
Updates the specified registered model.
| Name | Type | Description | Notes |
|---|---|---|---|
| full_name | String | Full name of the model. | [default to null] |
| UpdateRegisteredModel | UpdateRegisteredModel | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json