supervisely 6.73.452__py3-none-any.whl → 6.73.513__py3-none-any.whl

supervisely/__init__.py

@@ -8,6 +8,22 @@ try:
 except TypeError as e:
     __version__ = "development"
 
+
+class _ApiProtoNotAvailable:
+    """Placeholder class that raises an error when accessing any attribute"""
+
+    def __getattr__(self, name):
+        from supervisely.app.v1.constants import PROTOBUF_REQUIRED_ERROR
+
+        raise ImportError(f"Cannot access `api_proto.{name}` : " + PROTOBUF_REQUIRED_ERROR)
+
+    def __bool__(self):
+        return False
+
+    def __repr__(self):
+        return "<api_proto: not available - install supervisely[agent] to enable>"
+
+
 from supervisely.sly_logger import (
     logger,
     ServiceType,
@@ -90,6 +106,7 @@ from supervisely.geometry.graph import GraphNodes, Node
 from supervisely.geometry.multichannel_bitmap import MultichannelBitmap
 from supervisely.geometry.alpha_mask import AlphaMask
 from supervisely.geometry.cuboid_2d import Cuboid2d
+from supervisely.geometry.oriented_bbox import OrientedBBox
 
 from supervisely.geometry.helpers import geometry_to_bitmap
 from supervisely.geometry.helpers import deserialize_geometry
@@ -112,7 +129,14 @@ from supervisely.worker_api.chunking import (
     ChunkedFileWriter,
     ChunkedFileReader,
 )
-import supervisely.worker_proto.worker_api_pb2 as api_proto
+
+# Global import of api_proto works only if protobuf is installed and compatible
+# Otherwise, we use a placeholder that raises an error when accessed
+try:
+    import supervisely.worker_proto.worker_api_pb2 as api_proto
+except Exception:
+    api_proto = _ApiProtoNotAvailable()
+
 
 from supervisely.api.api import Api, UserSession, ApiContext
 from supervisely.api import api

supervisely/annotation/annotation.py

@@ -26,6 +26,7 @@ from supervisely.geometry.bitmap import Bitmap
 from supervisely.geometry.geometry import Geometry
 from supervisely.geometry.image_rotator import ImageRotator
 from supervisely.geometry.multichannel_bitmap import MultichannelBitmap
+from supervisely.geometry.oriented_bbox import OrientedBBox
 from supervisely.geometry.polygon import Polygon
 from supervisely.geometry.rectangle import Rectangle
 from supervisely.imaging import font as sly_font
@@ -551,7 +552,7 @@ class Annotation:
         :return: list of the Label class objects
         """
         for label in labels:
-            if self.img_size.count(None) == 0:
+            if self.img_size.count(None) == 0 and not isinstance(label.geometry, OrientedBBox):
                 # image has resolution in DB
                 canvas_rect = Rectangle.from_size(self.img_size)
                 try:
@@ -566,6 +567,7 @@ class Annotation:
             else:
                 # image was uploaded by link and does not have resolution in DB
                 # add label without normalization and validation
+                # OrientedBBox geometries can be outside of image bounds
                 dest.append(label)
 
     def add_label(self, label: Label) -> Annotation:
@@ -1417,7 +1419,7 @@ class Annotation:
         if draw_tags is True:
             tags_font = self._get_font()
         for label in self._labels:
-            if not fill_rectangles and isinstance(label.geometry, Rectangle):
+            if not fill_rectangles and isinstance(label.geometry, (Rectangle, OrientedBBox)):
                 label.draw_contour(
                     bitmap,
                     color=color,
@@ -2962,6 +2964,8 @@ class Annotation:
         for label in data[AnnotationJsonFields.LABELS]:
             if label[LabelJsonFields.GEOMETRY_TYPE] == Rectangle.geometry_name():
                 label = Rectangle._to_pixel_coordinate_system_json(label, image_size)
+            elif label[LabelJsonFields.GEOMETRY_TYPE] == OrientedBBox.geometry_name():
+                label = OrientedBBox._to_pixel_coordinate_system_json(label, image_size)
             else:
                 label = Geometry._to_pixel_coordinate_system_json(label, image_size)
             new_labels.append(label)
@@ -2988,6 +2992,8 @@ class Annotation:
         for label in data[AnnotationJsonFields.LABELS]:
             if label[LabelJsonFields.GEOMETRY_TYPE] == Rectangle.geometry_name():
                 label = Rectangle._to_subpixel_coordinate_system_json(label)
+            elif label[LabelJsonFields.GEOMETRY_TYPE] == OrientedBBox.geometry_name():
+                label = OrientedBBox._to_subpixel_coordinate_system_json(label)
             else:
                 label = Geometry._to_subpixel_coordinate_system_json(label)
             new_labels.append(label)

supervisely/annotation/json_geometries_map.py

@@ -1,22 +1,22 @@
 # coding: utf-8
+from supervisely.geometry.alpha_mask import AlphaMask
+from supervisely.geometry.any_geometry import AnyGeometry
 from supervisely.geometry.bitmap import Bitmap
-from supervisely.geometry.mask_3d import Mask3D
+from supervisely.geometry.closed_surface_mesh import ClosedSurfaceMesh
 from supervisely.geometry.cuboid import Cuboid
+from supervisely.geometry.cuboid_2d import Cuboid2d
+from supervisely.geometry.cuboid_3d import Cuboid3d
+from supervisely.geometry.graph import GraphNodes
+from supervisely.geometry.mask_3d import Mask3D
+from supervisely.geometry.multichannel_bitmap import MultichannelBitmap
+from supervisely.geometry.oriented_bbox import OrientedBBox
 from supervisely.geometry.point import Point
+from supervisely.geometry.point_3d import Point3d
+from supervisely.geometry.pointcloud import Pointcloud
 from supervisely.geometry.polygon import Polygon
 from supervisely.geometry.polyline import Polyline
-from supervisely.geometry.rectangle import Rectangle
-from supervisely.geometry.graph import GraphNodes
-from supervisely.geometry.any_geometry import AnyGeometry
-from supervisely.geometry.cuboid_3d import Cuboid3d
-from supervisely.geometry.pointcloud import Pointcloud
-from supervisely.geometry.point_3d import Point3d
-from supervisely.geometry.multichannel_bitmap import MultichannelBitmap
-from supervisely.geometry.closed_surface_mesh import ClosedSurfaceMesh
-from supervisely.geometry.alpha_mask import AlphaMask
-from supervisely.geometry.cuboid_2d import Cuboid2d
 from supervisely.geometry.polyline_3d import Polyline3D
-
+from supervisely.geometry.rectangle import Rectangle
 
 _INPUT_GEOMETRIES = [
     Bitmap,
@@ -36,6 +36,7 @@ _INPUT_GEOMETRIES = [
     AlphaMask,
     Cuboid2d,
     Polyline3D,
+    OrientedBBox,
 ]
 _JSON_SHAPE_TO_GEOMETRY_TYPE = {
     geometry.geometry_name(): geometry for geometry in _INPUT_GEOMETRIES

supervisely/api/annotation_api.py

@@ -869,9 +869,12 @@ class AnnotationApi(ModuleApi):
             )
 
         # use context to avoid redundant API calls
-        dataset_id = self._api.image.get_info_by_id(
-            img_ids[0], force_metadata_for_links=False
-        ).dataset_id
+        image_info = self._api.image.get_info_by_id(img_ids[0], force_metadata_for_links=False)
+        if image_info is None:
+            raise RuntimeError(
+                f"Cannot get dataset ID from image info. Image with ID={img_ids[0]} not found."
+            )
+        dataset_id = image_info.dataset_id
         context = self._api.optimization_context
         context_dataset_id = context.get("dataset_id")
         project_id = context.get("project_id")

supervisely/api/api.py

@@ -42,6 +42,7 @@ import supervisely.api.dataset_api as dataset_api
 import supervisely.api.entities_collection_api as entities_collection_api
 import supervisely.api.file_api as file_api
 import supervisely.api.github_api as github_api
+import supervisely.api.guides_api as guides_api
 import supervisely.api.image_annotation_tool_api as image_annotation_tool_api
 import supervisely.api.image_api as image_api
 import supervisely.api.import_storage_api as import_stoarge_api
@@ -358,6 +359,7 @@ class Api:
         self.user = user_api.UserApi(self)
         self.labeling_job = labeling_job_api.LabelingJobApi(self)
         self.labeling_queue = labeling_queue_api.LabelingQueueApi(self)
+        self.guides = guides_api.GuidesApi(self)
         self.video = video_api.VideoApi(self)
         # self.project_class = project_class_api.ProjectClassApi(self)
         self.object_class = object_class_api.ObjectClassApi(self)

supervisely/api/app_api.py

@@ -1750,6 +1750,7 @@ class AppApi(TaskApi):
         module_id: Optional[int] = None,
         redirect_requests: Dict[str, int] = {},
         kubernetes_settings: Optional[Union[KubernetesSettings, Dict[str, Any]]] = None,
+        multi_user_session: bool = False,
     ) -> SessionInfo:
         """Start a new application session (task).
 
@@ -1783,13 +1784,20 @@ class AppApi(TaskApi):
         :type redirect_requests: dict
         :param kubernetes_settings: Kubernetes settings for the task. If not specified, default settings will be used.
         :type kubernetes_settings: Optional[Union[KubernetesSettings, Dict[str, Any]]]
+        :param multi_user_session: If True, the application session will be created as multi-user.
+                                   In this case, multiple users will be able to connect to the same application session.
+                                   All users will have separate application states.
+                                   Available only for applications that support multi-user sessions.
+        :type multi_user_session: bool, default is False
         :return: SessionInfo object with information about the started task.
         :rtype: SessionInfo
         :raises ValueError: If both app_id and module_id are not provided.
         :raises ValueError: If both app_id and module_id are provided.
         """
         users_ids = None
-        if users_id is not None:
+        if isinstance(users_id, list) and all(isinstance(u, int) for u in users_id):
+            users_ids = users_id
+        elif isinstance(users_id, int):
             users_ids = [users_id]
 
         new_params = {}
@@ -1818,6 +1826,7 @@ class AppApi(TaskApi):
             module_id=module_id,
             redirect_requests=redirect_requests,
             kubernetes_settings=kubernetes_settings,
+            multi_user_session=multi_user_session,
         )
         if type(result) is not list:
             result = [result]

supervisely/api/dataset_api.py

@@ -1021,13 +1021,66 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
 
         return dataset_tree
 
-    def tree(self, project_id: int) -> Generator[Tuple[List[str], DatasetInfo], None, None]:
+    def _yield_tree(
+        self, tree: Dict[DatasetInfo, Dict], path: List[str]
+    ) -> Generator[Tuple[List[str], DatasetInfo], None, None]:
+        """
+        Helper method for recursive tree traversal.
+        Yields tuples of (path, dataset) for all datasets in the tree. For each node (dataset) at the current level,
+        yields its (path, dataset) before recursively traversing and yielding from its children.
+        
+        :param tree: Tree structure to yield from.
+        :type tree: Dict[DatasetInfo, Dict]
+        :param path: Current path (used for recursion).
+        :type path: List[str]
+        :return: Generator of tuples of (path, dataset).
+        :rtype: Generator[Tuple[List[str], DatasetInfo], None, None]
+        """
+        for dataset, children in tree.items():
+            yield path, dataset
+            new_path = path + [dataset.name]
+            if children:
+                yield from self._yield_tree(children, new_path)
+
+    def _find_dataset_in_tree(
+        self, tree: Dict[DatasetInfo, Dict], target_id: int, path: List[str] = None
+    ) -> Tuple[Optional[DatasetInfo], Optional[Dict], List[str]]:
+        """Find a specific dataset in the tree and return its subtree and path.
+        
+        :param tree: Tree structure to search in.
+        :type tree: Dict[DatasetInfo, Dict]
+        :param target_id: ID of the dataset to find.
+        :type target_id: int
+        :param path: Current path (used for recursion).
+        :type path: List[str], optional
+        :return: Tuple of (found_dataset, its_subtree, path_to_dataset).
+        :rtype: Tuple[Optional[DatasetInfo], Optional[Dict], List[str]]
+        """
+        if path is None:
+            path = []
+            
+        for dataset, children in tree.items():
+            if dataset.id == target_id:
+                return dataset, children, path
+            # Search in children
+            if children:
+                found_dataset, found_children, found_path = self._find_dataset_in_tree(
+                    children, target_id, path + [dataset.name]
+                )
+                if found_dataset is not None:
+                    return found_dataset, found_children, found_path
+        return None, None, []
+
+    def tree(self, project_id: int, dataset_id: Optional[int] = None) -> Generator[Tuple[List[str], DatasetInfo], None, None]:
         """Yields tuples of (path, dataset) for all datasets in the project.
         Path of the dataset is a list of parents, e.g. ["ds1", "ds2", "ds3"].
         For root datasets, the path is an empty list.
 
         :param project_id: Project ID in which the Dataset is located.
         :type project_id: int
+        :param dataset_id: Optional Dataset ID to start the tree from. If provided, only yields
+            the subtree starting from this dataset (including the dataset itself and all its children).
+        :type dataset_id: Optional[int]
         :return: Generator of tuples of (path, dataset).
         :rtype: Generator[Tuple[List[str], DatasetInfo], None, None]
         :Usage example:
@@ -1040,11 +1093,17 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
 
             project_id = 123
 
+            # Get all datasets in the project
             for parents, dataset in api.dataset.tree(project_id):
                 parents: List[str]
                 dataset: sly.DatasetInfo
                 print(parents, dataset.name)
 
+            # Get only a specific branch starting from dataset_id = 456
+            for parents, dataset in api.dataset.tree(project_id, dataset_id=456):
+                parents: List[str]
+                dataset: sly.DatasetInfo
+                print(parents, dataset.name)
 
             # Output:
             # [] ds1
@@ -1052,17 +1111,20 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
             # ["ds1", "ds2"] ds3
         """
 
-        def yield_tree(
-            tree: Dict[DatasetInfo, Dict], path: List[str]
-        ) -> Generator[Tuple[List[str], DatasetInfo], None, None]:
-            """Yields tuples of (path, dataset) for all datasets in the tree."""
-            for dataset, children in tree.items():
-                yield path, dataset
-                new_path = path + [dataset.name]
-                if children:
-                    yield from yield_tree(children, new_path)
-
-        yield from yield_tree(self.get_tree(project_id), [])
+        full_tree = self.get_tree(project_id)
+        
+        if dataset_id is None:
+            # Return the full tree
+            yield from self._yield_tree(full_tree, [])
+        else:
+            # Find the specific dataset and return only its subtree
+            target_dataset, subtree, dataset_path = self._find_dataset_in_tree(full_tree, dataset_id)
+            if target_dataset is not None:
+                # Yield the target dataset first, then its children
+                yield dataset_path, target_dataset
+                if subtree:
+                    new_path = dataset_path + [target_dataset.name]
+                    yield from self._yield_tree(subtree, new_path)
 
     def get_nested(self, project_id: int, dataset_id: int) -> List[DatasetInfo]:
         """Returns a list of all nested datasets in the specified dataset.

supervisely/api/entities_collection_api.py

@@ -281,6 +281,7 @@ class EntitiesCollectionApi(UpdateableModule, RemoveableModuleApi):
         description: Optional[str] = None,
         type: str = CollectionType.DEFAULT,
         ai_search_key: Optional[str] = None,
+        change_name_if_conflict=False,
     ) -> EntitiesCollectionInfo:
         """
         Creates Entities Collections.
@@ -295,6 +296,8 @@ class EntitiesCollectionApi(UpdateableModule, RemoveableModuleApi):
         :type type: str
         :param ai_search_key: AI search key for the collection. Defaults to None.
         :type ai_search_key: Optional[str]
+        :param change_name_if_conflict: Checks if given name already exists and adds suffix to the end of the name. Defaults to False.
+        :type change_name_if_conflict: bool
         :return: Information about new Entities Collection
         :rtype: :class:`EntitiesCollectionInfo`
         :Usage example:
@@ -316,6 +319,13 @@ class EntitiesCollectionApi(UpdateableModule, RemoveableModuleApi):
             new_collection = api.entities_collection.create(project_id, name, description, type, ai_search_key)
             print(new_collection)
         """
