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

label_studio_sdk/__init__.py

@@ -1,6 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .types import (
+    ActionEnum,
     ActionsEnum,
     ActivityLog,
     ActivityLogResponse,
@@ -9,9 +10,13 @@ from .types import (
     AllRolesProjectListSkipQueue,
     AnnotatedEnum,
     Annotation,
+    AnnotationHistory,
+    AnnotationHistoryAction,
     AnnotationLastAction,
     AnnotationRequest,
     AnnotationRequestLastAction,
+    AnnotationReview,
+    AnnotationReviewRequest,
     AssignmentSettings,
     AssignmentSettingsLabelStreamTaskDistribution,
     AssignmentSettingsRequest,
@@ -20,12 +25,17 @@ from .types import (
     AuthMethodEnum,
     AzureBlobExportStorage,
     AzureBlobImportStorage,
+    AzureServicePrincipalExportStorage,
+    AzureServicePrincipalExportStorageRequest,
+    AzureServicePrincipalImportStorage,
+    AzureServicePrincipalImportStorageRequest,
     BatchFailedPredictions,
     BatchPredictions,
     BillingChecks,
     BillingFlags,
     BillingInfoResponse,
     BlankEnum,
+    Blueprint,
     BlueprintList,
     BudgetResetPeriodEnum,
     ChildFilter,
@@ -36,6 +46,8 @@ from .types import (
     ConvertedFormatRequest,
     CountLimit,
     CustomScriptsEditableByEnum,
+    DefaultRole,
+    DefaultRoleCustomScriptsEditableBy,
     DefaultRoleEnum,
     EditionEnum,
     Export,
@@ -45,6 +57,10 @@ from .types import (
     FinishedEnum,
     GcsExportStorage,
     GcsImportStorage,
+    GcswifExportStorage,
+    GcswifExportStorageRequest,
+    GcswifImportStorage,
+    GcswifImportStorageRequest,
     Hotkeys,
     ImportApiRequest,
     InferenceRunCostEstimate,
@@ -64,9 +80,12 @@ from .types import (
     LseOrganization,
     LseOrganizationCustomScriptsEditableBy,
     LseOrganizationMemberList,
+    LseProject,
     LseProjectCreate,
     LseProjectCreateSampling,
     LseProjectCreateSkipQueue,
+    LseProjectSampling,
+    LseProjectSkipQueue,
     LseProjectUpdate,
     LseProjectUpdateSampling,
     LseProjectUpdateSkipQueue,
@@ -119,7 +138,11 @@ from .types import (
     OrganizationMember,
     OrganizationMembership,
     PaginatedAllRolesProjectListList,
+    PaginatedAnnotationHistoryList,
     PaginatedLseOrganizationMemberListList,
+    PaginatedLseUserList,
+    PaginatedPaginatedProjectMemberList,
+    PaginatedProjectMember,
     PaginatedRoleBasedTaskList,
     Pause,
     PauseRequest,
@@ -132,9 +155,12 @@ from .types import (
     ProjectImport,
     ProjectLabelConfig,
     ProjectLabelConfigRequest,
+    ProjectMemberBulkAssignRolesRequest,
     ProjectSampling,
     ProjectSkipQueue,
     ProjectSubsetEnum,
+    ProjectTemplate,
+    ProjectTemplateRequest,
     PromptsStatusEnum,
     ProviderEnum,
     ReasonEnum,
@@ -165,6 +191,7 @@ from .types import (
     SerializationOptionRequest,
     SerializationOptions,
     SerializationOptionsRequest,
+    SessionTimeoutPolicy,
     SkillNameEnum,
     SkipQueueEnum,
     SkippedEnum,
@@ -172,6 +199,7 @@ from .types import (
     Status7BfEnum,
     StatusC5AEnum,
     TaskAssignment,
+    TaskEvent,
     ThirdPartyModelVersion,
     ThirdPartyModelVersionRequest,
     TokenRefreshResponse,
@@ -203,8 +231,11 @@ from .errors import (
 from . import (
     actions,
     activity_logs,
+    annotation_history,
+    annotation_reviews,
     annotations,
     billing,
+    blueprints,
     comments,
     export_storage,
     files,
@@ -214,8 +245,10 @@ from . import (
     model_providers,
     organizations,
     predictions,
+    project_templates,
     projects,
     prompts,
+    session_policy,
     sso,
     tasks,
     tokens,
@@ -242,6 +275,7 @@ from .actions import (
     ActionsListResponseItemDialog,
 )
 from .activity_logs import ActivityLogsListRequestMethod
+from .annotation_history import AnnotationHistoryDeleteResponse
 from .annotations import AnnotationBulkSerializerWithSelectedItemsRequestLastAction, AnnotationsCreateBulkResponseItem
 from .client import AsyncLabelStudio, LabelStudio
 from .environment import LabelStudioEnvironment
@@ -249,6 +283,7 @@ from .export_storage import ExportStorageListTypesResponseItem
 from .import_storage import ImportStorageListTypesResponseItem
 from .ml import MlCreateRequestAuthMethod, MlListModelVersionsResponse, MlUpdateRequestAuthMethod
 from .model_providers import ModelProvidersListModelProviderChoicesResponse
+from .organizations import PatchedDefaultRoleRequestCustomScriptsEditableBy
 from .projects import (
     LseProjectCreateRequestSampling,
     LseProjectCreateRequestSkipQueue,
@@ -300,6 +335,7 @@ from .webhooks import (
 )
 
 __all__ = [
+    "ActionEnum",
     "ActionsCreateRequestFilters",
     "ActionsCreateRequestFiltersConjunction",
     "ActionsCreateRequestFiltersItemsItem",
@@ -323,9 +359,14 @@ __all__ = [
     "AnnotatedEnum",
     "Annotation",
     "AnnotationBulkSerializerWithSelectedItemsRequestLastAction",
+    "AnnotationHistory",
+    "AnnotationHistoryAction",
+    "AnnotationHistoryDeleteResponse",
     "AnnotationLastAction",
     "AnnotationRequest",
     "AnnotationRequestLastAction",
+    "AnnotationReview",
+    "AnnotationReviewRequest",
     "AnnotationsCreateBulkResponseItem",
     "AssignmentSettings",
     "AssignmentSettingsLabelStreamTaskDistribution",
@@ -336,6 +377,10 @@ __all__ = [
     "AuthMethodEnum",
     "AzureBlobExportStorage",
     "AzureBlobImportStorage",
+    "AzureServicePrincipalExportStorage",
+    "AzureServicePrincipalExportStorageRequest",
+    "AzureServicePrincipalImportStorage",
+    "AzureServicePrincipalImportStorageRequest",
     "BadRequestError",
     "BatchFailedPredictions",
     "BatchPredictions",
@@ -343,6 +388,7 @@ __all__ = [
     "BillingFlags",
     "BillingInfoResponse",
     "BlankEnum",
+    "Blueprint",
     "BlueprintList",
     "BudgetResetPeriodEnum",
     "ChildFilter",
@@ -354,6 +400,8 @@ __all__ = [
     "ConvertedFormatRequest",
     "CountLimit",
     "CustomScriptsEditableByEnum",
+    "DefaultRole",
+    "DefaultRoleCustomScriptsEditableBy",
     "DefaultRoleEnum",
     "EditionEnum",
     "Export",
@@ -365,6 +413,10 @@ __all__ = [
     "ForbiddenError",
     "GcsExportStorage",
     "GcsImportStorage",
+    "GcswifExportStorage",
+    "GcswifExportStorageRequest",
+    "GcswifImportStorage",
+    "GcswifImportStorageRequest",
     "Hotkeys",
     "ImportApiRequest",
     "ImportStorageListTypesResponseItem",
@@ -388,11 +440,14 @@ __all__ = [
     "LseOrganization",
     "LseOrganizationCustomScriptsEditableBy",
     "LseOrganizationMemberList",
+    "LseProject",
     "LseProjectCreate",
     "LseProjectCreateRequestSampling",
     "LseProjectCreateRequestSkipQueue",
     "LseProjectCreateSampling",
     "LseProjectCreateSkipQueue",
+    "LseProjectSampling",
+    "LseProjectSkipQueue",
     "LseProjectUpdate",
     "LseProjectUpdateSampling",
     "LseProjectUpdateSkipQueue",
@@ -451,8 +506,13 @@ __all__ = [
     "OrganizationMember",
     "OrganizationMembership",
     "PaginatedAllRolesProjectListList",
+    "PaginatedAnnotationHistoryList",
     "PaginatedLseOrganizationMemberListList",
+    "PaginatedLseUserList",
+    "PaginatedPaginatedProjectMemberList",
+    "PaginatedProjectMember",
     "PaginatedRoleBasedTaskList",
+    "PatchedDefaultRoleRequestCustomScriptsEditableBy",
     "PatchedLseProjectUpdateRequestSampling",
     "PatchedLseProjectUpdateRequestSkipQueue",
     "Pause",
@@ -466,9 +526,12 @@ __all__ = [
     "ProjectImport",
     "ProjectLabelConfig",
     "ProjectLabelConfigRequest",
+    "ProjectMemberBulkAssignRolesRequest",
     "ProjectSampling",
     "ProjectSkipQueue",
     "ProjectSubsetEnum",
+    "ProjectTemplate",
+    "ProjectTemplateRequest",
     "ProjectsDuplicateResponse",
     "ProjectsImportTasksResponse",
     "ProjectsListRequestFilter",
@@ -503,6 +566,7 @@ __all__ = [
     "SerializationOptionRequest",
     "SerializationOptions",
     "SerializationOptionsRequest",
+    "SessionTimeoutPolicy",
     "SkillNameEnum",
     "SkipQueueEnum",
     "SkippedEnum",
@@ -510,6 +574,7 @@ __all__ = [
     "Status7BfEnum",
     "StatusC5AEnum",
     "TaskAssignment",
+    "TaskEvent",
     "TasksListRequestFields",
     "ThirdPartyModelVersion",
     "ThirdPartyModelVersionRequest",
@@ -568,8 +633,11 @@ __all__ = [
     "__version__",
     "actions",
     "activity_logs",
+    "annotation_history",
+    "annotation_reviews",
     "annotations",
     "billing",
+    "blueprints",
     "comments",
     "export_storage",
     "files",
@@ -579,8 +647,10 @@ __all__ = [
     "model_providers",
     "organizations",
     "predictions",
+    "project_templates",
     "projects",
     "prompts",
+    "session_policy",
     "sso",
     "tasks",
     "tokens",

label_studio_sdk/annotation_history/__init__.py

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

label_studio_sdk/annotation_history/client.py

@@ -0,0 +1,415 @@
+# 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 ..types.annotation_history import AnnotationHistory
+from ..core.unchecked_base_model import construct_type
+from json.decoder import JSONDecodeError
+from ..core.api_error import ApiError
+from .types.annotation_history_delete_response import AnnotationHistoryDeleteResponse
+from ..types.paginated_annotation_history_list import PaginatedAnnotationHistoryList
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.client_wrapper import AsyncClientWrapper
+
+
+class AnnotationHistoryClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(
+        self,
+        *,
+        annotation: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[AnnotationHistory]:
+        """
+        List annotation history items for an annotation. Annotation history logs all actions performed with annotations, such as: imports, submits, updates, reviews, and more. Users can view annotation history items in the Annotation History panel during labeling.
+
+        Parameters
+        ----------
+        annotation : typing.Optional[int]
+            Annotation ID to get annotation history items for.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[AnnotationHistory]
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.annotation_history.list()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/annotation-history/",
+            method="GET",
+            params={
+                "annotation": annotation,
+                "ordering": ordering,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[AnnotationHistory],
+                    construct_type(
+                        type_=typing.List[AnnotationHistory],  # 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 delete(
+        self,
+        *,
+        annotation: typing.Optional[int] = None,
+        project: typing.Optional[int] = None,
+        task: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AnnotationHistoryDeleteResponse:
+        """
+        Delete all annotation history items for a specific annotation, task or project. This method is available only for users with administrator roles.
+
+        Parameters
+        ----------
+        annotation : typing.Optional[int]
+            Annotation ID to delete annotation history items for.
+
+        project : typing.Optional[int]
+            Project ID to delete annotation history items for.
+
+        task : typing.Optional[int]
+            Task ID to delete annotation history items for.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AnnotationHistoryDeleteResponse
+            Returns a dict containing the count of removed items.
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.annotation_history.delete()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/annotation-history/",
+            method="DELETE",
+            params={
+                "annotation": annotation,
+                "project": project,
+                "task": task,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    AnnotationHistoryDeleteResponse,
+                    construct_type(
+                        type_=AnnotationHistoryDeleteResponse,  # 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 list_for_project(
+        self,
+        id: int,
+        *,
+        page: typing.Optional[int] = None,
+        page_size: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaginatedAnnotationHistoryList:
+        """
+        List all annotation history items for the project with pagination.
+
+        Parameters
+        ----------
+        id : int
+
+        page : typing.Optional[int]
+            A page number within the paginated result set.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedAnnotationHistoryList
+
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.annotation_history.list_for_project(
+            id=1,
+        )
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/annotation-history/",
+            method="GET",
+            params={
+                "page": page,
+                "page_size": page_size,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PaginatedAnnotationHistoryList,
+                    construct_type(
+                        type_=PaginatedAnnotationHistoryList,  # 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 AsyncAnnotationHistoryClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
+        self,
+        *,
+        annotation: typing.Optional[int] = None,
+        ordering: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.List[AnnotationHistory]:
+        """
+        List annotation history items for an annotation. Annotation history logs all actions performed with annotations, such as: imports, submits, updates, reviews, and more. Users can view annotation history items in the Annotation History panel during labeling.
+
+        Parameters
+        ----------
+        annotation : typing.Optional[int]
+            Annotation ID to get annotation history items for.
+
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.List[AnnotationHistory]
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.annotation_history.list()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/annotation-history/",
+            method="GET",
+            params={
+                "annotation": annotation,
+                "ordering": ordering,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    typing.List[AnnotationHistory],
+                    construct_type(
+                        type_=typing.List[AnnotationHistory],  # 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 delete(
+        self,
+        *,
+        annotation: typing.Optional[int] = None,
+        project: typing.Optional[int] = None,
+        task: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AnnotationHistoryDeleteResponse:
+        """
+        Delete all annotation history items for a specific annotation, task or project. This method is available only for users with administrator roles.
+
+        Parameters
+        ----------
+        annotation : typing.Optional[int]
+            Annotation ID to delete annotation history items for.
+
+        project : typing.Optional[int]
+            Project ID to delete annotation history items for.
+
+        task : typing.Optional[int]
+            Task ID to delete annotation history items for.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AnnotationHistoryDeleteResponse
+            Returns a dict containing the count of removed items.
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.annotation_history.delete()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/annotation-history/",
+            method="DELETE",
+            params={
+                "annotation": annotation,
+                "project": project,
+                "task": task,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    AnnotationHistoryDeleteResponse,
+                    construct_type(
+                        type_=AnnotationHistoryDeleteResponse,  # 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 list_for_project(
+        self,
+        id: int,
+        *,
+        page: typing.Optional[int] = None,
+        page_size: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PaginatedAnnotationHistoryList:
+        """
+        List all annotation history items for the project with pagination.
+
+        Parameters
+        ----------
+        id : int
+
+        page : typing.Optional[int]
+            A page number within the paginated result set.
+
+        page_size : typing.Optional[int]
+            Number of results to return per page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PaginatedAnnotationHistoryList
+
+
+        Examples
+        --------
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.annotation_history.list_for_project(
+                id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/projects/{jsonable_encoder(id)}/annotation-history/",
+            method="GET",
+            params={
+                "page": page,
+                "page_size": page_size,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    PaginatedAnnotationHistoryList,
+                    construct_type(
+                        type_=PaginatedAnnotationHistoryList,  # 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/annotation_history/types/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .annotation_history_delete_response import AnnotationHistoryDeleteResponse
+
+__all__ = ["AnnotationHistoryDeleteResponse"]