label-studio-sdk 0.0.34__py3-none-any.whl → 1.0.0__py3-none-any.whl

label_studio_sdk/tasks/types/__init__.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .tasks_list_request_fields import TasksListRequestFields
+from .tasks_list_response import TasksListResponse
+
+__all__ = ["TasksListRequestFields", "TasksListResponse"]

label_studio_sdk/tasks/types/tasks_list_request_fields.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TasksListRequestFields = typing.Union[typing.Literal["all", "task_only"], typing.Any]

label_studio_sdk/tasks/types/tasks_list_response.py

@@ -0,0 +1,48 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ...core.datetime_utils import serialize_datetime
+from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from ...types.task import Task
+
+
+class TasksListResponse(pydantic_v1.BaseModel):
+    tasks: typing.Optional[typing.List[Task]] = pydantic_v1.Field(default=None)
+    """
+    List of tasks, each task contains predictions and annotations if `fields` query parameter is set to `all`
+    """
+
+    total: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Total number of tasks
+    """
+
+    total_annotations: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Total number of annotations
+    """
+
+    total_predictions: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Total number of predictions
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/__init__.py

@@ -0,0 +1,115 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .annotation import Annotation
+from .annotation_filter_options import AnnotationFilterOptions
+from .annotation_last_action import AnnotationLastAction
+from .azure_blob_export_storage import AzureBlobExportStorage
+from .azure_blob_export_storage_status import AzureBlobExportStorageStatus
+from .azure_blob_import_storage import AzureBlobImportStorage
+from .azure_blob_import_storage_status import AzureBlobImportStorageStatus
+from .base_task import BaseTask
+from .base_user import BaseUser
+from .converted_format import ConvertedFormat
+from .converted_format_status import ConvertedFormatStatus
+from .export import Export
+from .export_convert import ExportConvert
+from .export_create import ExportCreate
+from .export_create_status import ExportCreateStatus
+from .export_status import ExportStatus
+from .file_upload import FileUpload
+from .filter import Filter
+from .filter_group import FilterGroup
+from .gcs_export_storage import GcsExportStorage
+from .gcs_export_storage_status import GcsExportStorageStatus
+from .gcs_import_storage import GcsImportStorage
+from .gcs_import_storage_status import GcsImportStorageStatus
+from .local_files_export_storage import LocalFilesExportStorage
+from .local_files_export_storage_status import LocalFilesExportStorageStatus
+from .local_files_import_storage import LocalFilesImportStorage
+from .local_files_import_storage_status import LocalFilesImportStorageStatus
+from .ml_backend import MlBackend
+from .ml_backend_auth_method import MlBackendAuthMethod
+from .ml_backend_state import MlBackendState
+from .prediction import Prediction
+from .project import Project
+from .project_import import ProjectImport
+from .project_import_status import ProjectImportStatus
+from .project_label_config import ProjectLabelConfig
+from .project_sampling import ProjectSampling
+from .project_skip_queue import ProjectSkipQueue
+from .redis_export_storage import RedisExportStorage
+from .redis_export_storage_status import RedisExportStorageStatus
+from .redis_import_storage import RedisImportStorage
+from .redis_import_storage_status import RedisImportStorageStatus
+from .s3export_storage import S3ExportStorage
+from .s3export_storage_status import S3ExportStorageStatus
+from .s3import_storage import S3ImportStorage
+from .s3import_storage_status import S3ImportStorageStatus
+from .serialization_option import SerializationOption
+from .serialization_options import SerializationOptions
+from .task import Task
+from .task_filter_options import TaskFilterOptions
+from .user_simple import UserSimple
+from .view import View
+from .webhook import Webhook
+from .webhook_actions_item import WebhookActionsItem
+from .webhook_serializer_for_update import WebhookSerializerForUpdate
+from .webhook_serializer_for_update_actions_item import WebhookSerializerForUpdateActionsItem
+
+__all__ = [
+    "Annotation",
+    "AnnotationFilterOptions",
+    "AnnotationLastAction",
+    "AzureBlobExportStorage",
+    "AzureBlobExportStorageStatus",
+    "AzureBlobImportStorage",
+    "AzureBlobImportStorageStatus",
+    "BaseTask",
+    "BaseUser",
+    "ConvertedFormat",
+    "ConvertedFormatStatus",
+    "Export",
+    "ExportConvert",
+    "ExportCreate",
+    "ExportCreateStatus",
+    "ExportStatus",
+    "FileUpload",
+    "Filter",
+    "FilterGroup",
+    "GcsExportStorage",
+    "GcsExportStorageStatus",
+    "GcsImportStorage",
+    "GcsImportStorageStatus",
+    "LocalFilesExportStorage",
+    "LocalFilesExportStorageStatus",
+    "LocalFilesImportStorage",
+    "LocalFilesImportStorageStatus",
+    "MlBackend",
+    "MlBackendAuthMethod",
+    "MlBackendState",
+    "Prediction",
+    "Project",
+    "ProjectImport",
+    "ProjectImportStatus",
+    "ProjectLabelConfig",
+    "ProjectSampling",
+    "ProjectSkipQueue",
+    "RedisExportStorage",
+    "RedisExportStorageStatus",
+    "RedisImportStorage",
+    "RedisImportStorageStatus",
+    "S3ExportStorage",
+    "S3ExportStorageStatus",
+    "S3ImportStorage",
+    "S3ImportStorageStatus",
+    "SerializationOption",
+    "SerializationOptions",
+    "Task",
+    "TaskFilterOptions",
+    "UserSimple",
+    "View",
+    "Webhook",
+    "WebhookActionsItem",
+    "WebhookSerializerForUpdate",
+    "WebhookSerializerForUpdateActionsItem",
+]

