label-studio-sdk 2.0.10__py3-none-any.whl → 2.0.11__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.

Files changed (51) hide show
  1. label_studio_sdk/activity_logs/client.py +12 -0
  2. label_studio_sdk/annotation_history/client.py +36 -0
  3. label_studio_sdk/annotation_reviews/client.py +60 -0
  4. label_studio_sdk/billing/client.py +12 -0
  5. label_studio_sdk/comments/client.py +72 -0
  6. label_studio_sdk/export_storage/azure_spi/client.py +84 -0
  7. label_studio_sdk/export_storage/databricks/client.py +84 -0
  8. label_studio_sdk/export_storage/gcswif/client.py +84 -0
  9. label_studio_sdk/export_storage/s3s/client.py +84 -0
  10. label_studio_sdk/import_storage/azure_spi/client.py +84 -0
  11. label_studio_sdk/import_storage/databricks/client.py +84 -0
  12. label_studio_sdk/import_storage/gcswif/client.py +84 -0
  13. label_studio_sdk/import_storage/s3s/client.py +84 -0
  14. label_studio_sdk/label_interface/control_tags.py +12 -7
  15. label_studio_sdk/ml/client.py +14 -2
  16. label_studio_sdk/model_providers/client.py +72 -0
  17. label_studio_sdk/organizations/client.py +30 -6
  18. label_studio_sdk/organizations/invites/client.py +24 -0
  19. label_studio_sdk/organizations/members/client.py +24 -0
  20. label_studio_sdk/organizations/permissions/client.py +60 -0
  21. label_studio_sdk/project_templates/client.py +76 -4
  22. label_studio_sdk/projects/__init__.py +6 -0
  23. label_studio_sdk/projects/assignments/client.py +60 -0
  24. label_studio_sdk/projects/client.py +12 -0
  25. label_studio_sdk/projects/members/bulk/client.py +24 -0
  26. label_studio_sdk/projects/members/client.py +12 -0
  27. label_studio_sdk/projects/members/paginated/client.py +12 -0
  28. label_studio_sdk/projects/metrics/client.py +24 -0
  29. label_studio_sdk/projects/pauses/client.py +60 -0
  30. label_studio_sdk/projects/stats/__init__.py +6 -0
  31. label_studio_sdk/projects/stats/client.py +486 -1
  32. label_studio_sdk/projects/stats/types/__init__.py +6 -0
  33. label_studio_sdk/projects/stats/types/stats_model_version_annotator_agreement_response.py +19 -0
  34. label_studio_sdk/projects/stats/types/stats_model_version_ground_truth_agreement_response.py +19 -0
  35. label_studio_sdk/projects/stats/types/stats_model_version_prediction_agreement_response.py +19 -0
  36. label_studio_sdk/prompts/client.py +96 -0
  37. label_studio_sdk/prompts/indicators/client.py +24 -0
  38. label_studio_sdk/prompts/runs/client.py +36 -0
  39. label_studio_sdk/prompts/versions/client.py +84 -0
  40. label_studio_sdk/sso/saml/client.py +24 -0
  41. label_studio_sdk/sso/scim/client.py +24 -0
  42. label_studio_sdk/types/default_role.py +2 -2
  43. label_studio_sdk/types/lse_organization.py +1 -1
  44. label_studio_sdk/types/project_template.py +1 -1
  45. label_studio_sdk/types/project_template_request.py +1 -1
  46. label_studio_sdk/users/client.py +24 -0
  47. label_studio_sdk/versions/client.py +12 -0
  48. {label_studio_sdk-2.0.10.dist-info → label_studio_sdk-2.0.11.dist-info}/METADATA +1 -1
  49. {label_studio_sdk-2.0.10.dist-info → label_studio_sdk-2.0.11.dist-info}/RECORD +51 -48
  50. {label_studio_sdk-2.0.10.dist-info → label_studio_sdk-2.0.11.dist-info}/LICENSE +0 -0
  51. {label_studio_sdk-2.0.10.dist-info → label_studio_sdk-2.0.11.dist-info}/WHEEL +0 -0
label_studio_sdk/prompts/client.py CHANGED
@@ -48,6 +48,12 @@ class PromptsClient:
48
48
  request_options: typing.Optional[RequestOptions] = None,
