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

label_studio_sdk/types/lse_annotation_filter_options_request.py

@@ -8,21 +8,11 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class LseAnnotationFilterOptionsRequest(UncheckedBaseModel):
-    usual: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    Include not skipped and not ground truth annotations
-    """
-
     ground_truth: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Include ground truth annotations
     """
 
-    skipped: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    Include skipped annotations
-    """
-
     reviewed: typing.Optional[LseAnnotationFilterOptionsRequestReviewed] = pydantic.Field(default=None)
     """
     `only` - include all tasks with at least one not reviewed annotation<br>`exclude` - exclude with at least one not reviewed annotation
@@ -32,6 +22,16 @@ class LseAnnotationFilterOptionsRequest(UncheckedBaseModel):
     * `None` - None
     """
 
+    skipped: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Include skipped annotations
+    """
+
+    usual: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Include not skipped and not ground truth annotations
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

label_studio_sdk/types/lse_export_create.py

@@ -2,38 +2,38 @@
 
 from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
-from .user_simple import UserSimple
+from .lse_annotation_filter_options import LseAnnotationFilterOptions
+from .converted_format import ConvertedFormat
 import datetime as dt
 import pydantic
+from .user_simple import UserSimple
+from .serialization_options import SerializationOptions
 from .status7bf_enum import Status7BfEnum
-from .converted_format import ConvertedFormat
 from .lse_task_filter_options import LseTaskFilterOptions
-from .lse_annotation_filter_options import LseAnnotationFilterOptions
-from .serialization_options import SerializationOptions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class LseExportCreate(UncheckedBaseModel):
-    title: typing.Optional[str] = None
-    id: int
-    created_by: typing.Optional[UserSimple] = None
+    annotation_filter_options: typing.Optional[LseAnnotationFilterOptions] = None
+    converted_formats: typing.Optional[typing.List[ConvertedFormat]] = None
+    counters: typing.Optional[typing.Optional[typing.Any]] = None
     created_at: dt.datetime = pydantic.Field()
     """
     Creation time
     """
 
+    created_by: typing.Optional[UserSimple] = None
     finished_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
     Complete or fail time
     """
 
-    status: typing.Optional[Status7BfEnum] = None
+    id: int
     md5: typing.Optional[str] = None
-    counters: typing.Optional[typing.Optional[typing.Any]] = None
-    converted_formats: typing.Optional[typing.List[ConvertedFormat]] = None
-    task_filter_options: typing.Optional[LseTaskFilterOptions] = None
-    annotation_filter_options: typing.Optional[LseAnnotationFilterOptions] = None
     serialization_options: typing.Optional[SerializationOptions] = None
+    status: typing.Optional[Status7BfEnum] = None
+    task_filter_options: typing.Optional[LseTaskFilterOptions] = None
+    title: 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/lse_fields.py

@@ -3,27 +3,18 @@
 from ..core.unchecked_base_model import UncheckedBaseModel
 import typing
 import datetime as dt
-from .lse_fields_trial_role import LseFieldsTrialRole
-import pydantic
 from .lse_fields_onboarding_state import LseFieldsOnboardingState
+import pydantic
+from .lse_fields_trial_role import LseFieldsTrialRole
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class LseFields(UncheckedBaseModel):
+    email_notification_settings: str
+    invite_activated: typing.Optional[bool] = None
     invite_expired: str
     invite_expired_at: str
     invited_at: typing.Optional[dt.datetime] = None
-    invite_activated: typing.Optional[bool] = None
-    trial_company: typing.Optional[str] = None
-    trial_role: typing.Optional[LseFieldsTrialRole] = None
-    trial_models_in_production: typing.Optional[str] = None
-    trial_experience_labeling: typing.Optional[str] = None
-    trial_license_enterprise: typing.Optional[bool] = None
-    social_auth_finished: typing.Optional[bool] = pydantic.Field(default=None)
-    """
-    Is user finished social authentication
-    """
-
     invited_by: typing.Optional[int] = None
     onboarding_state: typing.Optional[LseFieldsOnboardingState] = pydantic.Field(default=None)
     """
@@ -37,7 +28,16 @@ class LseFields(UncheckedBaseModel):
     * `complete` - Complete
     """
 
-    email_notification_settings: str
+    social_auth_finished: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Is user finished social authentication
+    """
+
+    trial_company: typing.Optional[str] = None
+    trial_experience_labeling: typing.Optional[str] = None
+    trial_license_enterprise: typing.Optional[bool] = None
+    trial_models_in_production: typing.Optional[str] = None
+    trial_role: typing.Optional[LseFieldsTrialRole] = 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/lse_organization.py

@@ -1,24 +1,27 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from ..core.unchecked_base_model import UncheckedBaseModel
+from .organization_billing import OrganizationBilling
+import datetime as dt
 import typing
+from .lse_organization_custom_scripts_editable_by import LseOrganizationCustomScriptsEditableBy
 import pydantic
 from .default_role_enum import DefaultRoleEnum
-import datetime as dt
-from .organization_billing import OrganizationBilling
-from .lse_organization_custom_scripts_editable_by import LseOrganizationCustomScriptsEditableBy
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class LseOrganization(UncheckedBaseModel):
-    id: int
-    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    billing: OrganizationBilling
+    created_at: dt.datetime
+    custom_scripts_editable_by: typing.Optional[LseOrganizationCustomScriptsEditableBy] = pydantic.Field(default=None)
     """
-    External ID to uniquely identify this organization
+    Set the minimum user role that can edit custom scripts in the UI.
+    
+    * `AD` - Administrator
+    * `MA` - Manager
     """
 
-    title: str
-    token: str
+    custom_scripts_enabled: str
     default_role: typing.Optional[DefaultRoleEnum] = pydantic.Field(default=None)
     """
     Default membership role for invited users
@@ -32,20 +35,17 @@ class LseOrganization(UncheckedBaseModel):
     * `NO` - Not Activated
     """
 
-    created_at: dt.datetime
-    billing: OrganizationBilling
+    email_notification_settings: str
     embed_domains: typing.Optional[typing.Optional[typing.Any]] = None
     embed_settings: typing.Optional[typing.Optional[typing.Any]] = None
-    custom_scripts_enabled: str
-    custom_scripts_editable_by: typing.Optional[LseOrganizationCustomScriptsEditableBy] = pydantic.Field(default=None)
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Set the minimum user role that can edit custom scripts in the UI.
-    
-    * `AD` - Administrator
-    * `MA` - Manager
+    External ID to uniquely identify this organization
     """
 
-    email_notification_settings: str
+    id: int
+    title: str
+    token: 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/lse_organization_member_list.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import pydantic
+from .lse_user_organization_member_list import LseUserOrganizationMemberList
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class LseOrganizationMemberList(UncheckedBaseModel):
+    """
+    A serializer mixin that takes an additional `fields` argument that controls
+    which fields should be displayed.
+    """
+
+    id: int
+    organization: int = pydantic.Field()
+    """
+    Organization ID
+    """
+
+    role: str
+    user: LseUserOrganizationMemberList
+
+    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.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 .lse_project_create_sampling import LseProjectCreateSampling
 from .lse_project_create_skip_queue import LseProjectCreateSkipQueue
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
@@ -16,10 +16,22 @@ class LseProjectCreate(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 LseProjectCreate(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 LseProjectCreate(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 LseProjectCreate(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[LseProjectCreateSampling] = 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 LseProjectCreate(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[LseProjectCreateSkipQueue] = 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[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
@@ -149,39 +159,29 @@ class LseProjectCreate(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[LseProjectCreateSkipQueue] = 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
     """
 
     workspace: typing.Optional[int] = None