label_studio_sdk/types/annotation.py

@@ -0,0 +1,116 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .annotation_last_action import AnnotationLastAction
+
+
+class Annotation(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    created_username: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Username string
+    """
+
+    created_ago: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Time delta from creation time
+    """
+
+    completed_by: typing.Optional[int] = None
+    unique_id: typing.Optional[str] = None
+    result: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    The main value of annotator work - labeling result in JSON format
+    """
+
+    was_cancelled: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    User skipped the task
+    """
+
+    ground_truth: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    This annotation is a Ground Truth (ground_truth)
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last updated time
+    """
+
+    draft_created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Draft creation time
+    """
+
+    lead_time: typing.Optional[float] = pydantic_v1.Field(default=None)
+    """
+    How much time it took to annotate the task
+    """
+
+    import_id: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Original annotation ID that was at the import step or NULL if this annotation wasn't imported
+    """
+
+    last_action: typing.Optional[AnnotationLastAction] = pydantic_v1.Field(default=None)
+    """
+    Action which was performed in the last annotation history item
+    """
+
+    task: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Corresponding task for this annotation
+    """
+
+    project: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Project ID for this annotation
+    """
+
+    updated_by: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Last user who updated this annotation
+    """
+
+    parent_prediction: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Points to the prediction from which this annotation was created
+    """
+
+    parent_annotation: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Points to the parent annotation from which this annotation was created
+    """
+
+    last_created_by: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    User who created the last annotation history item
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/annotation_filter_options.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+
+
+class AnnotationFilterOptions(pydantic_v1.BaseModel):
+    usual: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Include not skipped and not ground truth annotations
+    """
+
+    ground_truth: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Include ground truth annotations
+    """
+
+    skipped: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Include skipped annotations
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/annotation_last_action.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+AnnotationLastAction = typing.Union[
+    typing.Literal[
+        "prediction",
+        "propagated_annotation",
+        "imported",
+        "submitted",
+        "updated",
+        "skipped",
+        "accepted",
+        "rejected",
+        "fixed_and_accepted",
+        "deleted_review",
+    ],
+    typing.Any,
+]

label_studio_sdk/types/azure_blob_export_storage.py

@@ -0,0 +1,112 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .azure_blob_export_storage_status import AzureBlobExportStorageStatus
+
+
+class AzureBlobExportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    container: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure blob container
+    """
+
+    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure blob prefix name
+    """
+
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage regex for filtering objects
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
+    account_name: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure Blob account name
+    """
+
+    account_key: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure Blob account key
+    """
+
+    last_sync: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last sync finished time
+    """
+
+    last_sync_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Count of tasks synced last time
+    """
+
+    last_sync_job: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Last sync job ID
+    """
+
+    status: typing.Optional[AzureBlobExportStorageStatus] = None
+    traceback: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Traceback report for the last failed sync
+    """
+
+    meta: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Meta and debug information about storage processes
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage description
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    can_delete_objects: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Deletion from storage enabled
+    """
+
+    project: int = pydantic_v1.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/azure_blob_export_storage_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+AzureBlobExportStorageStatus = typing.Union[
+    typing.Literal["initialized", "queued", "in_progress", "failed", "completed"], typing.Any
+]

label_studio_sdk/types/azure_blob_import_storage.py

@@ -0,0 +1,113 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .azure_blob_import_storage_status import AzureBlobImportStorageStatus
+
+
+class AzureBlobImportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    presign: typing.Optional[bool] = None
+    container: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure blob container
+    """
+
+    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure blob prefix name
+    """
+
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage regex for filtering objects
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
+    account_name: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure Blob account name
+    """
+
+    account_key: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure Blob account key
+    """
+
+    last_sync: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last sync finished time
+    """
+
+    last_sync_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Count of tasks synced last time
+    """
+
+    last_sync_job: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Last sync job ID
+    """
+
+    status: typing.Optional[AzureBlobImportStorageStatus] = None
+    traceback: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Traceback report for the last failed sync
+    """
+
+    meta: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Meta and debug information about storage processes
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage description
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    presign_ttl: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Presigned URLs TTL (in minutes)
+    """
+
+    project: int = pydantic_v1.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/azure_blob_import_storage_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+AzureBlobImportStorageStatus = typing.Union[
+    typing.Literal["initialized", "queued", "in_progress", "failed", "completed"], typing.Any
+]