49
49
  ) -> BatchFailedPredictions:
50
50
  """
51
+ <Card href="https://humansignal.com/goenterprise">
52
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
53
+ <p style="margin-top: 10px; font-size: 14px;">
54
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
55
+ </p>
56
+ </Card>
51
57
  Create a new batch of failed predictions.
52
58
 
53
59
  Parameters
@@ -122,6 +128,12 @@ class PromptsClient:
122
128
  request_options: typing.Optional[RequestOptions] = None,
123
129
  ) -> BatchPredictions:
124
130
  """
131
+ <Card href="https://humansignal.com/goenterprise">
132
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
133
+ <p style="margin-top: 10px; font-size: 14px;">
134
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
135
+ </p>
136
+ </Card>
125
137
  Create a new batch prediction.
126
138
 
127
139
  Parameters
@@ -200,6 +212,12 @@ class PromptsClient:
200
212
  request_options: typing.Optional[RequestOptions] = None,
201
213
  ) -> PaginatedProjectSubsetTasksResponseList:
202
214
  """
215
+ <Card href="https://humansignal.com/goenterprise">
216
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
217
+ <p style="margin-top: 10px; font-size: 14px;">
218
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
219
+ </p>
220
+ </Card>
203
221
 
204
222
  Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.
205
223
 
@@ -294,6 +312,12 @@ class PromptsClient:
294
312
  request_options: typing.Optional[RequestOptions] = None,
295
313
  ) -> typing.List[ProjectSubsetItem]:
296
314
  """
315
+ <Card href="https://humansignal.com/goenterprise">
316
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
317
+ <p style="margin-top: 10px; font-size: 14px;">
318
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
319
+ </p>
320
+ </Card>
297
321
 
298
322
  Provides list of available subsets for a project along with count of tasks in each subset
299
323
 
@@ -410,6 +434,12 @@ class PromptsClient:
410
434
  request_options: typing.Optional[RequestOptions] = None,
411
435
  ) -> ModelInterface:
412
436
  """
437
+ <Card href="https://humansignal.com/goenterprise">
438
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
439
+ <p style="margin-top: 10px; font-size: 14px;">
440
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
441
+ </p>
442
+ </Card>
413
443
  Create a new prompt.
414
444
 
415
445
  Parameters
@@ -554,6 +584,12 @@ class PromptsClient:
554
584
 
555
585
  def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ModelInterfaceSerializerGet:
556
586
  """
587
+ <Card href="https://humansignal.com/goenterprise">
588
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
589
+ <p style="margin-top: 10px; font-size: 14px;">
590
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
591
+ </p>
592
+ </Card>
557
593
  Retrieve a specific prompt.
558
594
 
559
595
  Parameters
@@ -600,6 +636,12 @@ class PromptsClient:
600
636
 
601
637
  def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
602
638
  """
639
+ <Card href="https://humansignal.com/goenterprise">
640
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
641
+ <p style="margin-top: 10px; font-size: 14px;">
642
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
643
+ </p>
644
+ </Card>
603
645
  Delete a prompt by ID
604
646
 
605
647
  Parameters
@@ -652,6 +694,12 @@ class PromptsClient:
652
694
  request_options: typing.Optional[RequestOptions] = None,
653
695
  ) -> ModelInterface:
654
696
  """
697
+ <Card href="https://humansignal.com/goenterprise">
698
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
699
+ <p style="margin-top: 10px; font-size: 14px;">
700
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
701
+ </p>
702
+ </Card>
655
703
  Update a specific prompt by ID.
656
704
 
657
705
  Parameters
@@ -749,6 +797,12 @@ class AsyncPromptsClient:
749
797
  request_options: typing.Optional[RequestOptions] = None,
750
798
  ) -> BatchFailedPredictions:
751
799
  """
800
+ <Card href="https://humansignal.com/goenterprise">
801
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
802
+ <p style="margin-top: 10px; font-size: 14px;">
803
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
804
+ </p>
805
+ </Card>
752
806
  Create a new batch of failed predictions.
753
807
 
754
808
  Parameters
@@ -831,6 +885,12 @@ class AsyncPromptsClient:
831
885
  request_options: typing.Optional[RequestOptions] = None,
832
886
  ) -> BatchPredictions:
833
887
  """
