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

label_studio_sdk/types/lse_project_update.py

@@ -2,13 +2,13 @@
 
 from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
+from .assignment_settings import AssignmentSettings
 import pydantic
-from .user_simple import UserSimple
 import datetime as dt
+from .user_simple import UserSimple
+from .review_settings import ReviewSettings
 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
 
 
@@ -18,35 +18,39 @@ class LseProjectUpdate(UncheckedBaseModel):
     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)
+    annotation_limit_count: typing.Optional[int] = None
+    annotation_limit_percent: typing.Optional[str] = None
+    annotator_evaluation_minimum_score: typing.Optional[str] = None
+    annotator_evaluation_minimum_tasks: typing.Optional[int] = None
+    assignment_settings: AssignmentSettings
+    color: typing.Optional[str] = None
+    comment_classification_config: typing.Optional[str] = None
+    config_has_control_tags: bool = pydantic.Field()
     """
-    Project description
+    Flag to detect is project ready for labeling
     """
 
-    label_config: typing.Optional[str] = pydantic.Field(default=None)
+    config_suitable_for_bulk_annotation: bool = pydantic.Field()
     """
-    Label config in XML format. See more about it in documentation
+    Flag to detect is project ready for bulk annotation
     """
 
-    expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
+    control_weights: typing.Optional[typing.Optional[typing.Any]] = None
+    created_at: dt.datetime
+    created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
     """
-    Labeling instructions in HTML format
+    Project owner
     """
 
-    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
+    custom_script: typing.Optional[str] = None
+    custom_task_lock_ttl: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Show instructions to the annotator before they start
+    TTL in seconds for task reservations, on new and existing tasks
     """
 
-    show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Show a skip button in interface and allow annotators to skip the task
+    Project description
     """
 
     enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
@@ -54,52 +58,55 @@ class LseProjectUpdate(UncheckedBaseModel):
     Allow annotators to submit empty annotations
     """
 
-    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
+    evaluate_predictions_automatically: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Show annotation history to annotator
+    Retrieve and display predictions when loading a task
     """
 
-    organization: typing.Optional[int] = None
-    color: typing.Optional[str] = None
-    maximum_annotations: typing.Optional[int] = pydantic.Field(default=None)
+    expert_instruction: typing.Optional[str] = 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)
+    Labeling instructions in HTML format
     """
 
-    is_published: typing.Optional[bool] = pydantic.Field(default=None)
+    finished_task_number: int = pydantic.Field()
     """
-    Whether or not the project is published to annotators
+    Finished tasks
     """
 
-    model_version: typing.Optional[str] = pydantic.Field(default=None)
+    ground_truth_number: int = pydantic.Field()
     """
-    Machine learning model version
+    Honeypot annotation number in project
     """
 
+    id: int
     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)
+    is_published: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Project owner
+    Whether or not the project is published to annotators
     """
 
-    created_at: dt.datetime
-    min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
+    label_config: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Minimum number of completed tasks after which model training is started
+    Label config in XML format. See more about it in documentation
     """
 
-    start_training_on_annotation_update: bool = pydantic.Field()
+    maximum_annotations: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Start model training after any annotations are submitted or updated
+    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)
     """
 
-    show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
+    min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
     """
-    If set, the annotator can view model predictions
+    Minimum number of completed tasks after which model training is started
+    """
+
+    model_version: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Machine learning model version
     """
 
     num_tasks_with_annotations: int = pydantic.Field()
@@ -107,102 +114,95 @@ class LseProjectUpdate(UncheckedBaseModel):
     Tasks with annotations count
     """
 
-    task_number: int = pydantic.Field()
+    organization: typing.Optional[int] = None
+    overlap_cohort_percentage: typing.Optional[int] = None
+    parsed_label_config: typing.Optional[typing.Any] = None
+    pause_on_failed_annotator_evaluation: typing.Optional[bool] = None
+    pinned_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
-    Total task number in project
+    Pinned date and time
     """
 
-    useful_annotation_number: int = pydantic.Field()
+    prompts: str
+    queue_done: int
+    queue_total: int
+    require_comment_on_skip: typing.Optional[bool] = None
+    reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
+    Reveal pre-annotations interactively
     """
 
-    ground_truth_number: int = pydantic.Field()
+    review_settings: ReviewSettings
+    sampling: typing.Optional[LseProjectUpdateSampling] = None
+    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Honeypot annotation number in project
+    Show annotation history to annotator
     """
 
-    skipped_annotations_number: int = pydantic.Field()
+    show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Skipped by collaborators annotation number in project
+    If set, the annotator can view model predictions
     """
 
-    total_annotations_number: int = pydantic.Field()
+    show_ground_truth_first: typing.Optional[bool] = None
+    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Total annotations number in project including skipped_annotations_number and ground_truth_number.
+    Show instructions to the annotator before they start
     """
 
-    total_predictions_number: int = pydantic.Field()
+    show_overlap_first: typing.Optional[bool] = None
+    show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
+    Show a skip button in interface and allow annotators to skip the task
     """
 
