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

label_studio_sdk/types/gcs_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 .gcs_import_storage_status import GcsImportStorageStatus
+
+
+class GcsImportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    presign: 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[GcsImportStorageStatus] = 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/gcs_import_storage_status.py

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

label_studio_sdk/types/local_files_export_storage.py

@@ -0,0 +1,97 @@
+# 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 .local_files_export_storage_status import LocalFilesExportStorageStatus
+
+
+class LocalFilesExportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    path: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Local path
+    """
+
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Regex for filtering objects
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
+    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[LocalFilesExportStorageStatus] = 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/local_files_export_storage_status.py

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

label_studio_sdk/types/local_files_import_storage.py

@@ -0,0 +1,92 @@
+# 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 .local_files_import_storage_status import LocalFilesImportStorageStatus
+
+
+class LocalFilesImportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    type: typing.Optional[str] = None
+    synchronizable: typing.Optional[bool] = None
+    path: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Local path
+    """
+
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Regex for filtering objects
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
+    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[LocalFilesImportStorageStatus] = 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
+    """
+
+    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/local_files_import_storage_status.py

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

label_studio_sdk/types/ml_backend.py

@@ -0,0 +1,89 @@
+# 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 .ml_backend_auth_method import MlBackendAuthMethod
+from .ml_backend_state import MlBackendState
+
+
+class MlBackend(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    state: typing.Optional[MlBackendState] = None
+    readable_state: typing.Optional[str] = None
+    is_interactive: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    Used to interactively annotate tasks. If true, model returns one list with results
+    """
+
+    url: str = pydantic_v1.Field()
+    """
+    URL for the machine learning model server
+    """
+
+    error_message: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Error message in error state
+    """
+
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Name of the machine learning backend
+    """
+
+    auth_method: typing.Optional[MlBackendAuthMethod] = None
+    basic_auth_user: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    HTTP Basic Auth user
+    """
+
+    basic_auth_pass: typing.Optional[str] = None
+    basic_auth_pass_is_set: typing.Optional[str] = None
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Description for the machine learning backend
+    """
+
+    extra_params: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Any extra parameters passed to the ML Backend during the setup
+    """
+
+    model_version: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Current model version associated with this machine learning backend
+    """
+
+    timeout: typing.Optional[float] = pydantic_v1.Field(default=None)
+    """
+    Response model timeout
+    """
+
+    created_at: typing.Optional[dt.datetime] = None
+    updated_at: typing.Optional[dt.datetime] = None
+    auto_update: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    If false, model version is set by the user, if true - getting latest version from backend.
+    """
+
+    project: int
+
+    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/ml_backend_auth_method.py

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

label_studio_sdk/types/ml_backend_state.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+MlBackendState = typing.Union[typing.Literal["CO", "DI", "ER", "TR", "PR"], typing.Any]

label_studio_sdk/types/prediction.py

@@ -0,0 +1,78 @@
+# 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 Prediction(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    result: typing.List[typing.Dict[str, typing.Any]] = pydantic_v1.Field()
+    """
+    List of prediction results for the task
+    """
+
+    model_version: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
+    """
+
+    created_ago: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Delta time from creation time
+    """
+
+    score: typing.Optional[float] = pydantic_v1.Field(default=None)
+    """
+    Prediction score
+    """
+
+    cluster: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Cluster for the current prediction
+    """
+
+    neighbors: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Array of task IDs of the closest neighbors
+    """
+
+    mislabeling: typing.Optional[float] = pydantic_v1.Field(default=None)
+    """
+    Related task mislabeling score
+    """
+
+    created_at: typing.Optional[dt.datetime] = None
+    updated_at: typing.Optional[dt.datetime] = None
+    model: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    An ML Backend instance that created the prediction.
+    """
+
+    model_run: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    A run of a ModelVersion that created the prediction.
+    """
+
+    task: int
+    project: typing.Optional[int] = 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}