supervisely 6.73.470__tar.gz → 6.73.486__tar.gz

{supervisely-6.73.470/supervisely.egg-info → supervisely-6.73.486}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: supervisely
-Version: 6.73.470
+Version: 6.73.486
 Summary: Supervisely Python SDK.
 Home-page: https://github.com/supervisely/supervisely
 Author: Supervisely
@@ -25,7 +25,7 @@ Requires-Dist: numpy<=2.3.3,>=1.19
 Requires-Dist: opencv-python<5.0.0.0,>=4.6.0.66
 Requires-Dist: PTable<1.0.0,>=0.9.2
 Requires-Dist: pillow<=10.4.0,>=5.4.1
-Requires-Dist: python-json-logger<3.0.0,>=0.1.11
+Requires-Dist: python-json-logger<=3.0.1,>=0.1.11
 Requires-Dist: requests<3.0.0,>=2.27.1
 Requires-Dist: requests-toolbelt>=0.9.1
 Requires-Dist: Shapely<=2.1.2,>=1.7.1
@@ -44,7 +44,7 @@ Requires-Dist: pydantic<=2.12.3,>=1.7.4
 Requires-Dist: fastapi<=0.119.1,>=0.103.1
 Requires-Dist: websockets<=13.1,>=10.3
 Requires-Dist: jinja2<4.0.0,>=3.0.3
-Requires-Dist: psutil<6.0.0,>=5.9.0
+Requires-Dist: psutil<=7.2.0,>=5.9.0
 Requires-Dist: jsonpatch<2.0,>=1.32
 Requires-Dist: MarkupSafe<3.0.0,>=2.1.1
 Requires-Dist: arel<1.0.0,>=0.2.0
@@ -146,6 +146,18 @@ Requires-Dist: imagecorruptions<2.0.0,>=1.1.2; extra == "aug"
 Requires-Dist: numpy<2.0.0,>=1.19; extra == "aug"
 Provides-Extra: agent
 Requires-Dist: protobuf<=3.20.3,>=3.19.5; extra == "agent"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 <h1 align="center">
   <a href="https://supervisely.com"><img alt="Supervisely" title="Supervisely" src="https://i.imgur.com/B276eMS.png"></a>

{supervisely-6.73.470 → supervisely-6.73.486}/setup.py

@@ -82,7 +82,7 @@ INSTALL_REQUIRES = [
     "opencv-python>=4.6.0.66, <5.0.0.0",
     "PTable>=0.9.2, <1.0.0",
     "pillow>=5.4.1, <=10.4.0",
-    "python-json-logger>=0.1.11, <3.0.0",
+    "python-json-logger>=0.1.11, <=3.0.1",
     "requests>=2.27.1, <3.0.0",
     "requests-toolbelt>=0.9.1",  # , <1.0.0
     "Shapely>=1.7.1, <=2.1.2",
@@ -101,7 +101,7 @@ INSTALL_REQUIRES = [
     "fastapi>=0.103.1, <=0.119.1",
     "websockets>=10.3, <=13.1",
     "jinja2>=3.0.3, <4.0.0",
-    "psutil>=5.9.0, <6.0.0",
+    "psutil>=5.9.0, <=7.2.0",
     "jsonpatch>=1.32, <2.0",
     "MarkupSafe>=2.1.1, <3.0.0",
     "arel>=0.2.0, <1.0.0",

{supervisely-6.73.470 → supervisely-6.73.486}/supervisely/__init__.py

@@ -106,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

{supervisely-6.73.470 → supervisely-6.73.486}/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-6.73.470 → supervisely-6.73.486}/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-6.73.470 → supervisely-6.73.486}/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-6.73.470 → supervisely-6.73.486}/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-6.73.470 → supervisely-6.73.486}/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-6.73.470 → supervisely-6.73.486}/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-6.73.470 → supervisely-6.73.486}/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,
+        )

supervisely-6.73.486/supervisely/api/guides_api.py

