VolumeTagApi¶

class VolumeTagApi[source]¶

Bases: supervisely.api.entity_annotation.tag_api.TagApi

VolumeTag for a single volume. VolumeTagApi object is immutable.

Methods

`add_tags_collection_to_objects`	For images project:
`add_to_entities_json`	Bulk add tags to entities (images, videos, pointclouds, volumes) in a project.
`add_to_objects`	For images project:
`append_to_entity`	Add tags to entity in project with given ID.
`append_to_objects`	Add Tags to Annotation Objects for a specific entity (image etc.).
`append_to_objects_json`	Add Tags to Annotation Objects for specific entity (image etc.).
`append_to_volume`	Add tag to volume.
`convert_info_to_json`	_convert_info_to_json
`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_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.
`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

add_tags_collection_to_objects(project_id, tags_map, batch_size=100, log_progress=False)¶

For images project:: Add Tags to existing Annotation Figures (labels). The tags_map example: {figure_id_1: TagCollection, …}.
For video, pointcloud, volume and pointcloud episodes projects:: Add Tags to existing Annotation Objects. The frameRange field is optional and is supported only for video and pointcloud episodes projects. The tags_map example: {object_id_1: TagCollection, …}.

All objects must belong to entities of the same project.

Parameters

project_id : int: Project ID in Supervisely.
tags_map : Dict[int, Any]: Dictionary with mapping figure/object ID to tags collection.
batch_size : int: Number of tags to add in one request.
log_progress : bool: If True, will display a progress bar.

Returns

List of tags infos as dictionaries.

Return type

List[Dit[str, Union[str, int, None]]]

Usage example: .. code-block:: python

import supervisely as sly

api = sly.Api(server_address, token)

project_id = 12345

tag_meta = sly.TagMeta(“tag_name”, sly.TagValueType.ANY_STRING) meta = sly.ProjectMeta(tag_metas=[tag_meta]) meta = sly.ProjectMeta.from_json(api.project.update_meta(project_id, meta)) tag_meta = meta.get_tag_meta(“tag_name”)

# for images project: tag_map = {

652959: sly.TagCollection([sly.Tag(tag_meta, value=”v1”), sly.Tag(tag_meta, value=”v2”), …]), 652958: sly.TagCollection([sly.Tag(tag_meta, value=”v3”), sly.Tag(tag_meta, value=”v4”), …]), …

} api.image.tag.add_tags_to_objects(project_id, tag_map)

# for videos projects (frameRange is optional): tag_map = {

652959: sly.VideoTagCollection([sly.VideoTag(tag_meta, value=”v1”, frameRange=[1, 10]), …]), 652958: sly.VideoTagCollection([sly.VideoTag(tag_meta, value=”v2”, frameRange=[4, 12]), …]), …

} api.video.tag.add_to_objects_json_batch(project_id, tag_map)

add_to_entities_json(project_id, tags_list, batch_size=100, log_progress=False)¶

Bulk add tags to entities (images, videos, pointclouds, volumes) in a project. Not supported for pointcloud episodes projects. All entities must belong to the same project. The frameRange field in a tag object within the tags list is optional and is supported only for video projects.

The tags_list example:: [{“tagId”: 12345, “entityId”: 54321, “value”: “tag_value”}, …].
or with frameRange:: [{“tagId”: 12345, “entityId”: 54321, “value”: “tag_value”, “frameRange”: [1, 10]}, …].

Parameters

project_id : int: Project ID in Supervisely.
tags_list : List[Dict[str, Union[str, int, None]]]: List of tag object infos as dictionaries (e.g. {“tagId”: 12345, “entityId”: 54321, “value”: “tag_value”}).
batch_size : int: Number of tags to add in one request.
log_progress : bool: If True, will display a progress bar.

Returns

List of tags IDs.

Return type

List[int]

Usage example: .. code-block:: python

import supervisely as sly

api = sly.Api(server_address, token)

