Update Model

Update a Model

Supply the unique id of the Model to update and an object describing which fields update

Request
path Parameters
id
required
string

ID of the Model to Update

query Parameters
system
boolean
Request Body schema: application/json

The values to update with

name
string or null

The models name

description
string or null

description of the model

datasetId
string or null

The datasets id that the model is connected to

Array of ItemArtifact (object) or LocalArtifact (object) or null

the artifacts of the model an artifact indicates where the model binaries sit

scope
string or null

Field that shows the scope in which the model exists

Enum: "private" "project" "org" "public"
status
string or null

the current models status

Enum: "created" "pending" "training" "trained" "deployed" "failed"
tags
Array of strings or null

Tags related to the model

labels
Array of strings or null

Labels related to the model

object or null

The configuration that the model was created with

inputType
string or null

Model Input Type

Enum: "image" "video" "text" "audio"
outputType
string or null

Model Output Type

Enum: "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text" "ref_image" "ref_semantic_3d" "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text" "ref_image" "ref_semantic_3d" "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text"
object or null
moduleName
string or null

The module name of the model

property name*
additional property
any
Responses
200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/ml/models/{id}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "datasetId": "string",
  • "artifacts": [
    ],
  • "scope": "private",
  • "status": "created",
  • "tags": [
    ],
  • "labels": [
    ],
  • "configuration": {
    },
  • "inputType": "image",
  • "outputType": "class",
  • "metadata": {
    },
  • "moduleName": "string"
}
Response samples
application/json
{
  • "name": "My Model",
  • "description": "My Model Description",
  • "status": "deployed"
}