label-studio-sdk 2.0.0__py3-none-any.whl → 2.0.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of label-studio-sdk might be problematic. Click here for more details.

@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: label-studio-sdk
3
- Version: 2.0.0
3
+ Version: 2.0.1
4
4
  Summary:
5
5
  Requires-Python: >=3.9,<4
6
6
  Classifier: Intended Audience :: Developers
@@ -45,29 +45,6 @@ Description-Content-Type: text/markdown
45
45
 
46
46
  # Label Studio Python Library
47
47
 
48
- <!-- Note about deprecated version <1 -->
49
- ---
50
- > :warning: **Note**<br/>
51
- >
52
- > The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
53
- > If you still want to use the old version, you can install it with `pip install "label-studio-sdk<1"`.
54
- > OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
55
- >
56
- > ```sh
57
- > git clone https://github.com/HumanSignal/label-studio-sdk.git
58
- > cd label-studio-sdk
59
- > git fetch origin
60
- > git checkout release/0.0.34
61
- > ```
62
- >
63
- > OR you can change your import statements as follows:
64
- > ```python
65
- > from label_studio_sdk import Client
66
- > from label_studio_sdk.data_manager import Filters, Column, Operator, Type
67
- > from label_studio_sdk._legacy import Project
68
- > ```
69
- ---
70
-
71
48
  [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
72
49
  [![pypi](https://img.shields.io/pypi/v/label-studio-sdk.svg)](https://pypi.python.org/pypi/label-studio-sdk)
73
50
 
@@ -100,6 +77,77 @@ ls = LabelStudio(
100
77
  )
101
78
  ```
102
79
 
80
+ # Versions
81
+
82
+ ## SDK 2.0.0
83
+
84
+ In August 2025, we released SDK version 2.0.0.
85
+
86
+ This version has a number of documentation and functional improvements over SDK 1.
87
+
88
+ ### Enhancements
89
+
90
+ **Enterprise-only**
91
+
92
+ - Added a new `projects.stats.iaa` endpoint to return stats from the inter-annotator agreement matrix.
93
+ - You can now update tasks that have comments.
94
+ - Added support for `sync` to `S3s` (S3 with IAM role) exports.
95
+
96
+ **Enterprise and open source**
97
+
98
+ - Expanded support to include all project settings, many of which were missing in SDK 1. For example, in Enterprise environments you can now configure `assignment_settings`, `review_settings`, `annotator_evaluation`, and many more.
99
+ - Fixed passing the `project` parameter in `actions.list()` (broken in SDK 1).
100
+ - Relaxed request/response validation reduces pydantic errors in SDK 2.
101
+
102
+ ### Breaking changes
103
+
104
+ **Enterprise-only**
105
+
106
+ - `comments.create` no longer accepts a `project` argument.
107
+ - In `prompts.indicators`, the `pk` parameter is now `id`.
108
+ - In `prompts.runs` and `prompts.versions`, the `id` parameter is now `prompt_id`.
109
+ - `workspaces.members.list` responses are now objects instead of dictionaries.
110
+
111
+ **Enterprise and open source**
112
+
113
+ - In `projects.exports` calls, the project ID is now passed as `id`, while the export ID is passed as `export_pk`.
114
+ - Predictions returned in task responses are now objects instead of dictionaries.
115
+
116
+ ## SDK 1.0+
117
+
118
+ SDK 1 was released in June 2024.
119
+
120
+ If you use the Label Studio SDK 1 package in any automated pipelines, we strongly recommend pinning your SDK version to `<2.0.0` until you can reconcile the breaking changes.
121
+
122
+
123
+ ## SDK <1
124
+
125
+ The version of `label-studio-sdk<1` is deprecated and no longer supported. We recommend updating to the latest version.
126
+
127
+ <details>
128
+
129
+ <summary> To use SDK <1 </summary>
130
+
131
+ If you still want to use the deprecated version, you can install it with `pip install "label-studio-sdk<1"`.
132
+
133
+ OR You can find the branch with the old version by cloning the repository and checking out the branch as follows:
134
+
135
+ ```sh
136
+ git clone https://github.com/HumanSignal/label-studio-sdk.git
137
+ cd label-studio-sdk
138
+ git fetch origin
139
+ git checkout release/0.0.34
140
+ ```
141
+
142
+ OR you can change your import statements as follows:
143
+ ```python
144
+ from label_studio_sdk import Client
145
+ from label_studio_sdk.data_manager import Filters, Column, Operator, Type
146
+ from label_studio_sdk._legacy import Project
147
+ ```
148
+
149
+ </details>
150
+
103
151
  # Examples
104
152
 
105
153
  Check more examples [here](https://api.labelstud.io/).
@@ -111,7 +159,7 @@ from label_studio_sdk.label_interface import LabelInterface
111
159
  from label_studio_sdk.label_interface.create import labels
112
160
 
113
161
  project = ls.projects.create(
114
- name="Project name",
162
+ title="Project name",
115
163
  description="Project description",
116
164
  label_config=LabelInterface.create({
117
165
  "image": "Image",
@@ -1,4 +1,4 @@
1
- label_studio_sdk/__init__.py,sha256=OiNObqTovR1qn_714BtghCoTGA1o1E7FsJLWaqmc0TA,15757
1
+ label_studio_sdk/__init__.py,sha256=jxaL_W9PeIdiJDHsTqtirq5MR0PAccQ8O_ZeOpeRnQk,16259
2
2
  label_studio_sdk/_extensions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
3
3
  label_studio_sdk/_extensions/eval/categorical.py,sha256=MxH2Jl8Mc6HS2byBnlRgABZgwMutSQdH3tgspwCkxqk,2703
4
4
  label_studio_sdk/_extensions/label_studio_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -45,7 +45,9 @@ label_studio_sdk/annotations/client.py,sha256=s_nOeKqt5VQSEYflzwtrTrGdvpJKvCpKRO
45
45
  label_studio_sdk/annotations/types/__init__.py,sha256=fFJUpZiJV7q7otQJVzsz9wJ1R8j_5qnm59z6ktmhWhE,409
46
46
  label_studio_sdk/annotations/types/annotation_bulk_serializer_with_selected_items_request_last_action.py,sha256=bY82sf_78SmtUjwpSLEmL6UfSFcXjpPCc9sRDqNUEDs,273
47
47
  label_studio_sdk/annotations/types/annotations_create_bulk_response_item.py,sha256=I-yNfeAGxx1sSeG2QQd_EHFo2m2xHOI7PEfZFWQAWMU,631
48
- label_studio_sdk/base_client.py,sha256=3AgqVkK09iMwYbXp4JO7o0Z-YdwjPYFw9t9rmvakUek,10808
48
+ label_studio_sdk/base_client.py,sha256=wk_mEGWF8cBkkXjujoLq_QKZNd5pq8RhibF4tx1glp8,11050
49
+ label_studio_sdk/billing/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
50
+ label_studio_sdk/billing/client.py,sha256=EvXxch0d-6DRnh1fSIqOr51VQcM1EDGPUN-TVNCgdGs,3642
49
51
  label_studio_sdk/client.py,sha256=g5YFI-U6OxGiGJ2aMqeREF1tGt-7LA5NSDl2CvW0wNA,916
50
52
  label_studio_sdk/comments/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
51
53
  label_studio_sdk/comments/client.py,sha256=jsChFd-CEemK3Grk_CBqaNl5O26EIK6Sp1PjLUL-4hc,27722
@@ -151,7 +153,7 @@ label_studio_sdk/model_providers/types/model_providers_list_model_provider_choic
151
153
  label_studio_sdk/organizations/__init__.py,sha256=4IfkSXstAMN7sS3_Z6jV9m75h2ER0bpaX_J_TO0WTPU,110
152
154
  label_studio_sdk/organizations/client.py,sha256=ujEB6lO8j5dCAOYXKh1kk0p_qawoaIrog86Xzl3euUg,10332
153
155
  label_studio_sdk/organizations/members/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
154
- label_studio_sdk/organizations/members/client.py,sha256=fjqaS2TUdLa0sSSSU9T9cAI_ensl_FohYmkCNzCxZNs,9575
156
+ label_studio_sdk/organizations/members/client.py,sha256=ug9M40jZQrO7K3mLpnoEanaheK5Xy6iFhLchGiOw3II,22677
155
157
  label_studio_sdk/predictions/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
156
158
  label_studio_sdk/predictions/client.py,sha256=-Smc64zABN4ApHSPY7HXrITPWvVBq886MeH0Yrv1viI,23930
157
159
  label_studio_sdk/projects/__init__.py,sha256=Oxo8EywDUm05kH9lhIuN8tbvNj00omDPnJmtqUsIB0o,1008
@@ -202,9 +204,9 @@ label_studio_sdk/tasks/types/tasks_list_request_fields.py,sha256=5YXxQgyzoaL0QjS
202
204
  label_studio_sdk/tokens/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
203
205
  label_studio_sdk/tokens/client.py,sha256=xcGl2ZA6Ojc9fZAbZQrqZ-yfBfllCUvvD4gzDM2HvW4,19125
204
206
  label_studio_sdk/tokens/client_ext.py,sha256=DJ4vEslU0BKragW51LjJW-AG1uogPiCeEGB3o6qtAK4,6030
205
- label_studio_sdk/types/__init__.py,sha256=GZUrPigjh7qFIIm20JSfhBRFo_HjmOt9BJL0F85J_Uw,14188
207
+ label_studio_sdk/types/__init__.py,sha256=hA2qJJSRkS4mHsZt85mGPYhsCBAA-ooc5C3RnSOboYw,14936
206
208
  label_studio_sdk/types/actions_enum.py,sha256=h2lpUstX459SfopuhWzpUONFhMYNkeWsddTxmTIx54k,575
207
- label_studio_sdk/types/all_roles_project_list.py,sha256=95EMk3xgRrtrfJkCQAmmLh2w3x32wwrVptH2zni4OzA,6395
209
+ label_studio_sdk/types/all_roles_project_list.py,sha256=7vDq_KsID6DUz4McDZLX0i7gvTCQqhPquymA-KzZH-Y,6395
208
210
  label_studio_sdk/types/all_roles_project_list_sampling.py,sha256=VfQKGeVtOlceTWajZu1I4JWnELn2JLOe0dKZPxlCnhg,219
209
211
  label_studio_sdk/types/all_roles_project_list_skip_queue.py,sha256=qG46c-oIEljyv5BtHLqGYqzQVSn57JhjUzp5ws2b1wQ,224
210
212
  label_studio_sdk/types/annotated_enum.py,sha256=27V8YMHtJtJITG-Ehwvgv7Y6ZEKPgK-9_qnbXvwxrYg,156
@@ -222,6 +224,9 @@ label_studio_sdk/types/azure_blob_export_storage.py,sha256=3l5fI10_sTdS5Mld_pmKP
222
224
  label_studio_sdk/types/azure_blob_import_storage.py,sha256=DRdOWOqT9m_oNybDsfx7yTtV-oWmGcAfyOVqatnYvsw,2577
223
225
  label_studio_sdk/types/batch_failed_predictions.py,sha256=VjE__mXOrsCmyB4ivULuedWr3X0Tpr4FWOvxtRm3VOM,634
224
226
  label_studio_sdk/types/batch_predictions.py,sha256=ZR0TvzMBZV2PnTerdfNNGgkDh5BwehTPxsSvLpGL7MM,617
227
+ label_studio_sdk/types/billing_checks.py,sha256=rXcZ_PYav6SF9_kRTzLiWtcy_F0-PZvIl0zafnjojiM,1276
228
+ label_studio_sdk/types/billing_flags.py,sha256=a1IxLHd0jt33DkCxie0RBouLWFF_wDuvVA8HZ4N80hM,1482
229
+ label_studio_sdk/types/billing_info_response.py,sha256=vvZyV_s4htMo-YN3dnQuduKKMvT7A_wcOMDjm312p8A,698
225
230
  label_studio_sdk/types/blank_enum.py,sha256=vYagq5xwjlI6eOtcMnnEH9O5IpIgKGXA2c-BkbOdI84,111
226
231
  label_studio_sdk/types/blueprint_list.py,sha256=H55EIio_NXLXC2rPQhxVjSNSqczYo35r61TPjUgrCys,895
227
232
  label_studio_sdk/types/budget_reset_period_enum.py,sha256=_GZlGEVuaFPG7Hv8OVzZEhczgXBB2pYUo2wXifjv8UY,166
@@ -231,6 +236,7 @@ label_studio_sdk/types/comment_request.py,sha256=yFc2pOIjR79KkY05wsg6UOPIredB4oc
231
236
  label_studio_sdk/types/comment_serializer_with_expanded_user.py,sha256=FK8fxhKvOky3f3BgC6i4RMu9UC22S2F6jDhYwzWGTqs,1472
232
237
  label_studio_sdk/types/converted_format.py,sha256=NDmMhmVBOUDVflW3lwkn9-NJYtUqVwHcwXtuPIeB6RY,793
233
238
  label_studio_sdk/types/converted_format_request.py,sha256=5nmGLN4BFb199vLV8AmNV1Jf0jQyclXlfdkI8-gs4gI,788
239
+ label_studio_sdk/types/count_limit.py,sha256=Gj_e9ajx9CFWV2PfEePnh7xy38kkQxlhE4MA9D6Hz5Y,628
234
240
  label_studio_sdk/types/custom_scripts_editable_by_enum.py,sha256=D6cvF_3KZd5SHfG5mZ4ymCw58tbjK_rNUBegjMchklw,163
235
241
  label_studio_sdk/types/default_role_enum.py,sha256=jgeievuDBcZDHc6aGlEUt0E4CybFWNr04vqAEuaBwNY,181
236
242
  label_studio_sdk/types/edition_enum.py,sha256=ve-LU0FMQIY3RcCdQ3iEPjscCz-kft8hZ77oYRX_MZ8,162
@@ -259,6 +265,7 @@ label_studio_sdk/types/lse_fields_trial_role.py,sha256=YVR9g-_xW2DNmlnGoxHf1Qizy
259
265
  label_studio_sdk/types/lse_key_indicator_value.py,sha256=UT2AcLLzJkzXroiRHqOILwfDDEwIKB7EU7XttyVcIqk,1041
260
266
  label_studio_sdk/types/lse_organization.py,sha256=HPVEeY_2Jti4Dih6kKnE3tDjbGQ31Akt5EoDb2efRyc,1794
261
267
  label_studio_sdk/types/lse_organization_custom_scripts_editable_by.py,sha256=y-IxR7V6xr6n_z934BXzg4pEjZ06FF-lcT6YiYjLMaM,278
268
+ label_studio_sdk/types/lse_organization_member_list.py,sha256=Pg_mYbWWTwa1RPoVYxl5yIXCqXK_4BBjPT83nrotraI,912
262
269
  label_studio_sdk/types/lse_project_create.py,sha256=qhqiLKw-a9zasRDm3jdDikLgGXhpbUXNw91amWlTvYs,6042
263
270
  label_studio_sdk/types/lse_project_create_sampling.py,sha256=IgKHAT26PDcAmDNKFPxDgMsmY1WYWPGikBSYI-fj60c,216
264
271
  label_studio_sdk/types/lse_project_create_skip_queue.py,sha256=MNCyF-K7MvppwVD9yByeZsEcCFAv3R46ufx3drzUWfs,221
@@ -290,6 +297,7 @@ label_studio_sdk/types/lse_task_serializer_for_reviewers_drafts_item.py,sha256=Y
290
297
  label_studio_sdk/types/lse_task_serializer_for_reviewers_predictions_item.py,sha256=FDlZS-bQXIiBi94dOlQIrSx_cblmW-dO8ySQFXH527A,1129
291
298
  label_studio_sdk/types/lse_user.py,sha256=jLGdOBRfYUBtIrurjmW7ecwVdISnI8S8D7dSG_bUaVQ,1592
292
299
  label_studio_sdk/types/lse_user_api.py,sha256=-TWyjZSYwU_92V-9KfepPVQ7zVtXwgWVhE13BPJDyLg,1520
300
+ label_studio_sdk/types/lse_user_organization_member_list.py,sha256=nDtzpEMUwMdtiv3pc-zi6HipUhcCvIokWqRG6B_DVy8,1523
293
301
  label_studio_sdk/types/lseapi_token_create.py,sha256=kn_SNy2LLrvGyA4dJo7qVscricaEs6oNvp61p6mGj94,603
294
302
  label_studio_sdk/types/lseapi_token_list.py,sha256=HAFDUDZzoeUKygKdEK8ztCDYq7qIz66bb8pp1alR84k,601
295
303
  label_studio_sdk/types/lsejwt_settings.py,sha256=CdlqzDqSJN5zxaGKi_aBzCgvXOIbFVg1_AVJcT4DWBI,1007
@@ -312,6 +320,7 @@ label_studio_sdk/types/organization_invite.py,sha256=j0eR1cAQ29Eb-z77yMbbvb487vS
312
320
  label_studio_sdk/types/organization_member.py,sha256=3a66PxnnfrEvDzXWvDa_LYIvU7eXqKYgeWAQIZWtsFQ,937
313
321
  label_studio_sdk/types/organization_membership.py,sha256=sKmy2M0UNl2Sp5nxpTTkJEfI8nwAlWQt8mYTXuYdRXA,663
314
322
  label_studio_sdk/types/paginated_all_roles_project_list_list.py,sha256=oOe6LOBdiy0LFlHjKeqGGnmmqMer6OxR7kPE2zS-7A4,760
323
+ label_studio_sdk/types/paginated_lse_organization_member_list_list.py,sha256=zTygAwXJ5BYD2tFHrpGQ40Fen-tcGpNib8oBt_C6P-4,784
315
324
  label_studio_sdk/types/paginated_role_based_task_list.py,sha256=d-fIE8kqfynKfnTpirLt_E2VMwsoXcNzFX1jT-hzbYY,904
316
325
  label_studio_sdk/types/pause.py,sha256=78SmA_e3gvI6F77j9MNATRGzyB0_PocnAer-nBt5_jc,2110
317
326
  label_studio_sdk/types/pause_request.py,sha256=vJHh0cYDICaxJsXsYjKvqR5-Hd3zxv1gPl1YIisefbo,1283
@@ -324,6 +333,7 @@ label_studio_sdk/types/project_label_config_request.py,sha256=O_IcPOADSztE02hkrC
324
333
  label_studio_sdk/types/project_sampling.py,sha256=n7U04PqHAIJ-53MqiQ9i6EyUn4RklVWu6KjZ-__FyhU,207
325
334
  label_studio_sdk/types/project_skip_queue.py,sha256=SW4RQaUGV9VmW_kUv9v6ngrReHt8YGeaxRKEIazYdjY,212
326
335
  label_studio_sdk/types/project_subset_enum.py,sha256=KuppmnQZwBtl3WD1g6B7Cosyf-S7_tYaB7PZvvD9GGs,167
336
+ label_studio_sdk/types/prompts_status_enum.py,sha256=g0EHGa6fJav2Xq7_eNowijMX_q9bzZkjoImOf_-KuXE,391
327
337
  label_studio_sdk/types/provider_enum.py,sha256=5WdjjsVnR3G2SCLsqYwRsCpgrNr96RuNiNMwiK5CNSc,230
328
338
  label_studio_sdk/types/reason_enum.py,sha256=WYuK-HZBEaq6Ta_83YbXi40eYrzmOQVBAMxDgsztZZ8,229
329
339
  label_studio_sdk/types/redis_export_storage.py,sha256=qlrYxE212UtceRd7AZ4fqbDHvm92oJ4TUZl25f4iq6k,2627
@@ -338,6 +348,7 @@ label_studio_sdk/types/review_settings_request_review_criteria.py,sha256=jbnHXIP
338
348
  label_studio_sdk/types/review_settings_requeue_rejected_tasks_mode.py,sha256=1Rb7RvttHvzEM_zAfrWF22lbd9Ah75d876T10bnxgVI,326
339
349
  label_studio_sdk/types/review_settings_review_criteria.py,sha256=jwNkr--dHJkoOzam1Xnji1zqzt8xjs2ToNNMgtfejfw,239
340
350
  label_studio_sdk/types/reviewed_enum.py,sha256=FsqYlxkK9Esx7zSiuIVLhMZeDMYocoZyKI_u2g8RHOw,155
351
+ label_studio_sdk/types/role9e7enum.py,sha256=nJoXEHF4O87K5PDqFn0HGG_AQ0LOeGPTWkZ-ggtgPDg,177
341
352
  label_studio_sdk/types/role_based_task.py,sha256=3zseKdoI_SIq_b2EUShS4o-fh7dDeIwiT-3QRwsSCro,367
342
353
  label_studio_sdk/types/s3export_storage.py,sha256=au1nB30x-aFQQE9a9cdcpYHUhMCyQ3JSvdFMCxMRsok,3110
343
354
  label_studio_sdk/types/s3import_storage.py,sha256=NEO9Ho41OZl_3PG_WjGKuBIdvKxJCYSO1dkUOAPZMe8,3287
@@ -418,7 +429,7 @@ label_studio_sdk/workspaces/__init__.py,sha256=4IfkSXstAMN7sS3_Z6jV9m75h2ER0bpaX
418
429
  label_studio_sdk/workspaces/client.py,sha256=7Zd4YvpX8tr1MCVXEY6Lk_8i4IMqi-tEDi80-sZuUPw,20578
419
430
  label_studio_sdk/workspaces/members/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
420
431
  label_studio_sdk/workspaces/members/client.py,sha256=kvEz36H4A2K1RPkPCGbHHtTaTrD7bJJEHA6yBTk43Jw,10592
421
- label_studio_sdk-2.0.0.dist-info/LICENSE,sha256=ymVrFcHiJGjHeY30NWZgdV-xzNEtfuC63oK9ZeMDjhs,11341
422
- label_studio_sdk-2.0.0.dist-info/METADATA,sha256=fpufQeyFYARffpvLBQeX1VOkvia9KyHob_prthoV80w,6065
423
- label_studio_sdk-2.0.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
424
- label_studio_sdk-2.0.0.dist-info/RECORD,,
432
+ label_studio_sdk-2.0.1.dist-info/LICENSE,sha256=ymVrFcHiJGjHeY30NWZgdV-xzNEtfuC63oK9ZeMDjhs,11341
433
+ label_studio_sdk-2.0.1.dist-info/METADATA,sha256=50TzORNpmd1nfvk7UUe3tvlD-JdFhigEW3S1faINRNQ,7650
434
+ label_studio_sdk-2.0.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
435
+ label_studio_sdk-2.0.1.dist-info/RECORD,,