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

label_studio_sdk/_legacy/schema/label_config_schema.json

@@ -0,0 +1,226 @@
+{
+  "$schema": "http://json-schema.org/draft-06/schema#",
+  "title": "LabelConfig",
+  "definitions": {
+    "$": {
+      "type": "string"
+    },
+    "@name": {
+      "type": "string"
+    },
+    "@toName": {
+      "type": "string"
+    },
+    "@value": {
+      "anyOf": [
+        {"type": "string"},
+        {"type": "boolean"},
+        {"type": "number"}
+      ]},
+    "@valueList": {
+      "anyOf": [
+        {"type": "string"}
+      ]},
+    "tag_with_value": {
+      "type": "object",
+      "required": [
+        "@value"
+      ],
+      "properties": {
+        "@value": {
+          "$ref": "#/definitions/@value"
+        },
+        "$": {
+          "$ref": "#/definitions/$"
+        }
+      }
+    },
+    "tag_with_value_required_name": {
+      "type": "object",
+      "oneOf": [
+          {
+            "required": [
+                "@name",
+                "@value"
+            ]
+          },
+          {
+            "required": [
+                "@name",
+                "@valueList"
+            ]
+          }
+      ],
+      "properties": {
+        "@value": {
+          "$ref": "#/definitions/@value"
+        },
+        "$": {
+          "$ref": "#/definitions/$"
+        }
+      }
+    },
+    "tags_with_value": {
+      "anyOf": [{
+        "type": "array",
+        "items": {"$ref": "#/definitions/tag_with_value"}
+      }, {"$ref": "#/definitions/tag_with_value"}]
+    },
+    "tags_with_value_or_object": {
+      "anyOf": [{
+        "type": "array",
+        "items": {"$ref": "#/definitions/tag_with_value"}
+      }, {
+        "type": "object"
+      }, {"$ref": "#/definitions/tag_with_value"}]
+    },
+    "tags_with_value_required_name": {
+      "anyOf": [{
+        "type": "array",
+        "items": {"$ref": "#/definitions/tag_with_value_required_name"}
+      }, {"$ref": "#/definitions/tag_with_value_required_name"}]
+    },
+    "View": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "Labels": {"$ref": "#/definitions/MaybeMultipleLabels"},
+        "Choices": {"$ref": "#/definitions/MaybeMultipleChoices"},
+        "Label": {"$ref": "#/definitions/MaybeMultipleLabel"},
+        "Choice": {"$ref": "#/definitions/MaybeMultipleChoice"},
+        "Image": {"$ref": "#/definitions/tags_with_value_required_name"},
+        "Text": {"$ref": "#/definitions/tags_with_value_required_name"},
+        "HyperText": {"$ref": "#/definitions/tags_with_value_required_name"},
+        "View": {"$ref": "#/definitions/MaybeMultipleView"},
+        "TextArea": {"$ref": "#/definitions/MaybeMultipleTextAreas"}
+      }
+    },
+    "MaybeMultipleView": {
+      "anyOf": [{
+        "type": "array",
+        "items": {"$ref": "#/definitions/View"}
+      }, {"$ref": "#/definitions/View"}]
+    },
+    "Choice": {
+      "$ref": "#/definitions/tag_with_value"
+    },
+    "MaybeMultipleChoice": {
+      "anyOf": [{
+        "type": "array",
+        "items": {"$ref": "#/definitions/Choice"}
+      }, {"$ref": "#/definitions/Choice"}]
+    },
+    "Label": {
+      "$ref": "#/definitions/tag_with_value"
+    },
+    "MaybeMultipleLabel": {
+      "anyOf": [{
+        "type": "array",
+        "items": {"$ref": "#/definitions/Label"}
+      }, {"$ref": "#/definitions/Label"}]
+    },
+    "Choices": {
+      "type": "object",
+      "anyOf": [
+        {"required": ["@name", "@toName", "Choice"]},
+        {"required": ["@name", "@toName", "@value"]},
+        {"required": ["@name", "@toName", "View"]}
+      ],
+      "properties": {
+        "@name": {
+          "$ref": "#/definitions/@name"
+        },
+        "@toName": {
+          "$ref": "#/definitions/@toName"
+        },
+        "@value": {
+          "$ref": "#/definitions/@value"
+        },
+        "$": {
+          "$ref": "#/definitions/$"
+        },
+        "Choice": {
+          "type": "array",
+          "items": {"$ref": "#/definitions/Choice"}
+        },
+        "View": {"$ref": "#/definitions/MaybeMultipleView"}
+      }
+    },
+    "MaybeMultipleChoices": {
+      "anyOf": [{
+        "type": "array",
+        "items": {"$ref": "#/definitions/Choices"}
+      }, {"$ref": "#/definitions/Choices"}]
+    },
+    "Labels": {
+      "type": "object",
+      "anyOf": [
+        {"required": ["@name", "@toName", "Label"]},
+        {"required": ["@name", "@toName", "@value"]},
+        {"required": ["@name", "@toName", "View"]}
+      ],
+      "properties": {
+        "@name": {
+          "$ref": "#/definitions/@name"
+        },
+        "@toName": {
+          "$ref": "#/definitions/@toName"
+        },
+        "@value": {
+          "$ref": "#/definitions/@value"
+        },
+        "$": {
+          "$ref": "#/definitions/$"
+        },
+        "Label": {"$ref": "#/definitions/MaybeMultipleLabel"},
+        "View": {"$ref": "#/definitions/MaybeMultipleView"}
+      }
+    },
+    "MaybeMultipleLabels": {
+      "anyOf": [{
+        "type": "array",
+        "items": {"$ref": "#/definitions/Labels"}
+      }, {"$ref": "#/definitions/Labels"}]
+    },
+    "TextArea": {
+      "type": "object",
+      "anyOf": [
+        {"required": ["@name", "@toName"]}
+      ],
+      "properties": {
+        "@name": {
+          "$ref": "#/definitions/@name"
+        },
+        "@toName": {
+          "$ref": "#/definitions/@toName"
+        },
+        "$": {
+          "$ref": "#/definitions/$"
+        }
+      }
+    },
+    "MaybeMultipleTextAreas": {
+      "anyOf": [{
+        "type": "array",
+        "items": {"$ref": "#/definitions/TextArea"}
+      }, {"$ref": "#/definitions/TextArea"}]
+    }
+    
+  },
+  "type": "object",
+  "properties": {
+    "View": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "Choices": {"$ref": "#/definitions/MaybeMultipleChoices"},
+        "Labels": {"$ref": "#/definitions/MaybeMultipleLabels"},
+        "View": {"$ref": "#/definitions/MaybeMultipleView"},
+        "Image": {"$ref": "#/definitions/tags_with_value_required_name"},
+        "Text": {"$ref": "#/definitions/tags_with_value_required_name"},
+        "HyperText": {"$ref": "#/definitions/tags_with_value_required_name"},
+        "TextArea": {"$ref": "#/definitions/MaybeMultipleTextAreas"}
+      }
+    }
+  }
+}