-    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)
+    skip_queue: typing.Optional[LseProjectUpdateSkipQueue] = None
+    skipped_annotations_number: int = pydantic.Field()
     """
-    Task data credentials: login
+    Skipped by collaborators annotation number in project
     """
 
-    task_data_password: typing.Optional[str] = pydantic.Field(default=None)
+    start_training_on_annotation_update: bool = pydantic.Field()
     """
-    Task data credentials: password
+    Start model training after any annotations are submitted or updated
     """
 
-    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)
+    task_data_login: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Retrieve and display predictions when loading a task
+    Task data credentials: login
     """
 
-    config_has_control_tags: bool = pydantic.Field()
+    task_data_password: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Flag to detect is project ready for labeling
+    Task data credentials: password
     """
 
-    skip_queue: typing.Optional[LseProjectUpdateSkipQueue] = None
-    reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
+    task_number: int = pydantic.Field()
     """
-    Reveal pre-annotations interactively
+    Total task number in project
     """
 
-    pinned_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Pinned date and time
+    Project name. Must be between 3 and 50 characters long.
     """
 
-    finished_task_number: int = pydantic.Field()
+    total_annotations_number: int = pydantic.Field()
     """
-    Finished tasks
+    Total annotations number in project including skipped_annotations_number and ground_truth_number.
     """
 
-    queue_total: int
-    queue_done: int
-    config_suitable_for_bulk_annotation: bool = pydantic.Field()
+    total_predictions_number: int = pydantic.Field()
     """
-    Flag to detect is project ready for bulk annotation
+    Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
     """
 
-    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)
+    useful_annotation_number: int = pydantic.Field()
     """
-    TTL in seconds for task reservations, on new and existing tasks
+    Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
     """
 
-    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: int
     workspace_title: str
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/lse_s3export_storage.py

@@ -2,48 +2,43 @@
 
 from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
-import datetime as dt
 import pydantic
-from .status_c5a_enum import StatusC5AEnum
+import datetime as dt
 import typing_extensions
 from ..core.serialization import FieldMetadata
+from .status_c5a_enum import StatusC5AEnum
 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)
+    aws_access_key_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Last sync finished time
+    AWS_ACCESS_KEY_ID
     """
 
-    last_sync_count: typing.Optional[int] = pydantic.Field(default=None)
+    aws_secret_access_key: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Count of tasks synced last time
+    AWS_SECRET_ACCESS_KEY
     """
 
-    last_sync_job: typing.Optional[str] = pydantic.Field(default=None)
+    aws_session_token: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Last sync job ID
+    AWS_SESSION_TOKEN
     """
 
-    status: typing.Optional[StatusC5AEnum] = None
-    traceback: typing.Optional[str] = pydantic.Field(default=None)
+    aws_sse_kms_key_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Traceback report for the last failed sync
+    AWS SSE KMS Key ID
     """
 
-    meta: typing.Optional[typing.Optional[typing.Any]] = None
-    title: typing.Optional[str] = pydantic.Field(default=None)
+    bucket: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage title
+    S3 bucket name
     """
 
-    description: typing.Optional[str] = pydantic.Field(default=None)
+    can_delete_objects: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Cloud storage description
+    Deletion from storage enabled
     """
 
     created_at: dt.datetime = pydantic.Field()
@@ -51,54 +46,57 @@ class LseS3ExportStorage(UncheckedBaseModel):
     Creation time
     """
 
-    can_delete_objects: typing.Optional[bool] = pydantic.Field(default=None)
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Deletion from storage enabled
+    Cloud storage description
     """
 
-    bucket: typing.Optional[str] = pydantic.Field(default=None)
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    S3 bucket name
+    AWS ExternalId
     """
 
-    prefix: typing.Optional[str] = pydantic.Field(default=None)
+    id: int
+    last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
-    S3 bucket prefix
+    Last sync finished time
     """
 
-    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    last_sync_count: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Cloud storage regex for filtering objects
+    Count of tasks synced last time
     """
 
-    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    last_sync_job: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Last sync job ID
     """
 
-    aws_access_key_id: typing.Optional[str] = pydantic.Field(default=None)
+    legacy_auth: typing.Optional[bool] = None
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
+    prefix: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS_ACCESS_KEY_ID
+    S3 bucket prefix
     """
 
-    aws_secret_access_key: typing.Optional[str] = pydantic.Field(default=None)
+    project: int = pydantic.Field()
     """
-    AWS_SECRET_ACCESS_KEY
+    A unique integer value identifying this project.
     """
 
-    aws_session_token: typing.Optional[str] = pydantic.Field(default=None)
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS_SESSION_TOKEN
+    Cloud storage regex for filtering objects
     """
 
-    aws_sse_kms_key_id: typing.Optional[str] = pydantic.Field(default=None)
+    region_name: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS SSE KMS Key ID
+    AWS Region
     """
 
