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

label_studio_sdk/types/all_roles_project_list.py

@@ -0,0 +1,197 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+from .all_roles_project_list_sampling import AllRolesProjectListSampling
+from .user_simple import UserSimple
+import datetime as dt
+from .blueprint_list import BlueprintList
+from .assignment_settings import AssignmentSettings
+from .all_roles_project_list_skip_queue import AllRolesProjectListSkipQueue
+from .review_settings import ReviewSettings
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AllRolesProjectList(UncheckedBaseModel):
+    """
+    Serializer get numbers from project queryset annotation,
+    make sure, that you use correct one(Project.objects.with_counts())
+    """
+
+    workspace_title: str
+    ready: str
+    overlap_cohort_percentage: typing.Optional[int] = None
+    queue_left: str
+    config_suitable_for_bulk_annotation: bool = pydantic.Field()
+    """
+    Flag to detect is project ready for bulk annotation
+    """
+
+    has_blueprints: str
+    show_overlap_first: typing.Optional[bool] = None
+    queue_total: str
+    enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow annotators to submit empty annotations
+    """
+
+    custom_task_lock_ttl: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    TTL in seconds for task reservations, on new and existing tasks
+    """
+
+    prompts: str
+    start_training_on_annotation_update: bool = pydantic.Field()
+    """
+    Start model training after any annotations are submitted or updated
+    """
+
+    evaluate_predictions_automatically: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Retrieve and display predictions when loading a task
+    """
+
+    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show instructions to the annotator before they start
+    """
+
+    color: typing.Optional[str] = None
+    sampling: typing.Optional[AllRolesProjectListSampling] = None
+    created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
+    """
+    Project owner
+    """
+
+    reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Reveal pre-annotations interactively
+    """
+
+    pinned_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Pinned date and time
+    """
+
+    finished_task_number: int
+    parsed_label_config: typing.Optional[typing.Any] = None
+    duplication_done: typing.Optional[bool] = None
+    reviewer_queue_total: str
+    show_ground_truth_first: typing.Optional[bool] = None
+    task_number: int = pydantic.Field()
+    """
+    Total task number in project
+    """
+
+    num_tasks_with_annotations: str
+    description_short: str
+    id: int
+    allow_stream: str
+    annotation_limit_percent: typing.Optional[str] = None
+    created_at: dt.datetime
+    annotation_limit_count: typing.Optional[int] = None
+    queue_done: str
+    control_weights: typing.Optional[typing.Optional[typing.Any]] = None
+    data_types: typing.Optional[typing.Any] = None
+    reviewed_number: str
+    total_annotations_number: str
+    total_predictions_number: int
+    config_has_control_tags: bool = pydantic.Field()
+    """
+    Flag to detect is project ready for labeling
+    """
+
+    blueprints: typing.List[BlueprintList]
+    is_published: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether or not the project is published to annotators
+    """
+
+    duplication_status: typing.Optional[str] = None
+    review_total_tasks: str
+    show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show a skip button in interface and allow annotators to skip the task
+    """
+
+    is_draft: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether or not the project is in the middle of being created
+    """
+
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Project name. Must be between 3 and 50 characters long.
+    """
+
+    show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If set, the annotator can view model predictions
+    """
+
+    members: str
+    min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Minimum number of completed tasks after which model training is started
+    """
+
+    workspace: str
+    organization: typing.Optional[int] = None
+    assignment_settings: AssignmentSettings
+    annotator_evaluation_minimum_tasks: typing.Optional[int] = None
+    skipped_annotations_number: str
+    annotator_evaluation_minimum_score: typing.Optional[str] = None
+    comment_classification_config: typing.Optional[str] = None
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Project description
+    """
+
+    expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Labeling instructions in HTML format
+    """
+
+    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show annotation history to annotator
+    """
+
+    skip_queue: typing.Optional[AllRolesProjectListSkipQueue] = None
+    review_settings: ReviewSettings
+    members_count: str
+    model_version: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Machine learning model version
+    """
+
+    useful_annotation_number: str
+    custom_script: typing.Optional[str] = None
+    require_comment_on_skip: typing.Optional[bool] = None
+    ground_truth_number: int = pydantic.Field()
+    """
+    Honeypot annotation number in project
+    """
+
+    pause_on_failed_annotator_evaluation: typing.Optional[bool] = None
+    label_config: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Label config in XML format. See more about it in documentation
+    """
+
+    maximum_annotations: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Maximum number of annotations for one task. If the number of annotations per task is equal or greater to this value, the task is completed (is_labeled=True)
+    """
+
+    rejected: str
+
+    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/all_roles_project_list_sampling.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .sampling_enum import SamplingEnum
+from .null_enum import NullEnum
+
+AllRolesProjectListSampling = typing.Union[SamplingEnum, NullEnum]

