label-studio-sdk 1.0.20__py3-none-any.whl → 2.0.1__py3-none-any.whl

label_studio_sdk/projects/pauses/client.py

@@ -5,9 +5,10 @@ from ...core.client_wrapper import SyncClientWrapper
 from ...core.request_options import RequestOptions
 from ...types.pause import Pause
 from ...core.jsonable_encoder import jsonable_encoder
-from ...core.pydantic_utilities import parse_obj_as
+from ...core.unchecked_base_model import construct_type
 from json.decoder import JSONDecodeError
 from ...core.api_error import ApiError
+from ...types.reason_enum import ReasonEnum
 from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -24,21 +25,23 @@ class PausesClient:
         user_pk: int,
         *,
         include_deleted: typing.Optional[bool] = None,
+        ordering: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Pause]:
         """
-        Return a list of pause objects for the specified project and user.
+        Retrieve a list of all pauses.
 
         Parameters
         ----------
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
 
         include_deleted : typing.Optional[bool]
-            Include deleted pauses
+            Include deleted pauses.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -46,7 +49,7 @@ class PausesClient:
         Returns
         -------
         typing.List[Pause]
-            Successfully retrieved a list of pauses
+
 
         Examples
         --------
@@ -61,10 +64,11 @@ class PausesClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/",
             method="GET",
             params={
                 "include_deleted": include_deleted,
+                "ordering": ordering,
             },
             request_options=request_options,
         )
@@ -72,7 +76,7 @@ class PausesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     typing.List[Pause],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[Pause],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -87,24 +91,30 @@ class PausesClient:
         project_pk: int,
         user_pk: int,
         *,
-        reason: str,
+        reason: ReasonEnum,
         verbose_reason: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Pause:
         """
-        Create a new pause object for the specified project and user.
+        Create a new pause entry.
 
         Parameters
         ----------
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
 
-        reason : str
+        reason : ReasonEnum
+            Reason for pausing
+
+            * `MANUAL` - Manual
+            * `BEHAVIOR_BASED` - Behavior-based
+            * `ANNOTATOR_EVALUATION` - Annotator evaluation
+            * `ANNOTATION_LIMIT` - Annotation limit
+            * `CUSTOM_SCRIPT` - Custom script
 
         verbose_reason : typing.Optional[str]
+            Detailed description of why the project is paused, will be readable by paused annotators
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -112,7 +122,7 @@ class PausesClient:
         Returns
         -------
         Pause
-            Successfully created a pause
+
 
         Examples
         --------
