label-studio-sdk 2.0.8__py3-none-any.whl → 2.0.9__py3-none-any.whl

label_studio_sdk/import_storage/gcswif/client.py

@@ -97,6 +97,7 @@ class GcswifClient:
         prefix: typing.Optional[str] = OMIT,
         presign: typing.Optional[bool] = OMIT,
         presign_ttl: typing.Optional[int] = OMIT,
+        recursive_scan: typing.Optional[bool] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
         status: typing.Optional[StatusC5AEnum] = OMIT,
         synchronizable: typing.Optional[bool] = OMIT,
@@ -156,6 +157,9 @@ class GcswifClient:
         presign_ttl : typing.Optional[int]
             Presigned URLs TTL (in minutes)
 
+        recursive_scan : typing.Optional[bool]
+            Perform recursive scan over the bucket content
+
         regex_filter : typing.Optional[str]
             Cloud storage regex for filtering objects
 
@@ -211,6 +215,7 @@ class GcswifClient:
                 "presign": presign,
                 "presign_ttl": presign_ttl,
                 "project": project,
+                "recursive_scan": recursive_scan,
                 "regex_filter": regex_filter,
                 "status": status,
                 "synchronizable": synchronizable,
@@ -254,6 +259,7 @@ class GcswifClient:
         prefix: typing.Optional[str] = OMIT,
         presign: typing.Optional[bool] = OMIT,
         presign_ttl: typing.Optional[int] = OMIT,
+        recursive_scan: typing.Optional[bool] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
         status: typing.Optional[StatusC5AEnum] = OMIT,
         synchronizable: typing.Optional[bool] = OMIT,
@@ -313,6 +319,9 @@ class GcswifClient:
         presign_ttl : typing.Optional[int]
             Presigned URLs TTL (in minutes)
 
+        recursive_scan : typing.Optional[bool]
+            Perform recursive scan over the bucket content
+
         regex_filter : typing.Optional[str]
             Cloud storage regex for filtering objects
 
@@ -367,6 +376,7 @@ class GcswifClient:
                 "presign": presign,
                 "presign_ttl": presign_ttl,
                 "project": project,
+                "recursive_scan": recursive_scan,
                 "regex_filter": regex_filter,
                 "status": status,
                 "synchronizable": synchronizable,
@@ -490,6 +500,7 @@ class GcswifClient:
         presign: typing.Optional[bool] = OMIT,
         presign_ttl: typing.Optional[int] = OMIT,
         project: typing.Optional[int] = OMIT,
+        recursive_scan: typing.Optional[bool] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
         status: typing.Optional[StatusC5AEnum] = OMIT,
         synchronizable: typing.Optional[bool] = OMIT,
@@ -551,6 +562,9 @@ class GcswifClient:
         project : typing.Optional[int]
             A unique integer value identifying this project.
 
+        recursive_scan : typing.Optional[bool]
+            Perform recursive scan over the bucket content
+
         regex_filter : typing.Optional[str]
             Cloud storage regex for filtering objects
 
@@ -606,6 +620,7 @@ class GcswifClient:
                 "presign": presign,
                 "presign_ttl": presign_ttl,
                 "project": project,
+                "recursive_scan": recursive_scan,
                 "regex_filter": regex_filter,
                 "status": status,
                 "synchronizable": synchronizable,
@@ -769,6 +784,7 @@ class AsyncGcswifClient:
         prefix: typing.Optional[str] = OMIT,
         presign: typing.Optional[bool] = OMIT,
         presign_ttl: typing.Optional[int] = OMIT,
+        recursive_scan: typing.Optional[bool] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
         status: typing.Optional[StatusC5AEnum] = OMIT,
         synchronizable: typing.Optional[bool] = OMIT,
@@ -828,6 +844,9 @@ class AsyncGcswifClient:
         presign_ttl : typing.Optional[int]
             Presigned URLs TTL (in minutes)
 