888
+ <Card href="https://humansignal.com/goenterprise">
889
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
890
+ <p style="margin-top: 10px; font-size: 14px;">
891
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
892
+ </p>
893
+ </Card>
834
894
  Create a new batch prediction.
835
895
 
836
896
  Parameters
@@ -917,6 +977,12 @@ class AsyncPromptsClient:
917
977
  request_options: typing.Optional[RequestOptions] = None,
918
978
  ) -> PaginatedProjectSubsetTasksResponseList:
919
979
  """
980
+ <Card href="https://humansignal.com/goenterprise">
981
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
982
+ <p style="margin-top: 10px; font-size: 14px;">
983
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
984
+ </p>
985
+ </Card>
920
986
 
921
987
  Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.
922
988
 
@@ -1019,6 +1085,12 @@ class AsyncPromptsClient:
1019
1085
  request_options: typing.Optional[RequestOptions] = None,
1020
1086
  ) -> typing.List[ProjectSubsetItem]:
1021
1087
  """
1088
+ <Card href="https://humansignal.com/goenterprise">
1089
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
1090
+ <p style="margin-top: 10px; font-size: 14px;">
1091
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
1092
+ </p>
1093
+ </Card>
1022
1094
 
1023
1095
  Provides list of available subsets for a project along with count of tasks in each subset
1024
1096
 
@@ -1151,6 +1223,12 @@ class AsyncPromptsClient:
1151
1223
  request_options: typing.Optional[RequestOptions] = None,
1152
1224
  ) -> ModelInterface:
1153
1225
  """
1226
+ <Card href="https://humansignal.com/goenterprise">
1227
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
1228
+ <p style="margin-top: 10px; font-size: 14px;">
1229
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
1230
+ </p>
1231
+ </Card>
1154
1232
  Create a new prompt.
1155
1233
 
1156
1234
  Parameters
@@ -1313,6 +1391,12 @@ class AsyncPromptsClient:
1313
1391
  self, id: str, *, request_options: typing.Optional[RequestOptions] = None
1314
1392
  ) -> ModelInterfaceSerializerGet:
1315
1393
  """
1394
+ <Card href="https://humansignal.com/goenterprise">
1395
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
1396
+ <p style="margin-top: 10px; font-size: 14px;">
1397
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
1398
+ </p>
1399
+ </Card>
1316
1400
  Retrieve a specific prompt.
1317
1401
 
1318
1402
  Parameters
@@ -1367,6 +1451,12 @@ class AsyncPromptsClient:
1367
1451
 
1368
1452
  async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
1369
1453
  """
1454
+ <Card href="https://humansignal.com/goenterprise">
1455
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
1456
+ <p style="margin-top: 10px; font-size: 14px;">
1457
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
1458
+ </p>
1459
+ </Card>
1370
1460
  Delete a prompt by ID
1371
1461
 
1372
1462
  Parameters
@@ -1427,6 +1517,12 @@ class AsyncPromptsClient:
1427
1517
  request_options: typing.Optional[RequestOptions] = None,
1428
1518
  ) -> ModelInterface:
1429
1519
  """
1520
+ <Card href="https://humansignal.com/goenterprise">
1521
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
1522
+ <p style="margin-top: 10px; font-size: 14px;">
1523
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
1524
+ </p>
1525
+ </Card>
1430
1526
  Update a specific prompt by ID.
1431
1527
 
1432
1528
  Parameters
label_studio_sdk/prompts/indicators/client.py CHANGED
@@ -20,6 +20,12 @@ class IndicatorsClient:
20
20
  self, id: int, *, request_options: typing.Optional[RequestOptions] = None
21
21
  ) -> typing.List[IndicatorsListResponseItem]:
22
22
  """
23
+ <Card href="https://humansignal.com/goenterprise">
24
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
25
+ <p style="margin-top: 10px; font-size: 14px;">
26
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
27
+ </p>
28
+ </Card>
23
29
  Get key indicators for the Prompt dashboard.
24
30
 
25
31
  Parameters
@@ -68,6 +74,12 @@ class IndicatorsClient:
68
74
  self, id: int, indicator_key: str, *, request_options: typing.Optional[RequestOptions] = None
69
75
  ) -> LseKeyIndicatorValue:
70
76
  """
