label-studio-sdk 2.0.6__py3-none-any.whl → 2.0.8__py3-none-any.whl

label_studio_sdk/types/default_role.py

@@ -0,0 +1,75 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import datetime as dt
+import pydantic
+from .default_role_custom_scripts_editable_by import DefaultRoleCustomScriptsEditableBy
+from .role9e7enum import Role9E7Enum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class DefaultRole(UncheckedBaseModel):
+    annotator_reviewer_firewall_enabled_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
+    """
+
+    custom_scripts_editable_by: typing.Optional[DefaultRoleCustomScriptsEditableBy] = pydantic.Field(default=None)
+    """
+    Set the minimum user role that can edit custom scripts in the UI.
+    
+    * `AD` - Administrator
+    * `MA` - Manager
+    """
+
+    custom_scripts_enabled_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Set to current time to enabled custom scripts for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts.
+    """
+
+    default_role: typing.Optional[Role9E7Enum] = 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
+    """
+
+    email_notification_settings: typing.Optional[typing.Optional[typing.Any]] = None
+    embed_domains: typing.Optional[typing.Optional[typing.Any]] = None
+    embed_settings: typing.Optional[typing.Optional[typing.Any]] = None
+    external_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    External ID to uniquely identify this organization
+    """
+
+    extra_data_on_activity_logs: typing.Optional[bool] = None
+    label_stream_navigation_disabled_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Set to current time to disable the label stream navigation for this organization. This will prevent users from going back in the label stream to view previous labels.
+    """
+
+    organization: int = pydantic.Field()
+    """
+    A unique integer value identifying this organization.
+    """
+
+    read_only_quick_view_enabled_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Set to current time to prevent creating or editing annotations in quick view.
+    """
+
+    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/default_role_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
+
+DefaultRoleCustomScriptsEditableBy = typing.Union[CustomScriptsEditableByEnum, NullEnum]

label_studio_sdk/types/lse_organization.py

@@ -6,7 +6,7 @@ import datetime as dt
 import typing
 from .lse_organization_custom_scripts_editable_by import LseOrganizationCustomScriptsEditableBy
 import pydantic
-from .default_role_enum import DefaultRoleEnum
+from .role9e7enum import Role9E7Enum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
@@ -22,7 +22,7 @@ class LseOrganization(UncheckedBaseModel):
     """
 
     custom_scripts_enabled: str
-    default_role: typing.Optional[DefaultRoleEnum] = pydantic.Field(default=None)
+    default_role: typing.Optional[Role9E7Enum] = pydantic.Field(default=None)
     """
     Default membership role for invited users
     

label_studio_sdk/types/lse_project.py

@@ -0,0 +1,223 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .assignment_settings import AssignmentSettings
+import pydantic
+import datetime as dt
+from .user_simple import UserSimple
+from .review_settings import ReviewSettings
+from .lse_project_sampling import LseProjectSampling
+from .lse_project_skip_queue import LseProjectSkipQueue
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class LseProject(UncheckedBaseModel):
+    """
+    Serializer get numbers from project queryset annotation,
+    make sure, that you use correct one(Project.objects.with_counts())
+    """
+
+    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()
+    """
+    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
+    """
+
+    custom_script: typing.Optional[str] = None
+    custom_task_lock_ttl: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    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
+    """
+
+    duplication_done: typing.Optional[bool] = None
+    duplication_status: typing.Optional[str] = None
+    enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    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)
+    """
+    Labeling instructions in HTML format
+    """
+
+    finished_task_number: int = pydantic.Field()
+    """
+    Finished tasks
+    """
+
+    ground_truth_number: int = pydantic.Field()
+    """
+    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
+    """
+
+    is_published: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    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
+    """
+
+    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)
+    """
+
+    members: str
+    members_count: int
+    min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    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()
+    """
+    Tasks with annotations count
+    """
+
+    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)
+    """
+    Pinned date and time
+    """
+
+    prompts: str
+    queue_done: str
+    queue_left: str
+    queue_total: str
+    require_comment_on_skip: typing.Optional[bool] = None
+    reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Reveal pre-annotations interactively
+    """
+
+    review_settings: ReviewSettings
+    reviewer_queue_total: str
+    sampling: typing.Optional[LseProjectSampling] = None
+    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show annotation history to annotator
+    """
+
+    show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If set, the annotator can view model predictions
+    """
+
+    show_ground_truth_first: typing.Optional[bool] = None
+    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show instructions to the annotator before they start
+    """
+
+    show_overlap_first: typing.Optional[bool] = None
+    show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show a skip button in interface and allow annotators to skip the task
+    """
+
+    show_unused_data_columns_to_annotators: typing.Optional[bool] = None
+    skip_queue: typing.Optional[LseProjectSkipQueue] = None
+    skipped_annotations_number: int = pydantic.Field()
+    """
+    Skipped by collaborators annotation number in project
+    """
+
+    start_training_on_annotation_update: bool = pydantic.Field()
+    """
+    Start model training after any annotations are submitted or updated
+    """
+
+    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
+    """
+
+    task_number: int = pydantic.Field()
+    """
+    Total task number in project
+    """
+
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Project name. Must be between 3 and 50 characters long.
+    """
+
+    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.
+    """
+
+    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
+    """
+
+    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
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/lse_project_counts.py