+        recursive_scan : typing.Optional[bool]
+            Perform recursive scan over the bucket content
+
         regex_filter : typing.Optional[str]
             Cloud storage regex for filtering objects
 
@@ -891,6 +910,7 @@ class AsyncGcswifClient:
                 "presign": presign,
                 "presign_ttl": presign_ttl,
                 "project": project,
+                "recursive_scan": recursive_scan,
                 "regex_filter": regex_filter,
                 "status": status,
                 "synchronizable": synchronizable,
@@ -934,6 +954,7 @@ class AsyncGcswifClient:
         prefix: typing.Optional[str] = OMIT,
         presign: typing.Optional[bool] = OMIT,
         presign_ttl: typing.Optional[int] = OMIT,
+        recursive_scan: typing.Optional[bool] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
         status: typing.Optional[StatusC5AEnum] = OMIT,
         synchronizable: typing.Optional[bool] = OMIT,
@@ -993,6 +1014,9 @@ class AsyncGcswifClient:
         presign_ttl : typing.Optional[int]
             Presigned URLs TTL (in minutes)
 
+        recursive_scan : typing.Optional[bool]
+            Perform recursive scan over the bucket content
+
         regex_filter : typing.Optional[str]
             Cloud storage regex for filtering objects
 
@@ -1055,6 +1079,7 @@ class AsyncGcswifClient:
                 "presign": presign,
                 "presign_ttl": presign_ttl,
                 "project": project,
+                "recursive_scan": recursive_scan,
                 "regex_filter": regex_filter,
                 "status": status,
                 "synchronizable": synchronizable,
@@ -1194,6 +1219,7 @@ class AsyncGcswifClient:
         presign: typing.Optional[bool] = OMIT,
         presign_ttl: typing.Optional[int] = OMIT,
         project: typing.Optional[int] = OMIT,
+        recursive_scan: typing.Optional[bool] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
         status: typing.Optional[StatusC5AEnum] = OMIT,
         synchronizable: typing.Optional[bool] = OMIT,
@@ -1255,6 +1281,9 @@ class AsyncGcswifClient:
         project : typing.Optional[int]
             A unique integer value identifying this project.
 
+        recursive_scan : typing.Optional[bool]
+            Perform recursive scan over the bucket content
+
         regex_filter : typing.Optional[str]
             Cloud storage regex for filtering objects
 
@@ -1318,6 +1347,7 @@ class AsyncGcswifClient:
                 "presign": presign,
                 "presign_ttl": presign_ttl,
                 "project": project,
+                "recursive_scan": recursive_scan,
                 "regex_filter": regex_filter,
                 "status": status,
                 "synchronizable": synchronizable,

label_studio_sdk/projects/__init__.py

