Page Comparison

Table of Contents

minLevel	2
maxLevel	2
type	flat

...

Endpoints and methods

Description

Status

colour	Yellow
title	GET

/models/{name}^{see below}

Get detailed information about a model.

Status

colour	Blue
title	PUT

/models/{name}^{see below}

Replace the data of an existing model.

Status

colour	Green
title	POST

/models/{name}^{see below}

Create a new model.

Status

colour	Red
title	DELETE

/models/{name} ^{see below}

Delete a model.

Status

colour	Green
title	PATCH

/models/{name} ^{see below}

Update an existing model.

Status

colour	Yellow
title	GET

/models/{name} ^{see below}

List the available models in the current domain.

Status

colour	Yellow
title	GET

/images/{name} ^{see below}

Get the binary image of a model.

Endpoints and methods

Anchor
path1
path1
GET `/models/{name}`

Get detailed information about a model.

...

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`name` ^required	`string`	Enter the name of the model you want to get information about.

Query string parameters

Query string parameters are optionally added after the path parameters, preceded by a question mark (?) and separated by an ampersand (&)

Parameter

Type

Description

fast

boolean

If it is true, it does not show the model image in details.

Default value is -.

Example

Find below a request example in cURL language:

Code Block
curl -X GET "https://api.stage.devo.com/mlmodelmanager/v3/models/MY FIRST MODEL?fast=true" -H "accept: application/json" -H "standAloneToken: cc81f6f5c73634002183d80b1fb736ec"

Expand

title	Response

Code

Description

200

Returns the retrieved model.

Code Block

{
  "id": 22,
  "name": "MY FIRST MODEL",
  "engine": "H2O",
  "location": "domains/self/632bfd1c-f734-44fd-af66-732410b953f1",
  "description": "A BRIEF DESCRIPTION",
  "updateDate": 1683714063000,
  "creationDate": 1683714063000,
  "domainName": "self",
  "outputType": "float8",
  "image": null,
  "category": "Regression",
  "fields": [
    {
      "id": 0,
      "name": "length",
      "description": "",
      "type": "float8"
    },
    {
      "id": 1,
      "name": "entropy",
      "description": "",
      "type": "float8"
    },
    {
      "id": 2,
      "name": "p_vowels",
      "description": "",
      "type": "float8"
    }
  ],
  "clusters": [],
  "parentId": null,
  "hidden": false,
  "runtimeSize": 78608,
  "fileSize": 77728
}

404

Returns a message when the model name is not found in the server.

500

Returned when an error occurred internally in the server.

Anchor
path2
path2
PUT `/models/{name}`

Replace the data of an existing model.

...

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`name` ^required	`string`	Enter the name of the model you want to replace the data of.

Request body

The request JSON body must include an object with the following key-value pairs:

Parameter	Type	Description
`engine`	`string`	The engine used to train and execute the model.
`fileName`	`string`
`description`	`string`	The description of the model.

Example

Find below a request example in cURL language:

Code Block
curl -H "standAloneToken:YOUR_TOKEN" -X GET "https://api-us.devo.com/aggregations/v2/aggrtasks/myDomain/cc_myDomain:abcDE123?skipCache=true"

Expand

title	Response

Code

Description

200

Returns a replaced model.

Code Block

{
  "name": "string",
  "engine": "string",
  "location": "string",
  "description": "string",
  "updateDate": 0,
  "creationDate": 0,
  "domainName": "string",
  "outputType": "string",
  "image": {
    "image": "string"
  },
  "category": "string",
  "fields": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "type": "string"
    }
  ],
  "clusters": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "centroid": [
        0
      ]
    }
  ],
  "runtimeSize": 0,
  "fileSize": 0
}

500

Returned when an error occurred internally in the server.

Anchor
path3
path3
POST `/models/{name}`

Create a model.

...

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`name` ^required	`string`	Enter the name of the model you want to create.

Request body

The request JSON body must include an object with the following key-value pairs:

Parameter	Type	Description
`engine`	`string`	The engine used to train and execute the model.
`fileName`	`string`
`description`	`string`	The description of the model.

