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

label_studio_sdk/types/all_roles_project_list.py

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

@@ -9,41 +9,25 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 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: str = pydantic.Field()
+    bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Username string
+    Annotation was created in bulk mode
     """
 
+    completed_by: typing.Optional[int] = None
     created_ago: str = pydantic.Field()
     """
     Time delta from creation time
     """
 
-    completed_by: typing.Optional[int] = None
-    was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    User skipped the task
-    """
-
-    ground_truth: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    This annotation is a Ground Truth (ground_truth)
-    """
-
     created_at: dt.datetime = pydantic.Field()
     """
     Creation time
     """
 
-    updated_at: dt.datetime = pydantic.Field()
+    created_username: str = pydantic.Field()
     """
-    Last updated time
+    Username string
     """
 
     draft_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
@@ -51,11 +35,12 @@ class Annotation(UncheckedBaseModel):
     Draft creation time
     """
 
-    lead_time: typing.Optional[float] = pydantic.Field(default=None)
+    ground_truth: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    How much time it took to annotate the task
+    This annotation is a Ground Truth (ground_truth)
     """
 
+    id: int
     import_id: typing.Optional[int] = pydantic.Field(default=None)
     """
     Original annotation ID that was at the import step or NULL if this annotation wasn't imported
@@ -77,14 +62,24 @@ class Annotation(UncheckedBaseModel):
     * `deleted_review` - Deleted review
     """
 
-    bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
+    last_created_by: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Annotation was created in bulk mode
+    User who created the last annotation history item
     """
 
-    task: typing.Optional[int] = pydantic.Field(default=None)
+    lead_time: typing.Optional[float] = pydantic.Field(default=None)
     """
-    Corresponding task for this annotation
+    How much time it took to annotate the task
+    """
+
+    parent_annotation: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Points to the parent annotation from which this annotation was created
+    """
+
+    parent_prediction: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Points to the prediction from which this annotation was created
     """
 
     project: typing.Optional[int] = pydantic.Field(default=None)
@@ -92,24 +87,29 @@ class Annotation(UncheckedBaseModel):
     Project ID for this annotation
     """
 
-    updated_by: typing.Optional[int] = pydantic.Field(default=None)
+    result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
     """
-    Last user who updated this annotation
+    List of annotation results for the task
     """
 
-    parent_prediction: typing.Optional[int] = pydantic.Field(default=None)
+    task: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Points to the prediction from which this annotation was created
+    Corresponding task for this annotation
     """
 
-    parent_annotation: typing.Optional[int] = pydantic.Field(default=None)
+    updated_at: dt.datetime = pydantic.Field()
     """
-    Points to the parent annotation from which this annotation was created
+    Last updated time
     """
 
-    last_created_by: typing.Optional[int] = pydantic.Field(default=None)
+    updated_by: typing.Optional[int] = pydantic.Field(default=None)
     """
-    User who created the last annotation history item
+    Last user who updated this annotation
+    """
+
+    was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    User skipped the task
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/annotation_request.py

@@ -9,31 +9,20 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class AnnotationRequest(UncheckedBaseModel):
-    result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
+    bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    List of annotation results for the task
+    Annotation was created in bulk mode
     """
 
     completed_by: typing.Optional[int] = None
-    unique_id: typing.Optional[str] = None
-    was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    User skipped the task
-    """
-
-    ground_truth: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    This annotation is a Ground Truth (ground_truth)
-    """
-
     draft_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
     Draft creation time
     """
 
-    lead_time: typing.Optional[float] = pydantic.Field(default=None)
+    ground_truth: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    How much time it took to annotate the task
+    This annotation is a Ground Truth (ground_truth)
     """
 
     import_id: typing.Optional[int] = pydantic.Field(default=None)
@@ -57,14 +46,24 @@ class AnnotationRequest(UncheckedBaseModel):
     * `deleted_review` - Deleted review
     """
 
-    bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
+    last_created_by: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Annotation was created in bulk mode
+    User who created the last annotation history item
     """
 
-    task: typing.Optional[int] = pydantic.Field(default=None)
+    lead_time: typing.Optional[float] = pydantic.Field(default=None)
     """
-    Corresponding task for this annotation
+    How much time it took to annotate the task
+    """
+
+    parent_annotation: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Points to the parent annotation from which this annotation was created
+    """
+
+    parent_prediction: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Points to the prediction from which this annotation was created
     """
 
     project: typing.Optional[int] = pydantic.Field(default=None)
@@ -72,24 +71,25 @@ class AnnotationRequest(UncheckedBaseModel):
     Project ID for this annotation
     """
 
-    updated_by: typing.Optional[int] = pydantic.Field(default=None)
+    result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
     """
-    Last user who updated this annotation
+    List of annotation results for the task
     """
 
-    parent_prediction: typing.Optional[int] = pydantic.Field(default=None)
+    task: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Points to the prediction from which this annotation was created
+    Corresponding task for this annotation
     """
 
-    parent_annotation: typing.Optional[int] = pydantic.Field(default=None)
+    unique_id: typing.Optional[str] = None
+    updated_by: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Points to the parent annotation from which this annotation was created
+    Last user who updated this annotation
     """
 
-    last_created_by: typing.Optional[int] = pydantic.Field(default=None)
+    was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    User who created the last annotation history item
+    User skipped the task
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/azure_blob_export_storage.py

@@ -9,39 +9,37 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class AzureBlobExportStorage(UncheckedBaseModel):
-    id: int
-    type: str
-    synchronizable: typing.Optional[bool] = None
-    container: typing.Optional[str] = pydantic.Field(default=None)
+    account_key: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Azure blob container
+    Azure Blob account key
     """
 
-    prefix: typing.Optional[str] = pydantic.Field(default=None)
+    account_name: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Azure blob prefix name
+    Azure Blob account name
     """
 
-    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    can_delete_objects: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Cloud storage regex for filtering objects
+    Deletion from storage enabled
     """
 
-    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    container: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Azure blob container
     """
 
-    account_name: typing.Optional[str] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
-    Azure Blob account name
+    Creation time
     """
 
-    account_key: typing.Optional[str] = pydantic.Field(default=None)
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Azure Blob account key
+    Cloud storage description
     """
 
+    id: int
     last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
     Last sync finished time
@@ -57,36 +55,38 @@ class AzureBlobExportStorage(UncheckedBaseModel):
     Last sync job ID
     """
 
-    status: typing.Optional[StatusC5AEnum] = None
-    traceback: typing.Optional[str] = pydantic.Field(default=None)
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
+    prefix: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Traceback report for the last failed sync
+    Azure blob prefix name
     """
 
-    meta: typing.Optional[typing.Optional[typing.Any]] = None
-    title: typing.Optional[str] = pydantic.Field(default=None)
+    project: int = pydantic.Field()
     """
-    Cloud storage title
+    A unique integer value identifying this project.
     """
 
-    description: typing.Optional[str] = pydantic.Field(default=None)
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage description
+    Cloud storage regex for filtering objects
     """
 
-    created_at: dt.datetime = pydantic.Field()
+    status: typing.Optional[StatusC5AEnum] = None
+    synchronizable: typing.Optional[bool] = None
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Creation time
+    Cloud storage title
     """
 
-    can_delete_objects: typing.Optional[bool] = pydantic.Field(default=None)
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Deletion from storage enabled
+    Traceback report for the last failed sync
     """
 
-    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: