label-studio-sdk 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

label_studio_sdk/tasks/client_ext.py

@@ -0,0 +1,18 @@
+from .client import TasksClient, AsyncTasksClient
+from label_studio_sdk._extensions.pager_ext import SyncPagerExt, AsyncPagerExt, T
+
+
+class TasksClientExt(TasksClient):
+
+    def list(self, **kwargs) -> SyncPagerExt[T]:
+        return SyncPagerExt.from_sync_pager(super().list(**kwargs))
+
+    list.__doc__ = TasksClient.list.__doc__
+
+
+class AsyncTasksClientExt(AsyncTasksClient):
+
+    async def list(self, **kwargs):
+        return await AsyncPagerExt.from_async_pager(await super().list(**kwargs))
+
+    list.__doc__ = AsyncTasksClient.list.__doc__

label_studio_sdk/types/__init__.py

@@ -3,6 +3,8 @@
 from .annotation import Annotation
 from .annotation_filter_options import AnnotationFilterOptions
 from .annotation_last_action import AnnotationLastAction
+from .annotations_dm_field import AnnotationsDmField
+from .annotations_dm_field_last_action import AnnotationsDmFieldLastAction
 from .azure_blob_export_storage import AzureBlobExportStorage
 from .azure_blob_export_storage_status import AzureBlobExportStorageStatus
 from .azure_blob_import_storage import AzureBlobImportStorage
@@ -11,6 +13,9 @@ from .base_task import BaseTask
 from .base_user import BaseUser
 from .converted_format import ConvertedFormat
 from .converted_format_status import ConvertedFormatStatus
+from .data_manager_task_serializer import DataManagerTaskSerializer
+from .data_manager_task_serializer_drafts_item import DataManagerTaskSerializerDraftsItem
+from .data_manager_task_serializer_predictions_item import DataManagerTaskSerializerPredictionsItem
 from .export import Export
 from .export_convert import ExportConvert
 from .export_create import ExportCreate
