label-studio-sdk 2.0.11__tar.gz → 2.0.12__tar.gz

{label_studio_sdk-2.0.11 → label_studio_sdk-2.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: label-studio-sdk
-Version: 2.0.11
+Version: 2.0.12
 Summary: 
 Requires-Python: >=3.9,<4
 Classifier: Intended Audience :: Developers

{label_studio_sdk-2.0.11 → label_studio_sdk-2.0.12}/pyproject.toml

@@ -3,7 +3,7 @@ name = "label-studio-sdk"
 
 [tool.poetry]
 name = "label-studio-sdk"
-version = "2.0.11"
+version = "2.0.12"
 description = ""
 readme = "README.md"
 authors = []

{label_studio_sdk-2.0.11 → label_studio_sdk-2.0.12}/src/label_studio_sdk/__init__.py

@@ -162,13 +162,18 @@ from .types import (
     PauseRequest,
     Prediction,
     PredictionRequest,
+    Project,
     ProjectGroup,
     ProjectGroupRequest,
     ProjectGroupRoleEnum,
     ProjectImport,
     ProjectLabelConfig,
     ProjectLabelConfigRequest,
+    ProjectMember,
     ProjectMemberBulkAssignRolesRequest,
+    ProjectRole,
+    ProjectSampling,
+    ProjectSkipQueue,
     ProjectSubsetEnum,
     ProjectSubsetItem,
     ProjectSubsetTaskItem,
@@ -549,13 +554,18 @@ __all__ = [
     "PauseRequest",
     "Prediction",
     "PredictionRequest",
+    "Project",
     "ProjectGroup",
     "ProjectGroupRequest",
     "ProjectGroupRoleEnum",
     "ProjectImport",
     "ProjectLabelConfig",
     "ProjectLabelConfigRequest",
+    "ProjectMember",
     "ProjectMemberBulkAssignRolesRequest",
+    "ProjectRole",
+    "ProjectSampling",
+    "ProjectSkipQueue",
     "ProjectSubsetEnum",
     "ProjectSubsetItem",
     "ProjectSubsetTaskItem",

{label_studio_sdk-2.0.11 → label_studio_sdk-2.0.12}/src/label_studio_sdk/projects/__init__.py

@@ -9,7 +9,7 @@ from .types import (
     ProjectsImportPredictionsResponse,
     ProjectsImportTasksResponse,
 )
-from . import assignments, exports, members, metrics, pauses, stats
+from . import assignments, exports, members, metrics, pauses, roles, stats
 from .assignments import (
     AssignmentsAssignRequestType,
     AssignmentsBulkAssignRequestFilters,
@@ -29,6 +29,7 @@ from .assignments import (
 from .exports import ExportsConvertResponse
 from .stats import (
     StatsAgreementAnnotatorResponse,
+    StatsAgreementAnnotatorsResponse,
     StatsDataFiltersResponse,
     StatsDataFiltersResponseUserFilters,
     StatsDataFiltersResponseUserFiltersStatsItem,
@@ -52,6 +53,8 @@ from .stats import (
     StatsUserReviewScoreResponse,
     StatsUserReviewScoreResponsePerformanceScore,
     StatsUserReviewScoreResponseReviewScore,
+    StatsUsersPredictionAgreementResponse,
+    StatsUsersPredictionAgreementResponseAgreementValue,
 )
 
 __all__ = [
@@ -78,6 +81,7 @@ __all__ = [
     "ProjectsImportPredictionsResponse",
     "ProjectsImportTasksResponse",
     "StatsAgreementAnnotatorResponse",
+    "StatsAgreementAnnotatorsResponse",
     "StatsDataFiltersResponse",
     "StatsDataFiltersResponseUserFilters",
     "StatsDataFiltersResponseUserFiltersStatsItem",
@@ -101,10 +105,13 @@ __all__ = [
     "StatsUserReviewScoreResponse",
     "StatsUserReviewScoreResponsePerformanceScore",
     "StatsUserReviewScoreResponseReviewScore",
+    "StatsUsersPredictionAgreementResponse",
+    "StatsUsersPredictionAgreementResponseAgreementValue",
     "assignments",
     "exports",
     "members",
     "metrics",
     "pauses",
+    "roles",
     "stats",
 ]

{label_studio_sdk-2.0.11 → label_studio_sdk-2.0.12}/src/label_studio_sdk/projects/client.py

@@ -2,6 +2,7 @@
 
 import typing
 from ..core.client_wrapper import SyncClientWrapper
+from .roles.client import RolesClient
 from .exports.client import ExportsClient
 from .members.client import MembersClient
 from .metrics.client import MetricsClient
@@ -39,6 +40,7 @@ from ..types.prediction_request import PredictionRequest
 from .types.projects_import_predictions_response import ProjectsImportPredictionsResponse
 from ..types.project_label_config import ProjectLabelConfig
 from ..core.client_wrapper import AsyncClientWrapper
+from .roles.client import AsyncRolesClient
 from .exports.client import AsyncExportsClient
 from .members.client import AsyncMembersClient
 from .metrics.client import AsyncMetricsClient
@@ -54,6 +56,7 @@ OMIT = typing.cast(typing.Any, ...)
 class ProjectsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
+        self.roles = RolesClient(client_wrapper=self._client_wrapper)
         self.exports = ExportsClient(client_wrapper=self._client_wrapper)
         self.members = MembersClient(client_wrapper=self._client_wrapper)
         self.metrics = MetricsClient(client_wrapper=self._client_wrapper)
@@ -276,6 +279,7 @@ class ProjectsClient:
             If set, the annotator can view model predictions
 
         show_ground_truth_first : typing.Optional[bool]
+            Onboarding mode (true): show ground truth tasks first in the labeling stream
 
         show_instruction : typing.Optional[bool]
             Show instructions to the annotator before they start
@@ -702,6 +706,7 @@ class ProjectsClient:
             If set, the annotator can view model predictions
 
         show_ground_truth_first : typing.Optional[bool]
+            Onboarding mode (true): show ground truth tasks first in the labeling stream
 
         show_instruction : typing.Optional[bool]
             Show instructions to the annotator before they start
@@ -1235,6 +1240,7 @@ class ProjectsClient:
 class AsyncProjectsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
+        self.roles = AsyncRolesClient(client_wrapper=self._client_wrapper)
         self.exports = AsyncExportsClient(client_wrapper=self._client_wrapper)
         self.members = AsyncMembersClient(client_wrapper=self._client_wrapper)
         self.metrics = AsyncMetricsClient(client_wrapper=self._client_wrapper)
@@ -1465,6 +1471,7 @@ class AsyncProjectsClient:
             If set, the annotator can view model predictions
 
         show_ground_truth_first : typing.Optional[bool]
+            Onboarding mode (true): show ground truth tasks first in the labeling stream
 
         show_instruction : typing.Optional[bool]
             Show instructions to the annotator before they start
@@ -1923,6 +1930,7 @@ class AsyncProjectsClient:
             If set, the annotator can view model predictions
 
         show_ground_truth_first : typing.Optional[bool]
+            Onboarding mode (true): show ground truth tasks first in the labeling stream
 
         show_instruction : typing.Optional[bool]
             Show instructions to the annotator before they start

label_studio_sdk-2.0.12/src/label_studio_sdk/projects/members/client.py

@@ -0,0 +1,264 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ...core.client_wrapper import SyncClientWrapper
+from .bulk.client import BulkClient
+from .paginated.client import PaginatedClient
+from ...core.request_options import RequestOptions
+from ...types.project_member import ProjectMember
+from ...core.jsonable_encoder import jsonable_encoder
+from ...core.unchecked_base_model import construct_type
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
+from ...core.client_wrapper import AsyncClientWrapper
+from .bulk.client import AsyncBulkClient
+from .paginated.client import AsyncPaginatedClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class MembersClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+        self.bulk = BulkClient(client_wrapper=self._client_wrapper)
+        self.paginated = PaginatedClient(client_wrapper=self._client_wrapper)
+
+    def add(self, id: int, *, user: int, request_options: typing.Optional[RequestOptions] = None) -> ProjectMember:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Add a member to a specific project.
+
+        Parameters
+        ----------
+        id : int
+
+        user : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProjectMember
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.members.add(
+            id=1,
+            user=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/members/",
+            method="POST",
+            json={
+                "user": user,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    ProjectMember,
+                    construct_type(
+                        type_=ProjectMember,  # 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 remove(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Remove a member from a specific project.
+
+        Parameters
+        ----------
+        id : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.projects.members.remove(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/members/",
+            method="DELETE",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _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)
+
+
+class AsyncMembersClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+        self.bulk = AsyncBulkClient(client_wrapper=self._client_wrapper)
+        self.paginated = AsyncPaginatedClient(client_wrapper=self._client_wrapper)
+
+    async def add(
+        self, id: int, *, user: int, request_options: typing.Optional[RequestOptions] = None
+    ) -> ProjectMember:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Add a member to a specific project.
+
+        Parameters
+        ----------
+        id : int
+
+        user : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        ProjectMember
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.members.add(
+                id=1,
+                user=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/members/",
+            method="POST",
+            json={
+                "user": user,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    ProjectMember,
+                    construct_type(
+                        type_=ProjectMember,  # 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 remove(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        <Card href="https://humansignal.com/goenterprise">
+                <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
+                <p style="margin-top: 10px; font-size: 14px;">
+                    This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
+                </p>
+            </Card>
+        Remove a member from a specific project.
+
+        Parameters
+        ----------
+        id : int
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.projects.members.remove(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/members/",
+            method="DELETE",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return
+            _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)