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

label_studio_sdk/types/s3export_storage.py

@@ -0,0 +1,134 @@
+# 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 .s3export_storage_status import S3ExportStorageStatus
+
+
+class S3ExportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    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[S3ExportStorageStatus] = 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
+    """
+
+    bucket: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 bucket name
+    """
+
+    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 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
+    """
+
+    aws_access_key_id: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS_ACCESS_KEY_ID
+    """
+
+    aws_secret_access_key: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS_SECRET_ACCESS_KEY
+    """
+
+    aws_session_token: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS_SESSION_TOKEN
+    """
+
+    aws_sse_kms_key_id: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS SSE KMS Key ID
+    """
+
+    region_name: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS Region
+    """
+
+    s3endpoint: typing.Optional[str] = pydantic_v1.Field(alias="s3_endpoint", default=None)
+    """
+    S3 Endpoint
+    """
+
+    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
+        allow_population_by_field_name = True
+        populate_by_name = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/s3export_storage_status.py

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

label_studio_sdk/types/s3import_storage.py

@@ -0,0 +1,140 @@
+# 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 .s3import_storage_status import S3ImportStorageStatus
+
+
+class S3ImportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    presign: typing.Optional[bool] = None
+    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[S3ImportStorageStatus] = 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
+    """
+
+    bucket: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 bucket name
+    """
+
+    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 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
+    """
+
+    aws_access_key_id: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS_ACCESS_KEY_ID
+    """
+
+    aws_secret_access_key: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS_SECRET_ACCESS_KEY
+    """
+
+    aws_session_token: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS_SESSION_TOKEN
+    """
+
+    aws_sse_kms_key_id: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS SSE KMS Key ID
+    """
+
+    region_name: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS Region
+    """
+
+    s3endpoint: typing.Optional[str] = pydantic_v1.Field(alias="s3_endpoint", default=None)
+    """
+    S3 Endpoint
+    """
+
+    presign_ttl: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Presigned URLs TTL (in minutes)
+    """
+
+    recursive_scan: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Perform recursive scan over the bucket content
+    """
+
+    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
+        allow_population_by_field_name = True
+        populate_by_name = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/s3import_storage_status.py

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

label_studio_sdk/types/serialization_option.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
+
+
+class SerializationOption(pydantic_v1.BaseModel):
+    """
+    JSON dict with parameters
+    """
+
+    only_id: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Include a full json body or IDs only
+    """
+
+    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/serialization_options.py

@@ -0,0 +1,45 @@
+# 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 .serialization_option import SerializationOption
+
+
+class SerializationOptions(pydantic_v1.BaseModel):
+    drafts: typing.Optional[SerializationOption] = None
+    predictions: typing.Optional[SerializationOption] = None
+    include_annotation_history: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Include annotation history
+    """
+
+    annotations_completed_by: typing.Optional[SerializationOption] = pydantic_v1.Field(
+        alias="annotations__completed_by", default=None
+    )
+    interpolate_key_frames: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Interpolate video key frames
+    """
+
+    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
+        allow_population_by_field_name = True
+        populate_by_name = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}

label_studio_sdk/types/task.py

@@ -0,0 +1,157 @@
+# 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 Task(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Unique ID of the task
+    """
+
+    predictions: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = pydantic_v1.Field(default=None)
+    """
+    Predictions for this task
+    """
+
+    annotations: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = pydantic_v1.Field(default=None)
+    """
+    Annotations for this task
+    """
+
+    drafts: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = pydantic_v1.Field(default=None)
+    """
+    Drafts for this task
+    """
+
+    annotators: typing.Optional[typing.List[int]] = pydantic_v1.Field(default=None)
+    """
+    List of annotators' IDs for this task
+    """
+
+    inner_id: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Inner ID of the task
+    """
+
+    cancelled_annotations: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of cancelled annotations for this task
+    """
+
+    total_annotations: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Total number of annotations for this task
+    """
+
+    total_predictions: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Total number of predictions for this task
+    """
+
+    completed_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Completion time of the task
+    """
+
+    file_upload: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    File upload ID for this task
+    """
+
+    storage_filename: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Storage filename for this task
+    """
+
+    avg_lead_time: typing.Optional[float] = pydantic_v1.Field(default=None)
+    """
+    Average lead time for this task
+    """
+
+    draft_exists: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Whether a draft exists for this task or not
+    """
+
+    updated_by: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = pydantic_v1.Field(default=None)
+    """
+    List of annotators' info who updated this task
+    """
+
+    data: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Data of the task
+    """
+
+    meta: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Meta information of the task
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time of the task
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last updated time of the task
+    """
+
+    is_labeled: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Whether the task is labeled or not
+    """
+
+    overlap: typing.Optional[float] = pydantic_v1.Field(default=None)
+    """
+    Overlap for the task
+    """
+
+    comment_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of comments for this task
+    """
+
+    unresolved_comment_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of unresolved comments for this task
+    """
+
+    last_comment_updated_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last updated time of the comments for this task
+    """
+
+    project: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Project ID for this task
+    """
+
+    comment_authors: typing.Optional[typing.List[int]] = pydantic_v1.Field(default=None)
+    """
+    List of comment authors' IDs for this task
+    """
+
+    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/task_filter_options.py

@@ -0,0 +1,49 @@
+# 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 TaskFilterOptions(pydantic_v1.BaseModel):
+    view: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Apply filters from the view ID (a tab from the Data Manager)
+    """
+
+    skipped: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    `only` - include all tasks with skipped annotations<br>`exclude` - exclude all tasks with skipped annotations
+    """
+
+    finished: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    `only` - include all finished tasks (is_labeled = true)<br>`exclude` - exclude all finished tasks
+    """
+
+    annotated: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    `only` - include all tasks with at least one not skipped annotation<br>`exclude` - exclude all tasks with at least one not skipped annotation
+    """
+
+    only_with_annotations: typing.Optional[bool] = 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/user_simple.py

@@ -0,0 +1,37 @@
+# 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 UserSimple(pydantic_v1.BaseModel):
+    """
+    Project owner
+    """
+
+    id: typing.Optional[int] = None
+    first_name: typing.Optional[str] = None
+    last_name: typing.Optional[str] = None
+    email: typing.Optional[str] = None
+    avatar: 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/view.py

@@ -0,0 +1,55 @@
+# 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_group import FilterGroup
+
+
+class View(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    filter_group: typing.Optional[FilterGroup] = None
+    data: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Custom view data
+    """
+
+    ordering: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Ordering parameters
+    """
+
+    selected_items: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Selected items
+    """
+
+    user: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    User who made this view
+    """
+
+    project: int = pydantic_v1.Field()
+    """
+    Project ID
+    """
+
+    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}