Example

Find below a request example in cURL language:

Code Block

Expand

title	Response

Code

Description

200

Model has been successfully saved to the server.

Code Block

{
  "name": "string",
  "engine": "string",
  "location": "string",
  "description": "string",
  "updateDate": 0,
  "creationDate": 0,
  "domainName": "string",
  "outputType": "string",
  "image": {
    "image": "string"
  },
  "category": "string",
  "fields": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "type": "string"
    }
  ],
  "clusters": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "centroid": [
        0
      ]
    }
  ],
  "runtimeSize": 0,
  "fileSize": 0
}

409

The model already exists.

500

Returned when an error occurred internally in the server.

Anchor
path4
path4
DELETE`/models/{name}`

Delete a model.

...

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`name` ^required	`string`	Enter the name of the model you want to delete.

Example

Find below a request example in cURL language.

Code Block
curl -X DELETE "https://api.stage.devo.com/mlmodelmanager/v3/models/MY FIRST MODEL" -H "accept: /" -H "standAloneToken: cc81f6f5c73634002183d80b1fb736ec"

Expand

title	Response

Code	Description
200	Model successfully deleted.
404	Model not found.
500	Returned when an error occurred internally in the server.

Anchor
path5
path5
PATCH`/models/{name}`

Update an existing model.

...

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`name` ^required	`string`	Enter the name of the model you want to update.

Request body

The request JSON body must include an object with the following key-value pairs:

Parameter	Type	Description
`name`	`string`
`engine`	`string`
`location`	`string`
`description`	`string`
`updateDate`	`integer`
`creationDate`	`integer`
`domainName`	`string`
`outputType`	`string`
`image`
`category`	`string`
`runtimeSize`	`integer`
`fileSize`	`integer`

Example

Find below a request example in cURL language.

Code Block

Expand

title	Response

Code	Description
200	Returns the patched model.
400	Returns a message when the model name is not found in the server or the received patch JSON is incorrect.
500	Returned when an error occurred internally in the server.

Anchor
path6
path6
GET`/models/{name}`

List the available models in the current domain.

...

Expand

title	Response

Code

Description

200

Successful response.

Code Block