@@ -0,0 +1,46 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class LseProjectCounts(UncheckedBaseModel):
+    """
+    Serializer get numbers from project queryset annotation,
+    make sure, that you use correct one(Project.objects.with_counts())
+    """
+
+    finished_task_number: int
+    ground_truth_number: int = pydantic.Field()
+    """
+    Honeypot annotation number in project
+    """
+
+    id: int
+    num_tasks_with_annotations: str
+    queue_done: str
+    queue_left: str
+    queue_total: str
+    rejected: str
+    review_total_tasks: str
+    reviewed_number: str
+    skipped_annotations_number: str
+    task_number: int = pydantic.Field()
+    """
+    Total task number in project
+    """
+
+    total_annotations_number: str
+    total_predictions_number: int
+    useful_annotation_number: 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_project_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
+
+LseProjectSampling = typing.Union[SamplingEnum, NullEnum]

label_studio_sdk/types/lse_project_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
+
+LseProjectSkipQueue = typing.Union[SkipQueueEnum, NullEnum]

label_studio_sdk/types/lse_task.py

@@ -15,7 +15,7 @@ class LseTask(UncheckedBaseModel):
     """
 
     agreement: str
-    agreement_filtered: str
+    agreement_selected: str
     annotations: str
     annotations_ids: str
     annotations_results: str

label_studio_sdk/types/lse_task_serializer_for_reviewers.py

@@ -15,7 +15,7 @@ class LseTaskSerializerForReviewers(UncheckedBaseModel):
     """
 
     agreement: str
-    agreement_filtered: str
+    agreement_selected: str
     annotations: str
     annotations_ids: str
     annotations_results: str

label_studio_sdk/types/organization_permission.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .role9e7enum import Role9E7Enum
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class OrganizationPermission(UncheckedBaseModel):
+    default_role: str
+    id: int
+    label: str
+    options: str
+    organization: int
+    permission: str
+    roles: typing.Optional[typing.List[Role9E7Enum]] = pydantic.Field(default=None)
+    """
+    Explicit roles that have this permission within the organization.
+    """
+
+    tooltip: 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/organization_permission_request.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .role9e7enum import Role9E7Enum
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class OrganizationPermissionRequest(UncheckedBaseModel):
+    permission: str
+    roles: typing.Optional[typing.List[Role9E7Enum]] = pydantic.Field(default=None)
+    """
+    Explicit roles that have this permission within the organization.
+    """
+
+    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/paginated_lse_project_counts_list.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .lse_project_counts import LseProjectCounts
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PaginatedLseProjectCountsList(UncheckedBaseModel):
+    count: int
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.List[LseProjectCounts]
+
+    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_template.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import datetime as dt
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ProjectTemplate(UncheckedBaseModel):
+    assignment_settings: typing.Optional[typing.Optional[typing.Any]] = None
+    created_at: dt.datetime
+    created_by: typing.Optional[int] = None
+    custom_script: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    custom script for projects created from this template
+    """
+
+    description: typing.Optional[str] = None
+    id: int
+    name: str
+    organization: typing.Optional[int] = None
+    project_settings: typing.Optional[typing.Optional[typing.Any]] = None
+    require_comment_on_skip: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    flag to require comment on skip
+    """
+
+    review_settings: typing.Optional[typing.Optional[typing.Any]] = None
+    show_unused_data_columns_to_annotators: typing.Optional[bool] = None
+    tags: typing.Optional[typing.Optional[typing.Any]] = None
+    updated_at: dt.datetime
+
+    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_template_request.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ProjectTemplateRequest(UncheckedBaseModel):
+    assignment_settings: typing.Optional[typing.Optional[typing.Any]] = None
+    created_by: typing.Optional[int] = None
+    custom_script: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    custom script for projects created from this template
+    """
+
+    description: typing.Optional[str] = None
+    name: str
+    organization: typing.Optional[int] = None
+    project_id: int
+    project_settings: typing.Optional[typing.Optional[typing.Any]] = None
+    require_comment_on_skip: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    flag to require comment on skip
+    """
+
+    review_settings: typing.Optional[typing.Optional[typing.Any]] = None
+    show_unused_data_columns_to_annotators: typing.Optional[bool] = None
+    tags: typing.Optional[typing.Optional[typing.Any]] = 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/who_am_i_user.py

@@ -36,6 +36,7 @@ class WhoAmIUser(UncheckedBaseModel):
     lse_fields: WhoAmILseFields
     org_membership: typing.List[OrganizationMembership]
     pause: str
+    permissions: typing.List[str]
     phone: typing.Optional[str] = None
     username: str
 

{label_studio_sdk-2.0.6.dist-info → label_studio_sdk-2.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: label-studio-sdk
-Version: 2.0.6
+Version: 2.0.8
 Summary: 
 Requires-Python: >=3.9,<4
 Classifier: Intended Audience :: Developers