label-studio-sdk 2.0.5__py3-none-any.whl → 2.0.7__py3-none-any.whl

label_studio_sdk/types/gcswif_import_storage.py

@@ -0,0 +1,120 @@
+# 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
+from .status_c5a_enum import StatusC5AEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GcswifImportStorage(UncheckedBaseModel):
+    bucket: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    GCS bucket name
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Creation time
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage description
+    """
+
+    google_application_credentials: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The content of GOOGLE_APPLICATION_CREDENTIALS json file
+    """
+
+    google_project_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google project ID
+    """
+
+    google_project_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google project number
+    """
+
+    google_service_account_email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google service account email
+    """
+
+    google_wif_pool_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google WIF pool ID
+    """
+
+    google_wif_provider_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google WIF provider ID
+    """
+
+    id: int
+    last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Last sync finished time
+    """
+
+    last_sync_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Count of tasks synced last time
+    """
+
+    last_sync_job: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Last sync job ID
+    """
+
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
+    prefix: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    GCS bucket prefix
+    """
+
+    presign: typing.Optional[bool] = None
+    presign_ttl: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Presigned URLs TTL (in minutes)
+    """
+
+    project: int = pydantic.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage regex for filtering objects
+    """
+
+    status: typing.Optional[StatusC5AEnum] = None
+    synchronizable: typing.Optional[bool] = None
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    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:
+        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/gcswif_import_storage_request.py

@@ -0,0 +1,113 @@
+# 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
+from .status_c5a_enum import StatusC5AEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class GcswifImportStorageRequest(UncheckedBaseModel):
+    bucket: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    GCS bucket name
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage description
+    """
+
+    google_application_credentials: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The content of GOOGLE_APPLICATION_CREDENTIALS json file
+    """
+
+    google_project_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google project ID
+    """
+
+    google_project_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google project number
+    """
+
+    google_service_account_email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google service account email
+    """
+
+    google_wif_pool_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google WIF pool ID
+    """
+
+    google_wif_provider_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google WIF provider ID
+    """
+
+    last_sync: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Last sync finished time
+    """
+
+    last_sync_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Count of tasks synced last time
+    """
+
+    last_sync_job: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Last sync job ID
+    """
+
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
+    prefix: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    GCS bucket prefix
+    """
+
+    presign: typing.Optional[bool] = None
+    presign_ttl: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Presigned URLs TTL (in minutes)
+    """
+
+    project: int = pydantic.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
+    regex_filter: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage regex for filtering objects
+    """
+
+    status: typing.Optional[StatusC5AEnum] = None
+    synchronizable: typing.Optional[bool] = None
+    title: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Cloud storage title
+    """
+
+    traceback: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Traceback report for the last failed sync
+    """
+
+    use_blob_urls: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Interpret objects as BLOBs and generate URLs
+    """
+
+    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.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_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_project_update.py

@@ -156,6 +156,7 @@ class LseProjectUpdate(UncheckedBaseModel):
     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[LseProjectUpdateSkipQueue] = None
     skipped_annotations_number: int = pydantic.Field()
     """

label_studio_sdk/types/lse_task.py

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

label_studio_sdk/types/lse_task_serializer_for_reviewers.py

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

label_studio_sdk/types/lsejwt_settings.py

@@ -7,11 +7,7 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class LsejwtSettings(UncheckedBaseModel):
-    api_token_ttl_days: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Number of days before JWT API tokens expire
-    """
-
+    api_token_ttl_days: int
     api_tokens_enabled: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Enable JWT API token authentication for this organization

label_studio_sdk/types/paginated_annotation_history_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 .annotation_history import AnnotationHistory
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PaginatedAnnotationHistoryList(UncheckedBaseModel):
+    count: int
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.List[AnnotationHistory]
+
+    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_user_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_user import LseUser
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PaginatedLseUserList(UncheckedBaseModel):
+    count: int
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.List[LseUser]
+
+    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_paginated_project_member_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 .paginated_project_member import PaginatedProjectMember
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PaginatedPaginatedProjectMemberList(UncheckedBaseModel):
+    count: int
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.List[PaginatedProjectMember]
+
+    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_project_member.py

@@ -0,0 +1,50 @@
+# 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
+from .lse_fields import LseFields
+from .organization_membership import OrganizationMembership
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class PaginatedProjectMember(UncheckedBaseModel):
+    """
+    A ModelSerializer that takes additional arguments for
+    "fields", "omit" and "expand" in order to
+    control which fields are displayed, and whether to replace simple
+    values with complex, nested serializations
+    """
+
+    active_organization: typing.Optional[int] = None
+    active_organization_meta: str
+    allow_newsletters: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow sending newsletters to user
+    """
+
+    avatar: str
+    custom_hotkeys: typing.Optional[typing.Optional[typing.Any]] = None
+    date_joined: typing.Optional[dt.datetime] = None
+    email: typing.Optional[str] = None
+    first_name: typing.Optional[str] = None
+    id: int
+    initials: str
+    last_activity: dt.datetime
+    last_name: typing.Optional[str] = None
+    lse_fields: LseFields
+    org_membership: typing.List[OrganizationMembership]
+    pause: str
+    phone: typing.Optional[str] = None
+    project_role: str
+    username: 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/project_member_bulk_assign_roles_request.py

@@ -0,0 +1,21 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .role9e7enum import Role9E7Enum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class ProjectMemberBulkAssignRolesRequest(UncheckedBaseModel):
+    role: Role9E7Enum
+    user_id: int
+
+    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