77
+ <Card href="https://humansignal.com/goenterprise">
78
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
79
+ <p style="margin-top: 10px; font-size: 14px;">
80
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
81
+ </p>
82
+ </Card>
71
83
  Get a specific key indicator for the Prompt dashboard.
72
84
 
73
85
  Parameters
@@ -124,6 +136,12 @@ class AsyncIndicatorsClient:
124
136
  self, id: int, *, request_options: typing.Optional[RequestOptions] = None
125
137
  ) -> typing.List[IndicatorsListResponseItem]:
126
138
  """
139
+ <Card href="https://humansignal.com/goenterprise">
140
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
141
+ <p style="margin-top: 10px; font-size: 14px;">
142
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
143
+ </p>
144
+ </Card>
127
145
  Get key indicators for the Prompt dashboard.
128
146
 
129
147
  Parameters
@@ -180,6 +198,12 @@ class AsyncIndicatorsClient:
180
198
  self, id: int, indicator_key: str, *, request_options: typing.Optional[RequestOptions] = None
181
199
  ) -> LseKeyIndicatorValue:
182
200
  """
201
+ <Card href="https://humansignal.com/goenterprise">
202
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
203
+ <p style="margin-top: 10px; font-size: 14px;">
204
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
205
+ </p>
206
+ </Card>
183
207
  Get a specific key indicator for the Prompt dashboard.
184
208
 
185
209
  Parameters
label_studio_sdk/prompts/runs/client.py CHANGED
@@ -34,6 +34,12 @@ class RunsClient:
34
34
  request_options: typing.Optional[RequestOptions] = None,
35
35
  ) -> typing.List[ModelRun]:
36
36
  """
37
+ <Card href="https://humansignal.com/goenterprise">
38
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
39
+ <p style="margin-top: 10px; font-size: 14px;">
40
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
41
+ </p>
42
+ </Card>
37
43
  Get information (status, metadata, etc) about an existing inference run
38
44
 
39
45
  Parameters
@@ -115,6 +121,12 @@ class RunsClient:
115
121
  request_options: typing.Optional[RequestOptions] = None,
116
122
  ) -> ModelRun:
117
123
  """
124
+ <Card href="https://humansignal.com/goenterprise">
125
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
126
+ <p style="margin-top: 10px; font-size: 14px;">
127
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
128
+ </p>
129
+ </Card>
118
130
  Run a prompt inference.
119
131
 
120
132
  Parameters
@@ -203,6 +215,12 @@ class RunsClient:
203
215
  request_options: typing.Optional[RequestOptions] = None,
204
216
  ) -> CancelModelRunResponse:
205
217
  """
218
+ <Card href="https://humansignal.com/goenterprise">
219
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
220
+ <p style="margin-top: 10px; font-size: 14px;">
221
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
222
+ </p>
223
+ </Card>
206
224
  Cancel the inference run for the given api
207
225
 
208
226
  Parameters
@@ -270,6 +288,12 @@ class AsyncRunsClient:
270
288
  request_options: typing.Optional[RequestOptions] = None,
271
289
  ) -> typing.List[ModelRun]:
272
290
  """
291
+ <Card href="https://humansignal.com/goenterprise">
292
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
293
+ <p style="margin-top: 10px; font-size: 14px;">
294
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
295
+ </p>
296
+ </Card>
273
297
  Get information (status, metadata, etc) about an existing inference run
274
298
 
275
299
  Parameters
@@ -359,6 +383,12 @@ class AsyncRunsClient:
359
383
  request_options: typing.Optional[RequestOptions] = None,
360
384
  ) -> ModelRun:
361
385
  """
386
+ <Card href="https://humansignal.com/goenterprise">
387
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
388
+ <p style="margin-top: 10px; font-size: 14px;">
389
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
390
+ </p>
391
+ </Card>
362
392
  Run a prompt inference.
363
393
 
364
394
  Parameters
@@ -455,6 +485,12 @@ class AsyncRunsClient:
455
485
  request_options: typing.Optional[RequestOptions] = None,
456
486
  ) -> CancelModelRunResponse:
457
487
  """
