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

label_studio_sdk/types/project.py

@@ -3,8 +3,8 @@
 from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
 import pydantic
-from .user_simple import UserSimple
 import datetime as dt
+from .user_simple import UserSimple
 from .project_sampling import ProjectSampling
 from .project_skip_queue import ProjectSkipQueue
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
@@ -16,10 +16,22 @@ class Project(UncheckedBaseModel):
     make sure, that you use correct one(Project.objects.with_counts())
     """
 
-    id: int
-    title: typing.Optional[str] = pydantic.Field(default=None)
+    color: typing.Optional[str] = None
+    config_has_control_tags: bool = pydantic.Field()
     """
-    Project name. Must be between 3 and 50 characters long.
+    Flag to detect is project ready for labeling
+    """
+
+    config_suitable_for_bulk_annotation: bool = pydantic.Field()
+    """
+    Flag to detect is project ready for bulk annotation
+    """
+
+    control_weights: typing.Optional[typing.Optional[typing.Any]] = None
+    created_at: dt.datetime
+    created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
+    """
+    Project owner
     """
 
     description: typing.Optional[str] = pydantic.Field(default=None)
@@ -27,9 +39,14 @@ class Project(UncheckedBaseModel):
     Project description
     """
 
-    label_config: typing.Optional[str] = pydantic.Field(default=None)
+    enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Label config in XML format. See more about it in documentation
+    Allow annotators to submit empty annotations
+    """
+
+    evaluate_predictions_automatically: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Retrieve and display predictions when loading a task
     """
 
     expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
@@ -37,36 +54,40 @@ class Project(UncheckedBaseModel):
     Labeling instructions in HTML format
     """
 
-    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
+    finished_task_number: int = pydantic.Field()
     """
-    Show instructions to the annotator before they start
+    Finished tasks
     """
 
-    show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
+    ground_truth_number: int = pydantic.Field()
     """
-    Show a skip button in interface and allow annotators to skip the task
+    Honeypot annotation number in project
     """
 
-    enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
+    id: int
+    is_draft: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Allow annotators to submit empty annotations
+    Whether or not the project is in the middle of being created
     """
 
-    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
+    is_published: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Show annotation history to annotator
+    Whether or not the project is published to annotators
+    """
+
+    label_config: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Label config in XML format. See more about it in documentation
     """
 
-    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)
+    min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Whether or not the project is published to annotators
+    Minimum number of completed tasks after which model training is started
     """
 
     model_version: typing.Optional[str] = pydantic.Field(default=None)
@@ -74,25 +95,30 @@ class Project(UncheckedBaseModel):
     Machine learning model version
     """
 
-    is_draft: typing.Optional[bool] = pydantic.Field(default=None)
+    num_tasks_with_annotations: int = pydantic.Field()
     """
-    Whether or not the project is in the middle of being created
+    Tasks with annotations count
     """
 
-    created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
+    organization: typing.Optional[int] = None
+    overlap_cohort_percentage: typing.Optional[int] = None
+    parsed_label_config: typing.Optional[typing.Any] = None
+    pinned_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
-    Project owner
+    Pinned date and time
     """
 
-    created_at: dt.datetime
-    min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
+    queue_done: int
+    queue_total: int
+    reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Minimum number of completed tasks after which model training is started
+    Reveal pre-annotations interactively
     """
 
-    start_training_on_annotation_update: bool = pydantic.Field()
+    sampling: typing.Optional[ProjectSampling] = None
+    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Start model training after any annotations are submitted or updated
+    Show annotation history to annotator
     """
 
     show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
@@ -100,45 +126,29 @@ class Project(UncheckedBaseModel):
     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()
+    show_ground_truth_first: typing.Optional[bool] = None
+    show_instruction: 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
+    Show instructions to the annotator before they start
     """
 
-    ground_truth_number: int = pydantic.Field()
+    show_overlap_first: typing.Optional[bool] = None
+    show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Honeypot annotation number in project
+    Show a skip button in interface and allow annotators to skip the task
     """
 
+    skip_queue: typing.Optional[ProjectSkipQueue] = None
     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()
+    start_training_on_annotation_update: bool = pydantic.Field()
     """
-    Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
+    Start model training after any annotations are submitted or updated
     """
 
-    sampling: typing.Optional[ProjectSampling] = 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
@@ -149,39 +159,29 @@ class Project(UncheckedBaseModel):
     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()
+    task_number: int = pydantic.Field()
     """