[
  {
    "id": 23,
    "name": "a new model",
    "engine": "H2O",
    "location": "domains/self/e27dd5ef-aedb-42ba-b0b9-21bca5338714",
    "description": "new",
    "updateDate": 1683718486000,
    "creationDate": 1683718486000,
    "domainName": "self",
    "outputType": "float8",
    "image": null,
    "category": "Regression",
    "fields": [
      {
        "id": 0,
        "name": "length",
        "description": "",
        "type": "float8"
      },
      {
        "id": 1,
        "name": "entropy",
        "description": "",
        "type": "float8"
      },
      {
        "id": 2,
        "name": "p_vowels",
        "description": "",
        "type": "float8"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 78608,
    "fileSize": 77728
  },
  {
    "id": 21,
    "name": "dga_classifier_onnx_demo",
    "engine": "ONNX",
    "location": "domains/self/823b3522-895c-411e-a4f3-2762db27a6fc",
    "description": null,
    "updateDate": 1681900499000,
    "creationDate": 1681900499000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "description": "",
        "type": "array(float4)"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 880,
    "fileSize": 3881
  },
  {
    "id": 20,
    "name": "graeme_test2",
    "engine": "ONNX",
    "location": "domains/self/b96fe0d9-74f2-4f51-a301-ff7573c0f6bd",
    "description": null,
    "updateDate": 1681804104000,
    "creationDate": 1681804104000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "description": "",
        "type": "array(float4)"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 876,
    "fileSize": 229468
  },
  {
    "id": 19,
    "name": "graeme_test",
    "engine": "ONNX",
    "location": "domains/self/82178f93-af1b-4d1b-9438-67b842a6bee8",
    "description": null,
    "updateDate": 1681738747000,
    "creationDate": 1681738724000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "description": "",
        "type": "array(float4)"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 876,
    "fileSize": 229468
  },
  {
    "id": 17,
    "name": "dga_scoring",
    "engine": "ONNX",
    "location": "domains/self/85132b1f-59fa-4859-9198-e6ce49258916",
    "description": "DGA domain label scoring",
    "updateDate": 1678361980000,
    "creationDate": 1678361980000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "description": "",
        "type": "array(float4)"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 892,
    "fileSize": null
  },
  {
    "id": 16,
    "name": "pokemon_onnx",
    "engine": "ONNX",
    "location": "domains/self/dd374598-af8e-4542-8663-e7e8e0cdbf38",
    "description": "this is the description",
    "updateDate": 1678201475000,
    "creationDate": 1678201449000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "description": "",
        "type": "array(float4)"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 876,
    "fileSize": 229468
  },
  {
    "id": 4,
    "name": "gptest",
    "engine": "ONNX",
    "location": "domains/self/126e92c2-d724-40cf-a6cf-3dc9f63e9219",
    "description": "",
    "updateDate": 1676390228000,
    "creationDate": 1676390228000,
    "domainName": "self",
    "outputType": "array(float4)",
    "image": null,
    "category": "ONNX",
    "fields": [
      {
        "id": 0,
        "name": "field_0",
        "description": "",
        "type": "array(float4)"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 876,
    "fileSize": 229468
  },
  {
    "id": 2,
    "name": "RRCF",
    "engine": "IDA",
    "location": "domains/self/f868583b-011d-48ea-970c-eb059f06b951",
    "description": "Testing RRCF in Flow",
    "updateDate": 1676291578000,
    "creationDate": 1676291578000,
    "domainName": "self",
    "outputType": "float8",
    "image": null,
    "category": "Rrcf",
    "fields": [
      {
        "id": 0,
        "name": "dimension_0",
        "description": "",
        "type": "float8"
      }
    ],
    "clusters": [],
    "parentId": null,
    "hidden": false,
    "runtimeSize": 23764,
    "fileSize": 227
  }
]

500

Returned when an error occurred internally in the server.

Anchor
path7
path7
GET`/images/{name}`

Get the binary image of a model.

...

Expand

title	Request

Path parameters

Add the following path parameters as part of the endpoint:

Parameter	Type	Description
`name` ^required	`string`	Enter the name of the model you want to get the binary image of.

Example

Find below a request example in cURL language.

Code Block
curl -X GET "https://api.stage.devo.com/mlmodelmanager/v3/images/RRCF" -H "accept: /" -H "standAloneToken: cc81f6f5c73634002183d80b1fb736ec"

...

Version	Old Version 9	New Version 10
Changes made by	Former user	Former user
Saved on	May 10, 2023	May 10, 2023

Versions Compared

Key

Endpoints and methods

Anchor
path1
path1
GET `/models/{name}`

Query string parameters

Anchor
path2
path2
PUT `/models/{name}`

Request body

Anchor
path3
path3
POST `/models/{name}`

Request body

Anchor
path4
path4
DELETE`/models/{name}`

Path parameters

Anchor
path5
path5
PATCH`/models/{name}`

Anchor
path6
path6
GET`/models/{name}`

Anchor
path7
path7
GET`/images/{name}`

Page Comparison

Versions Compared

Key

Endpoints and methods

Anchorpath1path1 GET /models/{name}

Query string parameters

Anchorpath2path2PUT /models/{name}

Request body

Anchorpath3path3POST /models/{name}

Request body

Anchorpath4path4DELETE/models/{name}

Path parameters

Anchorpath5path5PATCH/models/{name}

Anchorpath6path6GET/models/{name}

Anchorpath7path7GET/images/{name}

Anchor
path1
path1
GET `/models/{name}`

Anchor
path2
path2
PUT `/models/{name}`

Anchor
path3
path3
POST `/models/{name}`

Anchor
path4
path4
DELETE`/models/{name}`

Anchor
path5
path5
PATCH`/models/{name}`

Anchor
path6
path6
GET`/models/{name}`

Anchor
path7
path7
GET`/images/{name}`