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

label_studio_sdk/types/lse_project_create.py

@@ -0,0 +1,196 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+from .user_simple import UserSimple
+import datetime as dt
+from .lse_project_create_sampling import LseProjectCreateSampling
+from .lse_project_create_skip_queue import LseProjectCreateSkipQueue
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class LseProjectCreate(UncheckedBaseModel):
+    """
+    Serializer get numbers from project queryset annotation,
+    make sure, that you use correct one(Project.objects.with_counts())
+    """
+
+    id: int
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Project name. Must be between 3 and 50 characters long.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Project description
+    """
+
+    label_config: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Label config in XML format. See more about it in documentation
+    """
+
+    expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Labeling instructions in HTML format
+    """
+
+    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show instructions to the annotator before they start
+    """
+
+    show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show a skip button in interface and allow annotators to skip the task
+    """
+
+    enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow annotators to submit empty annotations
+    """
+
+    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show annotation history to annotator
+    """
+
+    organization: typing.Optional[int] = None
+    color: typing.Optional[str] = None
+    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)
+    """
+
+    is_published: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether or not the project is published to annotators
+    """
+
+    model_version: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Machine learning model version
+    """
+
+    is_draft: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether or not the project is in the middle of being created
+    """
+
+    created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
+    """
+    Project owner
+    """
+
+    created_at: dt.datetime
+    min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Minimum number of completed tasks after which model training is started
+    """
+
+    start_training_on_annotation_update: bool = pydantic.Field()
+    """
+    Start model training after any annotations are submitted or updated
+    """
+
+    show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If set, the annotator can view model predictions
+    """
+
+    num_tasks_with_annotations: int = pydantic.Field()
+    """
+    Tasks with annotations count
+    """
+
+    task_number: int = pydantic.Field()
+    """
+    Total task number in project
+    """
+
+    useful_annotation_number: int = pydantic.Field()
+    """
+    Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
+    """
+
+    ground_truth_number: int = pydantic.Field()
+    """
+    Honeypot annotation number in project
+    """
+
+    skipped_annotations_number: int = pydantic.Field()
+    """
+    Skipped by collaborators annotation number in project
+    """
+
+    total_annotations_number: int = pydantic.Field()
+    """
+    Total annotations number in project including skipped_annotations_number and ground_truth_number.
+    """
+
+    total_predictions_number: int = pydantic.Field()
+    """
+    Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
+    """
+
+    sampling: typing.Optional[LseProjectCreateSampling] = None
+    show_ground_truth_first: typing.Optional[bool] = None
+    show_overlap_first: typing.Optional[bool] = None
+    overlap_cohort_percentage: typing.Optional[int] = None
+    task_data_login: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Task data credentials: login
+    """
+
+    task_data_password: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Task data credentials: password
+    """
+
+    control_weights: typing.Optional[typing.Optional[typing.Any]] = None
+    parsed_label_config: typing.Optional[typing.Any] = None
+    evaluate_predictions_automatically: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Retrieve and display predictions when loading a task
+    """
+
+    config_has_control_tags: bool = pydantic.Field()
+    """
+    Flag to detect is project ready for labeling
+    """
+
+    skip_queue: typing.Optional[LseProjectCreateSkipQueue] = None
+    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 = pydantic.Field()
+    """
+    Finished tasks
+    """
+
+    queue_total: int
+    queue_done: int
+    config_suitable_for_bulk_annotation: bool = pydantic.Field()
+    """
+    Flag to detect is project ready for bulk annotation
+    """
+
+    workspace: 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/lse_project_create_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
+
+LseProjectCreateSampling = typing.Union[SamplingEnum, NullEnum]

label_studio_sdk/types/lse_project_create_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
+
+LseProjectCreateSkipQueue = typing.Union[SkipQueueEnum, NullEnum]

label_studio_sdk/types/lse_project_update.py

