label-studio-sdk 1.0.7__py3-none-any.whl → 1.0.10__py3-none-any.whl

label_studio_sdk/types/ml_backend.py

@@ -1,89 +1,80 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
+from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-
-from ..core.datetime_utils import serialize_datetime
-from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
-from .ml_backend_auth_method import MlBackendAuthMethod
 from .ml_backend_state import MlBackendState
+import pydantic
+from .ml_backend_auth_method import MlBackendAuthMethod
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class MlBackend(pydantic_v1.BaseModel):
+class MlBackend(UniversalBaseModel):
     id: typing.Optional[int] = None
     state: typing.Optional[MlBackendState] = None
     readable_state: typing.Optional[str] = None
-    is_interactive: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    is_interactive: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Used to interactively annotate tasks. If true, model returns one list with results
     """
 
-    url: str = pydantic_v1.Field()
+    url: str = pydantic.Field()
     """
     URL for the machine learning model server
     """
 
-    error_message: typing.Optional[str] = pydantic_v1.Field(default=None)
+    error_message: typing.Optional[str] = pydantic.Field(default=None)
     """
     Error message in error state
     """
 
-    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
     Name of the machine learning backend
     """
 
     auth_method: typing.Optional[MlBackendAuthMethod] = None
-    basic_auth_user: typing.Optional[str] = pydantic_v1.Field(default=None)
+    basic_auth_user: typing.Optional[str] = pydantic.Field(default=None)
     """
     HTTP Basic Auth user
     """
 
     basic_auth_pass: typing.Optional[str] = None
     basic_auth_pass_is_set: typing.Optional[str] = None
-    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
     Description for the machine learning backend
     """
 
-    extra_params: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    extra_params: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
     """
     Any extra parameters passed to the ML Backend during the setup
     """
 
-    model_version: typing.Optional[str] = pydantic_v1.Field(default=None)
+    model_version: typing.Optional[str] = pydantic.Field(default=None)
     """
     Current model version associated with this machine learning backend
     """
 
-    timeout: typing.Optional[float] = pydantic_v1.Field(default=None)
+    timeout: typing.Optional[float] = pydantic.Field(default=None)
     """
     Response model timeout
     """
 
     created_at: typing.Optional[dt.datetime] = None
     updated_at: typing.Optional[dt.datetime] = None
-    auto_update: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    auto_update: typing.Optional[bool] = pydantic.Field(default=None)
     """
     If false, model version is set by the user, if true - getting latest version from backend.
     """
 
     project: int
 
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().json(**kwargs_with_defaults)
-
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
-        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
-
-        return deep_union_pydantic_dicts(
-            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_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_v1.Extra.allow
-        json_encoders = {dt.datetime: serialize_datetime}
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/model_provider_connection.py

@@ -1,17 +1,18 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
-import typing
-
-from ..core.datetime_utils import serialize_datetime
-from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
-from .model_provider_connection_created_by import ModelProviderConnectionCreatedBy
-from .model_provider_connection_organization import ModelProviderConnectionOrganization
+from ..core.pydantic_utilities import UniversalBaseModel
 from .model_provider_connection_provider import ModelProviderConnectionProvider
+import typing
 from .model_provider_connection_scope import ModelProviderConnectionScope
+from .model_provider_connection_organization import ModelProviderConnectionOrganization
+from .model_provider_connection_created_by import ModelProviderConnectionCreatedBy
+import datetime as dt
+import pydantic
+from .model_provider_connection_budget_reset_period import ModelProviderConnectionBudgetResetPeriod
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class ModelProviderConnection(pydantic_v1.BaseModel):
+class ModelProviderConnection(UniversalBaseModel):
     provider: ModelProviderConnectionProvider
     api_key: typing.Optional[str] = None
     deployment_name: typing.Optional[str] = None
@@ -21,21 +22,41 @@ class ModelProviderConnection(pydantic_v1.BaseModel):
     created_by: typing.Optional[ModelProviderConnectionCreatedBy] = None
     created_at: typing.Optional[dt.datetime] = None
     updated_at: typing.Optional[dt.datetime] = None
-
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().json(**kwargs_with_defaults)
-
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
-        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
-
-        return deep_union_pydantic_dicts(
-            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
-        )
-
-    class Config:
-        frozen = True
-        smart_union = True
-        extra = pydantic_v1.Extra.allow
-        json_encoders = {dt.datetime: serialize_datetime}
+    is_internal: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the model provider connection is internal, not visible to the user.
+    """
+
+    budget_limit: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Budget limit for the model provider connection (null if unlimited)
+    """
+
+    budget_last_reset_date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Date and time the budget was last reset
+    """
+
+    budget_reset_period: typing.Optional[ModelProviderConnectionBudgetResetPeriod] = pydantic.Field(default=None)
+    """
+    Budget reset period for the model provider connection (null if not reset)
+    """
+
+    budget_total_spent: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Tracked total budget spent for the given provider connection within the current budget period
+    """
+
+    budget_alert_threshold: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Budget alert threshold for the given provider connection
+    """
+
+    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/model_provider_connection_budget_reset_period.py

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