488
+ <Card href="https://humansignal.com/goenterprise">
489
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
490
+ <p style="margin-top: 10px; font-size: 14px;">
491
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
492
+ </p>
493
+ </Card>
458
494
  Cancel the inference run for the given api
459
495
 
460
496
  Parameters
label_studio_sdk/prompts/versions/client.py CHANGED
@@ -23,6 +23,12 @@ class VersionsClient:
23
23
 
24
24
  def get_default_version_name(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
25
25
  """
26
+ <Card href="https://humansignal.com/goenterprise">
27
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
28
+ <p style="margin-top: 10px; font-size: 14px;">
29
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
30
+ </p>
31
+ </Card>
26
32
  Get default prompt version name
27
33
 
28
34
  Parameters
@@ -68,6 +74,12 @@ class VersionsClient:
68
74
  request_options: typing.Optional[RequestOptions] = None,
69
75
  ) -> typing.List[ThirdPartyModelVersion]:
70
76
  """
77
+ <Card href="https://humansignal.com/goenterprise">
78
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
79
+ <p style="margin-top: 10px; font-size: 14px;">
80
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
81
+ </p>
82
+ </Card>
71
83
  List all versions of a prompt.
72
84
 
73
85
  Parameters
@@ -132,6 +144,12 @@ class VersionsClient:
132
144
  request_options: typing.Optional[RequestOptions] = None,
133
145
  ) -> ThirdPartyModelVersion:
134
146
  """
147
+ <Card href="https://humansignal.com/goenterprise">
148
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
149
+ <p style="margin-top: 10px; font-size: 14px;">
150
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
151
+ </p>
152
+ </Card>
135
153
  Create a new version of a prompt.
136
154
 
137
155
  Parameters
@@ -220,6 +238,12 @@ class VersionsClient:
220
238
  self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None
221
239
  ) -> ThirdPartyModelVersion:
222
240
  """
241
+ <Card href="https://humansignal.com/goenterprise">
242
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
243
+ <p style="margin-top: 10px; font-size: 14px;">
244
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
245
+ </p>
246
+ </Card>
223
247
  Retrieve a specific prompt of a model.
224
248
 
225
249
  Parameters
@@ -271,6 +295,12 @@ class VersionsClient:
271
295
  self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None
272
296
  ) -> None:
273
297
  """
298
+ <Card href="https://humansignal.com/goenterprise">
299
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
300
+ <p style="margin-top: 10px; font-size: 14px;">
301
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
302
+ </p>
303
+ </Card>
274
304
  Delete a prompt version by ID
275
305
 
276
306
  Parameters
@@ -326,6 +356,12 @@ class VersionsClient:
326
356
  request_options: typing.Optional[RequestOptions] = None,
327
357
  ) -> ThirdPartyModelVersion:
328
358
  """
359
+ <Card href="https://humansignal.com/goenterprise">
360
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
361
+ <p style="margin-top: 10px; font-size: 14px;">
362
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
363
+ </p>
364
+ </Card>
329
365
  Update a specific prompt version by ID.
330
366
 
331
367
  Parameters
@@ -417,6 +453,12 @@ class VersionsClient:
417
453
  self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None
418
454
  ) -> InferenceRunCostEstimate:
419
455
  """
456
+ <Card href="https://humansignal.com/goenterprise">
457
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
458
+ <p style="margin-top: 10px; font-size: 14px;">
459
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
460
+ </p>
461
+ </Card>
420
462
  Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset
421
463
 
422
464
  Parameters
@@ -621,6 +663,12 @@ class AsyncVersionsClient:
621
663
  self, id: int, *, request_options: typing.Optional[RequestOptions] = None
622
664
  ) -> None:
623
665
  """
666
+ <Card href="https://humansignal.com/goenterprise">
667
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
668
+ <p style="margin-top: 10px; font-size: 14px;">
669
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
670
+ </p>
671
+ </Card>
624
672
  Get default prompt version name
625
673
 
626
674
  Parameters
@@ -674,6 +722,12 @@ class AsyncVersionsClient:
674
722
  request_options: typing.Optional[RequestOptions] = None,
675
723
  ) -> typing.List[ThirdPartyModelVersion]:
