REST API
Describe a Model
REST API
Describe a Model
Gets the attributes of a specific model.
GET
/api/projects/{projectName}/models/{modelName}/describe
projectName*
modelName*
curl --request GET \
--url http://127.0.0.1:47334/api/projects/{projectName}/models/{modelName}/describe \
--header 'Content-Type: application/json'[
{
"accuracies": {
"r2_score": 0.999
},
"column_importances": {
"days_on_market": 0.116,
"location": 0.054,
"neighborhood": 0.0,
"number_of_bathrooms": 0.009,
"number_of_rooms": 0.297,
"sqft": 1.037
},
"inputs": [
"number_of_rooms",
"number_of_bathrooms",
"sqft",
"location",
"days_on_market",
"neighborhood"
],
"model": "encoders --> dtype_dict --> dependency_dict --> model --> problem_definition --> identifiers --> imputers --> accuracy_functions",
"outputs": [
"rental_price"
]
}
]
The REST API playground can currently only be used with MindsDB running locally at http://127.0.0.1:47334. Support for MindsDB Cloud is in progress. In the meantime, check out our SQL example for how to use the REST API with MindsDB Cloud.
Path Parameters
projectNamerequired
string
The name of the project
modelNamerequired
string
The name of the model
Body
attribute
string
Attribute of the model to describe. See our DESCRIBE documentation. E.g. info, features, model
Response
object
curl --request GET \
--url http://127.0.0.1:47334/api/projects/{projectName}/models/{modelName}/describe \
--header 'Content-Type: application/json'[
{
"accuracies": {
"r2_score": 0.999
},
"column_importances": {
"days_on_market": 0.116,
"location": 0.054,
"neighborhood": 0.0,
"number_of_bathrooms": 0.009,
"number_of_rooms": 0.297,
"sqft": 1.037
},
"inputs": [
"number_of_rooms",
"number_of_bathrooms",
"sqft",
"location",
"days_on_market",
"neighborhood"
],
"model": "encoders --> dtype_dict --> dependency_dict --> model --> problem_definition --> identifiers --> imputers --> accuracy_functions",
"outputs": [
"rental_price"
]
}
]