@@ -8,7 +8,6 @@ from .types import (
     ProjectsDuplicateResponse,
     ProjectsImportPredictionsResponse,
     ProjectsImportTasksResponse,
-    ProjectsListRequestFilter,
 )
 from . import assignments, exports, members, metrics, pauses, stats
 from .assignments import (
@@ -75,7 +74,6 @@ __all__ = [
     "ProjectsDuplicateResponse",
     "ProjectsImportPredictionsResponse",
     "ProjectsImportTasksResponse",
-    "ProjectsListRequestFilter",
     "StatsAgreementAnnotatorResponse",
     "StatsDataFiltersResponse",
     "StatsDataFiltersResponseUserFilters",

label_studio_sdk/projects/client.py

@@ -8,7 +8,6 @@ from .metrics.client import MetricsClient
 from .stats.client import StatsClient
 from .assignments.client import AssignmentsClient
 from .pauses.client import PausesClient
-from .types.projects_list_request_filter import ProjectsListRequestFilter
 from ..core.request_options import RequestOptions
 from ..core.pagination import SyncPager
 from ..types.all_roles_project_list import AllRolesProjectList
@@ -23,13 +22,14 @@ from .types.lse_project_create_request_skip_queue import LseProjectCreateRequest
 from ..types.lse_project_create import LseProjectCreate
 from ..core.serialization import convert_and_respect_annotation_metadata
 from ..types.paginated_lse_project_counts_list import PaginatedLseProjectCountsList
-from ..types.project import Project
+from ..types.lse_project_response import LseProjectResponse
 from ..core.jsonable_encoder import jsonable_encoder
 from ..types.assignment_settings_request import AssignmentSettingsRequest
 from ..types.review_settings_request import ReviewSettingsRequest
 from .types.patched_lse_project_update_request_sampling import PatchedLseProjectUpdateRequestSampling
 from .types.patched_lse_project_update_request_skip_queue import PatchedLseProjectUpdateRequestSkipQueue
 from ..types.lse_project_update import LseProjectUpdate
+from ..types.user_simple import UserSimple
 from ..types.mode_enum import ModeEnum
 from .types.projects_duplicate_response import ProjectsDuplicateResponse
 from ..types.import_api_request import ImportApiRequest
@@ -64,15 +64,16 @@ class ProjectsClient:
     def list(
         self,
         *,
-        filter: typing.Optional[ProjectsListRequestFilter] = None,
+        filter: typing.Optional[str] = None,
         ids: typing.Optional[str] = None,
         include: typing.Optional[str] = None,
         members_limit: typing.Optional[int] = None,
         ordering: typing.Optional[str] = None,
         page: typing.Optional[int] = None,
         page_size: typing.Optional[int] = None,
+        search: typing.Optional[str] = None,
         title: typing.Optional[str] = None,
-        workspaces: typing.Optional[int] = None,
+        workspaces: typing.Optional[float] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SyncPager[AllRolesProjectList]:
         """
@@ -80,17 +81,17 @@ class ProjectsClient:
 
         Parameters
         ----------
-        filter : typing.Optional[ProjectsListRequestFilter]
+        filter : typing.Optional[str]
             Filter projects by pinned status. Use 'pinned_only' to return only pinned projects, 'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects.
 
         ids : typing.Optional[str]
-            ids
+            Filter id by in list
 
         include : typing.Optional[str]
             Comma-separated list of count fields to include in the response to optimize performance. Available fields: task_number, finished_task_number, total_predictions_number, total_annotations_number, num_tasks_with_annotations, useful_annotation_number, ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.
 
         members_limit : typing.Optional[int]
-            Maximum number of members to return.
+            Maximum number of members to return
 
         ordering : typing.Optional[str]
             Which field to use when ordering the results.
@@ -101,11 +102,14 @@ class ProjectsClient:
         page_size : typing.Optional[int]
             Number of results to return per page.
 
+        search : typing.Optional[str]
+            Search term for project title and description
+
         title : typing.Optional[str]
-            title
+            Filter title by contains (case-insensitive)
 
-        workspaces : typing.Optional[int]
-            workspaces
+        workspaces : typing.Optional[float]
+            Filter workspaces by exact match
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -141,6 +145,7 @@ class ProjectsClient:
                 "ordering": ordering,
                 "page": page,
                 "page_size": page_size,
+                "search": search,
                 "title": title,
                 "workspaces": workspaces,
             },
@@ -164,6 +169,7 @@ class ProjectsClient:
                     ordering=ordering,
                     page=page + 1,
                     page_size=page_size,
+                    search=search,
                     title=title,
                     workspaces=workspaces,
                     request_options=request_options,
@@ -389,13 +395,13 @@ class ProjectsClient:
         Parameters
         ----------
         filter : typing.Optional[str]
-            Project filter setting. One of 'all', 'pinned_only', 'exclude_pinned'.
+            Filter projects by pinned status. Use 'pinned_only' to return only pinned projects, 'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects.
 
         ids : typing.Optional[str]
             Filter id by in list
 
         include : typing.Optional[str]
-            Comma-separated list of fields to include
+            Comma-separated list of count fields to include in the response to optimize performance. Available fields: task_number, finished_task_number, total_predictions_number, total_annotations_number, num_tasks_with_annotations, useful_annotation_number, ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.
 
         ordering : typing.Optional[str]
             Which field to use when ordering the results.
@@ -462,7 +468,13 @@ class ProjectsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Project:
+    def get(
+        self,
+        id: int,
+        *,
+        members_limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> LseProjectResponse:
         """
         Retrieve information about a project by project ID.
 
@@ -470,13 +482,16 @@ class ProjectsClient:
         ----------
         id : int
 
+        members_limit : typing.Optional[int]
+            Maximum number of members to return
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        Project
-            Project information
+        LseProjectResponse
+            Project information. Not all fields are available for all roles.
 
         Examples
         --------
@@ -492,14 +507,17 @@ class ProjectsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/",
             method="GET",
+            params={
+                "members_limit": members_limit,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    Project,
+                    LseProjectResponse,
                     construct_type(
-                        type_=Project,  # type: ignore
+                        type_=LseProjectResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -551,6 +569,7 @@ class ProjectsClient:
         self,
         id: int,
         *,
+        members_limit: typing.Optional[int] = None,
         annotation_limit_count: typing.Optional[int] = OMIT,
         annotation_limit_percent: typing.Optional[str] = OMIT,
         annotator_evaluation_minimum_score: typing.Optional[str] = OMIT,
@@ -601,6 +620,9 @@ class ProjectsClient:
         ----------
         id : int
 
+        members_limit : typing.Optional[int]
+            Maximum number of members to return
+
         annotation_limit_count : typing.Optional[int]
 
         annotation_limit_percent : typing.Optional[str]
@@ -726,6 +748,9 @@ class ProjectsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/",
             method="PATCH",
+            params={
+                "members_limit": members_limit,
+            },
             json={
                 "annotation_limit_count": annotation_limit_count,
                 "annotation_limit_percent": annotation_limit_percent,
@@ -799,6 +824,54 @@ class ProjectsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def list_unique_annotators(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[UserSimple]:
+        """
+        Return unique users who have submitted annotations in the specified project.
+
+        Parameters
+        ----------
+        id : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[UserSimple]
+            List of annotator users
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.list_unique_annotators(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/annotators/",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[UserSimple],
+                    construct_type(
+                        type_=typing.List[UserSimple],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
     def duplicate(
         self,
         id: int,
@@ -1166,15 +1239,16 @@ class AsyncProjectsClient:
     async def list(
         self,
         *,
-        filter: typing.Optional[ProjectsListRequestFilter] = None,
+        filter: typing.Optional[str] = None,
         ids: typing.Optional[str] = None,
         include: typing.Optional[str] = None,
         members_limit: typing.Optional[int] = None,
         ordering: typing.Optional[str] = None,
         page: typing.Optional[int] = None,
         page_size: typing.Optional[int] = None,
+        search: typing.Optional[str] = None,
         title: typing.Optional[str] = None,
-        workspaces: typing.Optional[int] = None,
+        workspaces: typing.Optional[float] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncPager[AllRolesProjectList]:
         """
@@ -1182,17 +1256,17 @@ class AsyncProjectsClient:
 
         Parameters
         ----------
-        filter : typing.Optional[ProjectsListRequestFilter]
+        filter : typing.Optional[str]
             Filter projects by pinned status. Use 'pinned_only' to return only pinned projects, 'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects.
 
         ids : typing.Optional[str]
-            ids
+            Filter id by in list
 
         include : typing.Optional[str]
             Comma-separated list of count fields to include in the response to optimize performance. Available fields: task_number, finished_task_number, total_predictions_number, total_annotations_number, num_tasks_with_annotations, useful_annotation_number, ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.
 
         members_limit : typing.Optional[int]
-            Maximum number of members to return.
+            Maximum number of members to return
 
         ordering : typing.Optional[str]
             Which field to use when ordering the results.
@@ -1203,11 +1277,14 @@ class AsyncProjectsClient:
         page_size : typing.Optional[int]
             Number of results to return per page.
 
+        search : typing.Optional[str]
+            Search term for project title and description
+
         title : typing.Optional[str]
-            title
+            Filter title by contains (case-insensitive)
 
-        workspaces : typing.Optional[int]
-            workspaces
+        workspaces : typing.Optional[float]
+            Filter workspaces by exact match
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1251,6 +1328,7 @@ class AsyncProjectsClient:
                 "ordering": ordering,
                 "page": page,
                 "page_size": page_size,
+                "search": search,
                 "title": title,
                 "workspaces": workspaces,
             },
@@ -1274,6 +1352,7 @@ class AsyncProjectsClient:
                     ordering=ordering,
                     page=page + 1,
                     page_size=page_size,
+                    search=search,
                     title=title,
                     workspaces=workspaces,
                     request_options=request_options,
@@ -1507,13 +1586,13 @@ class AsyncProjectsClient:
         Parameters
         ----------
         filter : typing.Optional[str]
-            Project filter setting. One of 'all', 'pinned_only', 'exclude_pinned'.
+            Filter projects by pinned status. Use 'pinned_only' to return only pinned projects, 'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects.
 
         ids : typing.Optional[str]
             Filter id by in list
 
         include : typing.Optional[str]
-            Comma-separated list of fields to include
+            Comma-separated list of count fields to include in the response to optimize performance. Available fields: task_number, finished_task_number, total_predictions_number, total_annotations_number, num_tasks_with_annotations, useful_annotation_number, ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.
 
         ordering : typing.Optional[str]
             Which field to use when ordering the results.
@@ -1588,7 +1667,13 @@ class AsyncProjectsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> Project:
+    async def get(
+        self,
+        id: int,
+        *,
+        members_limit: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> LseProjectResponse:
         """
         Retrieve information about a project by project ID.
 
@@ -1596,13 +1681,16 @@ class AsyncProjectsClient:
         ----------
         id : int
 
+        members_limit : typing.Optional[int]
+            Maximum number of members to return
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        Project
-            Project information
+        LseProjectResponse
+            Project information. Not all fields are available for all roles.
 
         Examples
         --------
@@ -1626,14 +1714,17 @@ class AsyncProjectsClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/",
             method="GET",
+            params={
+                "members_limit": members_limit,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    Project,
+                    LseProjectResponse,
                     construct_type(
-                        type_=Project,  # type: ignore
+                        type_=LseProjectResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -1693,6 +1784,7 @@ class AsyncProjectsClient:
         self,
         id: int,
         *,
+        members_limit: typing.Optional[int] = None,
         annotation_limit_count: typing.Optional[int] = OMIT,
         annotation_limit_percent: typing.Optional[str] = OMIT,
         annotator_evaluation_minimum_score: typing.Optional[str] = OMIT,
@@ -1743,6 +1835,9 @@ class AsyncProjectsClient:
         ----------
         id : int
 
+        members_limit : typing.Optional[int]
+            Maximum number of members to return
+
         annotation_limit_count : typing.Optional[int]
 
         annotation_limit_percent : typing.Optional[str]
@@ -1876,6 +1971,9 @@ class AsyncProjectsClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/",
             method="PATCH",
+            params={
+                "members_limit": members_limit,
+            },
             json={
                 "annotation_limit_count": annotation_limit_count,
                 "annotation_limit_percent": annotation_limit_percent,
@@ -1949,6 +2047,62 @@ class AsyncProjectsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    async def list_unique_annotators(
+        self, id: int, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[UserSimple]:
+        """
+        Return unique users who have submitted annotations in the specified project.
+
+        Parameters
+        ----------
+        id : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[UserSimple]
+            List of annotator users
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.list_unique_annotators(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/annotators/",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[UserSimple],
+                    construct_type(
+                        type_=typing.List[UserSimple],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
     async def duplicate(
         self,
         id: int,