label_studio_sdk/{users.py → _legacy/users.py}

@@ -1,18 +1,20 @@
 from datetime import datetime
-from pydantic import BaseModel
 from enum import Enum
 from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
 from .client import Client
 
 
 class UserRole(Enum):
-    ANNOTATOR = 'AN'
-    REVIEWER = 'RE'
-    MANAGER = 'MA'
-    ADMINISTRATOR = 'AD'
-    OWNER = 'OW'
-    NOT_ACTIVATED = 'NO'
-    DISABLED = 'DI'
+    ANNOTATOR = "AN"
+    REVIEWER = "RE"
+    MANAGER = "MA"
+    ADMINISTRATOR = "AD"
+    OWNER = "OW"
+    NOT_ACTIVATED = "NO"
+    DISABLED = "DI"
 
 
 class OrgMembership(BaseModel):
@@ -30,8 +32,8 @@ class User(BaseModel):
     last_activity: datetime
     initials: str
     phone: str
-    active_organization: Optional[int]
-    org_membership: Optional[List[OrgMembership]]
+    active_organization: Optional[int] = None
+    org_membership: Optional[List[OrgMembership]] = Field(default_factory=list)
     client: Client
 
     class Config:
@@ -46,9 +48,9 @@ class User(BaseModel):
             User role
         """
         response = self.client.make_request(
-            'PATCH',
-            f'/api/organizations/{self.active_organization}/memberships',
-            json={'user_id': self.id, 'role': role.value},
+            "PATCH",
+            f"/api/organizations/{self.active_organization}/memberships",
+            json={"user_id": self.id, "role": role.value},
         )
         for membership in self.org_membership:
             if membership.organization_id == self.active_organization:

label_studio_sdk/{utils.py → _legacy/utils.py}

@@ -1,5 +1,6 @@
 """ .. include::../docs/utils.md
 """
+
 import logging
 
 from lxml import etree
@@ -7,9 +8,9 @@ from collections import defaultdict
 
 logger = logging.getLogger(__name__)
 
-_LABEL_TAGS = {'Label', 'Choice'}
+_LABEL_TAGS = {"Label", "Choice"}
 _NOT_CONTROL_TAGS = {
-    'Filter',
+    "Filter",
 }
 
 
@@ -49,12 +50,12 @@ def parse_config(config_string):
         return {}
 
     def _is_input_tag(tag):
-        return tag.attrib.get('name') and tag.attrib.get('value')
+        return tag.attrib.get("name") and tag.attrib.get("value")
 
     def _is_output_tag(tag):
         return (
-            tag.attrib.get('name')
-            and tag.attrib.get('toName')
+            tag.attrib.get("name")
+            and tag.attrib.get("toName")
             and tag.tag not in _NOT_CONTROL_TAGS
         )
 
@@ -65,7 +66,7 @@ def parse_config(config_string):
             parent = parent.getparent()
             if parent is None:
                 return
-            name = parent.attrib.get('name')
+            name = parent.attrib.get("name")
             if name in outputs:
                 return name
 
@@ -74,55 +75,55 @@ def parse_config(config_string):
     inputs, outputs, labels = {}, {}, defaultdict(dict)
     for tag in xml_tree.iter():
         if _is_output_tag(tag):
-            tag_info = {'type': tag.tag, 'to_name': tag.attrib['toName'].split(',')}
+            tag_info = {"type": tag.tag, "to_name": tag.attrib["toName"].split(",")}
             # Grab conditionals if any
             conditionals = {}
-            if tag.attrib.get('perRegion') == 'true':
-                if tag.attrib.get('whenTagName'):
-                    conditionals = {'type': 'tag', 'name': tag.attrib['whenTagName']}
-                elif tag.attrib.get('whenLabelValue'):
+            if tag.attrib.get("perRegion") == "true":
+                if tag.attrib.get("whenTagName"):
+                    conditionals = {"type": "tag", "name": tag.attrib["whenTagName"]}
+                elif tag.attrib.get("whenLabelValue"):
                     conditionals = {
-                        'type': 'label',
-                        'name': tag.attrib['whenLabelValue'],
+                        "type": "label",
+                        "name": tag.attrib["whenLabelValue"],
                     }
-                elif tag.attrib.get('whenChoiceValue'):
+                elif tag.attrib.get("whenChoiceValue"):
                     conditionals = {
-                        'type': 'choice',
-                        'name': tag.attrib['whenChoiceValue'],
+                        "type": "choice",
+                        "name": tag.attrib["whenChoiceValue"],
                     }
             if conditionals:
-                tag_info['conditionals'] = conditionals
-            outputs[tag.attrib['name']] = tag_info
+                tag_info["conditionals"] = conditionals
+            outputs[tag.attrib["name"]] = tag_info
         elif _is_input_tag(tag):
-            inputs[tag.attrib['name']] = {
-                'type': tag.tag,
-                'value': tag.attrib['value'].lstrip('$'),
+            inputs[tag.attrib["name"]] = {
+                "type": tag.tag,
+                "value": tag.attrib["value"].lstrip("$"),
             }
         if tag.tag not in _LABEL_TAGS:
             continue
         parent_name = _get_parent_output_tag_name(tag, outputs)
         if parent_name is not None:
-            actual_value = tag.attrib.get('alias') or tag.attrib.get('value')
+            actual_value = tag.attrib.get("alias") or tag.attrib.get("value")
             if not actual_value:
                 logger.debug(
                     'Inspecting tag {tag_name}... found no "value" or "alias" attributes.'.format(
-                        tag_name=etree.tostring(tag, encoding='unicode').strip()[:50]
+                        tag_name=etree.tostring(tag, encoding="unicode").strip()[:50]
                     )
                 )
             else:
                 labels[parent_name][actual_value] = dict(tag.attrib)
     for output_tag, tag_info in outputs.items():
-        tag_info['inputs'] = []
-        for input_tag_name in tag_info['to_name']:
+        tag_info["inputs"] = []
+        for input_tag_name in tag_info["to_name"]:
             if input_tag_name not in inputs:
                 logger.warning(
-                    f'to_name={input_tag_name} is specified for output tag name={output_tag}, '
-                    'but we can\'t find it among input tags'
+                    f"to_name={input_tag_name} is specified for output tag name={output_tag}, "
+                    "but we can't find it among input tags"
                 )
                 continue
-            tag_info['inputs'].append(inputs[input_tag_name])
-        tag_info['labels'] = list(labels[output_tag])
-        tag_info['labels_attrs'] = labels[output_tag]
+            tag_info["inputs"].append(inputs[input_tag_name])
+        tag_info["labels"] = list(labels[output_tag])
+        tag_info["labels_attrs"] = labels[output_tag]
     return outputs
 
 

label_studio_sdk/{workspaces.py → _legacy/workspaces.py}

@@ -1,13 +1,15 @@
+from typing import Optional
+
 from pydantic import BaseModel
-from typing import List, Optional
-from .users import User
+
 from .client import Client
+from .users import User
 
 
 class Workspace(BaseModel):
     id: int
     title: str
-    description: Optional[str]
+    description: Optional[str] = ''
     color: str
     is_personal: bool
     created_by: int
@@ -25,9 +27,9 @@ class Workspace(BaseModel):
             User
         """
         response = self.client.make_request(
-            'POST',
-            f'/api/workspaces/{self.id}/memberships',
-            json={'workspace': self.id, 'user': user.id},
+            "POST",
+            f"/api/workspaces/{self.id}/memberships",
+            json={"workspace": self.id, "user": user.id},
         )
         return response.json()
 
