Retrieve a model by its ID
Path Parameters
- model_id integer required
ID of the model
- 200
- 401
- 403
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
models object[]
array of objects that represent the models.
base stringthe name of the model used to create the modal that's being changed
created date-timecreation date
display_name stringa friendly name.
uuid uuidmodel unique identifier. Should be a UUID value
id integerPossible values:
>= 1
The ID of the model
language stringPossible values: [
en
,de
,ar
]long_description stringa longer description which proper describes the model
name stringinternal name. It should be unique for a workspace
owner stringprogress floatproject_id integerThe ID of the project
score floatmodel score. As this is a result of a training session, this value shouldn't be touched
short_description stringa short description to help users quickly identify the model
status stringPossible values: [
CREATED
,QUEUED
,TRAINING
,FAILED
,READY
,ACTIVE
,PUBLISHED
]the model status
type stringPossible values: [
ABSA
,CLASS
,LABEL
,CLASSLABEL
]model type (1: BASE, 2: ABSA, 3: LABEL, 4: CLASS, 5: CLASSLABEL))
- has_more boolean
indicates if a new request with a different offset should be done to get more models.
- offset integer
An offset is simply the number of records you wish to skip before selecting records.
- limit integer
Limit of entries that should be returned.
- count integer
Number of objects returned
{
"models": [
{
"base": "Hotel Pre-Trained",
"created": "2023-11-02",
"display_name": "My model 1",
"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": 0,
"language": "en",
"long_description": "My model 1 can predict anything I want",
"name": "My model 1",
"owner": "John Doe",
"progress": 6.78,
"project_id": 1,
"score": 0.68,
"short_description": "This is a very short description of My Model 1",
"status": "CREATED",
"type": "ABSA"
}
],
"has_more": true,
"offset": 0,
"limit": 10,
"count": 10
}
User is not authenticated. This means token is either not present or invalid
User does not have the minimal required model role "USER"
The model was not found
Something is wrong with the API.