+
+        name = self._get_effective_new_name(
+            parent_id=project_id,
+            name=name,
+            change_name_if_conflict=change_name_if_conflict,
+        )
+
         method = "entities-collections.add"
         data = {
             ApiField.PROJECT_ID: project_id,

supervisely/api/entity_annotation/figure_api.py

@@ -1046,3 +1046,31 @@ class FigureApi(RemoveableBulkModuleApi):
                 image_ids=image_ids,
                 skip_geometry=skip_geometry,
             )
+
+    def restore_batch(self, ids: List[int], progress_cb: Optional[Callable] = None, batch_size: int = 50):
+        """
+        Restore archived figures in batches from the Supervisely server.
+
+        :param ids: IDs of figures in Supervisely.
+        :type ids: List[int]
+        :param progress_cb: Optional callback to track restore progress. Receives number of restored figures in the current batch.
+        :type progress_cb: Optional[Callable]
+        :param batch_size: Number of figure IDs to send in a single request.
+        :type batch_size: int
+        """
+        for ids_batch in batched(ids, batch_size=batch_size):
+            self._api.post(
+                "figures.bulk.restore",
+                {ApiField.FIGURE_IDS: ids_batch},
+            )
+            if progress_cb is not None:
+                progress_cb(len(ids_batch))
+
+    def restore(self, id: int):
+        """
+        Restore a single archived figure with the specified ID from the Supervisely server.
+
+        :param id: Figure ID in Supervisely.
+        :type id: int
+        """
+        self.restore_batch([id])

