label-studio-sdk 1.0.19__py3-none-any.whl → 2.0.0__py3-none-any.whl

label_studio_sdk/types/{access_token_response.py → batch_predictions.py}

@@ -1,16 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
 
 
-class AccessTokenResponse(UniversalBaseModel):
-    access: str = pydantic.Field()
-    """
-    New JWT access token
-    """
+class BatchPredictions(UncheckedBaseModel):
+    job_id: str
+    results: typing.List[typing.Optional[typing.Any]]
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/types/blank_enum.py

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

label_studio_sdk/types/{key_indicators_item_extra_kpis_item.py → blueprint_list.py}

@@ -1,22 +1,28 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
 import pydantic
+import datetime as dt
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class KeyIndicatorsItemExtraKpisItem(UniversalBaseModel):
-    key: typing.Optional[str] = pydantic.Field(default=None)
+class BlueprintList(UncheckedBaseModel):
+    id: int
+    share_id: str
+    short_url: str
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    The key for this KPI, where you can find the value from inside main_kpi
+    Blueprint name. Must be between 3 and 50 characters long.
     """
 
-    label: typing.Optional[str] = pydantic.Field(default=None)
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
-    The label for this KPI, to be displayed to the user
+    Project description
     """
 
+    created_at: dt.datetime
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

label_studio_sdk/types/budget_reset_period_enum.py

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

label_studio_sdk/types/child_filter.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ChildFilter(UncheckedBaseModel):
+    id: int
+    index: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Display order among root filters only
+    """
+
+    column: str = pydantic.Field()
+    """
+    Field name
+    """
+
+    type: str = pydantic.Field()
+    """
+    Field type
+    """
+
+    operator: str = pydantic.Field()
+    """
+    Filter operator
+    """
+
+    value: typing.Optional[typing.Optional[typing.Any]] = None
+    parent: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent)
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/comment.py

@@ -1,24 +1,49 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-from .comment_created_by import CommentCreatedBy
-import datetime as dt
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Comment(UniversalBaseModel):
+class Comment(UncheckedBaseModel):
     id: int
-    text: str
-    project: int
-    task: int
-    annotation: int
-    created_by: CommentCreatedBy
-    created_at: dt.datetime
-    updated_at: dt.datetime
-    is_resolved: typing.Optional[bool] = None
-    resolved_at: typing.Optional[dt.datetime] = None
+    region_ref: typing.Optional[typing.Optional[typing.Any]] = None
+    classifications: typing.Optional[typing.Optional[typing.Any]] = None
+    text: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Reviewer or annotator comment
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation time
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Last updated time
+    """
+
+    is_resolved: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    True if the comment is resolved
+    """
+
+    resolved_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Resolving time
+    """
+
+    project: typing.Optional[int] = None
+    task: typing.Optional[int] = None
+    draft: typing.Optional[int] = None
+    annotation: typing.Optional[int] = None
+    created_by: int = pydantic.Field()
+    """
+    User who made this comment
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/types/comment_request.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CommentRequest(UncheckedBaseModel):
+    region_ref: typing.Optional[typing.Optional[typing.Any]] = None
+    classifications: typing.Optional[typing.Optional[typing.Any]] = None
+    text: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Reviewer or annotator comment
+    """
+
+    is_resolved: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    True if the comment is resolved
+    """
+
+    draft: typing.Optional[int] = None
+    annotation: typing.Optional[int] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/comment_serializer_with_expanded_user.py

@@ -0,0 +1,53 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .lse_user import LseUser
+import typing
+import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class CommentSerializerWithExpandedUser(UncheckedBaseModel):
+    id: int
+    created_by: LseUser
+    region_ref: typing.Optional[typing.Optional[typing.Any]] = None
+    classifications: typing.Optional[typing.Optional[typing.Any]] = None
+    text: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Reviewer or annotator comment
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation time
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Last updated time
+    """
+
+    is_resolved: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    True if the comment is resolved
+    """
+
+    resolved_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Resolving time
+    """
+
+    project: typing.Optional[int] = None
+    task: typing.Optional[int] = None
+    draft: typing.Optional[int] = None
+    annotation: typing.Optional[int] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/converted_format.py