@@ -40,9 +42,9 @@ class Workspace(BaseModel):
             User
         """
         response = self.client.make_request(
-            'DELETE',
-            f'/api/workspaces/{self.id}/memberships',
-            json={'workspace': self.id, 'user': user.id},
+            "DELETE",
+            f"/api/workspaces/{self.id}/memberships",
+            json={"workspace": self.id, "user": user.id},
         )
         if response.status_code != 204:
             raise ValueError(str(response.content))
@@ -59,11 +61,11 @@ class Workspace(BaseModel):
 
         final_results = []
         response = self.client.make_request(
-            'GET', f'/api/workspaces/{self.id}/projects'
+            "GET", f"/api/workspaces/{self.id}/projects"
         )
         projects = response.json()
         for project_data in projects:
-            project_id = project_data['id']
+            project_id = project_data["id"]
             final_results.append(
                 Project.get_from_id(
                     client=self.client,

label_studio_sdk/actions/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+

label_studio_sdk/actions/client.py

@@ -0,0 +1,150 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+
+
+class ActionsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Retrieve all the registered actions with descriptions that data manager can use.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.actions.list()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/dm/actions/", method="GET", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    def create(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Perform an action with the selected items from a specific view.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.actions.create()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/dm/actions/", method="POST", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncActionsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Retrieve all the registered actions with descriptions that data manager can use.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.actions.list()
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/dm/actions/", method="GET", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+    async def create(self, *, request_options: typing.Optional[RequestOptions] = None) -> None:
+        """
+        Perform an action with the selected items from a specific view.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk.client import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        await client.actions.create()
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/dm/actions/", method="POST", request_options=request_options
+        )
+        if 200 <= _response.status_code < 300:
+            return
+        try:
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

label_studio_sdk/annotations/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+