@@ -60,6 +65,8 @@ __all__ = [
     "Annotation",
     "AnnotationFilterOptions",
     "AnnotationLastAction",
+    "AnnotationsDmField",
+    "AnnotationsDmFieldLastAction",
     "AzureBlobExportStorage",
     "AzureBlobExportStorageStatus",
     "AzureBlobImportStorage",
@@ -68,6 +75,9 @@ __all__ = [
     "BaseUser",
     "ConvertedFormat",
     "ConvertedFormatStatus",
+    "DataManagerTaskSerializer",
+    "DataManagerTaskSerializerDraftsItem",
+    "DataManagerTaskSerializerPredictionsItem",
     "Export",
     "ExportConvert",
     "ExportCreate",

label_studio_sdk/types/annotation.py

@@ -10,6 +10,11 @@ from .annotation_last_action import AnnotationLastAction
 
 class Annotation(pydantic_v1.BaseModel):
     id: typing.Optional[int] = None
+    result: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = pydantic_v1.Field(default=None)
+    """
+    List of annotation results for the task
+    """
+
     created_username: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
     Username string
@@ -22,11 +27,6 @@ class Annotation(pydantic_v1.BaseModel):
 
     completed_by: typing.Optional[int] = None
     unique_id: typing.Optional[str] = None
-    result: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
-    """
-    The main value of annotator work - labeling result in JSON format
-    """
-
     was_cancelled: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
     User skipped the task

label_studio_sdk/types/annotations_dm_field.py

@@ -0,0 +1,120 @@
+# 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 .annotations_dm_field_last_action import AnnotationsDmFieldLastAction
+
+
+class AnnotationsDmField(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    result: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = pydantic_v1.Field(default=None)
+    """
+    List of annotation results for the task
+    """
+
+    created_username: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Username string
+    """
+
+    created_ago: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Time delta from creation time
+    """
+
+    completed_by: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    User details who completed this annotation.
+    """
+
+    unique_id: typing.Optional[str] = None
+    was_cancelled: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    User skipped the task
+    """
+
+    ground_truth: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    """
+    This annotation is a Ground Truth (ground_truth)
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last updated time
+    """
+
+    draft_created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Draft creation time
+    """
+
+    lead_time: typing.Optional[float] = pydantic_v1.Field(default=None)
+    """
+    How much time it took to annotate the task
+    """
+
+    import_id: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Original annotation ID that was at the import step or NULL if this annotation wasn't imported
+    """
+
+    last_action: typing.Optional[AnnotationsDmFieldLastAction] = pydantic_v1.Field(default=None)
+    """
+    Action which was performed in the last annotation history item
+    """
+
+    task: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Corresponding task for this annotation
+    """
+
+    project: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Project ID for this annotation
+    """
+
+    updated_by: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Last user who updated this annotation
+    """
+
+    parent_prediction: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Points to the prediction from which this annotation was created
+    """
+
+    parent_annotation: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Points to the parent annotation from which this annotation was created
+    """
+
+    last_created_by: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    User who created the last annotation history item
+    """
+
+    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}

label_studio_sdk/types/annotations_dm_field_last_action.py

@@ -0,0 +1,19 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+AnnotationsDmFieldLastAction = typing.Union[
+    typing.Literal[
+        "prediction",
+        "propagated_annotation",
+        "imported",
+        "submitted",
+        "updated",
+        "skipped",
+        "accepted",
+        "rejected",
+        "fixed_and_accepted",
+        "deleted_review",
+    ],
+    typing.Any,
+]

label_studio_sdk/types/data_manager_task_serializer.py

@@ -0,0 +1,123 @@
+# 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 .annotations_dm_field import AnnotationsDmField
+from .data_manager_task_serializer_drafts_item import DataManagerTaskSerializerDraftsItem
+from .data_manager_task_serializer_predictions_item import DataManagerTaskSerializerPredictionsItem
+
+
+class DataManagerTaskSerializer(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    predictions: typing.Optional[typing.List[DataManagerTaskSerializerPredictionsItem]] = pydantic_v1.Field(
+        default=None
+    )
+    """
+    Predictions for this task
+    """
+
+    annotations: typing.Optional[typing.List[AnnotationsDmField]] = None
+    drafts: typing.Optional[typing.List[DataManagerTaskSerializerDraftsItem]] = pydantic_v1.Field(default=None)
+    """
+    Drafts for this task
+    """
+
+    annotators: typing.Optional[typing.List[int]] = pydantic_v1.Field(default=None)
+    """
+    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: typing.Optional[str] = None
+    predictions_results: typing.Optional[str] = None
+    predictions_score: typing.Optional[float] = None
+    file_upload: typing.Optional[str] = None
+    storage_filename: typing.Optional[str] = None
+    annotations_ids: typing.Optional[str] = None
+    predictions_model_versions: typing.Optional[str] = None
+    avg_lead_time: typing.Optional[float] = None
+    draft_exists: typing.Optional[bool] = None
+    updated_by: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = pydantic_v1.Field(default=None)
+    """
+    User IDs who updated this task
+    """
+
+    data: typing.Dict[str, typing.Any] = pydantic_v1.Field()
+    """
+    User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.
+    """
+
+    meta: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(default=None)
+    """
+    Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Time a task was created
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Last time a task was updated
+    """
+
+    is_labeled: typing.Optional[bool] = pydantic_v1.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_v1.Field(default=None)
+    """
+    Number of distinct annotators that processed the current task
+    """
+
+    comment_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of comments in the task including all annotations
+    """
+
+    unresolved_comment_count: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Number of unresolved comments in the task including all annotations
+    """
+
+    last_comment_updated_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    When the last comment was updated
+    """
+
+    project: typing.Optional[int] = pydantic_v1.Field(default=None)
+    """
+    Project ID for this task
+    """
+
+    comment_authors: typing.Optional[typing.List[int]] = pydantic_v1.Field(default=None)
+    """
+    Users who wrote comments
+    """
+
+    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}

label_studio_sdk/types/data_manager_task_serializer_drafts_item.py

@@ -0,0 +1,31 @@
+# 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
+
+
+class DataManagerTaskSerializerDraftsItem(pydantic_v1.BaseModel):
+    result: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = 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}

label_studio_sdk/types/data_manager_task_serializer_predictions_item.py

@@ -0,0 +1,37 @@
+# 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
+
+
+class DataManagerTaskSerializerPredictionsItem(pydantic_v1.BaseModel):
+    result: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = None
+    score: typing.Optional[float] = None
+    model_version: typing.Optional[str] = None
+    model: typing.Optional[typing.Dict[str, typing.Any]] = None
+    model_run: typing.Optional[typing.Dict[str, typing.Any]] = None
+    task: typing.Optional[int] = None
+    project: typing.Optional[float] = 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}