@@ -1,15 +1,15 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
-from .converted_format_status import ConvertedFormatStatus
+from .status7bf_enum import Status7BfEnum
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class ConvertedFormat(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    status: typing.Optional[ConvertedFormatStatus] = None
+class ConvertedFormat(UncheckedBaseModel):
+    id: int
+    status: typing.Optional[Status7BfEnum] = None
     export_type: str
     traceback: typing.Optional[str] = pydantic.Field(default=None)
     """

label_studio_sdk/types/{api_token_response.py → converted_format_request.py}

@@ -1,25 +1,18 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .status7bf_enum import Status7BfEnum
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
-import typing
-
-
-class ApiTokenResponse(UniversalBaseModel):
-    token: str = pydantic.Field()
-    """
-    JWT token
-    """
 
-    created_at: str = pydantic.Field()
-    """
-    Token creation timestamp
-    """
 
-    expires_at: str = pydantic.Field()
+class ConvertedFormatRequest(UncheckedBaseModel):
+    status: typing.Optional[Status7BfEnum] = None
+    export_type: str
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Token expiration timestamp
+    Traceback report in case of errors
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/custom_scripts_editable_by_enum.py

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

label_studio_sdk/types/default_role_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+DefaultRoleEnum = typing.Union[typing.Literal["OW", "AD", "MA", "RE", "AN", "DI", "NO"], typing.Any]

label_studio_sdk/types/edition_enum.py

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

label_studio_sdk/types/export.py

@@ -1,20 +1,20 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
 from .user_simple import UserSimple
 import datetime as dt
 import pydantic
-from .export_status import ExportStatus
+from .status7bf_enum import Status7BfEnum
 from .converted_format import ConvertedFormat
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Export(UniversalBaseModel):
+class Export(UncheckedBaseModel):
     title: typing.Optional[str] = None
-    id: typing.Optional[int] = None
+    id: int
     created_by: typing.Optional[UserSimple] = None
-    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
     Creation time
     """
@@ -24,9 +24,9 @@ class Export(UniversalBaseModel):
     Complete or fail time
     """
 
-    status: typing.Optional[ExportStatus] = None
+    status: typing.Optional[Status7BfEnum] = None
     md5: typing.Optional[str] = None
-    counters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    counters: typing.Optional[typing.Optional[typing.Any]] = None
     converted_formats: typing.Optional[typing.List[ConvertedFormat]] = None
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/file_upload.py

@@ -1,14 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing
+from ..core.unchecked_base_model import UncheckedBaseModel
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
 import pydantic
 
 
-class FileUpload(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    file: typing.Optional[str] = None
+class FileUpload(UncheckedBaseModel):
+    id: int
+    file: str
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/types/filter.py

@@ -1,16 +1,18 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
+from .child_filter import ChildFilter
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Filter(UniversalBaseModel):
-    id: typing.Optional[int] = None
+class Filter(UncheckedBaseModel):
+    id: int
+    child_filter: typing.Optional[ChildFilter] = None
     index: typing.Optional[int] = pydantic.Field(default=None)
     """
-    To keep filter order
+    Display order among root filters only
     """
 
     column: str = pydantic.Field()
@@ -28,9 +30,10 @@ class Filter(UniversalBaseModel):
     Filter operator
     """
 
-    value: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    value: typing.Optional[typing.Optional[typing.Any]] = None
+    parent: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Filter value
+    Optional parent filter to create one-level hierarchy (child filters are AND-merged with parent)
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/filter_group.py

@@ -1,14 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
 from .filter import Filter
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class FilterGroup(UniversalBaseModel):
-    id: typing.Optional[int] = None
+class FilterGroup(UncheckedBaseModel):
+    id: int
     filters: typing.List[Filter]
     conjunction: str = pydantic.Field()
     """

label_studio_sdk/types/finished_enum.py

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

label_studio_sdk/types/gcs_export_storage.py

@@ -1,16 +1,16 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
 import pydantic
 import datetime as dt
-from .gcs_export_storage_status import GcsExportStorageStatus
+from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class GcsExportStorage(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    type: typing.Optional[str] = None
+class GcsExportStorage(UncheckedBaseModel):
+    id: int
+    type: str
     synchronizable: typing.Optional[bool] = None
     bucket: typing.Optional[str] = pydantic.Field(default=None)
     """
@@ -57,17 +57,13 @@ class GcsExportStorage(UniversalBaseModel):
     Last sync job ID
     """
 
-    status: typing.Optional[GcsExportStorageStatus] = None
+    status: typing.Optional[StatusC5AEnum] = None
     traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
     Traceback report for the last failed sync
     """
 
-    meta: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    Meta and debug information about storage processes
-    """
-
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
     title: typing.Optional[str] = pydantic.Field(default=None)
     """
     Cloud storage title
@@ -78,7 +74,7 @@ class GcsExportStorage(UniversalBaseModel):
     Cloud storage description
     """
 
-    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
     Creation time
     """

label_studio_sdk/types/gcs_import_storage.py

@@ -1,16 +1,16 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
 import pydantic
 import datetime as dt
-from .gcs_import_storage_status import GcsImportStorageStatus
+from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class GcsImportStorage(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    type: typing.Optional[str] = None
+class GcsImportStorage(UncheckedBaseModel):
+    id: int
+    type: str
     synchronizable: typing.Optional[bool] = None
     presign: typing.Optional[bool] = None
     bucket: typing.Optional[str] = pydantic.Field(default=None)
@@ -58,17 +58,13 @@ class GcsImportStorage(UniversalBaseModel):
     Last sync job ID
     """
 
-    status: typing.Optional[GcsImportStorageStatus] = None
+    status: typing.Optional[StatusC5AEnum] = None
     traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
     Traceback report for the last failed sync
     """
 
-    meta: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    Meta and debug information about storage processes
-    """
-
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
     title: typing.Optional[str] = pydantic.Field(default=None)
     """
     Cloud storage title
@@ -79,7 +75,7 @@ class GcsImportStorage(UniversalBaseModel):
     Cloud storage description
     """
 
-    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
     Creation time
     """

label_studio_sdk/types/{rotate_token_response.py → hotkeys.py}

@@ -1,16 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
 
 
-class RotateTokenResponse(UniversalBaseModel):
-    refresh: str = pydantic.Field()
-    """
-    New JWT refresh token
-    """
+class Hotkeys(UncheckedBaseModel):
+    custom_hotkeys: typing.Dict[str, typing.Optional[typing.Any]]
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/types/{base_task.py → import_api_request.py}

@@ -1,41 +1,23 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
+from .annotation_request import AnnotationRequest
+from .prediction_request import PredictionRequest
 import pydantic
 import datetime as dt
-from .base_task_updated_by import BaseTaskUpdatedBy
-from .base_task_file_upload import BaseTaskFileUpload
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class BaseTask(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    data: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
+class ImportApiRequest(UncheckedBaseModel):
     """
-    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.Optional[typing.Any]]] = pydantic.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.Field(default=None)
-    """
-    Time a task was created
-    """
-
-    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
-    """
-    Last time a task was updated
-    """
-
-    is_labeled: typing.Optional[bool] = pydantic.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
+    Tasks serializer for Import API (TaskBulkCreateAPI)
     """
 
+    annotations: typing.Optional[typing.List[AnnotationRequest]] = None
+    predictions: typing.Optional[typing.List[PredictionRequest]] = None
+    data: typing.Optional[typing.Any] = None
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
     overlap: typing.Optional[int] = pydantic.Field(default=None)
     """
     Number of distinct annotators that processed the current task
@@ -76,17 +58,12 @@ class BaseTask(UniversalBaseModel):
     When the last comment was updated
     """
 
-    project: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Project ID for this task
-    """
-
-    updated_by: typing.Optional[BaseTaskUpdatedBy] = pydantic.Field(default=None)
+    updated_by: typing.Optional[int] = pydantic.Field(default=None)
     """
     Last annotator or reviewer who updated this task
     """
 
-    file_upload: typing.Optional[BaseTaskFileUpload] = pydantic.Field(default=None)
+    file_upload: typing.Optional[int] = pydantic.Field(default=None)
     """
     Uploaded file used as data source for this task
     """