-    Flag to detect is project ready for labeling
+    Total task number in project
     """
 
-    skip_queue: typing.Optional[ProjectSkipQueue] = None
-    reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Reveal pre-annotations interactively
+    Project name. Must be between 3 and 50 characters long.
     """
 
-    pinned_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    total_annotations_number: int = pydantic.Field()
     """
-    Pinned date and time
+    Total annotations number in project including skipped_annotations_number and ground_truth_number.
     """
 
-    finished_task_number: int = pydantic.Field()
+    total_predictions_number: int = pydantic.Field()
     """
-    Finished tasks
+    Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
     """
 
-    queue_total: int
-    queue_done: int
-    config_suitable_for_bulk_annotation: bool = pydantic.Field()
+    useful_annotation_number: int = pydantic.Field()
     """
-    Flag to detect is project ready for bulk annotation
+    Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/project_group.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .project_group_role_enum import ProjectGroupRoleEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class ProjectGroup(UncheckedBaseModel):
+    group: str
+    project_id: int
+    role: ProjectGroupRoleEnum
+
+    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/project_group_request.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .project_group_role_enum import ProjectGroupRoleEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class ProjectGroupRequest(UncheckedBaseModel):
+    group: str
+    project_id: int
+    role: ProjectGroupRoleEnum
+
+    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/project_group_role_enum.py

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

label_studio_sdk/types/project_import.py

@@ -2,46 +2,46 @@
 
 from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
-from .status7bf_enum import Status7BfEnum
 import datetime as dt
 import pydantic
+from .status7bf_enum import Status7BfEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class ProjectImport(UncheckedBaseModel):
-    id: int
-    project: typing.Optional[int] = None
-    preannotated_from_fields: typing.Optional[typing.Optional[typing.Any]] = None
+    annotation_count: typing.Optional[int] = None
     commit_to_project: typing.Optional[bool] = None
-    return_task_ids: typing.Optional[bool] = None
-    status: typing.Optional[Status7BfEnum] = None
-    url: typing.Optional[str] = None
-    error: typing.Optional[str] = None
+    could_be_tasks_list: typing.Optional[bool] = None
     created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
     Creation time
     """
 
-    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
-    """
-    Updated time
-    """
-
+    data_columns: typing.Optional[typing.Optional[typing.Any]] = None
+    duration: typing.Optional[int] = None
+    error: typing.Optional[str] = None
+    file_upload_ids: typing.Optional[typing.Optional[typing.Any]] = None
     finished_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
     Complete or fail time
     """
 
-    task_count: typing.Optional[int] = None
-    annotation_count: typing.Optional[int] = None
-    prediction_count: typing.Optional[int] = None
-    duration: typing.Optional[int] = None
-    file_upload_ids: typing.Optional[typing.Optional[typing.Any]] = None
-    could_be_tasks_list: typing.Optional[bool] = None
     found_formats: typing.Optional[typing.Optional[typing.Any]] = None
-    data_columns: typing.Optional[typing.Optional[typing.Any]] = None
-    tasks: typing.Optional[typing.Optional[typing.Any]] = None
+    id: int
+    preannotated_from_fields: typing.Optional[typing.Optional[typing.Any]] = None
+    prediction_count: typing.Optional[int] = None
+    project: typing.Optional[int] = None
+    return_task_ids: typing.Optional[bool] = None
+    status: typing.Optional[Status7BfEnum] = None
+    task_count: typing.Optional[int] = None
     task_ids: typing.Optional[typing.Optional[typing.Any]] = None
+    tasks: typing.Optional[typing.Optional[typing.Any]] = None
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Updated time
+    """
+
+    url: typing.Optional[str] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/types/redis_export_storage.py

@@ -9,39 +9,32 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class RedisExportStorage(UncheckedBaseModel):
-    id: int
-    type: str
-    synchronizable: typing.Optional[bool] = None
-    path: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Storage prefix (optional)
-    """
-
-    host: typing.Optional[str] = pydantic.Field(default=None)
+    can_delete_objects: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Server Host IP (optional)
+    Deletion from storage enabled
     """
 
-    port: typing.Optional[str] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
-    Server Port (optional)
+    Creation time
     """
 
-    password: typing.Optional[str] = pydantic.Field(default=None)
+    db: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Server Password (optional)
+    Server Database
     """
 
-    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage regex for filtering objects
+    Cloud storage description
     """
 
-    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    host: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Server Host IP (optional)
     """
 
+    id: int
     last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
     Last sync finished time
