rapidata 0.3.0__py3-none-any.whl → 0.4.1__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.
Files changed (72) hide show
  1. rapidata/__init__.py +18 -1
  2. rapidata/api_client/__init__.py +29 -3
  3. rapidata/api_client/api/__init__.py +3 -0
  4. rapidata/api_client/api/compare_workflow_api.py +316 -0
  5. rapidata/api_client/api/dataset_api.py +24 -24
  6. rapidata/api_client/api/order_api.py +515 -289
  7. rapidata/api_client/api/rapid_api.py +6 -6
  8. rapidata/api_client/api/simple_workflow_api.py +350 -0
  9. rapidata/api_client/api/validation_api.py +6 -6
  10. rapidata/api_client/api/workflow_api.py +2386 -0
  11. rapidata/api_client/api_client.py +2 -2
  12. rapidata/api_client/models/__init__.py +26 -3
  13. rapidata/api_client/models/admin_order_model.py +8 -1
  14. rapidata/api_client/models/age_group.py +1 -1
  15. rapidata/api_client/models/age_user_filter_model.py +2 -2
  16. rapidata/api_client/models/campaign_user_filter_model.py +2 -2
  17. rapidata/api_client/models/compare_workflow_get_result_overview_get200_response.py +137 -0
  18. rapidata/api_client/models/compare_workflow_model1.py +146 -0
  19. rapidata/api_client/models/completed_rapid_model.py +103 -0
  20. rapidata/api_client/models/country_user_filter_model.py +2 -2
  21. rapidata/api_client/models/create_demographic_rapid_model.py +3 -3
  22. rapidata/api_client/models/create_independent_workflow_model.py +93 -0
  23. rapidata/api_client/models/create_independent_workflow_model_workflow_config.py +140 -0
  24. rapidata/api_client/models/create_independent_workflow_result.py +89 -0
  25. rapidata/api_client/models/create_order_model.py +40 -31
  26. rapidata/api_client/models/create_order_model_selections_inner.py +24 -10
  27. rapidata/api_client/models/create_order_model_user_filters_inner.py +35 -35
  28. rapidata/api_client/models/customer_order_model.py +8 -1
  29. rapidata/api_client/models/demographic_rapid_selection_config.py +3 -3
  30. rapidata/api_client/models/demographic_selection.py +4 -4
  31. rapidata/api_client/models/feedback_model.py +1 -1
  32. rapidata/api_client/models/gender.py +1 -1
  33. rapidata/api_client/models/gender_user_filter_model.py +2 -2
  34. rapidata/api_client/models/get_attach_category_workflow_result_overview_result.py +144 -0
  35. rapidata/api_client/models/get_compare_workflow_result_overview_result.py +125 -0
  36. rapidata/api_client/models/get_compare_workflow_result_overview_small_result.py +114 -0
  37. rapidata/api_client/models/get_simple_workflow_result_overview_result.py +142 -0
  38. rapidata/api_client/models/get_workflow_by_id_result.py +91 -0
  39. rapidata/api_client/models/get_workflow_by_id_result_workflow.py +140 -0
  40. rapidata/api_client/models/get_workflow_progress_result.py +100 -0
  41. rapidata/api_client/models/get_workflow_result_overview_result.py +104 -0
  42. rapidata/api_client/models/i_workflow_model_paged_result.py +105 -0
  43. rapidata/api_client/models/in_progress_rapid_model.py +103 -0
  44. rapidata/api_client/models/labeling_selection.py +2 -2
  45. rapidata/api_client/models/language_user_filter_model.py +2 -2
  46. rapidata/api_client/models/not_started_rapid_model.py +93 -0
  47. rapidata/api_client/models/order_state.py +43 -0
  48. rapidata/api_client/models/query_workflows_model.py +112 -0
  49. rapidata/api_client/models/ranked_datapoint_model.py +95 -0
  50. rapidata/api_client/models/rapid_answer.py +97 -0
  51. rapidata/api_client/models/rapid_answer_result.py +252 -0
  52. rapidata/api_client/models/simple_workflow_get_result_overview_get200_response.py +137 -0
  53. rapidata/api_client/models/simple_workflow_model1.py +140 -0
  54. rapidata/api_client/models/static_selection.py +96 -0
  55. rapidata/api_client/models/user_score_user_filter_model.py +3 -3
  56. rapidata/api_client/models/validation_selection.py +3 -3
  57. rapidata/api_client/models/workflow_state.py +41 -0
  58. rapidata/api_client/rest.py +1 -1
  59. rapidata/api_client_README.md +44 -8
  60. rapidata/rapidata_client/__init__.py +7 -1
  61. rapidata/rapidata_client/country_codes/__init__.py +1 -1
  62. rapidata/rapidata_client/feature_flags/__init__.py +1 -1
  63. rapidata/rapidata_client/metadata/__init__.py +5 -0
  64. rapidata/rapidata_client/order/rapidata_order_builder.py +20 -2
  65. rapidata/rapidata_client/rapidata_client.py +22 -0
  66. rapidata/rapidata_client/referee/__init__.py +3 -3
  67. rapidata/rapidata_client/selection/__init__.py +4 -0
  68. rapidata/rapidata_client/workflow/__init__.py +5 -4
  69. {rapidata-0.3.0.dist-info → rapidata-0.4.1.dist-info}/METADATA +1 -1
  70. {rapidata-0.3.0.dist-info → rapidata-0.4.1.dist-info}/RECORD +72 -43
  71. {rapidata-0.3.0.dist-info → rapidata-0.4.1.dist-info}/LICENSE +0 -0
  72. {rapidata-0.3.0.dist-info → rapidata-0.4.1.dist-info}/WHEEL +0 -0
