AgentApi

class AgentApi[source]

Bases: supervisely.api.module_api.ModuleApi, supervisely.api.module_api.ModuleWithStatus

API for working with agent. AgentApi object is immutable.

Parameters
api : Api

API connection to the server

Usage example
import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))
api = sly.Api.from_env()

# Pass values into the API constructor (optional, not recommended)
# api = sly.Api(server_address="https://app.supervise.ly", token="4r47N...xaTatb")

team_id = 8
agents = api.agent.get_list(team_id)

Methods

exists

Checks if an entity with the given parent_id and name exists

get_free_name

Generates a free name for an entity with the given parent_id and name.

get_info_by_id

Get Agent information by ID.

get_info_by_name

Get information about an entity by its name from the Supervisely server.

get_list

List of all agents in the given Team.

get_list_all_pages

Get list of all or limited quantity entities from the Supervisely server.

get_list_all_pages_generator

This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved

get_list_available

Return list of available agents.

get_status

Status object containing status of Agent: waiting or running.

info_sequence

NamedTuple AgentInfo information about Agent.

info_tuple_name

NamedTuple name - AgentInfo.

raise_for_status

Attributes

MAX_WAIT_ATTEMPTS

Maximum number of attempts that will be made to wait for a certain condition to be met.

WAIT_ATTEMPT_TIMEOUT_SEC

Number of seconds for intervals between attempts.

InfoType

alias of supervisely.api.module_api.AgentInfo

class Status[source]

Bases: enum.Enum

Agent status.

RUNNING = 'running'
WAITING = 'waiting'
exists(parent_id, name)

Checks if an entity with the given parent_id and name exists

Parameters
parent_id : int

ID of the parent entity.

name : str

Name of the entity.

Returns

Returns True if entity exists, and False if not

Return type

bool

Usage example
import supervisely as sly

# You can connect to API directly
address = 'https://app.supervise.ly/'
token = 'Your Supervisely API Token'
api = sly.Api(address, token)

# Or you can use API from environment
os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()


name = "IMG_0315.jpeg"
dataset_id = 55832
exists = api.image.exists(dataset_id, name)
print(exists) # True
get_free_name(parent_id, name)

Generates a free name for an entity with the given parent_id and name. Adds an increasing suffix to original name until a unique name is found.

Parameters
parent_id : int

ID of the parent entity.

name : str

Name of the entity.

Returns

Returns free name.

Return type

str

Usage example
import supervisely as sly

# You can connect to API directly
address = 'https://app.supervise.ly/'
token = 'Your Supervisely API Token'
api = sly.Api(address, token)

# Or you can use API from environment
os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()


name = "IMG_0315.jpeg"
dataset_id = 55832
free_name = api.image.get_free_name(dataset_id, name)
print(free_name) # IMG_0315_001.jpeg
get_info_by_id(id)[source]

Get Agent information by ID.

Parameters
id : int

Agent ID in Supervisely.

Returns

Information about Agent. See info_sequence

Return type

NamedTuple

Usage example
import supervisely as sly

os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()

agent = api.agent.get_info_by_id(7)
get_info_by_name(parent_id, name, fields=[])

Get information about an entity by its name from the Supervisely server.

Parameters
parent_id : int

ID of the parent entity.

name : str

Name of the entity for which the information is being retrieved.

fields : List[str]

The list of api fields which will be returned with the response.

Usage example
import supervisely as sly

# You can connect to API directly
address = 'https://app.supervise.ly/'
token = 'Your Supervisely API Token'
api = sly.Api(address, token)

# Or you can use API from environment
os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()


dataset_id = 55832
name = "IMG_0315.jpeg"
info = api.image.get_info_by_name(dataset_id, name)
print(info)
# Output: ImageInfo(id=19369643, name='IMG_0315.jpeg', ...)
get_list(team_id, filters=None)[source]

List of all agents in the given Team.

Parameters
team_id : int

Team ID in Supervisely.

filters : List[dict], optional

List of params to sort output Agents.

Returns

List of Agents with information. See info_sequence

Return type

List[NamedTuple]

Usage example
import supervisely as sly

os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()

team_id = 16087
agents = api.agent.get_list(team_id)

filter_agents = api.agent.get_list(team_id, filters=[{ 'field': 'name', 'operator': '=', 'value': 'Gorgeous Chicken' }])
get_list_all_pages(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)

Get list of all or limited quantity entities from the Supervisely server.

Parameters
method : str

Request method name

data : dict

Dictionary with request body info

progress_cb : Progress, optional

Function for tracking download progress.

convert_json_info_cb : Callable, optional

Function for convert json info

limit : int, optional

Number of entity to retrieve

return_first_response : bool, optional

Specify if return first response

get_list_all_pages_generator(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)

This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved

Parameters
method : str

Request method name

data : dict

Dictionary with request body info

progress_cb : Progress, optional

Function for tracking download progress.

convert_json_info_cb : Callable, optional

Function for convert json info

limit : int, optional

Number of entity to retrieve

return_first_response : bool, optional

Specify if return first response

get_list_available(team_id, show_public=False, show_only_running=True, has_gpu=False, type=None, plugin_version_id=None, version=None, envs=None, min_nvidia_driver_version=None)[source]

Return list of available agents. Available agents are agents that are not disabled and can be used to run the app.

Parameters
team_id : int

Team ID in Supervisely.

show_public : bool, optional

Show public agents.

show_only_running : bool, optional

Show only running agents.

has_gpu : bool, optional

Show only agents with GPU.

type : Literal["import", "import_agent", "export", "train", "inference", "infer_rpc", "custom", "pipeline", "python", "app", "app_gpu", "smarttool"], optional

Filter by agent task type.

plugin_version_id : int, optional

Filter by agent plugin version ID.

version : str, optional

Filter by agent version.

envs : List[dict], optional

Filter by agent env variables.

min_nvidia_driver_version : str, optional

Filter by minimum nvidia driver version.

Returns

List of Agents with information. See AgentInfo

Return type

List[AgentInfo]

Usage example
import supervisely as sly

os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()

team_id = 350
available_agents = api.agent.get_list_available(
    team_id=team_id,
    show_public=True,
    show_only_running=False,
    has_gpu=False,
    type="app",
    plugin_version_id=1,
    version="6.7.39",
    envs=[{"field": "DOCKER_NET"}],
    min_nvidia_driver_version="546.33"
)
get_status(id)[source]

Status object containing status of Agent: waiting or running.

Parameters
id : int

Agent ID in Supervisely.

Returns

Agent Status

Return type

Status

Usage example
import supervisely as sly

os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()

agent = api.agent.get_status(7)
static info_sequence()[source]

NamedTuple AgentInfo information about Agent.

Example
AgentInfo("some info")
static info_tuple_name()[source]

NamedTuple name - AgentInfo.

raise_for_status(status)[source]