label-studio-sdk 1.0.18__tar.gz → 1.0.19__tar.gz

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: label-studio-sdk
-Version: 1.0.18
+Version: 1.0.19
 Summary: 
 Requires-Python: >=3.9,<4
 Classifier: Intended Audience :: Developers
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Dist: Pillow (>=10.0.1)
+Requires-Dist: Pillow (>=11.3.0)
 Requires-Dist: appdirs (>=1.4.3)
 Requires-Dist: datamodel-code-generator (==0.26.1)
 Requires-Dist: httpx (>=0.21.2)
@@ -38,6 +38,7 @@ 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: urllib3 (>=2.5.0)
 Requires-Dist: xmljson (==0.2.1)
 Project-URL: Repository, https://github.com/HumanSignal/label-studio-sdk
 Description-Content-Type: text/markdown

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/pyproject.toml

@@ -3,7 +3,7 @@ name = "label-studio-sdk"
 
 [tool.poetry]
 name = "label-studio-sdk"
-version = "1.0.18"
+version = "1.0.19"
 description = ""
 readme = "README.md"
 authors = []
@@ -35,7 +35,7 @@ Repository = 'https://github.com/HumanSignal/label-studio-sdk'
 
 [tool.poetry.dependencies]
 python = ">=3.9,<4"
-Pillow = ">=10.0.1"
+Pillow = ">=11.3.0"
 appdirs = ">=1.4.3"
 datamodel-code-generator = "0.26.1"
 httpx = ">=0.21.2"
@@ -54,6 +54,7 @@ requests = ">=2.22.0"
 requests-mock = "1.12.1"
 typing_extensions = ">= 4.0.0"
 ujson = ">=5.8.0"
+urllib3 = ">=2.5.0"
 xmljson = "0.2.1"
 
 [tool.poetry.dev-dependencies]

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/src/label_studio_sdk/__init__.py

@@ -159,7 +159,13 @@ from .ml import (
     MlUpdateResponse,
     MlUpdateResponseAuthMethod,
 )
