rapidata 2.15.0__py3-none-any.whl → 2.16.0__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 rapidata might be problematic. Click here for more details.
- rapidata/api_client/__init__.py +17 -7
- rapidata/api_client/api/__init__.py +2 -1
- rapidata/api_client/api/campaign_api.py +554 -30
- rapidata/api_client/api/client_api.py +292 -20
- rapidata/api_client/api/coco_api.py +594 -8
- rapidata/api_client/api/compare_workflow_api.py +23 -23
- rapidata/api_client/api/datapoint_api.py +548 -26
- rapidata/api_client/api/dataset_api.py +2198 -186
- rapidata/api_client/api/feedback_api.py +306 -0
- rapidata/api_client/api/identity_api.py +1143 -78
- rapidata/api_client/api/newsletter_api.py +299 -11
- rapidata/api_client/api/order_api.py +5358 -556
- rapidata/api_client/api/pipeline_api.py +263 -524
- rapidata/api_client/api/rapid_api.py +1930 -254
- rapidata/api_client/api/simple_workflow_api.py +23 -23
- rapidata/api_client/api/validation_set_api.py +5259 -0
- rapidata/api_client/api/workflow_api.py +929 -134
- rapidata/api_client/models/__init__.py +15 -6
- rapidata/api_client/models/ab_test_selection_a_inner.py +24 -10
- rapidata/api_client/models/add_user_response_result.py +106 -0
- rapidata/api_client/models/add_user_response_result_validation_truth.py +258 -0
- rapidata/api_client/models/add_validation_rapid_model.py +3 -3
- rapidata/api_client/models/add_validation_text_rapid_model.py +3 -3
- rapidata/api_client/models/are_rapids_active_result.py +87 -0
- rapidata/api_client/models/compare_workflow_model.py +3 -3
- rapidata/api_client/models/create_datapoint_from_files_model.py +102 -0
- rapidata/api_client/models/create_datapoint_from_files_model_metadata_inner.py +168 -0
- rapidata/api_client/models/create_datapoint_from_text_sources_model.py +109 -0
- rapidata/api_client/models/create_datapoint_from_urls_model.py +4 -4
- rapidata/api_client/models/create_datapoints_from_s3_bucket_model.py +124 -0
- rapidata/api_client/models/create_rapid_result.py +87 -0
- rapidata/api_client/models/create_validation_set_model.py +87 -0
- rapidata/api_client/models/datapoint_metadata_model.py +3 -3
- rapidata/api_client/models/get_validation_rapids_query.py +123 -0
- rapidata/api_client/models/get_validation_rapids_query_paged_result.py +105 -0
- rapidata/api_client/models/pipeline_id_workflow_artifact_id_put_request.py +140 -0
- rapidata/api_client/models/query_validation_rapids_result.py +3 -3
- rapidata/api_client/models/rapid_issue.py +4 -0
- rapidata/api_client/models/report_model.py +4 -4
- rapidata/api_client/models/shuffling_selection.py +106 -0
- rapidata/api_client/models/update_dataset_name_model.py +87 -0
- rapidata/api_client/models/update_order_name_model.py +87 -0
- rapidata/api_client/models/upload_text_sources_to_dataset_model.py +3 -3
- rapidata/api_client/models/user_score_user_filter_model.py +9 -2
- rapidata/api_client_README.md +153 -88
- rapidata/rapidata_client/demographic/demographic_manager.py +1 -1
- rapidata/rapidata_client/filter/user_score_filter.py +4 -1
- rapidata/rapidata_client/order/_rapidata_dataset.py +10 -11
- rapidata/rapidata_client/order/_rapidata_order_builder.py +1 -1
- rapidata/rapidata_client/order/rapidata_order.py +5 -5
- rapidata/rapidata_client/order/rapidata_order_manager.py +1 -1
- rapidata/rapidata_client/order/rapidata_results.py +1 -1
- rapidata/rapidata_client/validation/rapidata_validation_set.py +11 -0
- rapidata/rapidata_client/validation/rapids/rapids.py +3 -5
- rapidata/rapidata_client/validation/validation_set_manager.py +36 -21
- rapidata/rapidata_client/workflow/_ranking_workflow.py +2 -2
- {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/METADATA +1 -1
- {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/RECORD +60 -43
- {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/LICENSE +0 -0
- {rapidata-2.15.0.dist-info → rapidata-2.16.0.dist-info}/WHEEL +0 -0
|
@@ -24,6 +24,7 @@ from rapidata.api_client.models.get_responses_result import GetResponsesResult
|
|
|
24
24
|
from rapidata.api_client.models.get_workflow_by_id_result import GetWorkflowByIdResult
|
|
25
25
|
from rapidata.api_client.models.get_workflow_progress_result import GetWorkflowProgressResult
|
|
26
26
|
from rapidata.api_client.models.i_workflow_model_paged_result import IWorkflowModelPagedResult
|
|
27
|
+
from rapidata.api_client.models.query_model import QueryModel
|
|
27
28
|
from rapidata.api_client.models.query_workflows_model import QueryWorkflowsModel
|
|
28
29
|
from rapidata.api_client.models.sort_direction import SortDirection
|
|
29
30
|
|
|
@@ -283,7 +284,7 @@ class WorkflowApi:
|
|
|
283
284
|
|
|
284
285
|
return self.api_client.param_serialize(
|
|
285
286
|
method='DELETE',
|
|
286
|
-
resource_path='/
|
|
287
|
+
resource_path='/workflow/delete',
|
|
287
288
|
path_params=_path_params,
|
|
288
289
|
query_params=_query_params,
|
|
289
290
|
header_params=_header_params,
|
|
@@ -300,7 +301,7 @@ class WorkflowApi:
|
|
|
300
301
|
|
|
301
302
|
|
|
302
303
|
@validate_call
|
|
303
|
-
def
|
|
304
|
+
def workflow_getbyid_get(
|
|
304
305
|
self,
|
|
305
306
|
workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get.")] = None,
|
|
306
307
|
_request_timeout: Union[
|
|
@@ -316,11 +317,812 @@ class WorkflowApi:
|
|
|
316
317
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
317
318
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
318
319
|
) -> GetWorkflowByIdResult:
|
|
319
|
-
"""Get a workflow by its ID.
|
|
320
|
+
"""(Deprecated) Get a workflow by its ID.
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
:param workflow_id: The ID of the workflow to get.
|
|
324
|
+
:type workflow_id: str
|
|
325
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
326
|
+
number provided, it will be total request
|
|
327
|
+
timeout. It can also be a pair (tuple) of
|
|
328
|
+
(connection, read) timeouts.
|
|
329
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
330
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
331
|
+
request; this effectively ignores the
|
|
332
|
+
authentication in the spec for a single request.
|
|
333
|
+
:type _request_auth: dict, optional
|
|
334
|
+
:param _content_type: force content-type for the request.
|
|
335
|
+
:type _content_type: str, Optional
|
|
336
|
+
:param _headers: set to override the headers for a single
|
|
337
|
+
request; this effectively ignores the headers
|
|
338
|
+
in the spec for a single request.
|
|
339
|
+
:type _headers: dict, optional
|
|
340
|
+
:param _host_index: set to override the host_index for a single
|
|
341
|
+
request; this effectively ignores the host_index
|
|
342
|
+
in the spec for a single request.
|
|
343
|
+
:type _host_index: int, optional
|
|
344
|
+
:return: Returns the result object.
|
|
345
|
+
""" # noqa: E501
|
|
346
|
+
warnings.warn("GET /workflow/getbyid is deprecated.", DeprecationWarning)
|
|
347
|
+
|
|
348
|
+
_param = self._workflow_getbyid_get_serialize(
|
|
349
|
+
workflow_id=workflow_id,
|
|
350
|
+
_request_auth=_request_auth,
|
|
351
|
+
_content_type=_content_type,
|
|
352
|
+
_headers=_headers,
|
|
353
|
+
_host_index=_host_index
|
|
354
|
+
)
|
|
355
|
+
|
|
356
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
357
|
+
'200': "GetWorkflowByIdResult",
|
|
358
|
+
}
|
|
359
|
+
response_data = self.api_client.call_api(
|
|
360
|
+
*_param,
|
|
361
|
+
_request_timeout=_request_timeout
|
|
362
|
+
)
|
|
363
|
+
response_data.read()
|
|
364
|
+
return self.api_client.response_deserialize(
|
|
365
|
+
response_data=response_data,
|
|
366
|
+
response_types_map=_response_types_map,
|
|
367
|
+
).data
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
@validate_call
|
|
371
|
+
def workflow_getbyid_get_with_http_info(
|
|
372
|
+
self,
|
|
373
|
+
workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get.")] = None,
|
|
374
|
+
_request_timeout: Union[
|
|
375
|
+
None,
|
|
376
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
377
|
+
Tuple[
|
|
378
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
379
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
380
|
+
]
|
|
381
|
+
] = None,
|
|
382
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
383
|
+
_content_type: Optional[StrictStr] = None,
|
|
384
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
385
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
386
|
+
) -> ApiResponse[GetWorkflowByIdResult]:
|
|
387
|
+
"""(Deprecated) Get a workflow by its ID.
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
:param workflow_id: The ID of the workflow to get.
|
|
391
|
+
:type workflow_id: str
|
|
392
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
393
|
+
number provided, it will be total request
|
|
394
|
+
timeout. It can also be a pair (tuple) of
|
|
395
|
+
(connection, read) timeouts.
|
|
396
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
397
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
398
|
+
request; this effectively ignores the
|
|
399
|
+
authentication in the spec for a single request.
|
|
400
|
+
:type _request_auth: dict, optional
|
|
401
|
+
:param _content_type: force content-type for the request.
|
|
402
|
+
:type _content_type: str, Optional
|
|
403
|
+
:param _headers: set to override the headers for a single
|
|
404
|
+
request; this effectively ignores the headers
|
|
405
|
+
in the spec for a single request.
|
|
406
|
+
:type _headers: dict, optional
|
|
407
|
+
:param _host_index: set to override the host_index for a single
|
|
408
|
+
request; this effectively ignores the host_index
|
|
409
|
+
in the spec for a single request.
|
|
410
|
+
:type _host_index: int, optional
|
|
411
|
+
:return: Returns the result object.
|
|
412
|
+
""" # noqa: E501
|
|
413
|
+
warnings.warn("GET /workflow/getbyid is deprecated.", DeprecationWarning)
|
|
414
|
+
|
|
415
|
+
_param = self._workflow_getbyid_get_serialize(
|
|
416
|
+
workflow_id=workflow_id,
|
|
417
|
+
_request_auth=_request_auth,
|
|
418
|
+
_content_type=_content_type,
|
|
419
|
+
_headers=_headers,
|
|
420
|
+
_host_index=_host_index
|
|
421
|
+
)
|
|
422
|
+
|
|
423
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
424
|
+
'200': "GetWorkflowByIdResult",
|
|
425
|
+
}
|
|
426
|
+
response_data = self.api_client.call_api(
|
|
427
|
+
*_param,
|
|
428
|
+
_request_timeout=_request_timeout
|
|
429
|
+
)
|
|
430
|
+
response_data.read()
|
|
431
|
+
return self.api_client.response_deserialize(
|
|
432
|
+
response_data=response_data,
|
|
433
|
+
response_types_map=_response_types_map,
|
|
434
|
+
)
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
@validate_call
|
|
438
|
+
def workflow_getbyid_get_without_preload_content(
|
|
439
|
+
self,
|
|
440
|
+
workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get.")] = None,
|
|
441
|
+
_request_timeout: Union[
|
|
442
|
+
None,
|
|
443
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
444
|
+
Tuple[
|
|
445
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
446
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
447
|
+
]
|
|
448
|
+
] = None,
|
|
449
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
450
|
+
_content_type: Optional[StrictStr] = None,
|
|
451
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
452
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
453
|
+
) -> RESTResponseType:
|
|
454
|
+
"""(Deprecated) Get a workflow by its ID.
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
:param workflow_id: The ID of the workflow to get.
|
|
458
|
+
:type workflow_id: str
|
|
459
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
460
|
+
number provided, it will be total request
|
|
461
|
+
timeout. It can also be a pair (tuple) of
|
|
462
|
+
(connection, read) timeouts.
|
|
463
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
464
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
465
|
+
request; this effectively ignores the
|
|
466
|
+
authentication in the spec for a single request.
|
|
467
|
+
:type _request_auth: dict, optional
|
|
468
|
+
:param _content_type: force content-type for the request.
|
|
469
|
+
:type _content_type: str, Optional
|
|
470
|
+
:param _headers: set to override the headers for a single
|
|
471
|
+
request; this effectively ignores the headers
|
|
472
|
+
in the spec for a single request.
|
|
473
|
+
:type _headers: dict, optional
|
|
474
|
+
:param _host_index: set to override the host_index for a single
|
|
475
|
+
request; this effectively ignores the host_index
|
|
476
|
+
in the spec for a single request.
|
|
477
|
+
:type _host_index: int, optional
|
|
478
|
+
:return: Returns the result object.
|
|
479
|
+
""" # noqa: E501
|
|
480
|
+
warnings.warn("GET /workflow/getbyid is deprecated.", DeprecationWarning)
|
|
481
|
+
|
|
482
|
+
_param = self._workflow_getbyid_get_serialize(
|
|
483
|
+
workflow_id=workflow_id,
|
|
484
|
+
_request_auth=_request_auth,
|
|
485
|
+
_content_type=_content_type,
|
|
486
|
+
_headers=_headers,
|
|
487
|
+
_host_index=_host_index
|
|
488
|
+
)
|
|
489
|
+
|
|
490
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
491
|
+
'200': "GetWorkflowByIdResult",
|
|
492
|
+
}
|
|
493
|
+
response_data = self.api_client.call_api(
|
|
494
|
+
*_param,
|
|
495
|
+
_request_timeout=_request_timeout
|
|
496
|
+
)
|
|
497
|
+
return response_data.response
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
def _workflow_getbyid_get_serialize(
|
|
501
|
+
self,
|
|
502
|
+
workflow_id,
|
|
503
|
+
_request_auth,
|
|
504
|
+
_content_type,
|
|
505
|
+
_headers,
|
|
506
|
+
_host_index,
|
|
507
|
+
) -> RequestSerialized:
|
|
508
|
+
|
|
509
|
+
_host = None
|
|
510
|
+
|
|
511
|
+
_collection_formats: Dict[str, str] = {
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
_path_params: Dict[str, str] = {}
|
|
515
|
+
_query_params: List[Tuple[str, str]] = []
|
|
516
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
517
|
+
_form_params: List[Tuple[str, str]] = []
|
|
518
|
+
_files: Dict[
|
|
519
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
520
|
+
] = {}
|
|
521
|
+
_body_params: Optional[bytes] = None
|
|
522
|
+
|
|
523
|
+
# process the path parameters
|
|
524
|
+
# process the query parameters
|
|
525
|
+
if workflow_id is not None:
|
|
526
|
+
|
|
527
|
+
_query_params.append(('workflowId', workflow_id))
|
|
528
|
+
|
|
529
|
+
# process the header parameters
|
|
530
|
+
# process the form parameters
|
|
531
|
+
# process the body parameter
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
# set the HTTP header `Accept`
|
|
535
|
+
if 'Accept' not in _header_params:
|
|
536
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
537
|
+
[
|
|
538
|
+
'text/plain',
|
|
539
|
+
'application/json',
|
|
540
|
+
'text/json'
|
|
541
|
+
]
|
|
542
|
+
)
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
# authentication setting
|
|
546
|
+
_auth_settings: List[str] = [
|
|
547
|
+
'bearer',
|
|
548
|
+
'oauth2'
|
|
549
|
+
]
|
|
550
|
+
|
|
551
|
+
return self.api_client.param_serialize(
|
|
552
|
+
method='GET',
|
|
553
|
+
resource_path='/workflow/getbyid',
|
|
554
|
+
path_params=_path_params,
|
|
555
|
+
query_params=_query_params,
|
|
556
|
+
header_params=_header_params,
|
|
557
|
+
body=_body_params,
|
|
558
|
+
post_params=_form_params,
|
|
559
|
+
files=_files,
|
|
560
|
+
auth_settings=_auth_settings,
|
|
561
|
+
collection_formats=_collection_formats,
|
|
562
|
+
_host=_host,
|
|
563
|
+
_request_auth=_request_auth
|
|
564
|
+
)
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
@validate_call
|
|
570
|
+
def workflow_getprogress_get(
|
|
571
|
+
self,
|
|
572
|
+
workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get the progress for.")] = None,
|
|
573
|
+
_request_timeout: Union[
|
|
574
|
+
None,
|
|
575
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
576
|
+
Tuple[
|
|
577
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
578
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
579
|
+
]
|
|
580
|
+
] = None,
|
|
581
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
582
|
+
_content_type: Optional[StrictStr] = None,
|
|
583
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
584
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
585
|
+
) -> GetWorkflowProgressResult:
|
|
586
|
+
"""(Deprecated) Get the progress of a workflow.
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
:param workflow_id: The ID of the workflow to get the progress for.
|
|
590
|
+
:type workflow_id: str
|
|
591
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
592
|
+
number provided, it will be total request
|
|
593
|
+
timeout. It can also be a pair (tuple) of
|
|
594
|
+
(connection, read) timeouts.
|
|
595
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
596
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
597
|
+
request; this effectively ignores the
|
|
598
|
+
authentication in the spec for a single request.
|
|
599
|
+
:type _request_auth: dict, optional
|
|
600
|
+
:param _content_type: force content-type for the request.
|
|
601
|
+
:type _content_type: str, Optional
|
|
602
|
+
:param _headers: set to override the headers for a single
|
|
603
|
+
request; this effectively ignores the headers
|
|
604
|
+
in the spec for a single request.
|
|
605
|
+
:type _headers: dict, optional
|
|
606
|
+
:param _host_index: set to override the host_index for a single
|
|
607
|
+
request; this effectively ignores the host_index
|
|
608
|
+
in the spec for a single request.
|
|
609
|
+
:type _host_index: int, optional
|
|
610
|
+
:return: Returns the result object.
|
|
611
|
+
""" # noqa: E501
|
|
612
|
+
warnings.warn("GET /workflow/getprogress is deprecated.", DeprecationWarning)
|
|
613
|
+
|
|
614
|
+
_param = self._workflow_getprogress_get_serialize(
|
|
615
|
+
workflow_id=workflow_id,
|
|
616
|
+
_request_auth=_request_auth,
|
|
617
|
+
_content_type=_content_type,
|
|
618
|
+
_headers=_headers,
|
|
619
|
+
_host_index=_host_index
|
|
620
|
+
)
|
|
621
|
+
|
|
622
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
623
|
+
'200': "GetWorkflowProgressResult",
|
|
624
|
+
}
|
|
625
|
+
response_data = self.api_client.call_api(
|
|
626
|
+
*_param,
|
|
627
|
+
_request_timeout=_request_timeout
|
|
628
|
+
)
|
|
629
|
+
response_data.read()
|
|
630
|
+
return self.api_client.response_deserialize(
|
|
631
|
+
response_data=response_data,
|
|
632
|
+
response_types_map=_response_types_map,
|
|
633
|
+
).data
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
@validate_call
|
|
637
|
+
def workflow_getprogress_get_with_http_info(
|
|
638
|
+
self,
|
|
639
|
+
workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get the progress for.")] = None,
|
|
640
|
+
_request_timeout: Union[
|
|
641
|
+
None,
|
|
642
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
643
|
+
Tuple[
|
|
644
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
645
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
646
|
+
]
|
|
647
|
+
] = None,
|
|
648
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
649
|
+
_content_type: Optional[StrictStr] = None,
|
|
650
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
651
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
652
|
+
) -> ApiResponse[GetWorkflowProgressResult]:
|
|
653
|
+
"""(Deprecated) Get the progress of a workflow.
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
:param workflow_id: The ID of the workflow to get the progress for.
|
|
657
|
+
:type workflow_id: str
|
|
658
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
659
|
+
number provided, it will be total request
|
|
660
|
+
timeout. It can also be a pair (tuple) of
|
|
661
|
+
(connection, read) timeouts.
|
|
662
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
663
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
664
|
+
request; this effectively ignores the
|
|
665
|
+
authentication in the spec for a single request.
|
|
666
|
+
:type _request_auth: dict, optional
|
|
667
|
+
:param _content_type: force content-type for the request.
|
|
668
|
+
:type _content_type: str, Optional
|
|
669
|
+
:param _headers: set to override the headers for a single
|
|
670
|
+
request; this effectively ignores the headers
|
|
671
|
+
in the spec for a single request.
|
|
672
|
+
:type _headers: dict, optional
|
|
673
|
+
:param _host_index: set to override the host_index for a single
|
|
674
|
+
request; this effectively ignores the host_index
|
|
675
|
+
in the spec for a single request.
|
|
676
|
+
:type _host_index: int, optional
|
|
677
|
+
:return: Returns the result object.
|
|
678
|
+
""" # noqa: E501
|
|
679
|
+
warnings.warn("GET /workflow/getprogress is deprecated.", DeprecationWarning)
|
|
680
|
+
|
|
681
|
+
_param = self._workflow_getprogress_get_serialize(
|
|
682
|
+
workflow_id=workflow_id,
|
|
683
|
+
_request_auth=_request_auth,
|
|
684
|
+
_content_type=_content_type,
|
|
685
|
+
_headers=_headers,
|
|
686
|
+
_host_index=_host_index
|
|
687
|
+
)
|
|
688
|
+
|
|
689
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
690
|
+
'200': "GetWorkflowProgressResult",
|
|
691
|
+
}
|
|
692
|
+
response_data = self.api_client.call_api(
|
|
693
|
+
*_param,
|
|
694
|
+
_request_timeout=_request_timeout
|
|
695
|
+
)
|
|
696
|
+
response_data.read()
|
|
697
|
+
return self.api_client.response_deserialize(
|
|
698
|
+
response_data=response_data,
|
|
699
|
+
response_types_map=_response_types_map,
|
|
700
|
+
)
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
@validate_call
|
|
704
|
+
def workflow_getprogress_get_without_preload_content(
|
|
705
|
+
self,
|
|
706
|
+
workflow_id: Annotated[Optional[StrictStr], Field(description="The ID of the workflow to get the progress for.")] = None,
|
|
707
|
+
_request_timeout: Union[
|
|
708
|
+
None,
|
|
709
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
710
|
+
Tuple[
|
|
711
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
712
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
713
|
+
]
|
|
714
|
+
] = None,
|
|
715
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
716
|
+
_content_type: Optional[StrictStr] = None,
|
|
717
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
718
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
719
|
+
) -> RESTResponseType:
|
|
720
|
+
"""(Deprecated) Get the progress of a workflow.
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
:param workflow_id: The ID of the workflow to get the progress for.
|
|
724
|
+
:type workflow_id: str
|
|
725
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
726
|
+
number provided, it will be total request
|
|
727
|
+
timeout. It can also be a pair (tuple) of
|
|
728
|
+
(connection, read) timeouts.
|
|
729
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
730
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
731
|
+
request; this effectively ignores the
|
|
732
|
+
authentication in the spec for a single request.
|
|
733
|
+
:type _request_auth: dict, optional
|
|
734
|
+
:param _content_type: force content-type for the request.
|
|
735
|
+
:type _content_type: str, Optional
|
|
736
|
+
:param _headers: set to override the headers for a single
|
|
737
|
+
request; this effectively ignores the headers
|
|
738
|
+
in the spec for a single request.
|
|
739
|
+
:type _headers: dict, optional
|
|
740
|
+
:param _host_index: set to override the host_index for a single
|
|
741
|
+
request; this effectively ignores the host_index
|
|
742
|
+
in the spec for a single request.
|
|
743
|
+
:type _host_index: int, optional
|
|
744
|
+
:return: Returns the result object.
|
|
745
|
+
""" # noqa: E501
|
|
746
|
+
warnings.warn("GET /workflow/getprogress is deprecated.", DeprecationWarning)
|
|
747
|
+
|
|
748
|
+
_param = self._workflow_getprogress_get_serialize(
|
|
749
|
+
workflow_id=workflow_id,
|
|
750
|
+
_request_auth=_request_auth,
|
|
751
|
+
_content_type=_content_type,
|
|
752
|
+
_headers=_headers,
|
|
753
|
+
_host_index=_host_index
|
|
754
|
+
)
|
|
755
|
+
|
|
756
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
757
|
+
'200': "GetWorkflowProgressResult",
|
|
758
|
+
}
|
|
759
|
+
response_data = self.api_client.call_api(
|
|
760
|
+
*_param,
|
|
761
|
+
_request_timeout=_request_timeout
|
|
762
|
+
)
|
|
763
|
+
return response_data.response
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
def _workflow_getprogress_get_serialize(
|
|
767
|
+
self,
|
|
768
|
+
workflow_id,
|
|
769
|
+
_request_auth,
|
|
770
|
+
_content_type,
|
|
771
|
+
_headers,
|
|
772
|
+
_host_index,
|
|
773
|
+
) -> RequestSerialized:
|
|
774
|
+
|
|
775
|
+
_host = None
|
|
776
|
+
|
|
777
|
+
_collection_formats: Dict[str, str] = {
|
|
778
|
+
}
|
|
779
|
+
|
|
780
|
+
_path_params: Dict[str, str] = {}
|
|
781
|
+
_query_params: List[Tuple[str, str]] = []
|
|
782
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
783
|
+
_form_params: List[Tuple[str, str]] = []
|
|
784
|
+
_files: Dict[
|
|
785
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
786
|
+
] = {}
|
|
787
|
+
_body_params: Optional[bytes] = None
|
|
788
|
+
|
|
789
|
+
# process the path parameters
|
|
790
|
+
# process the query parameters
|
|
791
|
+
if workflow_id is not None:
|
|
792
|
+
|
|
793
|
+
_query_params.append(('workflowId', workflow_id))
|
|
794
|
+
|
|
795
|
+
# process the header parameters
|
|
796
|
+
# process the form parameters
|
|
797
|
+
# process the body parameter
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
# set the HTTP header `Accept`
|
|
801
|
+
if 'Accept' not in _header_params:
|
|
802
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
803
|
+
[
|
|
804
|
+
'text/plain',
|
|
805
|
+
'application/json',
|
|
806
|
+
'text/json'
|
|
807
|
+
]
|
|
808
|
+
)
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
# authentication setting
|
|
812
|
+
_auth_settings: List[str] = [
|
|
813
|
+
'bearer',
|
|
814
|
+
'oauth2'
|
|
815
|
+
]
|
|
816
|
+
|
|
817
|
+
return self.api_client.param_serialize(
|
|
818
|
+
method='GET',
|
|
819
|
+
resource_path='/workflow/getprogress',
|
|
820
|
+
path_params=_path_params,
|
|
821
|
+
query_params=_query_params,
|
|
822
|
+
header_params=_header_params,
|
|
823
|
+
body=_body_params,
|
|
824
|
+
post_params=_form_params,
|
|
825
|
+
files=_files,
|
|
826
|
+
auth_settings=_auth_settings,
|
|
827
|
+
collection_formats=_collection_formats,
|
|
828
|
+
_host=_host,
|
|
829
|
+
_request_auth=_request_auth
|
|
830
|
+
)
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
@validate_call
|
|
836
|
+
def workflow_query_get(
|
|
837
|
+
self,
|
|
838
|
+
request: Annotated[Optional[QueryWorkflowsModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
|
|
839
|
+
_request_timeout: Union[
|
|
840
|
+
None,
|
|
841
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
842
|
+
Tuple[
|
|
843
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
844
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
845
|
+
]
|
|
846
|
+
] = None,
|
|
847
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
848
|
+
_content_type: Optional[StrictStr] = None,
|
|
849
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
850
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
851
|
+
) -> IWorkflowModelPagedResult:
|
|
852
|
+
"""(Deprecated) Queries workflows based on the provided filter, page, and sort criteria.
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
:param request: The model containing the filter, page, and sort criteria.
|
|
856
|
+
:type request: QueryWorkflowsModel
|
|
857
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
858
|
+
number provided, it will be total request
|
|
859
|
+
timeout. It can also be a pair (tuple) of
|
|
860
|
+
(connection, read) timeouts.
|
|
861
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
862
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
863
|
+
request; this effectively ignores the
|
|
864
|
+
authentication in the spec for a single request.
|
|
865
|
+
:type _request_auth: dict, optional
|
|
866
|
+
:param _content_type: force content-type for the request.
|
|
867
|
+
:type _content_type: str, Optional
|
|
868
|
+
:param _headers: set to override the headers for a single
|
|
869
|
+
request; this effectively ignores the headers
|
|
870
|
+
in the spec for a single request.
|
|
871
|
+
:type _headers: dict, optional
|
|
872
|
+
:param _host_index: set to override the host_index for a single
|
|
873
|
+
request; this effectively ignores the host_index
|
|
874
|
+
in the spec for a single request.
|
|
875
|
+
:type _host_index: int, optional
|
|
876
|
+
:return: Returns the result object.
|
|
877
|
+
""" # noqa: E501
|
|
878
|
+
warnings.warn("GET /workflow/query is deprecated.", DeprecationWarning)
|
|
879
|
+
|
|
880
|
+
_param = self._workflow_query_get_serialize(
|
|
881
|
+
request=request,
|
|
882
|
+
_request_auth=_request_auth,
|
|
883
|
+
_content_type=_content_type,
|
|
884
|
+
_headers=_headers,
|
|
885
|
+
_host_index=_host_index
|
|
886
|
+
)
|
|
887
|
+
|
|
888
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
889
|
+
'200': "IWorkflowModelPagedResult",
|
|
890
|
+
}
|
|
891
|
+
response_data = self.api_client.call_api(
|
|
892
|
+
*_param,
|
|
893
|
+
_request_timeout=_request_timeout
|
|
894
|
+
)
|
|
895
|
+
response_data.read()
|
|
896
|
+
return self.api_client.response_deserialize(
|
|
897
|
+
response_data=response_data,
|
|
898
|
+
response_types_map=_response_types_map,
|
|
899
|
+
).data
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
@validate_call
|
|
903
|
+
def workflow_query_get_with_http_info(
|
|
904
|
+
self,
|
|
905
|
+
request: Annotated[Optional[QueryWorkflowsModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
|
|
906
|
+
_request_timeout: Union[
|
|
907
|
+
None,
|
|
908
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
909
|
+
Tuple[
|
|
910
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
911
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
912
|
+
]
|
|
913
|
+
] = None,
|
|
914
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
915
|
+
_content_type: Optional[StrictStr] = None,
|
|
916
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
917
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
918
|
+
) -> ApiResponse[IWorkflowModelPagedResult]:
|
|
919
|
+
"""(Deprecated) Queries workflows based on the provided filter, page, and sort criteria.
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
:param request: The model containing the filter, page, and sort criteria.
|
|
923
|
+
:type request: QueryWorkflowsModel
|
|
924
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
925
|
+
number provided, it will be total request
|
|
926
|
+
timeout. It can also be a pair (tuple) of
|
|
927
|
+
(connection, read) timeouts.
|
|
928
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
929
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
930
|
+
request; this effectively ignores the
|
|
931
|
+
authentication in the spec for a single request.
|
|
932
|
+
:type _request_auth: dict, optional
|
|
933
|
+
:param _content_type: force content-type for the request.
|
|
934
|
+
:type _content_type: str, Optional
|
|
935
|
+
:param _headers: set to override the headers for a single
|
|
936
|
+
request; this effectively ignores the headers
|
|
937
|
+
in the spec for a single request.
|
|
938
|
+
:type _headers: dict, optional
|
|
939
|
+
:param _host_index: set to override the host_index for a single
|
|
940
|
+
request; this effectively ignores the host_index
|
|
941
|
+
in the spec for a single request.
|
|
942
|
+
:type _host_index: int, optional
|
|
943
|
+
:return: Returns the result object.
|
|
944
|
+
""" # noqa: E501
|
|
945
|
+
warnings.warn("GET /workflow/query is deprecated.", DeprecationWarning)
|
|
946
|
+
|
|
947
|
+
_param = self._workflow_query_get_serialize(
|
|
948
|
+
request=request,
|
|
949
|
+
_request_auth=_request_auth,
|
|
950
|
+
_content_type=_content_type,
|
|
951
|
+
_headers=_headers,
|
|
952
|
+
_host_index=_host_index
|
|
953
|
+
)
|
|
954
|
+
|
|
955
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
956
|
+
'200': "IWorkflowModelPagedResult",
|
|
957
|
+
}
|
|
958
|
+
response_data = self.api_client.call_api(
|
|
959
|
+
*_param,
|
|
960
|
+
_request_timeout=_request_timeout
|
|
961
|
+
)
|
|
962
|
+
response_data.read()
|
|
963
|
+
return self.api_client.response_deserialize(
|
|
964
|
+
response_data=response_data,
|
|
965
|
+
response_types_map=_response_types_map,
|
|
966
|
+
)
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
@validate_call
|
|
970
|
+
def workflow_query_get_without_preload_content(
|
|
971
|
+
self,
|
|
972
|
+
request: Annotated[Optional[QueryWorkflowsModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
|
|
973
|
+
_request_timeout: Union[
|
|
974
|
+
None,
|
|
975
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
976
|
+
Tuple[
|
|
977
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
978
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
979
|
+
]
|
|
980
|
+
] = None,
|
|
981
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
982
|
+
_content_type: Optional[StrictStr] = None,
|
|
983
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
984
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
985
|
+
) -> RESTResponseType:
|
|
986
|
+
"""(Deprecated) Queries workflows based on the provided filter, page, and sort criteria.
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
:param request: The model containing the filter, page, and sort criteria.
|
|
990
|
+
:type request: QueryWorkflowsModel
|
|
991
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
992
|
+
number provided, it will be total request
|
|
993
|
+
timeout. It can also be a pair (tuple) of
|
|
994
|
+
(connection, read) timeouts.
|
|
995
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
996
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
997
|
+
request; this effectively ignores the
|
|
998
|
+
authentication in the spec for a single request.
|
|
999
|
+
:type _request_auth: dict, optional
|
|
1000
|
+
:param _content_type: force content-type for the request.
|
|
1001
|
+
:type _content_type: str, Optional
|
|
1002
|
+
:param _headers: set to override the headers for a single
|
|
1003
|
+
request; this effectively ignores the headers
|
|
1004
|
+
in the spec for a single request.
|
|
1005
|
+
:type _headers: dict, optional
|
|
1006
|
+
:param _host_index: set to override the host_index for a single
|
|
1007
|
+
request; this effectively ignores the host_index
|
|
1008
|
+
in the spec for a single request.
|
|
1009
|
+
:type _host_index: int, optional
|
|
1010
|
+
:return: Returns the result object.
|
|
1011
|
+
""" # noqa: E501
|
|
1012
|
+
warnings.warn("GET /workflow/query is deprecated.", DeprecationWarning)
|
|
1013
|
+
|
|
1014
|
+
_param = self._workflow_query_get_serialize(
|
|
1015
|
+
request=request,
|
|
1016
|
+
_request_auth=_request_auth,
|
|
1017
|
+
_content_type=_content_type,
|
|
1018
|
+
_headers=_headers,
|
|
1019
|
+
_host_index=_host_index
|
|
1020
|
+
)
|
|
1021
|
+
|
|
1022
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1023
|
+
'200': "IWorkflowModelPagedResult",
|
|
1024
|
+
}
|
|
1025
|
+
response_data = self.api_client.call_api(
|
|
1026
|
+
*_param,
|
|
1027
|
+
_request_timeout=_request_timeout
|
|
1028
|
+
)
|
|
1029
|
+
return response_data.response
|
|
320
1030
|
|
|
321
1031
|
|
|
322
|
-
|
|
1032
|
+
def _workflow_query_get_serialize(
|
|
1033
|
+
self,
|
|
1034
|
+
request,
|
|
1035
|
+
_request_auth,
|
|
1036
|
+
_content_type,
|
|
1037
|
+
_headers,
|
|
1038
|
+
_host_index,
|
|
1039
|
+
) -> RequestSerialized:
|
|
1040
|
+
|
|
1041
|
+
_host = None
|
|
1042
|
+
|
|
1043
|
+
_collection_formats: Dict[str, str] = {
|
|
1044
|
+
}
|
|
1045
|
+
|
|
1046
|
+
_path_params: Dict[str, str] = {}
|
|
1047
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1048
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1049
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1050
|
+
_files: Dict[
|
|
1051
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1052
|
+
] = {}
|
|
1053
|
+
_body_params: Optional[bytes] = None
|
|
1054
|
+
|
|
1055
|
+
# process the path parameters
|
|
1056
|
+
# process the query parameters
|
|
1057
|
+
if request is not None:
|
|
1058
|
+
|
|
1059
|
+
_query_params.append(('request', request))
|
|
1060
|
+
|
|
1061
|
+
# process the header parameters
|
|
1062
|
+
# process the form parameters
|
|
1063
|
+
# process the body parameter
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
# set the HTTP header `Accept`
|
|
1067
|
+
if 'Accept' not in _header_params:
|
|
1068
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1069
|
+
[
|
|
1070
|
+
'text/plain',
|
|
1071
|
+
'application/json',
|
|
1072
|
+
'text/json'
|
|
1073
|
+
]
|
|
1074
|
+
)
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
# authentication setting
|
|
1078
|
+
_auth_settings: List[str] = [
|
|
1079
|
+
'bearer',
|
|
1080
|
+
'oauth2'
|
|
1081
|
+
]
|
|
1082
|
+
|
|
1083
|
+
return self.api_client.param_serialize(
|
|
1084
|
+
method='GET',
|
|
1085
|
+
resource_path='/workflow/query',
|
|
1086
|
+
path_params=_path_params,
|
|
1087
|
+
query_params=_query_params,
|
|
1088
|
+
header_params=_header_params,
|
|
1089
|
+
body=_body_params,
|
|
1090
|
+
post_params=_form_params,
|
|
1091
|
+
files=_files,
|
|
1092
|
+
auth_settings=_auth_settings,
|
|
1093
|
+
collection_formats=_collection_formats,
|
|
1094
|
+
_host=_host,
|
|
1095
|
+
_request_auth=_request_auth
|
|
1096
|
+
)
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
@validate_call
|
|
1102
|
+
def workflow_workflow_id_compare_ab_summary_get(
|
|
1103
|
+
self,
|
|
1104
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the summary for.")],
|
|
1105
|
+
use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = None,
|
|
1106
|
+
_request_timeout: Union[
|
|
1107
|
+
None,
|
|
1108
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1109
|
+
Tuple[
|
|
1110
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1111
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1112
|
+
]
|
|
1113
|
+
] = None,
|
|
1114
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1115
|
+
_content_type: Optional[StrictStr] = None,
|
|
1116
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1117
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1118
|
+
) -> GetCompareAbSummaryResult:
|
|
1119
|
+
"""Calculates a summary of the results for a simple compare workflow. The summary includes the number of times an asset at each index was the winner.
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
:param workflow_id: The ID of the workflow to get the summary for. (required)
|
|
323
1123
|
:type workflow_id: str
|
|
1124
|
+
:param use_user_score: Whether to use the user score to determine the winner.
|
|
1125
|
+
:type use_user_score: bool
|
|
324
1126
|
:param _request_timeout: timeout setting for this request. If one
|
|
325
1127
|
number provided, it will be total request
|
|
326
1128
|
timeout. It can also be a pair (tuple) of
|
|
@@ -343,8 +1145,9 @@ class WorkflowApi:
|
|
|
343
1145
|
:return: Returns the result object.
|
|
344
1146
|
""" # noqa: E501
|
|
345
1147
|
|
|
346
|
-
_param = self.
|
|
1148
|
+
_param = self._workflow_workflow_id_compare_ab_summary_get_serialize(
|
|
347
1149
|
workflow_id=workflow_id,
|
|
1150
|
+
use_user_score=use_user_score,
|
|
348
1151
|
_request_auth=_request_auth,
|
|
349
1152
|
_content_type=_content_type,
|
|
350
1153
|
_headers=_headers,
|
|
@@ -352,7 +1155,7 @@ class WorkflowApi:
|
|
|
352
1155
|
)
|
|
353
1156
|
|
|
354
1157
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
355
|
-
'200': "
|
|
1158
|
+
'200': "GetCompareAbSummaryResult",
|
|
356
1159
|
}
|
|
357
1160
|
response_data = self.api_client.call_api(
|
|
358
1161
|
*_param,
|
|
@@ -366,9 +1169,10 @@ class WorkflowApi:
|
|
|
366
1169
|
|
|
367
1170
|
|
|
368
1171
|
@validate_call
|
|
369
|
-
def
|
|
1172
|
+
def workflow_workflow_id_compare_ab_summary_get_with_http_info(
|
|
370
1173
|
self,
|
|
371
|
-
workflow_id: Annotated[
|
|
1174
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the summary for.")],
|
|
1175
|
+
use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = None,
|
|
372
1176
|
_request_timeout: Union[
|
|
373
1177
|
None,
|
|
374
1178
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -381,12 +1185,14 @@ class WorkflowApi:
|
|
|
381
1185
|
_content_type: Optional[StrictStr] = None,
|
|
382
1186
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
383
1187
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
384
|
-
) -> ApiResponse[
|
|
385
|
-
"""
|
|
1188
|
+
) -> ApiResponse[GetCompareAbSummaryResult]:
|
|
1189
|
+
"""Calculates a summary of the results for a simple compare workflow. The summary includes the number of times an asset at each index was the winner.
|
|
386
1190
|
|
|
387
1191
|
|
|
388
|
-
:param workflow_id: The ID of the workflow to get.
|
|
1192
|
+
:param workflow_id: The ID of the workflow to get the summary for. (required)
|
|
389
1193
|
:type workflow_id: str
|
|
1194
|
+
:param use_user_score: Whether to use the user score to determine the winner.
|
|
1195
|
+
:type use_user_score: bool
|
|
390
1196
|
:param _request_timeout: timeout setting for this request. If one
|
|
391
1197
|
number provided, it will be total request
|
|
392
1198
|
timeout. It can also be a pair (tuple) of
|
|
@@ -409,8 +1215,9 @@ class WorkflowApi:
|
|
|
409
1215
|
:return: Returns the result object.
|
|
410
1216
|
""" # noqa: E501
|
|
411
1217
|
|
|
412
|
-
_param = self.
|
|
1218
|
+
_param = self._workflow_workflow_id_compare_ab_summary_get_serialize(
|
|
413
1219
|
workflow_id=workflow_id,
|
|
1220
|
+
use_user_score=use_user_score,
|
|
414
1221
|
_request_auth=_request_auth,
|
|
415
1222
|
_content_type=_content_type,
|
|
416
1223
|
_headers=_headers,
|
|
@@ -418,7 +1225,7 @@ class WorkflowApi:
|
|
|
418
1225
|
)
|
|
419
1226
|
|
|
420
1227
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
421
|
-
'200': "
|
|
1228
|
+
'200': "GetCompareAbSummaryResult",
|
|
422
1229
|
}
|
|
423
1230
|
response_data = self.api_client.call_api(
|
|
424
1231
|
*_param,
|
|
@@ -432,9 +1239,10 @@ class WorkflowApi:
|
|
|
432
1239
|
|
|
433
1240
|
|
|
434
1241
|
@validate_call
|
|
435
|
-
def
|
|
1242
|
+
def workflow_workflow_id_compare_ab_summary_get_without_preload_content(
|
|
436
1243
|
self,
|
|
437
|
-
workflow_id: Annotated[
|
|
1244
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the summary for.")],
|
|
1245
|
+
use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = None,
|
|
438
1246
|
_request_timeout: Union[
|
|
439
1247
|
None,
|
|
440
1248
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -448,11 +1256,13 @@ class WorkflowApi:
|
|
|
448
1256
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
449
1257
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
450
1258
|
) -> RESTResponseType:
|
|
451
|
-
"""
|
|
1259
|
+
"""Calculates a summary of the results for a simple compare workflow. The summary includes the number of times an asset at each index was the winner.
|
|
452
1260
|
|
|
453
1261
|
|
|
454
|
-
:param workflow_id: The ID of the workflow to get.
|
|
1262
|
+
:param workflow_id: The ID of the workflow to get the summary for. (required)
|
|
455
1263
|
:type workflow_id: str
|
|
1264
|
+
:param use_user_score: Whether to use the user score to determine the winner.
|
|
1265
|
+
:type use_user_score: bool
|
|
456
1266
|
:param _request_timeout: timeout setting for this request. If one
|
|
457
1267
|
number provided, it will be total request
|
|
458
1268
|
timeout. It can also be a pair (tuple) of
|
|
@@ -475,8 +1285,9 @@ class WorkflowApi:
|
|
|
475
1285
|
:return: Returns the result object.
|
|
476
1286
|
""" # noqa: E501
|
|
477
1287
|
|
|
478
|
-
_param = self.
|
|
1288
|
+
_param = self._workflow_workflow_id_compare_ab_summary_get_serialize(
|
|
479
1289
|
workflow_id=workflow_id,
|
|
1290
|
+
use_user_score=use_user_score,
|
|
480
1291
|
_request_auth=_request_auth,
|
|
481
1292
|
_content_type=_content_type,
|
|
482
1293
|
_headers=_headers,
|
|
@@ -484,7 +1295,7 @@ class WorkflowApi:
|
|
|
484
1295
|
)
|
|
485
1296
|
|
|
486
1297
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
487
|
-
'200': "
|
|
1298
|
+
'200': "GetCompareAbSummaryResult",
|
|
488
1299
|
}
|
|
489
1300
|
response_data = self.api_client.call_api(
|
|
490
1301
|
*_param,
|
|
@@ -493,9 +1304,10 @@ class WorkflowApi:
|
|
|
493
1304
|
return response_data.response
|
|
494
1305
|
|
|
495
1306
|
|
|
496
|
-
def
|
|
1307
|
+
def _workflow_workflow_id_compare_ab_summary_get_serialize(
|
|
497
1308
|
self,
|
|
498
1309
|
workflow_id,
|
|
1310
|
+
use_user_score,
|
|
499
1311
|
_request_auth,
|
|
500
1312
|
_content_type,
|
|
501
1313
|
_headers,
|
|
@@ -517,10 +1329,12 @@ class WorkflowApi:
|
|
|
517
1329
|
_body_params: Optional[bytes] = None
|
|
518
1330
|
|
|
519
1331
|
# process the path parameters
|
|
520
|
-
# process the query parameters
|
|
521
1332
|
if workflow_id is not None:
|
|
1333
|
+
_path_params['workflowId'] = workflow_id
|
|
1334
|
+
# process the query parameters
|
|
1335
|
+
if use_user_score is not None:
|
|
522
1336
|
|
|
523
|
-
_query_params.append(('
|
|
1337
|
+
_query_params.append(('useUserScore', use_user_score))
|
|
524
1338
|
|
|
525
1339
|
# process the header parameters
|
|
526
1340
|
# process the form parameters
|
|
@@ -546,7 +1360,7 @@ class WorkflowApi:
|
|
|
546
1360
|
|
|
547
1361
|
return self.api_client.param_serialize(
|
|
548
1362
|
method='GET',
|
|
549
|
-
resource_path='/
|
|
1363
|
+
resource_path='/workflow/{workflowId}/compare-ab-summary',
|
|
550
1364
|
path_params=_path_params,
|
|
551
1365
|
query_params=_query_params,
|
|
552
1366
|
header_params=_header_params,
|
|
@@ -563,9 +1377,9 @@ class WorkflowApi:
|
|
|
563
1377
|
|
|
564
1378
|
|
|
565
1379
|
@validate_call
|
|
566
|
-
def
|
|
1380
|
+
def workflow_workflow_id_get(
|
|
567
1381
|
self,
|
|
568
|
-
workflow_id: Annotated[
|
|
1382
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get.")],
|
|
569
1383
|
_request_timeout: Union[
|
|
570
1384
|
None,
|
|
571
1385
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -578,11 +1392,11 @@ class WorkflowApi:
|
|
|
578
1392
|
_content_type: Optional[StrictStr] = None,
|
|
579
1393
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
580
1394
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
581
|
-
) ->
|
|
582
|
-
"""Get
|
|
1395
|
+
) -> GetWorkflowByIdResult:
|
|
1396
|
+
"""Get a workflow by its ID.
|
|
583
1397
|
|
|
584
1398
|
|
|
585
|
-
:param workflow_id: The ID of the workflow to get
|
|
1399
|
+
:param workflow_id: The ID of the workflow to get. (required)
|
|
586
1400
|
:type workflow_id: str
|
|
587
1401
|
:param _request_timeout: timeout setting for this request. If one
|
|
588
1402
|
number provided, it will be total request
|
|
@@ -606,7 +1420,7 @@ class WorkflowApi:
|
|
|
606
1420
|
:return: Returns the result object.
|
|
607
1421
|
""" # noqa: E501
|
|
608
1422
|
|
|
609
|
-
_param = self.
|
|
1423
|
+
_param = self._workflow_workflow_id_get_serialize(
|
|
610
1424
|
workflow_id=workflow_id,
|
|
611
1425
|
_request_auth=_request_auth,
|
|
612
1426
|
_content_type=_content_type,
|
|
@@ -615,7 +1429,7 @@ class WorkflowApi:
|
|
|
615
1429
|
)
|
|
616
1430
|
|
|
617
1431
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
618
|
-
'200': "
|
|
1432
|
+
'200': "GetWorkflowByIdResult",
|
|
619
1433
|
}
|
|
620
1434
|
response_data = self.api_client.call_api(
|
|
621
1435
|
*_param,
|
|
@@ -629,9 +1443,9 @@ class WorkflowApi:
|
|
|
629
1443
|
|
|
630
1444
|
|
|
631
1445
|
@validate_call
|
|
632
|
-
def
|
|
1446
|
+
def workflow_workflow_id_get_with_http_info(
|
|
633
1447
|
self,
|
|
634
|
-
workflow_id: Annotated[
|
|
1448
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get.")],
|
|
635
1449
|
_request_timeout: Union[
|
|
636
1450
|
None,
|
|
637
1451
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -644,11 +1458,11 @@ class WorkflowApi:
|
|
|
644
1458
|
_content_type: Optional[StrictStr] = None,
|
|
645
1459
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
646
1460
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
647
|
-
) -> ApiResponse[
|
|
648
|
-
"""Get
|
|
1461
|
+
) -> ApiResponse[GetWorkflowByIdResult]:
|
|
1462
|
+
"""Get a workflow by its ID.
|
|
649
1463
|
|
|
650
1464
|
|
|
651
|
-
:param workflow_id: The ID of the workflow to get
|
|
1465
|
+
:param workflow_id: The ID of the workflow to get. (required)
|
|
652
1466
|
:type workflow_id: str
|
|
653
1467
|
:param _request_timeout: timeout setting for this request. If one
|
|
654
1468
|
number provided, it will be total request
|
|
@@ -672,7 +1486,7 @@ class WorkflowApi:
|
|
|
672
1486
|
:return: Returns the result object.
|
|
673
1487
|
""" # noqa: E501
|
|
674
1488
|
|
|
675
|
-
_param = self.
|
|
1489
|
+
_param = self._workflow_workflow_id_get_serialize(
|
|
676
1490
|
workflow_id=workflow_id,
|
|
677
1491
|
_request_auth=_request_auth,
|
|
678
1492
|
_content_type=_content_type,
|
|
@@ -681,7 +1495,7 @@ class WorkflowApi:
|
|
|
681
1495
|
)
|
|
682
1496
|
|
|
683
1497
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
684
|
-
'200': "
|
|
1498
|
+
'200': "GetWorkflowByIdResult",
|
|
685
1499
|
}
|
|
686
1500
|
response_data = self.api_client.call_api(
|
|
687
1501
|
*_param,
|
|
@@ -695,9 +1509,9 @@ class WorkflowApi:
|
|
|
695
1509
|
|
|
696
1510
|
|
|
697
1511
|
@validate_call
|
|
698
|
-
def
|
|
1512
|
+
def workflow_workflow_id_get_without_preload_content(
|
|
699
1513
|
self,
|
|
700
|
-
workflow_id: Annotated[
|
|
1514
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get.")],
|
|
701
1515
|
_request_timeout: Union[
|
|
702
1516
|
None,
|
|
703
1517
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -711,10 +1525,10 @@ class WorkflowApi:
|
|
|
711
1525
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
712
1526
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
713
1527
|
) -> RESTResponseType:
|
|
714
|
-
"""Get
|
|
1528
|
+
"""Get a workflow by its ID.
|
|
715
1529
|
|
|
716
1530
|
|
|
717
|
-
:param workflow_id: The ID of the workflow to get
|
|
1531
|
+
:param workflow_id: The ID of the workflow to get. (required)
|
|
718
1532
|
:type workflow_id: str
|
|
719
1533
|
:param _request_timeout: timeout setting for this request. If one
|
|
720
1534
|
number provided, it will be total request
|
|
@@ -738,7 +1552,7 @@ class WorkflowApi:
|
|
|
738
1552
|
:return: Returns the result object.
|
|
739
1553
|
""" # noqa: E501
|
|
740
1554
|
|
|
741
|
-
_param = self.
|
|
1555
|
+
_param = self._workflow_workflow_id_get_serialize(
|
|
742
1556
|
workflow_id=workflow_id,
|
|
743
1557
|
_request_auth=_request_auth,
|
|
744
1558
|
_content_type=_content_type,
|
|
@@ -747,7 +1561,7 @@ class WorkflowApi:
|
|
|
747
1561
|
)
|
|
748
1562
|
|
|
749
1563
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
750
|
-
'200': "
|
|
1564
|
+
'200': "GetWorkflowByIdResult",
|
|
751
1565
|
}
|
|
752
1566
|
response_data = self.api_client.call_api(
|
|
753
1567
|
*_param,
|
|
@@ -756,7 +1570,7 @@ class WorkflowApi:
|
|
|
756
1570
|
return response_data.response
|
|
757
1571
|
|
|
758
1572
|
|
|
759
|
-
def
|
|
1573
|
+
def _workflow_workflow_id_get_serialize(
|
|
760
1574
|
self,
|
|
761
1575
|
workflow_id,
|
|
762
1576
|
_request_auth,
|
|
@@ -780,11 +1594,9 @@ class WorkflowApi:
|
|
|
780
1594
|
_body_params: Optional[bytes] = None
|
|
781
1595
|
|
|
782
1596
|
# process the path parameters
|
|
783
|
-
# process the query parameters
|
|
784
1597
|
if workflow_id is not None:
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
1598
|
+
_path_params['workflowId'] = workflow_id
|
|
1599
|
+
# process the query parameters
|
|
788
1600
|
# process the header parameters
|
|
789
1601
|
# process the form parameters
|
|
790
1602
|
# process the body parameter
|
|
@@ -809,7 +1621,7 @@ class WorkflowApi:
|
|
|
809
1621
|
|
|
810
1622
|
return self.api_client.param_serialize(
|
|
811
1623
|
method='GET',
|
|
812
|
-
resource_path='/
|
|
1624
|
+
resource_path='/workflow/{workflowId}',
|
|
813
1625
|
path_params=_path_params,
|
|
814
1626
|
query_params=_query_params,
|
|
815
1627
|
header_params=_header_params,
|
|
@@ -826,10 +1638,9 @@ class WorkflowApi:
|
|
|
826
1638
|
|
|
827
1639
|
|
|
828
1640
|
@validate_call
|
|
829
|
-
def
|
|
1641
|
+
def workflow_workflow_id_progress_get(
|
|
830
1642
|
self,
|
|
831
|
-
|
|
832
|
-
use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = None,
|
|
1643
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the progress for.")],
|
|
833
1644
|
_request_timeout: Union[
|
|
834
1645
|
None,
|
|
835
1646
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -842,14 +1653,12 @@ class WorkflowApi:
|
|
|
842
1653
|
_content_type: Optional[StrictStr] = None,
|
|
843
1654
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
844
1655
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
845
|
-
) ->
|
|
846
|
-
"""
|
|
1656
|
+
) -> GetWorkflowProgressResult:
|
|
1657
|
+
"""Get the progress of a workflow.
|
|
847
1658
|
|
|
848
1659
|
|
|
849
|
-
:param
|
|
850
|
-
:type
|
|
851
|
-
:param use_user_score: Whether to use the user score to determine the winner.
|
|
852
|
-
:type use_user_score: bool
|
|
1660
|
+
:param workflow_id: The ID of the workflow to get the progress for. (required)
|
|
1661
|
+
:type workflow_id: str
|
|
853
1662
|
:param _request_timeout: timeout setting for this request. If one
|
|
854
1663
|
number provided, it will be total request
|
|
855
1664
|
timeout. It can also be a pair (tuple) of
|
|
@@ -872,9 +1681,8 @@ class WorkflowApi:
|
|
|
872
1681
|
:return: Returns the result object.
|
|
873
1682
|
""" # noqa: E501
|
|
874
1683
|
|
|
875
|
-
_param = self.
|
|
876
|
-
|
|
877
|
-
use_user_score=use_user_score,
|
|
1684
|
+
_param = self._workflow_workflow_id_progress_get_serialize(
|
|
1685
|
+
workflow_id=workflow_id,
|
|
878
1686
|
_request_auth=_request_auth,
|
|
879
1687
|
_content_type=_content_type,
|
|
880
1688
|
_headers=_headers,
|
|
@@ -882,7 +1690,7 @@ class WorkflowApi:
|
|
|
882
1690
|
)
|
|
883
1691
|
|
|
884
1692
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
885
|
-
'200': "
|
|
1693
|
+
'200': "GetWorkflowProgressResult",
|
|
886
1694
|
}
|
|
887
1695
|
response_data = self.api_client.call_api(
|
|
888
1696
|
*_param,
|
|
@@ -896,10 +1704,9 @@ class WorkflowApi:
|
|
|
896
1704
|
|
|
897
1705
|
|
|
898
1706
|
@validate_call
|
|
899
|
-
def
|
|
1707
|
+
def workflow_workflow_id_progress_get_with_http_info(
|
|
900
1708
|
self,
|
|
901
|
-
|
|
902
|
-
use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = None,
|
|
1709
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the progress for.")],
|
|
903
1710
|
_request_timeout: Union[
|
|
904
1711
|
None,
|
|
905
1712
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -912,14 +1719,12 @@ class WorkflowApi:
|
|
|
912
1719
|
_content_type: Optional[StrictStr] = None,
|
|
913
1720
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
914
1721
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
915
|
-
) -> ApiResponse[
|
|
916
|
-
"""
|
|
1722
|
+
) -> ApiResponse[GetWorkflowProgressResult]:
|
|
1723
|
+
"""Get the progress of a workflow.
|
|
917
1724
|
|
|
918
1725
|
|
|
919
|
-
:param
|
|
920
|
-
:type
|
|
921
|
-
:param use_user_score: Whether to use the user score to determine the winner.
|
|
922
|
-
:type use_user_score: bool
|
|
1726
|
+
:param workflow_id: The ID of the workflow to get the progress for. (required)
|
|
1727
|
+
:type workflow_id: str
|
|
923
1728
|
:param _request_timeout: timeout setting for this request. If one
|
|
924
1729
|
number provided, it will be total request
|
|
925
1730
|
timeout. It can also be a pair (tuple) of
|
|
@@ -942,9 +1747,8 @@ class WorkflowApi:
|
|
|
942
1747
|
:return: Returns the result object.
|
|
943
1748
|
""" # noqa: E501
|
|
944
1749
|
|
|
945
|
-
_param = self.
|
|
946
|
-
|
|
947
|
-
use_user_score=use_user_score,
|
|
1750
|
+
_param = self._workflow_workflow_id_progress_get_serialize(
|
|
1751
|
+
workflow_id=workflow_id,
|
|
948
1752
|
_request_auth=_request_auth,
|
|
949
1753
|
_content_type=_content_type,
|
|
950
1754
|
_headers=_headers,
|
|
@@ -952,7 +1756,7 @@ class WorkflowApi:
|
|
|
952
1756
|
)
|
|
953
1757
|
|
|
954
1758
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
955
|
-
'200': "
|
|
1759
|
+
'200': "GetWorkflowProgressResult",
|
|
956
1760
|
}
|
|
957
1761
|
response_data = self.api_client.call_api(
|
|
958
1762
|
*_param,
|
|
@@ -966,10 +1770,9 @@ class WorkflowApi:
|
|
|
966
1770
|
|
|
967
1771
|
|
|
968
1772
|
@validate_call
|
|
969
|
-
def
|
|
1773
|
+
def workflow_workflow_id_progress_get_without_preload_content(
|
|
970
1774
|
self,
|
|
971
|
-
|
|
972
|
-
use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = None,
|
|
1775
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the progress for.")],
|
|
973
1776
|
_request_timeout: Union[
|
|
974
1777
|
None,
|
|
975
1778
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -983,13 +1786,11 @@ class WorkflowApi:
|
|
|
983
1786
|
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
984
1787
|
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
985
1788
|
) -> RESTResponseType:
|
|
986
|
-
"""
|
|
1789
|
+
"""Get the progress of a workflow.
|
|
987
1790
|
|
|
988
1791
|
|
|
989
|
-
:param
|
|
990
|
-
:type
|
|
991
|
-
:param use_user_score: Whether to use the user score to determine the winner.
|
|
992
|
-
:type use_user_score: bool
|
|
1792
|
+
:param workflow_id: The ID of the workflow to get the progress for. (required)
|
|
1793
|
+
:type workflow_id: str
|
|
993
1794
|
:param _request_timeout: timeout setting for this request. If one
|
|
994
1795
|
number provided, it will be total request
|
|
995
1796
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1012,9 +1813,8 @@ class WorkflowApi:
|
|
|
1012
1813
|
:return: Returns the result object.
|
|
1013
1814
|
""" # noqa: E501
|
|
1014
1815
|
|
|
1015
|
-
_param = self.
|
|
1016
|
-
|
|
1017
|
-
use_user_score=use_user_score,
|
|
1816
|
+
_param = self._workflow_workflow_id_progress_get_serialize(
|
|
1817
|
+
workflow_id=workflow_id,
|
|
1018
1818
|
_request_auth=_request_auth,
|
|
1019
1819
|
_content_type=_content_type,
|
|
1020
1820
|
_headers=_headers,
|
|
@@ -1022,7 +1822,7 @@ class WorkflowApi:
|
|
|
1022
1822
|
)
|
|
1023
1823
|
|
|
1024
1824
|
_response_types_map: Dict[str, Optional[str]] = {
|
|
1025
|
-
'200': "
|
|
1825
|
+
'200': "GetWorkflowProgressResult",
|
|
1026
1826
|
}
|
|
1027
1827
|
response_data = self.api_client.call_api(
|
|
1028
1828
|
*_param,
|
|
@@ -1031,10 +1831,9 @@ class WorkflowApi:
|
|
|
1031
1831
|
return response_data.response
|
|
1032
1832
|
|
|
1033
1833
|
|
|
1034
|
-
def
|
|
1834
|
+
def _workflow_workflow_id_progress_get_serialize(
|
|
1035
1835
|
self,
|
|
1036
|
-
|
|
1037
|
-
use_user_score,
|
|
1836
|
+
workflow_id,
|
|
1038
1837
|
_request_auth,
|
|
1039
1838
|
_content_type,
|
|
1040
1839
|
_headers,
|
|
@@ -1056,13 +1855,9 @@ class WorkflowApi:
|
|
|
1056
1855
|
_body_params: Optional[bytes] = None
|
|
1057
1856
|
|
|
1058
1857
|
# process the path parameters
|
|
1059
|
-
if
|
|
1060
|
-
_path_params['
|
|
1858
|
+
if workflow_id is not None:
|
|
1859
|
+
_path_params['workflowId'] = workflow_id
|
|
1061
1860
|
# process the query parameters
|
|
1062
|
-
if use_user_score is not None:
|
|
1063
|
-
|
|
1064
|
-
_query_params.append(('useUserScore', use_user_score))
|
|
1065
|
-
|
|
1066
1861
|
# process the header parameters
|
|
1067
1862
|
# process the form parameters
|
|
1068
1863
|
# process the body parameter
|
|
@@ -1087,7 +1882,7 @@ class WorkflowApi:
|
|
|
1087
1882
|
|
|
1088
1883
|
return self.api_client.param_serialize(
|
|
1089
1884
|
method='GET',
|
|
1090
|
-
resource_path='/workflow/{
|
|
1885
|
+
resource_path='/workflow/{workflowId}/progress',
|
|
1091
1886
|
path_params=_path_params,
|
|
1092
1887
|
query_params=_query_params,
|
|
1093
1888
|
header_params=_header_params,
|
|
@@ -1104,9 +1899,9 @@ class WorkflowApi:
|
|
|
1104
1899
|
|
|
1105
1900
|
|
|
1106
1901
|
@validate_call
|
|
1107
|
-
def
|
|
1902
|
+
def workflow_workflow_id_responses_get(
|
|
1108
1903
|
self,
|
|
1109
|
-
|
|
1904
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the responses for.")],
|
|
1110
1905
|
limit: Annotated[Optional[StrictInt], Field(description="The number of responses to get.")] = None,
|
|
1111
1906
|
sort: Annotated[Optional[SortDirection], Field(description="Whether the oldest or most recent responses should be returned.")] = None,
|
|
1112
1907
|
_request_timeout: Union[
|
|
@@ -1125,8 +1920,8 @@ class WorkflowApi:
|
|
|
1125
1920
|
"""Gets the limit most recent or oldest responses for a workflow. The responses are not guaranteed to be of any specific rapid. Instead, this endpoint returns all responses to any rapid in the workflow.
|
|
1126
1921
|
|
|
1127
1922
|
|
|
1128
|
-
:param
|
|
1129
|
-
:type
|
|
1923
|
+
:param workflow_id: The ID of the workflow to get the responses for. (required)
|
|
1924
|
+
:type workflow_id: str
|
|
1130
1925
|
:param limit: The number of responses to get.
|
|
1131
1926
|
:type limit: int
|
|
1132
1927
|
:param sort: Whether the oldest or most recent responses should be returned.
|
|
@@ -1153,8 +1948,8 @@ class WorkflowApi:
|
|
|
1153
1948
|
:return: Returns the result object.
|
|
1154
1949
|
""" # noqa: E501
|
|
1155
1950
|
|
|
1156
|
-
_param = self.
|
|
1157
|
-
|
|
1951
|
+
_param = self._workflow_workflow_id_responses_get_serialize(
|
|
1952
|
+
workflow_id=workflow_id,
|
|
1158
1953
|
limit=limit,
|
|
1159
1954
|
sort=sort,
|
|
1160
1955
|
_request_auth=_request_auth,
|
|
@@ -1178,9 +1973,9 @@ class WorkflowApi:
|
|
|
1178
1973
|
|
|
1179
1974
|
|
|
1180
1975
|
@validate_call
|
|
1181
|
-
def
|
|
1976
|
+
def workflow_workflow_id_responses_get_with_http_info(
|
|
1182
1977
|
self,
|
|
1183
|
-
|
|
1978
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the responses for.")],
|
|
1184
1979
|
limit: Annotated[Optional[StrictInt], Field(description="The number of responses to get.")] = None,
|
|
1185
1980
|
sort: Annotated[Optional[SortDirection], Field(description="Whether the oldest or most recent responses should be returned.")] = None,
|
|
1186
1981
|
_request_timeout: Union[
|
|
@@ -1199,8 +1994,8 @@ class WorkflowApi:
|
|
|
1199
1994
|
"""Gets the limit most recent or oldest responses for a workflow. The responses are not guaranteed to be of any specific rapid. Instead, this endpoint returns all responses to any rapid in the workflow.
|
|
1200
1995
|
|
|
1201
1996
|
|
|
1202
|
-
:param
|
|
1203
|
-
:type
|
|
1997
|
+
:param workflow_id: The ID of the workflow to get the responses for. (required)
|
|
1998
|
+
:type workflow_id: str
|
|
1204
1999
|
:param limit: The number of responses to get.
|
|
1205
2000
|
:type limit: int
|
|
1206
2001
|
:param sort: Whether the oldest or most recent responses should be returned.
|
|
@@ -1227,8 +2022,8 @@ class WorkflowApi:
|
|
|
1227
2022
|
:return: Returns the result object.
|
|
1228
2023
|
""" # noqa: E501
|
|
1229
2024
|
|
|
1230
|
-
_param = self.
|
|
1231
|
-
|
|
2025
|
+
_param = self._workflow_workflow_id_responses_get_serialize(
|
|
2026
|
+
workflow_id=workflow_id,
|
|
1232
2027
|
limit=limit,
|
|
1233
2028
|
sort=sort,
|
|
1234
2029
|
_request_auth=_request_auth,
|
|
@@ -1252,9 +2047,9 @@ class WorkflowApi:
|
|
|
1252
2047
|
|
|
1253
2048
|
|
|
1254
2049
|
@validate_call
|
|
1255
|
-
def
|
|
2050
|
+
def workflow_workflow_id_responses_get_without_preload_content(
|
|
1256
2051
|
self,
|
|
1257
|
-
|
|
2052
|
+
workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the responses for.")],
|
|
1258
2053
|
limit: Annotated[Optional[StrictInt], Field(description="The number of responses to get.")] = None,
|
|
1259
2054
|
sort: Annotated[Optional[SortDirection], Field(description="Whether the oldest or most recent responses should be returned.")] = None,
|
|
1260
2055
|
_request_timeout: Union[
|
|
@@ -1273,8 +2068,8 @@ class WorkflowApi:
|
|
|
1273
2068
|
"""Gets the limit most recent or oldest responses for a workflow. The responses are not guaranteed to be of any specific rapid. Instead, this endpoint returns all responses to any rapid in the workflow.
|
|
1274
2069
|
|
|
1275
2070
|
|
|
1276
|
-
:param
|
|
1277
|
-
:type
|
|
2071
|
+
:param workflow_id: The ID of the workflow to get the responses for. (required)
|
|
2072
|
+
:type workflow_id: str
|
|
1278
2073
|
:param limit: The number of responses to get.
|
|
1279
2074
|
:type limit: int
|
|
1280
2075
|
:param sort: Whether the oldest or most recent responses should be returned.
|
|
@@ -1301,8 +2096,8 @@ class WorkflowApi:
|
|
|
1301
2096
|
:return: Returns the result object.
|
|
1302
2097
|
""" # noqa: E501
|
|
1303
2098
|
|
|
1304
|
-
_param = self.
|
|
1305
|
-
|
|
2099
|
+
_param = self._workflow_workflow_id_responses_get_serialize(
|
|
2100
|
+
workflow_id=workflow_id,
|
|
1306
2101
|
limit=limit,
|
|
1307
2102
|
sort=sort,
|
|
1308
2103
|
_request_auth=_request_auth,
|
|
@@ -1321,9 +2116,9 @@ class WorkflowApi:
|
|
|
1321
2116
|
return response_data.response
|
|
1322
2117
|
|
|
1323
2118
|
|
|
1324
|
-
def
|
|
2119
|
+
def _workflow_workflow_id_responses_get_serialize(
|
|
1325
2120
|
self,
|
|
1326
|
-
|
|
2121
|
+
workflow_id,
|
|
1327
2122
|
limit,
|
|
1328
2123
|
sort,
|
|
1329
2124
|
_request_auth,
|
|
@@ -1347,8 +2142,8 @@ class WorkflowApi:
|
|
|
1347
2142
|
_body_params: Optional[bytes] = None
|
|
1348
2143
|
|
|
1349
2144
|
# process the path parameters
|
|
1350
|
-
if
|
|
1351
|
-
_path_params['
|
|
2145
|
+
if workflow_id is not None:
|
|
2146
|
+
_path_params['workflowId'] = workflow_id
|
|
1352
2147
|
# process the query parameters
|
|
1353
2148
|
if limit is not None:
|
|
1354
2149
|
|
|
@@ -1382,7 +2177,7 @@ class WorkflowApi:
|
|
|
1382
2177
|
|
|
1383
2178
|
return self.api_client.param_serialize(
|
|
1384
2179
|
method='GET',
|
|
1385
|
-
resource_path='/workflow/{
|
|
2180
|
+
resource_path='/workflow/{workflowId}/responses',
|
|
1386
2181
|
path_params=_path_params,
|
|
1387
2182
|
query_params=_query_params,
|
|
1388
2183
|
header_params=_header_params,
|
|
@@ -1399,9 +2194,9 @@ class WorkflowApi:
|
|
|
1399
2194
|
|
|
1400
2195
|
|
|
1401
2196
|
@validate_call
|
|
1402
|
-
def
|
|
2197
|
+
def workflows_get(
|
|
1403
2198
|
self,
|
|
1404
|
-
request: Annotated[Optional[
|
|
2199
|
+
request: Annotated[Optional[QueryModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
|
|
1405
2200
|
_request_timeout: Union[
|
|
1406
2201
|
None,
|
|
1407
2202
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -1419,7 +2214,7 @@ class WorkflowApi:
|
|
|
1419
2214
|
|
|
1420
2215
|
|
|
1421
2216
|
:param request: The model containing the filter, page, and sort criteria.
|
|
1422
|
-
:type request:
|
|
2217
|
+
:type request: QueryModel
|
|
1423
2218
|
:param _request_timeout: timeout setting for this request. If one
|
|
1424
2219
|
number provided, it will be total request
|
|
1425
2220
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1442,7 +2237,7 @@ class WorkflowApi:
|
|
|
1442
2237
|
:return: Returns the result object.
|
|
1443
2238
|
""" # noqa: E501
|
|
1444
2239
|
|
|
1445
|
-
_param = self.
|
|
2240
|
+
_param = self._workflows_get_serialize(
|
|
1446
2241
|
request=request,
|
|
1447
2242
|
_request_auth=_request_auth,
|
|
1448
2243
|
_content_type=_content_type,
|
|
@@ -1465,9 +2260,9 @@ class WorkflowApi:
|
|
|
1465
2260
|
|
|
1466
2261
|
|
|
1467
2262
|
@validate_call
|
|
1468
|
-
def
|
|
2263
|
+
def workflows_get_with_http_info(
|
|
1469
2264
|
self,
|
|
1470
|
-
request: Annotated[Optional[
|
|
2265
|
+
request: Annotated[Optional[QueryModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
|
|
1471
2266
|
_request_timeout: Union[
|
|
1472
2267
|
None,
|
|
1473
2268
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -1485,7 +2280,7 @@ class WorkflowApi:
|
|
|
1485
2280
|
|
|
1486
2281
|
|
|
1487
2282
|
:param request: The model containing the filter, page, and sort criteria.
|
|
1488
|
-
:type request:
|
|
2283
|
+
:type request: QueryModel
|
|
1489
2284
|
:param _request_timeout: timeout setting for this request. If one
|
|
1490
2285
|
number provided, it will be total request
|
|
1491
2286
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1508,7 +2303,7 @@ class WorkflowApi:
|
|
|
1508
2303
|
:return: Returns the result object.
|
|
1509
2304
|
""" # noqa: E501
|
|
1510
2305
|
|
|
1511
|
-
_param = self.
|
|
2306
|
+
_param = self._workflows_get_serialize(
|
|
1512
2307
|
request=request,
|
|
1513
2308
|
_request_auth=_request_auth,
|
|
1514
2309
|
_content_type=_content_type,
|
|
@@ -1531,9 +2326,9 @@ class WorkflowApi:
|
|
|
1531
2326
|
|
|
1532
2327
|
|
|
1533
2328
|
@validate_call
|
|
1534
|
-
def
|
|
2329
|
+
def workflows_get_without_preload_content(
|
|
1535
2330
|
self,
|
|
1536
|
-
request: Annotated[Optional[
|
|
2331
|
+
request: Annotated[Optional[QueryModel], Field(description="The model containing the filter, page, and sort criteria.")] = None,
|
|
1537
2332
|
_request_timeout: Union[
|
|
1538
2333
|
None,
|
|
1539
2334
|
Annotated[StrictFloat, Field(gt=0)],
|
|
@@ -1551,7 +2346,7 @@ class WorkflowApi:
|
|
|
1551
2346
|
|
|
1552
2347
|
|
|
1553
2348
|
:param request: The model containing the filter, page, and sort criteria.
|
|
1554
|
-
:type request:
|
|
2349
|
+
:type request: QueryModel
|
|
1555
2350
|
:param _request_timeout: timeout setting for this request. If one
|
|
1556
2351
|
number provided, it will be total request
|
|
1557
2352
|
timeout. It can also be a pair (tuple) of
|
|
@@ -1574,7 +2369,7 @@ class WorkflowApi:
|
|
|
1574
2369
|
:return: Returns the result object.
|
|
1575
2370
|
""" # noqa: E501
|
|
1576
2371
|
|
|
1577
|
-
_param = self.
|
|
2372
|
+
_param = self._workflows_get_serialize(
|
|
1578
2373
|
request=request,
|
|
1579
2374
|
_request_auth=_request_auth,
|
|
1580
2375
|
_content_type=_content_type,
|
|
@@ -1592,7 +2387,7 @@ class WorkflowApi:
|
|
|
1592
2387
|
return response_data.response
|
|
1593
2388
|
|
|
1594
2389
|
|
|
1595
|
-
def
|
|
2390
|
+
def _workflows_get_serialize(
|
|
1596
2391
|
self,
|
|
1597
2392
|
request,
|
|
1598
2393
|
_request_auth,
|
|
@@ -1645,7 +2440,7 @@ class WorkflowApi:
|
|
|
1645
2440
|
|
|
1646
2441
|
return self.api_client.param_serialize(
|
|
1647
2442
|
method='GET',
|
|
1648
|
-
resource_path='/
|
|
2443
|
+
resource_path='/workflows',
|
|
1649
2444
|
path_params=_path_params,
|
|
1650
2445
|
query_params=_query_params,
|
|
1651
2446
|
header_params=_header_params,
|