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

label_studio_sdk/types/inference_run_cost_estimate.py

@@ -1,12 +1,12 @@
 # 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 pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class InferenceRunCostEstimate(UniversalBaseModel):
+class InferenceRunCostEstimate(UncheckedBaseModel):
     prompt_cost_usd: typing.Optional[str] = pydantic.Field(default=None)
     """
     Cost of the prompt (in USD)

label_studio_sdk/types/label_stream_task_distribution_enum.py

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

label_studio_sdk/types/{annotations_dm_field_last_action.py → last_action_enum.py}

@@ -2,7 +2,7 @@
 
 import typing
 
-AnnotationsDmFieldLastAction = typing.Union[
+LastActionEnum = typing.Union[
     typing.Literal[
         "prediction",
         "propagated_annotation",

label_studio_sdk/types/local_files_export_storage.py

@@ -1,16 +1,16 @@
 # 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 pydantic
 import datetime as dt
-from .local_files_export_storage_status import LocalFilesExportStorageStatus
+from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class LocalFilesExportStorage(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    type: typing.Optional[str] = None
+class LocalFilesExportStorage(UncheckedBaseModel):
+    id: int
+    type: str
     synchronizable: typing.Optional[bool] = None
     path: typing.Optional[str] = pydantic.Field(default=None)
     """
@@ -42,17 +42,13 @@ class LocalFilesExportStorage(UniversalBaseModel):
     Last sync job ID
     """
 
-    status: typing.Optional[LocalFilesExportStorageStatus] = None
+    status: typing.Optional[StatusC5AEnum] = None
     traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
     Traceback report for the last failed sync
     """
 
-    meta: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    Meta and debug information about storage processes
-    """
-
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
     title: typing.Optional[str] = pydantic.Field(default=None)
     """
     Cloud storage title
@@ -63,7 +59,7 @@ class LocalFilesExportStorage(UniversalBaseModel):
     Cloud storage description
     """
 
-    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
     Creation time
     """

label_studio_sdk/types/local_files_import_storage.py

@@ -1,16 +1,16 @@
 # 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 pydantic
 import datetime as dt
