label-studio-sdk 2.0.10__py3-none-any.whl → 2.0.12__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/__init__.py +10 -0
- 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 +24 -0
- 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 +14 -1
- label_studio_sdk/projects/assignments/client.py +60 -0
- label_studio_sdk/projects/client.py +20 -0
- label_studio_sdk/projects/members/bulk/client.py +24 -0
- label_studio_sdk/projects/members/client.py +149 -30
- 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/roles/__init__.py +2 -0
- label_studio_sdk/projects/roles/client.py +555 -0
- label_studio_sdk/projects/stats/__init__.py +12 -0
- label_studio_sdk/projects/stats/client.py +766 -1
- label_studio_sdk/projects/stats/types/__init__.py +14 -0
- label_studio_sdk/projects/stats/types/stats_agreement_annotators_response.py +22 -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/projects/stats/types/stats_users_prediction_agreement_response.py +27 -0
- label_studio_sdk/projects/stats/types/stats_users_prediction_agreement_response_agreement_value.py +5 -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/__init__.py +10 -0
- label_studio_sdk/types/all_roles_project_list.py +5 -1
- label_studio_sdk/types/default_role.py +2 -2
- label_studio_sdk/types/lse_organization.py +1 -1
- label_studio_sdk/types/lse_project.py +5 -1
- label_studio_sdk/types/lse_project_create.py +5 -1
- label_studio_sdk/types/lse_project_response.py +5 -1
- label_studio_sdk/types/lse_project_update.py +5 -1
- label_studio_sdk/types/project.py +198 -0
- label_studio_sdk/types/project_member.py +19 -0
- label_studio_sdk/types/project_role.py +35 -0
- label_studio_sdk/types/project_sampling.py +7 -0
- label_studio_sdk/types/project_skip_queue.py +7 -0
- 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/__init__.py +2 -2
- label_studio_sdk/workspaces/client.py +4 -0
- label_studio_sdk/workspaces/projects/__init__.py +2 -0
- label_studio_sdk/workspaces/projects/client.py +352 -0
- {label_studio_sdk-2.0.10.dist-info → label_studio_sdk-2.0.12.dist-info}/METADATA +1 -1
- {label_studio_sdk-2.0.10.dist-info → label_studio_sdk-2.0.12.dist-info}/RECORD +72 -57
- {label_studio_sdk-2.0.10.dist-info → label_studio_sdk-2.0.12.dist-info}/LICENSE +0 -0
- {label_studio_sdk-2.0.10.dist-info → label_studio_sdk-2.0.12.dist-info}/WHEEL +0 -0
|
@@ -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
|
|
@@ -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
|
|
@@ -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
|
|
@@ -163,13 +163,18 @@ from .pause import Pause
|
|
|
163
163
|
from .pause_request import PauseRequest
|
|
164
164
|
from .prediction import Prediction
|
|
165
165
|
from .prediction_request import PredictionRequest
|
|
166
|
+
from .project import Project
|
|
166
167
|
from .project_group import ProjectGroup
|
|
167
168
|
from .project_group_request import ProjectGroupRequest
|
|
168
169
|
from .project_group_role_enum import ProjectGroupRoleEnum
|
|
169
170
|
from .project_import import ProjectImport
|
|
170
171
|
from .project_label_config import ProjectLabelConfig
|
|
171
172
|
from .project_label_config_request import ProjectLabelConfigRequest
|
|
173
|
+
from .project_member import ProjectMember
|
|
172
174
|
from .project_member_bulk_assign_roles_request import ProjectMemberBulkAssignRolesRequest
|
|
175
|
+
from .project_role import ProjectRole
|
|
176
|
+
from .project_sampling import ProjectSampling
|
|
177
|
+
from .project_skip_queue import ProjectSkipQueue
|
|
173
178
|
from .project_subset_enum import ProjectSubsetEnum
|
|
174
179
|
from .project_subset_item import ProjectSubsetItem
|
|
175
180
|
from .project_subset_task_item import ProjectSubsetTaskItem
|
|
@@ -400,13 +405,18 @@ __all__ = [
|
|
|
400
405
|
"PauseRequest",
|
|
401
406
|
"Prediction",
|
|
402
407
|
"PredictionRequest",
|
|
408
|
+
"Project",
|
|
403
409
|
"ProjectGroup",
|
|
404
410
|
"ProjectGroupRequest",
|
|
405
411
|
"ProjectGroupRoleEnum",
|
|
406
412
|
"ProjectImport",
|
|
407
413
|
"ProjectLabelConfig",
|
|
408
414
|
"ProjectLabelConfigRequest",
|
|
415
|
+
"ProjectMember",
|
|
409
416
|
"ProjectMemberBulkAssignRolesRequest",
|
|
417
|
+
"ProjectRole",
|
|
418
|
+
"ProjectSampling",
|
|
419
|
+
"ProjectSkipQueue",
|
|
410
420
|
"ProjectSubsetEnum",
|
|
411
421
|
"ProjectSubsetItem",
|
|
412
422
|
"ProjectSubsetTaskItem",
|
|
@@ -151,7 +151,11 @@ class AllRolesProjectList(UncheckedBaseModel):
|
|
|
151
151
|
If set, the annotator can view model predictions
|
|
152
152
|
"""
|
|
153
153
|
|
|
154
|
-
show_ground_truth_first: typing.Optional[bool] = None
|
|
154
|
+
show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
|
|
155
|
+
"""
|
|
156
|
+
Onboarding mode (true): show ground truth tasks first in the labeling stream
|
|
157
|
+
"""
|
|
158
|
+
|
|
155
159
|
show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
|
|
156
160
|
"""
|
|
157
161
|
Show instructions to the annotator before they start
|
|
@@ -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
|
|
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)
|
|
@@ -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
|
|
@@ -151,7 +151,11 @@ class LseProject(UncheckedBaseModel):
|
|
|
151
151
|
If set, the annotator can view model predictions
|
|
152
152
|
"""
|
|
153
153
|
|
|
154
|
-
show_ground_truth_first: typing.Optional[bool] = None
|
|
154
|
+
show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
|
|
155
|
+
"""
|
|
156
|
+
Onboarding mode (true): show ground truth tasks first in the labeling stream
|
|
157
|
+
"""
|
|
158
|
+
|
|
155
159
|
show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
|
|
156
160
|
"""
|
|
157
161
|
Show instructions to the annotator before they start
|
|
@@ -126,7 +126,11 @@ class LseProjectCreate(UncheckedBaseModel):
|
|
|
126
126
|
If set, the annotator can view model predictions
|
|
127
127
|
"""
|
|
128
128
|
|
|
129
|
-
show_ground_truth_first: typing.Optional[bool] = None
|
|
129
|
+
show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
|
|
130
|
+
"""
|
|
131
|
+
Onboarding mode (true): show ground truth tasks first in the labeling stream
|
|
132
|
+
"""
|
|
133
|
+
|
|
130
134
|
show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
|
|
131
135
|
"""
|
|
132
136
|
Show instructions to the annotator before they start
|
|
@@ -151,7 +151,11 @@ class LseProjectResponse(UncheckedBaseModel):
|
|
|
151
151
|
If set, the annotator can view model predictions
|
|
152
152
|
"""
|
|
153
153
|
|
|
154
|
-
show_ground_truth_first: typing.Optional[bool] = None
|
|
154
|
+
show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
|
|
155
|
+
"""
|
|
156
|
+
Onboarding mode (true): show ground truth tasks first in the labeling stream
|
|
157
|
+
"""
|
|
158
|
+
|
|
155
159
|
show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
|
|
156
160
|
"""
|
|
157
161
|
Show instructions to the annotator before they start
|
|
@@ -144,7 +144,11 @@ class LseProjectUpdate(UncheckedBaseModel):
|
|
|
144
144
|
If set, the annotator can view model predictions
|
|
145
145
|
"""
|
|
146
146
|
|
|
147
|
-
show_ground_truth_first: typing.Optional[bool] = None
|
|
147
|
+
show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
|
|
148
|
+
"""
|
|
149
|
+
Onboarding mode (true): show ground truth tasks first in the labeling stream
|
|
150
|
+
"""
|
|
151
|
+
|
|
148
152
|
show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
|
|
149
153
|
"""
|
|
150
154
|
Show instructions to the annotator before they start
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
# This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
|
|
3
|
+
from ..core.unchecked_base_model import UncheckedBaseModel
|
|
4
|
+
import typing
|
|
5
|
+
import pydantic
|
|
6
|
+
import datetime as dt
|
|
7
|
+
from .user_simple import UserSimple
|
|
8
|
+
from .project_sampling import ProjectSampling
|
|
9
|
+
from .project_skip_queue import ProjectSkipQueue
|
|
10
|
+
from ..core.pydantic_utilities import IS_PYDANTIC_V2
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class Project(UncheckedBaseModel):
|
|
14
|
+
"""
|
|
15
|
+
Serializer get numbers from project queryset annotation,
|
|
16
|
+
make sure, that you use correct one(Project.objects.with_counts())
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
color: typing.Optional[str] = None
|
|
20
|
+
config_has_control_tags: bool = pydantic.Field()
|
|
21
|
+
"""
|
|
22
|
+
Flag to detect is project ready for labeling
|
|
23
|
+
"""
|
|
24
|
+
|
|
25
|
+
config_suitable_for_bulk_annotation: bool = pydantic.Field()
|
|
26
|
+
"""
|
|
27
|
+
Flag to detect is project ready for bulk annotation
|
|
28
|
+
"""
|
|
29
|
+
|
|
30
|
+
control_weights: typing.Optional[typing.Optional[typing.Any]] = None
|
|
31
|
+
created_at: dt.datetime
|
|
32
|
+
created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
|
|
33
|
+
"""
|
|
34
|
+
Project owner
|
|
35
|
+
"""
|
|
36
|
+
|
|
37
|
+
description: typing.Optional[str] = pydantic.Field(default=None)
|
|
38
|
+
"""
|
|
39
|
+
Project description
|
|
40
|
+
"""
|
|
41
|
+
|
|
42
|
+
enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
|
|
43
|
+
"""
|
|
44
|
+
Allow annotators to submit empty annotations
|
|
45
|
+
"""
|
|
46
|
+
|
|
47
|
+
evaluate_predictions_automatically: typing.Optional[bool] = pydantic.Field(default=None)
|
|
48
|
+
"""
|
|
49
|
+
Retrieve and display predictions when loading a task
|
|
50
|
+
"""
|
|
51
|
+
|
|
52
|
+
expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
|
|
53
|
+
"""
|
|
54
|
+
Labeling instructions in HTML format
|
|
55
|
+
"""
|
|
56
|
+
|
|
57
|
+
finished_task_number: int = pydantic.Field()
|
|
58
|
+
"""
|
|
59
|
+
Finished tasks
|
|
60
|
+
"""
|
|
61
|
+
|
|
62
|
+
ground_truth_number: int = pydantic.Field()
|
|
63
|
+
"""
|
|
64
|
+
Honeypot annotation number in project
|
|
65
|
+
"""
|
|
66
|
+
|
|
67
|
+
id: int
|
|
68
|
+
is_draft: typing.Optional[bool] = pydantic.Field(default=None)
|
|
69
|
+
"""
|
|
70
|
+
Whether or not the project is in the middle of being created
|
|
71
|
+
"""
|
|
72
|
+
|
|
73
|
+
is_published: typing.Optional[bool] = pydantic.Field(default=None)
|
|
74
|
+
"""
|
|
75
|
+
Whether or not the project is published to annotators
|
|
76
|
+
"""
|
|
77
|
+
|
|
78
|
+
label_config: typing.Optional[str] = pydantic.Field(default=None)
|
|
79
|
+
"""
|
|
80
|
+
Label config in XML format. See more about it in documentation
|
|
81
|
+
"""
|
|
82
|
+
|
|
83
|
+
maximum_annotations: typing.Optional[int] = pydantic.Field(default=None)
|
|
84
|
+
"""
|
|
85
|
+
Maximum number of annotations for one task. If the number of annotations per task is equal or greater to this value, the task is completed (is_labeled=True)
|
|
86
|
+
"""
|
|
87
|
+
|
|
88
|
+
min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
|
|
89
|
+
"""
|
|
90
|
+
Minimum number of completed tasks after which model training is started
|
|
91
|
+
"""
|
|
92
|
+
|
|
93
|
+
model_version: typing.Optional[str] = pydantic.Field(default=None)
|
|
94
|
+
"""
|
|
95
|
+
Machine learning model version
|
|
96
|
+
"""
|
|
97
|
+
|
|
98
|
+
num_tasks_with_annotations: int = pydantic.Field()
|
|
99
|
+
"""
|
|
100
|
+
Tasks with annotations count
|
|
101
|
+
"""
|
|
102
|
+
|
|
103
|
+
organization: typing.Optional[int] = None
|
|
104
|
+
overlap_cohort_percentage: typing.Optional[int] = None
|
|
105
|
+
parsed_label_config: typing.Optional[typing.Any] = None
|
|
106
|
+
pinned_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
|
|
107
|
+
"""
|
|
108
|
+
Pinned date and time
|
|
109
|
+
"""
|
|
110
|
+
|
|
111
|
+
queue_done: int
|
|
112
|
+
queue_total: int
|
|
113
|
+
reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
|
|
114
|
+
"""
|
|
115
|
+
Reveal pre-annotations interactively
|
|
116
|
+
"""
|
|
117
|
+
|
|
118
|
+
sampling: typing.Optional[ProjectSampling] = None
|
|
119
|
+
show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
|
|
120
|
+
"""
|
|
121
|
+
Show annotation history to annotator
|
|
122
|
+
"""
|
|
123
|
+
|
|
124
|
+
show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
|
|
125
|
+
"""
|
|
126
|
+
If set, the annotator can view model predictions
|
|
127
|
+
"""
|
|
128
|
+
|
|
129
|
+
show_ground_truth_first: typing.Optional[bool] = pydantic.Field(default=None)
|
|
130
|
+
"""
|
|
131
|
+
Onboarding mode (true): show ground truth tasks first in the labeling stream
|
|
132
|
+
"""
|
|
133
|
+
|
|
134
|
+
show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
|
|
135
|
+
"""
|
|
136
|
+
Show instructions to the annotator before they start
|
|
137
|
+
"""
|
|
138
|
+
|
|
139
|
+
show_overlap_first: typing.Optional[bool] = None
|
|
140
|
+
show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
|
|
141
|
+
"""
|
|
142
|
+
Show a skip button in interface and allow annotators to skip the task
|
|
143
|
+
"""
|
|
144
|
+
|
|
145
|
+
skip_queue: typing.Optional[ProjectSkipQueue] = None
|
|
146
|
+
skipped_annotations_number: int = pydantic.Field()
|
|
147
|
+
"""
|
|
148
|
+
Skipped by collaborators annotation number in project
|
|
149
|
+
"""
|
|
150
|
+
|
|
151
|
+
start_training_on_annotation_update: bool = pydantic.Field()
|
|
152
|
+
"""
|
|
153
|
+
Start model training after any annotations are submitted or updated
|
|
154
|
+
"""
|
|
155
|
+
|
|
156
|
+
task_data_login: typing.Optional[str] = pydantic.Field(default=None)
|
|
157
|
+
"""
|
|
158
|
+
Task data credentials: login
|
|
159
|
+
"""
|
|
160
|
+
|
|
161
|
+
task_data_password: typing.Optional[str] = pydantic.Field(default=None)
|
|
162
|
+
"""
|
|
163
|
+
Task data credentials: password
|
|
164
|
+
"""
|
|
165
|
+
|
|
166
|
+
task_number: int = pydantic.Field()
|
|
167
|
+
"""
|
|
168
|
+
Total task number in project
|
|
169
|
+
"""
|
|
170
|
+
|
|
171
|
+
title: typing.Optional[str] = pydantic.Field(default=None)
|
|
172
|
+
"""
|
|
173
|
+
Project name. Must be between 3 and 50 characters long.
|
|
174
|
+
"""
|
|
175
|
+
|
|
176
|
+
total_annotations_number: int = pydantic.Field()
|
|
177
|
+
"""
|
|
178
|
+
Total annotations number in project including skipped_annotations_number and ground_truth_number.
|
|
179
|
+
"""
|
|
180
|
+
|
|
181
|
+
total_predictions_number: int = pydantic.Field()
|
|
182
|
+
"""
|
|
183
|
+
Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.
|
|
184
|
+
"""
|
|
185
|
+
|
|
186
|
+
useful_annotation_number: int = pydantic.Field()
|
|
187
|
+
"""
|
|
188
|
+
Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number
|
|
189
|
+
"""
|
|
190
|
+
|
|
191
|
+
if IS_PYDANTIC_V2:
|
|
192
|
+
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
|
|
193
|
+
else:
|
|
194
|
+
|
|
195
|
+
class Config:
|
|
196
|
+
frozen = True
|
|
197
|
+
smart_union = True
|
|
198
|
+
extra = pydantic.Extra.allow
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
|
|
3
|
+
from ..core.unchecked_base_model import UncheckedBaseModel
|
|
4
|
+
from ..core.pydantic_utilities import IS_PYDANTIC_V2
|
|
5
|
+
import typing
|
|
6
|
+
import pydantic
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class ProjectMember(UncheckedBaseModel):
|
|
10
|
+
user: int
|
|
11
|
+
|
|
12
|
+
if IS_PYDANTIC_V2:
|
|
13
|
+
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
|
|
14
|
+
else:
|
|
15
|
+
|
|
16
|
+
class Config:
|
|
17
|
+
frozen = True
|
|
18
|
+
smart_union = True
|
|
19
|
+
extra = pydantic.Extra.allow
|