fixed list_items include categories

Author: Narek Mkhitaryan

src/superannotate/lib/app/interface/sdk_interface.py

@@ -2903,7 +2903,7 @@ def list_items(
         project: Union[NotEmptyStr, int],
         folder: Optional[Union[NotEmptyStr, int]] = None,
         *,
-        include: List[Literal["custom_metadata", "category"]] = None,
+        include: List[Literal["custom_metadata", "categories"]] = None,
         **filters,
     ):
         """
@@ -3014,6 +3014,14 @@ def list_items(
             if isinstance(project, int)
             else self.controller.get_project(project)
         )
+        if (
+            include
+            and "categories" in include
+            and project.type != ProjectType.MULTIMODAL.value
+        ):
+            raise AppException(
+                "The 'categories' option in the 'include' field is only supported for Multimodal projects."
+            )
         if folder is None:
             folder = self.controller.get_folder(project, "root")
         else:

src/superannotate/lib/core/entities/items.py

@@ -16,6 +16,13 @@ class Config:
         extra = Extra.ignore
 
 
+class MultiModalItemEntity(BaseItemEntity):
+    categories: Optional[list]
+
+    class Config:
+        extra = Extra.ignore
+
+
 class VideoEntity(BaseItemEntity):
     approval_status: Optional[ApprovalStatus] = Field(None)
 
@@ -51,4 +58,5 @@ class Config:
     ProjectType.TILED: ImageEntity,
     ProjectType.VIDEO: VideoEntity,
     ProjectType.DOCUMENT: DocumentEntity,
+    ProjectType.MULTIMODAL: MultiModalItemEntity,
 }

src/superannotate/lib/core/usecases/items.py

@@ -17,6 +17,7 @@
 from lib.core.entities import ImageEntity
 from lib.core.entities import ProjectEntity
 from lib.core.entities import VideoEntity
+from lib.core.entities.items import MultiModalItemEntity
 from lib.core.exceptions import AppException
 from lib.core.exceptions import AppValidationException
 from lib.core.exceptions import BackendError
@@ -60,6 +61,8 @@ def serialize_item_entity(
         return VideoEntity(**entity.dict(by_alias=True))
     elif project.type == constants.ProjectType.DOCUMENT.value:
         return DocumentEntity(**entity.dict(by_alias=True))
+    elif project.type == constants.ProjectType.MULTIMODAL.value:
+        return MultiModalItemEntity(**entity.dict(by_alias=True))
     return entity