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

label_studio_sdk/views/types/views_create_request_data_ordering_item.py

@@ -1,38 +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
-from .views_create_request_data_ordering_item_direction import ViewsCreateRequestDataOrderingItemDirection
-
-
-class ViewsCreateRequestDataOrderingItem(pydantic_v1.BaseModel):
-    column: typing.Optional[str] = pydantic_v1.Field(default=None)
-    """
-    Field name
-    """
-
-    direction: typing.Optional[ViewsCreateRequestDataOrderingItemDirection] = pydantic_v1.Field(default=None)
-    """
-    Order direction
-    """
-
-    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}
+ViewsCreateRequestDataOrderingItem = typing.Union[
+    typing.Literal[
+        "tasks:agreement",
+        "tasks:annotations_results",
+        "tasks:annotators",
+        "tasks:cancelled_annotations",
+        "tasks:comments",
+        "tasks:completed_at",
+        "tasks:created_at",
+        "tasks:file_upload",
+        "tasks:ground_truth",
+        "tasks:id",
+        "tasks:inner_id",
+        "tasks:predictions_model_versions",
+        "tasks:predictions_results",
+        "tasks:predictions_score",
+        "tasks:reviewed",
+        "tasks:reviewers",
+        "tasks:reviews_accepted",
+        "tasks:reviews_rejected",
+        "tasks:total_annotations",
+        "tasks:total_predictions",
+        "tasks:unresolved_comment_count",
+        "tasks:updated_at",
+    ],
+    typing.Any,
+]

label_studio_sdk/views/types/views_update_request_data.py

@@ -16,12 +16,12 @@ class ViewsUpdateRequestData(pydantic_v1.BaseModel):
 
     filters: typing.Optional[ViewsUpdateRequestDataFilters] = 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[ViewsUpdateRequestDataOrderingItem]] = 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_update_request_data_filters.py

@@ -11,17 +11,17 @@ from .views_update_request_data_filters_items_item import ViewsUpdateRequestData
 
 class ViewsUpdateRequestDataFilters(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[ViewsUpdateRequestDataFiltersConjunction] = pydantic_v1.Field(default=None)
+    conjunction: ViewsUpdateRequestDataFiltersConjunction = 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[ViewsUpdateRequestDataFiltersItemsItem]] = pydantic_v1.Field(default=None)
+    items: typing.List[ViewsUpdateRequestDataFiltersItemsItem] = pydantic_v1.Field()
     """
-    Filter items
+    List of filter items
     """
 
     def json(self, **kwargs: typing.Any) -> str:

label_studio_sdk/views/types/views_update_request_data_filters_conjunction.py

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

label_studio_sdk/views/types/views_update_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_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
 
 
 class ViewsUpdateRequestDataFiltersItemsItem(pydantic_v1.BaseModel):
-    filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    filter: ViewsUpdateRequestDataFiltersItemsItemFilter = 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: ViewsUpdateRequestDataFiltersItemsItemOperator = 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: ViewsUpdateRequestDataFiltersItemsItemValue = pydantic_v1.Field()
     """
-    Filter value
+    Value to filter by
     """
 
     def json(self, **kwargs: typing.Any) -> str:

label_studio_sdk/views/types/views_update_request_data_filters_items_item_filter.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ViewsUpdateRequestDataFiltersItemsItemFilter = 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_update_request_data_filters_items_item_operator.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+ViewsUpdateRequestDataFiltersItemsItemOperator = 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_update_request_data_filters_items_item_value.py

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

label_studio_sdk/views/types/views_update_request_data_ordering_item.py

@@ -1,38 +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
-from .views_update_request_data_ordering_item_direction import ViewsUpdateRequestDataOrderingItemDirection
-
-
-class ViewsUpdateRequestDataOrderingItem(pydantic_v1.BaseModel):
-    column: typing.Optional[str] = pydantic_v1.Field(default=None)
-    """
-    Field name
-    """
-
-    direction: typing.Optional[ViewsUpdateRequestDataOrderingItemDirection] = pydantic_v1.Field(default=None)
-    """
-    Order direction
-    """
-
-    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}
+ViewsUpdateRequestDataOrderingItem = typing.Union[
+    typing.Literal[
+        "tasks:agreement",
+        "tasks:annotations_results",
+        "tasks:annotators",
+        "tasks:cancelled_annotations",
+        "tasks:comments",
+        "tasks:completed_at",
+        "tasks:created_at",
+        "tasks:file_upload",
+        "tasks:ground_truth",
+        "tasks:id",
+        "tasks:inner_id",
+        "tasks:predictions_model_versions",
+        "tasks:predictions_results",
+        "tasks:predictions_score",
+        "tasks:reviewed",
+        "tasks:reviewers",
+        "tasks:reviews_accepted",
+        "tasks:reviews_rejected",
+        "tasks:total_annotations",
+        "tasks:total_predictions",
+        "tasks:unresolved_comment_count",
+        "tasks:updated_at",
+    ],
+    typing.Any,
+]