-from .projects import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse, ProjectsUpdateResponse
+from .projects import (
+    ProjectsCreateResponse,
+    ProjectsImportTasksResponse,
+    ProjectsListRequestFilter,
+    ProjectsListResponse,
+    ProjectsUpdateResponse,
+)
 from .prompts import (
     PromptsBatchFailedPredictionsRequestFailedPredictionsItem,
     PromptsBatchFailedPredictionsResponse,
@@ -293,6 +299,7 @@ __all__ = [
     "ProjectSkipQueue",
     "ProjectsCreateResponse",
     "ProjectsImportTasksResponse",
+    "ProjectsListRequestFilter",
     "ProjectsListResponse",
     "ProjectsUpdateResponse",
     "Prompt",

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/src/label_studio_sdk/_extensions/label_studio_tools/core/label_config.py

@@ -134,7 +134,7 @@ def has_variable(actual_value):
     :param actual_value: value to check
     :return: True if value has variable
     """
-    expression = "^\$[A-Za-z_]+$"
+    expression = r"^\$[A-Za-z_]+$"
     pattern = re.compile(expression)
     full_match = pattern.fullmatch(actual_value)
     if full_match:

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/src/label_studio_sdk/converter/converter.py

@@ -582,13 +582,26 @@ class Converter(object):
         self._check_format(Format.JSON)
         ensure_dir(output_dir)
         output_file = os.path.join(output_dir, "result.json")
-        records = []
+
         if is_dir:
-            for json_file in glob(os.path.join(input_data, "*.json")):
-                with io.open(json_file, encoding="utf8") as f:
-                    records.append(json.load(f))
+            # Memory-optimized: stream JSON writing instead of accumulating in memory
             with io.open(output_file, mode="w", encoding="utf8") as fout:
-                json.dump(records, fout, indent=2, ensure_ascii=False)
+                fout.write("[\n")
+                first_record = True
+
+                for json_file in glob(os.path.join(input_data, "*.json")):
+                    with io.open(json_file, encoding="utf8") as f:
+                        record = json.load(f)
+
+                        if not first_record:
+                            fout.write(",\n")
+                        json.dump(record, fout, indent=2, ensure_ascii=False)
+                        first_record = False
+
+                        # Free memory immediately
+                        del record
+
+                fout.write("\n]")
         else:
             copy2(input_data, output_file)
 
@@ -596,26 +609,39 @@ class Converter(object):
         self._check_format(Format.JSON_MIN)
         ensure_dir(output_dir)
         output_file = os.path.join(output_dir, "result.json")
-        records = []
         item_iterator = self.iter_from_dir if is_dir else self.iter_from_json_file
 
-        for item in item_iterator(input_data):
-            record = deepcopy(item["input"])
-            if item.get("id") is not None:
-                record["id"] = item["id"]
-            for name, value in item["output"].items():
-                record[name] = prettify_result(value)
-            record["annotator"] = get_annotator(item, int_id=True)
-            record["annotation_id"] = item["annotation_id"]
-            record["created_at"] = item["created_at"]
-            record["updated_at"] = item["updated_at"]
-            record["lead_time"] = item["lead_time"]
-            if "agreement" in item:
-                record["agreement"] = item["agreement"]
-            records.append(record)
-
         with io.open(output_file, mode="w", encoding="utf8") as fout:
-            json.dump(records, fout, indent=2, ensure_ascii=False)
+            fout.write("[\n")
+            first_record = True
+
+            for item in item_iterator(input_data):
+                # SAFE memory optimization: use json serialization/deserialization
+                # This avoids deepcopy but ensures complete isolation of objects
+                record = json.loads(json.dumps(item["input"]))
+
+                if item.get("id") is not None:
+                    record["id"] = item["id"]
+                for name, value in item["output"].items():
+                    record[name] = prettify_result(value)
+                record["annotator"] = get_annotator(item, int_id=True)
+                record["annotation_id"] = item["annotation_id"]
+                record["created_at"] = item["created_at"]
+                record["updated_at"] = item["updated_at"]
+                record["lead_time"] = item["lead_time"]
+                if "agreement" in item:
+                    record["agreement"] = item["agreement"]
+
+                # Write record to file immediately
+                if not first_record:
+                    fout.write(",\n")
+                json.dump(record, fout, indent=2, ensure_ascii=False)
+                first_record = False
+
+                # Explicitly delete record to free memory
+                del record
+
+            fout.write("\n]")
 
     def convert_to_csv(self, input_data, output_dir, is_dir=True, **kwargs):
         self._check_format(Format.CSV)

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/src/label_studio_sdk/files/client.py

@@ -119,7 +119,7 @@ class FilesClient:
 
         You will need to include the file data in the request body. For example:
         ```bash
-        curl -H 'Authorization: Token abc123' \ -X POST 'https://localhost:8080/api/import/file-upload/245' -F ‘file=@path/to/my_file.csv’
+        curl -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/import/file-upload/245' -F 'file=@path/to/my_file.csv'
         ```
 
         Parameters
@@ -445,7 +445,7 @@ class AsyncFilesClient:
 
         You will need to include the file data in the request body. For example:
         ```bash
-        curl -H 'Authorization: Token abc123' \ -X POST 'https://localhost:8080/api/import/file-upload/245' -F ‘file=@path/to/my_file.csv’
+        curl -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/import/file-upload/245' -F 'file=@path/to/my_file.csv'
         ```
 
         Parameters

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/src/label_studio_sdk/projects/__init__.py

@@ -1,6 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import ProjectsCreateResponse, ProjectsImportTasksResponse, ProjectsListResponse, ProjectsUpdateResponse
+from .types import (
+    ProjectsCreateResponse,
+    ProjectsImportTasksResponse,
+    ProjectsListRequestFilter,
+    ProjectsListResponse,
+    ProjectsUpdateResponse,
+)
 from . import exports, pauses
 from .exports import ExportsConvertResponse, ExportsListFormatsResponseItem
 
@@ -9,6 +15,7 @@ __all__ = [
     "ExportsListFormatsResponseItem",
     "ProjectsCreateResponse",
     "ProjectsImportTasksResponse",
+    "ProjectsListRequestFilter",
     "ProjectsListResponse",
     "ProjectsUpdateResponse",
     "exports",

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/src/label_studio_sdk/projects/client.py

@@ -4,6 +4,7 @@ import typing
 from ..core.client_wrapper import SyncClientWrapper
 from .pauses.client import PausesClient
 from .exports.client import ExportsClient
+from .types.projects_list_request_filter import ProjectsListRequestFilter
 from ..core.request_options import RequestOptions
 from ..core.pagination import SyncPager
 from ..types.project import Project
@@ -41,6 +42,8 @@ class ProjectsClient:
         page: typing.Optional[int] = None,
         page_size: typing.Optional[int] = None,
         workspaces: typing.Optional[int] = None,
+        include: typing.Optional[str] = None,
+        filter: typing.Optional[ProjectsListRequestFilter] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> SyncPager[Project]:
         """
@@ -75,6 +78,12 @@ class ProjectsClient:
         workspaces : typing.Optional[int]
             workspaces
 
+        include : typing.Optional[str]
+            Comma-separated list of count fields to include in the response to optimize performance.  Available fields: task_number, finished_task_number, total_predictions_number,  total_annotations_number, num_tasks_with_annotations, useful_annotation_number,  ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.
+
+        filter : typing.Optional[ProjectsListRequestFilter]
+            Filter projects by pinned status. Use 'pinned_only' to return only pinned projects,  'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -90,7 +99,9 @@ class ProjectsClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        response = client.projects.list()
+        response = client.projects.list(
+            include="task_number,total_annotations_number,num_tasks_with_annotations",
+        )
         for item in response:
             yield item
         # alternatively, you can paginate page-by-page
@@ -108,6 +119,8 @@ class ProjectsClient:
                 "page": page,
                 "page_size": page_size,
                 "workspaces": workspaces,
+                "include": include,
+                "filter": filter,
             },
             request_options=request_options,
         )