tag_list = [

{
“tagId”: 25926, “entityId”: 652959, “value”: None # optional for tag with type ‘None’ “frameRange”: [1, 10] # optional (supported only for video projects)

}, {

“tagId”: 25927, “entityId”: 652959, “value”: “v1”

}, {

“tagId”: 25927, “entityId”: 652958, “value”: “v2”

}

] api.image.tag.add_to_entities_json(project_id=12345, tag_list=tag_list)

add_to_objects(project_id, tags_list, batch_size=100, log_progress=False, progress=None)¶

For images project:

Add Tags to existing Annotation Figures (labels). The tags_list example:

[{“tagId”: 12345, “figureId”: 54321, “value”: “tag_value”}, …].

For video, pointcloud, volume and pointcloud episodes projects:

Add Tags to existing Annotation Objects. The frameRange field is optional and is supported only for video and pointcloud episodes projects. The tags_list` example:

[{“tagId”: 12345, “objectId”: 54321, “value”: “tag_value”}, …].

or with frameRange:: [{“tagId”: 12345, “objectId”: 54321, “value”: “tag_value”, “frameRange”: [1, 10]}, …].

All objects must belong to entities of the same project.

Parameters

project_id : int: Project ID in Supervisely.
tags_list : List[dict]: List of tag object infos as dictionaries.
batch_size : int: Number of tags to add in one request.
log_progress : bool: If True, will display a progress bar.
progress : Optional[tqdm_sly]: Progress bar object to display progress.

Returns

List of tags infos as dictionaries.

Return type

List[Dict[str, Union[str, int, None]]]

Usage example: .. code-block:: python

import supervisely as sly

api = sly.Api(server_address, token)

tag_list = [

{
“tagId”: 25926, “figureId”: 652959, “value”: None # optional for tag with type ‘None’ “frameRange”: [1, 10] # optional (supported only for video and pointcloud episodes projects)

}, {

“tagId”: 25927, “figureId”: 652959, “value”: “v1”

}, {

“tagId”: 25927, “figureId”: 652958, “value”: “v2”,

}

] response = api.image.tag.add_to_figures(12345, tag_list)

print(response) # Output: # [ # { # “id”: 80421101, # “tagId”: 25926, # “figureId”: 652959, # “value”: None # }, # { # “id”: 80421102, # “tagId”: 25927, # “figureId”: 652959, # “value”: “v1” # }, # { # “id”: 80421103, # “tagId”: 25927, # “figureId”: 652958, # “value”: “v2” # } # ]

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 for a specific entity (image etc.).

Parameters

entity_id : int: ID of the entity in Supervisely to add a tag to its objects
project_id : int: Project ID in Supervisely. Uses to get tag name to tag ID mapping.
objects : KeyIndexedCollection: Collection of Annotation Objects.
key_id_map : KeyIdMap: KeyIdMap object.

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

img_id = 19373170
img_info = api.

append_to_objects_json(entity_id, tags_json, project_id=None)¶

Add Tags to Annotation Objects for specific entity (image etc.).

Parameters

entity_id : int: ID of the entity in Supervisely to add a tag to its objects
tags_json : dict: Collection of tags in JSON format

Returns

List of tags IDs

Return type

list

Usage example

import supervisely as sly

api = sly.Api(server_address, token)

tags_list = [
    {
        "tagId": 25926,
        "objectId": 652959,
        "value": None
    },
    {
        "tagId": 25927,
        "objectId": 652959,
        "value": "v1"
    },
    {
        "tagId": 25927,
        "objectId": 652958,
        "value": "v2"
    }
]
response = api.video.tag.append_to_objects_json(12345, tags_list)

print(response)
# Output:
#    [
#        80421101,
#        80421102,
#        80421103
#    ]

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)

classmethod convert_info_to_json(info)¶

_convert_info_to_json

Return type: Dict

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.supervisely.com/'
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.supervisely.com/'
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.supervisely.com/'
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://api.docs.supervisely.com/#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

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

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