VolumeTagApi

class VolumeTagApi[source]

Bases: supervisely.api.entity_annotation.tag_api.TagApi

VolumeTag for a single volume. VolumeTagApi object is immutable.

Methods

append_to_entity

Add tags to entity in project with given ID.

append_to_objects

Add Tags to Annotation Objects.

append_to_objects_json

Add Tags to Annotation Objects.

append_to_volume

Add tag to volume.

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 information about an entity by its ID from the Supervisely server.

get_info_by_name

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

get_list

Get list of tags for a given project ID.

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_name_to_id_map

Get dictionary with mapping tag name to tag ID for a given project ID.

info_sequence

NamedTuple TagInfo information about Tag.

info_tuple_name

Get string name of NamedTuple for class.

remove_from_volume

Remove tag from volume.

update_value

Update VolumeTag value.

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

append_to_entity(entity_id, project_id, tags, key_id_map=None)

Add tags to entity in project with given ID.

Parameters
entity_id : int

ID of the entity in Supervisely to add a tag to

project_id : int

Project ID in Supervisely.

tags : KeyIndexedCollection

Collection of tags

key_id_map : KeyIdMap, optional

KeyIdMap object.

Returns

List of tags IDs

Return type

list

append_to_objects(entity_id, project_id, objects, key_id_map)

Add Tags to Annotation Objects.

Parameters
entity_id : int

ID of the entity in Supervisely to add a tag to

project_id : int

Project ID in Supervisely.

tags_json : KeyIndexedCollection

Collection of tags

Returns

List of tags IDs

Return type

list

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

pointcloud_id = 19373170
pcd_info = api.
append_to_objects_json(entity_id, tags_json)

Add Tags to Annotation Objects.

Parameters
entity_id : int

ID of the entity in Supervisely to add a tag to

tags_json : dict

Collection of tags in JSON format

Returns

List of tags IDs

Return type

list

append_to_volume(volume_id, tag_id, value=None, tag_meta=None)[source]

Add tag to volume.

Parameters
volume_id : int

Volume ID in Supervisely.

tag_id : int

Tag ID in Supervisely.

tag_value : str or int or None, optional

VolumeTag value.

tag_meta : TagMeta, optional

TagMeta object.

Returns

VolumeTag ID.

Return type

int

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

volume_id = 19402023
tag_id = 19402023
tag_value = 'tag_value'
tag_meta = api.tag.get_info_by_id(tag_id).meta
id = api.volume.tag.append_to_volume(volume_id, tag_id, tag_value, tag_meta)
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)

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

Parameters
id : int

ID of the entity.

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(project_id, filters=None)

Get list of tags for a given project ID.

Parameters
project_id : int

Dataset ID in Supervisely.

filters : List[Dict[str, str]], optional

List of parameters to sort output tags. See: https://dev.supervise.ly/api-docs/#tag/Advanced/paths/~1tags.list/get

Returns

List of the tags from the project with given id.

Return type

list

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

Get dictionary with mapping tag name to tag ID for a given project ID.

Parameters
project_id : int

Dataset ID in Supervisely.

Returns

Dictionary with mapping tag name to tag id for a given project ID.

Return type

dict

static info_sequence()

NamedTuple TagInfo information about Tag.

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

info_sequence = api.video.tag.info_sequence()
static info_tuple_name()

Get string name of NamedTuple for class.

Returns

NamedTuple name.

Return type

str

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

tuple_name = api.video.tag.info_tuple_name()
print(tuple_name) # TagInfo
remove_from_volume(tag_id)[source]

Remove tag from volume.

Parameters
tag_id : int

VolumeTag ID in Supervisely.

Returns

None

Return type

NoneType

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.volume.tag.remove_from_volume(volume_tag_id)
update_value(tag_id, tag_value)[source]

Update VolumeTag value.

Parameters
tag_id : int

VolumeTag ID in Supervisely.

tag_value : str or int

New VolumeTag value.

Returns

None

Return type

NoneType

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.volume.tag.update_value(volume_tag_id, 'new_tag_value')