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

label_studio_sdk/types/gcswif_import_storage_request.py

@@ -0,0 +1,113 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+import datetime as dt
+from .status_c5a_enum import StatusC5AEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GcswifImportStorageRequest(UncheckedBaseModel):
+    bucket: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    GCS bucket name
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage description
+    """
+
+    google_application_credentials: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The content of GOOGLE_APPLICATION_CREDENTIALS json file
+    """
+
+    google_project_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google project ID
+    """
+
+    google_project_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google project number
+    """
+
+    google_service_account_email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google service account email
+    """
+
+    google_wif_pool_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google WIF pool ID
+    """
+
+    google_wif_provider_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google WIF provider ID
+    """
+
+    last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Last sync finished time
+    """
+
+    last_sync_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Count of tasks synced last time
+    """
+
+    last_sync_job: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Last sync job ID
+    """
+
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
+    prefix: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    GCS bucket prefix
+    """
+
+    presign: typing.Optional[bool] = None
+    presign_ttl: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Presigned URLs TTL (in minutes)
+    """
+
+    project: int = pydantic.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage regex for filtering objects
+    """
+
+    status: typing.Optional[StatusC5AEnum] = None
+    synchronizable: typing.Optional[bool] = None
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage title
+    """
+
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Traceback report for the last failed sync
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/lse_project_update.py

@@ -156,6 +156,7 @@ class LseProjectUpdate(UncheckedBaseModel):
     Show a skip button in interface and allow annotators to skip the task
     """
 
+    show_unused_data_columns_to_annotators: typing.Optional[bool] = None
     skip_queue: typing.Optional[LseProjectUpdateSkipQueue] = None
     skipped_annotations_number: int = pydantic.Field()
     """

label_studio_sdk/types/lse_task.py

@@ -15,6 +15,7 @@ class LseTask(UncheckedBaseModel):
     """
 
     agreement: str
+    agreement_filtered: str
     annotations: str
     annotations_ids: str
     annotations_results: str

label_studio_sdk/types/lse_task_serializer_for_reviewers.py

@@ -15,6 +15,7 @@ class LseTaskSerializerForReviewers(UncheckedBaseModel):
     """
 
     agreement: str
+    agreement_filtered: str
     annotations: str
     annotations_ids: str
     annotations_results: str

label_studio_sdk/types/lsejwt_settings.py

@@ -7,11 +7,7 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class LsejwtSettings(UncheckedBaseModel):
-    api_token_ttl_days: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Number of days before JWT API tokens expire
-    """
-
+    api_token_ttl_days: int
     api_tokens_enabled: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Enable JWT API token authentication for this organization

label_studio_sdk/types/paginated_annotation_history_list.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .annotation_history import AnnotationHistory
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PaginatedAnnotationHistoryList(UncheckedBaseModel):
+    count: int
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.List[AnnotationHistory]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/paginated_lse_user_list.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .lse_user import LseUser
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PaginatedLseUserList(UncheckedBaseModel):
+    count: int
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.List[LseUser]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/paginated_paginated_project_member_list.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .paginated_project_member import PaginatedProjectMember
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PaginatedPaginatedProjectMemberList(UncheckedBaseModel):
+    count: int
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.List[PaginatedProjectMember]
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/paginated_project_member.py

@@ -0,0 +1,50 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+import datetime as dt
+from .lse_fields import LseFields
+from .organization_membership import OrganizationMembership
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class PaginatedProjectMember(UncheckedBaseModel):
+    """
+    A ModelSerializer that takes additional arguments for
+    "fields", "omit" and "expand" in order to
+    control which fields are displayed, and whether to replace simple
+    values with complex, nested serializations
+    """
+
+    active_organization: typing.Optional[int] = None
+    active_organization_meta: str
+    allow_newsletters: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow sending newsletters to user
+    """
+
+    avatar: str
+    custom_hotkeys: typing.Optional[typing.Optional[typing.Any]] = None
+    date_joined: typing.Optional[dt.datetime] = None
+    email: typing.Optional[str] = None
+    first_name: typing.Optional[str] = None
+    id: int
+    initials: str
+    last_activity: dt.datetime
+    last_name: typing.Optional[str] = None
+    lse_fields: LseFields
+    org_membership: typing.List[OrganizationMembership]
+    pause: str
+    phone: typing.Optional[str] = None
+    project_role: str
+    username: str
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/project_member_bulk_assign_roles_request.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .role9e7enum import Role9E7Enum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class ProjectMemberBulkAssignRolesRequest(UncheckedBaseModel):
+    role: Role9E7Enum
+    user_id: int
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/review_settings.py

@@ -69,6 +69,11 @@ class ReviewSettings(UncheckedBaseModel):
     Show instructions to the reviewers before they start
     """
 
+    show_unused_data_columns_to_reviewers: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If true, Data Manager shows all task.data columns to reviewers; if false, hides columns not referenced by the label interface
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

label_studio_sdk/types/review_settings_request.py

@@ -69,6 +69,11 @@ class ReviewSettingsRequest(UncheckedBaseModel):
     Show instructions to the reviewers before they start
     """
 
+    show_unused_data_columns_to_reviewers: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If true, Data Manager shows all task.data columns to reviewers; if false, hides columns not referenced by the label interface
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

label_studio_sdk/types/session_timeout_policy.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import datetime as dt
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class SessionTimeoutPolicy(UncheckedBaseModel):
+    created_at: dt.datetime
+    max_session_age: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of minutes that a session can be active before needing to re-login
+    """
+
+    max_time_between_activity: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of minutes that a session stays active without any activity
+    """
+
+    updated_at: dt.datetime
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/task_event.py