@@ -128,6 +141,8 @@ class ProjectsClient:
                     page=page + 1,
                     page_size=page_size,
                     workspaces=workspaces,
+                    include=include,
+                    filter=filter,
                     request_options=request_options,
                 )
                 _items = _parsed_response.results
@@ -207,7 +222,7 @@ class ProjectsClient:
             Project color in HEX format
 
         control_weights : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: \{'my_bbox': \{'type': 'RectangleLabels', 'labels': \{'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
+            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
 
 
         workspace : typing.Optional[int]
@@ -441,7 +456,7 @@ class ProjectsClient:
             Project color in HEX format
 
         control_weights : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: \{'my_bbox': \{'type': 'RectangleLabels', 'labels': \{'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
+            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
 
 
         workspace : typing.Optional[int]
@@ -520,84 +535,80 @@ class ProjectsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProjectsImportTasksResponse:
         """
-        
+
         Use this API endpoint to import labeling tasks in bulk. Note that each POST request is limited at 250K tasks and 200 MB.
-        The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list). 
-        
+        The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list).
+
         <Note>
-        Imported data is verified against a project *label_config* and must include all variables that were used in the *label_config*. 
-        
+        Imported data is verified against a project *label_config* and must include all variables that were used in the *label_config*.
+
         For example, if the label configuration has a *$text* variable, then each item in a data object must include a `text` field.
         </Note>
-        
+
         There are three possible ways to import tasks with this endpoint:
-        
-        #### 1\. **POST with data**
+
+        #### 1. **POST with data**
         Send JSON tasks as POST data. Only JSON is supported for POSTing files directly.
-        
+
         Update this example to specify your authorization token and Label Studio instance host, then run the following from
         the command line:
-        
+
         ```bash
-        curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' \
-        -X POST 'https://localhost:8080/api/projects/1/import' --data '[{"text": "Some text 1"}, {"text": "Some text 2"}]'
+        curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/projects/1/import' --data '[{"text": "Some text 1"}, {"text": "Some text 2"}]'
         ```
-        
-        #### 2\. **POST with files**
+
+        #### 2. **POST with files**
         Send tasks as files. You can attach multiple files with different names.
-        
+
         - **JSON**: text files in JavaScript object notation format
         - **CSV**: text files with tables in Comma Separated Values format
         - **TSV**: text files with tables in Tab Separated Value format
         - **TXT**: simple text files are similar to CSV with one column and no header, supported for projects with one source only
-        
+
         Update this example to specify your authorization token, Label Studio instance host, and file name and path,
         then run the following from the command line:
-        
+
         ```bash
-        curl -H 'Authorization: Token abc123' \
-        -X POST 'https://localhost:8080/api/projects/1/import' -F ‘file=@path/to/my_file.csv’
+        curl -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/projects/1/import' -F 'file=@path/to/my_file.csv'
         ```
-        
-        #### 3\. **POST with URL**
+
+        #### 3. **POST with URL**
         You can also provide a URL to a file with labeling tasks. Supported file formats are the same as in option 2.
-        
+
         ```bash
-        curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' \
-        -X POST 'https://localhost:8080/api/projects/1/import' \
-        --data '[{"url": "http://example.com/test1.csv"}, {"url": "http://example.com/test2.csv"}]'
+        curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/projects/1/import' --data '[{"url": "http://example.com/test1.csv"}, {"url": "http://example.com/test2.csv"}]'
         ```
-        
+
         <br>
-        
+
         Parameters
         ----------
         id : int
             A unique integer value identifying this project.
-        
+
         request : typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]
-        
+
         commit_to_project : typing.Optional[bool]
             Set to "true" to immediately commit tasks to the project.
-        
+
         return_task_ids : typing.Optional[bool]
             Set to "true" to return task IDs in the response.
-        
+
         preannotated_from_fields : typing.Optional[typing.Union[str, typing.Sequence[str]]]
             List of fields to preannotate from the task data. For example, if you provide a list of `{"text": "text", "prediction": "label"}` items in the request, the system will create a task with the `text` field and a prediction with the `label` field when `preannoted_from_fields=["prediction"]`.
-        
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
-        
+
         Returns
         -------
         ProjectsImportTasksResponse
             Tasks successfully imported
-        
+
         Examples
         --------
         from label_studio_sdk import LabelStudio
-        
+
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
@@ -718,6 +729,8 @@ class AsyncProjectsClient:
         page: typing.Optional[int] = None,
         page_size: typing.Optional[int] = None,
         workspaces: typing.Optional[int] = None,
+        include: typing.Optional[str] = None,
+        filter: typing.Optional[ProjectsListRequestFilter] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncPager[Project]:
         """
@@ -752,6 +765,12 @@ class AsyncProjectsClient:
         workspaces : typing.Optional[int]
             workspaces
 
+        include : typing.Optional[str]
+            Comma-separated list of count fields to include in the response to optimize performance.  Available fields: task_number, finished_task_number, total_predictions_number,  total_annotations_number, num_tasks_with_annotations, useful_annotation_number,  ground_truth_number, skipped_annotations_number. If not specified, all count fields are included.
+
+        filter : typing.Optional[ProjectsListRequestFilter]
+            Filter projects by pinned status. Use 'pinned_only' to return only pinned projects,  'exclude_pinned' to return only non-pinned projects, or 'all' to return all projects.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -772,7 +791,9 @@ class AsyncProjectsClient:
 
 
         async def main() -> None:
-            response = await client.projects.list()
+            response = await client.projects.list(
+                include="task_number,total_annotations_number,num_tasks_with_annotations",
+            )
             async for item in response:
                 yield item
             # alternatively, you can paginate page-by-page
@@ -793,6 +814,8 @@ class AsyncProjectsClient:
                 "page": page,
                 "page_size": page_size,
                 "workspaces": workspaces,
+                "include": include,
+                "filter": filter,
             },
             request_options=request_options,
         )
@@ -813,6 +836,8 @@ class AsyncProjectsClient:
                     page=page + 1,
                     page_size=page_size,
                     workspaces=workspaces,
+                    include=include,
+                    filter=filter,
                     request_options=request_options,
                 )
                 _items = _parsed_response.results
@@ -892,7 +917,7 @@ class AsyncProjectsClient:
             Project color in HEX format
 
         control_weights : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: \{'my_bbox': \{'type': 'RectangleLabels', 'labels': \{'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
+            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
 
 
         workspace : typing.Optional[int]
@@ -1150,7 +1175,7 @@ class AsyncProjectsClient:
             Project color in HEX format
 
         control_weights : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
-            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: \{'my_bbox': \{'type': 'RectangleLabels', 'labels': \{'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
+            Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}}
 
 
         workspace : typing.Optional[int]
@@ -1237,98 +1262,94 @@ class AsyncProjectsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ProjectsImportTasksResponse:
         """
-        
+
         Use this API endpoint to import labeling tasks in bulk. Note that each POST request is limited at 250K tasks and 200 MB.
-        The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list). 
-        
+        The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../projects/list).
+
         <Note>
-        Imported data is verified against a project *label_config* and must include all variables that were used in the *label_config*. 
-        
+        Imported data is verified against a project *label_config* and must include all variables that were used in the *label_config*.
+
         For example, if the label configuration has a *$text* variable, then each item in a data object must include a `text` field.
         </Note>
-        
+
         There are three possible ways to import tasks with this endpoint:
-        
-        #### 1\. **POST with data**
+
+        #### 1. **POST with data**
         Send JSON tasks as POST data. Only JSON is supported for POSTing files directly.
-        
+
         Update this example to specify your authorization token and Label Studio instance host, then run the following from
         the command line:
-        
+
         ```bash
-        curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' \
-        -X POST 'https://localhost:8080/api/projects/1/import' --data '[{"text": "Some text 1"}, {"text": "Some text 2"}]'
+        curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/projects/1/import' --data '[{"text": "Some text 1"}, {"text": "Some text 2"}]'
         ```
-        
-        #### 2\. **POST with files**
+
+        #### 2. **POST with files**
         Send tasks as files. You can attach multiple files with different names.
-        
+
         - **JSON**: text files in JavaScript object notation format
         - **CSV**: text files with tables in Comma Separated Values format
         - **TSV**: text files with tables in Tab Separated Value format
         - **TXT**: simple text files are similar to CSV with one column and no header, supported for projects with one source only
-        
+
         Update this example to specify your authorization token, Label Studio instance host, and file name and path,
         then run the following from the command line:
-        
+
         ```bash
-        curl -H 'Authorization: Token abc123' \
-        -X POST 'https://localhost:8080/api/projects/1/import' -F ‘file=@path/to/my_file.csv’
+        curl -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/projects/1/import' -F 'file=@path/to/my_file.csv'
         ```
-        
-        #### 3\. **POST with URL**
+
+        #### 3. **POST with URL**
         You can also provide a URL to a file with labeling tasks. Supported file formats are the same as in option 2.
-        
+
         ```bash
-        curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' \
-        -X POST 'https://localhost:8080/api/projects/1/import' \
-        --data '[{"url": "http://example.com/test1.csv"}, {"url": "http://example.com/test2.csv"}]'
+        curl -H 'Content-Type: application/json' -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/projects/1/import' --data '[{"url": "http://example.com/test1.csv"}, {"url": "http://example.com/test2.csv"}]'
         ```
-        
+
         <br>
-        
+
         Parameters
         ----------
         id : int
             A unique integer value identifying this project.
-        
+
         request : typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]
-        
+
         commit_to_project : typing.Optional[bool]
             Set to "true" to immediately commit tasks to the project.
-        
+
         return_task_ids : typing.Optional[bool]
             Set to "true" to return task IDs in the response.
-        
+
         preannotated_from_fields : typing.Optional[typing.Union[str, typing.Sequence[str]]]
             List of fields to preannotate from the task data. For example, if you provide a list of `{"text": "text", "prediction": "label"}` items in the request, the system will create a task with the `text` field and a prediction with the `label` field when `preannoted_from_fields=["prediction"]`.
-        
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
-        
+
         Returns
         -------
         ProjectsImportTasksResponse
             Tasks successfully imported
-        
+
         Examples
         --------
         import asyncio
-        
+
         from label_studio_sdk import AsyncLabelStudio
-        
+
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        
-        
+
+
         async def main() -> None:
             await client.projects.import_tasks(
                 id=1,
                 request=[{"key": "value"}],
             )
-        
-        
+
+
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/src/label_studio_sdk/projects/exports/client.py

@@ -55,7 +55,7 @@ class ExportsClient:
         ```
         To export specific tasks with IDs of 123 and 345, run the following from the command line:
         ```bash
-        curl -X GET https://localhost:8080/api/projects/{id}/export?ids[]=123\&ids[]=345 -H 'Authorization: Token abc123' --output 'annotations.json'
+        curl -X GET "https://localhost:8080/api/projects/{id}/export?ids[]=123&ids[]=345" -H 'Authorization: Token abc123' --output 'annotations.json'
         ```
 
         You must provide a project ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../list).
@@ -604,7 +604,7 @@ class AsyncExportsClient:
         ```
         To export specific tasks with IDs of 123 and 345, run the following from the command line:
         ```bash
-        curl -X GET https://localhost:8080/api/projects/{id}/export?ids[]=123\&ids[]=345 -H 'Authorization: Token abc123' --output 'annotations.json'
+        curl -X GET "https://localhost:8080/api/projects/{id}/export?ids[]=123&ids[]=345" -H 'Authorization: Token abc123' --output 'annotations.json'
         ```
 
         You must provide a project ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../list).

{label_studio_sdk-1.0.18 → label_studio_sdk-1.0.19}/src/label_studio_sdk/projects/exports/client_ext.py

@@ -15,11 +15,11 @@ class ExportTimeoutError(ApiError):
         super().__init__(
             status_code=500,
             body=(
-                f"Export job timed out after {timeout} seconds: "
+                f"Export job timed out: "
                 f"unable to retrieve export job {export_snapshot.id}. "
                 f"Current status: {export_snapshot.status}. "
                 f"Try manually checking the running job with "
-                f"`ls.projects.exports.get(project_id={project_id}, export_pk={export_snapshot.id})`."
+                f"`ls.projects.exports.get(id=<PROJECT_ID>, export_pk={export_snapshot.id})`."
             )
         )