supervisely/api/entity_annotation/object_api.py

@@ -214,6 +214,7 @@ class ObjectApi(RemoveableBulkModuleApi):
         objects,
         key_id_map: KeyIdMap = None,
         is_pointcloud=False,
+        is_video_multi_view: bool = False,
     ):
         """"""
         if len(objects) == 0:
@@ -225,8 +226,7 @@ class ObjectApi(RemoveableBulkModuleApi):
         for obj in objects:
             new_obj = {ApiField.CLASS_ID: objcls_name_id_map[obj.obj_class.name]}
 
-            if not is_pointcloud:
-                # if entity_id is not None:
+            if not is_video_multi_view and not is_pointcloud:
                 new_obj[ApiField.ENTITY_ID] = entity_id
             items.append(new_obj)
 
@@ -238,7 +238,7 @@ class ObjectApi(RemoveableBulkModuleApi):
         KeyIdMap.add_objects_to(key_id_map, [obj.key() for obj in objects], ids)
 
         # add tags to objects
-        tag_api.append_to_objects(entity_id, project_id, objects, key_id_map)
+        tag_api.append_to_objects(entity_id, project_id, objects, key_id_map, is_video_multi_view)
 
         return ids
 

supervisely/api/entity_annotation/tag_api.py

@@ -5,6 +5,8 @@ from typing import Any, Dict, List, Optional, Union
 from supervisely._utils import batched
 from supervisely.api.module_api import ApiField, ModuleApi
 from supervisely.collection.key_indexed_collection import KeyIndexedCollection
