-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathquality-api.ts
1279 lines (1115 loc) · 61 KB
/
quality-api.ts
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
/* tslint:disable */
/* eslint-disable */
/**
* CVAT REST API
* REST API for Computer Vision Annotation Tool (CVAT)
*
* The version of the OpenAPI document: 2.31.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// URLSearchParams not necessarily used
// @ts-ignore
import { URL, URLSearchParams } from 'url';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
// @ts-ignore
import type { PaginatedAnnotationConflictList } from '../models';
// @ts-ignore
import type { PaginatedQualityReportList } from '../models';
// @ts-ignore
import type { PaginatedQualitySettingsList } from '../models';
// @ts-ignore
import type { PatchedQualitySettingsRequest } from '../models';
// @ts-ignore
import type { QualityReport } from '../models';
// @ts-ignore
import type { QualityReportCreateRequest } from '../models';
// @ts-ignore
import type { QualitySettings } from '../models';
// @ts-ignore
import type { RqId } from '../models';
/**
* QualityApi - axios parameter creator
* @export
*/
export const QualityApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Create a quality report
* @param {string} [rqId] The report creation request id. Can be specified to check the report creation status.
* @param {QualityReportCreateRequest} [qualityReportCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityCreateReport: async (rqId?: string, qualityReportCreateRequest?: QualityReportCreateRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/api/quality/reports`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
if (rqId !== undefined) {
localVarQueryParameter['rq_id'] = rqId;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(qualityReportCreateRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary List annotation conflicts in a quality report
* @param {string} [xOrganization] Organization unique slug
* @param {string} [filter] JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'id\', \'frame\', \'type\', \'job_id\', \'task_id\', \'severity\'].
* @param {number} [frame] A simple equality filter for the frame field
* @param {number} [jobId] A simple equality filter for the job_id field
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {number} [page] A page number within the paginated result set.
* @param {number} [pageSize] Number of results to return per page.
* @param {number} [reportId] A simple equality filter for report id
* @param {QualityListConflictsSeverityEnum} [severity] A simple equality filter for the severity field
* @param {string} [sort] Which field to use when ordering the results. Available ordering_fields: [\'id\', \'frame\', \'type\', \'job_id\', \'task_id\', \'severity\']
* @param {number} [taskId] A simple equality filter for the task_id field
* @param {QualityListConflictsTypeEnum} [type] A simple equality filter for the type field
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityListConflicts: async (xOrganization?: string, filter?: string, frame?: number, jobId?: number, org?: string, orgId?: number, page?: number, pageSize?: number, reportId?: number, severity?: QualityListConflictsSeverityEnum, sort?: string, taskId?: number, type?: QualityListConflictsTypeEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/api/quality/conflicts`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
if (filter !== undefined) {
localVarQueryParameter['filter'] = filter;
}
if (frame !== undefined) {
localVarQueryParameter['frame'] = frame;
}
if (jobId !== undefined) {
localVarQueryParameter['job_id'] = jobId;
}
if (org !== undefined) {
localVarQueryParameter['org'] = org;
}
if (orgId !== undefined) {
localVarQueryParameter['org_id'] = orgId;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (pageSize !== undefined) {
localVarQueryParameter['page_size'] = pageSize;
}
if (reportId !== undefined) {
localVarQueryParameter['report_id'] = reportId;
}
if (severity !== undefined) {
localVarQueryParameter['severity'] = severity;
}
if (sort !== undefined) {
localVarQueryParameter['sort'] = sort;
}
if (taskId !== undefined) {
localVarQueryParameter['task_id'] = taskId;
}
if (type !== undefined) {
localVarQueryParameter['type'] = type;
}
if (xOrganization != null) {
localVarHeaderParameter['X-Organization'] = String(xOrganization);
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary List quality reports
* @param {string} [xOrganization] Organization unique slug
* @param {string} [filter] JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'id\', \'job_id\', \'created_date\', \'gt_last_updated\', \'target_last_updated\', \'parent_id\'].
* @param {number} [jobId] A simple equality filter for the job_id field
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {number} [page] A page number within the paginated result set.
* @param {number} [pageSize] Number of results to return per page.
* @param {number} [parentId] A simple equality filter for the parent_id field
* @param {string} [sort] Which field to use when ordering the results. Available ordering_fields: [\'id\', \'job_id\', \'created_date\', \'gt_last_updated\', \'target_last_updated\', \'parent_id\']
* @param {string} [target] A simple equality filter for target
* @param {number} [taskId] A simple equality filter for task id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityListReports: async (xOrganization?: string, filter?: string, jobId?: number, org?: string, orgId?: number, page?: number, pageSize?: number, parentId?: number, sort?: string, target?: string, taskId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/api/quality/reports`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
if (filter !== undefined) {
localVarQueryParameter['filter'] = filter;
}
if (jobId !== undefined) {
localVarQueryParameter['job_id'] = jobId;
}
if (org !== undefined) {
localVarQueryParameter['org'] = org;
}
if (orgId !== undefined) {
localVarQueryParameter['org_id'] = orgId;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (pageSize !== undefined) {
localVarQueryParameter['page_size'] = pageSize;
}
if (parentId !== undefined) {
localVarQueryParameter['parent_id'] = parentId;
}
if (sort !== undefined) {
localVarQueryParameter['sort'] = sort;
}
if (target !== undefined) {
localVarQueryParameter['target'] = target;
}
if (taskId !== undefined) {
localVarQueryParameter['task_id'] = taskId;
}
if (xOrganization != null) {
localVarHeaderParameter['X-Organization'] = String(xOrganization);
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary List quality settings instances
* @param {string} [xOrganization] Organization unique slug
* @param {string} [filter] JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'id\', \'task_id\'].
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {number} [page] A page number within the paginated result set.
* @param {number} [pageSize] Number of results to return per page.
* @param {string} [sort] Which field to use when ordering the results. Available ordering_fields: [\'id\']
* @param {number} [taskId] A simple equality filter for the task_id field
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityListSettings: async (xOrganization?: string, filter?: string, org?: string, orgId?: number, page?: number, pageSize?: number, sort?: string, taskId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/api/quality/settings`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
if (filter !== undefined) {
localVarQueryParameter['filter'] = filter;
}
if (org !== undefined) {
localVarQueryParameter['org'] = org;
}
if (orgId !== undefined) {
localVarQueryParameter['org_id'] = orgId;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (pageSize !== undefined) {
localVarQueryParameter['page_size'] = pageSize;
}
if (sort !== undefined) {
localVarQueryParameter['sort'] = sort;
}
if (taskId !== undefined) {
localVarQueryParameter['task_id'] = taskId;
}
if (xOrganization != null) {
localVarHeaderParameter['X-Organization'] = String(xOrganization);
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Update a quality settings instance
* @param {number} id An id of a quality settings instance
* @param {PatchedQualitySettingsRequest} [patchedQualitySettingsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityPartialUpdateSettings: async (id: number, patchedQualitySettingsRequest?: PatchedQualitySettingsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('qualityPartialUpdateSettings', 'id', id)
const localVarPath = `/api/quality/settings/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(patchedQualitySettingsRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Get quality report details
* @param {number} id A unique integer value identifying this quality report.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityRetrieveReport: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('qualityRetrieveReport', 'id', id)
const localVarPath = `/api/quality/reports/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Get quality report contents
* @param {number} id A unique integer value identifying this quality report.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityRetrieveReportData: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('qualityRetrieveReportData', 'id', id)
const localVarPath = `/api/quality/reports/{id}/data`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Get quality settings instance details
* @param {number} id An id of a quality settings instance
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityRetrieveSettings: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('qualityRetrieveSettings', 'id', id)
const localVarPath = `/api/quality/settings/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication signatureAuth required
await setApiKeyToObject(localVarQueryParameter, "sign", configuration)
// authentication basicAuth required
// http basic authentication required
setBasicAuthToObject(localVarRequestOptions, configuration)
// authentication tokenAuth required
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
// authentication csrfAuth required
// authentication sessionAuth required
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* QualityApi - functional programming interface
* @export
*/
export const QualityApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = QualityApiAxiosParamCreator(configuration)
return {
/**
*
* @summary Create a quality report
* @param {string} [rqId] The report creation request id. Can be specified to check the report creation status.
* @param {QualityReportCreateRequest} [qualityReportCreateRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async qualityCreateReport(rqId?: string, qualityReportCreateRequest?: QualityReportCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QualityReport>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.qualityCreateReport(rqId, qualityReportCreateRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['QualityApi.qualityCreateReport']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary List annotation conflicts in a quality report
* @param {string} [xOrganization] Organization unique slug
* @param {string} [filter] JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'id\', \'frame\', \'type\', \'job_id\', \'task_id\', \'severity\'].
* @param {number} [frame] A simple equality filter for the frame field
* @param {number} [jobId] A simple equality filter for the job_id field
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {number} [page] A page number within the paginated result set.
* @param {number} [pageSize] Number of results to return per page.
* @param {number} [reportId] A simple equality filter for report id
* @param {QualityListConflictsSeverityEnum} [severity] A simple equality filter for the severity field
* @param {string} [sort] Which field to use when ordering the results. Available ordering_fields: [\'id\', \'frame\', \'type\', \'job_id\', \'task_id\', \'severity\']
* @param {number} [taskId] A simple equality filter for the task_id field
* @param {QualityListConflictsTypeEnum} [type] A simple equality filter for the type field
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async qualityListConflicts(xOrganization?: string, filter?: string, frame?: number, jobId?: number, org?: string, orgId?: number, page?: number, pageSize?: number, reportId?: number, severity?: QualityListConflictsSeverityEnum, sort?: string, taskId?: number, type?: QualityListConflictsTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedAnnotationConflictList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.qualityListConflicts(xOrganization, filter, frame, jobId, org, orgId, page, pageSize, reportId, severity, sort, taskId, type, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['QualityApi.qualityListConflicts']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary List quality reports
* @param {string} [xOrganization] Organization unique slug
* @param {string} [filter] JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'id\', \'job_id\', \'created_date\', \'gt_last_updated\', \'target_last_updated\', \'parent_id\'].
* @param {number} [jobId] A simple equality filter for the job_id field
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {number} [page] A page number within the paginated result set.
* @param {number} [pageSize] Number of results to return per page.
* @param {number} [parentId] A simple equality filter for the parent_id field
* @param {string} [sort] Which field to use when ordering the results. Available ordering_fields: [\'id\', \'job_id\', \'created_date\', \'gt_last_updated\', \'target_last_updated\', \'parent_id\']
* @param {string} [target] A simple equality filter for target
* @param {number} [taskId] A simple equality filter for task id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async qualityListReports(xOrganization?: string, filter?: string, jobId?: number, org?: string, orgId?: number, page?: number, pageSize?: number, parentId?: number, sort?: string, target?: string, taskId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedQualityReportList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.qualityListReports(xOrganization, filter, jobId, org, orgId, page, pageSize, parentId, sort, target, taskId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['QualityApi.qualityListReports']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary List quality settings instances
* @param {string} [xOrganization] Organization unique slug
* @param {string} [filter] JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'id\', \'task_id\'].
* @param {string} [org] Organization unique slug
* @param {number} [orgId] Organization identifier
* @param {number} [page] A page number within the paginated result set.
* @param {number} [pageSize] Number of results to return per page.
* @param {string} [sort] Which field to use when ordering the results. Available ordering_fields: [\'id\']
* @param {number} [taskId] A simple equality filter for the task_id field
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async qualityListSettings(xOrganization?: string, filter?: string, org?: string, orgId?: number, page?: number, pageSize?: number, sort?: string, taskId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedQualitySettingsList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.qualityListSettings(xOrganization, filter, org, orgId, page, pageSize, sort, taskId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['QualityApi.qualityListSettings']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Update a quality settings instance
* @param {number} id An id of a quality settings instance
* @param {PatchedQualitySettingsRequest} [patchedQualitySettingsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async qualityPartialUpdateSettings(id: number, patchedQualitySettingsRequest?: PatchedQualitySettingsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QualitySettings>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.qualityPartialUpdateSettings(id, patchedQualitySettingsRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['QualityApi.qualityPartialUpdateSettings']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Get quality report details
* @param {number} id A unique integer value identifying this quality report.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async qualityRetrieveReport(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QualityReport>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.qualityRetrieveReport(id, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['QualityApi.qualityRetrieveReport']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Get quality report contents
* @param {number} id A unique integer value identifying this quality report.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async qualityRetrieveReportData(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.qualityRetrieveReportData(id, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['QualityApi.qualityRetrieveReportData']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Get quality settings instance details
* @param {number} id An id of a quality settings instance
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async qualityRetrieveSettings(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QualitySettings>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.qualityRetrieveSettings(id, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['QualityApi.qualityRetrieveSettings']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* QualityApi - factory interface
* @export
*/
export const QualityApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = QualityApiFp(configuration)
return {
/**
*
* @summary Create a quality report
* @param {QualityApiQualityCreateReportRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityCreateReport(requestParameters: QualityApiQualityCreateReportRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<QualityReport> {
return localVarFp.qualityCreateReport(requestParameters.rqId, requestParameters.qualityReportCreateRequest, options).then((request) => request(axios, basePath));
},
/**
*
* @summary List annotation conflicts in a quality report
* @param {QualityApiQualityListConflictsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityListConflicts(requestParameters: QualityApiQualityListConflictsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedAnnotationConflictList> {
return localVarFp.qualityListConflicts(requestParameters.xOrganization, requestParameters.filter, requestParameters.frame, requestParameters.jobId, requestParameters.org, requestParameters.orgId, requestParameters.page, requestParameters.pageSize, requestParameters.reportId, requestParameters.severity, requestParameters.sort, requestParameters.taskId, requestParameters.type, options).then((request) => request(axios, basePath));
},
/**
*
* @summary List quality reports
* @param {QualityApiQualityListReportsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityListReports(requestParameters: QualityApiQualityListReportsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedQualityReportList> {
return localVarFp.qualityListReports(requestParameters.xOrganization, requestParameters.filter, requestParameters.jobId, requestParameters.org, requestParameters.orgId, requestParameters.page, requestParameters.pageSize, requestParameters.parentId, requestParameters.sort, requestParameters.target, requestParameters.taskId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary List quality settings instances
* @param {QualityApiQualityListSettingsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityListSettings(requestParameters: QualityApiQualityListSettingsRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedQualitySettingsList> {
return localVarFp.qualityListSettings(requestParameters.xOrganization, requestParameters.filter, requestParameters.org, requestParameters.orgId, requestParameters.page, requestParameters.pageSize, requestParameters.sort, requestParameters.taskId, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Update a quality settings instance
* @param {QualityApiQualityPartialUpdateSettingsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityPartialUpdateSettings(requestParameters: QualityApiQualityPartialUpdateSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<QualitySettings> {
return localVarFp.qualityPartialUpdateSettings(requestParameters.id, requestParameters.patchedQualitySettingsRequest, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get quality report details
* @param {QualityApiQualityRetrieveReportRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityRetrieveReport(requestParameters: QualityApiQualityRetrieveReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<QualityReport> {
return localVarFp.qualityRetrieveReport(requestParameters.id, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get quality report contents
* @param {QualityApiQualityRetrieveReportDataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityRetrieveReportData(requestParameters: QualityApiQualityRetrieveReportDataRequest, options?: RawAxiosRequestConfig): AxiosPromise<object> {
return localVarFp.qualityRetrieveReportData(requestParameters.id, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Get quality settings instance details
* @param {QualityApiQualityRetrieveSettingsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
qualityRetrieveSettings(requestParameters: QualityApiQualityRetrieveSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<QualitySettings> {
return localVarFp.qualityRetrieveSettings(requestParameters.id, options).then((request) => request(axios, basePath));
},
};
};
/**
* Request parameters for qualityCreateReport operation in QualityApi.
* @export
* @interface QualityApiQualityCreateReportRequest
*/
export interface QualityApiQualityCreateReportRequest {
/**
* The report creation request id. Can be specified to check the report creation status.
* @type {string}
* @memberof QualityApiQualityCreateReport
*/
readonly rqId?: string
/**
*
* @type {QualityReportCreateRequest}
* @memberof QualityApiQualityCreateReport
*/
readonly qualityReportCreateRequest?: QualityReportCreateRequest
}
/**
* Request parameters for qualityListConflicts operation in QualityApi.
* @export
* @interface QualityApiQualityListConflictsRequest
*/
export interface QualityApiQualityListConflictsRequest {
/**
* Organization unique slug
* @type {string}
* @memberof QualityApiQualityListConflicts
*/
readonly xOrganization?: string
/**
* JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'id\', \'frame\', \'type\', \'job_id\', \'task_id\', \'severity\'].
* @type {string}
* @memberof QualityApiQualityListConflicts
*/
readonly filter?: string
/**
* A simple equality filter for the frame field
* @type {number}
* @memberof QualityApiQualityListConflicts
*/
readonly frame?: number
/**
* A simple equality filter for the job_id field
* @type {number}
* @memberof QualityApiQualityListConflicts
*/
readonly jobId?: number
/**
* Organization unique slug
* @type {string}
* @memberof QualityApiQualityListConflicts
*/
readonly org?: string
/**
* Organization identifier
* @type {number}
* @memberof QualityApiQualityListConflicts
*/
readonly orgId?: number
/**
* A page number within the paginated result set.
* @type {number}
* @memberof QualityApiQualityListConflicts
*/
readonly page?: number
/**
* Number of results to return per page.
* @type {number}
* @memberof QualityApiQualityListConflicts
*/
readonly pageSize?: number
/**
* A simple equality filter for report id
* @type {number}
* @memberof QualityApiQualityListConflicts
*/
readonly reportId?: number
/**
* A simple equality filter for the severity field
* @type {'warning' | 'error'}
* @memberof QualityApiQualityListConflicts
*/
readonly severity?: QualityListConflictsSeverityEnum
/**
* Which field to use when ordering the results. Available ordering_fields: [\'id\', \'frame\', \'type\', \'job_id\', \'task_id\', \'severity\']
* @type {string}
* @memberof QualityApiQualityListConflicts
*/
readonly sort?: string
/**
* A simple equality filter for the task_id field
* @type {number}
* @memberof QualityApiQualityListConflicts
*/
readonly taskId?: number
/**
* A simple equality filter for the type field
* @type {'missing_annotation' | 'extra_annotation' | 'mismatching_label' | 'low_overlap' | 'mismatching_direction' | 'mismatching_attributes' | 'mismatching_groups' | 'covered_annotation'}
* @memberof QualityApiQualityListConflicts
*/
readonly type?: QualityListConflictsTypeEnum
}
/**
* Request parameters for qualityListReports operation in QualityApi.
* @export
* @interface QualityApiQualityListReportsRequest
*/
export interface QualityApiQualityListReportsRequest {
/**
* Organization unique slug
* @type {string}
* @memberof QualityApiQualityListReports
*/
readonly xOrganization?: string
/**
* JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [\'id\', \'job_id\', \'created_date\', \'gt_last_updated\', \'target_last_updated\', \'parent_id\'].
* @type {string}
* @memberof QualityApiQualityListReports
*/
readonly filter?: string
/**
* A simple equality filter for the job_id field
* @type {number}
* @memberof QualityApiQualityListReports
*/
readonly jobId?: number
/**
* Organization unique slug
* @type {string}
* @memberof QualityApiQualityListReports
*/
readonly org?: string
/**
* Organization identifier
* @type {number}
* @memberof QualityApiQualityListReports
*/
readonly orgId?: number
/**
* A page number within the paginated result set.
* @type {number}
* @memberof QualityApiQualityListReports
*/
readonly page?: number
/**
* Number of results to return per page.
* @type {number}
* @memberof QualityApiQualityListReports
*/
readonly pageSize?: number
/**
* A simple equality filter for the parent_id field