rapidata/__init__.py CHANGED
@@ -1 +1,18 @@
1
- from rapidata.rapidata_client import RapidataClient
1
+ from .rapidata_client import (
2
+ RapidataClient,
3
+ ClassifyWorkflow,
4
+ TranscriptionWorkflow,
5
+ CompareWorkflow,
6
+ FreeTextWorkflow,
7
+ DemographicSelection,
8
+ LabelingSelection,
9
+ ValidationSelection,
10
+ NaiveReferee,
11
+ ClassifyEarlyStoppingReferee,
12
+ PrivateTextMetadata,
13
+ PublicTextMetadata,
14
+ PromptMetadata,
15
+ TranscriptionMetadata,
16
+ FeatureFlags,
17
+ CountryCodes
18
+ )
@@ -18,13 +18,16 @@ __version__ = "1.0.0"
18
18
 
19
19
  # import apis into sdk package
20
20
  from rapidata.api_client.api.coco_api import CocoApi
21
+ from rapidata.api_client.api.compare_workflow_api import CompareWorkflowApi
21
22
  from rapidata.api_client.api.datapoint_api import DatapointApi
22
23
  from rapidata.api_client.api.dataset_api import DatasetApi
23
24
  from rapidata.api_client.api.identity_api import IdentityApi
24
25
  from rapidata.api_client.api.newsletter_api import NewsletterApi
25
26
  from rapidata.api_client.api.order_api import OrderApi
26
27
  from rapidata.api_client.api.rapid_api import RapidApi
28
+ from rapidata.api_client.api.simple_workflow_api import SimpleWorkflowApi
27
29
  from rapidata.api_client.api.validation_api import ValidationApi
30
+ from rapidata.api_client.api.workflow_api import WorkflowApi
28
31
 
29
32
  # import ApiClient
30
33
  from rapidata.api_client.api_response import ApiResponse
@@ -70,7 +73,10 @@ from rapidata.api_client.models.compare_truth import CompareTruth
70
73
  from rapidata.api_client.models.compare_workflow_config import CompareWorkflowConfig
71
74
  from rapidata.api_client.models.compare_workflow_config_rapid_selection_configs_inner import CompareWorkflowConfigRapidSelectionConfigsInner
72
75
  from rapidata.api_client.models.compare_workflow_config_referee import CompareWorkflowConfigReferee
76
+ from rapidata.api_client.models.compare_workflow_get_result_overview_get200_response import CompareWorkflowGetResultOverviewGet200Response
73
77
  from rapidata.api_client.models.compare_workflow_model import CompareWorkflowModel
78
+ from rapidata.api_client.models.compare_workflow_model1 import CompareWorkflowModel1
79
+ from rapidata.api_client.models.completed_rapid_model import CompletedRapidModel
74
80
  from rapidata.api_client.models.conditional_validation_rapid_selection_config import ConditionalValidationRapidSelectionConfig
75
81
  from rapidata.api_client.models.coordinate import Coordinate
76
82
  from rapidata.api_client.models.correlated_rapid_selection_config import CorrelatedRapidSelectionConfig
@@ -83,11 +89,11 @@ from rapidata.api_client.models.create_complex_order_model_pipeline import Creat
83
89
  from rapidata.api_client.models.create_complex_order_result import CreateComplexOrderResult
84
90
  from rapidata.api_client.models.create_dataset_artifact_model import CreateDatasetArtifactModel
85
91
  from rapidata.api_client.models.create_dataset_artifact_model_dataset import CreateDatasetArtifactModelDataset
86
- from rapidata.api_client.models.create_default_order_model import CreateDefaultOrderModel
87
- from rapidata.api_client.models.create_default_order_model_workflow_config import CreateDefaultOrderModelWorkflowConfig
88
92
  from rapidata.api_client.models.create_demographic_rapid_model import CreateDemographicRapidModel
89
93
  from rapidata.api_client.models.create_empty_validation_set_result import CreateEmptyValidationSetResult
90
- from rapidata.api_client.models.create_legacy_order_result import CreateLegacyOrderResult
94
+ from rapidata.api_client.models.create_independent_workflow_model import CreateIndependentWorkflowModel
95
+ from rapidata.api_client.models.create_independent_workflow_model_workflow_config import CreateIndependentWorkflowModelWorkflowConfig
96
+ from rapidata.api_client.models.create_independent_workflow_result import CreateIndependentWorkflowResult
91
97
  from rapidata.api_client.models.create_order_model import CreateOrderModel
92
98
  from rapidata.api_client.models.create_order_model_referee import CreateOrderModelReferee
93
99
  from rapidata.api_client.models.create_order_model_selections_inner import CreateOrderModelSelectionsInner
@@ -126,17 +132,27 @@ from rapidata.api_client.models.free_text_rapid_blueprint import FreeTextRapidBl
126
132
  from rapidata.api_client.models.free_text_result import FreeTextResult
127
133
  from rapidata.api_client.models.gender import Gender
128
134
  from rapidata.api_client.models.gender_user_filter_model import GenderUserFilterModel
135
+ from rapidata.api_client.models.get_attach_category_workflow_result_overview_result import GetAttachCategoryWorkflowResultOverviewResult
129
136
  from rapidata.api_client.models.get_available_validation_sets_result import GetAvailableValidationSetsResult
137
+ from rapidata.api_client.models.get_compare_workflow_result_overview_result import GetCompareWorkflowResultOverviewResult
138
+ from rapidata.api_client.models.get_compare_workflow_result_overview_small_result import GetCompareWorkflowResultOverviewSmallResult
130
139
  from rapidata.api_client.models.get_datapoints_by_dataset_id_result import GetDatapointsByDatasetIdResult
131
140
  from rapidata.api_client.models.get_dataset_by_id_result import GetDatasetByIdResult
132
141
  from rapidata.api_client.models.get_order_by_id_result import GetOrderByIdResult
133
142
  from rapidata.api_client.models.get_order_results_result import GetOrderResultsResult
134
143
  from rapidata.api_client.models.get_public_orders_result import GetPublicOrdersResult
144
+ from rapidata.api_client.models.get_simple_workflow_result_overview_result import GetSimpleWorkflowResultOverviewResult
145
+ from rapidata.api_client.models.get_workflow_by_id_result import GetWorkflowByIdResult
146
+ from rapidata.api_client.models.get_workflow_by_id_result_workflow import GetWorkflowByIdResultWorkflow
135
147
  from rapidata.api_client.models.get_workflow_config_result import GetWorkflowConfigResult
136
148
  from rapidata.api_client.models.get_workflow_config_result_workflow_config import GetWorkflowConfigResultWorkflowConfig
149
+ from rapidata.api_client.models.get_workflow_progress_result import GetWorkflowProgressResult
150
+ from rapidata.api_client.models.get_workflow_result_overview_result import GetWorkflowResultOverviewResult
151
+ from rapidata.api_client.models.i_workflow_model_paged_result import IWorkflowModelPagedResult
137
152
  from rapidata.api_client.models.image_dimension_metadata import ImageDimensionMetadata
138
153
  from rapidata.api_client.models.import_from_file_result import ImportFromFileResult
139
154
  from rapidata.api_client.models.import_validation_set_from_file_result import ImportValidationSetFromFileResult