@@ -124,19 +134,16 @@ class PausesClient:
         client.projects.pauses.create(
             project_pk=1,
             user_pk=1,
-            reason="reason",
+            reason="MANUAL",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/",
             method="POST",
             json={
                 "reason": reason,
                 "verbose_reason": verbose_reason,
             },
-            headers={
-                "content-type": "application/json",
-            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -144,7 +151,7 @@ class PausesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Pause,
-                    parse_obj_as(
+                    construct_type(
                         type_=Pause,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -155,21 +162,18 @@ class PausesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def get(
-        self, project_pk: int, user_pk: int, id: int, *, request_options: typing.Optional[RequestOptions] = None
+        self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> Pause:
         """
-        Return detailed information about a specific pause.
+        Retrieve a specific pause by ID.
 
         Parameters
         ----------
+        id : str
+
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
-
-        id : int
-            Pause ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -177,7 +181,7 @@ class PausesClient:
         Returns
         -------
         Pause
-            Successfully retrieved the pause
+
 
         Examples
         --------
@@ -187,13 +191,13 @@ class PausesClient:
             api_key="YOUR_API_KEY",
         )
         client.projects.pauses.get(
+            id="id",
             project_pk=1,
             user_pk=1,
-            id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}/",
             method="GET",
             request_options=request_options,
         )
@@ -201,7 +205,7 @@ class PausesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Pause,
-                    parse_obj_as(
+                    construct_type(
                         type_=Pause,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -212,21 +216,18 @@ class PausesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     def delete(
-        self, project_pk: int, user_pk: int, id: int, *, request_options: typing.Optional[RequestOptions] = None
+        self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> None:
         """
-        Remove a pause from the database.
+        Delete a specific pause by ID.
 
         Parameters
         ----------
+        id : str
+
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
-
-        id : int
-            Pause ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -243,13 +244,13 @@ class PausesClient:
             api_key="YOUR_API_KEY",
         )
         client.projects.pauses.delete(
+            id="id",
             project_pk=1,
             user_pk=1,
-            id=1,
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}/",
             method="DELETE",
             request_options=request_options,
         )
@@ -263,31 +264,36 @@ class PausesClient:
 
     def update(
         self,
+        id: str,
         project_pk: int,
         user_pk: int,
-        id: int,
         *,
-        reason: str,
+        reason: typing.Optional[ReasonEnum] = OMIT,
         verbose_reason: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Pause:
         """
-        Partially update one or more fields of an existing pause.
+        Partially update a pause entry by ID.
 
         Parameters
         ----------
+        id : str
+
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
 
-        id : int
-            Pause ID
+        reason : typing.Optional[ReasonEnum]
+            Reason for pausing
 
-        reason : str
+            * `MANUAL` - Manual
+            * `BEHAVIOR_BASED` - Behavior-based
+            * `ANNOTATOR_EVALUATION` - Annotator evaluation
+            * `ANNOTATION_LIMIT` - Annotation limit
+            * `CUSTOM_SCRIPT` - Custom script
 
         verbose_reason : typing.Optional[str]
+            Detailed description of why the project is paused, will be readable by paused annotators
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -295,7 +301,7 @@ class PausesClient:
         Returns
         -------
         Pause
-            Successfully updated the pause (partial)
+
 
         Examples
         --------
@@ -305,14 +311,13 @@ class PausesClient:
             api_key="YOUR_API_KEY",
         )
         client.projects.pauses.update(
+            id="id",
             project_pk=1,
             user_pk=1,
-            id=1,
-            reason="reason",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}/",
             method="PATCH",
             json={
                 "reason": reason,
@@ -328,7 +333,7 @@ class PausesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Pause,
-                    parse_obj_as(
+                    construct_type(
                         type_=Pause,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -349,21 +354,23 @@ class AsyncPausesClient:
         user_pk: int,
         *,
         include_deleted: typing.Optional[bool] = None,
+        ordering: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[Pause]:
         """
-        Return a list of pause objects for the specified project and user.
+        Retrieve a list of all pauses.
 
         Parameters
         ----------
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
 
         include_deleted : typing.Optional[bool]
-            Include deleted pauses
+            Include deleted pauses.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -371,7 +378,7 @@ class AsyncPausesClient:
         Returns
         -------
         typing.List[Pause]
-            Successfully retrieved a list of pauses
+
 
         Examples
         --------
@@ -394,10 +401,11 @@ class AsyncPausesClient:
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/",
             method="GET",
             params={
                 "include_deleted": include_deleted,
+                "ordering": ordering,
             },
             request_options=request_options,
         )
@@ -405,7 +413,7 @@ class AsyncPausesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     typing.List[Pause],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[Pause],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -420,24 +428,30 @@ class AsyncPausesClient:
         project_pk: int,
         user_pk: int,
         *,
-        reason: str,
+        reason: ReasonEnum,
         verbose_reason: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Pause:
         """
-        Create a new pause object for the specified project and user.
+        Create a new pause entry.
 
         Parameters
         ----------
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
 
-        reason : str
+        reason : ReasonEnum
+            Reason for pausing
+
+            * `MANUAL` - Manual
+            * `BEHAVIOR_BASED` - Behavior-based
+            * `ANNOTATOR_EVALUATION` - Annotator evaluation
+            * `ANNOTATION_LIMIT` - Annotation limit
+            * `CUSTOM_SCRIPT` - Custom script
 
         verbose_reason : typing.Optional[str]
+            Detailed description of why the project is paused, will be readable by paused annotators
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -445,7 +459,7 @@ class AsyncPausesClient:
         Returns
         -------
         Pause
-            Successfully created a pause
+
 
         Examples
         --------
@@ -462,22 +476,19 @@ class AsyncPausesClient:
             await client.projects.pauses.create(
                 project_pk=1,
                 user_pk=1,
-                reason="reason",
+                reason="MANUAL",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/",
             method="POST",
             json={
                 "reason": reason,
                 "verbose_reason": verbose_reason,
             },
-            headers={
-                "content-type": "application/json",
-            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -485,7 +496,7 @@ class AsyncPausesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Pause,
-                    parse_obj_as(
+                    construct_type(
                         type_=Pause,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -496,21 +507,18 @@ class AsyncPausesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def get(
-        self, project_pk: int, user_pk: int, id: int, *, request_options: typing.Optional[RequestOptions] = None
+        self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> Pause:
         """
-        Return detailed information about a specific pause.
+        Retrieve a specific pause by ID.
 
         Parameters
         ----------
+        id : str
+
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
-
-        id : int
-            Pause ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -518,7 +526,7 @@ class AsyncPausesClient:
         Returns
         -------
         Pause
-            Successfully retrieved the pause
+
 
         Examples
         --------
@@ -533,16 +541,16 @@ class AsyncPausesClient:
 
         async def main() -> None:
             await client.projects.pauses.get(
+                id="id",
                 project_pk=1,
                 user_pk=1,
-                id=1,
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}/",
             method="GET",
             request_options=request_options,
         )
@@ -550,7 +558,7 @@ class AsyncPausesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Pause,
-                    parse_obj_as(
+                    construct_type(
                         type_=Pause,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -561,21 +569,18 @@ class AsyncPausesClient:
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
     async def delete(
-        self, project_pk: int, user_pk: int, id: int, *, request_options: typing.Optional[RequestOptions] = None
+        self, id: str, project_pk: int, user_pk: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> None:
         """
-        Remove a pause from the database.
+        Delete a specific pause by ID.
 
         Parameters
         ----------
+        id : str
+
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
-
-        id : int
-            Pause ID
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -597,16 +602,16 @@ class AsyncPausesClient:
 
         async def main() -> None:
             await client.projects.pauses.delete(
+                id="id",
                 project_pk=1,
                 user_pk=1,
-                id=1,
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}/",
             method="DELETE",
             request_options=request_options,
         )
@@ -620,31 +625,36 @@ class AsyncPausesClient:
 
     async def update(
         self,
+        id: str,
         project_pk: int,
         user_pk: int,
-        id: int,
         *,
-        reason: str,
+        reason: typing.Optional[ReasonEnum] = OMIT,
         verbose_reason: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Pause:
         """
-        Partially update one or more fields of an existing pause.
+        Partially update a pause entry by ID.
 
         Parameters
         ----------
+        id : str
+
         project_pk : int
-            Project ID
 
         user_pk : int
-            User ID
 
-        id : int
-            Pause ID
+        reason : typing.Optional[ReasonEnum]
+            Reason for pausing
 
-        reason : str
+            * `MANUAL` - Manual
+            * `BEHAVIOR_BASED` - Behavior-based
+            * `ANNOTATOR_EVALUATION` - Annotator evaluation
+            * `ANNOTATION_LIMIT` - Annotation limit
+            * `CUSTOM_SCRIPT` - Custom script
 
         verbose_reason : typing.Optional[str]
+            Detailed description of why the project is paused, will be readable by paused annotators
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -652,7 +662,7 @@ class AsyncPausesClient:
         Returns
         -------
         Pause
-            Successfully updated the pause (partial)
+
 
         Examples
         --------
@@ -667,17 +677,16 @@ class AsyncPausesClient:
 
         async def main() -> None:
             await client.projects.pauses.update(
+                id="id",
                 project_pk=1,
                 user_pk=1,
-                id=1,
-                reason="reason",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}",
+            f"api/projects/{jsonable_encoder(project_pk)}/members/{jsonable_encoder(user_pk)}/pauses/{jsonable_encoder(id)}/",
             method="PATCH",
             json={
                 "reason": reason,
@@ -693,7 +702,7 @@ class AsyncPausesClient:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
                     Pause,
-                    parse_obj_as(
+                    construct_type(
                         type_=Pause,  # type: ignore
                         object_=_response.json(),
                     ),

label_studio_sdk/projects/stats/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import StatsIaaResponse, StatsIaaResponseCommonTasks, StatsIaaResponseIaa, StatsIaaResponseStd
+
+__all__ = ["StatsIaaResponse", "StatsIaaResponseCommonTasks", "StatsIaaResponseIaa", "StatsIaaResponseStd"]