label_studio_sdk/types/model_provider_connection_created_by.py

@@ -2,4 +2,4 @@
 
 import typing
 
-ModelProviderConnectionCreatedBy = typing.Union[int, typing.Dict[str, typing.Any]]
+ModelProviderConnectionCreatedBy = typing.Union[int, typing.Dict[str, typing.Optional[typing.Any]]]

label_studio_sdk/types/model_provider_connection_organization.py

@@ -2,4 +2,4 @@
 
 import typing
 
-ModelProviderConnectionOrganization = typing.Union[int, typing.Dict[str, typing.Any]]
+ModelProviderConnectionOrganization = typing.Union[int, typing.Dict[str, typing.Optional[typing.Any]]]

label_studio_sdk/types/model_provider_connection_provider.py

@@ -2,4 +2,6 @@
 
 import typing
 
-ModelProviderConnectionProvider = typing.Union[typing.Literal["OpenAI", "AzureOpenAI"], typing.Any]
+ModelProviderConnectionProvider = typing.Union[
+    typing.Literal["OpenAI", "AzureOpenAI", "VertexAI", "Gemini", "Custom"], typing.Any
+]

label_studio_sdk/types/prediction.py

@@ -1,57 +1,57 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
+from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-
-from ..core.datetime_utils import serialize_datetime
-from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Prediction(pydantic_v1.BaseModel):
+class Prediction(UniversalBaseModel):
     id: typing.Optional[int] = None
-    result: typing.List[typing.Dict[str, typing.Any]] = pydantic_v1.Field()
+    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_v1.Field(default=None)
+    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
     """
 
-    created_ago: typing.Optional[str] = pydantic_v1.Field(default=None)
+    created_ago: typing.Optional[str] = pydantic.Field(default=None)
     """
     Delta time from creation time
     """
 
-    score: typing.Optional[float] = pydantic_v1.Field(default=None)
+    score: typing.Optional[float] = pydantic.Field(default=None)
     """
     Prediction score
     """
 
-    cluster: typing.Optional[int] = pydantic_v1.Field(default=None)
+    cluster: typing.Optional[int] = pydantic.Field(default=None)
     """
     Cluster for the current prediction
     """
 
-    neighbors: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    neighbors: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
     """
     Array of task IDs of the closest neighbors
     """
 
-    mislabeling: typing.Optional[float] = pydantic_v1.Field(default=None)
+    mislabeling: typing.Optional[float] = pydantic.Field(default=None)
     """
     Related task mislabeling score
     """
 
     created_at: typing.Optional[dt.datetime] = None
     updated_at: typing.Optional[dt.datetime] = None
-    model: typing.Optional[int] = pydantic_v1.Field(default=None)
+    model: typing.Optional[int] = pydantic.Field(default=None)
     """
     An ML Backend instance that created the prediction.
     """
 
-    model_run: typing.Optional[int] = pydantic_v1.Field(default=None)
+    model_run: typing.Optional[int] = pydantic.Field(default=None)
     """
     A run of a ModelVersion that created the prediction.
     """
@@ -59,20 +59,11 @@ class Prediction(pydantic_v1.BaseModel):
     task: int
     project: typing.Optional[int] = None
 
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().json(**kwargs_with_defaults)
-
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
-        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
-
-        return deep_union_pydantic_dicts(
-            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_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_v1.Extra.allow
-        json_encoders = {dt.datetime: serialize_datetime}
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/types/project.py

@@ -1,127 +1,129 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
+from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-
-from ..core.datetime_utils import serialize_datetime
-from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+import pydantic
+from .prompt import Prompt
+from .user_simple import UserSimple
+import datetime as dt
 from .project_sampling import ProjectSampling
 from .project_skip_queue import ProjectSkipQueue
-from .user_simple import UserSimple
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Project(pydantic_v1.BaseModel):
+class Project(UniversalBaseModel):
     id: typing.Optional[int] = None
-    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    title: typing.Optional[str] = pydantic.Field(default=None)
     """
     Project name. Must be between 3 and 50 characters long.
     """
 
-    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
     Project description
     """
 