676
724
  """
725
+ <Card href="https://humansignal.com/goenterprise">
726
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
727
+ <p style="margin-top: 10px; font-size: 14px;">
728
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
729
+ </p>
730
+ </Card>
677
731
  List all versions of a prompt.
678
732
 
679
733
  Parameters
@@ -746,6 +800,12 @@ class AsyncVersionsClient:
746
800
  request_options: typing.Optional[RequestOptions] = None,
747
801
  ) -> ThirdPartyModelVersion:
748
802
  """
803
+ <Card href="https://humansignal.com/goenterprise">
804
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
805
+ <p style="margin-top: 10px; font-size: 14px;">
806
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
807
+ </p>
808
+ </Card>
749
809
  Create a new version of a prompt.
750
810
 
751
811
  Parameters
@@ -842,6 +902,12 @@ class AsyncVersionsClient:
842
902
  self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None
843
903
  ) -> ThirdPartyModelVersion:
844
904
  """
905
+ <Card href="https://humansignal.com/goenterprise">
906
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
907
+ <p style="margin-top: 10px; font-size: 14px;">
908
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
909
+ </p>
910
+ </Card>
845
911
  Retrieve a specific prompt of a model.
846
912
 
847
913
  Parameters
@@ -901,6 +967,12 @@ class AsyncVersionsClient:
901
967
  self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None
902
968
  ) -> None:
903
969
  """
970
+ <Card href="https://humansignal.com/goenterprise">
971
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
972
+ <p style="margin-top: 10px; font-size: 14px;">
973
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
974
+ </p>
975
+ </Card>
904
976
  Delete a prompt version by ID
905
977
 
906
978
  Parameters
@@ -964,6 +1036,12 @@ class AsyncVersionsClient:
964
1036
  request_options: typing.Optional[RequestOptions] = None,
965
1037
  ) -> ThirdPartyModelVersion:
966
1038
  """
1039
+ <Card href="https://humansignal.com/goenterprise">
1040
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
1041
+ <p style="margin-top: 10px; font-size: 14px;">
1042
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
1043
+ </p>
1044
+ </Card>
967
1045
  Update a specific prompt version by ID.
968
1046
 
969
1047
  Parameters
@@ -1063,6 +1141,12 @@ class AsyncVersionsClient:
1063
1141
  self, prompt_id: int, version_id: int, *, request_options: typing.Optional[RequestOptions] = None
1064
1142
  ) -> InferenceRunCostEstimate:
1065
1143
  """
1144
+ <Card href="https://humansignal.com/goenterprise">
1145
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
1146
+ <p style="margin-top: 10px; font-size: 14px;">
1147
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
1148
+ </p>
1149
+ </Card>
1066
1150
  Get an estimate of the cost for making an inference run on the selected Prompt Version and Project/ProjectSubset
1067
1151
 
1068
1152
  Parameters
label_studio_sdk/sso/saml/client.py CHANGED
@@ -22,6 +22,12 @@ class SamlClient:
22
22
 
23
23
  def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> SamlSettings:
24
24
  """
25
+ <Card href="https://humansignal.com/goenterprise">
26
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
27
+ <p style="margin-top: 10px; font-size: 14px;">
28
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
29
+ </p>
30
+ </Card>
25
31
  Retrieve SAML2 settings for the currently active organization.
26
32
 
27
33
  Parameters
@@ -71,6 +77,12 @@ class SamlClient:
71
77
  request_options: typing.Optional[RequestOptions] = None,
72
78
  ) -> SamlSettingsUpdate:
73
79
  """
80
+ <Card href="https://humansignal.com/goenterprise">
81
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
82
+ <p style="margin-top: 10px; font-size: 14px;">
83
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
84
+ </p>
85
+ </Card>
74
86
  Update SAML2 settings for the currently active organization.
75
87
 
76
88
  Parameters
@@ -145,6 +157,12 @@ class AsyncSamlClient:
145
157
 
146
158
  async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> SamlSettings:
147
159
  """
160
+ <Card href="https://humansignal.com/goenterprise">
161
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
162
+ <p style="margin-top: 10px; font-size: 14px;">
163
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
164
+ </p>
165
+ </Card>
148
166
  Retrieve SAML2 settings for the currently active organization.
149
167
 
150
168
  Parameters
@@ -202,6 +220,12 @@ class AsyncSamlClient:
202
220
  request_options: typing.Optional[RequestOptions] = None,
203
221
  ) -> SamlSettingsUpdate:
204
222
  """
223
+ <Card href="https://humansignal.com/goenterprise">
224
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
225
+ <p style="margin-top: 10px; font-size: 14px;">
226
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
227
+ </p>
228
+ </Card>
205
229
  Update SAML2 settings for the currently active organization.
206
230
 
207
231
  Parameters
label_studio_sdk/sso/scim/client.py CHANGED
@@ -22,6 +22,12 @@ class ScimClient:
22
22
 
23
23
  def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> ScimSettings:
24
24
  """
25
+ <Card href="https://humansignal.com/goenterprise">
26
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
27
+ <p style="margin-top: 10px; font-size: 14px;">
28
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
29
+ </p>
30
+ </Card>
25
31
  Retrieve SCIM settings for the currently active organization.
26
32
 
27
33
  Parameters
@@ -71,6 +77,12 @@ class ScimClient:
71
77
  request_options: typing.Optional[RequestOptions] = None,
72
78
  ) -> ScimSettingsUpdate:
73
79
  """
80
+ <Card href="https://humansignal.com/goenterprise">
81
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
82
+ <p style="margin-top: 10px; font-size: 14px;">
83
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
84
+ </p>
85
+ </Card>
74
86
  Update SCIM settings for the currently active organization.
75
87
 
76
88
  Parameters
@@ -145,6 +157,12 @@ class AsyncScimClient:
145
157
 
146
158
  async def get(self, *, request_options: typing.Optional[RequestOptions] = None) -> ScimSettings:
147
159
  """
160
+ <Card href="https://humansignal.com/goenterprise">
161
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
162
+ <p style="margin-top: 10px; font-size: 14px;">
163
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
164
+ </p>
165
+ </Card>
148
166
  Retrieve SCIM settings for the currently active organization.
149
167
 
150
168
  Parameters
@@ -202,6 +220,12 @@ class AsyncScimClient:
202
220
  request_options: typing.Optional[RequestOptions] = None,
203
221
  ) -> ScimSettingsUpdate:
204
222
  """
223
+ <Card href="https://humansignal.com/goenterprise">
224
+ <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
225
+ <p style="margin-top: 10px; font-size: 14px;">
226
+ This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
227
+ </p>
228
+ </Card>
205
229
  Update SCIM settings for the currently active organization.
206
230
 
207
231
  Parameters
label_studio_sdk/types/default_role.py CHANGED
@@ -17,7 +17,7 @@ class DefaultRole(UncheckedBaseModel):
17
17
 
18
18
  custom_scripts_editable_by: typing.Optional[DefaultRoleCustomScriptsEditableBy] = pydantic.Field(default=None)
19
19
  """
20
- Set the minimum user role that can edit custom scripts in the UI.
20
+ Set the minimum user role that can edit custom scripts (Plugins) in the UI.
21
21
 
22
22
  * `AD` - Administrator
23
23
  * `MA` - Manager
@@ -25,7 +25,7 @@ class DefaultRole(UncheckedBaseModel):
25
25
 
26
26
  custom_scripts_enabled_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
27
27
  """
28
- Set to current time to enabled custom scripts for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts.
28
+ Set to current time to enable custom scripts (Plugins) for this organization. Can only be enabled if no organization members are active members of any other organizations; otherwise an error will be raised. If this occurs, contact the LEAP team for assistance with enabling custom scripts (Plugins).
29
29
  """
30
30
 
31
31
  default_role: typing.Optional[Role9E7Enum] = pydantic.Field(default=None)
label_studio_sdk/types/lse_organization.py CHANGED
@@ -15,7 +15,7 @@ class LseOrganization(UncheckedBaseModel):
15
15
  created_at: dt.datetime
16
16
  custom_scripts_editable_by: typing.Optional[LseOrganizationCustomScriptsEditableBy] = pydantic.Field(default=None)
17
17
  """
18
- Set the minimum user role that can edit custom scripts in the UI.
18
+ Set the minimum user role that can edit custom scripts (Plugins) in the UI.
19
19
 
20
20
  * `AD` - Administrator
21
21
  * `MA` - Manager