label_studio_sdk-1.0.2.dist-info/METADATA

@@ -0,0 +1,195 @@
+Metadata-Version: 2.1
+Name: label-studio-sdk
+Version: 1.0.2
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: Pillow (>=10.0.1)
+Requires-Dist: appdirs (>=1.4.3)
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: ijson (>=3.2.3)
+Requires-Dist: jsonschema (==3.2.0)
+Requires-Dist: lxml (>=4.2.5)
+Requires-Dist: nltk (==3.6.7)
+Requires-Dist: pandas (>=0.24.0)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: requests (>=2.22.0)
+Requires-Dist: requests-mock (==1.12.1)
+Requires-Dist: typing_extensions (>=4.0.0)
+Requires-Dist: ujson (>=5.8.0)
+Requires-Dist: xmljson (==0.2.1)
+Description-Content-Type: text/markdown
+
+# Label Studio Python Library
+
+<!-- Note about deprecated version <1 -->
+---
+> :warning: **Note**<br/>
+>
+> The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
+> If you still want to use the old version, you can install it with `pip install "label-studio-sdk<1"`.
+> OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
+>
+> ```sh
+> git clone https://github.com/HumanSignal/label-studio-sdk.git
+> cd label-studio-sdk
+> git checkout previous-version
+> ```
+> 
+> OR you can change your import statements as follows:
+> ```python
+> from label_studio_sdk import Client
+> from label_studio_sdk.data_manager import Filters, Column, Operator, Type
+> from label_studio_sdk._legacy import Project
+> ```
+---
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+[![pypi](https://img.shields.io/pypi/v/label-studio-sdk.svg)](https://pypi.python.org/pypi/label-studio-sdk)
+
+The Label Studio Python Library provides convenient access to the Label Studio API from applications written in Python.
+<!-- End Title  -->
+
+<!-- Outline -->
+
+
+# Documentation
+Explore the Label Studio API documentation [here](https://api.labelstud.io/).
+
+
+# Installation
+
+```sh
+pip install --upgrade label-studio-sdk
+# or
+poetry add label-studio-sdk
+```
+
+# Usage
+
+```python
+from label_studio_sdk.client import LabelStudio
+
+ls = LabelStudio(
+    base_url='YOUR_LABEL_STUDIO_URL',  
+    api_key="YOUR_API_KEY",
+)
+```
+
+# Examples
+
+Check more examples [here](https://api.labelstud.io/).
+
+## Create a new project
+
+```python
+project = ls.projects.create(
+    name="Project name",
+    description="Project description",
+    label_config="""
+    <View>
+        <Image name="image" value="$image" />
+        <RectangleLabels name="label" toName="image">
+            <Label value="cat" />
+            <Label value="dog" />
+        </RectangleLabels>
+    </View>
+    """
+)
+```
+
+## Create a new task
+    
+```python
+task = ls.tasks.create(
+    project=project.id,
+    data={"image": "https://example.com/image.jpg"}
+)
+```
+Now you can open the project `PROJECT_ID` in the Label Studio UI and create annotations for the task.
+
+## Export annotations
+
+```python
+annotations = [
+    task.annotations
+    for task in ls.tasks.list(project=project.id, fields='all')
+    if task.annotations
+]
+```
+
+
+## Async client
+
+```python
+from label_studio_sdk.client import AsyncLabelStudio
+
+client = AsyncLabelStudio(
+    api_key="YOUR_API_KEY",
+)
+```
+
+## Advanced
+
+### Timeouts
+By default, requests time out after 60 seconds. You can configure this with a 
+timeout option at the client or request level.
+
+```python
+from label_studio_sdk.client import LabelStudio
+
+ls = LabelStudio(
+    # All timeouts set to 20 seconds
+    timeout=20.0
+)
+
+ls.projects.create(..., {
+    # Override timeout for a specific method
+    timeout=20.0
+})
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use-case. Some common use-cases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from label_studio_sdk.client import LabelStudio
+
+ls = LabelStudio(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+<!-- Begin Contributing, generated by Fern  -->
+# Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+<!-- End Contributing  -->
+
+