+from supervisely.project.project_meta import ProjectMeta
+from supervisely.project.project_settings import LabelingInterface
 from supervisely.task.progress import tqdm_sly
 from supervisely.video_annotation.key_id_map import KeyIdMap
 
@@ -157,7 +159,12 @@ class TagApi(ModuleApi):
         return ids
 
     def append_to_objects(
-        self, entity_id: int, project_id: int, objects: KeyIndexedCollection, key_id_map: KeyIdMap
+        self,
+        entity_id: int,
+        project_id: int,
+        objects: KeyIndexedCollection,
+        key_id_map: KeyIdMap,
+        is_video_multi_view: bool = False,
     ):
         """
         Add Tags to Annotation Objects for a specific entity (image etc.).
@@ -170,6 +177,8 @@ class TagApi(ModuleApi):
         :type objects: KeyIndexedCollection
         :param key_id_map: KeyIdMap object.
         :type key_id_map: KeyIdMap
+        :param is_video_multi_view: If True, indicates that the entity is a multi-view video.
+        :type is_video_multi_view: bool
         :return: List of tags IDs
         :rtype: list
         :Usage example:
@@ -210,12 +219,16 @@ class TagApi(ModuleApi):
             raise RuntimeError("SDK error: len(tags_keys) != len(tags_to_add)")
         if len(tags_keys) == 0:
             return
-        ids = self.append_to_objects_json(entity_id, tags_to_add, project_id)
+        ids = self.append_to_objects_json(entity_id, tags_to_add, project_id, is_video_multi_view)
         KeyIdMap.add_tags_to(key_id_map, tags_keys, ids)
         return ids
 
     def append_to_objects_json(
-        self, entity_id: int, tags_json: List[Dict], project_id: Optional[int] = None
+        self,
+        entity_id: int,
+        tags_json: List[Dict],
+        project_id: Optional[int] = None,
+        is_video_multi_view: bool = False,
     ) -> List[int]:
         """
         Add Tags to Annotation Objects for specific entity (image etc.).
