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

label_studio_sdk/types/model_provider_connection.py

@@ -1,30 +1,56 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-from .model_provider_connection_provider import ModelProviderConnectionProvider
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .user_simple import UserSimple
+import pydantic
 import typing
-from .model_provider_connection_scope import ModelProviderConnectionScope
-from .model_provider_connection_organization import ModelProviderConnectionOrganization
-from .model_provider_connection_created_by import ModelProviderConnectionCreatedBy
+from .provider_enum import ProviderEnum
+from .scope_enum import ScopeEnum
 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(UniversalBaseModel):
-    provider: ModelProviderConnectionProvider
-    api_key: typing.Optional[str] = None
-    deployment_name: typing.Optional[str] = None
-    endpoint: typing.Optional[str] = None
-    scope: typing.Optional[ModelProviderConnectionScope] = None
-    organization: typing.Optional[ModelProviderConnectionOrganization] = None
-    created_by: typing.Optional[ModelProviderConnectionCreatedBy] = None
-    created_at: typing.Optional[dt.datetime] = None
-    updated_at: typing.Optional[dt.datetime] = None
+class ModelProviderConnection(UncheckedBaseModel):
+    id: int
+    created_by: UserSimple
+    model_params: str = pydantic.Field()
+    """
+    JSON schema for the model parameters available for the provider
+    """
+
+    provider: typing.Optional[ProviderEnum] = None
+    deployment_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Azure OpenAI deployment name
+    """
+
+    endpoint: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Azure OpenAI endpoint
+    """
+
+    google_project_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google project ID
+    """
+
+    google_location: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google project location
+    """
+
+    cached_available_models: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    List of available models from the provider
+    """
+
+    scope: typing.Optional[ScopeEnum] = None
+    created_at: dt.datetime
+    updated_at: dt.datetime
     is_internal: typing.Optional[bool] = pydantic.Field(default=None)
     """
-    Whether the model provider connection is internal, not visible to the user.
+    Whether the model provider connection is internal, not visible to the user
     """
 
     budget_limit: typing.Optional[float] = pydantic.Field(default=None)
@@ -40,6 +66,9 @@ class ModelProviderConnection(UniversalBaseModel):
     budget_reset_period: typing.Optional[ModelProviderConnectionBudgetResetPeriod] = pydantic.Field(default=None)
     """
     Budget reset period for the model provider connection (null if not reset)
+    
+    * `Monthly` - Monthly
+    * `Yearly` - Yearly
     """
 
     budget_total_spent: typing.Optional[float] = pydantic.Field(default=None)
@@ -52,6 +81,8 @@ class ModelProviderConnection(UniversalBaseModel):
     Budget alert threshold for the given provider connection
     """
 
+    organization: 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:

label_studio_sdk/types/model_provider_connection_budget_reset_period.py

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

label_studio_sdk/types/model_provider_connection_request.py

@@ -0,0 +1,71 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .provider_enum import ProviderEnum
+import pydantic
+from .scope_enum import ScopeEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ModelProviderConnectionRequest(UncheckedBaseModel):
+    provider: typing.Optional[ProviderEnum] = None
+    api_key: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Model provider API key
+    """
+
+    auth_token: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Model provider Auth token
+    """
+
+    deployment_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Azure OpenAI deployment name
+    """
+
+    endpoint: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Azure OpenAI endpoint
+    """
+
+    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_location: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Google project location
+    """
+
+    cached_available_models: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    List of available models from the provider
+    """
+
+    scope: typing.Optional[ScopeEnum] = None
+    is_internal: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the model provider connection is internal, not visible to the user
+    """
+
+    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_run.py

@@ -0,0 +1,40 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .project_subset_enum import ProjectSubsetEnum
+from .model_run_status_enum import ModelRunStatusEnum
+import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ModelRun(UncheckedBaseModel):
+    id: int
+    parent_model: int
+    project_subset: typing.Optional[ProjectSubsetEnum] = None
+    status: ModelRunStatusEnum
+    job_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Job ID for inference job for a ModelRun e.g. Adala job ID
+    """
+
+    total_predictions: typing.Optional[int] = None
+    total_correct_predictions: typing.Optional[int] = None
+    total_tasks: typing.Optional[int] = None
+    created_at: dt.datetime
+    triggered_at: typing.Optional[dt.datetime] = None
+    predictions_updated_at: typing.Optional[dt.datetime] = None
+    completed_at: typing.Optional[dt.datetime] = None
+    organization: typing.Optional[int] = None
+    project: int
+    created_by: 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/{inference_run_status.py → model_run_status_enum.py}