@@ -0,0 +1,215 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+from .user_simple import UserSimple
+import datetime as dt
+from .lse_project_update_sampling import LseProjectUpdateSampling
+from .lse_project_update_skip_queue import LseProjectUpdateSkipQueue
+from .review_settings import ReviewSettings
+from .assignment_settings import AssignmentSettings
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class LseProjectUpdate(UncheckedBaseModel):
+    """
+    Serializer get numbers from project queryset annotation,
+    make sure, that you use correct one(Project.objects.with_counts())
+    """
+
+    id: int
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Project name. Must be between 3 and 50 characters long.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Project description
+    """
+
+    label_config: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Label config in XML format. See more about it in documentation
+    """
+
+    expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Labeling instructions in HTML format
+    """
+
+    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show instructions to the annotator before they start
+    """
+
+    show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show a skip button in interface and allow annotators to skip the task
+    """
+
+    enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow annotators to submit empty annotations
+    """
+
+    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show annotation history to annotator
+    """
+
+    organization: typing.Optional[int] = None
+    color: typing.Optional[str] = None
+    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)
+    """
+
+    is_published: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether or not the project is published to annotators
+    """
+
+    model_version: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Machine learning model version
+    """
+
+    is_draft: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether or not the project is in the middle of being created
+    """
+
+    created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
+    """
+    Project owner
+    """
+
+    created_at: dt.datetime
+    min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Minimum number of completed tasks after which model training is started
+    """
+
+    start_training_on_annotation_update: bool = pydantic.Field()
+    """
+    Start model training after any annotations are submitted or updated
+    """
+
+    show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If set, the annotator can view model predictions
+    """
+
+    num_tasks_with_annotations: int = pydantic.Field()
+    """
+    Tasks with annotations count
+    """
+
+    task_number: int = pydantic.Field()
+    """
+    Total task number in project
+    """
+
+    useful_annotation_number: int = pydantic.Field()
+    """
+    Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
+    """
+
+    ground_truth_number: int = pydantic.Field()
+    """
+    Honeypot annotation number in project
+    """
+
+    skipped_annotations_number: int = pydantic.Field()
+    """
+    Skipped by collaborators annotation number in project
+    """
+
+    total_annotations_number: int = pydantic.Field()
+    """
+    Total annotations number in project including skipped_annotations_number and ground_truth_number.
+    """
+
+    total_predictions_number: int = pydantic.Field()
+    """
+    Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
+    """
+
+    sampling: typing.Optional[LseProjectUpdateSampling] = None
+    show_ground_truth_first: typing.Optional[bool] = None
+    show_overlap_first: typing.Optional[bool] = None
+    overlap_cohort_percentage: typing.Optional[int] = None
+    task_data_login: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Task data credentials: login
+    """
+
+    task_data_password: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Task data credentials: password
+    """
+
+    control_weights: typing.Optional[typing.Optional[typing.Any]] = None
+    parsed_label_config: typing.Optional[typing.Any] = None
+    evaluate_predictions_automatically: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Retrieve and display predictions when loading a task
+    """
+
+    config_has_control_tags: bool = pydantic.Field()
+    """
+    Flag to detect is project ready for labeling
+    """
+
+    skip_queue: typing.Optional[LseProjectUpdateSkipQueue] = None
+    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 = pydantic.Field()
+    """
+    Finished tasks
+    """
+
+    queue_total: int
+    queue_done: int
+    config_suitable_for_bulk_annotation: bool = pydantic.Field()
+    """
+    Flag to detect is project ready for bulk annotation
+    """
+
+    workspace: int
+    review_settings: ReviewSettings
+    assignment_settings: AssignmentSettings
+    custom_script: typing.Optional[str] = None
+    comment_classification_config: typing.Optional[str] = None
+    require_comment_on_skip: typing.Optional[bool] = None
+    custom_task_lock_ttl: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    TTL in seconds for task reservations, on new and existing tasks
+    """
+
+    prompts: str
+    annotation_limit_count: typing.Optional[int] = None
+    annotation_limit_percent: typing.Optional[str] = None
+    pause_on_failed_annotator_evaluation: typing.Optional[bool] = None
+    annotator_evaluation_minimum_score: typing.Optional[str] = None
+    annotator_evaluation_minimum_tasks: typing.Optional[int] = None
+    workspace_title: 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/lse_project_update_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
+
+LseProjectUpdateSampling = typing.Union[SamplingEnum, NullEnum]

label_studio_sdk/types/lse_project_update_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
+
+LseProjectUpdateSkipQueue = typing.Union[SkipQueueEnum, NullEnum]

label_studio_sdk/types/lse_s3export_storage.py

@@ -0,0 +1,134 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import datetime as dt
+import pydantic
+from .status_c5a_enum import StatusC5AEnum
+import typing_extensions
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class LseS3ExportStorage(UncheckedBaseModel):
+    id: int
+    type: str
+    synchronizable: typing.Optional[bool] = None
+    last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Last sync finished time
+    """
+
+    last_sync_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Count of tasks synced last time
+    """
+
+    last_sync_job: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Last sync job ID
+    """
+
+    status: typing.Optional[StatusC5AEnum] = None
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Traceback report for the last failed sync
+    """
+
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage title
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage description
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation time
+    """
+
+    can_delete_objects: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Deletion from storage enabled
+    """
+
+    bucket: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    S3 bucket name
+    """
+
+    prefix: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    S3 bucket prefix
+    """
+
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage regex for filtering objects
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
+    aws_access_key_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    AWS_ACCESS_KEY_ID
+    """
+
+    aws_secret_access_key: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    AWS_SECRET_ACCESS_KEY
+    """
+
+    aws_session_token: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    AWS_SESSION_TOKEN
+    """
+
+    aws_sse_kms_key_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    AWS SSE KMS Key ID
+    """
+
+    region_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    AWS Region
+    """
+
+    s3endpoint: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_endpoint")] = pydantic.Field(
+        default=None
+    )
+    """
+    S3 Endpoint
+    """
+
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    AWS ExternalId
+    """
+
+    role_arn: str = pydantic.Field()
+    """
+    AWS RoleArn
+    """
+
+    legacy_auth: typing.Optional[bool] = None
+    project: int = pydantic.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
+    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/{import_storage/s3/types/s3create_response.py → types/lse_s3export_storage_request.py}

@@ -1,52 +1,52 @@
 # 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 datetime as dt
 import pydantic
+from .status_c5a_enum import StatusC5AEnum
 import typing_extensions
-from ....core.serialization import FieldMetadata
-from ....core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class S3CreateResponse(UniversalBaseModel):
-    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
-    """
-
-    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+class LseS3ExportStorageRequest(UncheckedBaseModel):
+    synchronizable: typing.Optional[bool] = None
+    last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+    Last sync finished time
     """
 
-    presign: typing.Optional[bool] = pydantic.Field(default=None)
+    last_sync_count: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Presign URLs for download
+    Count of tasks synced last time
     """
 