label_studio_sdk/types/all_roles_project_list_skip_queue.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .skip_queue_enum import SkipQueueEnum
+from .null_enum import NullEnum
+
+AllRolesProjectListSkipQueue = typing.Union[SkipQueueEnum, NullEnum]

label_studio_sdk/types/annotated_enum.py

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

label_studio_sdk/types/annotation.py

@@ -1,33 +1,31 @@
 # 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
-from .annotation_completed_by import AnnotationCompletedBy
 import datetime as dt
 from .annotation_last_action import AnnotationLastAction
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Annotation(UniversalBaseModel):
-    id: typing.Optional[int] = None
+class Annotation(UncheckedBaseModel):
+    id: int
     result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
     """
     List of annotation results for the task
     """
 
-    created_username: typing.Optional[str] = pydantic.Field(default=None)
+    created_username: str = pydantic.Field()
     """
     Username string
     """
 
-    created_ago: typing.Optional[str] = pydantic.Field(default=None)
+    created_ago: str = pydantic.Field()
     """
     Time delta from creation time
     """
 
-    completed_by: typing.Optional[AnnotationCompletedBy] = None
-    unique_id: typing.Optional[str] = None
+    completed_by: typing.Optional[int] = None
     was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
     """
     User skipped the task
@@ -38,12 +36,12 @@ class Annotation(UniversalBaseModel):
     This annotation is a Ground Truth (ground_truth)
     """
 
-    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
     Creation time
     """
 
-    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    updated_at: dt.datetime = pydantic.Field()
     """
     Last updated time
     """
@@ -66,6 +64,22 @@ class Annotation(UniversalBaseModel):
     last_action: typing.Optional[AnnotationLastAction] = pydantic.Field(default=None)
     """
     Action which was performed in the last annotation history item
+    
+    * `prediction` - Created from prediction
+    * `propagated_annotation` - Created from another annotation
+    * `imported` - Imported
+    * `submitted` - Submitted
+    * `updated` - Updated
+    * `skipped` - Skipped
+    * `accepted` - Accepted
+    * `rejected` - Rejected
+    * `fixed_and_accepted` - Fixed and accepted
+    * `deleted_review` - Deleted review
+    """
+
+    bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Annotation was created in bulk mode
     """
 
     task: typing.Optional[int] = pydantic.Field(default=None)

label_studio_sdk/types/annotation_last_action.py

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

label_studio_sdk/types/{annotations_dm_field.py → annotation_request.py}

@@ -1,35 +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
 import pydantic
 import datetime as dt
-from .annotations_dm_field_last_action import AnnotationsDmFieldLastAction
+from .annotation_request_last_action import AnnotationRequestLastAction
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class AnnotationsDmField(UniversalBaseModel):
-    id: typing.Optional[int] = None
+class AnnotationRequest(UncheckedBaseModel):
     result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
     """
     List of annotation results for the task
     """
 
-    created_username: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Username string
-    """
-
-    created_ago: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Time delta from creation time
-    """
-
-    completed_by: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    User details who completed this annotation.
-    """
-
+    completed_by: typing.Optional[int] = None
     unique_id: typing.Optional[str] = None
     was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
     """
@@ -41,16 +26,6 @@ class AnnotationsDmField(UniversalBaseModel):
     This annotation is a Ground Truth (ground_truth)
     """
 
-    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
-    """
-    Creation time
-    """
-
-    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
-    """
-    Last updated time
-    """
-
     draft_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
     Draft creation time
@@ -66,9 +41,25 @@ class AnnotationsDmField(UniversalBaseModel):
     Original annotation ID that was at the import step or NULL if this annotation wasn't imported
     """
 
