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

label_studio_sdk/types/base_task.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
+
+
+class BaseTask(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    data: typing.Dict[str, typing.Any] = pydantic_v1.Field()
+    """
+    User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
+    """
+
+    meta: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Time a task was created
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last time a task was updated
+    """
+
+    is_labeled: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
+    """
+
+    overlap: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of distinct annotators that processed the current task
+    """
+
+    inner_id: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Internal task ID in the project, starts with 1
+    """
+
+    total_annotations: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of total annotations for the current task except cancelled annotations
+    """
+
+    cancelled_annotations: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of total cancelled annotations for the current task
+    """
+
+    total_predictions: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of total predictions for the current task
+    """
+
+    comment_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of comments in the task including all annotations
+    """
+
+    unresolved_comment_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of unresolved comments in the task including all annotations
+    """
+
+    last_comment_updated_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    When the last comment was updated
+    """
+
+    project: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Project ID for this task
+    """
+
+    updated_by: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Last annotator or reviewer who updated this task
+    """
+
+    file_upload: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Uploaded file used as data source for this task
+    """
+
+    comment_authors: typing.Optional[typing.List[int]] = pydantic_v1.Field(default=None)
+    """
+    Users who wrote comments
+    """
+
+    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/base_user.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 BaseUser(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    first_name: typing.Optional[str] = None
+    last_name: typing.Optional[str] = None
+    username: str
+    email: typing.Optional[str] = None
+    last_activity: typing.Optional[dt.datetime] = None
+    avatar: typing.Optional[str] = None
+    initials: typing.Optional[str] = None
+    phone: typing.Optional[str] = None
+    active_organization: typing.Optional[int] = None
+    allow_newsletters: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Allow sending newsletters to user
+    """
+
+    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/converted_format.py

@@ -0,0 +1,36 @@
+# 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 .converted_format_status import ConvertedFormatStatus
+
+
+class ConvertedFormat(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    status: typing.Optional[ConvertedFormatStatus] = None
+    export_type: str
+    traceback: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Traceback report in case of errors
+    """
+
+    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/converted_format_status.py

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

label_studio_sdk/types/export.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 .converted_format import ConvertedFormat
+from .export_status import ExportStatus
+from .user_simple import UserSimple
+
+
+class Export(pydantic_v1.BaseModel):
+    title: typing.Optional[str] = None
+    id: typing.Optional[int] = None
+    created_by: typing.Optional[UserSimple] = None
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    finished_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Complete or fail time
+    """
+
+    status: typing.Optional[ExportStatus] = None
+    md5: typing.Optional[str] = None
+    counters: typing.Optional[typing.Dict[str, typing.Any]] = None
+    converted_formats: typing.Optional[typing.List[ConvertedFormat]] = None
+
+    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/export_convert.py

@@ -0,0 +1,32 @@
+# 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 ExportConvert(pydantic_v1.BaseModel):
+    export_type: str = pydantic_v1.Field()
+    """
+    Export file format.
+    """
+
+    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/export_create.py

@@ -0,0 +1,54 @@
+# 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_filter_options import AnnotationFilterOptions
+from .converted_format import ConvertedFormat
+from .export_create_status import ExportCreateStatus
+from .serialization_options import SerializationOptions
+from .task_filter_options import TaskFilterOptions
+from .user_simple import UserSimple
+
+
+class ExportCreate(pydantic_v1.BaseModel):
+    title: typing.Optional[str] = None
+    id: typing.Optional[int] = None
+    created_by: typing.Optional[UserSimple] = None
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    finished_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Complete or fail time
+    """
+
+    status: typing.Optional[ExportCreateStatus] = None
+    md5: typing.Optional[str] = None
+    counters: typing.Optional[typing.Dict[str, typing.Any]] = None
+    converted_formats: typing.Optional[typing.List[ConvertedFormat]] = None
+    task_filter_options: typing.Optional[TaskFilterOptions] = None
+    annotation_filter_options: typing.Optional[AnnotationFilterOptions] = None
+    serialization_options: typing.Optional[SerializationOptions] = None
+
+    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/export_create_status.py

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

label_studio_sdk/types/export_status.py

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

label_studio_sdk/types/file_upload.py

@@ -0,0 +1,30 @@
+# 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 FileUpload(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    file: typing.Optional[str] = None
+
+    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/filter.py

@@ -0,0 +1,53 @@
+# 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 Filter(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    index: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    To keep filter order
+    """
+
+    column: str = pydantic_v1.Field()
+    """
+    Field name
+    """
+
+    type: str = pydantic_v1.Field()
+    """
+    Field type
+    """
+
+    operator: str = pydantic_v1.Field()
+    """
+    Filter operator
+    """
+
+    value: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Filter value
+    """
+
+    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/filter_group.py

@@ -0,0 +1,35 @@
+# 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 .filter import Filter
+
+
+class FilterGroup(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    filters: typing.List[Filter]
+    conjunction: str = pydantic_v1.Field()
+    """
+    Type of conjunction
+    """
+
+    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/gcs_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 .gcs_export_storage_status import GcsExportStorageStatus
+
+
+class GcsExportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    bucket: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    GCS bucket name
+    """
+
+    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    GCS bucket prefix
+    """
+
+    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
+    """
+
+    google_application_credentials: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    The content of GOOGLE_APPLICATION_CREDENTIALS json file
+    """
+
+    google_project_id: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Google project ID
+    """
+
+    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[GcsExportStorageStatus] = 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/gcs_export_storage_status.py

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