label_studio_sdk/types/task.py

@@ -58,7 +58,7 @@ class Task(pydantic_v1.BaseModel):
     Completion time of the task
     """
 
-    file_upload: typing.Optional[int] = pydantic_v1.Field(default=None)
+    file_upload: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
     File upload ID for this task
     """

label_studio_sdk/views/__init__.py

@@ -5,14 +5,18 @@ from .types import (
     ViewsCreateRequestDataFilters,
     ViewsCreateRequestDataFiltersConjunction,
     ViewsCreateRequestDataFiltersItemsItem,
+    ViewsCreateRequestDataFiltersItemsItemFilter,
+    ViewsCreateRequestDataFiltersItemsItemOperator,
+    ViewsCreateRequestDataFiltersItemsItemValue,
     ViewsCreateRequestDataOrderingItem,
-    ViewsCreateRequestDataOrderingItemDirection,
     ViewsUpdateRequestData,
     ViewsUpdateRequestDataFilters,
     ViewsUpdateRequestDataFiltersConjunction,
     ViewsUpdateRequestDataFiltersItemsItem,
+    ViewsUpdateRequestDataFiltersItemsItemFilter,
+    ViewsUpdateRequestDataFiltersItemsItemOperator,
+    ViewsUpdateRequestDataFiltersItemsItemValue,
     ViewsUpdateRequestDataOrderingItem,
-    ViewsUpdateRequestDataOrderingItemDirection,
 )
 
 __all__ = [
@@ -20,12 +24,16 @@ __all__ = [
     "ViewsCreateRequestDataFilters",
     "ViewsCreateRequestDataFiltersConjunction",
     "ViewsCreateRequestDataFiltersItemsItem",
+    "ViewsCreateRequestDataFiltersItemsItemFilter",
+    "ViewsCreateRequestDataFiltersItemsItemOperator",
+    "ViewsCreateRequestDataFiltersItemsItemValue",
     "ViewsCreateRequestDataOrderingItem",
-    "ViewsCreateRequestDataOrderingItemDirection",
     "ViewsUpdateRequestData",
     "ViewsUpdateRequestDataFilters",
     "ViewsUpdateRequestDataFiltersConjunction",
     "ViewsUpdateRequestDataFiltersItemsItem",
+    "ViewsUpdateRequestDataFiltersItemsItemFilter",
+    "ViewsUpdateRequestDataFiltersItemsItemOperator",
+    "ViewsUpdateRequestDataFiltersItemsItemValue",
     "ViewsUpdateRequestDataOrderingItem",
-    "ViewsUpdateRequestDataOrderingItemDirection",
 ]

label_studio_sdk/views/types/__init__.py

@@ -4,26 +4,34 @@ from .views_create_request_data import ViewsCreateRequestData
 from .views_create_request_data_filters import ViewsCreateRequestDataFilters
 from .views_create_request_data_filters_conjunction import ViewsCreateRequestDataFiltersConjunction
 from .views_create_request_data_filters_items_item import ViewsCreateRequestDataFiltersItemsItem
+from .views_create_request_data_filters_items_item_filter import ViewsCreateRequestDataFiltersItemsItemFilter
+from .views_create_request_data_filters_items_item_operator import ViewsCreateRequestDataFiltersItemsItemOperator
+from .views_create_request_data_filters_items_item_value import ViewsCreateRequestDataFiltersItemsItemValue
 from .views_create_request_data_ordering_item import ViewsCreateRequestDataOrderingItem
-from .views_create_request_data_ordering_item_direction import ViewsCreateRequestDataOrderingItemDirection
 from .views_update_request_data import ViewsUpdateRequestData
 from .views_update_request_data_filters import ViewsUpdateRequestDataFilters
 from .views_update_request_data_filters_conjunction import ViewsUpdateRequestDataFiltersConjunction
 from .views_update_request_data_filters_items_item import ViewsUpdateRequestDataFiltersItemsItem
+from .views_update_request_data_filters_items_item_filter import ViewsUpdateRequestDataFiltersItemsItemFilter
+from .views_update_request_data_filters_items_item_operator import ViewsUpdateRequestDataFiltersItemsItemOperator
+from .views_update_request_data_filters_items_item_value import ViewsUpdateRequestDataFiltersItemsItemValue
 from .views_update_request_data_ordering_item import ViewsUpdateRequestDataOrderingItem
-from .views_update_request_data_ordering_item_direction import ViewsUpdateRequestDataOrderingItemDirection
 
 __all__ = [
     "ViewsCreateRequestData",
     "ViewsCreateRequestDataFilters",
     "ViewsCreateRequestDataFiltersConjunction",
     "ViewsCreateRequestDataFiltersItemsItem",
+    "ViewsCreateRequestDataFiltersItemsItemFilter",
+    "ViewsCreateRequestDataFiltersItemsItemOperator",
+    "ViewsCreateRequestDataFiltersItemsItemValue",
     "ViewsCreateRequestDataOrderingItem",
-    "ViewsCreateRequestDataOrderingItemDirection",
     "ViewsUpdateRequestData",
     "ViewsUpdateRequestDataFilters",
     "ViewsUpdateRequestDataFiltersConjunction",
     "ViewsUpdateRequestDataFiltersItemsItem",
+    "ViewsUpdateRequestDataFiltersItemsItemFilter",
+    "ViewsUpdateRequestDataFiltersItemsItemOperator",
+    "ViewsUpdateRequestDataFiltersItemsItemValue",
     "ViewsUpdateRequestDataOrderingItem",
-    "ViewsUpdateRequestDataOrderingItemDirection",
 ]

label_studio_sdk/views/types/views_create_request_data.py

@@ -16,12 +16,12 @@ class ViewsCreateRequestData(pydantic_v1.BaseModel):
 
     filters: typing.Optional[ViewsCreateRequestDataFilters] = pydantic_v1.Field(default=None)
     """
-    Filters for the view
+    Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.<br>Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`
     """
 
     ordering: typing.Optional[typing.List[ViewsCreateRequestDataOrderingItem]] = pydantic_v1.Field(default=None)
     """
-    Ordering for the view
+    List of fields to order by. Fields are similar to filters but without the `filter:` prefix. To reverse the order, add a minus sign before the field name, e.g. `-tasks:created_at`.
     """
 
     def json(self, **kwargs: typing.Any) -> str:

label_studio_sdk/views/types/views_create_request_data_filters.py

@@ -11,17 +11,17 @@ from .views_create_request_data_filters_items_item import ViewsCreateRequestData
 
 class ViewsCreateRequestDataFilters(pydantic_v1.BaseModel):
     """
-    Filters for the view
+    Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.<br>Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`
     """
 
-    conjunction: typing.Optional[ViewsCreateRequestDataFiltersConjunction] = pydantic_v1.Field(default=None)
+    conjunction: ViewsCreateRequestDataFiltersConjunction = pydantic_v1.Field()
     """
-    Type of conjunction
+    Logical conjunction for the filters. This conjunction (either "or" or "and") will be applied to all items in the filters list. It is not possible to combine "or" and "and" within one list of filters. All filters will be either combined with "or" or with "and", but not a mix of both.
     """
 
-    items: typing.Optional[typing.List[ViewsCreateRequestDataFiltersItemsItem]] = pydantic_v1.Field(default=None)
+    items: typing.List[ViewsCreateRequestDataFiltersItemsItem] = pydantic_v1.Field()
     """
-    Filter items
+    List of filter items
     """
 
     def json(self, **kwargs: typing.Any) -> str:

label_studio_sdk/views/types/views_create_request_data_filters_conjunction.py

@@ -2,4 +2,4 @@
 
 import typing
 
-ViewsCreateRequestDataFiltersConjunction = typing.Union[typing.Literal["and", "or"], typing.Any]
+ViewsCreateRequestDataFiltersConjunction = typing.Union[typing.Literal["or", "and"], typing.Any]

label_studio_sdk/views/types/views_create_request_data_filters_items_item.py

@@ -5,27 +5,30 @@ import typing
 
 from ...core.datetime_utils import serialize_datetime
 from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from .views_create_request_data_filters_items_item_filter import ViewsCreateRequestDataFiltersItemsItemFilter
+from .views_create_request_data_filters_items_item_operator import ViewsCreateRequestDataFiltersItemsItemOperator
+from .views_create_request_data_filters_items_item_value import ViewsCreateRequestDataFiltersItemsItemValue
 
 
 class ViewsCreateRequestDataFiltersItemsItem(pydantic_v1.BaseModel):
-    filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    filter: ViewsCreateRequestDataFiltersItemsItemFilter = pydantic_v1.Field()
     """
-    Field name
+    Filter identifier, it should start with `filter:tasks:` prefix, e.g. `filter:tasks:agreement`. For `task.data` fields it may look like `filter:tasks:data.field_name`. If you need more info about columns, check the [Get data manager columns](#tag/Data-Manager/operation/api_dm_columns_list) API endpoint. Possible values:<br><li>`filter:tasks:agreement`<br> (Number) Agreement for annotation results for a specific task (Enterprise only)</li><br><li>`filter:tasks:annotations_results`<br> (String) Annotation results for the tasks</li><br><li>`filter:tasks:annotators`<br> (List) Annotators that completed the task (Community). Can include assigned annotators (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer</li><br><li>`filter:tasks:cancelled_annotations`<br> (Number) Number of cancelled or skipped annotations for the task</li><br><li>`filter:tasks:comments`<br> (Number) Number of comments in a task</li><br><li>`filter:tasks:completed_at`<br> (Datetime) Time when a task was fully annotated</li><br><li>`filter:tasks:created_at`<br> (Datetime) Time the task was created at</li><br><li>`filter:tasks:file_upload`<br> (String) Name of the file uploaded to create the tasks</li><br><li>`filter:tasks:ground_truth`<br> (Boolean) Ground truth status of the tasks</li><br><li>`filter:tasks:id`<br> (Number) Task ID</li><br><li>`filter:tasks:inner_id`<br> (Number) Task Inner ID, it starts from 1 for all projects</li><br><li>`filter:tasks:predictions_model_versions`<br> (String) Model version used for the predictions</li><br><li>`filter:tasks:predictions_results`<br> (String) Prediction results for the tasks</li><br><li>`filter:tasks:predictions_score`<br> (Number) Prediction score for the task</li><br><li>`filter:tasks:reviewed`<br> (Boolean) Whether the tasks have been reviewed (Enterprise only)</li><br><li>`filter:tasks:reviewers`<br> (String) Reviewers that reviewed the task, or assigned reviewers (Enterprise only). Important note: the filter `type` should be List, but the filter `value` is integer</li><br><li>`filter:tasks:reviews_accepted`<br> (Number) Number of annotations accepted for a task in review (Enterprise only)</li><br><li>`filter:tasks:reviews_rejected`<br> (Number) Number of annotations rejected for a task in review (Enterprise only)</li><br><li>`filter:tasks:total_annotations`<br> (Number) Total number of annotations on a task</li><br><li>`filter:tasks:total_predictions`<br> (Number) Total number of predictions for the task</li><br><li>`filter:tasks:unresolved_comment_count`<br> (Number) Number of unresolved comments in a task</li><br><li>`filter:tasks:updated_at`<br> (Datetime) Time the task was updated at (e.g. new annotation was created, review added, etc)</li>
     """
 
-    type: typing.Optional[str] = pydantic_v1.Field(default=None)
+    operator: ViewsCreateRequestDataFiltersItemsItemOperator = pydantic_v1.Field()
     """
-    Field type
+    Filter operator. Possible values:<br><li>`contains`<br> Contains</li><br><li>`ends_with`<br> Ends with</li><br><li>`equal`<br> Equal to</li><br><li>`exists`<br> Exists</li><br><li>`greater`<br> Greater than</li><br><li>`greater_or_equal`<br> Greater than or equal to</li><br><li>`in`<br> Is between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`</li><br><li>`less`<br> Less than</li><br><li>`less_or_equal`<br> Less than or equal to</li><br><li>`not_contains`<br> Does not contain</li><br><li>`not_equal`<br> Not equal to</li><br><li>`not_exists`<br> Does not exist</li><br><li>`not_in`<br> Is not between min and max values, so the filter `value` should be e.g. `{"min": 1, "max": 7}`</li><br><li>`starts_with`<br> Starts with</li>
     """
 
-    operator: typing.Optional[str] = pydantic_v1.Field(default=None)
+    type: str = pydantic_v1.Field()
     """
-    Filter operator
+    Type of the filter value. Possible values:<br><li>`Boolean`<br> Boolean</li><br><li>`Datetime`<br> Datetime string in `strftime('%Y-%m-%dT%H:%M:%S.%fZ')` format</li><br><li>`List`<br> List of items</li><br><li>`Number`<br> Float or Integer</li><br><li>`String`<br> String</li><br><li>`Unknown`<br> Unknown is explicitly converted to string format</li>
     """
 
-    value: typing.Optional[str] = pydantic_v1.Field(default=None)
+    value: ViewsCreateRequestDataFiltersItemsItemValue = pydantic_v1.Field()
     """
-    Filter value
+    Value to filter by
     """
 
     def json(self, **kwargs: typing.Any) -> str:

label_studio_sdk/views/types/views_create_request_data_filters_items_item_filter.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ViewsCreateRequestDataFiltersItemsItemFilter = typing.Union[
+    typing.Literal[
+        "filter:tasks:agreement",
+        "filter:tasks:annotations_results",
+        "filter:tasks:annotators",
+        "filter:tasks:cancelled_annotations",
+        "filter:tasks:comments",
+        "filter:tasks:completed_at",
+        "filter:tasks:created_at",
+        "filter:tasks:file_upload",
+        "filter:tasks:ground_truth",
+        "filter:tasks:id",
+        "filter:tasks:inner_id",
+        "filter:tasks:predictions_model_versions",
+        "filter:tasks:predictions_results",
+        "filter:tasks:predictions_score",
+        "filter:tasks:reviewed",
+        "filter:tasks:reviewers",
+        "filter:tasks:reviews_accepted",
+        "filter:tasks:reviews_rejected",
+        "filter:tasks:total_annotations",
+        "filter:tasks:total_predictions",
+        "filter:tasks:unresolved_comment_count",
+        "filter:tasks:updated_at",
+    ],
+    typing.Any,
+]

label_studio_sdk/views/types/views_create_request_data_filters_items_item_operator.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ViewsCreateRequestDataFiltersItemsItemOperator = typing.Union[
+    typing.Literal[
+        "contains",
+        "ends_with",
+        "equal",
+        "exists",
+        "greater",
+        "greater_or_equal",
+        "in",
+        "less",
+        "less_or_equal",
+        "not_contains",
+        "not_equal",
+        "not_exists",
+        "not_in",
+        "starts_with",
+    ],
+    typing.Any,
+]

label_studio_sdk/views/types/views_create_request_data_filters_items_item_value.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ViewsCreateRequestDataFiltersItemsItemValue = typing.Union[str, int, float, bool, typing.Dict[str, typing.Any]]