@@ -0,0 +1,61 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class TaskEvent(UncheckedBaseModel):
+    """
+    Serializer for TaskEvent model to handle event creation from frontend.
+
+    This serializer validates and processes task events sent from the labeling interface,
+    ensuring proper data format and automatically setting required relationships.
+    """
+
+    actor: int
+    annotation: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Annotation ID associated with this event
+    """
+
+    annotation_draft: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Draft annotation ID associated with this event
+    """
+
+    created_at: dt.datetime
+    event_key: str = pydantic.Field()
+    """
+    Event type identifier (e.g., "annotation_loaded", "region_finished_drawing")
+    """
+
+    event_time: dt.datetime = pydantic.Field()
+    """
+    Timestamp when the event occurred (frontend time)
+    """
+
+    id: int
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
+    organization: int
+    project: int
+    review: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Review ID associated with this event
+    """
+
+    task: int = pydantic.Field()
+    """
+    Task this event is associated with
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/workspaces/members/__init__.py

@@ -1,6 +1,6 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from . import bulk
+from . import bulk, paginated
 from .bulk import BulkDeleteResponse, BulkPostResponse
 
-__all__ = ["BulkDeleteResponse", "BulkPostResponse", "bulk"]
+__all__ = ["BulkDeleteResponse", "BulkPostResponse", "bulk", "paginated"]

label_studio_sdk/workspaces/members/client.py

@@ -3,6 +3,7 @@
 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.workspace_member_list import WorkspaceMemberList
 from ...core.jsonable_encoder import jsonable_encoder
@@ -12,6 +13,7 @@ from ...core.api_error import ApiError
 from ...types.workspace_member_create import WorkspaceMemberCreate
 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, ...)
@@ -21,6 +23,7 @@ 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 list(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
@@ -182,6 +185,7 @@ 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 list(
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None

label_studio_sdk/workspaces/members/paginated/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+

label_studio_sdk/workspaces/members/paginated/client.py

@@ -0,0 +1,212 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ....core.client_wrapper import SyncClientWrapper
+import typing
+from ....core.request_options import RequestOptions
+from ....core.pagination import SyncPager
+from ....types.lse_user import LseUser
+from ....core.jsonable_encoder import jsonable_encoder
+from ....types.paginated_lse_user_list import PaginatedLseUserList
+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 ....core.pagination import AsyncPager
+
+
+class PaginatedClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        id: int,
+        *,
+        ids: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        page_size: typing.Optional[int] = None,
+        search: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SyncPager[LseUser]:
+        """
+        Retrieve the members for a specific workspace.
+
+        Parameters
+        ----------
+        id : int
+
+        ids : typing.Optional[str]
+            Comma-separated list of user IDs to filter by
+
+        page : typing.Optional[int]
+            A page number within the paginated result set.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        search : typing.Optional[str]
+            A search term.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SyncPager[LseUser]
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        response = client.workspaces.members.paginated.list(
+            id=1,
+        )
+        for item in response:
+            yield item
+        # alternatively, you can paginate page-by-page
+        for page in response.iter_pages():
+            yield page
+        """
+        page = page if page is not None else 1
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/workspaces/{jsonable_encoder(id)}/memberships/paginated/",
+            method="GET",
+            params={
+                "ids": ids,
+                "page": page,
+                "page_size": page_size,
+                "search": search,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _parsed_response = typing.cast(
+                    PaginatedLseUserList,
+                    construct_type(
+                        type_=PaginatedLseUserList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                _has_next = True
+                _get_next = lambda: self.list(
+                    id,
+                    ids=ids,
+                    page=page + 1,
+                    page_size=page_size,
+                    search=search,
+                    request_options=request_options,
+                )
+                _items = _parsed_response.results
+                return SyncPager(has_next=_has_next, items=_items, get_next=_get_next)
+            _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 AsyncPaginatedClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        id: int,
+        *,
+        ids: typing.Optional[str] = None,
+        page: typing.Optional[int] = None,
+        page_size: typing.Optional[int] = None,
+        search: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncPager[LseUser]:
+        """
+        Retrieve the members for a specific workspace.
+
+        Parameters
+        ----------
+        id : int
+
+        ids : typing.Optional[str]
+            Comma-separated list of user IDs to filter by
+
+        page : typing.Optional[int]
+            A page number within the paginated result set.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        search : typing.Optional[str]
+            A search term.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncPager[LseUser]
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            response = await client.workspaces.members.paginated.list(
+                id=1,
+            )
+            async for item in response:
+                yield item
+            # alternatively, you can paginate page-by-page
+            async for page in response.iter_pages():
+                yield page
+
+
+        asyncio.run(main())
+        """
+        page = page if page is not None else 1
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/workspaces/{jsonable_encoder(id)}/memberships/paginated/",
+            method="GET",
+            params={
+                "ids": ids,
+                "page": page,
+                "page_size": page_size,
+                "search": search,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _parsed_response = typing.cast(
+                    PaginatedLseUserList,
+                    construct_type(
+                        type_=PaginatedLseUserList,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                _has_next = True
+                _get_next = lambda: self.list(
+                    id,
+                    ids=ids,
+                    page=page + 1,
+                    page_size=page_size,
+                    search=search,
+                    request_options=request_options,
+                )
+                _items = _parsed_response.results
+                return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next)
+            _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)