@@ -2,6 +2,6 @@
 
 import typing
 
-InferenceRunStatus = typing.Union[
+ModelRunStatusEnum = typing.Union[
     typing.Literal["Pending", "InProgress", "Completed", "Failed", "Canceled"], typing.Any
 ]

label_studio_sdk/types/null_enum.py

@@ -0,0 +1,3 @@
+# This file was auto-generated by Fern from our API Definition.
+
+NullEnum = str

label_studio_sdk/types/onboarding_state_enum.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+OnboardingStateEnum = typing.Union[
+    typing.Literal["not_started", "signup", "trial_signup", "first_tutorial", "in_app_guidance", "complete"], typing.Any
+]

label_studio_sdk/types/organization_billing.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+import pydantic
+
+
+class OrganizationBilling(UncheckedBaseModel):
+    manual_workspace_management: str
+    manual_role_management: 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_id.py

@@ -0,0 +1,28 @@
+# 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 ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class OrganizationId(UncheckedBaseModel):
+    """
+    A serializer mixin that takes an additional `fields` argument that controls
+    which fields should be displayed.
+    """
+
+    id: int
+    title: str
+    contact_info: typing.Optional[str] = None
+    created_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/organization_invite.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class OrganizationInvite(UncheckedBaseModel):
+    token: typing.Optional[str] = None
+    invite_url: typing.Optional[str] = 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/organization_member.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import pydantic
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing
+
+
+class OrganizationMember(UncheckedBaseModel):
+    """
+    A serializer mixin that takes an additional `fields` argument that controls
+    which fields should be displayed.
+    """
+
+    user: int = pydantic.Field()
+    """
+    User ID
+    """
+
+    organization: int = pydantic.Field()
+    """
+    Organization ID
+    """
+
+    contributed_projects_count: str
+    annotations_count: str
+    created_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/organization_membership.py

@@ -0,0 +1,24 @@
+# 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 OrganizationMembership(UncheckedBaseModel):
+    role: str
+    active: str
+    organization_id: int = pydantic.Field()
+    """
+    Organization ID
+    """
+
+    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/{projects/types/projects_list_response.py → types/paginated_all_roles_project_list_list.py}

@@ -1,17 +1,17 @@
 # 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 ...types.project import Project
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from .all_roles_project_list import AllRolesProjectList
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import pydantic
 
 
-class ProjectsListResponse(UniversalBaseModel):
+class PaginatedAllRolesProjectListList(UncheckedBaseModel):
     count: int
     next: typing.Optional[str] = None
     previous: typing.Optional[str] = None
-    results: typing.List[Project]
+    results: typing.List[AllRolesProjectList]
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/types/paginated_lse_organization_member_list_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_organization_member_list import LseOrganizationMemberList
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class PaginatedLseOrganizationMemberListList(UncheckedBaseModel):
+    count: int
+    next: typing.Optional[str] = None
+    previous: typing.Optional[str] = None
+    results: typing.List[LseOrganizationMemberList]
+
+    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/{jwt_settings_response.py → paginated_role_based_task_list.py}

@@ -1,25 +1,27 @@
 # 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 .role_based_task import RoleBasedTask
 import pydantic
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
-import typing
 
 
-class JwtSettingsResponse(UniversalBaseModel):
-    api_tokens_enabled: bool = pydantic.Field()
+class PaginatedRoleBasedTaskList(UncheckedBaseModel):
+    tasks: typing.List[RoleBasedTask]
+    total: int = pydantic.Field()
     """
-    Whether JWT API tokens are enabled
+    Total number of tasks
     """
 
-    legacy_api_tokens_enabled: bool = pydantic.Field()
+    total_annotations: int = pydantic.Field()
     """
-    Whether legacy API tokens are enabled
+    Total number of annotations
     """
 
-    api_token_ttl_days: int = pydantic.Field()
+    total_predictions: int = pydantic.Field()
     """
-    Number of days before API tokens expire
+    Total number of predictions
     """
 
     if IS_PYDANTIC_V2:

label_studio_sdk/types/pause.py

@@ -1,28 +1,69 @@
 # 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 .pause_paused_by import PausePausedBy
 import pydantic
+from .user_simple import UserSimple
+from .reason_enum import ReasonEnum
 import datetime as dt
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Pause(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    project: typing.Optional[int] = None
-    user: typing.Optional[int] = None
-    paused_by: typing.Optional[PausePausedBy] = pydantic.Field(default=None)
+class Pause(UncheckedBaseModel):
     """
-    User who created the pause
+    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
     """
 
-    reason: str
-    verbose_reason: typing.Optional[str] = None
-    deleted_by: typing.Optional[int] = None
-    deleted_at: typing.Optional[dt.datetime] = None
-    created_at: typing.Optional[dt.datetime] = None
-    updated_at: typing.Optional[dt.datetime] = None
+    id: int
+    project: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Related project for which the pause is set
+    """
+
+    user: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    User who is paused
+    """
+
+    paused_by: UserSimple
+    reason: ReasonEnum = pydantic.Field()
+    """
+    Reason for pausing
+    
+    * `MANUAL` - Manual
+    * `BEHAVIOR_BASED` - Behavior-based
+    * `ANNOTATOR_EVALUATION` - Annotator evaluation
+    * `ANNOTATION_LIMIT` - Annotation limit
+    * `CUSTOM_SCRIPT` - Custom script
+    """
+
+    verbose_reason: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Detailed description of why the project is paused, will be readable by paused annotators
+    """
+
+    deleted_by: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    User who soft-deleted this pause record
+    """
+
+    deleted_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when this pause record was soft-deleted
+    """
+
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Timestamp when this pause record was created
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Timestamp when this pause record was last updated
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/types/pause_request.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .reason_enum import ReasonEnum
+import pydantic
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class PauseRequest(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
+    """
+
+    reason: ReasonEnum = pydantic.Field()
+    """
+    Reason for pausing
+    
+    * `MANUAL` - Manual
+    * `BEHAVIOR_BASED` - Behavior-based
+    * `ANNOTATOR_EVALUATION` - Annotator evaluation
+    * `ANNOTATION_LIMIT` - Annotation limit
+    * `CUSTOM_SCRIPT` - Custom script
+    """
+
+    verbose_reason: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Detailed description of why the project is paused, will be readable by paused annotators
+    """
+
+    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/prediction.py

@@ -1,14 +1,14 @@
 # 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 ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class Prediction(UniversalBaseModel):
-    id: typing.Optional[int] = None
+class Prediction(UncheckedBaseModel):
+    id: int
     result: typing.List[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field()
     """
     List of prediction results for the task
@@ -19,7 +19,7 @@ class Prediction(UniversalBaseModel):
     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.Field(default=None)
+    created_ago: str = pydantic.Field()
     """
     Delta time from creation time
     """
@@ -34,18 +34,14 @@ class Prediction(UniversalBaseModel):
     Cluster for the current prediction
     """
 
-    neighbors: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
-    """
-    Array of task IDs of the closest neighbors
-    """
-
+    neighbors: typing.Optional[typing.Optional[typing.Any]] = 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
+    created_at: dt.datetime
+    updated_at: dt.datetime
     model: typing.Optional[int] = pydantic.Field(default=None)
     """
     An ML Backend instance that created the prediction.