155
+ from rapidata.api_client.models.in_progress_rapid_model import InProgressRapidModel
140
156
  from rapidata.api_client.models.issue_auth_token_result import IssueAuthTokenResult
141
157
  from rapidata.api_client.models.issue_client_auth_token_result import IssueClientAuthTokenResult
142
158
  from rapidata.api_client.models.labeling_selection import LabelingSelection
@@ -169,11 +185,13 @@ from rapidata.api_client.models.named_entity_truth import NamedEntityTruth
169
185
  from rapidata.api_client.models.never_ending_referee_config import NeverEndingRefereeConfig
170
186
  from rapidata.api_client.models.newsletter_model import NewsletterModel
171
187
  from rapidata.api_client.models.no_validation_workflow_rapid_selection_config import NoValidationWorkflowRapidSelectionConfig
188
+ from rapidata.api_client.models.not_started_rapid_model import NotStartedRapidModel
172
189
  from rapidata.api_client.models.null_asset import NullAsset
173
190
  from rapidata.api_client.models.null_asset_model import NullAssetModel
174
191
  from rapidata.api_client.models.only_validation_workflow_rapid_selection_config import OnlyValidationWorkflowRapidSelectionConfig
175
192
  from rapidata.api_client.models.order_model import OrderModel
176
193
  from rapidata.api_client.models.order_query_get200_response import OrderQueryGet200Response
194
+ from rapidata.api_client.models.order_state import OrderState
177
195
  from rapidata.api_client.models.original_filename_metadata import OriginalFilenameMetadata
178
196
  from rapidata.api_client.models.page_info import PageInfo
179
197
  from rapidata.api_client.models.polygon_payload import PolygonPayload
@@ -191,6 +209,10 @@ from rapidata.api_client.models.query_validation_rapids_result import QueryValid
191
209
  from rapidata.api_client.models.query_validation_rapids_result_asset import QueryValidationRapidsResultAsset
192
210
  from rapidata.api_client.models.query_validation_rapids_result_paged_result import QueryValidationRapidsResultPagedResult
193
211
  from rapidata.api_client.models.query_validation_set_model import QueryValidationSetModel
212
+ from rapidata.api_client.models.query_workflows_model import QueryWorkflowsModel
213
+ from rapidata.api_client.models.ranked_datapoint_model import RankedDatapointModel
214
+ from rapidata.api_client.models.rapid_answer import RapidAnswer
215
+ from rapidata.api_client.models.rapid_answer_result import RapidAnswerResult
194
216
  from rapidata.api_client.models.rapid_result_model import RapidResultModel
195
217
  from rapidata.api_client.models.rapid_result_model_result import RapidResultModelResult
196
218
  from rapidata.api_client.models.rapid_skipped_model import RapidSkippedModel
@@ -202,12 +224,15 @@ from rapidata.api_client.models.signup_customer_model import SignupCustomerModel
202
224
  from rapidata.api_client.models.signup_shadow_customer_model import SignupShadowCustomerModel
203
225
  from rapidata.api_client.models.simple_workflow_config import SimpleWorkflowConfig
204
226
  from rapidata.api_client.models.simple_workflow_config_blueprint import SimpleWorkflowConfigBlueprint
227
+ from rapidata.api_client.models.simple_workflow_get_result_overview_get200_response import SimpleWorkflowGetResultOverviewGet200Response
205
228
  from rapidata.api_client.models.simple_workflow_model import SimpleWorkflowModel
229
+ from rapidata.api_client.models.simple_workflow_model1 import SimpleWorkflowModel1
206
230
  from rapidata.api_client.models.simple_workflow_model_blueprint import SimpleWorkflowModelBlueprint
207
231
  from rapidata.api_client.models.skip_result import SkipResult
208
232
  from rapidata.api_client.models.sort_criterion import SortCriterion
209
233
  from rapidata.api_client.models.sort_direction import SortDirection
210
234
  from rapidata.api_client.models.static_rapid_selection_config import StaticRapidSelectionConfig
235
+ from rapidata.api_client.models.static_selection import StaticSelection
211
236
  from rapidata.api_client.models.submit_coco_model import SubmitCocoModel
212
237
  from rapidata.api_client.models.submit_coco_result import SubmitCocoResult
213
238
  from rapidata.api_client.models.submit_password_reset_command import SubmitPasswordResetCommand
