label-studio-sdk 2.0.5__py3-none-any.whl → 2.0.7__py3-none-any.whl

label_studio_sdk/session_policy/client.py

@@ -0,0 +1,247 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ..core.client_wrapper import SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.session_timeout_policy import SessionTimeoutPolicy
+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
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class SessionPolicyClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> SessionTimeoutPolicy:
+        """
+        Retrieve session timeout policy for the currently active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SessionTimeoutPolicy
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.session_policy.get()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/session-policy/",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    SessionTimeoutPolicy,
+                    construct_type(
+                        type_=SessionTimeoutPolicy,  # 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 update(
+        self,
+        *,
+        max_session_age: typing.Optional[int] = OMIT,
+        max_time_between_activity: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SessionTimeoutPolicy:
+        """
+        Update session timeout policy for the currently active organization.
+
+        Parameters
+        ----------
+        max_session_age : typing.Optional[int]
+            Number of minutes that a session can be active before needing to re-login
+
+        max_time_between_activity : typing.Optional[int]
+            Number of minutes that a session stays active without any activity
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SessionTimeoutPolicy
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.session_policy.update()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/session-policy/",
+            method="PATCH",
+            json={
+                "max_session_age": max_session_age,
+                "max_time_between_activity": max_time_between_activity,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    SessionTimeoutPolicy,
+                    construct_type(
+                        type_=SessionTimeoutPolicy,  # 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)
+
+
+class AsyncSessionPolicyClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> SessionTimeoutPolicy:
+        """
+        Retrieve session timeout policy for the currently active organization.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SessionTimeoutPolicy
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.session_policy.get()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/session-policy/",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    SessionTimeoutPolicy,
+                    construct_type(
+                        type_=SessionTimeoutPolicy,  # 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 update(
+        self,
+        *,
+        max_session_age: typing.Optional[int] = OMIT,
+        max_time_between_activity: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SessionTimeoutPolicy:
+        """
+        Update session timeout policy for the currently active organization.
+
+        Parameters
+        ----------
+        max_session_age : typing.Optional[int]
+            Number of minutes that a session can be active before needing to re-login
+
+        max_time_between_activity : typing.Optional[int]
+            Number of minutes that a session stays active without any activity
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SessionTimeoutPolicy
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.session_policy.update()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/session-policy/",
+            method="PATCH",
+            json={
+                "max_session_age": max_session_age,
+                "max_time_between_activity": max_time_between_activity,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    SessionTimeoutPolicy,
+                    construct_type(
+                        type_=SessionTimeoutPolicy,  # 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)

label_studio_sdk/tasks/client.py

@@ -17,6 +17,8 @@ from ..errors.unauthorized_error import UnauthorizedError
 from ..errors.forbidden_error import ForbiddenError
 import datetime as dt
 from ..types.lse_task import LseTask
+from ..types.task_event import TaskEvent
+from ..errors.not_found_error import NotFoundError
 from ..core.client_wrapper import AsyncClientWrapper
 from ..core.pagination import AsyncPager
 
@@ -644,6 +646,187 @@ class TasksClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def create_event(
+        self,
+        id: int,
+        *,
+        event_key: str,
+        event_time: dt.datetime,
+        annotation: typing.Optional[int] = OMIT,
+        annotation_draft: typing.Optional[int] = OMIT,
+        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        review: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> TaskEvent:
+        """
+
+            Create a new task event to track user interactions and system events during annotation.
+
+            This endpoint is designed to receive events from the frontend labeling interface to enable
+            accurate lead time calculation and detailed annotation analytics.
+
+            ## Event Types
+
+            **Core Annotation Events:**
+            - `annotation_loaded` - When annotation interface is loaded
+            - `annotation_submitted` - When annotation is submitted
+            - `annotation_updated` - When annotation is modified
+            - `annotation_reviewed` - When annotation is reviewed
+
+            **User Activity Events:**
+            - `visibility_change` - When page visibility changes (tab switch, minimize)
+            - `idle_detected` - When user goes idle
+            - `idle_resumed` - When user returns from idle
+
+            **Interaction Events:**
+            - `region_finished_drawing` - When annotation region is completed
+            - `region_deleted` - When annotation regions are removed
+            - `hotkey_pressed` - When keyboard shortcuts are used
+
+            **Media Events:**
+            - `video_playback_start/end` - Video playback control
+            - `audio_playback_start/end` - Audio playback control
+            - `video_scrub` - Video timeline scrubbing
+
+            ## Usage
+
+            Events are automatically associated with the task specified in the URL path.
+            The current user is automatically set as the actor. Project and organization
+            are derived from the task context.
+
+            ## Example Request
+
+            ```json
+            {
+                "event_key": "annotation_loaded",
+                "event_time": "2024-01-15T10:30:00Z",
+                "annotation": 123,
+                "meta": {
+                    "annotation_count": 5,
+                    "estimated_time": 300
+                }
+            }
+            ```
+
+
+        Parameters
+        ----------
+        id : int
+            Task ID to associate the event with
+
+        event_key : str
+            Event type identifier (e.g., "annotation_loaded", "region_finished_drawing")
+
+        event_time : dt.datetime
+            Timestamp when the event occurred (frontend time)
+
+        annotation : typing.Optional[int]
+            Annotation ID associated with this event
+
+        annotation_draft : typing.Optional[int]
+            Draft annotation ID associated with this event
+
+        meta : typing.Optional[typing.Optional[typing.Any]]
+
+        review : typing.Optional[int]
+            Review ID associated with this event
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        TaskEvent
+
+
+        Examples
+        --------
+        import datetime
+
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.tasks.create_event(
+            id=1,
+            event_key="event_key",
+            event_time=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/tasks/{jsonable_encoder(id)}/events/",
+            method="POST",
+            json={
+                "annotation": annotation,
+                "annotation_draft": annotation_draft,
+                "event_key": event_key,
+                "event_time": event_time,
+                "meta": meta,
+                "review": review,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    TaskEvent,
+                    construct_type(
+                        type_=TaskEvent,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # 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)
+
 
 class AsyncTasksClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -1320,3 +1503,191 @@ class AsyncTasksClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def create_event(
+        self,
+        id: int,
+        *,
+        event_key: str,
+        event_time: dt.datetime,
+        annotation: typing.Optional[int] = OMIT,
+        annotation_draft: typing.Optional[int] = OMIT,
+        meta: typing.Optional[typing.Optional[typing.Any]] = OMIT,
+        review: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> TaskEvent:
+        """
+
+            Create a new task event to track user interactions and system events during annotation.
+
+            This endpoint is designed to receive events from the frontend labeling interface to enable
+            accurate lead time calculation and detailed annotation analytics.
+
+            ## Event Types
+
+            **Core Annotation Events:**
+            - `annotation_loaded` - When annotation interface is loaded
+            - `annotation_submitted` - When annotation is submitted
+            - `annotation_updated` - When annotation is modified
+            - `annotation_reviewed` - When annotation is reviewed
+
+            **User Activity Events:**
+            - `visibility_change` - When page visibility changes (tab switch, minimize)
+            - `idle_detected` - When user goes idle
+            - `idle_resumed` - When user returns from idle
+
+            **Interaction Events:**
+            - `region_finished_drawing` - When annotation region is completed
+            - `region_deleted` - When annotation regions are removed
+            - `hotkey_pressed` - When keyboard shortcuts are used
+
+            **Media Events:**
+            - `video_playback_start/end` - Video playback control
+            - `audio_playback_start/end` - Audio playback control
+            - `video_scrub` - Video timeline scrubbing
+
+            ## Usage
+
+            Events are automatically associated with the task specified in the URL path.
+            The current user is automatically set as the actor. Project and organization
+            are derived from the task context.
+
+            ## Example Request
+
+            ```json
+            {
+                "event_key": "annotation_loaded",
+                "event_time": "2024-01-15T10:30:00Z",
+                "annotation": 123,
+                "meta": {
+                    "annotation_count": 5,
+                    "estimated_time": 300
+                }
+            }
+            ```
+
+
+        Parameters
+        ----------
+        id : int
+            Task ID to associate the event with
+
+        event_key : str
+            Event type identifier (e.g., "annotation_loaded", "region_finished_drawing")
+
+        event_time : dt.datetime
+            Timestamp when the event occurred (frontend time)
+
+        annotation : typing.Optional[int]
+            Annotation ID associated with this event
+
+        annotation_draft : typing.Optional[int]
+            Draft annotation ID associated with this event
+
+        meta : typing.Optional[typing.Optional[typing.Any]]
+
+        review : typing.Optional[int]
+            Review ID associated with this event
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        TaskEvent
+
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.tasks.create_event(
+                id=1,
+                event_key="event_key",
+                event_time=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/tasks/{jsonable_encoder(id)}/events/",
+            method="POST",
+            json={
+                "annotation": annotation,
+                "annotation_draft": annotation_draft,
+                "event_key": event_key,
+                "event_time": event_time,
+                "meta": meta,
+                "review": review,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    TaskEvent,
+                    construct_type(
+                        type_=TaskEvent,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    typing.cast(
+                        typing.Optional[typing.Any],
+                        construct_type(
+                            type_=typing.Optional[typing.Any],  # 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)