@@ -0,0 +1,210 @@
+# coding: utf-8
+"""create or manipulate guides that can be assigned to labeling jobs and labeling queues"""
+
+# docs
+from __future__ import annotations
+
+from typing import Dict, List, NamedTuple, Optional
+
+from supervisely.api.module_api import ApiField, ModuleApiBase
+
+
+class GuideInfo(NamedTuple):
+    """
+    Information about a Guide.
+
+    :param id: Guide ID in Supervisely.
+    :type id: int
+    :param name: Guide name.
+    :type name: str
+    :param description: Guide description.
+    :type description: str
+    :param file_path: Path to the guide file (PDF or other).
+    :type file_path: str
+    :param created_at: Guide creation date.
+    :type created_at: str
+    :param updated_at: Guide last update date.
+    :type updated_at: str
+    :param created_by_id: ID of the User who created the Guide.
+    :type created_by_id: int
+    :param team_id: Team ID where the Guide is located.
+    :type team_id: int
+    :param video_id: ID of the video associated with the guide (if any).
+    :type video_id: Optional[int]
+    :param disabled_by: ID of the User who disabled the Guide (if disabled).
+    :type disabled_by: Optional[int]
+    :param disabled_at: Date when the Guide was disabled (if disabled).
+    :type disabled_at: Optional[str]
+    """
+
+    id: int
+    name: str
+    description: str
+    file_path: str
+    created_at: str
+    updated_at: str
+    created_by_id: int
+    team_id: int
+    video_id: Optional[int] = None
+    disabled_by: Optional[int] = None
+    disabled_at: Optional[str] = None
+
+
+class GuidesApi(ModuleApiBase):
+    """
+    API for working with Guides. :class:`GuidesApi<GuidesApi>` object is immutable.
+
+    :param api: API connection to the server.
+    :type api: Api
+    :Usage example:
+
+     .. code-block:: python
+
+        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
+
+        api = sly.Api.from_env()
+
+        # Get list of guides in team
+        guides = api.guides.get_list(team_id=123)
+    """
+
+    @staticmethod
+    def info_sequence():
+        """
+        NamedTuple GuideInfo information about Guide.
+
+        :Example:
+
+         .. code-block:: python
+
+            GuideInfo(
+                id=1,
+                name='How to label objects',
+                description='Comprehensive guide on object labeling',
+                file_path='/path/to/guide.pdf',
+                created_at='2023-01-01T00:00:00.000Z',
+                updated_at='2025-11-17T18:21:10.217Z',
+                created_by_id=1,
+                team_id=1,
+                video_id=None,
+                disabled_by=None,
+                disabled_at=None
+            )
+        """
+        return [
+            ApiField.ID,
+            ApiField.NAME,
+            ApiField.DESCRIPTION,
+            ApiField.FILE_PATH,
+            ApiField.CREATED_AT,
+            ApiField.UPDATED_AT,
+            ApiField.CREATED_BY_ID,
+            ApiField.TEAM_ID,
+            ApiField.VIDEO_ID,
+            ApiField.DISABLED_BY,
+            ApiField.DISABLED_AT,
+        ]
+
+    @staticmethod
+    def info_tuple_name():
+        """
+        NamedTuple name - **GuideInfo**.
+        """
+        return "GuideInfo"
+
+    def get_list(
+        self, team_id: int, filters: Optional[List[Dict[str, str]]] = None
+    ) -> List[GuideInfo]:
+        """
+        Get list of Guides in the given Team.
+
+        :param team_id: Team ID in Supervisely.
+        :type team_id: int
+        :param filters: List of parameters to filter Guides.
+        :type filters: List[Dict[str, str]], optional
+        :return: List of information about Guides.
+        :rtype: :class:`List[GuideInfo]`
+        :Usage example:
+
+         .. code-block:: python
+
+            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
+
+            api = sly.Api.from_env()
+
+            team_id = 123
+            guides = api.guides.get_list(team_id)
+            print(guides)
+            # Output: [
+            #     GuideInfo(
+            #         id=1,
+            #         name='How to label objects',
+            #         description='Comprehensive guide on object labeling',
+            #         file_path='/path/to/guide.pdf',
+            #         created_at='2023-01-01T00:00:00.000Z',
+            #         updated_at='2025-11-17T18:21:10.217Z',
+            #         created_by_id=1,
+            #         team_id=1,
+            #         video_id=None,
+            #         disabled_by=None,
+            #         disabled_at=None
+            #     )
+            # ]
+        """
+        return self.get_list_all_pages(
+            "guides.list",
+            {ApiField.TEAM_ID: team_id, ApiField.FILTER: filters or []},
+        )
+
+    def get_info_by_id(self, id: int) -> GuideInfo:
+        """
+        Get Guide information by ID.
+
+        :param id: Guide ID in Supervisely.
+        :type id: int
+        :return: Information about Guide.
+        :rtype: :class:`GuideInfo`
+        :Usage example:
+
+         .. code-block:: python
+
+            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
+
+            api = sly.Api.from_env()
+
+            guide_id = 1
+            guide_info = api.guides.get_info_by_id(guide_id)
+            print(guide_info)
+            # Output: GuideInfo(
+            #     id=1,
+            #     name='How to label objects',
+            #     description='Comprehensive guide on object labeling',
+            #     file_path='/path/to/guide.pdf',
+            #     created_at='2023-01-01T00:00:00.000Z',
+            #     updated_at='2025-11-17T18:21:10.217Z',
+            #     created_by_id=1,
+            #     team_id=1,
+            #     video_id=None,
+            #     disabled_by=None,
+            #     disabled_at=None
+            # )
+        """
+        return self._get_info_by_id(id, "guides.info")