-    presign_ttl: typing.Optional[int] = pydantic.Field(default=None)
+    last_sync_job: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Presign TTL in minutes
+    Last sync job ID
     """
 
-    recursive_scan: typing.Optional[bool] = pydantic.Field(default=None)
+    status: typing.Optional[StatusC5AEnum] = None
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Scan recursively
+    Traceback report for the last failed sync
     """
 
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
     title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Storage title
+    Cloud storage title
     """
 
     description: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Storage description
+    Cloud storage description
     """
 
-    project: typing.Optional[int] = pydantic.Field(default=None)
+    can_delete_objects: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Project ID
+    Deletion from storage enabled
     """
 
     bucket: typing.Optional[str] = pydantic.Field(default=None)
@@ -59,6 +59,16 @@ class S3CreateResponse(UniversalBaseModel):
     S3 bucket prefix
     """
 
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage regex for filtering objects
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
     aws_access_key_id: typing.Optional[str] = pydantic.Field(default=None)
     """
     AWS_ACCESS_KEY_ID
@@ -91,6 +101,22 @@ class S3CreateResponse(UniversalBaseModel):
     S3 Endpoint
     """
 
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    AWS ExternalId
+    """
+
+    role_arn: str = pydantic.Field()
+    """
+    AWS RoleArn
+    """
+
+    legacy_auth: typing.Optional[bool] = None
+    project: int = pydantic.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else: