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

label_studio_sdk/_legacy/label_interface/data_examples.json

@@ -0,0 +1,96 @@
+{
+  "editor_preview": {
+    "TextRaw": "To have faith is to trust yourself to the water",
+    "TextUrl": "https://htx-pub.s3.amazonaws.com/example.txt",
+    "HyperText": "<div style=\"max-width: 750px\"><div style=\"clear: both\"><div style=\"float: right; display: inline-block; border: 1px solid #F2F3F4; background-color: #F8F9F9; border-radius: 5px; padding: 7px; margin: 10px 0;\"><p><b>Jules<\/b>: No no, Mr. Wolfe, it's not like that. Your help is definitely appreciated.<\/p><\/div><\/div><div style=\"clear: both\"><div style=\"float: right; display: inline-block; border: 1px solid #F2F3F4; background-color: #F8F9F9; border-radius: 5px; padding: 7px; margin: 10px 0;\"><p><b>Vincent<\/b>: Look, Mr. Wolfe, I respect you. I just don't like people barking orders at me, that's all.<\/p><\/div><\/div><div style=\"clear: both\"><div style=\"display: inline-block; border: 1px solid #D5F5E3; background-color: #EAFAF1; border-radius: 5px; padding: 7px; margin: 10px 0;\"><p><b>The Wolf<\/b>: If I'm curt with you, it's because time is a factor. I think fast, I talk fast, and I need you two guys to act fast if you want to get out of this. So pretty please, with sugar on top, clean the car.<\/p><\/div><\/div><\/div>",
+    "HyperTextUrl": "<HOSTNAME>/static/samples/hypertext.html",
+    "Image": "<HOSTNAME>/static/samples/sample.jpg",
+    "Audio": "<HOSTNAME>/static/samples/game.wav",
+    "AudioPlus": "<HOSTNAME>/static/samples/game.wav",
+    "Header": "Task header",
+    "Paragraphs":  [{"author": "Alice", "text": "Hi, Bob."}, {"author": "Bob", "text": "Hello, Alice!"}, {"author": "Alice", "text": "What's up?"}, {"author": "Bob", "text": "Good. Ciao!"}, {"author": "Alice", "text": "Bye, Bob."}],
+    "ParagraphsUrl": "<HOSTNAME>/samples/paragraphs.json?",
+    "Table": {"Card number": 18799210, "First name": "Max", "Last name":  "Nobel"},
+    "$videoHack": "<video src='<HOSTNAME>/static/samples/opossum_snow.mp4' width=100% controls>",
+    "Video": "<HOSTNAME>/static/samples/opossum_snow.mp4",
+    "Labels": [
+      { "value": "DynamicLabel1", "background": "#ff0000" },
+      { "value": "DynamicLabel2", "background": "#0000ff" }
+    ],
+    "Choices": [
+      { "value": "DynamicChoice1" },
+      { "value": "DynamicChoice2" },
+      { "value": "DynamicChoice3" }
+    ],
+    "NestedChoices": [
+      {
+        "value": "DynamicChoiceHeader1",
+        "children": [
+          { "value": "DynamicChoice1.1" },
+          { "value": "DynamicChoice1.2" }
+        ]
+      },
+      {
+        "value": "DynamicChoiceHeader2",
+        "children": [
+          { "value": "DynamicChoice2.1" },
+          { "value": "DynamicChoice2.2" },
+          { "value": "DynamicChoice2.3" }
+        ]
+      }
+    ],
+    "List": [
+      {
+        "id": 1,
+        "title": "The Amazing World of Opossums",
+        "body": "Opossums are fascinating marsupials native to North America. They have prehensile tails, which help them to climb trees and navigate their surroundings with ease. Additionally, they are known for their unique defense mechanism, called 'playing possum,' where they mimic the appearance and smell of a dead animal to deter predators."
+      },
+      {
+        "id": 2,
+        "title": "Opossums: Nature's Pest Control",
+        "body": "Opossums play a crucial role in controlling insect and rodent populations, as they consume a variety of pests like cockroaches, beetles, and mice. This makes them valuable allies for gardeners and homeowners, as they help to maintain a balanced ecosystem and reduce the need for chemical pest control methods."
+      },
+      {
+        "id": 3,
+        "title": "Fun Fact: Opossums Are Immune to Snake Venom",
+        "body": "One surprising characteristic of opossums is their natural immunity to snake venom. They have a unique protein in their blood called 'Lethal Toxin-Neutralizing Factor' (LTNF), which neutralizes venom from a variety of snake species, including rattlesnakes and cottonmouths. This allows opossums to prey on snakes without fear of harm, further highlighting their important role in the ecosystem."
+      }
+    ],
+    "$longText": "Opossums are frequently considered to be living fossils, and as a result are often used to approximate the ancestral therian condition in comparative studies. However, this is inaccurate, the oldest opossum fossils are early Miocene in age (roughly 20 million years old) and the last common ancestor of all living opossums approximately dates to the Oligocene-Miocene boundary (roughly 23 million years ago) and is at most no older than Oligocene in age. Many extinct metatherians once considered early opossums, such as Alphadon, Peradectes, Herpetotherium, and Pucadelphys, have since been recognized to have been previously grouped with opossums on the basis of plesiomorphies and are now considered to represent older branches of Metatheria only distantly related to modern opossums.",
+    "$corefText": "I voted for Obama because he was most aligned with my values, she said.",
+    "$pdf": "<embed src='<HOSTNAME>/static/samples/sample.pdf' width='100%' height='600px'/>",
+    "$website": "<iframe src='http://heartex.ai' width='100%' height='600px'/>",
+    "$headlessCsv": "<HOSTNAME>/static/samples/sample-task-sin-headless.csv",
+    "$humanMachineDialogue": [
+        {"author": "Human", "text": "Hi, Robot!"},
+        {"author": "Robot", "text": "Nice to meet you, man! Tell me what you want."},
+        {"author": "Human", "text": "Order me a pizza from Golden Boy at Green Street "},
+        {"author": "Robot", "text": "Done. When do you want to get the order?"},
+        {"author": "Human", "text": "At 3am in the morning, please"}],
+    "$respone": "Sure, no problem!",
+    "$resptwo": "Sorry, it's too early. May be we can change the time?",
+    "$respthree": "Don't eat junk food man, it's bad for you...",
+    "$ocr": "https://htx-pub.s3.amazonaws.com/demo/ocr/example.jpg",
+    "$ner": "A Florida restaurant paid 10,925 pounds ($16,935) for the draft of \\\"Ain't no telling\\\", which Hendrix penned on a piece of London hotel stationery in late 1966.",
+    "$captioning": "<HOSTNAME>/static/samples/trees_in_snow.jpg",
+    "$pairText1": "Look at this! It's a brand new product",
+    "$pairText2": "Look at this! It's an awesome piece of sh*t"
+  },
+  "upload": {
+    "TextRaw": "To have faith is to trust yourself to the water",
+    "TextUrl": "https://htx-pub.s3.amazonaws.com/example.txt",
+    "HyperText": "<a href='heartex.net'>Heartex</a>",
+    "Image": "<HOSTNAME>/static/samples/sample.jpg",
+    "Audio": "<HOSTNAME>/static/samples/game.wav",
+    "AudioPlus": "<HOSTNAME>/static/samples/game.wav",
+    "Header": "Task header",
+    "Paragraphs":  [{"author": "Alice", "text": "Hi, Bob."}, {"author": "Bob", "text": "Hello, Alice!"}, {"author": "Alice", "text": "What's up?"}, {"author": "Bob", "text": "Good. Ciao!"}, {"author": "Alice", "text": "Bye, Bob."}],
+    "Table": {"Card number": 18799210, "First name": "Max", "Last name":  "Nobel"},
+    "$videoHack": "<video src='static/samples/opossum_snow.mp4' width=100% controls>",
+    "Video": "<HOSTNAME>/static/samples/opossum_snow.mp4",
+    "$longText": "Opossums are frequently considered to be living fossils, and as a result are often used to approximate the ancestral therian condition in comparative studies. However, this is inaccurate, the oldest opossum fossils are early Miocene in age (roughly 20 million years old) and the last common ancestor of all living opossums approximately dates to the Oligocene-Miocene boundary (roughly 23 million years ago) and is at most no older than Oligocene in age. Many extinct metatherians once considered early opossums, such as Alphadon, Peradectes, Herpetotherium, and Pucadelphys, have since been recognized to have been previously grouped with opossums on the basis of plesiomorphies and are now considered to represent older branches of Metatheria only distantly related to modern opossums.",
+    "$pdf": "<embed src='<HOSTNAME>/static/samples/sample.pdf' width='100%' height='600px'/>",
+    "$website": "<iframe src='https://heartex.ai' width='100%' height='600px'/>",
+    "$headlessCsv": "<HOSTNAME>/static/samples/sample-task-sin-headless.csv"
+  }
+}

label_studio_sdk/{label_interface → _legacy/label_interface}/interface.py

@@ -16,20 +16,20 @@ from collections import defaultdict
 from lxml import etree
 import xmljson
 
-from label_studio_sdk.exceptions import (
+from label_studio_sdk._legacy.exceptions import (
     LSConfigParseException,
     LabelStudioXMLSyntaxErrorSentryIgnored,
     LabelStudioValidationErrorSentryIgnored,
 )
 
-from label_studio_sdk.label_interface.control_tags import (
+from label_studio_sdk._legacy.label_interface.control_tags import (
     ControlTag,
     ChoicesTag,
     LabelsTag,
 )
-from label_studio_sdk.label_interface.object_tags import ObjectTag
-from label_studio_sdk.label_interface.label_tags import LabelTag
-from label_studio_sdk.objects import AnnotationValue, TaskValue, PredictionValue
+from label_studio_sdk._legacy.label_interface.object_tags import ObjectTag
+from label_studio_sdk._legacy.label_interface.label_tags import LabelTag
+from label_studio_sdk._legacy.objects import AnnotationValue, TaskValue, PredictionValue
 
 
 dir_path = os.path.dirname(os.path.realpath(__file__))
@@ -429,7 +429,10 @@ class LabelInterface:
 
             elif LabelTag.validate_node(tag):
                 lb = LabelTag.parse_node(tag, controls)
-                labels[lb.parent_name][lb.value] = lb
+                # This case is hit when Label tag is missing `value` and `alias`
+                # For now we will skip that Label, but in future might want to raise an error
+                if lb:
+                    labels[lb.parent_name][lb.value] = lb
 
         return controls, objects, labels, xml_tree
 

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

@@ -11,8 +11,8 @@ from pathlib import Path
 from random import sample, shuffle
 from typing import Optional, Union, List, Dict, Callable
 
-from label_studio_tools.core.label_config import parse_config
-from label_studio_tools.core.utils.io import get_local_path
+from label_studio_sdk._extensions.label_studio_tools.core.label_config import parse_config
+from label_studio_sdk._extensions.label_studio_tools.core.utils.io import get_local_path
 from requests import Response
 from requests.exceptions import HTTPError, InvalidSchema, MissingSchema
 

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.
+