-    region_name: typing.Optional[str] = pydantic.Field(default=None)
+    role_arn: str = pydantic.Field()
     """
-    AWS Region
+    AWS RoleArn
     """
 
     s3endpoint: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_endpoint")] = pydantic.Field(
@@ -108,20 +106,22 @@ class LseS3ExportStorage(UncheckedBaseModel):
     S3 Endpoint
     """
 
-    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    status: typing.Optional[StatusC5AEnum] = None
+    synchronizable: typing.Optional[bool] = None
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS ExternalId
+    Cloud storage title
     """
 
-    role_arn: str = pydantic.Field()
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS RoleArn
+    Traceback report for the last failed sync
     """
 
-    legacy_auth: typing.Optional[bool] = None
-    project: int = pydantic.Field()
+    type: str
+    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    A unique integer value identifying this project.
+    Interpret objects as BLOBs and generate URLs
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/lse_s3export_storage_request.py

@@ -2,46 +2,38 @@
 
 from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
-import datetime as dt
 import pydantic
-from .status_c5a_enum import StatusC5AEnum
+import datetime as dt
 import typing_extensions
 from ..core.serialization import FieldMetadata
+from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class LseS3ExportStorageRequest(UncheckedBaseModel):
-    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)
+    aws_access_key_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Count of tasks synced last time
+    AWS_ACCESS_KEY_ID
     """
 
-    last_sync_job: typing.Optional[str] = pydantic.Field(default=None)
+    aws_secret_access_key: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Last sync job ID
+    AWS_SECRET_ACCESS_KEY
     """
 
-    status: typing.Optional[StatusC5AEnum] = None
-    traceback: typing.Optional[str] = pydantic.Field(default=None)
+    aws_session_token: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Traceback report for the last failed sync
+    AWS_SESSION_TOKEN
     """
 
-    meta: typing.Optional[typing.Optional[typing.Any]] = None
-    title: typing.Optional[str] = pydantic.Field(default=None)
+    aws_sse_kms_key_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage title
+    AWS SSE KMS Key ID
     """
 
-    description: typing.Optional[str] = pydantic.Field(default=None)
+    bucket: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage description
+    S3 bucket name
     """
 
     can_delete_objects: typing.Optional[bool] = pydantic.Field(default=None)
@@ -49,44 +41,46 @@ class LseS3ExportStorageRequest(UncheckedBaseModel):
     Deletion from storage enabled
     """
 
-    bucket: typing.Optional[str] = pydantic.Field(default=None)
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
-    S3 bucket name
+    Cloud storage description
     """
 
-    prefix: typing.Optional[str] = pydantic.Field(default=None)
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    S3 bucket prefix
+    AWS ExternalId
     """
 
-    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
-    Cloud storage regex for filtering objects
+    Last sync finished time
     """
 
-    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    last_sync_count: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Count of tasks synced last time
     """
 
-    aws_access_key_id: typing.Optional[str] = pydantic.Field(default=None)
+    last_sync_job: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS_ACCESS_KEY_ID
+    Last sync job ID
     """
 
-    aws_secret_access_key: typing.Optional[str] = pydantic.Field(default=None)
+    legacy_auth: typing.Optional[bool] = None
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
+    prefix: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS_SECRET_ACCESS_KEY
+    S3 bucket prefix
     """
 
-    aws_session_token: typing.Optional[str] = pydantic.Field(default=None)
+    project: int = pydantic.Field()
     """
-    AWS_SESSION_TOKEN
+    A unique integer value identifying this project.
     """
 
-    aws_sse_kms_key_id: typing.Optional[str] = pydantic.Field(default=None)
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS SSE KMS Key ID
+    Cloud storage regex for filtering objects
     """
 
     region_name: typing.Optional[str] = pydantic.Field(default=None)
@@ -94,6 +88,11 @@ class LseS3ExportStorageRequest(UncheckedBaseModel):
     AWS Region
     """
 
+    role_arn: str = pydantic.Field()
+    """
+    AWS RoleArn
+    """
+
     s3endpoint: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="s3_endpoint")] = pydantic.Field(
         default=None
     )
@@ -101,20 +100,21 @@ class LseS3ExportStorageRequest(UncheckedBaseModel):
     S3 Endpoint
     """
 
-    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    status: typing.Optional[StatusC5AEnum] = None
+    synchronizable: typing.Optional[bool] = None
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS ExternalId
+    Cloud storage title
     """
 
-    role_arn: str = pydantic.Field()
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
-    AWS RoleArn
+    Traceback report for the last failed sync
     """
 
-    legacy_auth: typing.Optional[bool] = None
-    project: int = pydantic.Field()
+    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    A unique integer value identifying this project.
+    Interpret objects as BLOBs and generate URLs
     """
 
     if IS_PYDANTIC_V2: