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

label_studio_sdk/types/lse_task_serializer_for_reviewers.py

@@ -0,0 +1,117 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .lse_task_serializer_for_reviewers_predictions_item import LseTaskSerializerForReviewersPredictionsItem
+import pydantic
+from .lse_task_serializer_for_reviewers_drafts_item import LseTaskSerializerForReviewersDraftsItem
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class LseTaskSerializerForReviewers(UncheckedBaseModel):
+    """
+    Task Serializer with project scheme configs validation
+    """
+
+    id: int
+    agreement: str
+    predictions: typing.List[LseTaskSerializerForReviewersPredictionsItem] = pydantic.Field()
+    """
+    Predictions for this task
+    """
+
+    annotations: str
+    drafts: typing.List[LseTaskSerializerForReviewersDraftsItem] = pydantic.Field()
+    """
+    Drafts for this task
+    """
+
+    annotators: typing.List[int] = pydantic.Field()
+    """
+    Annotators IDs who annotated this task
+    """
+
+    inner_id: typing.Optional[int] = None
+    cancelled_annotations: typing.Optional[int] = None
+    total_annotations: typing.Optional[int] = None
+    total_predictions: typing.Optional[int] = None
+    completed_at: typing.Optional[dt.datetime] = None
+    annotations_results: str
+    predictions_results: str
+    predictions_score: typing.Optional[float] = None
+    file_upload: str
+    storage_filename: str
+    annotations_ids: str
+    predictions_model_versions: str
+    avg_lead_time: typing.Optional[float] = None
+    draft_exists: typing.Optional[bool] = None
+    updated_by: typing.List[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field()
+    """
+    User IDs who updated this task
+    """
+
+    reviewers: typing.List[typing.Dict[str, typing.Optional[typing.Any]]]
+    comments: str
+    comment_authors: typing.List[typing.Dict[str, typing.Optional[typing.Any]]]
+    reviewed: typing.Optional[bool] = None
+    reviews_accepted: typing.Optional[int] = None
+    reviews_rejected: typing.Optional[int] = None
+    ground_truth: typing.Optional[bool] = None
+    annotators_count: int = pydantic.Field()
+    """
+    The annotators_count is calculated as the number of users with annotations (can be repeated, so same as the number of annotations) + the number of assignees without annotations.
+    """
+
+    reviewers_count: int
+    comment_authors_count: int
+    data: typing.Optional[typing.Any] = None
+    meta: typing.Optional[typing.Optional[typing.Any]] = None
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Time a task was created
+    """
+
+    updated_at: dt.datetime = pydantic.Field()
+    """
+    Last time a task was updated
+    """
+
+    is_labeled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project
+    """
+
+    overlap: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of distinct annotators that processed the current task
+    """
+
+    comment_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of comments in the task including all annotations
+    """
+
+    unresolved_comment_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of unresolved comments in the task including all annotations
+    """
+
+    last_comment_updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    When the last comment was updated
+    """
+
+    project: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Project ID for this task
+    """
+
+    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_task_serializer_for_reviewers_drafts_item.py

@@ -0,0 +1,22 @@
+# 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 LseTaskSerializerForReviewersDraftsItem(UncheckedBaseModel):
+    result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
+    created_at: typing.Optional[dt.datetime] = None
+    updated_at: typing.Optional[dt.datetime] = 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/lse_task_serializer_for_reviewers_predictions_item.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 LseTaskSerializerForReviewersPredictionsItem(UncheckedBaseModel):
+    result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = None
+    score: typing.Optional[float] = None
+    model_version: typing.Optional[str] = None
+    model: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    model_run: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    task: typing.Optional[int] = None
+    project: typing.Optional[int] = None
+    created_at: typing.Optional[dt.datetime] = None
+    updated_at: typing.Optional[dt.datetime] = 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/lse_user.py

@@ -0,0 +1,49 @@
+# 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 .organization_membership import OrganizationMembership
+from .lse_fields import LseFields
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class LseUser(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
+    """
+
+    id: int
+    first_name: typing.Optional[str] = None
+    last_name: typing.Optional[str] = None
+    username: str
+    email: typing.Optional[str] = None
+    last_activity: dt.datetime
+    custom_hotkeys: typing.Optional[typing.Optional[typing.Any]] = None
+    avatar: str
+    initials: str
+    phone: typing.Optional[str] = None
+    active_organization: typing.Optional[int] = None
+    active_organization_meta: str
+    allow_newsletters: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Allow sending newsletters to user
+    """
+
+    date_joined: typing.Optional[dt.datetime] = None
+    org_membership: typing.List[OrganizationMembership]
+    lse_fields: LseFields
+    pause: 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/{base_user.py → lse_user_api.py}

@@ -1,29 +1,40 @@
 # 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 datetime as dt
 import pydantic
+from .organization_membership import OrganizationMembership
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class BaseUser(UniversalBaseModel):
-    id: typing.Optional[int] = None
+class LseUserApi(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
+    """
+
+    id: int
     first_name: typing.Optional[str] = None
     last_name: typing.Optional[str] = None
     username: str
     email: typing.Optional[str] = None
-    last_activity: typing.Optional[dt.datetime] = None
-    avatar: typing.Optional[str] = None
-    initials: typing.Optional[str] = None
+    last_activity: dt.datetime
+    custom_hotkeys: typing.Optional[typing.Optional[typing.Any]] = None
+    avatar: str
+    initials: str
     phone: typing.Optional[str] = None
     active_organization: typing.Optional[int] = None
+    active_organization_meta: str
     allow_newsletters: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Allow sending newsletters to user
     """
 
     date_joined: typing.Optional[dt.datetime] = None
+    org_membership: typing.List[OrganizationMembership]
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

label_studio_sdk/types/lseapi_token_create.py

@@ -0,0 +1,21 @@
+# 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 LseapiTokenCreate(UncheckedBaseModel):
+    token: str
+    created_at: str
+    expires_at: 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/lseapi_token_list.py

@@ -0,0 +1,21 @@
+# 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 LseapiTokenList(UncheckedBaseModel):
+    token: str
+    created_at: str
+    expires_at: 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/lsejwt_settings.py

@@ -0,0 +1,32 @@
+# 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 LsejwtSettings(UncheckedBaseModel):
+    api_tokens_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Enable JWT API token authentication for this organization
+    """
+
+    legacy_api_tokens_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Enable legacy API token authentication for this organization
+    """
+
+    api_token_ttl_days: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of days before JWT API tokens expire
+    """
+
+    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/maybe_expanded_comment.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from .comment import Comment
+from .comment_serializer_with_expanded_user import CommentSerializerWithExpandedUser
+
+MaybeExpandedComment = typing.Union[Comment, CommentSerializerWithExpandedUser]

label_studio_sdk/types/ml_backend.py

@@ -1,18 +1,22 @@
 # 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 .ml_backend_state import MlBackendState
+from .state_enum import StateEnum
 import pydantic
-from .ml_backend_auth_method import MlBackendAuthMethod
+from .auth_method_enum import AuthMethodEnum
 import datetime as dt
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class MlBackend(UniversalBaseModel):
-    id: typing.Optional[int] = None
-    state: typing.Optional[MlBackendState] = None
-    readable_state: typing.Optional[str] = None
+class MlBackend(UncheckedBaseModel):
+    """
+    Serializer for MLBackend model.
+    """
+
+    id: int
+    state: typing.Optional[StateEnum] = None
+    readable_state: str
     is_interactive: typing.Optional[bool] = pydantic.Field(default=None)
     """
     Used to interactively annotate tasks. If true, model returns one list with results
@@ -33,24 +37,19 @@ class MlBackend(UniversalBaseModel):
     Name of the machine learning backend
     """
 
-    auth_method: typing.Optional[MlBackendAuthMethod] = None
+    auth_method: typing.Optional[AuthMethodEnum] = 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
+    basic_auth_pass_is_set: str
     description: typing.Optional[str] = pydantic.Field(default=None)
     """
     Description for the machine learning backend
     """
 
-    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
-    """
-
+    extra_params: typing.Optional[typing.Optional[typing.Any]] = None
     model_version: typing.Optional[str] = pydantic.Field(default=None)
     """
     Current model version associated with this machine learning backend
@@ -61,8 +60,8 @@ class MlBackend(UniversalBaseModel):
     Response model timeout
     """
 
-    created_at: typing.Optional[dt.datetime] = None
-    updated_at: typing.Optional[dt.datetime] = None
+    created_at: dt.datetime
+    updated_at: dt.datetime
     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.

label_studio_sdk/types/mode_enum.py

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

label_studio_sdk/types/model_interface.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .user_simple import UserSimple
+import pydantic
+from .skill_name_enum import SkillNameEnum
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ModelInterface(UncheckedBaseModel):
+    id: int
+    created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
+    """
+    User who created Dataset
+    """
+
+    skill_name: typing.Optional[SkillNameEnum] = None
+    title: str = pydantic.Field()
+    """
+    Model name
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Model description
+    """
+
+    created_at: dt.datetime
+    updated_at: dt.datetime
+    input_fields: typing.Optional[typing.Optional[typing.Any]] = None
+    output_classes: typing.Optional[typing.Optional[typing.Any]] = None
+    organization: typing.Optional[int] = None
+    associated_projects: typing.Optional[typing.List[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/model_interface_request.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 .user_simple_request import UserSimpleRequest
+import pydantic
+from .skill_name_enum import SkillNameEnum
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ModelInterfaceRequest(UncheckedBaseModel):
+    created_by: typing.Optional[UserSimpleRequest] = pydantic.Field(default=None)
+    """
+    User who created Dataset
+    """
+
+    skill_name: typing.Optional[SkillNameEnum] = None
+    title: str = pydantic.Field()
+    """
+    Model name
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Model description
+    """
+
+    input_fields: typing.Optional[typing.Optional[typing.Any]] = None
+    output_classes: typing.Optional[typing.Optional[typing.Any]] = None
+    organization: typing.Optional[int] = None
+    associated_projects: typing.Optional[typing.List[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/model_interface_serializer_get.py

@@ -0,0 +1,45 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.unchecked_base_model import UncheckedBaseModel
+import typing
+from .user_simple import UserSimple
+import pydantic
+from .skill_name_enum import SkillNameEnum
+from .associated_project import AssociatedProject
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class ModelInterfaceSerializerGet(UncheckedBaseModel):
+    id: int
+    created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
+    """
+    User who created Dataset
+    """
+
+    skill_name: typing.Optional[SkillNameEnum] = None
+    associated_projects: typing.Optional[typing.List[AssociatedProject]] = None
+    title: str = pydantic.Field()
+    """
+    Model name
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Model description
+    """
+
+    created_at: dt.datetime
+    updated_at: dt.datetime
+    input_fields: typing.Optional[typing.Optional[typing.Any]] = None
+    output_classes: typing.Optional[typing.Optional[typing.Any]] = None
+    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:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

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]