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

label_studio_sdk/types/prediction_request.py

@@ -0,0 +1,56 @@
+# 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 PredictionRequest(UncheckedBaseModel):
+    result: typing.List[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field()
+    """
+    List of prediction results for the task
+    """
+
+    model_version: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Model version - tag for predictions that can be used to filter tasks in Data Manager, as well as select specific model version for showing preannotations in the labeling interface
+    """
+
+    score: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Prediction score
+    """
+
+    cluster: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Cluster for the current prediction
+    """
+
+    neighbors: typing.Optional[typing.Optional[typing.Any]] = None
+    mislabeling: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Related task mislabeling score
+    """
+
+    model: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    An ML Backend instance that created the prediction.
+    """
+
+    model_run: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    A run of a ModelVersion that created the prediction.
+    """
+
+    task: int
+    project: 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/project.py

@@ -1,9 +1,8 @@
 # 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 .prompt import Prompt
 from .user_simple import UserSimple
 import datetime as dt
 from .project_sampling import ProjectSampling
@@ -11,8 +10,13 @@ from .project_skip_queue import ProjectSkipQueue
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Project(UniversalBaseModel):
-    id: typing.Optional[int] = None
+class Project(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.
@@ -54,23 +58,12 @@ class Project(UniversalBaseModel):
     """
 
     organization: typing.Optional[int] = None
-    prompts: typing.Optional[typing.List[Prompt]] = 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)
     """
 
-    annotation_limit_count: typing.Optional[int] = pydantic.Field(default=None)
-    """
-    Maximum number of tasks that can be annotated by a single annotator in this project pause
-    """
-
-    annotation_limit_percent: typing.Optional[float] = pydantic.Field(default=None)
-    """
-    Maximum percentage of tasks in this project that can be annotated by a single annotator
-    """
-
     is_published: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Whether or not the project is published to annotators
@@ -86,14 +79,18 @@ class Project(UniversalBaseModel):
     Whether or not the project is in the middle of being created
     """
 
-    created_by: typing.Optional[UserSimple] = None
-    created_at: typing.Optional[dt.datetime] = None
+    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: typing.Optional[bool] = pydantic.Field(default=None)
+    start_training_on_annotation_update: bool = pydantic.Field()
     """
     Start model training after any annotations are submitted or updated
     """
@@ -103,37 +100,37 @@ class Project(UniversalBaseModel):
     If set, the annotator can view model predictions
     """
 
-    num_tasks_with_annotations: typing.Optional[int] = pydantic.Field(default=None)
+    num_tasks_with_annotations: int = pydantic.Field()
     """
     Tasks with annotations count
     """
 
-    task_number: typing.Optional[int] = pydantic.Field(default=None)
+    task_number: int = pydantic.Field()
     """
     Total task number in project
     """
 
-    useful_annotation_number: typing.Optional[int] = pydantic.Field(default=None)
+    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: typing.Optional[int] = pydantic.Field(default=None)
+    ground_truth_number: int = pydantic.Field()
     """
     Honeypot annotation number in project
     """
 
-    skipped_annotations_number: typing.Optional[int] = pydantic.Field(default=None)
+    skipped_annotations_number: int = pydantic.Field()
     """
     Skipped by collaborators annotation number in project
     """
 
-    total_annotations_number: typing.Optional[int] = pydantic.Field(default=None)
+    total_annotations_number: int = pydantic.Field()
     """
     Total annotations number in project including skipped_annotations_number and ground_truth_number.
     """
 
-    total_predictions_number: typing.Optional[int] = pydantic.Field(default=None)
+    total_predictions_number: int = pydantic.Field()
     """
     Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
     """
@@ -152,22 +149,14 @@ class Project(UniversalBaseModel):
     Task data credentials: password
     """
 
-    control_weights: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
-    """
-
-    parsed_label_config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    JSON-formatted labeling configuration
-    """
-
+    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: typing.Optional[bool] = pydantic.Field(default=None)
+    config_has_control_tags: bool = pydantic.Field()
     """
     Flag to detect is project ready for labeling
     """
@@ -183,13 +172,17 @@ class Project(UniversalBaseModel):
     Pinned date and time
     """
 
-    finished_task_number: typing.Optional[int] = pydantic.Field(default=None)
+    finished_task_number: int = pydantic.Field()
     """
     Finished tasks
     """
 
-    queue_total: typing.Optional[int] = None
-    queue_done: typing.Optional[int] = None
+    queue_total: int
+    queue_done: int
+    config_suitable_for_bulk_annotation: bool = pydantic.Field()
+    """
+    Flag to detect is project ready for bulk annotation
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/types/project_import.py

@@ -1,21 +1,21 @@
 # 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 .project_import_status import ProjectImportStatus
+from .status7bf_enum import Status7BfEnum
 import datetime as dt
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class ProjectImport(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    preannotated_from_fields: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+class ProjectImport(UncheckedBaseModel):
+    id: int
+    project: typing.Optional[int] = None
+    preannotated_from_fields: typing.Optional[typing.Optional[typing.Any]] = None
     commit_to_project: typing.Optional[bool] = None
     return_task_ids: typing.Optional[bool] = None
-    status: typing.Optional[ProjectImportStatus] = None
+    status: typing.Optional[Status7BfEnum] = None
     url: typing.Optional[str] = None
-    traceback: typing.Optional[str] = None
     error: typing.Optional[str] = None
     created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
@@ -36,13 +36,12 @@ class ProjectImport(UniversalBaseModel):
     annotation_count: typing.Optional[int] = None
     prediction_count: typing.Optional[int] = None
     duration: typing.Optional[int] = None
-    file_upload_ids: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    file_upload_ids: typing.Optional[typing.Optional[typing.Any]] = None
     could_be_tasks_list: typing.Optional[bool] = None
-    found_formats: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    data_columns: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    tasks: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    task_ids: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
-    project: typing.Optional[int] = 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
+    task_ids: 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

label_studio_sdk/types/project_label_config.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 pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
 
 
-class ProjectLabelConfig(UniversalBaseModel):
+class ProjectLabelConfig(UncheckedBaseModel):
     label_config: str = pydantic.Field()
     """
     Label config in XML format. See more about it in documentation

label_studio_sdk/types/project_label_config_request.py

@@ -0,0 +1,22 @@
+# 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 ProjectLabelConfigRequest(UncheckedBaseModel):
+    label_config: str = pydantic.Field()
+    """
+    Label config in XML format. See more about it in documentation
+    """
+
+    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_sampling.py

@@ -1,7 +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
 
-ProjectSampling = typing.Union[
-    typing.Literal["Sequential sampling", "Uniform sampling", "Uncertainty sampling"], typing.Any
-]
+ProjectSampling = typing.Union[SamplingEnum, NullEnum]

label_studio_sdk/types/project_skip_queue.py

@@ -1,5 +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
 
-ProjectSkipQueue = typing.Union[typing.Literal["REQUEUE_FOR_ME", "REQUEUE_FOR_OTHERS", "IGNORE_SKIPPED"], typing.Any]
+ProjectSkipQueue = typing.Union[SkipQueueEnum, NullEnum]

label_studio_sdk/types/project_subset_enum.py

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

label_studio_sdk/types/prompts_status_enum.py

@@ -0,0 +1,16 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PromptsStatusEnum = typing.Union[
+    typing.Literal[
+        "Enabled",
+        "Cloud license per organization disabled",
+        "On-premise global license disabled",
+        "Expired",
+        "Adala not connected",
+        "Disabled for this organization [FF]",
+        "unknown",
+    ],
+    typing.Any,
+]

label_studio_sdk/types/{prompt_version_provider.py → provider_enum.py}

@@ -2,6 +2,6 @@
 
 import typing
 
-PromptVersionProvider = typing.Union[
+ProviderEnum = typing.Union[
     typing.Literal["OpenAI", "AzureOpenAI", "AzureAIFoundry", "VertexAI", "Gemini", "Anthropic", "Custom"], typing.Any
 ]

label_studio_sdk/types/reason_enum.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ReasonEnum = typing.Union[
+    typing.Literal["MANUAL", "BEHAVIOR_BASED", "ANNOTATOR_EVALUATION", "ANNOTATION_LIMIT", "CUSTOM_SCRIPT"], typing.Any
+]

label_studio_sdk/types/redis_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 .redis_export_storage_status import RedisExportStorageStatus
+from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class RedisExportStorage(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    type: typing.Optional[str] = None
+class RedisExportStorage(UncheckedBaseModel):
+    id: int
+    type: str
     synchronizable: typing.Optional[bool] = None
     path: typing.Optional[str] = pydantic.Field(default=None)
     """
@@ -57,17 +57,13 @@ class RedisExportStorage(UniversalBaseModel):
     Last sync job ID
     """
 
-    status: typing.Optional[RedisExportStorageStatus] = 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
@@ -78,7 +74,7 @@ class RedisExportStorage(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/redis_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 .redis_import_storage_status import RedisImportStorageStatus
+from .status_c5a_enum import StatusC5AEnum
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class RedisImportStorage(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    type: typing.Optional[str] = None
+class RedisImportStorage(UncheckedBaseModel):
+    id: int
+    type: str
     synchronizable: typing.Optional[bool] = None
     path: typing.Optional[str] = pydantic.Field(default=None)
     """
@@ -57,17 +57,13 @@ class RedisImportStorage(UniversalBaseModel):
     Last sync job ID
     """
 
-    status: typing.Optional[RedisImportStorageStatus] = 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
@@ -78,7 +74,7 @@ class RedisImportStorage(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/refined_prompt_response.py

@@ -1,14 +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 .refined_prompt_response_refinement_status import RefinedPromptResponseRefinementStatus
-from .prompt_version import PromptVersion
+from .third_party_model_version import ThirdPartyModelVersion
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class RefinedPromptResponse(UniversalBaseModel):
+class RefinedPromptResponse(UncheckedBaseModel):
     title: typing.Optional[str] = pydantic.Field(default=None)
     """
     Title of the refined prompt
@@ -29,7 +28,7 @@ class RefinedPromptResponse(UniversalBaseModel):
     Unique identifier for the refinement job
     """
 
-    refinement_status: typing.Optional[RefinedPromptResponseRefinementStatus] = pydantic.Field(default=None)
+    refinement_status: typing.Optional[str] = pydantic.Field(default=None)
     """
     Status of the refinement job
     """
@@ -39,7 +38,7 @@ class RefinedPromptResponse(UniversalBaseModel):
     Total cost of the refinement job (in USD)
     """
 
-    previous_version: typing.Optional[PromptVersion] = pydantic.Field(default=None)
+    previous_version: typing.Optional[ThirdPartyModelVersion] = pydantic.Field(default=None)
     """
     Previous version of the prompt
     """

label_studio_sdk/types/requeue_rejected_tasks_mode_enum.py

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

label_studio_sdk/types/review_criteria_enum.py

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

label_studio_sdk/types/review_settings.py

@@ -0,0 +1,80 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .review_settings_review_criteria import ReviewSettingsReviewCriteria
+import pydantic
+from .review_settings_requeue_rejected_tasks_mode import ReviewSettingsRequeueRejectedTasksMode
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ReviewSettings(UncheckedBaseModel):
+    id: int
+    requeue_rejected_tasks_to_annotator: bool
+    review_criteria: typing.Optional[ReviewSettingsReviewCriteria] = pydantic.Field(default=None)
+    """
+    Criteria to mark task as reviewed
+    
+    * `all` - Task is reviewed if all annotations are reviewed
+    * `one` - Task is reviewed if at least one annotation is reviewed
+    """
+
+    anonymize_annotations: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Hide annotator names from annotations while review
+    """
+
+    only_finished_tasks: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show only finished tasks in the review stream
+    """
+
+    instruction: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Reviewer instructions in HTML format
+    """
+
+    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show instructions to the reviewers before they start
+    """
+
+    show_data_manager_to_reviewers: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show the data manager to reviewers
+    """
+
+    show_agreement_to_reviewers: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Show the agreement column to reviewers
+    """
+
+    require_comment_on_reject: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    If set, the reviewer must leave a comment on reject
+    """
+
+    requeue_rejected_tasks_mode: typing.Optional[ReviewSettingsRequeueRejectedTasksMode] = pydantic.Field(default=None)
+    """
+    Requeue mode for rejected tasks
+    
+    * `requeue` - Requeue
+    * `remove` - Remove
+    * `flexible` - Flexible
+    """
+
+    review_only_manual_assignments: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    When set True, review queue is built only from manually assigned tasks
+    """
+
+    project: 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