@@ -224,6 +237,11 @@ class TagApi(ModuleApi):
         :type entity_id: int
         :param tags_json: Collection of tags in JSON format
         :type tags_json: dict
+        :param project_id: Project ID in Supervisely. Uses to get tag name to tag ID mapping.
+                           Not required if `multi_view` is True.
+        :type project_id: int, optional
+        :param is_video_multi_view: If True, indicates that the entity is a multi-view video.
+        :type is_video_multi_view: bool
         :return: List of tags IDs
         :rtype: list
 
@@ -262,10 +280,15 @@ class TagApi(ModuleApi):
                 #        80421103
                 #    ]
         """
+        project_meta = self._api.optimization_context.get("project_meta")
+
+        if isinstance(project_meta, ProjectMeta):
+            if project_meta.labeling_interface == LabelingInterface.MULTIVIEW:
+                is_video_multi_view = True
 
         if len(tags_json) == 0:
             return []
-        if project_id is not None:
+        if project_id is not None and not is_video_multi_view:
             json_data = {ApiField.PROJECT_ID: project_id, ApiField.TAGS: tags_json}
         else:
             json_data = {ApiField.ENTITY_ID: entity_id, ApiField.TAGS: tags_json}
@@ -280,6 +303,8 @@ class TagApi(ModuleApi):
         batch_size: int = 100,
         log_progress: bool = False,
         progress: Optional[tqdm_sly] = None,
+        is_video_multi_view: bool = False,
+        entity_id: Optional[int] = None,
     ) -> List[Dict[str, Union[str, int, None]]]:
         """
         For images project:
