-
Notifications
You must be signed in to change notification settings - Fork 34
/
search_requests.pyi
2179 lines (1840 loc) · 83.8 KB
/
search_requests.pyi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
__all__ = [
'SortItemSelf',
'SortItemsSelf',
'SortOrder',
'BaseSortItem',
'BaseSortItems',
'SearchRequestMetaclass',
'BaseSearchRequest',
'ProjectSearchRequest',
'ProjectSortItems',
'PoolSearchRequest',
'PoolSortItems',
'TrainingSearchRequest',
'TrainingSortItems',
'SkillSearchRequest',
'SkillSortItems',
'AssignmentSearchRequest',
'AssignmentSortItems',
'AggregatedSolutionSearchRequest',
'AggregatedSolutionSortItems',
'TaskSearchRequest',
'TaskSortItems',
'TaskSuiteSearchRequest',
'TaskSuiteSortItems',
'AttachmentSearchRequest',
'AttachmentSortItems',
'UserSkillSearchRequest',
'UserSkillSortItems',
'UserRestrictionSearchRequest',
'UserRestrictionSortItems',
'UserBonusSearchRequest',
'UserBonusSortItems',
'MessageThreadSearchRequest',
'MessageThreadSortItems',
'WebhookSubscriptionSearchRequest',
'WebhookSubscriptionSortItems',
'OperationSearchRequest',
'OperationSortItems',
'AppProjectSearchRequest',
'AppProjectSortItems',
'AppSearchRequest',
'AppSortItems',
'AppItemSearchRequest',
'AppItemSortItems',
'AppBatchSearchRequest',
'AppBatchSortItems',
]
import datetime
import enum
import toloka.client.app
import toloka.client.assignment
import toloka.client.attachment
import toloka.client.message_thread
import toloka.client.operations
import toloka.client.pool
import toloka.client.primitives.base
import toloka.client.project
import toloka.client.training
import toloka.client.user_restriction
import toloka.client.webhook_subscription
import typing
SortItemSelf = typing.TypeVar('SortItemSelf', bound='BaseSortItem')
SortItemsSelf = typing.TypeVar('SortItemsSelf', bound='BaseSortItems')
class SortOrder(enum.Enum):
"""An enumeration.
"""
ASCENDING = 1
DESCENDING = 2
class BaseSortItem(toloka.client.primitives.base.BaseTolokaObject):
def unstructure(self): ...
@classmethod
def structure(cls: typing.Type[SortItemSelf], value: typing.Union[SortItemSelf, str]) -> SortItemSelf: ...
@classmethod
def for_fields(
cls,
qualname: str,
sort_fields: typing.List[str]
): ...
def __init__(self) -> None:
"""Method generated by attrs for class BaseSortItem.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
class BaseSortItems(toloka.client.primitives.base.BaseTolokaObject):
def unstructure(self): ...
@classmethod
def structure(cls, items): ...
@classmethod
def for_fields(
cls,
qualname: str,
sort_fields: typing.List[str],
docstring: typing.Optional[str] = None
): ...
def __init__(self) -> None:
"""Method generated by attrs for class BaseSortItems.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
class SearchRequestMetaclass(toloka.client.primitives.base.BaseTolokaObjectMetaclass):
@staticmethod
def __new__(
mcs,
name,
bases,
namespace,
kw_only=False,
**kwargs
): ...
class BaseSearchRequest(toloka.client.primitives.base.BaseTolokaObject, metaclass=SearchRequestMetaclass):
"""Base class for all search request classes
"""
class CompareFields:
...
def __init__(self) -> None:
"""Method generated by attrs for class BaseSearchRequest.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
class ProjectSearchRequest(BaseSearchRequest):
"""Parameters for searching projects.
Attributes:
status: Project status.
Refer to the [ProjectStatus](toloka.client.project.Project.ProjectStatus.md) page for more information on the available `status` values.
id_lt: Projects with IDs less than the specified value.
id_lte: Projects with IDs less than or equal to the specified value.
id_gt: Projects with IDs greater than the specified value.
id_gte: Projects with IDs greater than or equal to the specified value.
created_lt: Projects created before the specified date.
created_lte: Projects created before or on the specified date.
created_gt: Projects created after the specified date.
created_gte: Projects created after or on the specified date.
"""
class CompareFields:
id: str
created: datetime.datetime
def __init__(
self,
status: typing.Optional[toloka.client.project.Project.ProjectStatus] = None,
id_lt: typing.Optional[str] = None,
id_lte: typing.Optional[str] = None,
id_gt: typing.Optional[str] = None,
id_gte: typing.Optional[str] = None,
created_lt: typing.Optional[datetime.datetime] = None,
created_lte: typing.Optional[datetime.datetime] = None,
created_gt: typing.Optional[datetime.datetime] = None,
created_gte: typing.Optional[datetime.datetime] = None
) -> None:
"""Method generated by attrs for class ProjectSearchRequest.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
status: typing.Optional[toloka.client.project.Project.ProjectStatus]
id_lt: typing.Optional[str]
id_lte: typing.Optional[str]
id_gt: typing.Optional[str]
id_gte: typing.Optional[str]
created_lt: typing.Optional[datetime.datetime]
created_lte: typing.Optional[datetime.datetime]
created_gt: typing.Optional[datetime.datetime]
created_gte: typing.Optional[datetime.datetime]
class ProjectSortItems(BaseSortItems):
"""Keys for sorting projects in search results.
Attributes:
items: A list of sorting keys. Supported values:
* `'id'` — A project ID.
* `'created'` — A project creation date.
* `'public_name'` — A project name.
* `'private_comment'` — A project private comment.
Example:
The example shows how to find active projects sorted by names in descending order. Projects with equal names are sorted by IDs in ascending order.
>>> sort = toloka.client.search_requests.ProjectSortItems(['-public_name', 'id'])
>>> result = toloka_client.find_projects(status='ACTIVE', sort=sort, limit=50)
...
"""
class SortItem(BaseSortItem):
class SortField(enum.Enum):
"""An enumeration.
"""
ID = 'id'
CREATED = 'created'
PUBLIC_NAME = 'public_name'
PRIVATE_COMMENT = 'private_comment'
def __init__(
self,
field: typing.Optional[SortField] = None,
order: typing.Optional[SortOrder] = SortOrder.ASCENDING
) -> None:
"""Method generated by attrs for class ProjectSortItems.SortItem.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
field: typing.Optional[SortField]
order: typing.Optional[SortOrder]
def __init__(self, items=None) -> None:
"""Method generated by attrs for class ProjectSortItems.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
items: typing.Optional[typing.List[SortItem]]
class PoolSearchRequest(BaseSearchRequest):
"""Parameters for searching pools.
Attributes:
status: Pool status. Refer to the [Pool.Status](toloka.client.pool.Pool.Status.md) page for more information on the available `status` values.
project_id: Pools belonging to the project with the specified ID.
id_lt: Pools with IDs less than the specified value.
id_lte: Pools with IDs less than or equal to the specified value.
id_gt: Pools with IDs greater than the specified value.
id_gte: Pools with IDs greater than or equal to the specified value.
created_lt: Pools created before the specified date.
created_lte: Pools created before or on the specified date.
created_gt: Pools created after the specified date.
created_gte: Pools created after or on the specified date.
last_started_lt: Pools that were opened last time before the specified date.
last_started_lte: Pools that were opened last time before or on the specified date.
last_started_gt: Pools that were opened last time after the specified date.
last_started_gte: Pools that were opened last time after or on the specified date.
"""
class CompareFields:
id: str
created: datetime.datetime
last_started: datetime.datetime
def __init__(
self,
status: typing.Optional[toloka.client.pool.Pool.Status] = None,
project_id: typing.Optional[str] = None,
id_lt: typing.Optional[str] = None,
id_lte: typing.Optional[str] = None,
id_gt: typing.Optional[str] = None,
id_gte: typing.Optional[str] = None,
created_lt: typing.Optional[datetime.datetime] = None,
created_lte: typing.Optional[datetime.datetime] = None,
created_gt: typing.Optional[datetime.datetime] = None,
created_gte: typing.Optional[datetime.datetime] = None,
last_started_lt: typing.Optional[datetime.datetime] = None,
last_started_lte: typing.Optional[datetime.datetime] = None,
last_started_gt: typing.Optional[datetime.datetime] = None,
last_started_gte: typing.Optional[datetime.datetime] = None
) -> None:
"""Method generated by attrs for class PoolSearchRequest.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
status: typing.Optional[toloka.client.pool.Pool.Status]
project_id: typing.Optional[str]
id_lt: typing.Optional[str]
id_lte: typing.Optional[str]
id_gt: typing.Optional[str]
id_gte: typing.Optional[str]
created_lt: typing.Optional[datetime.datetime]
created_lte: typing.Optional[datetime.datetime]
created_gt: typing.Optional[datetime.datetime]
created_gte: typing.Optional[datetime.datetime]
last_started_lt: typing.Optional[datetime.datetime]
last_started_lte: typing.Optional[datetime.datetime]
last_started_gt: typing.Optional[datetime.datetime]
last_started_gte: typing.Optional[datetime.datetime]
class PoolSortItems(BaseSortItems):
"""Keys for sorting pools in search results.
Attributes:
items: A list of sorting keys. Supported values:
* `'id'` — A pool ID.
* `'created'` — A pool creation date.
* `'last_started'` — The last opening date of a pool.
Example:
The example shows how to find opened pools sorted by the last opening date in descending order. Pools with equal opening dates are sorted by IDs in ascending order.
>>> sort = toloka.client.search_requests.PoolSortItems(['-last_started', 'id'])
>>> result = toloka_client.find_pools(status='OPEN', sort=sort, limit=50)
...
"""
class SortItem(BaseSortItem):
class SortField(enum.Enum):
"""An enumeration.
"""
ID = 'id'
CREATED = 'created'
LAST_STARTED = 'last_started'
def __init__(
self,
field: typing.Optional[SortField] = None,
order: typing.Optional[SortOrder] = SortOrder.ASCENDING
) -> None:
"""Method generated by attrs for class PoolSortItems.SortItem.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
field: typing.Optional[SortField]
order: typing.Optional[SortOrder]
def __init__(self, items=None) -> None:
"""Method generated by attrs for class PoolSortItems.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
items: typing.Optional[typing.List[SortItem]]
class TrainingSearchRequest(BaseSearchRequest):
"""Parameters for searching training pools.
Attributes:
status: Training pool status.
Refer to the [Training.Status](toloka.client.training.Training.Status.md) page for more information on the available `status` values.
project_id: Training pools belonging to the project with the specified ID.
id_lt: Training pools with IDs less than the specified value.
id_lte: Training pools with IDs less than or equal to the specified value.
id_gt: Training pools with IDs greater than the specified value.
id_gte: Training pools with IDs greater than or equal to the specified value.
created_lt: Training pools created before the specified date.
created_lte: Training pools created before or on the specified date.
created_gt: Training pools created after the specified date.
created_gte: Training pools created after or on the specified date.
last_started_lt: Training pools that were opened last time before the specified date.
last_started_lte: Training pools that were opened last time before or on the specified date.
last_started_gt: Training pools that were opened last time after the specified date.
last_started_gte: Training pools that were opened last time after or on the specified date.
"""
class CompareFields:
id: str
created: datetime.datetime
last_started: datetime.datetime
def __init__(
self,
status: typing.Optional[toloka.client.training.Training.Status] = None,
project_id: typing.Optional[str] = None,
id_lt: typing.Optional[str] = None,
id_lte: typing.Optional[str] = None,
id_gt: typing.Optional[str] = None,
id_gte: typing.Optional[str] = None,
created_lt: typing.Optional[datetime.datetime] = None,
created_lte: typing.Optional[datetime.datetime] = None,
created_gt: typing.Optional[datetime.datetime] = None,
created_gte: typing.Optional[datetime.datetime] = None,
last_started_lt: typing.Optional[datetime.datetime] = None,
last_started_lte: typing.Optional[datetime.datetime] = None,
last_started_gt: typing.Optional[datetime.datetime] = None,
last_started_gte: typing.Optional[datetime.datetime] = None
) -> None:
"""Method generated by attrs for class TrainingSearchRequest.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
status: typing.Optional[toloka.client.training.Training.Status]
project_id: typing.Optional[str]
id_lt: typing.Optional[str]
id_lte: typing.Optional[str]
id_gt: typing.Optional[str]
id_gte: typing.Optional[str]
created_lt: typing.Optional[datetime.datetime]
created_lte: typing.Optional[datetime.datetime]
created_gt: typing.Optional[datetime.datetime]
created_gte: typing.Optional[datetime.datetime]
last_started_lt: typing.Optional[datetime.datetime]
last_started_lte: typing.Optional[datetime.datetime]
last_started_gt: typing.Optional[datetime.datetime]
last_started_gte: typing.Optional[datetime.datetime]
class TrainingSortItems(BaseSortItems):
"""Keys for sorting training pools in search results.
Attributes:
items: A list of sorting keys. Supported values:
* `'id'` — Training pool ID.
* `'created'` — Training pool creation date.
* `'last_started'` — The last opening date of a training pool.
Example:
The example shows how to find opened training pools sorted by the last opening date in descending order. Pools with equal opening dates are sorted by IDs in ascending order.
>>> sort = toloka.client.search_requests.TrainingSortItems(['-last_started', 'id'])
>>> result = toloka_client.find_trainings(status='OPEN', sort=sort, limit=50)
...
"""
class SortItem(BaseSortItem):
class SortField(enum.Enum):
"""An enumeration.
"""
ID = 'id'
CREATED = 'created'
LAST_STARTED = 'last_started'
def __init__(
self,
field: typing.Optional[SortField] = None,
order: typing.Optional[SortOrder] = SortOrder.ASCENDING
) -> None:
"""Method generated by attrs for class TrainingSortItems.SortItem.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
field: typing.Optional[SortField]
order: typing.Optional[SortOrder]
def __init__(self, items=None) -> None:
"""Method generated by attrs for class TrainingSortItems.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
items: typing.Optional[typing.List[SortItem]]
class SkillSearchRequest(BaseSearchRequest):
"""Parameters for searching skill.
Attributes:
name: The name of the skill.
id_lt: Skills with IDs less than the specified value.
id_lte: Skills with IDs less than or equal to the specified value.
id_gt: Skills with IDs greater than the specified value.
id_gte: Skills with IDs greater than or equal to the specified value.
created_lt: Skills created before the specified date.
created_lte: Skills created before or on the specified date.
created_gt: Skills created after the specified date.
created_gte: Skills created on or after the specified date.
"""
class CompareFields:
id: str
created: datetime.datetime
def __init__(
self,
name: typing.Optional[str] = None,
id_lt: typing.Optional[str] = None,
id_lte: typing.Optional[str] = None,
id_gt: typing.Optional[str] = None,
id_gte: typing.Optional[str] = None,
created_lt: typing.Optional[datetime.datetime] = None,
created_lte: typing.Optional[datetime.datetime] = None,
created_gt: typing.Optional[datetime.datetime] = None,
created_gte: typing.Optional[datetime.datetime] = None
) -> None:
"""Method generated by attrs for class SkillSearchRequest.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
name: typing.Optional[str]
id_lt: typing.Optional[str]
id_lte: typing.Optional[str]
id_gt: typing.Optional[str]
id_gte: typing.Optional[str]
created_lt: typing.Optional[datetime.datetime]
created_lte: typing.Optional[datetime.datetime]
created_gt: typing.Optional[datetime.datetime]
created_gte: typing.Optional[datetime.datetime]
class SkillSortItems(BaseSortItems):
"""Keys for sorting skills in search results.
Attributes:
items: A list of sorting keys. Supported values:
* `'id'` — The ID of a skill.
* `'created'` — A skill creation date.
Example:
The example shows how to find skills sorted by creation date in descending order. Skills with equal creation dates are sorted by IDs in ascending order.
>>> sort = toloka.client.search_requests.SkillSortItems(['-created', 'id'])
>>> result = toloka_client.find_skills(name='Image annotation', sort=sort, limit=10)
...
"""
class SortItem(BaseSortItem):
class SortField(enum.Enum):
"""An enumeration.
"""
ID = 'id'
CREATED = 'created'
def __init__(
self,
field: typing.Optional[SortField] = None,
order: typing.Optional[SortOrder] = SortOrder.ASCENDING
) -> None:
"""Method generated by attrs for class SkillSortItems.SortItem.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
field: typing.Optional[SortField]
order: typing.Optional[SortOrder]
def __init__(self, items=None) -> None:
"""Method generated by attrs for class SkillSortItems.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
items: typing.Optional[typing.List[SortItem]]
class AssignmentSearchRequest(BaseSearchRequest):
"""Parameters for searching task suites assignments.
Attributes:
status: Assignment status or a list of statuses.
Refer to the [Assignment.Status](toloka.client.assignment.Assignment.Status.md) page
for more information on the available `status` values.
task_id: Assignments containing the task with the specified ID.
task_suite_id: Assignments for a task suite with the specified ID.
pool_id: Assignments in a pool with the specified ID.
user_id: Assignments from a Toloker with the specified ID.
id_lt: Assignments with IDs less than the specified value.
id_lte: Assignments with IDs less than or equal to the specified value.
id_gt: Assignments with IDs greater than the specified value.
id_gte: Assignments with IDs greater than or equal to the specified value.
created_lt: Task suites assigned before the specified date.
created_lte: Task suites assigned before or on the specified date.
created_gt: Task suites assigned after the specified date.
created_gte: Task suites assigned after or on the specified date.
submitted_lt: Assignments completed before the specified date.
submitted_lte: Assignments completed before or on the specified date.
submitted_gt: Assignments completed after the specified date.
submitted_gte: Assignments completed after or on the specified date.
accepted_lt: Assignments accepted before the specified date.
accepted_lte: Assignments accepted before or on the specified date.
accepted_gt: Assignments accepted after the specified date.
accepted_gte: Assignments accepted after or on the specified date.
rejected_lt: Assignments rejected before the specified date.
rejected_lte: Assignments rejected before or on the specified date.
rejected_gt: Assignments rejected after the specified date.
rejected_gte: Assignments rejected after or on the specified date.
skipped_lt: Assigned task suites skipped before the specified date.
skipped_lte: Assigned task suites skipped before or on the specified date.
skipped_gt: Assigned task suites skipped after the specified date.
skipped_gte: Assigned task suites skipped after or on the specified date.
expired_lt: Assigned task suites expired before the specified date.
expired_lte: Assigned task suites expired before or on the specified date.
expired_gt: Assigned task suites expired after the specified date.
expired_gte: Assigned task suites expired after or on the specified date.
"""
class CompareFields:
id: str
created: datetime.datetime
submitted: datetime.datetime
accepted: datetime.datetime
rejected: datetime.datetime
skipped: datetime.datetime
expired: datetime.datetime
def unstructure(self) -> typing.Optional[dict]: ...
def __init__(
self,
status: typing.Union[str, toloka.client.assignment.Assignment.Status, typing.List[typing.Union[str, toloka.client.assignment.Assignment.Status]]] = None,
task_id: typing.Optional[str] = None,
task_suite_id: typing.Optional[str] = None,
pool_id: typing.Optional[str] = None,
user_id: typing.Optional[str] = None,
id_lt: typing.Optional[str] = None,
id_lte: typing.Optional[str] = None,
id_gt: typing.Optional[str] = None,
id_gte: typing.Optional[str] = None,
created_lt: typing.Optional[datetime.datetime] = None,
created_lte: typing.Optional[datetime.datetime] = None,
created_gt: typing.Optional[datetime.datetime] = None,
created_gte: typing.Optional[datetime.datetime] = None,
submitted_lt: typing.Optional[datetime.datetime] = None,
submitted_lte: typing.Optional[datetime.datetime] = None,
submitted_gt: typing.Optional[datetime.datetime] = None,
submitted_gte: typing.Optional[datetime.datetime] = None,
accepted_lt: typing.Optional[datetime.datetime] = None,
accepted_lte: typing.Optional[datetime.datetime] = None,
accepted_gt: typing.Optional[datetime.datetime] = None,
accepted_gte: typing.Optional[datetime.datetime] = None,
rejected_lt: typing.Optional[datetime.datetime] = None,
rejected_lte: typing.Optional[datetime.datetime] = None,
rejected_gt: typing.Optional[datetime.datetime] = None,
rejected_gte: typing.Optional[datetime.datetime] = None,
skipped_lt: typing.Optional[datetime.datetime] = None,
skipped_lte: typing.Optional[datetime.datetime] = None,
skipped_gt: typing.Optional[datetime.datetime] = None,
skipped_gte: typing.Optional[datetime.datetime] = None,
expired_lt: typing.Optional[datetime.datetime] = None,
expired_lte: typing.Optional[datetime.datetime] = None,
expired_gt: typing.Optional[datetime.datetime] = None,
expired_gte: typing.Optional[datetime.datetime] = None
) -> None:
"""Method generated by attrs for class AssignmentSearchRequest.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
status: typing.Optional[typing.List[toloka.client.assignment.Assignment.Status]]
task_id: typing.Optional[str]
task_suite_id: typing.Optional[str]
pool_id: typing.Optional[str]
user_id: typing.Optional[str]
id_lt: typing.Optional[str]
id_lte: typing.Optional[str]
id_gt: typing.Optional[str]
id_gte: typing.Optional[str]
created_lt: typing.Optional[datetime.datetime]
created_lte: typing.Optional[datetime.datetime]
created_gt: typing.Optional[datetime.datetime]
created_gte: typing.Optional[datetime.datetime]
submitted_lt: typing.Optional[datetime.datetime]
submitted_lte: typing.Optional[datetime.datetime]
submitted_gt: typing.Optional[datetime.datetime]
submitted_gte: typing.Optional[datetime.datetime]
accepted_lt: typing.Optional[datetime.datetime]
accepted_lte: typing.Optional[datetime.datetime]
accepted_gt: typing.Optional[datetime.datetime]
accepted_gte: typing.Optional[datetime.datetime]
rejected_lt: typing.Optional[datetime.datetime]
rejected_lte: typing.Optional[datetime.datetime]
rejected_gt: typing.Optional[datetime.datetime]
rejected_gte: typing.Optional[datetime.datetime]
skipped_lt: typing.Optional[datetime.datetime]
skipped_lte: typing.Optional[datetime.datetime]
skipped_gt: typing.Optional[datetime.datetime]
skipped_gte: typing.Optional[datetime.datetime]
expired_lt: typing.Optional[datetime.datetime]
expired_lte: typing.Optional[datetime.datetime]
expired_gt: typing.Optional[datetime.datetime]
expired_gte: typing.Optional[datetime.datetime]
class AssignmentSortItems(BaseSortItems):
"""Keys for sorting assignments in search results.
Attributes:
items: A list of sorting keys. Supported values:
* `'id'` — An assignment ID.
* `'created'` — The assigning date of a task suite.
* `'submitted'` — The completion date of a task suite.
* `'accepted'` — The acceptance date of a task suite.
* `'rejected'` — The rejection date a task suite.
* `'skipped'` — The date when a task suite was skipped.
* `'expired'` — The expiration date of a task suite.
Example:
The example shows how to find assignments sorted by the completion date in descending order. Assignments with equal completion dates are sorted by IDs in ascending order.
>>> sort = toloka.client.search_requests.AssignmentSortItems(['-submitted', 'id'])
>>> result = toloka_client.find_assignments(status='SUBMITTED', sort=sort, limit=10)
...
"""
class SortItem(BaseSortItem):
class SortField(enum.Enum):
"""An enumeration.
"""
ID = 'id'
CREATED = 'created'
SUBMITTED = 'submitted'
ACCEPTED = 'accepted'
REJECTED = 'rejected'
SKIPPED = 'skipped'
EXPIRED = 'expired'
def __init__(
self,
field: typing.Optional[SortField] = None,
order: typing.Optional[SortOrder] = SortOrder.ASCENDING
) -> None:
"""Method generated by attrs for class AssignmentSortItems.SortItem.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
field: typing.Optional[SortField]
order: typing.Optional[SortOrder]
def __init__(self, items=None) -> None:
"""Method generated by attrs for class AssignmentSortItems.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
items: typing.Optional[typing.List[SortItem]]
class AggregatedSolutionSearchRequest(BaseSearchRequest):
"""Parameters for searching aggregated responses.
Attributes:
task_id_lt: Responses for tasks with IDs less than the specified value.
task_id_lte: Responses for tasks with IDs less than or equal to the specified value.
task_id_gt: Responses for tasks with IDs greater than the specified value.
task_id_gte: Responses for tasks with IDs greater than or equal to the specified value.
"""
class CompareFields:
task_id: str
def __init__(
self,
task_id_lt: typing.Optional[str] = None,
task_id_lte: typing.Optional[str] = None,
task_id_gt: typing.Optional[str] = None,
task_id_gte: typing.Optional[str] = None
) -> None:
"""Method generated by attrs for class AggregatedSolutionSearchRequest.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
task_id_lt: typing.Optional[str]
task_id_lte: typing.Optional[str]
task_id_gt: typing.Optional[str]
task_id_gte: typing.Optional[str]
class AggregatedSolutionSortItems(BaseSortItems):
"""Keys for sorting aggregated responses in search results.
Attributes:
items: A list of sorting keys. Supported values:
* `'task_id'` — The ID of a task.
"""
class SortItem(BaseSortItem):
class SortField(enum.Enum):
"""An enumeration.
"""
TASK_ID = 'task_id'
def __init__(
self,
field: typing.Optional[SortField] = None,
order: typing.Optional[SortOrder] = SortOrder.ASCENDING
) -> None:
"""Method generated by attrs for class AggregatedSolutionSortItems.SortItem.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
field: typing.Optional[SortField]
order: typing.Optional[SortOrder]
def __init__(self, items=None) -> None:
"""Method generated by attrs for class AggregatedSolutionSortItems.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
items: typing.Optional[typing.List[SortItem]]
class TaskSearchRequest(BaseSearchRequest):
"""Parameters for searching tasks.
Attributes:
pool_id: The ID of the pool to get tasks from.
overlap: Tasks with an overlap equal to the specified value.
id_lt: Tasks with IDs less than the specified value.
id_lte: Tasks with IDs less than or equal to the specified value.
id_gt: Tasks with IDs greater than the specified value.
id_gte: Tasks with IDs greater than or equal to the specified value.
created_lt: Tasks created before the specified date.
created_lte: Tasks created before or on the specified date.
created_gt: Tasks created after the specified date.
created_gte: Tasks created after or on the specified date.
overlap_lt: Tasks with an overlap less than the specified value.
overlap_lte: Tasks with an overlap less than or equal to the specified value.
overlap_gt: Tasks with an overlap greater than the specified value.
overlap_gte: Tasks with an overlap greater than or equal to the specified value.
"""
class CompareFields:
id: str
created: datetime.datetime
overlap: int
def __init__(
self,
pool_id: typing.Optional[str] = None,
overlap: typing.Optional[int] = None,
id_lt: typing.Optional[str] = None,
id_lte: typing.Optional[str] = None,
id_gt: typing.Optional[str] = None,
id_gte: typing.Optional[str] = None,
created_lt: typing.Optional[datetime.datetime] = None,
created_lte: typing.Optional[datetime.datetime] = None,
created_gt: typing.Optional[datetime.datetime] = None,
created_gte: typing.Optional[datetime.datetime] = None,
overlap_lt: typing.Optional[int] = None,
overlap_lte: typing.Optional[int] = None,
overlap_gt: typing.Optional[int] = None,
overlap_gte: typing.Optional[int] = None
) -> None:
"""Method generated by attrs for class TaskSearchRequest.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
pool_id: typing.Optional[str]
overlap: typing.Optional[int]
id_lt: typing.Optional[str]
id_lte: typing.Optional[str]
id_gt: typing.Optional[str]
id_gte: typing.Optional[str]
created_lt: typing.Optional[datetime.datetime]
created_lte: typing.Optional[datetime.datetime]
created_gt: typing.Optional[datetime.datetime]
created_gte: typing.Optional[datetime.datetime]
overlap_lt: typing.Optional[int]
overlap_lte: typing.Optional[int]
overlap_gt: typing.Optional[int]
overlap_gte: typing.Optional[int]
class TaskSortItems(BaseSortItems):
"""Keys for sorting tasks in search results.
Attributes:
items: A list of sorting keys. Supported values:
* `'id'` — The ID of a task.
* `'created'` — The creation date of a task.
Example:
The example shows how to find tasks sorted by creation dates in descending order. Tasks with equal creation dates are sorted by IDs in ascending order.
>>> sort = toloka.client.search_requests.TaskSortItems(['-created', 'id'])
>>> result = toloka_client.find_tasks(pool_id=my_pool_id, sort=sort, limit=10)
...
"""
class SortItem(BaseSortItem):
class SortField(enum.Enum):
"""An enumeration.
"""
ID = 'id'
CREATED = 'created'
def __init__(
self,
field: typing.Optional[SortField] = None,
order: typing.Optional[SortOrder] = SortOrder.ASCENDING
) -> None:
"""Method generated by attrs for class TaskSortItems.SortItem.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
field: typing.Optional[SortField]
order: typing.Optional[SortOrder]
def __init__(self, items=None) -> None:
"""Method generated by attrs for class TaskSortItems.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
items: typing.Optional[typing.List[SortItem]]
class TaskSuiteSearchRequest(BaseSearchRequest):
"""Parameters for searching task suites.
Attributes:
task_id: Task suite containing a task with the specified ID.
pool_id: Task suites from a pool with the specified ID.
overlap: Task suites with an overlap equal to the specified value.
id_lt: Task suites with IDs less than the specified value.
id_lte: Task suites with IDs less than or equal to the specified value.
id_gt: Task suites with IDs greater than the specified value.
id_gte: Task suites with IDs greater than or equal to the specified value.
created_lt: Task suites created before the specified date.
created_lte: Task suites created before or on the specified date.
created_gt: Task suites created after the specified date.
created_gte: Task suites created after or on the specified date.
overlap_lt: Task suites with an overlap less than the specified value.
overlap_lte: Task suites with an overlap less than or equal to the specified value.
overlap_gt: Task suites with an overlap greater than the specified value.
overlap_gte: Task suites with an overlap greater than or equal to the specified value.
"""
class CompareFields:
id: str
created: datetime.datetime
overlap: int
def __init__(
self,
task_id: typing.Optional[str] = None,
pool_id: typing.Optional[str] = None,
overlap: typing.Optional[int] = None,
id_lt: typing.Optional[str] = None,
id_lte: typing.Optional[str] = None,
id_gt: typing.Optional[str] = None,
id_gte: typing.Optional[str] = None,
created_lt: typing.Optional[datetime.datetime] = None,
created_lte: typing.Optional[datetime.datetime] = None,
created_gt: typing.Optional[datetime.datetime] = None,
created_gte: typing.Optional[datetime.datetime] = None,
overlap_lt: typing.Optional[int] = None,
overlap_lte: typing.Optional[int] = None,
overlap_gt: typing.Optional[int] = None,
overlap_gte: typing.Optional[int] = None
) -> None:
"""Method generated by attrs for class TaskSuiteSearchRequest.
"""
...
_unexpected: typing.Optional[typing.Dict[str, typing.Any]]
task_id: typing.Optional[str]
pool_id: typing.Optional[str]
overlap: typing.Optional[int]
id_lt: typing.Optional[str]
id_lte: typing.Optional[str]
id_gt: typing.Optional[str]
id_gte: typing.Optional[str]
created_lt: typing.Optional[datetime.datetime]
created_lte: typing.Optional[datetime.datetime]
created_gt: typing.Optional[datetime.datetime]
created_gte: typing.Optional[datetime.datetime]
overlap_lt: typing.Optional[int]
overlap_lte: typing.Optional[int]
overlap_gt: typing.Optional[int]
overlap_gte: typing.Optional[int]
class TaskSuiteSortItems(BaseSortItems):
"""Keys for sorting task suites in search results.
Attributes:
items: A list of sorting keys. Supported values:
* `'id'` — The ID of a task suite.
* `'created'` — The creation date of a task suite.
Example:
The example shows how to find task suites sorted by the creation date in descending order. Task suites with equal creation dates are sorted by IDs in ascending order.
>>> sort = toloka.client.search_requests.TaskSuiteSortItems(['-created', 'id'])
>>> result = toloka_client.find_task_suites(pool_id=my_pool_id, sort=sort, limit=10)
...