@@ -242,3 +267,4 @@ from rapidata.api_client.models.workflow_aggregation_step_model import WorkflowA
242
267
  from rapidata.api_client.models.workflow_labeling_step_model import WorkflowLabelingStepModel
243
268
  from rapidata.api_client.models.workflow_split_model import WorkflowSplitModel
244
269
  from rapidata.api_client.models.workflow_split_model_filter_configs_inner import WorkflowSplitModelFilterConfigsInner
270
+ from rapidata.api_client.models.workflow_state import WorkflowState
@@ -2,11 +2,14 @@
2
2
 
3
3
  # import apis into api package
4
4
  from rapidata.api_client.api.coco_api import CocoApi
5
+ from rapidata.api_client.api.compare_workflow_api import CompareWorkflowApi
5
6
  from rapidata.api_client.api.datapoint_api import DatapointApi
6
7
  from rapidata.api_client.api.dataset_api import DatasetApi
7
8
  from rapidata.api_client.api.identity_api import IdentityApi
8
9
  from rapidata.api_client.api.newsletter_api import NewsletterApi
9
10
  from rapidata.api_client.api.order_api import OrderApi
10
11
  from rapidata.api_client.api.rapid_api import RapidApi
12
+ from rapidata.api_client.api.simple_workflow_api import SimpleWorkflowApi
11
13
  from rapidata.api_client.api.validation_api import ValidationApi
14
+ from rapidata.api_client.api.workflow_api import WorkflowApi
12
15
 
