Change project data.
Any project attribute can be given that should be updated.
Path Parameters
- project_id integer required
ID of the project to change
- application/json
Request Body required
- name string
Unique identifier representing the project name
- type string
Possible values: [
ABSA
,CLASS
,LABEL
,CLASSLABEL
]Classification Type
- 200
- 400
- 403
- 404
- 500
Project was changed
- application/json
- Schema
- Example (from schema)
Schema
- classes string[]
All classes that belong to the project.
- labels string[]
All labels that belong to the project
- created date-time
- id integer
The ID of the project.
models object[]
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))
- name string
The project's name.
- type string
Possible values: [
ABSA
,CLASS
,LABEL
,CLASSLABEL
]The project's classification type.
- status string
Possible values: [
CREATED
,CLONING
,DELETED
,FAILED
]The project's status.
- external_id integer
External ID is a integer that represents a project in our labeling API project.
{
"classes": [
"Comfort"
],
"labels": [
"Staff"
],
"created": "2023-11-02",
"id": 1,
"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"
}
],
"name": "My first project!",
"type": "ABSA",
"status": "CREATED",
"external_id": 412
}
The body sent is invalid. Check the error message for more details
User is not a beta user or does not have the minimal required project role "MANAGER"
The project was not found
Something is wrong with the API.