@@ -306,6 +331,11 @@ class TagApi(ModuleApi):
         :type log_progress: bool
         :param progress: Progress bar object to display progress.
         :type progress: Optional[tqdm_sly]
+        :param is_video_multi_view: If True, indicates that the entity is a multi-view video.
+        :type is_video_multi_view: bool
+        :param entity_id: ID of the entity in Supervisely to add a tag to its objects.
+                          Required if `is_video_multi_view` is True.
+        :type entity_id: Optional[int]
         :return: List of tags infos as dictionaries.
         :rtype: List[Dict[str, Union[str, int, None]]]
 
@@ -363,6 +393,12 @@ class TagApi(ModuleApi):
         if progress is not None:
             log_progress = False
 
+        project_meta = self._api.optimization_context.get("project_meta")
+
+        if isinstance(project_meta, ProjectMeta):
+            if project_meta.labeling_interface == LabelingInterface.MULTIVIEW:
+                is_video_multi_view = True
+
         result = []
 
         if len(tags_list) == 0:
@@ -373,7 +409,12 @@ class TagApi(ModuleApi):
                 total=len(tags_list),
             )
         for batch in batched(tags_list, batch_size):
-            data = {ApiField.PROJECT_ID: project_id, ApiField.TAGS: batch}
+            if is_video_multi_view:
+                if entity_id is None:
+                    raise ValueError("entity_id must be provided when is_video_multi_view is True")
+                data = {ApiField.ENTITY_ID: entity_id, ApiField.TAGS: batch}
+            else:
+                data = {ApiField.PROJECT_ID: project_id, ApiField.TAGS: batch}
             if type(self) is TagApi:
                 response = self._api.post("figures.tags.bulk.add", data)
             else:
@@ -463,6 +504,8 @@ class TagApi(ModuleApi):
         tags_map: Dict[int, Any],
         batch_size: int = 100,
         log_progress: bool = False,
+        is_video_multi_view: bool = False,
+        entity_id: Optional[int] = None,
     ) -> List[Dict[str, Union[str, int, None]]]:
         """
         For images project:
@@ -483,8 +526,13 @@ class TagApi(ModuleApi):
         :type batch_size: int
         :param log_progress: If True, will display a progress bar.
         :type log_progress: bool
+        :param is_video_multi_view: If True, indicates that the entity is a multi-view video.
+        :type is_video_multi_view: bool
+        :param entity_id: ID of the entity in Supervisely to add a tag to its objects.
+                          Required if `is_video_multi_view` is True.
+        :type entity_id: Optional[int]
         :return: List of tags infos as dictionaries.
-        :rtype: List[Dit[str, Union[str, int, None]]]
+        :rtype: List[Dict[str, Union[str, int, None]]]
 
         Usage example:
         .. code-block:: python
@@ -527,11 +575,14 @@ class TagApi(ModuleApi):
                     raise ValueError(f"Tag {tag.name} meta has no sly_id")
 
                 data.append(
-                    {
-                        ApiField.TAG_ID: tag.meta.sly_id,
-                        OBJ_ID_FIELD: obj_id,
-                        **tag.to_json()
-                    }
+                    {ApiField.TAG_ID: tag.meta.sly_id, OBJ_ID_FIELD: obj_id, **tag.to_json()}
                 )
 
-        return self.add_to_objects(project_id, data, batch_size, log_progress)
+        return self.add_to_objects(
+            project_id,
+            data,
+            batch_size,
+            log_progress,
+            is_video_multi_view=is_video_multi_view,
+            entity_id=entity_id,
+        )