@@ -0,0 +1,316 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Rapidata.Dataset
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: v1
9
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
10
+
11
+ Do not edit the class manually.
12
+ """ # noqa: E501
13
+
14
+ import warnings
15
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
+ from typing import Any, Dict, List, Optional, Tuple, Union
17
+ from typing_extensions import Annotated
18
+
19
+ from pydantic import Field, StrictInt, StrictStr
20
+ from typing import Optional
21
+ from typing_extensions import Annotated
22
+ from rapidata.api_client.models.compare_workflow_get_result_overview_get200_response import CompareWorkflowGetResultOverviewGet200Response
23
+
24
+ from rapidata.api_client.api_client import ApiClient, RequestSerialized
25
+ from rapidata.api_client.api_response import ApiResponse
26
+ from rapidata.api_client.rest import RESTResponseType
27
+
28
+
29
+ class CompareWorkflowApi:
30
+ """NOTE: This class is auto generated by OpenAPI Generator
31
+ Ref: https://openapi-generator.tech
32
+
33
+ Do not edit the class manually.
34
+ """
35
+
36
+ def __init__(self, api_client=None) -> None:
37
+ if api_client is None:
38
+ api_client = ApiClient.get_default()
39
+ self.api_client = api_client
40
+
41
+
42
+ @validate_call
43
+ def compare_workflow_get_result_overview_get(
44
+ self,
45
+ workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow.")],
46
+ display_count: Annotated[Optional[StrictInt], Field(description="The number of datapoints to return.")] = None,
47
+ _request_timeout: Union[
48
+ None,
49
+ Annotated[StrictFloat, Field(gt=0)],
50
+ Tuple[
51
+ Annotated[StrictFloat, Field(gt=0)],
52
+ Annotated[StrictFloat, Field(gt=0)]
53
+ ]
54
+ ] = None,
55
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
56
+ _content_type: Optional[StrictStr] = None,
57
+ _headers: Optional[Dict[StrictStr, Any]] = None,
58
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
59
+ ) -> CompareWorkflowGetResultOverviewGet200Response:
60
+ """Get the result overview for a compare workflow.
61
+
62
+
63
+ :param workflow_id: The ID of the workflow. (required)
64
+ :type workflow_id: str
65
+ :param display_count: The number of datapoints to return.
66
+ :type display_count: int
67
+ :param _request_timeout: timeout setting for this request. If one
68
+ number provided, it will be total request
69
+ timeout. It can also be a pair (tuple) of
70
+ (connection, read) timeouts.
71
+ :type _request_timeout: int, tuple(int, int), optional
72
+ :param _request_auth: set to override the auth_settings for an a single
73
+ request; this effectively ignores the
74
+ authentication in the spec for a single request.
75
+ :type _request_auth: dict, optional
76
+ :param _content_type: force content-type for the request.
77
+ :type _content_type: str, Optional
78
+ :param _headers: set to override the headers for a single
79
+ request; this effectively ignores the headers
80
+ in the spec for a single request.
81
+ :type _headers: dict, optional
82
+ :param _host_index: set to override the host_index for a single
83
+ request; this effectively ignores the host_index
84
+ in the spec for a single request.
85
+ :type _host_index: int, optional
86
+ :return: Returns the result object.
87
+ """ # noqa: E501
88
+
89
+ _param = self._compare_workflow_get_result_overview_get_serialize(
90
+ workflow_id=workflow_id,
91
+ display_count=display_count,
92
+ _request_auth=_request_auth,
93
+ _content_type=_content_type,
94
+ _headers=_headers,
95
+ _host_index=_host_index
96
+ )
97
+
98
+ _response_types_map: Dict[str, Optional[str]] = {
99
+ '200': "CompareWorkflowGetResultOverviewGet200Response",
100
+ }
101
+ response_data = self.api_client.call_api(
102
+ *_param,
103
+ _request_timeout=_request_timeout
104
+ )
105
+ response_data.read()
106
+ return self.api_client.response_deserialize(
107
+ response_data=response_data,
108
+ response_types_map=_response_types_map,
109
+ ).data
110
+
111
+
112
+ @validate_call
113
+ def compare_workflow_get_result_overview_get_with_http_info(
114
+ self,
115
+ workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow.")],
116
+ display_count: Annotated[Optional[StrictInt], Field(description="The number of datapoints to return.")] = None,
117
+ _request_timeout: Union[
118
+ None,
119
+ Annotated[StrictFloat, Field(gt=0)],
120
+ Tuple[
121
+ Annotated[StrictFloat, Field(gt=0)],
122
+ Annotated[StrictFloat, Field(gt=0)]
123
+ ]
124
+ ] = None,
125
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
126
+ _content_type: Optional[StrictStr] = None,
127
+ _headers: Optional[Dict[StrictStr, Any]] = None,
128
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
129
+ ) -> ApiResponse[CompareWorkflowGetResultOverviewGet200Response]:
130
+ """Get the result overview for a compare workflow.
131
+
132
+
133
+ :param workflow_id: The ID of the workflow. (required)
134
+ :type workflow_id: str
135
+ :param display_count: The number of datapoints to return.
136
+ :type display_count: int
137
+ :param _request_timeout: timeout setting for this request. If one
138
+ number provided, it will be total request
139
+ timeout. It can also be a pair (tuple) of
140
+ (connection, read) timeouts.
141
+ :type _request_timeout: int, tuple(int, int), optional
142
+ :param _request_auth: set to override the auth_settings for an a single
143
+ request; this effectively ignores the
144
+ authentication in the spec for a single request.
145
+ :type _request_auth: dict, optional
146
+ :param _content_type: force content-type for the request.
147
+ :type _content_type: str, Optional
148
+ :param _headers: set to override the headers for a single
149
+ request; this effectively ignores the headers
150
+ in the spec for a single request.
151
+ :type _headers: dict, optional
152
+ :param _host_index: set to override the host_index for a single
153
+ request; this effectively ignores the host_index
154
+ in the spec for a single request.
155
+ :type _host_index: int, optional
156
+ :return: Returns the result object.
157
+ """ # noqa: E501
158
+
159
+ _param = self._compare_workflow_get_result_overview_get_serialize(
160
+ workflow_id=workflow_id,
161
+ display_count=display_count,
162
+ _request_auth=_request_auth,
163
+ _content_type=_content_type,
164
+ _headers=_headers,
165
+ _host_index=_host_index
166
+ )
167
+
168
+ _response_types_map: Dict[str, Optional[str]] = {
169
+ '200': "CompareWorkflowGetResultOverviewGet200Response",
170
+ }
171
+ response_data = self.api_client.call_api(
172
+ *_param,
173
+ _request_timeout=_request_timeout
174
+ )
175
+ response_data.read()
176
+ return self.api_client.response_deserialize(
177
+ response_data=response_data,
178
+ response_types_map=_response_types_map,
179
+ )
180
+
181
+
182
+ @validate_call
183
+ def compare_workflow_get_result_overview_get_without_preload_content(
184
+ self,
185
+ workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow.")],
186
+ display_count: Annotated[Optional[StrictInt], Field(description="The number of datapoints to return.")] = None,
187
+ _request_timeout: Union[
188
+ None,
189
+ Annotated[StrictFloat, Field(gt=0)],
190
+ Tuple[
191
+ Annotated[StrictFloat, Field(gt=0)],
192
+ Annotated[StrictFloat, Field(gt=0)]
193
+ ]
194
+ ] = None,
195
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
196
+ _content_type: Optional[StrictStr] = None,
197
+ _headers: Optional[Dict[StrictStr, Any]] = None,
198
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
199
+ ) -> RESTResponseType:
200
+ """Get the result overview for a compare workflow.
201
+
202
+
203
+ :param workflow_id: The ID of the workflow. (required)
204
+ :type workflow_id: str
205
+ :param display_count: The number of datapoints to return.
206
+ :type display_count: int
207
+ :param _request_timeout: timeout setting for this request. If one
208
+ number provided, it will be total request
209
+ timeout. It can also be a pair (tuple) of
210
+ (connection, read) timeouts.
211
+ :type _request_timeout: int, tuple(int, int), optional
212
+ :param _request_auth: set to override the auth_settings for an a single
213
+ request; this effectively ignores the
214
+ authentication in the spec for a single request.
215
+ :type _request_auth: dict, optional
216
+ :param _content_type: force content-type for the request.
217
+ :type _content_type: str, Optional
218
+ :param _headers: set to override the headers for a single
219
+ request; this effectively ignores the headers
220
+ in the spec for a single request.
221
+ :type _headers: dict, optional
222
+ :param _host_index: set to override the host_index for a single
223
+ request; this effectively ignores the host_index
224
+ in the spec for a single request.
225
+ :type _host_index: int, optional
226
+ :return: Returns the result object.
227
+ """ # noqa: E501
228
+
229
+ _param = self._compare_workflow_get_result_overview_get_serialize(
230
+ workflow_id=workflow_id,
231
+ display_count=display_count,
232
+ _request_auth=_request_auth,
233
+ _content_type=_content_type,
234
+ _headers=_headers,
235
+ _host_index=_host_index
236
+ )
237
+
238
+ _response_types_map: Dict[str, Optional[str]] = {
239
+ '200': "CompareWorkflowGetResultOverviewGet200Response",
240
+ }
241
+ response_data = self.api_client.call_api(
242
+ *_param,
243
+ _request_timeout=_request_timeout
244
+ )
245
+ return response_data.response
246
+
247
+
248
+ def _compare_workflow_get_result_overview_get_serialize(
249
+ self,
250
+ workflow_id,
251
+ display_count,
252
+ _request_auth,
253
+ _content_type,
254
+ _headers,
255
+ _host_index,
256
+ ) -> RequestSerialized:
257
+
258
+ _host = None
259
+
260
+ _collection_formats: Dict[str, str] = {
261
+ }
262
+
263
+ _path_params: Dict[str, str] = {}
264
+ _query_params: List[Tuple[str, str]] = []
265
+ _header_params: Dict[str, Optional[str]] = _headers or {}
266
+ _form_params: List[Tuple[str, str]] = []
267
+ _files: Dict[
268
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
269
+ ] = {}
270
+ _body_params: Optional[bytes] = None
271
+
272
+ # process the path parameters
273
+ # process the query parameters
274
+ if workflow_id is not None:
275
+
276
+ _query_params.append(('WorkflowId', workflow_id))
277
+
278
+ if display_count is not None:
279
+
280
+ _query_params.append(('DisplayCount', display_count))
281
+
282
+ # process the header parameters
283
+ # process the form parameters
284
+ # process the body parameter
285
+
286
+
287
+ # set the HTTP header `Accept`
288
+ if 'Accept' not in _header_params:
289
+ _header_params['Accept'] = self.api_client.select_header_accept(
290
+ [
291
+ 'application/json'
292
+ ]
293
+ )
294
+
295
+
296
+ # authentication setting
297
+ _auth_settings: List[str] = [
298
+ 'bearer'
299
+ ]
300
+
301
+ return self.api_client.param_serialize(
302
+ method='GET',
303
+ resource_path='/CompareWorkflow/GetResultOverview',
304
+ path_params=_path_params,
305
+ query_params=_query_params,
306
+ header_params=_header_params,
307
+ body=_body_params,
308
+ post_params=_form_params,
309
+ files=_files,
310
+ auth_settings=_auth_settings,
311
+ collection_formats=_collection_formats,
312
+ _host=_host,
313
+ _request_auth=_request_auth
314
+ )
315
+
316
+