ML

Get ML backend

GET

Path parameters

idintegerRequired
A unique integer value identifying this ml backend.

Response

This endpoint returns an object
url
string
URL for the machine learning model server
project
integer
id
integerOptional
state
enumOptional
Allowed values: CODIERTRPR
readable_state
stringOptional
is_interactive
booleanOptional
Used to interactively annotate tasks. If true, model returns one list with results
error_message
stringOptional
Error message in error state
title
stringOptional
Name of the machine learning backend
auth_method
enumOptional
Allowed values: NONEBASIC_AUTH
basic_auth_user
stringOptional
HTTP Basic Auth user
basic_auth_pass
stringOptional
basic_auth_pass_is_set
stringOptional
description
stringOptional
Description for the machine learning backend
extra_params
map from strings to anyOptional
Any extra parameters passed to the ML Backend during the setup
model_version
stringOptional
Current model version associated with this machine learning backend
timeout
doubleOptional
Response model timeout
created_at
datetimeOptional
updated_at
datetimeOptional
auto_update
booleanOptional
If false, model version is set by the user, if true - getting latest version from backend.
GET
1curl http://localhost:8080/api/ml/1 \
2 -H "Authorization: Token <api_key>"
200Retrieved
1{
2 "url": "url",
3 "project": 1,
4 "id": 1,
5 "state": "CO",
6 "readable_state": "readable_state",
7 "is_interactive": true,
8 "error_message": "error_message",
9 "title": "title",
10 "auth_method": "NONE",
11 "basic_auth_user": "basic_auth_user",
12 "basic_auth_pass": "basic_auth_pass",
13 "basic_auth_pass_is_set": "basic_auth_pass_is_set",
14 "description": "description",
15 "extra_params": {
16 "extra_params": {
17 "key": "value"
18 }
19 },
20 "model_version": "model_version",
21 "timeout": 1.1,
22 "created_at": "2024-01-15T09:30:00Z",
23 "updated_at": "2024-01-15T09:30:00Z",
24 "auto_update": true
25}