@@ -57,41 +50,48 @@ class RedisExportStorage(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
+    password: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Traceback report for the last failed sync
+    Server Password (optional)
     """
 
-    meta: typing.Optional[typing.Optional[typing.Any]] = None
-    title: typing.Optional[str] = pydantic.Field(default=None)
+    path: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage title
+    Storage prefix (optional)
     """
 
-    description: typing.Optional[str] = pydantic.Field(default=None)
+    port: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage description
+    Server Port (optional)
     """
 
-    created_at: dt.datetime = pydantic.Field()
+    project: int = pydantic.Field()
     """
-    Creation time
+    A unique integer value identifying this project.
     """
 
-    can_delete_objects: typing.Optional[bool] = pydantic.Field(default=None)
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Deletion from storage enabled
+    Cloud storage regex for filtering objects
     """
 
-    db: typing.Optional[int] = pydantic.Field(default=None)
+    status: typing.Optional[StatusC5AEnum] = None
+    synchronizable: typing.Optional[bool] = None
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Server Database
+    Cloud storage title
     """
 
-    project: int = pydantic.Field()
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
-    A unique integer value identifying this project.
+    Traceback report for the last failed sync
+    """
+
+    type: str
+    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/redis_import_storage.py

@@ -1,47 +1,35 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from ..core.unchecked_base_model import UncheckedBaseModel
-import typing
-import pydantic
 import datetime as dt
+import pydantic
+import typing
 from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class RedisImportStorage(UncheckedBaseModel):
-    id: int
-    type: str
-    synchronizable: typing.Optional[bool] = None
-    path: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Storage prefix (optional)
-    """
-
-    host: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Server Host IP (optional)
-    """
-
-    port: typing.Optional[str] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
-    Server Port (optional)
+    Creation time
     """
 
-    password: typing.Optional[str] = pydantic.Field(default=None)
+    db: typing.Optional[int] = pydantic.Field(default=None)
     """
-    Server Password (optional)
+    Server Database
     """
 
-    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage regex for filtering objects
+    Cloud storage description
     """
 
-    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    host: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Server Host IP (optional)
     """
 
+    id: int
     last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
     Last sync finished time
@@ -57,36 +45,48 @@ class RedisImportStorage(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
+    password: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Traceback report for the last failed sync
+    Server Password (optional)
     """
 
-    meta: typing.Optional[typing.Optional[typing.Any]] = None
-    title: typing.Optional[str] = pydantic.Field(default=None)
+    path: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage title
+    Storage prefix (optional)
     """
 
-    description: typing.Optional[str] = pydantic.Field(default=None)
+    port: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Cloud storage description
+    Server Port (optional)
     """
 
-    created_at: dt.datetime = pydantic.Field()
+    project: int = pydantic.Field()
     """
-    Creation time
+    A unique integer value identifying this project.
     """
 
-    db: typing.Optional[int] = pydantic.Field(default=None)
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Server Database
+    Cloud storage regex for filtering objects
     """
 
-    project: int = pydantic.Field()
+    status: typing.Optional[StatusC5AEnum] = None
+    synchronizable: typing.Optional[bool] = None
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    A unique integer value identifying this project.
+    Cloud storage title
+    """
+
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Traceback report for the last failed sync
+    """
+
+    type: str
+    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/refined_prompt_response.py

@@ -2,25 +2,25 @@
 
 from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
-import pydantic
 from .third_party_model_version import ThirdPartyModelVersion
+import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class RefinedPromptResponse(UncheckedBaseModel):
-    title: typing.Optional[str] = pydantic.Field(default=None)
+    previous_version: typing.Optional[ThirdPartyModelVersion] = pydantic.Field(default=None)
     """
-    Title of the refined prompt
+    Previous version of the prompt
     """
 
-    reasoning: typing.Optional[str] = pydantic.Field(default=None)
+    prompt: str = pydantic.Field()
     """
-    Reasoning behind the refinement
+    The refined prompt text
     """
 
-    prompt: str = pydantic.Field()
+    reasoning: typing.Optional[str] = pydantic.Field(default=None)
     """
-    The refined prompt text
+    Reasoning behind the refinement
     """
 
     refinement_job_id: typing.Optional[str] = pydantic.Field(default=None)
@@ -33,14 +33,14 @@ class RefinedPromptResponse(UncheckedBaseModel):
     Status of the refinement job
     """
 
-    total_cost: typing.Optional[str] = pydantic.Field(default=None)
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Total cost of the refinement job (in USD)
+    Title of the refined prompt
     """
 
-    previous_version: typing.Optional[ThirdPartyModelVersion] = pydantic.Field(default=None)
+    total_cost: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Previous version of the prompt
+    Total cost of the refinement job (in USD)
     """
 
     if IS_PYDANTIC_V2: