label-studio-sdk 2.0.9__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.
- label_studio_sdk/activity_logs/client.py +12 -0
- label_studio_sdk/annotation_history/client.py +36 -0
- label_studio_sdk/annotation_reviews/client.py +60 -0
- label_studio_sdk/billing/client.py +12 -0
- label_studio_sdk/comments/client.py +72 -0
- label_studio_sdk/export_storage/azure_spi/client.py +84 -0
- label_studio_sdk/export_storage/databricks/client.py +84 -0
- label_studio_sdk/export_storage/gcswif/client.py +84 -0
- label_studio_sdk/export_storage/s3s/client.py +84 -0
- label_studio_sdk/import_storage/azure_spi/client.py +84 -0
- label_studio_sdk/import_storage/databricks/client.py +84 -0
- label_studio_sdk/import_storage/gcswif/client.py +84 -0
- label_studio_sdk/import_storage/s3s/client.py +84 -0
- label_studio_sdk/label_interface/control_tags.py +12 -7
- label_studio_sdk/ml/client.py +14 -2
- label_studio_sdk/model_providers/client.py +72 -0
- label_studio_sdk/organizations/client.py +30 -6
- label_studio_sdk/organizations/invites/client.py +55 -6
- label_studio_sdk/organizations/members/client.py +24 -0
- label_studio_sdk/organizations/permissions/client.py +60 -0
- label_studio_sdk/project_templates/client.py +76 -4
- label_studio_sdk/projects/__init__.py +6 -0
- label_studio_sdk/projects/assignments/client.py +60 -0
- label_studio_sdk/projects/client.py +12 -0
- label_studio_sdk/projects/members/bulk/client.py +24 -0
- label_studio_sdk/projects/members/client.py +12 -0
- label_studio_sdk/projects/members/paginated/client.py +12 -0
- label_studio_sdk/projects/metrics/client.py +24 -0
- label_studio_sdk/projects/pauses/client.py +60 -0
- label_studio_sdk/projects/stats/__init__.py +6 -0
- label_studio_sdk/projects/stats/client.py +486 -1
- label_studio_sdk/projects/stats/types/__init__.py +6 -0
- label_studio_sdk/projects/stats/types/stats_model_version_annotator_agreement_response.py +19 -0
- label_studio_sdk/projects/stats/types/stats_model_version_ground_truth_agreement_response.py +19 -0
- label_studio_sdk/projects/stats/types/stats_model_version_prediction_agreement_response.py +19 -0
- label_studio_sdk/prompts/client.py +96 -0
- label_studio_sdk/prompts/indicators/client.py +24 -0
- label_studio_sdk/prompts/runs/client.py +36 -0
- label_studio_sdk/prompts/versions/client.py +84 -0
- label_studio_sdk/sso/saml/client.py +24 -0
- label_studio_sdk/sso/scim/client.py +24 -0
- label_studio_sdk/types/default_role.py +2 -2
- label_studio_sdk/types/lse_organization.py +1 -1
- label_studio_sdk/types/project_template.py +1 -1
- label_studio_sdk/types/project_template_request.py +1 -1
- label_studio_sdk/users/client.py +24 -0
- label_studio_sdk/versions/client.py +12 -0
- label_studio_sdk/workspaces/client.py +60 -0
- label_studio_sdk/workspaces/members/bulk/client.py +24 -0
- label_studio_sdk/workspaces/members/client.py +36 -0
- label_studio_sdk/workspaces/members/paginated/client.py +12 -0
- {label_studio_sdk-2.0.9.dist-info → label_studio_sdk-2.0.11.dist-info}/METADATA +1 -1
- {label_studio_sdk-2.0.9.dist-info → label_studio_sdk-2.0.11.dist-info}/RECORD +55 -52
- {label_studio_sdk-2.0.9.dist-info → label_studio_sdk-2.0.11.dist-info}/LICENSE +0 -0
- {label_studio_sdk-2.0.9.dist-info → label_studio_sdk-2.0.11.dist-info}/WHEEL +0 -0
|
@@ -28,6 +28,12 @@ class S3SClient:
|
|
|
28
28
|
request_options: typing.Optional[RequestOptions] = None,
|
|
29
29
|
) -> typing.List[LseS3ImportStorage]:
|
|
30
30
|
"""
|
|
31
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
32
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
33
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
34
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
35
|
+
</p>
|
|
36
|
+
</Card>
|
|
31
37
|
Get list of all S3 import storage connections set up with IAM role access.
|
|
32
38
|
|
|
33
39
|
Parameters
|
|
@@ -110,6 +116,12 @@ class S3SClient:
|
|
|
110
116
|
request_options: typing.Optional[RequestOptions] = None,
|
|
111
117
|
) -> LseS3ImportStorage:
|
|
112
118
|
"""
|
|
119
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
120
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
121
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
122
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
123
|
+
</p>
|
|
124
|
+
</Card>
|
|
113
125
|
Create S3 import storage with IAM role access.
|
|
114
126
|
|
|
115
127
|
Parameters
|
|
@@ -287,6 +299,12 @@ class S3SClient:
|
|
|
287
299
|
request_options: typing.Optional[RequestOptions] = None,
|
|
288
300
|
) -> None:
|
|
289
301
|
"""
|
|
302
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
303
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
304
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
305
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
306
|
+
</p>
|
|
307
|
+
</Card>
|
|
290
308
|
Validate a specific S3 import storage connection that was set up with IAM role access.
|
|
291
309
|
|
|
292
310
|
Parameters
|
|
@@ -427,6 +445,12 @@ class S3SClient:
|
|
|
427
445
|
|
|
428
446
|
def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ImportStorage:
|
|
429
447
|
"""
|
|
448
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
449
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
450
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
451
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
452
|
+
</p>
|
|
453
|
+
</Card>
|
|
430
454
|
Get a specific S3 import storage connection that was set up with IAM role access.
|
|
431
455
|
|
|
432
456
|
Parameters
|
|
@@ -473,6 +497,12 @@ class S3SClient:
|
|
|
473
497
|
|
|
474
498
|
def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
|
|
475
499
|
"""
|
|
500
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
501
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
502
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
503
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
504
|
+
</p>
|
|
505
|
+
</Card>
|
|
476
506
|
Delete a specific S3 import storage connection that was set up with IAM role access.
|
|
477
507
|
|
|
478
508
|
Parameters
|
|
@@ -543,6 +573,12 @@ class S3SClient:
|
|
|
543
573
|
request_options: typing.Optional[RequestOptions] = None,
|
|
544
574
|
) -> LseS3ImportStorage:
|
|
545
575
|
"""
|
|
576
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
577
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
578
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
579
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
580
|
+
</p>
|
|
581
|
+
</Card>
|
|
546
582
|
Update a specific S3 import storage connection that was set up with IAM role access.
|
|
547
583
|
|
|
548
584
|
Parameters
|
|
@@ -694,6 +730,12 @@ class S3SClient:
|
|
|
694
730
|
|
|
695
731
|
def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ImportStorage:
|
|
696
732
|
"""
|
|
733
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
734
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
735
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
736
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
737
|
+
</p>
|
|
738
|
+
</Card>
|
|
697
739
|
Sync tasks from an S3 import storage connection that was set up with IAM role access.
|
|
698
740
|
|
|
699
741
|
Parameters
|
|
@@ -751,6 +793,12 @@ class AsyncS3SClient:
|
|
|
751
793
|
request_options: typing.Optional[RequestOptions] = None,
|
|
752
794
|
) -> typing.List[LseS3ImportStorage]:
|
|
753
795
|
"""
|
|
796
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
797
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
798
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
799
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
800
|
+
</p>
|
|
801
|
+
</Card>
|
|
754
802
|
Get list of all S3 import storage connections set up with IAM role access.
|
|
755
803
|
|
|
756
804
|
Parameters
|
|
@@ -841,6 +889,12 @@ class AsyncS3SClient:
|
|
|
841
889
|
request_options: typing.Optional[RequestOptions] = None,
|
|
842
890
|
) -> LseS3ImportStorage:
|
|
843
891
|
"""
|
|
892
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
893
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
894
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
895
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
896
|
+
</p>
|
|
897
|
+
</Card>
|
|
844
898
|
Create S3 import storage with IAM role access.
|
|
845
899
|
|
|
846
900
|
Parameters
|
|
@@ -1026,6 +1080,12 @@ class AsyncS3SClient:
|
|
|
1026
1080
|
request_options: typing.Optional[RequestOptions] = None,
|
|
1027
1081
|
) -> None:
|
|
1028
1082
|
"""
|
|
1083
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
1084
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
1085
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
1086
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
1087
|
+
</p>
|
|
1088
|
+
</Card>
|
|
1029
1089
|
Validate a specific S3 import storage connection that was set up with IAM role access.
|
|
1030
1090
|
|
|
1031
1091
|
Parameters
|
|
@@ -1174,6 +1234,12 @@ class AsyncS3SClient:
|
|
|
1174
1234
|
|
|
1175
1235
|
async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ImportStorage:
|
|
1176
1236
|
"""
|
|
1237
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
1238
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
1239
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
1240
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
1241
|
+
</p>
|
|
1242
|
+
</Card>
|
|
1177
1243
|
Get a specific S3 import storage connection that was set up with IAM role access.
|
|
1178
1244
|
|
|
1179
1245
|
Parameters
|
|
@@ -1228,6 +1294,12 @@ class AsyncS3SClient:
|
|
|
1228
1294
|
|
|
1229
1295
|
async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
|
|
1230
1296
|
"""
|
|
1297
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
1298
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
1299
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
1300
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
1301
|
+
</p>
|
|
1302
|
+
</Card>
|
|
1231
1303
|
Delete a specific S3 import storage connection that was set up with IAM role access.
|
|
1232
1304
|
|
|
1233
1305
|
Parameters
|
|
@@ -1306,6 +1378,12 @@ class AsyncS3SClient:
|
|
|
1306
1378
|
request_options: typing.Optional[RequestOptions] = None,
|
|
1307
1379
|
) -> LseS3ImportStorage:
|
|
1308
1380
|
"""
|
|
1381
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
1382
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
1383
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
1384
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
1385
|
+
</p>
|
|
1386
|
+
</Card>
|
|
1309
1387
|
Update a specific S3 import storage connection that was set up with IAM role access.
|
|
1310
1388
|
|
|
1311
1389
|
Parameters
|
|
@@ -1465,6 +1543,12 @@ class AsyncS3SClient:
|
|
|
1465
1543
|
|
|
1466
1544
|
async def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LseS3ImportStorage:
|
|
1467
1545
|
"""
|
|
1546
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
1547
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
1548
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
1549
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
1550
|
+
</p>
|
|
1551
|
+
</Card>
|
|
1468
1552
|
Sync tasks from an S3 import storage connection that was set up with IAM role access.
|
|
1469
1553
|
|
|
1470
1554
|
Parameters
|
|
@@ -503,8 +503,8 @@ class ControlTag(LabelStudioTag):
|
|
|
503
503
|
|
|
504
504
|
|
|
505
505
|
class SpanSelection(BaseModel):
|
|
506
|
-
start: Union[int, str]
|
|
507
|
-
end: Union[int, str]
|
|
506
|
+
start: Union[float, int, str]
|
|
507
|
+
end: Union[float, int, str]
|
|
508
508
|
|
|
509
509
|
|
|
510
510
|
class SpanSelectionOffsets(SpanSelection):
|
|
@@ -561,6 +561,7 @@ class LabelsTag(ControlTag):
|
|
|
561
561
|
_label_attr_name: str = "labels"
|
|
562
562
|
_value_class: Type[LabelsValue] = LabelsValue
|
|
563
563
|
|
|
564
|
+
|
|
564
565
|
def to_json_schema(self):
|
|
565
566
|
"""
|
|
566
567
|
Converts the current LabelsTag instance into a JSON Schema.
|
|
@@ -575,13 +576,17 @@ class LabelsTag(ControlTag):
|
|
|
575
576
|
"required": ["start", "end", "labels"],
|
|
576
577
|
"properties": {
|
|
577
578
|
"start": {
|
|
578
|
-
"
|
|
579
|
+
"oneOf": [
|
|
580
|
+
{"type": "integer", "minimum": 0},
|
|
581
|
+
{"type": "number", "minimum": 0}
|
|
582
|
+
],
|
|
579
583
|
# TODO: this is incompatible with the OpenAI API using PredictedOutputs
|
|
580
|
-
"minimum": 0
|
|
581
584
|
},
|
|
582
585
|
"end": {
|
|
583
|
-
"
|
|
584
|
-
|
|
586
|
+
"oneOf": [
|
|
587
|
+
{"type": "integer", "minimum": 0},
|
|
588
|
+
{"type": "number", "minimum": 0}
|
|
589
|
+
]
|
|
585
590
|
},
|
|
586
591
|
"labels": {
|
|
587
592
|
"type": "array",
|
|
@@ -778,7 +783,7 @@ class VideoRectangleTag(ControlTag):
|
|
|
778
783
|
|
|
779
784
|
|
|
780
785
|
class NumberValue(BaseModel):
|
|
781
|
-
number:
|
|
786
|
+
number: float = Field(..., ge=0)
|
|
782
787
|
|
|
783
788
|
|
|
784
789
|
class NumberTag(ControlTag):
|
label_studio_sdk/ml/client.py
CHANGED
|
@@ -465,7 +465,13 @@ class MlClient:
|
|
|
465
465
|
request_options: typing.Optional[RequestOptions] = None,
|
|
466
466
|
) -> None:
|
|
467
467
|
"""
|
|
468
|
-
|
|
468
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
469
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
470
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
471
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
472
|
+
</p>
|
|
473
|
+
</Card>
|
|
474
|
+
|
|
469
475
|
|
|
470
476
|
Create predictions for all tasks using a specific ML backend so that you can set up an active learning strategy based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires a Label Studio ML backend set up and configured for your project.
|
|
471
477
|
|
|
@@ -1130,7 +1136,13 @@ class AsyncMlClient:
|
|
|
1130
1136
|
request_options: typing.Optional[RequestOptions] = None,
|
|
1131
1137
|
) -> None:
|
|
1132
1138
|
"""
|
|
1133
|
-
|
|
1139
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
1140
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
1141
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
1142
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
1143
|
+
</p>
|
|
1144
|
+
</Card>
|
|
1145
|
+
|
|
1134
1146
|
|
|
1135
1147
|
Create predictions for all tasks using a specific ML backend so that you can set up an active learning strategy based on the confidence or uncertainty scores associated with the predictions. Creating predictions requires a Label Studio ML backend set up and configured for your project.
|
|
1136
1148
|
|
|
@@ -25,6 +25,12 @@ class ModelProvidersClient:
|
|
|
25
25
|
self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
|
|
26
26
|
) -> typing.List[ModelProviderConnection]:
|
|
27
27
|
"""
|
|
28
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
29
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
30
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
31
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
32
|
+
</p>
|
|
33
|
+
</Card>
|
|
28
34
|
List all model provider connections.
|
|
29
35
|
|
|
30
36
|
Parameters
|
|
@@ -89,6 +95,12 @@ class ModelProvidersClient:
|
|
|
89
95
|
request_options: typing.Optional[RequestOptions] = None,
|
|
90
96
|
) -> ModelProviderConnection:
|
|
91
97
|
"""
|
|
98
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
99
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
100
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
101
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
102
|
+
</p>
|
|
103
|
+
</Card>
|
|
92
104
|
Create a new model provider connection.
|
|
93
105
|
|
|
94
106
|
Parameters
|
|
@@ -182,6 +194,12 @@ class ModelProvidersClient:
|
|
|
182
194
|
self, *, request_options: typing.Optional[RequestOptions] = None
|
|
183
195
|
) -> ModelProvidersListModelProviderChoicesResponse:
|
|
184
196
|
"""
|
|
197
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
198
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
199
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
200
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
201
|
+
</p>
|
|
202
|
+
</Card>
|
|
185
203
|
List all possible model provider choices
|
|
186
204
|
|
|
187
205
|
Parameters
|
|
@@ -224,6 +242,12 @@ class ModelProvidersClient:
|
|
|
224
242
|
|
|
225
243
|
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ModelProviderConnection:
|
|
226
244
|
"""
|
|
245
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
246
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
247
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
248
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
249
|
+
</p>
|
|
250
|
+
</Card>
|
|
227
251
|
Retrieve a specific model provider connection.
|
|
228
252
|
|
|
229
253
|
Parameters
|
|
@@ -270,6 +294,12 @@ class ModelProvidersClient:
|
|
|
270
294
|
|
|
271
295
|
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
|
|
272
296
|
"""
|
|
297
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
298
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
299
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
300
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
301
|
+
</p>
|
|
302
|
+
</Card>
|
|
273
303
|
Delete a model provider connection by ID
|
|
274
304
|
|
|
275
305
|
Parameters
|
|
@@ -326,6 +356,12 @@ class ModelProvidersClient:
|
|
|
326
356
|
request_options: typing.Optional[RequestOptions] = None,
|
|
327
357
|
) -> ModelProviderConnection:
|
|
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 model provider connection by ID.
|
|
330
366
|
|
|
331
367
|
Parameters
|
|
@@ -431,6 +467,12 @@ class AsyncModelProvidersClient:
|
|
|
431
467
|
self, *, ordering: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
|
|
432
468
|
) -> typing.List[ModelProviderConnection]:
|
|
433
469
|
"""
|
|
470
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
471
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
472
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
473
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
474
|
+
</p>
|
|
475
|
+
</Card>
|
|
434
476
|
List all model provider connections.
|
|
435
477
|
|
|
436
478
|
Parameters
|
|
@@ -503,6 +545,12 @@ class AsyncModelProvidersClient:
|
|
|
503
545
|
request_options: typing.Optional[RequestOptions] = None,
|
|
504
546
|
) -> ModelProviderConnection:
|
|
505
547
|
"""
|
|
548
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
549
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
550
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
551
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
552
|
+
</p>
|
|
553
|
+
</Card>
|
|
506
554
|
Create a new model provider connection.
|
|
507
555
|
|
|
508
556
|
Parameters
|
|
@@ -604,6 +652,12 @@ class AsyncModelProvidersClient:
|
|
|
604
652
|
self, *, request_options: typing.Optional[RequestOptions] = None
|
|
605
653
|
) -> ModelProvidersListModelProviderChoicesResponse:
|
|
606
654
|
"""
|
|
655
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
656
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
657
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
658
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
659
|
+
</p>
|
|
660
|
+
</Card>
|
|
607
661
|
List all possible model provider choices
|
|
608
662
|
|
|
609
663
|
Parameters
|
|
@@ -654,6 +708,12 @@ class AsyncModelProvidersClient:
|
|
|
654
708
|
|
|
655
709
|
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ModelProviderConnection:
|
|
656
710
|
"""
|
|
711
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
712
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
713
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
714
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
715
|
+
</p>
|
|
716
|
+
</Card>
|
|
657
717
|
Retrieve a specific model provider connection.
|
|
658
718
|
|
|
659
719
|
Parameters
|
|
@@ -708,6 +768,12 @@ class AsyncModelProvidersClient:
|
|
|
708
768
|
|
|
709
769
|
async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
|
|
710
770
|
"""
|
|
771
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
772
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
773
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
774
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
775
|
+
</p>
|
|
776
|
+
</Card>
|
|
711
777
|
Delete a model provider connection by ID
|
|
712
778
|
|
|
713
779
|
Parameters
|
|
@@ -772,6 +838,12 @@ class AsyncModelProvidersClient:
|
|
|
772
838
|
request_options: typing.Optional[RequestOptions] = None,
|
|
773
839
|
) -> ModelProviderConnection:
|
|
774
840
|
"""
|
|
841
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
842
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
843
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
844
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
845
|
+
</p>
|
|
846
|
+
</Card>
|
|
775
847
|
Update a specific model provider connection by ID.
|
|
776
848
|
|
|
777
849
|
Parameters
|
|
@@ -195,7 +195,13 @@ class OrganizationsClient:
|
|
|
195
195
|
request_options: typing.Optional[RequestOptions] = None,
|
|
196
196
|
) -> LseOrganization:
|
|
197
197
|
"""
|
|
198
|
-
|
|
198
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
199
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
200
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
201
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
202
|
+
</p>
|
|
203
|
+
</Card>
|
|
204
|
+
Update organization details including title, embed domains, and Plugins settings.
|
|
199
205
|
|
|
200
206
|
Parameters
|
|
201
207
|
----------
|
|
@@ -321,6 +327,12 @@ class OrganizationsClient:
|
|
|
321
327
|
request_options: typing.Optional[RequestOptions] = None,
|
|
322
328
|
) -> DefaultRole:
|
|
323
329
|
"""
|
|
330
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
331
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
332
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
333
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
334
|
+
</p>
|
|
335
|
+
</Card>
|
|
324
336
|
Update the default role for members of a specific organization.
|
|
325
337
|
|
|
326
338
|
Parameters
|
|
@@ -331,13 +343,13 @@ class OrganizationsClient:
|
|
|
331
343
|
Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
|
|
332
344
|
|
|
333
345
|
custom_scripts_editable_by : typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy]
|
|
334
|
-
Set the minimum user role that can edit custom scripts in the UI.
|
|
346
|
+
Set the minimum user role that can edit custom scripts (Plugins) in the UI.
|
|
335
347
|
|
|
336
348
|
* `AD` - Administrator
|
|
337
349
|
* `MA` - Manager
|
|
338
350
|
|
|
339
351
|
custom_scripts_enabled_at : typing.Optional[dt.datetime]
|
|
340
|
-
Set to current time to
|
|
352
|
+
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).
|
|
341
353
|
|
|
342
354
|
default_role : typing.Optional[Role9E7Enum]
|
|
343
355
|
Default membership role for invited users
|
|
@@ -618,7 +630,13 @@ class AsyncOrganizationsClient:
|
|
|
618
630
|
request_options: typing.Optional[RequestOptions] = None,
|
|
619
631
|
) -> LseOrganization:
|
|
620
632
|
"""
|
|
621
|
-
|
|
633
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
634
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
635
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
636
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
637
|
+
</p>
|
|
638
|
+
</Card>
|
|
639
|
+
Update organization details including title, embed domains, and Plugins settings.
|
|
622
640
|
|
|
623
641
|
Parameters
|
|
624
642
|
----------
|
|
@@ -752,6 +770,12 @@ class AsyncOrganizationsClient:
|
|
|
752
770
|
request_options: typing.Optional[RequestOptions] = None,
|
|
753
771
|
) -> DefaultRole:
|
|
754
772
|
"""
|
|
773
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
774
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
775
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
776
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
777
|
+
</p>
|
|
778
|
+
</Card>
|
|
755
779
|
Update the default role for members of a specific organization.
|
|
756
780
|
|
|
757
781
|
Parameters
|
|
@@ -762,13 +786,13 @@ class AsyncOrganizationsClient:
|
|
|
762
786
|
Set to current time to restrict data sharing between annotators and reviewers in the label stream, review stream, and notifications (which will be disabled). In these settings, information about annotator and reviewer identity is suppressed in the UI.
|
|
763
787
|
|
|
764
788
|
custom_scripts_editable_by : typing.Optional[PatchedDefaultRoleRequestCustomScriptsEditableBy]
|
|
765
|
-
Set the minimum user role that can edit custom scripts in the UI.
|
|
789
|
+
Set the minimum user role that can edit custom scripts (Plugins) in the UI.
|
|
766
790
|
|
|
767
791
|
* `AD` - Administrator
|
|
768
792
|
* `MA` - Manager
|
|
769
793
|
|
|
770
794
|
custom_scripts_enabled_at : typing.Optional[dt.datetime]
|
|
771
|
-
Set to current time to
|
|
795
|
+
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).
|
|
772
796
|
|
|
773
797
|
default_role : typing.Optional[Role9E7Enum]
|
|
774
798
|
Default membership role for invited users
|
|
@@ -8,6 +8,7 @@ from ...core.unchecked_base_model import construct_type
|
|
|
8
8
|
from ...errors.forbidden_error import ForbiddenError
|
|
9
9
|
from json.decoder import JSONDecodeError
|
|
10
10
|
from ...core.api_error import ApiError
|
|
11
|
+
from ...types.role9e7enum import Role9E7Enum
|
|
11
12
|
from ...core.client_wrapper import AsyncClientWrapper
|
|
12
13
|
|
|
13
14
|
# this is used as the default value for optional parameters
|
|
@@ -72,6 +73,12 @@ class InvitesClient:
|
|
|
72
73
|
|
|
73
74
|
def revoke_invite(self, *, email: str, request_options: typing.Optional[RequestOptions] = None) -> None:
|
|
74
75
|
"""
|
|
76
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
77
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
78
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
79
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
80
|
+
</p>
|
|
81
|
+
</Card>
|
|
75
82
|
Revoke invite to organization
|
|
76
83
|
|
|
77
84
|
Parameters
|
|
@@ -117,16 +124,32 @@ class InvitesClient:
|
|
|
117
124
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
118
125
|
|
|
119
126
|
def send_email(
|
|
120
|
-
self,
|
|
127
|
+
self,
|
|
128
|
+
*,
|
|
129
|
+
emails: typing.Sequence[str],
|
|
130
|
+
role: Role9E7Enum,
|
|
131
|
+
projects: typing.Optional[typing.Sequence[int]] = OMIT,
|
|
132
|
+
workspaces: typing.Optional[typing.Sequence[int]] = OMIT,
|
|
133
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
121
134
|
) -> None:
|
|
122
135
|
"""
|
|
136
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
137
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
138
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
139
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
140
|
+
</p>
|
|
141
|
+
</Card>
|
|
123
142
|
Send email with invite to organization
|
|
124
143
|
|
|
125
144
|
Parameters
|
|
126
145
|
----------
|
|
127
146
|
emails : typing.Sequence[str]
|
|
128
147
|
|
|
129
|
-
role :
|
|
148
|
+
role : Role9E7Enum
|
|
149
|
+
|
|
150
|
+
projects : typing.Optional[typing.Sequence[int]]
|
|
151
|
+
|
|
152
|
+
workspaces : typing.Optional[typing.Sequence[int]]
|
|
130
153
|
|
|
131
154
|
request_options : typing.Optional[RequestOptions]
|
|
132
155
|
Request-specific configuration.
|
|
@@ -144,7 +167,7 @@ class InvitesClient:
|
|
|
144
167
|
)
|
|
145
168
|
client.organizations.invites.send_email(
|
|
146
169
|
emails=["emails"],
|
|
147
|
-
role="
|
|
170
|
+
role="OW",
|
|
148
171
|
)
|
|
149
172
|
"""
|
|
150
173
|
_response = self._client_wrapper.httpx_client.request(
|
|
@@ -152,7 +175,9 @@ class InvitesClient:
|
|
|
152
175
|
method="POST",
|
|
153
176
|
json={
|
|
154
177
|
"emails": emails,
|
|
178
|
+
"projects": projects,
|
|
155
179
|
"role": role,
|
|
180
|
+
"workspaces": workspaces,
|
|
156
181
|
},
|
|
157
182
|
headers={
|
|
158
183
|
"content-type": "application/json",
|
|
@@ -245,6 +270,12 @@ class AsyncInvitesClient:
|
|
|
245
270
|
|
|
246
271
|
async def revoke_invite(self, *, email: str, request_options: typing.Optional[RequestOptions] = None) -> None:
|
|
247
272
|
"""
|
|
273
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
274
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
275
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
276
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
277
|
+
</p>
|
|
278
|
+
</Card>
|
|
248
279
|
Revoke invite to organization
|
|
249
280
|
|
|
250
281
|
Parameters
|
|
@@ -298,16 +329,32 @@ class AsyncInvitesClient:
|
|
|
298
329
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
299
330
|
|
|
300
331
|
async def send_email(
|
|
301
|
-
self,
|
|
332
|
+
self,
|
|
333
|
+
*,
|
|
334
|
+
emails: typing.Sequence[str],
|
|
335
|
+
role: Role9E7Enum,
|
|
336
|
+
projects: typing.Optional[typing.Sequence[int]] = OMIT,
|
|
337
|
+
workspaces: typing.Optional[typing.Sequence[int]] = OMIT,
|
|
338
|
+
request_options: typing.Optional[RequestOptions] = None,
|
|
302
339
|
) -> None:
|
|
303
340
|
"""
|
|
341
|
+
<Card href="https://humansignal.com/goenterprise">
|
|
342
|
+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
|
|
343
|
+
<p style="margin-top: 10px; font-size: 14px;">
|
|
344
|
+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
|
|
345
|
+
</p>
|
|
346
|
+
</Card>
|
|
304
347
|
Send email with invite to organization
|
|
305
348
|
|
|
306
349
|
Parameters
|
|
307
350
|
----------
|
|
308
351
|
emails : typing.Sequence[str]
|
|
309
352
|
|
|
310
|
-
role :
|
|
353
|
+
role : Role9E7Enum
|
|
354
|
+
|
|
355
|
+
projects : typing.Optional[typing.Sequence[int]]
|
|
356
|
+
|
|
357
|
+
workspaces : typing.Optional[typing.Sequence[int]]
|
|
311
358
|
|
|
312
359
|
request_options : typing.Optional[RequestOptions]
|
|
313
360
|
Request-specific configuration.
|
|
@@ -330,7 +377,7 @@ class AsyncInvitesClient:
|
|
|
330
377
|
async def main() -> None:
|
|
331
378
|
await client.organizations.invites.send_email(
|
|
332
379
|
emails=["emails"],
|
|
333
|
-
role="
|
|
380
|
+
role="OW",
|
|
334
381
|
)
|
|
335
382
|
|
|
336
383
|
|
|
@@ -341,7 +388,9 @@ class AsyncInvitesClient:
|
|
|
341
388
|
method="POST",
|
|
342
389
|
json={
|
|
343
390
|
"emails": emails,
|
|
391
|
+
"projects": projects,
|
|
344
392
|
"role": role,
|
|
393
|
+
"workspaces": workspaces,
|
|
345
394
|
},
|
|
346
395
|
headers={
|
|
347
396
|
"content-type": "application/json",
|