-from .local_files_import_storage_status import LocalFilesImportStorageStatus
+from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class LocalFilesImportStorage(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    type: typing.Optional[str] = None
+class LocalFilesImportStorage(UncheckedBaseModel):
+    id: int
+    type: str
     synchronizable: typing.Optional[bool] = None
     path: typing.Optional[str] = pydantic.Field(default=None)
     """
@@ -42,17 +42,13 @@ class LocalFilesImportStorage(UniversalBaseModel):
     Last sync job ID
     """
 
-    status: typing.Optional[LocalFilesImportStorageStatus] = None
+    status: typing.Optional[StatusC5AEnum] = None
     traceback: typing.Optional[str] = pydantic.Field(default=None)
     """
     Traceback report for the last failed sync
     """
 
-    meta: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    Meta and debug information about storage processes
-    """
-
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
     title: typing.Optional[str] = pydantic.Field(default=None)
     """
     Cloud storage title
@@ -63,7 +59,7 @@ class LocalFilesImportStorage(UniversalBaseModel):
     Cloud storage description
     """
 
-    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
     Creation time
     """

label_studio_sdk/types/{annotation_filter_options.py → lse_annotation_filter_options.py}

@@ -1,12 +1,13 @@
 # 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 pydantic
+from .lse_annotation_filter_options_reviewed import LseAnnotationFilterOptionsReviewed
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class AnnotationFilterOptions(UniversalBaseModel):
+class LseAnnotationFilterOptions(UncheckedBaseModel):
     usual: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Include not skipped and not ground truth annotations
@@ -22,6 +23,15 @@ class AnnotationFilterOptions(UniversalBaseModel):
     Include skipped annotations
     """
 
+    reviewed: typing.Optional[LseAnnotationFilterOptionsReviewed] = 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
+    
+    * `only` - only
+    * `exclude` - exclude
+    * `None` - None
+    """
+
     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_annotation_filter_options_request.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+from .lse_annotation_filter_options_request_reviewed import LseAnnotationFilterOptionsRequestReviewed
+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
+    
+    * `only` - only
+    * `exclude` - exclude
+    * `None` - 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_annotation_filter_options_request_reviewed.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .reviewed_enum import ReviewedEnum
+from .null_enum import NullEnum
+
+LseAnnotationFilterOptionsRequestReviewed = typing.Union[ReviewedEnum, NullEnum]

label_studio_sdk/types/lse_annotation_filter_options_reviewed.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .reviewed_enum import ReviewedEnum
+from .null_enum import NullEnum
+
+LseAnnotationFilterOptionsReviewed = typing.Union[ReviewedEnum, NullEnum]

label_studio_sdk/types/{export_snapshot.py → lse_export_create.py}

@@ -1,23 +1,23 @@
 # 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
 from .user_simple import UserSimple
 import datetime as dt
 import pydantic
-from .export_snapshot_status import ExportSnapshotStatus
+from .status7bf_enum import Status7BfEnum
 from .converted_format import ConvertedFormat
-from .task_filter_options import TaskFilterOptions
-from .annotation_filter_options import AnnotationFilterOptions
+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 ExportSnapshot(UniversalBaseModel):
+class LseExportCreate(UncheckedBaseModel):
     title: typing.Optional[str] = None
-    id: typing.Optional[int] = None
+    id: int
     created_by: typing.Optional[UserSimple] = None
-    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    created_at: dt.datetime = pydantic.Field()
     """
     Creation time
     """
@@ -27,12 +27,12 @@ class ExportSnapshot(UniversalBaseModel):
     Complete or fail time
     """
 
-    status: typing.Optional[ExportSnapshotStatus] = None
+    status: typing.Optional[Status7BfEnum] = None
     md5: typing.Optional[str] = None
-    counters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    counters: typing.Optional[typing.Optional[typing.Any]] = None
     converted_formats: typing.Optional[typing.List[ConvertedFormat]] = None
-    task_filter_options: typing.Optional[TaskFilterOptions] = None
-    annotation_filter_options: typing.Optional[AnnotationFilterOptions] = None
+    task_filter_options: typing.Optional[LseTaskFilterOptions] = None
+    annotation_filter_options: typing.Optional[LseAnnotationFilterOptions] = None
     serialization_options: typing.Optional[SerializationOptions] = None
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/lse_fields.py

@@ -0,0 +1,49 @@
+# This file was auto-generated by Fern from our API Definition.
+
+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
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class LseFields(UncheckedBaseModel):
+    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)
+    """
+    The current stage of user onboarding
+    
+    * `not_started` - Not Started
+    * `signup` - Signup
+    * `trial_signup` - Trial Signup
+    * `first_tutorial` - First Tutorial
+    * `in_app_guidance` - In App Guidance
+    * `complete` - Complete
+    """
+
+    email_notification_settings: 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_fields_onboarding_state.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .onboarding_state_enum import OnboardingStateEnum
+from .blank_enum import BlankEnum
+from .null_enum import NullEnum
+
+LseFieldsOnboardingState = typing.Union[OnboardingStateEnum, BlankEnum, NullEnum]

label_studio_sdk/types/lse_fields_trial_role.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .trial_role_enum import TrialRoleEnum
+from .blank_enum import BlankEnum
+from .null_enum import NullEnum
+
+LseFieldsTrialRole = typing.Union[TrialRoleEnum, BlankEnum, NullEnum]

label_studio_sdk/types/lse_key_indicator_value.py

@@ -0,0 +1,35 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import pydantic
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class LseKeyIndicatorValue(UncheckedBaseModel):
+    """
+    Key indicator value for Label Studio Enterprise.
+
+    Attributes:
+        title: The title for this metric, to be displayed to the user
+        values: Dictionary of key-value pairs for the indicator values
+    """
+
+    title: str = pydantic.Field()
+    """
+    The title for this metric, to be displayed to the user
+    """
+
+    values: typing.Dict[str, typing.Optional[typing.Any]] = pydantic.Field()
+    """
+    Dictionary of key-value pairs for the indicator values
+    """
+
+    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_organization.py

@@ -0,0 +1,57 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+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)
+    """
+    External ID to uniquely identify this organization
+    """
+
+    title: str
+    token: str
+    default_role: typing.Optional[DefaultRoleEnum] = pydantic.Field(default=None)
+    """
+    Default membership role for invited users
+    
+    * `OW` - Owner
+    * `AD` - Administrator
+    * `MA` - Manager
+    * `RE` - Reviewer
+    * `AN` - Annotator
+    * `DI` - Deactivated
+    * `NO` - Not Activated
+    """
+
+    created_at: dt.datetime
+    billing: OrganizationBilling
+    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)
+    """
+    Set the minimum user role that can edit custom scripts in the UI.
+    
+    * `AD` - Administrator
+    * `MA` - Manager
+    """
+
+    email_notification_settings: 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_organization_custom_scripts_editable_by.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .custom_scripts_editable_by_enum import CustomScriptsEditableByEnum
+from .null_enum import NullEnum
+
+LseOrganizationCustomScriptsEditableBy = typing.Union[CustomScriptsEditableByEnum, NullEnum]

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]