WorkspaceApi¶

class WorkspaceApi[source]¶

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

API for working with Workspace. WorkspaceApi 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")

workspace_info = api.workspace.get_info_by_id(workspace_id) # api usage example

Methods

`change_visibility`	Change Workspace visibility.
`create`	Create Workspace with given name in the given Team.
`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 Workspace information by ID.
`get_info_by_name`	Get information about an entity by its name from the Supervisely server.
`get_list`	List of Workspaces 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_idx_page_async`	Get the list of items for a given page number.
`get_list_page_generator_async`	Yields list of images in dataset asynchronously page by page.
`info_sequence`	NamedTuple WorkspaceInfo containing information about Workspace.
`info_tuple_name`	NamedTuple name - WorkspaceInfo.
`update`

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.WorkspaceInfo

change_visibility(id, visible)[source]¶

Change Workspace visibility.

Parameters

id : int: Workspace ID.
visible : bool: Visibility 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()

api.workspace.change_visibility(58, False)

create(team_id, name, description='', change_name_if_conflict=False)[source]¶

Create Workspace with given name in the given Team.

Parameters

team_id : int: Team ID in Supervisely where Workspace will be created.
name : str: Workspace Name.
description : str, optional: Workspace description.
change_name_if_conflict : bool, optional: Checks if given name already exists and adds suffix to the end of the name.

Returns

Information about Workspace. See info_sequence

Return type

WorkspaceInfo

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()

new_workspace = api.workspace.create(8, "Vehicle Detection")
print(new_workspace)
# Output: WorkspaceInfo(id=274,
#                       name='Vehicle Detection"',
#                       description='',
#                       team_id=8,
#                       created_at='2021-03-11T12:24:21.773Z',
#                       updated_at='2021-03-11T12:24:21.773Z')

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, raise_error=False)[source]¶

Get Workspace information by ID.

Parameters

id : int: Workspace ID in Supervisely.

Returns

Information about Workspace. See info_sequence

Return type

WorkspaceInfo

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()

workspace_info = api.workspace.get_info_by_id(58)
print(workspace_info)
# Output: WorkspaceInfo(id=58,
#                       name='Test',
#                       description='',
#                       team_id=8,
#                       created_at='2020-11-09T18:21:08.202Z',
#                       updated_at='2020-11-09T18:21:08.202Z')

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 Workspaces in the given Team.

Parameters

team_id : int: Team ID in which the Workspaces are located.
filters : List[dict], optional: List of params to sort output Workspaces.

Returns

List of all Workspaces with information for the given Team. See info_sequence

Return type

List[WorkspaceInfo]

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()

workspace_infos = api.workspace.get_list(8)
print(workspace_infos)
# Output: [
# WorkspaceInfo(id=15,
#               name='Cars',
#               description='',
#               team_id=8,
#               created_at='2020-04-15T10:50:41.926Z',
#               updated_at='2020-04-15T10:50:41.926Z'),
# WorkspaceInfo(id=18,
#               name='Heart',
#               description='',
#               team_id=8,
#               created_at='2020-05-20T15:01:54.172Z',
#               updated_at='2020-05-20T15:01:54.172Z'),
# WorkspaceInfo(id=20,
#               name='PCD',
#               description='',
#               team_id=8,
#               created_at='2020-06-24T11:51:11.336Z',
#               updated_at='2020-06-24T11:51:11.336Z')
# ]

# Filtered Workspace list
workspace_infos = api.workspace.get_list(8, filters=[{ 'field': 'name', 'operator': '=', 'value': 'Heart'}])
print(workspace_infos)
# Output: [WorkspaceInfo(id=18,
#                       name='Heart',
#                       description='',
#                       team_id=8,
#                       created_at='2020-05-20T15:01:54.172Z',
#                       updated_at='2020-05-20T15:01:54.172Z')
# ]

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

async get_list_idx_page_async(method, data)¶

Get the list of items for a given page number. Page number is specified in the data dictionary.

Parameters

method : str: Method to call for listing items.
data : dict: Data to pass to the API method.

Returns

List of items.

Return type

Tuple[int, List[NamedTuple]]

async get_list_page_generator_async(method, data, pages_count=None, semaphore=None)¶

Yields list of images in dataset asynchronously page by page.

Parameters

method : str: Method to call for listing items.
data : dict: Data to pass to the API method.
pages_count : int, optional: Preferred number of pages to retrieve if used with a per_page limit. Will be automatically adjusted if the pagesCount differs from the requested number.
semaphore : asyncio.Semaphore, optional: Semaphore for limiting the number of simultaneous requests.
kwargs: Additional arguments.

Returns

List of images in dataset.

Return type

AsyncGenerator[List[ImageInfo]]

Usage example

import supervisely as sly
import asyncio

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

method = 'images.list'
data = {
    'datasetId': 123456
}

loop = sly.utils.get_or_create_event_loop()
images = loop.run_until_complete(api.image.get_list_generator_async(method, data))

static info_sequence()[source]¶

NamedTuple WorkspaceInfo containing information about Workspace.

Example

WorkspaceInfo(id=15,
              name='Cars',
              description='Workspace contains Project with annotated Cars',
              team_id=8,
              created_at='2020-04-15T10:50:41.926Z',
              updated_at='2020-04-15T10:50:41.926Z')

static info_tuple_name()[source]¶: NamedTuple name - WorkspaceInfo.

update(id, name=None, description=None)¶