-    last_action: typing.Optional[AnnotationsDmFieldLastAction] = pydantic.Field(default=None)
+    last_action: typing.Optional[AnnotationRequestLastAction] = pydantic.Field(default=None)
     """
     Action which was performed in the last annotation history item
+    
+    * `prediction` - Created from prediction
+    * `propagated_annotation` - Created from another annotation
+    * `imported` - Imported
+    * `submitted` - Submitted
+    * `updated` - Updated
+    * `skipped` - Skipped
+    * `accepted` - Accepted
+    * `rejected` - Rejected
+    * `fixed_and_accepted` - Fixed and accepted
+    * `deleted_review` - Deleted review
+    """
+
+    bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Annotation was created in bulk mode
     """
 
     task: typing.Optional[int] = pydantic.Field(default=None)

label_studio_sdk/types/annotation_request_last_action.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .last_action_enum import LastActionEnum
+from .null_enum import NullEnum
+
+AnnotationRequestLastAction = typing.Union[LastActionEnum, NullEnum]

label_studio_sdk/types/assignment_settings.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .assignment_settings_label_stream_task_distribution import AssignmentSettingsLabelStreamTaskDistribution
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AssignmentSettings(UncheckedBaseModel):
+    id: int
+    label_stream_task_distribution: typing.Optional[AssignmentSettingsLabelStreamTaskDistribution] = pydantic.Field(
+        default=None
+    )
+    """
+    Modes for distributing tasks to annotators
+    
+    * `auto_distribution` - Label Stream distributes tasks automatically to annotators
+    * `assigned_only` - Label Stream shows tasks only to assigned users
+    """
+
+    project: 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/assignment_settings_label_stream_task_distribution.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .label_stream_task_distribution_enum import LabelStreamTaskDistributionEnum
+from .null_enum import NullEnum
+
+AssignmentSettingsLabelStreamTaskDistribution = typing.Union[LabelStreamTaskDistributionEnum, NullEnum]

label_studio_sdk/types/assignment_settings_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
+from .assignment_settings_request_label_stream_task_distribution import (
+    AssignmentSettingsRequestLabelStreamTaskDistribution,
+)
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class AssignmentSettingsRequest(UncheckedBaseModel):
+    label_stream_task_distribution: typing.Optional[AssignmentSettingsRequestLabelStreamTaskDistribution] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Modes for distributing tasks to annotators
+    
+    * `auto_distribution` - Label Stream distributes tasks automatically to annotators
+    * `assigned_only` - Label Stream shows tasks only to assigned users
+    """
+
+    project: 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/assignment_settings_request_label_stream_task_distribution.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .label_stream_task_distribution_enum import LabelStreamTaskDistributionEnum
+from .null_enum import NullEnum
+
+AssignmentSettingsRequestLabelStreamTaskDistribution = typing.Union[LabelStreamTaskDistributionEnum, NullEnum]

label_studio_sdk/types/{key_indicators_item_additional_kpis_item.py → associated_project.py}

@@ -1,20 +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
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class KeyIndicatorsItemAdditionalKpisItem(UniversalBaseModel):
-    key: typing.Optional[str] = pydantic.Field(default=None)
+class AssociatedProject(UncheckedBaseModel):
     """
-    The key for this KPI, where you can find the value from inside main_kpi
+    A ModelSerializer that takes additional arguments for
+    "fields", "omit" and "expand" in order to
+    control which fields are displayed, and whether to replace simple
+    values with complex, nested serializations
     """
 
-    label: typing.Optional[str] = pydantic.Field(default=None)
+    id: int
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    The label for this KPI, to be displayed to the user
+    Project name. Must be between 3 and 50 characters long.
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/auth_method_enum.py

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

label_studio_sdk/types/azure_blob_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 .azure_blob_export_storage_status import AzureBlobExportStorageStatus
+from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class AzureBlobExportStorage(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    type: typing.Optional[str] = None
+class AzureBlobExportStorage(UncheckedBaseModel):
+    id: int
+    type: str
     synchronizable: typing.Optional[bool] = None
     container: typing.Optional[str] = pydantic.Field(default=None)
     """
@@ -57,17 +57,13 @@ class AzureBlobExportStorage(UniversalBaseModel):
     Last sync job ID
     """
 
-    status: typing.Optional[AzureBlobExportStorageStatus] = 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 AzureBlobExportStorage(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/azure_blob_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 .azure_blob_import_storage_status import AzureBlobImportStorageStatus
+from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class AzureBlobImportStorage(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    type: typing.Optional[str] = None
+class AzureBlobImportStorage(UncheckedBaseModel):
+    id: int
+    type: str
     synchronizable: typing.Optional[bool] = None
     presign: typing.Optional[bool] = None
     container: typing.Optional[str] = pydantic.Field(default=None)
@@ -58,17 +58,13 @@ class AzureBlobImportStorage(UniversalBaseModel):
     Last sync job ID
     """
 
-    status: typing.Optional[AzureBlobImportStorageStatus] = 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 AzureBlobImportStorage(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/{prompt_associated_projects_item_id.py → batch_failed_predictions.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 ..core.pydantic_utilities import IS_PYDANTIC_V2
 import pydantic
 
 
-class PromptAssociatedProjectsItemId(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    title: typing.Optional[str] = None
+class BatchFailedPredictions(UncheckedBaseModel):
+    job_id: str
+    failed_predictions: 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