-    label_config: typing.Optional[str] = pydantic_v1.Field(default=None)
+    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_v1.Field(default=None)
+    expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
     """
     Labeling instructions in HTML format
     """
 
-    show_instruction: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Show instructions to the annotator before they start
     """
 
-    show_skip_button: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    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_v1.Field(default=None)
+    enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Allow annotators to submit empty annotations
     """
 
-    show_annotation_history: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Show annotation history to annotator
     """
 
     organization: typing.Optional[int] = None
+    prompts: typing.Optional[typing.List[Prompt]] = None
     color: typing.Optional[str] = None
-    maximum_annotations: typing.Optional[int] = pydantic_v1.Field(default=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_v1.Field(default=None)
+    is_published: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Whether or not the project is published to annotators
     """
 
-    model_version: typing.Optional[str] = pydantic_v1.Field(default=None)
+    model_version: typing.Optional[str] = pydantic.Field(default=None)
     """
     Machine learning model version
     """
 
-    is_draft: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    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] = None
     created_at: typing.Optional[dt.datetime] = None
-    min_annotations_to_start_training: typing.Optional[int] = pydantic_v1.Field(default=None)
+    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[str] = pydantic_v1.Field(default=None)
+    start_training_on_annotation_update: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Start model training after any annotations are submitted or updated
     """
 
-    show_collab_predictions: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
     """
     If set, the annotator can view model predictions
     """
 
-    num_tasks_with_annotations: typing.Optional[int] = pydantic_v1.Field(default=None)
+    num_tasks_with_annotations: typing.Optional[int] = pydantic.Field(default=None)
     """
     Tasks with annotations count
     """
 
-    task_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    task_number: typing.Optional[int] = pydantic.Field(default=None)
     """
     Total task number in project
     """
 
-    useful_annotation_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    useful_annotation_number: typing.Optional[int] = 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
     """
 
-    ground_truth_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    ground_truth_number: typing.Optional[int] = pydantic.Field(default=None)
     """
     Honeypot annotation number in project
     """
 
-    skipped_annotations_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    skipped_annotations_number: typing.Optional[int] = pydantic.Field(default=None)
     """
     Skipped by collaborators annotation number in project
     """
 
-    total_annotations_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    total_annotations_number: typing.Optional[int] = pydantic.Field(default=None)
     """
     Total annotations number in project including skipped_annotations_number and ground_truth_number.
     """
 
-    total_predictions_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    total_predictions_number: typing.Optional[int] = pydantic.Field(default=None)
     """
     Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
     """
@@ -130,69 +132,60 @@ class Project(pydantic_v1.BaseModel):
     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_v1.Field(default=None)
+    task_data_login: typing.Optional[str] = pydantic.Field(default=None)
     """
     Task data credentials: login
     """
 
-    task_data_password: typing.Optional[str] = pydantic_v1.Field(default=None)
+    task_data_password: typing.Optional[str] = pydantic.Field(default=None)
     """
     Task data credentials: password
     """
 
-    control_weights: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    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 it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}
     """
 
-    parsed_label_config: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    parsed_label_config: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
     """
     JSON-formatted labeling configuration
     """
 
-    evaluate_predictions_automatically: typing.Optional[bool] = pydantic_v1.Field(default=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[str] = pydantic_v1.Field(default=None)
+    config_has_control_tags: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Flag to detect is project ready for labeling
     """
 
     skip_queue: typing.Optional[ProjectSkipQueue] = None
-    reveal_preannotations_interactively: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Reveal pre-annotations interactively
     """
 
-    pinned_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    pinned_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
     """
     Pinned date and time
     """
 
-    finished_task_number: typing.Optional[int] = pydantic_v1.Field(default=None)
+    finished_task_number: typing.Optional[int] = pydantic.Field(default=None)
     """
     Finished tasks
     """
 
-    queue_total: typing.Optional[str] = None
-    queue_done: typing.Optional[str] = None
-
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().json(**kwargs_with_defaults)
-
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
-        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+    queue_total: typing.Optional[int] = None
+    queue_done: typing.Optional[int] = None
 
-        return deep_union_pydantic_dicts(
-            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_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_v1.Extra.allow
-        json_encoders = {dt.datetime: serialize_datetime}
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow