label-studio-sdk 2.0.0__py3-none-any.whl → 2.0.2__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 (175) hide show
  1. label_studio_sdk/__init__.py +24 -0
  2. label_studio_sdk/actions/client.py +13 -13
  3. label_studio_sdk/actions/types/actions_list_response_item.py +3 -3
  4. label_studio_sdk/actions/types/actions_list_response_item_dialog.py +2 -2
  5. label_studio_sdk/annotations/client.py +441 -441
  6. label_studio_sdk/base_client.py +4 -0
  7. label_studio_sdk/billing/__init__.py +2 -0
  8. label_studio_sdk/billing/client.py +112 -0
  9. label_studio_sdk/comments/client.py +176 -176
  10. label_studio_sdk/export_storage/azure/client.py +274 -274
  11. label_studio_sdk/export_storage/gcs/client.py +263 -263
  12. label_studio_sdk/export_storage/local/client.py +206 -206
  13. label_studio_sdk/export_storage/redis/client.py +287 -287
  14. label_studio_sdk/export_storage/s3/client.py +347 -347
  15. label_studio_sdk/export_storage/s3s/client.py +678 -678
  16. label_studio_sdk/import_storage/azure/client.py +357 -357
  17. label_studio_sdk/import_storage/gcs/client.py +357 -357
  18. label_studio_sdk/import_storage/local/client.py +206 -206
  19. label_studio_sdk/import_storage/redis/client.py +309 -309
  20. label_studio_sdk/import_storage/s3/client.py +452 -452
  21. label_studio_sdk/import_storage/s3s/client.py +735 -735
  22. label_studio_sdk/jwt_settings/client.py +10 -10
  23. label_studio_sdk/ml/client.py +118 -118
  24. label_studio_sdk/ml/types/ml_list_model_versions_response.py +1 -1
  25. label_studio_sdk/model_providers/client.py +181 -181
  26. label_studio_sdk/organizations/members/client.py +348 -2
  27. label_studio_sdk/predictions/client.py +60 -60
  28. label_studio_sdk/projects/__init__.py +30 -1
  29. label_studio_sdk/projects/assignments/__init__.py +33 -0
  30. label_studio_sdk/projects/assignments/client.py +764 -0
  31. label_studio_sdk/projects/assignments/types/__init__.py +35 -0
  32. label_studio_sdk/projects/assignments/types/assignments_assign_request_type.py +5 -0
  33. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_filters.py +33 -0
  34. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_filters_conjunction.py +5 -0
  35. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_filters_items_item.py +44 -0
  36. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_filters_items_item_filter.py +31 -0
  37. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_filters_items_item_operator.py +23 -0
  38. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_filters_items_item_value.py +7 -0
  39. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_selected_items.py +9 -0
  40. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_selected_items_excluded.py +29 -0
  41. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_selected_items_included.py +29 -0
  42. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_request_type.py +5 -0
  43. label_studio_sdk/projects/assignments/types/assignments_bulk_assign_response.py +22 -0
  44. label_studio_sdk/projects/assignments/types/assignments_update_request_type.py +5 -0
  45. label_studio_sdk/projects/client.py +441 -425
  46. label_studio_sdk/projects/exports/client.py +55 -55
  47. label_studio_sdk/projects/exports/types/exports_convert_response.py +1 -1
  48. label_studio_sdk/projects/stats/types/stats_iaa_response.py +5 -5
  49. label_studio_sdk/projects/types/projects_import_tasks_response.py +12 -12
  50. label_studio_sdk/prompts/client.py +211 -211
  51. label_studio_sdk/prompts/runs/client.py +33 -33
  52. label_studio_sdk/prompts/versions/client.py +72 -72
  53. label_studio_sdk/tasks/client.py +174 -174
  54. label_studio_sdk/types/__init__.py +22 -0
  55. label_studio_sdk/types/all_roles_project_list.py +98 -98
  56. label_studio_sdk/types/annotation.py +35 -35
  57. label_studio_sdk/types/annotation_request.py +27 -27
  58. label_studio_sdk/types/azure_blob_export_storage.py +29 -29
  59. label_studio_sdk/types/azure_blob_import_storage.py +33 -33
  60. label_studio_sdk/types/batch_failed_predictions.py +1 -1
  61. label_studio_sdk/types/billing_checks.py +39 -0
  62. label_studio_sdk/types/billing_flags.py +44 -0
  63. label_studio_sdk/types/billing_info_response.py +22 -0
  64. label_studio_sdk/types/blueprint_list.py +7 -8
  65. label_studio_sdk/types/child_filter.py +11 -10
  66. label_studio_sdk/types/comment.py +15 -15
  67. label_studio_sdk/types/comment_request.py +7 -8
  68. label_studio_sdk/types/comment_serializer_with_expanded_user.py +17 -18
  69. label_studio_sdk/types/converted_format.py +1 -1
  70. label_studio_sdk/types/converted_format_request.py +1 -1
  71. label_studio_sdk/types/count_limit.py +22 -0
  72. label_studio_sdk/types/export.py +8 -8
  73. label_studio_sdk/types/file_upload.py +3 -2
  74. label_studio_sdk/types/filter.py +10 -9
  75. label_studio_sdk/types/filter_group.py +4 -3
  76. label_studio_sdk/types/gcs_export_storage.py +23 -23
  77. label_studio_sdk/types/gcs_import_storage.py +27 -27
  78. label_studio_sdk/types/import_api_request.py +26 -26
  79. label_studio_sdk/types/inference_run_cost_estimate.py +10 -10
  80. label_studio_sdk/types/local_files_export_storage.py +23 -23
  81. label_studio_sdk/types/local_files_import_storage.py +26 -26
  82. label_studio_sdk/types/lse_annotation_filter_options.py +10 -10
  83. label_studio_sdk/types/lse_annotation_filter_options_request.py +10 -10
  84. label_studio_sdk/types/lse_export_create.py +12 -12
  85. label_studio_sdk/types/lse_fields.py +14 -14
  86. label_studio_sdk/types/lse_organization.py +17 -17
  87. label_studio_sdk/types/lse_organization_member_list.py +32 -0
  88. label_studio_sdk/types/lse_project_create.py +72 -72
  89. label_studio_sdk/types/lse_project_update.py +89 -89
  90. label_studio_sdk/types/lse_s3export_storage.py +46 -46
  91. label_studio_sdk/types/lse_s3export_storage_request.py +43 -43
  92. label_studio_sdk/types/lse_s3import_storage.py +53 -53
  93. label_studio_sdk/types/lse_s3import_storage_request.py +49 -49
  94. label_studio_sdk/types/lse_task.py +49 -49
  95. label_studio_sdk/types/lse_task_drafts_item.py +1 -1
  96. label_studio_sdk/types/lse_task_filter_options.py +14 -14
  97. label_studio_sdk/types/lse_task_filter_options_request.py +14 -14
  98. label_studio_sdk/types/lse_task_predictions_item.py +5 -5
  99. label_studio_sdk/types/lse_task_serializer_for_annotators.py +12 -12
  100. label_studio_sdk/types/lse_task_serializer_for_annotators_drafts_item.py +1 -1
  101. label_studio_sdk/types/lse_task_serializer_for_annotators_predictions_item.py +5 -5
  102. label_studio_sdk/types/lse_task_serializer_for_reviewers.py +49 -49
  103. label_studio_sdk/types/lse_task_serializer_for_reviewers_drafts_item.py +1 -1
  104. label_studio_sdk/types/lse_task_serializer_for_reviewers_predictions_item.py +5 -5
  105. label_studio_sdk/types/lse_user.py +13 -13
  106. label_studio_sdk/types/lse_user_api.py +11 -11
  107. label_studio_sdk/types/lse_user_organization_member_list.py +48 -0
  108. label_studio_sdk/types/lseapi_token_create.py +1 -1
  109. label_studio_sdk/types/lseapi_token_list.py +1 -1
  110. label_studio_sdk/types/lsejwt_settings.py +5 -5
  111. label_studio_sdk/types/ml_backend.py +27 -28
  112. label_studio_sdk/types/model_interface.py +12 -12
  113. label_studio_sdk/types/model_interface_request.py +7 -8
  114. label_studio_sdk/types/model_interface_serializer_get.py +13 -13
  115. label_studio_sdk/types/model_provider_connection.py +34 -34
  116. label_studio_sdk/types/model_provider_connection_request.py +15 -14
  117. label_studio_sdk/types/model_run.py +12 -12
  118. label_studio_sdk/types/organization_billing.py +1 -1
  119. label_studio_sdk/types/organization_id.py +2 -2
  120. label_studio_sdk/types/organization_invite.py +1 -1
  121. label_studio_sdk/types/organization_member.py +8 -9
  122. label_studio_sdk/types/organization_membership.py +2 -1
  123. label_studio_sdk/types/paginated_lse_organization_member_list_list.py +23 -0
  124. label_studio_sdk/types/pause.py +23 -23
  125. label_studio_sdk/types/prediction.py +21 -21
  126. label_studio_sdk/types/prediction_request.py +16 -16
  127. label_studio_sdk/types/project.py +72 -72
  128. label_studio_sdk/types/project_import.py +21 -21
  129. label_studio_sdk/types/prompts_status_enum.py +16 -0
  130. label_studio_sdk/types/redis_export_storage.py +34 -34
  131. label_studio_sdk/types/redis_import_storage.py +37 -37
  132. label_studio_sdk/types/refined_prompt_response.py +11 -11
  133. label_studio_sdk/types/review_settings.py +29 -30
  134. label_studio_sdk/types/review_settings_request.py +29 -30
  135. label_studio_sdk/types/role9e7enum.py +5 -0
  136. label_studio_sdk/types/s3export_storage.py +45 -45
  137. label_studio_sdk/types/s3import_storage.py +44 -44
  138. label_studio_sdk/types/selected_items_request.py +1 -1
  139. label_studio_sdk/types/serialization_options.py +10 -10
  140. label_studio_sdk/types/serialization_options_request.py +10 -10
  141. label_studio_sdk/types/task_assignment.py +43 -0
  142. label_studio_sdk/types/third_party_model_version.py +11 -11
  143. label_studio_sdk/types/third_party_model_version_request.py +6 -7
  144. label_studio_sdk/types/type_enum.py +5 -0
  145. label_studio_sdk/types/user_simple.py +3 -3
  146. label_studio_sdk/types/user_simple_request.py +1 -1
  147. label_studio_sdk/types/version_response.py +19 -20
  148. label_studio_sdk/types/view.py +8 -8
  149. label_studio_sdk/types/webhook.py +16 -16
  150. label_studio_sdk/types/webhook_serializer_for_update.py +16 -16
  151. label_studio_sdk/types/workspace.py +10 -11
  152. label_studio_sdk/users/client.py +160 -160
  153. label_studio_sdk/views/client.py +164 -164
  154. label_studio_sdk/webhooks/client.py +183 -183
  155. label_studio_sdk/webhooks/types/webhooks_info_response.py +32 -32
  156. label_studio_sdk/webhooks/types/webhooks_info_response_annotation_created.py +1 -1
  157. label_studio_sdk/webhooks/types/webhooks_info_response_annotation_updated.py +1 -1
  158. label_studio_sdk/webhooks/types/webhooks_info_response_annotations_created.py +1 -1
  159. label_studio_sdk/webhooks/types/webhooks_info_response_annotations_deleted.py +1 -1
  160. label_studio_sdk/webhooks/types/webhooks_info_response_label_link_created.py +1 -1
  161. label_studio_sdk/webhooks/types/webhooks_info_response_label_link_deleted.py +1 -1
  162. label_studio_sdk/webhooks/types/webhooks_info_response_label_link_updated.py +1 -1
  163. label_studio_sdk/webhooks/types/webhooks_info_response_project_created.py +1 -1
  164. label_studio_sdk/webhooks/types/webhooks_info_response_project_deleted.py +1 -1
  165. label_studio_sdk/webhooks/types/webhooks_info_response_project_updated.py +1 -1
  166. label_studio_sdk/webhooks/types/webhooks_info_response_review_created.py +1 -1
  167. label_studio_sdk/webhooks/types/webhooks_info_response_review_updated.py +1 -1
  168. label_studio_sdk/webhooks/types/webhooks_info_response_reviews_deleted.py +1 -1
  169. label_studio_sdk/webhooks/types/webhooks_info_response_tasks_created.py +1 -1
  170. label_studio_sdk/webhooks/types/webhooks_info_response_tasks_deleted.py +1 -1
  171. label_studio_sdk/workspaces/client.py +40 -40
  172. {label_studio_sdk-2.0.0.dist-info → label_studio_sdk-2.0.2.dist-info}/METADATA +73 -25
  173. {label_studio_sdk-2.0.0.dist-info → label_studio_sdk-2.0.2.dist-info}/RECORD +175 -146
  174. {label_studio_sdk-2.0.0.dist-info → label_studio_sdk-2.0.2.dist-info}/LICENSE +0 -0
  175. {label_studio_sdk-2.0.0.dist-info → label_studio_sdk-2.0.2.dist-info}/WHEEL +0 -0
@@ -21,6 +21,9 @@ from .azure_blob_export_storage import AzureBlobExportStorage
21
21
  from .azure_blob_import_storage import AzureBlobImportStorage
22
22
  from .batch_failed_predictions import BatchFailedPredictions
23
23
  from .batch_predictions import BatchPredictions
24
+ from .billing_checks import BillingChecks
25
+ from .billing_flags import BillingFlags
26
+ from .billing_info_response import BillingInfoResponse
24
27
  from .blank_enum import BlankEnum
25
28
  from .blueprint_list import BlueprintList
26
29
  from .budget_reset_period_enum import BudgetResetPeriodEnum
@@ -30,6 +33,7 @@ from .comment_request import CommentRequest
30
33
  from .comment_serializer_with_expanded_user import CommentSerializerWithExpandedUser
31
34
  from .converted_format import ConvertedFormat
32
35
  from .converted_format_request import ConvertedFormatRequest
36
+ from .count_limit import CountLimit
33
37
  from .custom_scripts_editable_by_enum import CustomScriptsEditableByEnum
34
38
  from .default_role_enum import DefaultRoleEnum
35
39
  from .edition_enum import EditionEnum
@@ -58,6 +62,7 @@ from .lse_fields_trial_role import LseFieldsTrialRole
58
62
  from .lse_key_indicator_value import LseKeyIndicatorValue
59
63
  from .lse_organization import LseOrganization
60
64
  from .lse_organization_custom_scripts_editable_by import LseOrganizationCustomScriptsEditableBy
65
+ from .lse_organization_member_list import LseOrganizationMemberList
61
66
  from .lse_project_create import LseProjectCreate
62
67
  from .lse_project_create_sampling import LseProjectCreateSampling
63
68
  from .lse_project_create_skip_queue import LseProjectCreateSkipQueue
@@ -89,6 +94,7 @@ from .lse_task_serializer_for_reviewers_drafts_item import LseTaskSerializerForR
89
94
  from .lse_task_serializer_for_reviewers_predictions_item import LseTaskSerializerForReviewersPredictionsItem
90
95
  from .lse_user import LseUser
91
96
  from .lse_user_api import LseUserApi
97
+ from .lse_user_organization_member_list import LseUserOrganizationMemberList
92
98
  from .lseapi_token_create import LseapiTokenCreate
93
99
  from .lseapi_token_list import LseapiTokenList
94
100
  from .lsejwt_settings import LsejwtSettings
@@ -111,6 +117,7 @@ from .organization_invite import OrganizationInvite
111
117
  from .organization_member import OrganizationMember
112
118
  from .organization_membership import OrganizationMembership
113
119
  from .paginated_all_roles_project_list_list import PaginatedAllRolesProjectListList
120
+ from .paginated_lse_organization_member_list_list import PaginatedLseOrganizationMemberListList
114
121
  from .paginated_role_based_task_list import PaginatedRoleBasedTaskList
115
122
  from .pause import Pause
116
123
  from .pause_request import PauseRequest
@@ -123,6 +130,7 @@ from .project_label_config_request import ProjectLabelConfigRequest
123
130
  from .project_sampling import ProjectSampling
124
131
  from .project_skip_queue import ProjectSkipQueue
125
132
  from .project_subset_enum import ProjectSubsetEnum
133
+ from .prompts_status_enum import PromptsStatusEnum
126
134
  from .provider_enum import ProviderEnum
127
135
  from .reason_enum import ReasonEnum
128
136
  from .redis_export_storage import RedisExportStorage
@@ -137,6 +145,7 @@ from .review_settings_request_review_criteria import ReviewSettingsRequestReview
137
145
  from .review_settings_requeue_rejected_tasks_mode import ReviewSettingsRequeueRejectedTasksMode
138
146
  from .review_settings_review_criteria import ReviewSettingsReviewCriteria
139
147
  from .reviewed_enum import ReviewedEnum
148
+ from .role9e7enum import Role9E7Enum
140
149
  from .role_based_task import RoleBasedTask
141
150
  from .s3export_storage import S3ExportStorage
142
151
  from .s3import_storage import S3ImportStorage
@@ -153,11 +162,13 @@ from .skipped_enum import SkippedEnum
153
162
  from .state_enum import StateEnum
154
163
  from .status7bf_enum import Status7BfEnum
155
164
  from .status_c5a_enum import StatusC5AEnum
165
+ from .task_assignment import TaskAssignment
156
166
  from .third_party_model_version import ThirdPartyModelVersion
157
167
  from .third_party_model_version_request import ThirdPartyModelVersionRequest
158
168
  from .token_refresh_response import TokenRefreshResponse
159
169
  from .token_rotate_response import TokenRotateResponse
160
170
  from .trial_role_enum import TrialRoleEnum
171
+ from .type_enum import TypeEnum
161
172
  from .user_simple import UserSimple
162
173
  from .user_simple_request import UserSimpleRequest
163
174
  from .version_response import VersionResponse
@@ -188,6 +199,9 @@ __all__ = [
188
199
  "AzureBlobImportStorage",
189
200
  "BatchFailedPredictions",
190
201
  "BatchPredictions",
202
+ "BillingChecks",
203
+ "BillingFlags",
204
+ "BillingInfoResponse",
191
205
  "BlankEnum",
192
206
  "BlueprintList",
193
207
  "BudgetResetPeriodEnum",
@@ -197,6 +211,7 @@ __all__ = [
197
211
  "CommentSerializerWithExpandedUser",
198
212
  "ConvertedFormat",
199
213
  "ConvertedFormatRequest",
214
+ "CountLimit",
200
215
  "CustomScriptsEditableByEnum",
201
216
  "DefaultRoleEnum",
202
217
  "EditionEnum",
@@ -225,6 +240,7 @@ __all__ = [
225
240
  "LseKeyIndicatorValue",
226
241
  "LseOrganization",
227
242
  "LseOrganizationCustomScriptsEditableBy",
243
+ "LseOrganizationMemberList",
228
244
  "LseProjectCreate",
229
245
  "LseProjectCreateSampling",
230
246
  "LseProjectCreateSkipQueue",
@@ -256,6 +272,7 @@ __all__ = [
256
272
  "LseTaskSerializerForReviewersPredictionsItem",
257
273
  "LseUser",
258
274
  "LseUserApi",
275
+ "LseUserOrganizationMemberList",
259
276
  "LseapiTokenCreate",
260
277
  "LseapiTokenList",
261
278
  "LsejwtSettings",
@@ -278,6 +295,7 @@ __all__ = [
278
295
  "OrganizationMember",
279
296
  "OrganizationMembership",
280
297
  "PaginatedAllRolesProjectListList",
298
+ "PaginatedLseOrganizationMemberListList",
281
299
  "PaginatedRoleBasedTaskList",
282
300
  "Pause",
283
301
  "PauseRequest",
@@ -290,6 +308,7 @@ __all__ = [
290
308
  "ProjectSampling",
291
309
  "ProjectSkipQueue",
292
310
  "ProjectSubsetEnum",
311
+ "PromptsStatusEnum",
293
312
  "ProviderEnum",
294
313
  "ReasonEnum",
295
314
  "RedisExportStorage",
@@ -304,6 +323,7 @@ __all__ = [
304
323
  "ReviewSettingsRequeueRejectedTasksMode",
305
324
  "ReviewSettingsReviewCriteria",
306
325
  "ReviewedEnum",
326
+ "Role9E7Enum",
307
327
  "RoleBasedTask",
308
328
  "S3ExportStorage",
309
329
  "S3ImportStorage",
@@ -320,11 +340,13 @@ __all__ = [
320
340
  "StateEnum",
321
341
  "Status7BfEnum",
322
342
  "StatusC5AEnum",
343
+ "TaskAssignment",
323
344
  "ThirdPartyModelVersion",
324
345
  "ThirdPartyModelVersionRequest",
325
346
  "TokenRefreshResponse",
326
347
  "TokenRotateResponse",
327
348
  "TrialRoleEnum",
349
+ "TypeEnum",
328
350
  "UserSimple",
329
351
  "UserSimpleRequest",
330
352
  "VersionResponse",
@@ -2,14 +2,14 @@
2
2
 
3
3
  from ..core.unchecked_base_model import UncheckedBaseModel
4
4
  import typing
5
+ from .assignment_settings import AssignmentSettings
6
+ from .blueprint_list import BlueprintList
5
7
  import pydantic
6
- from .all_roles_project_list_sampling import AllRolesProjectListSampling
7
- from .user_simple import UserSimple
8
8
  import datetime as dt
9
- from .blueprint_list import BlueprintList
10
- from .assignment_settings import AssignmentSettings
11
- from .all_roles_project_list_skip_queue import AllRolesProjectListSkipQueue
9
+ from .user_simple import UserSimple
12
10
  from .review_settings import ReviewSettings
11
+ from .all_roles_project_list_sampling import AllRolesProjectListSampling
12
+ from .all_roles_project_list_skip_queue import AllRolesProjectListSkipQueue
13
13
  from ..core.pydantic_utilities import IS_PYDANTIC_V2
14
14
 
15
15
 
@@ -19,173 +19,173 @@ class AllRolesProjectList(UncheckedBaseModel):
19
19
  make sure, that you use correct one(Project.objects.with_counts())
20
20
  """
21
21
 
22
- workspace_title: str
23
- ready: str
24
- overlap_cohort_percentage: typing.Optional[int] = None
25
- queue_left: str
22
+ allow_stream: str
23
+ annotation_limit_count: typing.Optional[int] = None
24
+ annotation_limit_percent: typing.Optional[str] = None
25
+ annotator_evaluation_minimum_score: typing.Optional[str] = None
26
+ annotator_evaluation_minimum_tasks: typing.Optional[int] = None
27
+ assignment_settings: AssignmentSettings
28
+ blueprints: typing.List[BlueprintList]
29
+ color: typing.Optional[str] = None
30
+ comment_classification_config: typing.Optional[str] = None
31
+ config_has_control_tags: bool = pydantic.Field()
32
+ """
33
+ Flag to detect is project ready for labeling
34
+ """
35
+
26
36
  config_suitable_for_bulk_annotation: bool = pydantic.Field()
27
37
  """
28
38
  Flag to detect is project ready for bulk annotation
29
39
  """
30
40
 
31
- has_blueprints: str
32
- show_overlap_first: typing.Optional[bool] = None
33
- queue_total: str
34
- enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
41
+ control_weights: typing.Optional[typing.Optional[typing.Any]] = None
42
+ created_at: dt.datetime
43
+ created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
35
44
  """
36
- Allow annotators to submit empty annotations
45
+ Project owner
37
46
  """
38
47
 
48
+ custom_script: typing.Optional[str] = None
39
49
  custom_task_lock_ttl: typing.Optional[int] = pydantic.Field(default=None)
40
50
  """
41
51
  TTL in seconds for task reservations, on new and existing tasks
42
52
  """
43
53
 
44
- prompts: str
45
- start_training_on_annotation_update: bool = pydantic.Field()
46
- """
47
- Start model training after any annotations are submitted or updated
48
- """
49
-
50
- evaluate_predictions_automatically: typing.Optional[bool] = pydantic.Field(default=None)
51
- """
52
- Retrieve and display predictions when loading a task
53
- """
54
-
55
- show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
54
+ data_types: typing.Optional[typing.Any] = None
55
+ description: typing.Optional[str] = pydantic.Field(default=None)
56
56
  """
57
- Show instructions to the annotator before they start
57
+ Project description
58
58
  """
59
59
 
60
- color: typing.Optional[str] = None
61
- sampling: typing.Optional[AllRolesProjectListSampling] = None
62
- created_by: typing.Optional[UserSimple] = pydantic.Field(default=None)
60
+ description_short: str
61
+ duplication_done: typing.Optional[bool] = None
62
+ duplication_status: typing.Optional[str] = None
63
+ enable_empty_annotation: typing.Optional[bool] = pydantic.Field(default=None)
63
64
  """
64
- Project owner
65
+ Allow annotators to submit empty annotations
65
66
  """
66
67
 
67
- reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
68
+ evaluate_predictions_automatically: typing.Optional[bool] = pydantic.Field(default=None)
68
69
  """
69
- Reveal pre-annotations interactively
70
+ Retrieve and display predictions when loading a task
70
71
  """
71
72
 
72
- pinned_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
73
+ expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
73
74
  """
74
- Pinned date and time
75
+ Labeling instructions in HTML format
75
76
  """
76
77
 
77
78
  finished_task_number: int
78
- parsed_label_config: typing.Optional[typing.Any] = None
79
- duplication_done: typing.Optional[bool] = None
80
- reviewer_queue_total: str
81
- show_ground_truth_first: typing.Optional[bool] = None
82
- task_number: int = pydantic.Field()
79
+ ground_truth_number: int = pydantic.Field()
83
80
  """
84
- Total task number in project
81
+ Honeypot annotation number in project
85
82
  """
86
83
 
87
- num_tasks_with_annotations: str
88
- description_short: str
84
+ has_blueprints: str
89
85
  id: int
90
- allow_stream: str
91
- annotation_limit_percent: typing.Optional[str] = None
92
- created_at: dt.datetime
93
- annotation_limit_count: typing.Optional[int] = None
94
- queue_done: str
95
- control_weights: typing.Optional[typing.Optional[typing.Any]] = None
96
- data_types: typing.Optional[typing.Any] = None
97
- reviewed_number: str
98
- total_annotations_number: str
99
- total_predictions_number: int
100
- config_has_control_tags: bool = pydantic.Field()
86
+ is_draft: typing.Optional[bool] = pydantic.Field(default=None)
101
87
  """
102
- Flag to detect is project ready for labeling
88
+ Whether or not the project is in the middle of being created
103
89
  """
104
90
 
105
- blueprints: typing.List[BlueprintList]
106
91
  is_published: typing.Optional[bool] = pydantic.Field(default=None)
107
92
  """
108
93
  Whether or not the project is published to annotators
109
94
  """
110
95
 
111
- duplication_status: typing.Optional[str] = None
112
- review_total_tasks: str
113
- show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
114
- """
115
- Show a skip button in interface and allow annotators to skip the task
116
- """
117
-
118
- is_draft: typing.Optional[bool] = pydantic.Field(default=None)
119
- """
120
- Whether or not the project is in the middle of being created
121
- """
122
-
123
- title: typing.Optional[str] = pydantic.Field(default=None)
96
+ label_config: typing.Optional[str] = pydantic.Field(default=None)
124
97
  """
125
- Project name. Must be between 3 and 50 characters long.
98
+ Label config in XML format. See more about it in documentation
126
99
  """
127
100
 
128
- show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
101
+ maximum_annotations: typing.Optional[int] = pydantic.Field(default=None)
129
102
  """
130
- If set, the annotator can view model predictions
103
+ 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)
131
104
  """
132
105
 
133
106
  members: str
107
+ members_count: int
134
108
  min_annotations_to_start_training: typing.Optional[int] = pydantic.Field(default=None)
135
109
  """
136
110
  Minimum number of completed tasks after which model training is started
137
111
  """
138
112
 
139
- workspace: str
113
+ model_version: typing.Optional[str] = pydantic.Field(default=None)
114
+ """
115
+ Machine learning model version
116
+ """
117
+
118
+ num_tasks_with_annotations: str
140
119
  organization: typing.Optional[int] = None
141
- assignment_settings: AssignmentSettings
142
- annotator_evaluation_minimum_tasks: typing.Optional[int] = None
143
- skipped_annotations_number: str
144
- annotator_evaluation_minimum_score: typing.Optional[str] = None
145
- comment_classification_config: typing.Optional[str] = None
146
- description: typing.Optional[str] = pydantic.Field(default=None)
120
+ overlap_cohort_percentage: typing.Optional[int] = None
121
+ parsed_label_config: typing.Optional[typing.Any] = None
122
+ pause_on_failed_annotator_evaluation: typing.Optional[bool] = None
123
+ pinned_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
147
124
  """
148
- Project description
125
+ Pinned date and time
149
126
  """
150
127
 
151
- expert_instruction: typing.Optional[str] = pydantic.Field(default=None)
128
+ prompts: str
129
+ queue_done: str
130
+ queue_left: str
131
+ queue_total: str
132
+ ready: str
133
+ rejected: str
134
+ require_comment_on_skip: typing.Optional[bool] = None
135
+ reveal_preannotations_interactively: typing.Optional[bool] = pydantic.Field(default=None)
152
136
  """
153
- Labeling instructions in HTML format
137
+ Reveal pre-annotations interactively
154
138
  """
155
139
 
140
+ review_settings: ReviewSettings
141
+ review_total_tasks: str
142
+ reviewed_number: str
143
+ reviewer_queue_total: str
144
+ sampling: typing.Optional[AllRolesProjectListSampling] = None
156
145
  show_annotation_history: typing.Optional[bool] = pydantic.Field(default=None)
157
146
  """
158
147
  Show annotation history to annotator
159
148
  """
160
149
 
161
- skip_queue: typing.Optional[AllRolesProjectListSkipQueue] = None
162
- review_settings: ReviewSettings
163
- members_count: str
164
- model_version: typing.Optional[str] = pydantic.Field(default=None)
150
+ show_collab_predictions: typing.Optional[bool] = pydantic.Field(default=None)
165
151
  """
166
- Machine learning model version
152
+ If set, the annotator can view model predictions
167
153
  """
168
154
 
169
- useful_annotation_number: str
170
- custom_script: typing.Optional[str] = None
171
- require_comment_on_skip: typing.Optional[bool] = None
172
- ground_truth_number: int = pydantic.Field()
155
+ show_ground_truth_first: typing.Optional[bool] = None
156
+ show_instruction: typing.Optional[bool] = pydantic.Field(default=None)
173
157
  """
174
- Honeypot annotation number in project
158
+ Show instructions to the annotator before they start
175
159
  """
176
160
 
177
- pause_on_failed_annotator_evaluation: typing.Optional[bool] = None
178
- label_config: typing.Optional[str] = pydantic.Field(default=None)
161
+ show_overlap_first: typing.Optional[bool] = None
162
+ show_skip_button: typing.Optional[bool] = pydantic.Field(default=None)
179
163
  """
180
- Label config in XML format. See more about it in documentation
164
+ Show a skip button in interface and allow annotators to skip the task
181
165
  """
182
166
 
183
- maximum_annotations: typing.Optional[int] = pydantic.Field(default=None)
167
+ skip_queue: typing.Optional[AllRolesProjectListSkipQueue] = None
168
+ skipped_annotations_number: str
169
+ start_training_on_annotation_update: bool = pydantic.Field()
184
170
  """
185
- 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)
171
+ Start model training after any annotations are submitted or updated
186
172
  """
187
173
 
188
- rejected: str
174
+ task_number: int = pydantic.Field()
175
+ """
176
+ Total task number in project
177
+ """
178
+
179
+ title: typing.Optional[str] = pydantic.Field(default=None)
180
+ """
181
+ Project name. Must be between 3 and 50 characters long.
182
+ """
183
+
184
+ total_annotations_number: str
185
+ total_predictions_number: int
186
+ useful_annotation_number: str
187
+ workspace: str
188
+ workspace_title: str
189
189
 
190
190
  if IS_PYDANTIC_V2:
191
191
  model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
@@ -9,41 +9,25 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
9
9
 
10
10
 
11
11
  class Annotation(UncheckedBaseModel):
12
- id: int
13
- result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
14
- """
15
- List of annotation results for the task
16
- """
17
-
18
- created_username: str = pydantic.Field()
12
+ bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
19
13
  """
20
- Username string
14
+ Annotation was created in bulk mode
21
15
  """
22
16
 
17
+ completed_by: typing.Optional[int] = None
23
18
  created_ago: str = pydantic.Field()
24
19
  """
25
20
  Time delta from creation time
26
21
  """
27
22
 
28
- completed_by: typing.Optional[int] = None
29
- was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
30
- """
31
- User skipped the task
32
- """
33
-
34
- ground_truth: typing.Optional[bool] = pydantic.Field(default=None)
35
- """
36
- This annotation is a Ground Truth (ground_truth)
37
- """
38
-
39
23
  created_at: dt.datetime = pydantic.Field()
40
24
  """
41
25
  Creation time
42
26
  """
43
27
 
44
- updated_at: dt.datetime = pydantic.Field()
28
+ created_username: str = pydantic.Field()
45
29
  """
46
- Last updated time
30
+ Username string
47
31
  """
48
32
 
49
33
  draft_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
@@ -51,11 +35,12 @@ class Annotation(UncheckedBaseModel):
51
35
  Draft creation time
52
36
  """
53
37
 
54
- lead_time: typing.Optional[float] = pydantic.Field(default=None)
38
+ ground_truth: typing.Optional[bool] = pydantic.Field(default=None)
55
39
  """
56
- How much time it took to annotate the task
40
+ This annotation is a Ground Truth (ground_truth)
57
41
  """
58
42
 
43
+ id: int
59
44
  import_id: typing.Optional[int] = pydantic.Field(default=None)
60
45
  """
61
46
  Original annotation ID that was at the import step or NULL if this annotation wasn't imported
@@ -77,14 +62,24 @@ class Annotation(UncheckedBaseModel):
77
62
  * `deleted_review` - Deleted review
78
63
  """
79
64
 
80
- bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
65
+ last_created_by: typing.Optional[int] = pydantic.Field(default=None)
81
66
  """
82
- Annotation was created in bulk mode
67
+ User who created the last annotation history item
83
68
  """
84
69
 
85
- task: typing.Optional[int] = pydantic.Field(default=None)
70
+ lead_time: typing.Optional[float] = pydantic.Field(default=None)
86
71
  """
87
- Corresponding task for this annotation
72
+ How much time it took to annotate the task
73
+ """
74
+
75
+ parent_annotation: typing.Optional[int] = pydantic.Field(default=None)
76
+ """
77
+ Points to the parent annotation from which this annotation was created
78
+ """
79
+
80
+ parent_prediction: typing.Optional[int] = pydantic.Field(default=None)
81
+ """
82
+ Points to the prediction from which this annotation was created
88
83
  """
89
84
 
90
85
  project: typing.Optional[int] = pydantic.Field(default=None)
@@ -92,24 +87,29 @@ class Annotation(UncheckedBaseModel):
92
87
  Project ID for this annotation
93
88
  """
94
89
 
95
- updated_by: typing.Optional[int] = pydantic.Field(default=None)
90
+ result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
96
91
  """
97
- Last user who updated this annotation
92
+ List of annotation results for the task
98
93
  """
99
94
 
100
- parent_prediction: typing.Optional[int] = pydantic.Field(default=None)
95
+ task: typing.Optional[int] = pydantic.Field(default=None)
101
96
  """
102
- Points to the prediction from which this annotation was created
97
+ Corresponding task for this annotation
103
98
  """
104
99
 
105
- parent_annotation: typing.Optional[int] = pydantic.Field(default=None)
100
+ updated_at: dt.datetime = pydantic.Field()
106
101
  """
107
- Points to the parent annotation from which this annotation was created
102
+ Last updated time
108
103
  """
109
104
 
110
- last_created_by: typing.Optional[int] = pydantic.Field(default=None)
105
+ updated_by: typing.Optional[int] = pydantic.Field(default=None)
111
106
  """
112
- User who created the last annotation history item
107
+ Last user who updated this annotation
108
+ """
109
+
110
+ was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
111
+ """
112
+ User skipped the task
113
113
  """
114
114
 
115
115
  if IS_PYDANTIC_V2:
@@ -9,31 +9,20 @@ from ..core.pydantic_utilities import IS_PYDANTIC_V2
9
9
 
10
10
 
11
11
  class AnnotationRequest(UncheckedBaseModel):
12
- result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
12
+ bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
13
13
  """
14
- List of annotation results for the task
14
+ Annotation was created in bulk mode
15
15
  """
16
16
 
17
17
  completed_by: typing.Optional[int] = None
18
- unique_id: typing.Optional[str] = None
19
- was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
20
- """
21
- User skipped the task
22
- """
23
-
24
- ground_truth: typing.Optional[bool] = pydantic.Field(default=None)
25
- """
26
- This annotation is a Ground Truth (ground_truth)
27
- """
28
-
29
18
  draft_created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
30
19
  """
31
20
  Draft creation time
32
21
  """
33
22
 
34
- lead_time: typing.Optional[float] = pydantic.Field(default=None)
23
+ ground_truth: typing.Optional[bool] = pydantic.Field(default=None)
35
24
  """
36
- How much time it took to annotate the task
25
+ This annotation is a Ground Truth (ground_truth)
37
26
  """
38
27
 
39
28
  import_id: typing.Optional[int] = pydantic.Field(default=None)
@@ -57,14 +46,24 @@ class AnnotationRequest(UncheckedBaseModel):
57
46
  * `deleted_review` - Deleted review
58
47
  """
59
48
 
60
- bulk_created: typing.Optional[bool] = pydantic.Field(default=None)
49
+ last_created_by: typing.Optional[int] = pydantic.Field(default=None)
61
50
  """
62
- Annotation was created in bulk mode
51
+ User who created the last annotation history item
63
52
  """
64
53
 
65
- task: typing.Optional[int] = pydantic.Field(default=None)
54
+ lead_time: typing.Optional[float] = pydantic.Field(default=None)
66
55
  """
67
- Corresponding task for this annotation
56
+ How much time it took to annotate the task
57
+ """
58
+
59
+ parent_annotation: typing.Optional[int] = pydantic.Field(default=None)
60
+ """
61
+ Points to the parent annotation from which this annotation was created
62
+ """
63
+
64
+ parent_prediction: typing.Optional[int] = pydantic.Field(default=None)
65
+ """
66
+ Points to the prediction from which this annotation was created
68
67
  """
69
68
 
70
69
  project: typing.Optional[int] = pydantic.Field(default=None)
@@ -72,24 +71,25 @@ class AnnotationRequest(UncheckedBaseModel):
72
71
  Project ID for this annotation
73
72
  """
74
73
 
75
- updated_by: typing.Optional[int] = pydantic.Field(default=None)
74
+ result: typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]] = pydantic.Field(default=None)
76
75
  """
77
- Last user who updated this annotation
76
+ List of annotation results for the task
78
77
  """
79
78
 
80
- parent_prediction: typing.Optional[int] = pydantic.Field(default=None)
79
+ task: typing.Optional[int] = pydantic.Field(default=None)
81
80
  """
82
- Points to the prediction from which this annotation was created
81
+ Corresponding task for this annotation
83
82
  """
84
83
 
85
- parent_annotation: typing.Optional[int] = pydantic.Field(default=None)
84
+ unique_id: typing.Optional[str] = None
85
+ updated_by: typing.Optional[int] = pydantic.Field(default=None)
86
86
  """
87
- Points to the parent annotation from which this annotation was created
87
+ Last user who updated this annotation
88
88
  """
89
89
 
90
- last_created_by: typing.Optional[int] = pydantic.Field(default=None)
90
+ was_cancelled: typing.Optional[bool] = pydantic.Field(default=None)
91
91
  """
92
- User who created the last annotation history item
92
+ User skipped the task
93
93
  """
94
94
 
95
95
  if IS_PYDANTIC_V2: