rapidata 2.23.2__py3-none-any.whl → 3.0.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.

Potentially problematic release.


This version of rapidata might be problematic. Click here for more details.

Files changed (865) hide show
  1. rapidata/__init__.py +31 -14
  2. rapidata/api_client/__init__.py +84 -312
  3. rapidata/api_client/api/__init__.py +12 -3
  4. rapidata/api_client/api/asset_api.py +853 -0
  5. rapidata/api_client/api/audience_api.py +3044 -0
  6. rapidata/api_client/api/benchmark_api.py +4307 -0
  7. rapidata/api_client/api/campaign_api.py +232 -207
  8. rapidata/api_client/api/client_api.py +166 -145
  9. rapidata/api_client/api/coco_api.py +0 -571
  10. rapidata/api_client/api/compare_workflow_api.py +11 -10
  11. rapidata/api_client/api/customer_rapid_api.py +2216 -0
  12. rapidata/api_client/api/datapoint_api.py +8 -797
  13. rapidata/api_client/api/dataset_api.py +276 -2858
  14. rapidata/api_client/api/evaluation_workflow_api.py +29 -82
  15. rapidata/api_client/api/feedback_api.py +11 -281
  16. rapidata/api_client/api/grouped_ranking_workflow_api.py +319 -0
  17. rapidata/api_client/api/identity_api.py +83 -1171
  18. rapidata/api_client/api/job_api.py +4200 -0
  19. rapidata/api_client/api/job_definition_api.py +319 -0
  20. rapidata/api_client/api/job_revision_api.py +335 -0
  21. rapidata/api_client/api/leaderboard_api.py +2855 -0
  22. rapidata/api_client/api/newsletter_api.py +30 -317
  23. rapidata/api_client/api/order_api.py +758 -5487
  24. rapidata/api_client/api/participant_api.py +2181 -0
  25. rapidata/api_client/api/pipeline_api.py +24 -1783
  26. rapidata/api_client/api/prompt_api.py +320 -0
  27. rapidata/api_client/api/rapidata_identity_api_api.py +5 -4
  28. rapidata/api_client/api/sample_api.py +300 -0
  29. rapidata/api_client/api/simple_workflow_api.py +11 -10
  30. rapidata/api_client/api/survey_api.py +304 -0
  31. rapidata/api_client/api/user_rapid_api.py +1389 -0
  32. rapidata/api_client/api/validation_set_api.py +510 -3230
  33. rapidata/api_client/api/workflow_api.py +32 -825
  34. rapidata/api_client/api_client.py +2 -2
  35. rapidata/api_client/configuration.py +16 -29
  36. rapidata/api_client/exceptions.py +2 -2
  37. rapidata/api_client/models/__init__.py +65 -291
  38. rapidata/api_client/models/ab_test_selection_a_inner.py +27 -13
  39. rapidata/api_client/models/add_campaign_model.py +8 -3
  40. rapidata/api_client/models/add_rapid_to_audience_model.py +144 -0
  41. rapidata/api_client/models/add_user_response_result.py +10 -5
  42. rapidata/api_client/models/add_validation_rapid_model.py +49 -28
  43. rapidata/api_client/models/add_validation_rapid_model_asset.py +154 -0
  44. rapidata/api_client/models/add_validation_rapid_model_context_asset.py +160 -0
  45. rapidata/api_client/models/add_validation_rapid_model_metadata_inner.py +140 -0
  46. rapidata/api_client/models/add_validation_rapid_model_truth.py +32 -12
  47. rapidata/api_client/models/add_validation_rapid_new_model.py +137 -0
  48. rapidata/api_client/models/add_validation_rapid_new_model_asset.py +182 -0
  49. rapidata/api_client/models/add_validation_rapid_new_model_truth.py +286 -0
  50. rapidata/api_client/models/add_validation_text_rapid_model.py +4 -6
  51. rapidata/api_client/models/age_user_filter_model.py +2 -2
  52. rapidata/api_client/models/age_user_filter_model_age_group.py +41 -0
  53. rapidata/api_client/models/aggregated_orders_model.py +98 -0
  54. rapidata/api_client/models/aggregator_type.py +4 -2
  55. rapidata/api_client/models/and_filter.py +121 -0
  56. rapidata/api_client/models/and_filter_filters_inner.py +282 -0
  57. rapidata/api_client/models/and_user_filter_model.py +106 -0
  58. rapidata/api_client/models/and_user_filter_model_filters_inner.py +282 -0
  59. rapidata/api_client/models/are_rapids_active_result.py +2 -2
  60. rapidata/api_client/models/asset_metadata.py +106 -0
  61. rapidata/api_client/models/asset_metadata_asset.py +170 -0
  62. rapidata/api_client/models/asset_metadata_model.py +96 -0
  63. rapidata/api_client/models/asset_metadata_model_asset.py +170 -0
  64. rapidata/api_client/models/asset_type.py +40 -0
  65. rapidata/api_client/models/attach_category_rapid_blueprint.py +13 -3
  66. rapidata/api_client/models/attach_category_rapid_blueprint_category.py +89 -0
  67. rapidata/api_client/models/audience_job_state.py +38 -0
  68. rapidata/api_client/models/audience_status.py +39 -0
  69. rapidata/api_client/models/benchmark_query_result.py +98 -0
  70. rapidata/api_client/models/benchmark_query_result_paged_result.py +105 -0
  71. rapidata/api_client/models/boost_leaderboard_model.py +89 -0
  72. rapidata/api_client/models/boost_mode.py +37 -0
  73. rapidata/api_client/models/boost_query_result.py +97 -0
  74. rapidata/api_client/models/boost_query_result_boost_mode.py +37 -0
  75. rapidata/api_client/models/boost_query_result_boost_status.py +39 -0
  76. rapidata/api_client/models/boost_status.py +39 -0
  77. rapidata/api_client/models/boosting_profile.py +91 -0
  78. rapidata/api_client/models/box_shape.py +4 -33
  79. rapidata/api_client/models/campaign_filter.py +98 -0
  80. rapidata/api_client/models/campaign_query_result.py +15 -13
  81. rapidata/api_client/models/campaign_status.py +2 -2
  82. rapidata/api_client/models/change_boost_model.py +89 -0
  83. rapidata/api_client/models/classification_metadata.py +12 -1
  84. rapidata/api_client/models/classify_payload.py +14 -15
  85. rapidata/api_client/models/classify_payload_category.py +89 -0
  86. rapidata/api_client/models/client_model.py +181 -0
  87. rapidata/api_client/models/clients_query_result.py +5 -5
  88. rapidata/api_client/models/clone_order_model.py +6 -8
  89. rapidata/api_client/models/clone_order_result.py +9 -4
  90. rapidata/api_client/models/compare_rapid_blueprint.py +5 -3
  91. rapidata/api_client/models/compare_rapid_blueprint1.py +96 -0
  92. rapidata/api_client/models/compare_result.py +1 -10
  93. rapidata/api_client/models/compare_workflow_config.py +34 -23
  94. rapidata/api_client/models/compare_workflow_config_context_asset.py +174 -0
  95. rapidata/api_client/models/compare_workflow_config_metadata_value.py +75 -17
  96. rapidata/api_client/models/compare_workflow_config_model.py +15 -5
  97. rapidata/api_client/models/compare_workflow_model.py +34 -6
  98. rapidata/api_client/models/compare_workflow_model1.py +20 -9
  99. rapidata/api_client/models/compare_workflow_model_context_asset.py +160 -0
  100. rapidata/api_client/models/compare_workflow_model_metadata_inner.py +154 -0
  101. rapidata/api_client/models/compare_workflow_model_pair_maker_config.py +1 -1
  102. rapidata/api_client/models/comparison_operator.py +2 -2
  103. rapidata/api_client/models/conditional_validation_selection.py +8 -11
  104. rapidata/api_client/models/conditional_validation_selection_validation_chance.py +103 -0
  105. rapidata/api_client/models/confidence_interval.py +89 -0
  106. rapidata/api_client/models/count_metadata.py +12 -1
  107. rapidata/api_client/models/country_filter.py +98 -0
  108. rapidata/api_client/models/create_audience_request.py +122 -0
  109. rapidata/api_client/models/create_audience_result.py +87 -0
  110. rapidata/api_client/models/create_benchmark_model.py +87 -0
  111. rapidata/api_client/models/create_benchmark_participant_model.py +87 -0
  112. rapidata/api_client/models/create_benchmark_participant_result.py +89 -0
  113. rapidata/api_client/models/create_benchmark_prompt_result.py +87 -0
  114. rapidata/api_client/models/create_benchmark_result.py +87 -0
  115. rapidata/api_client/models/create_bridge_token_result.py +2 -2
  116. rapidata/api_client/models/create_client_model.py +6 -13
  117. rapidata/api_client/models/create_complex_order_model.py +9 -9
  118. rapidata/api_client/models/create_complex_order_result.py +6 -4
  119. rapidata/api_client/models/create_customer_client_result.py +89 -0
  120. rapidata/api_client/models/create_datapoint_from_files_model_metadata_inner.py +25 -11
  121. rapidata/api_client/models/create_datapoint_model.py +124 -0
  122. rapidata/api_client/models/create_datapoint_model_asset.py +154 -0
  123. rapidata/api_client/models/create_datapoint_model_context_asset.py +160 -0
  124. rapidata/api_client/models/create_datapoint_model_metadata_inner.py +154 -0
  125. rapidata/api_client/models/create_datapoint_result.py +6 -18
  126. rapidata/api_client/models/create_dataset_endpoint_input.py +87 -0
  127. rapidata/api_client/models/create_dataset_endpoint_output.py +87 -0
  128. rapidata/api_client/models/create_demographic_rapid_model.py +45 -7
  129. rapidata/api_client/models/create_demographic_rapid_model_asset.py +160 -0
  130. rapidata/api_client/models/create_demographic_rapid_model_context_asset.py +160 -0
  131. rapidata/api_client/models/create_demographic_rapid_model_new.py +119 -0
  132. rapidata/api_client/models/create_empty_validation_set_result.py +2 -2
  133. rapidata/api_client/models/create_job_definition_endpoint_input.py +119 -0
  134. rapidata/api_client/models/create_job_definition_endpoint_output.py +89 -0
  135. rapidata/api_client/models/create_job_endpoint_input.py +100 -0
  136. rapidata/api_client/models/create_job_endpoint_output.py +89 -0
  137. rapidata/api_client/models/create_job_revision_endpoint_input.py +127 -0
  138. rapidata/api_client/models/create_job_revision_endpoint_output.py +89 -0
  139. rapidata/api_client/models/create_leaderboard_model.py +147 -0
  140. rapidata/api_client/models/create_leaderboard_participant_model.py +87 -0
  141. rapidata/api_client/models/create_leaderboard_participant_result.py +89 -0
  142. rapidata/api_client/models/create_leaderboard_result.py +99 -0
  143. rapidata/api_client/models/create_order_definition_model.py +119 -0
  144. rapidata/api_client/models/create_order_definition_result.py +87 -0
  145. rapidata/api_client/models/create_order_definition_revision_model.py +117 -0
  146. rapidata/api_client/models/create_order_definition_revision_result.py +87 -0
  147. rapidata/api_client/models/create_order_model.py +30 -103
  148. rapidata/api_client/models/create_order_model_referee.py +12 -12
  149. rapidata/api_client/models/create_order_model_workflow.py +35 -21
  150. rapidata/api_client/models/create_order_result.py +6 -4
  151. rapidata/api_client/models/create_rapid_result.py +2 -2
  152. rapidata/api_client/models/create_sample_model.py +93 -0
  153. rapidata/api_client/models/create_sample_model_asset.py +154 -0
  154. rapidata/api_client/models/create_sample_model_obsolete.py +87 -0
  155. rapidata/api_client/models/create_simple_pipeline_model_pipeline_steps_inner.py +8 -22
  156. rapidata/api_client/models/create_unsupported_order_model.py +6 -6
  157. rapidata/api_client/models/create_validation_set_model.py +5 -5
  158. rapidata/api_client/models/datapoint_metadata_model.py +3 -3
  159. rapidata/api_client/models/datapoint_model.py +3 -3
  160. rapidata/api_client/models/datapoint_model_paged_result.py +105 -0
  161. rapidata/api_client/models/datapoint_state.py +2 -2
  162. rapidata/api_client/models/dataset_dataset_id_datapoints_post_request_metadata_inner.py +182 -0
  163. rapidata/api_client/models/definition_type.py +49 -0
  164. rapidata/api_client/models/demographic_filter.py +100 -0
  165. rapidata/api_client/models/dynamic_client_registration_request.py +160 -0
  166. rapidata/api_client/models/early_stopping_referee_model.py +3 -3
  167. rapidata/api_client/models/effort_capped_selection.py +106 -0
  168. rapidata/api_client/models/elo_config.py +2 -2
  169. rapidata/api_client/models/elo_config_model.py +6 -6
  170. rapidata/api_client/models/entity_tag_header_value.py +93 -0
  171. rapidata/api_client/models/evaluation_workflow_config.py +13 -3
  172. rapidata/api_client/models/evaluation_workflow_model.py +16 -6
  173. rapidata/api_client/models/existing_asset_input.py +109 -0
  174. rapidata/api_client/models/existing_asset_input_metadata_value.py +126 -0
  175. rapidata/api_client/models/feature_flag.py +2 -2
  176. rapidata/api_client/models/feature_flag_model.py +6 -6
  177. rapidata/api_client/models/feedback_model.py +7 -7
  178. rapidata/api_client/models/file_asset.py +15 -12
  179. rapidata/api_client/models/file_asset_input.py +104 -0
  180. rapidata/api_client/models/file_asset_input1.py +104 -0
  181. rapidata/api_client/models/file_asset_input1_file.py +168 -0
  182. rapidata/api_client/models/file_asset_input2.py +104 -0
  183. rapidata/api_client/models/file_asset_input3.py +104 -0
  184. rapidata/api_client/models/file_asset_input_file.py +168 -0
  185. rapidata/api_client/models/file_asset_metadata_value.py +252 -0
  186. rapidata/api_client/models/file_asset_model_metadata_value.py +37 -51
  187. rapidata/api_client/models/file_stream_result.py +122 -0
  188. rapidata/api_client/models/file_type.py +39 -0
  189. rapidata/api_client/models/file_type_metadata.py +110 -0
  190. rapidata/api_client/models/file_type_metadata_model.py +97 -0
  191. rapidata/api_client/models/filter.py +7 -25
  192. rapidata/api_client/models/filter_operator.py +3 -2
  193. rapidata/api_client/models/fork_benchmark_result.py +87 -0
  194. rapidata/api_client/models/form_file_wrapper.py +135 -0
  195. rapidata/api_client/models/free_text_payload.py +10 -3
  196. rapidata/api_client/models/free_text_rapid_blueprint.py +10 -3
  197. rapidata/api_client/models/gender_user_filter_model.py +2 -2
  198. rapidata/api_client/models/gender_user_filter_model_gender.py +38 -0
  199. rapidata/api_client/models/get_asset_metadata_result.py +100 -0
  200. rapidata/api_client/models/get_audience_by_id_result.py +118 -0
  201. rapidata/api_client/models/get_audience_user_state_metrics_result.py +87 -0
  202. rapidata/api_client/models/get_available_validation_sets_result.py +2 -2
  203. rapidata/api_client/models/get_benchmark_by_id_query.py +96 -0
  204. rapidata/api_client/models/get_benchmark_by_id_query_result.py +94 -0
  205. rapidata/api_client/models/get_benchmark_by_id_query_result_paged_result.py +105 -0
  206. rapidata/api_client/models/get_benchmark_by_id_result.py +98 -0
  207. rapidata/api_client/models/get_boost_result.py +97 -0
  208. rapidata/api_client/models/get_boost_result_boost_mode.py +37 -0
  209. rapidata/api_client/models/get_boost_result_boost_status.py +39 -0
  210. rapidata/api_client/models/get_compare_ab_summary_result.py +5 -5
  211. rapidata/api_client/models/get_compare_workflow_results_model.py +7 -7
  212. rapidata/api_client/models/get_compare_workflow_results_result.py +5 -5
  213. rapidata/api_client/models/get_datapoint_by_id_result.py +10 -21
  214. rapidata/api_client/models/get_datapoint_by_id_result_asset.py +170 -0
  215. rapidata/api_client/models/get_dataset_by_id_result.py +2 -2
  216. rapidata/api_client/models/get_dataset_progress_result.py +2 -2
  217. rapidata/api_client/models/get_evaluation_workflow_results_model.py +119 -0
  218. rapidata/api_client/models/get_failed_datapoints_result.py +5 -5
  219. rapidata/api_client/models/get_failed_datapoints_result_datapoint.py +100 -0
  220. rapidata/api_client/models/get_file_metadata_result.py +100 -0
  221. rapidata/api_client/models/get_grouped_ranking_workflow_results_model.py +106 -0
  222. rapidata/api_client/models/get_grouped_ranking_workflow_results_result.py +97 -0
  223. rapidata/api_client/models/get_grouped_ranking_workflow_results_result_paged_result.py +105 -0
  224. rapidata/api_client/models/get_job_by_id_endpoint_output.py +130 -0
  225. rapidata/api_client/models/get_job_definition_by_id_endpoint_output.py +95 -0
  226. rapidata/api_client/models/get_job_revision_endpoint_output.py +133 -0
  227. rapidata/api_client/models/get_leaderboard_by_id_result.py +135 -0
  228. rapidata/api_client/models/get_order_by_id_result.py +12 -5
  229. rapidata/api_client/models/get_participant_by_id_result.py +91 -0
  230. rapidata/api_client/models/get_pipeline_by_id_result.py +5 -5
  231. rapidata/api_client/models/get_public_orders_result.py +2 -2
  232. rapidata/api_client/models/get_public_responses_result.py +95 -0
  233. rapidata/api_client/models/get_public_responses_result_response.py +112 -0
  234. rapidata/api_client/models/get_rapid_responses_result.py +6 -12
  235. rapidata/api_client/models/get_recommended_validation_set_result.py +95 -0
  236. rapidata/api_client/models/get_responses_for_rapid_result.py +106 -0
  237. rapidata/api_client/models/get_responses_for_rapid_result_response.py +103 -0
  238. rapidata/api_client/models/get_responses_for_rapid_result_response_result.py +266 -0
  239. rapidata/api_client/models/get_responses_result.py +5 -5
  240. rapidata/api_client/models/get_responses_result_response.py +103 -0
  241. rapidata/api_client/models/get_sample_by_id_result.py +125 -0
  242. rapidata/api_client/models/get_simple_workflow_results_model.py +20 -15
  243. rapidata/api_client/models/get_standing_by_id_result.py +96 -0
  244. rapidata/api_client/models/get_validation_rapids_result.py +33 -33
  245. rapidata/api_client/models/get_validation_rapids_result_truth.py +25 -11
  246. rapidata/api_client/models/get_validation_set_by_id_result.py +10 -4
  247. rapidata/api_client/models/get_workflow_by_id_result.py +5 -5
  248. rapidata/api_client/models/get_workflow_by_id_result_workflow.py +23 -9
  249. rapidata/api_client/models/get_workflow_progress_result.py +5 -11
  250. rapidata/api_client/models/get_workflow_results_result.py +34 -23
  251. rapidata/api_client/models/get_workflow_results_result_response.py +103 -0
  252. rapidata/api_client/models/google_one_tap_login_model.py +4 -4
  253. rapidata/api_client/models/grouped_ranking_workflow_config.py +155 -0
  254. rapidata/api_client/models/grouped_ranking_workflow_config_context_assets_value.py +170 -0
  255. rapidata/api_client/models/grouped_ranking_workflow_model.py +147 -0
  256. rapidata/api_client/models/grouped_ranking_workflow_model1.py +121 -0
  257. rapidata/api_client/models/i_artifact_model.py +182 -0
  258. rapidata/api_client/models/i_artifact_model_campaign_artifact_model.py +98 -0
  259. rapidata/api_client/models/i_artifact_model_dataset_artifact_model.py +98 -0
  260. rapidata/api_client/models/i_artifact_model_file_artifact_model.py +98 -0
  261. rapidata/api_client/models/i_artifact_model_workflow_artifact_model.py +98 -0
  262. rapidata/api_client/models/i_artifact_model_workflow_config_artifact_model.py +102 -0
  263. rapidata/api_client/models/i_asset.py +170 -0
  264. rapidata/api_client/models/i_asset_file_asset.py +111 -0
  265. rapidata/api_client/models/i_asset_input.py +156 -0
  266. rapidata/api_client/models/i_asset_input_existing_asset_input.py +118 -0
  267. rapidata/api_client/models/i_asset_input_multi_asset_input.py +128 -0
  268. rapidata/api_client/models/i_asset_input_text_asset_input.py +118 -0
  269. rapidata/api_client/models/i_asset_model.py +170 -0
  270. rapidata/api_client/models/i_asset_model_file_asset_model.py +113 -0
  271. rapidata/api_client/models/i_asset_model_multi_asset_model.py +123 -0
  272. rapidata/api_client/models/i_asset_model_null_asset_model.py +111 -0
  273. rapidata/api_client/models/i_asset_model_text_asset_model.py +113 -0
  274. rapidata/api_client/models/i_asset_multi_asset.py +121 -0
  275. rapidata/api_client/models/i_asset_null_asset.py +109 -0
  276. rapidata/api_client/models/i_asset_text_asset.py +111 -0
  277. rapidata/api_client/models/i_audience_filter.py +184 -0
  278. rapidata/api_client/models/i_audience_filter_and_audience_filter.py +106 -0
  279. rapidata/api_client/models/i_audience_filter_country_audience_filter.py +96 -0
  280. rapidata/api_client/models/i_audience_filter_country_filter.py +96 -0
  281. rapidata/api_client/models/i_audience_filter_language_audience_filter.py +96 -0
  282. rapidata/api_client/models/i_audience_filter_language_filter.py +96 -0
  283. rapidata/api_client/models/i_audience_filter_not_audience_filter.py +102 -0
  284. rapidata/api_client/models/i_audience_filter_or_audience_filter.py +106 -0
  285. rapidata/api_client/models/i_campaign_filter.py +296 -0
  286. rapidata/api_client/models/i_campaign_filter_and_filter.py +117 -0
  287. rapidata/api_client/models/i_campaign_filter_campaign_filter.py +98 -0
  288. rapidata/api_client/models/i_campaign_filter_campaign_session_count_filter.py +101 -0
  289. rapidata/api_client/models/i_campaign_filter_country_filter.py +98 -0
  290. rapidata/api_client/models/i_campaign_filter_demographic_filter.py +100 -0
  291. rapidata/api_client/models/i_campaign_filter_device_filter.py +106 -0
  292. rapidata/api_client/models/i_campaign_filter_language_filter.py +98 -0
  293. rapidata/api_client/models/i_campaign_filter_new_user_filter.py +96 -0
  294. rapidata/api_client/models/i_campaign_filter_not_filter.py +113 -0
  295. rapidata/api_client/models/i_campaign_filter_or_filter.py +117 -0
  296. rapidata/api_client/models/i_campaign_filter_response_count_filter.py +103 -0
  297. rapidata/api_client/models/i_campaign_filter_user_action_restriction_filter.py +106 -0
  298. rapidata/api_client/models/i_campaign_filter_user_score_filter.py +102 -0
  299. rapidata/api_client/models/i_campaign_filter_user_state_filter.py +106 -0
  300. rapidata/api_client/models/i_dataset_metadata_input.py +154 -0
  301. rapidata/api_client/models/i_dataset_metadata_input_prompt_asset_metadata_input.py +100 -0
  302. rapidata/api_client/models/i_dataset_metadata_input_prompt_metadata_input.py +96 -0
  303. rapidata/api_client/models/i_dataset_metadata_input_transcription_metadata_input.py +96 -0
  304. rapidata/api_client/models/i_dataset_model.py +126 -0
  305. rapidata/api_client/models/i_dataset_model_clone_dataset_model.py +98 -0
  306. rapidata/api_client/models/i_metadata.py +252 -0
  307. rapidata/api_client/models/i_metadata_classification_metadata.py +109 -0
  308. rapidata/api_client/models/i_metadata_count_metadata.py +109 -0
  309. rapidata/api_client/models/i_metadata_duration_metadata.py +110 -0
  310. rapidata/api_client/models/i_metadata_file_type_metadata.py +110 -0
  311. rapidata/api_client/models/i_metadata_image_dimension_metadata.py +111 -0
  312. rapidata/api_client/models/i_metadata_input.py +126 -0
  313. rapidata/api_client/models/i_metadata_input_text_metadata_input.py +111 -0
  314. rapidata/api_client/models/i_metadata_location_metadata.py +111 -0
  315. rapidata/api_client/models/i_metadata_model.py +252 -0
  316. rapidata/api_client/models/i_metadata_model_classification_metadata_model.py +96 -0
  317. rapidata/api_client/models/i_metadata_model_count_metadata_model.py +96 -0
  318. rapidata/api_client/models/i_metadata_model_file_type_metadata_model.py +97 -0
  319. rapidata/api_client/models/i_metadata_model_image_dimension_metadata_model.py +98 -0
  320. rapidata/api_client/models/i_metadata_model_location_metadata_model.py +98 -0
  321. rapidata/api_client/models/i_metadata_model_original_filename_metadata_model.py +96 -0
  322. rapidata/api_client/models/i_metadata_model_source_url_metadata_model.py +96 -0
  323. rapidata/api_client/models/i_metadata_model_streams_metadata_model.py +100 -0
  324. rapidata/api_client/models/i_metadata_model_text_metadata_model.py +101 -0
  325. rapidata/api_client/models/i_metadata_model_video_duration_metadata_model.py +97 -0
  326. rapidata/api_client/models/i_metadata_original_filename_metadata.py +109 -0
  327. rapidata/api_client/models/i_metadata_source_url_metadata.py +109 -0
  328. rapidata/api_client/models/i_metadata_streams_metadata.py +113 -0
  329. rapidata/api_client/models/i_metadata_text_metadata.py +114 -0
  330. rapidata/api_client/models/i_metadata_video_duration_metadata.py +110 -0
  331. rapidata/api_client/models/i_order_workflow_model.py +168 -0
  332. rapidata/api_client/models/i_order_workflow_model_compare_workflow_model.py +146 -0
  333. rapidata/api_client/models/i_order_workflow_model_evaluation_workflow_model.py +108 -0
  334. rapidata/api_client/models/i_order_workflow_model_grouped_ranking_workflow_model.py +147 -0
  335. rapidata/api_client/models/i_order_workflow_model_simple_workflow_model.py +110 -0
  336. rapidata/api_client/models/i_pair_maker_config.py +126 -0
  337. rapidata/api_client/models/i_pair_maker_config_model.py +126 -0
  338. rapidata/api_client/models/i_pair_maker_config_model_online_pair_maker_config_model.py +98 -0
  339. rapidata/api_client/models/i_pair_maker_config_online_pair_maker_config.py +98 -0
  340. rapidata/api_client/models/i_pair_maker_information.py +126 -0
  341. rapidata/api_client/models/i_pair_maker_information_online_pair_maker_information.py +100 -0
  342. rapidata/api_client/models/i_pipeline_artifact_model.py +126 -0
  343. rapidata/api_client/models/i_pipeline_artifact_model_create_dataset_artifact_model.py +102 -0
  344. rapidata/api_client/models/i_pipeline_model.py +126 -0
  345. rapidata/api_client/models/i_pipeline_model_create_simple_pipeline_model.py +116 -0
  346. rapidata/api_client/models/i_pipeline_step_model.py +168 -0
  347. rapidata/api_client/models/i_pipeline_step_model_dataset_evaluation_step_model.py +102 -0
  348. rapidata/api_client/models/i_pipeline_step_model_send_completion_mail_step_model.py +98 -0
  349. rapidata/api_client/models/i_pipeline_step_model_workflow_aggregation_step_model.py +103 -0
  350. rapidata/api_client/models/i_pipeline_step_model_workflow_labeling_step_model.py +96 -0
  351. rapidata/api_client/models/i_rapid_blueprint.py +252 -0
  352. rapidata/api_client/models/i_rapid_blueprint_attach_category_rapid_blueprint.py +108 -0
  353. rapidata/api_client/models/i_rapid_blueprint_bounding_box_rapid_blueprint.py +96 -0
  354. rapidata/api_client/models/i_rapid_blueprint_compare_rapid_blueprint.py +98 -0
  355. rapidata/api_client/models/i_rapid_blueprint_free_text_rapid_blueprint.py +105 -0
  356. rapidata/api_client/models/i_rapid_blueprint_line_rapid_blueprint.py +96 -0
  357. rapidata/api_client/models/i_rapid_blueprint_locate_rapid_blueprint.py +96 -0
  358. rapidata/api_client/models/i_rapid_blueprint_named_entity_rapid_blueprint.py +98 -0
  359. rapidata/api_client/models/i_rapid_blueprint_polygon_rapid_blueprint.py +96 -0
  360. rapidata/api_client/models/i_rapid_blueprint_scrub_rapid_blueprint.py +96 -0
  361. rapidata/api_client/models/i_rapid_blueprint_transcription_rapid_blueprint.py +96 -0
  362. rapidata/api_client/models/i_rapid_payload.py +252 -0
  363. rapidata/api_client/models/i_rapid_payload_bounding_box_payload.py +96 -0
  364. rapidata/api_client/models/i_rapid_payload_classify_payload.py +106 -0
  365. rapidata/api_client/models/i_rapid_payload_compare_payload.py +96 -0
  366. rapidata/api_client/models/i_rapid_payload_free_text_payload.py +105 -0
  367. rapidata/api_client/models/i_rapid_payload_line_payload.py +96 -0
  368. rapidata/api_client/models/i_rapid_payload_locate_payload.py +96 -0
  369. rapidata/api_client/models/i_rapid_payload_named_entity_payload.py +98 -0
  370. rapidata/api_client/models/i_rapid_payload_polygon_payload.py +96 -0
  371. rapidata/api_client/models/i_rapid_payload_scrub_payload.py +96 -0
  372. rapidata/api_client/models/i_rapid_payload_transcription_payload.py +106 -0
  373. rapidata/api_client/models/i_rapid_result.py +266 -0
  374. rapidata/api_client/models/i_rapid_result_attach_category_result.py +98 -0
  375. rapidata/api_client/models/i_rapid_result_bounding_box_result.py +106 -0
  376. rapidata/api_client/models/i_rapid_result_compare_result.py +98 -0
  377. rapidata/api_client/models/i_rapid_result_free_text_result.py +98 -0
  378. rapidata/api_client/models/i_rapid_result_line_result.py +106 -0
  379. rapidata/api_client/models/i_rapid_result_locate_result.py +106 -0
  380. rapidata/api_client/models/i_rapid_result_named_entity_result.py +106 -0
  381. rapidata/api_client/models/i_rapid_result_polygon_result.py +106 -0
  382. rapidata/api_client/models/i_rapid_result_scrub_result.py +98 -0
  383. rapidata/api_client/models/i_rapid_result_skip_result.py +96 -0
  384. rapidata/api_client/models/i_rapid_result_transcription_result.py +106 -0
  385. rapidata/api_client/models/i_referee_config.py +154 -0
  386. rapidata/api_client/models/i_referee_config_naive_referee_config.py +96 -0
  387. rapidata/api_client/models/i_referee_config_never_ending_referee_config.py +94 -0
  388. rapidata/api_client/models/i_referee_config_probabilistic_attach_category_referee_config.py +98 -0
  389. rapidata/api_client/models/i_referee_info.py +154 -0
  390. rapidata/api_client/models/i_referee_info_naive_referee_info.py +96 -0
  391. rapidata/api_client/models/i_referee_info_never_ending_referee_info.py +94 -0
  392. rapidata/api_client/models/i_referee_info_probabilistic_attach_category_referee_info.py +98 -0
  393. rapidata/api_client/models/i_referee_model.py +140 -0
  394. rapidata/api_client/models/i_referee_model_early_stopping_referee_model.py +98 -0
  395. rapidata/api_client/models/i_referee_model_naive_referee_model.py +96 -0
  396. rapidata/api_client/models/i_selection.py +240 -0
  397. rapidata/api_client/models/i_selection_ab_test_selection.py +122 -0
  398. rapidata/api_client/models/i_selection_capped_selection.py +108 -0
  399. rapidata/api_client/models/i_selection_conditional_validation_selection.py +110 -0
  400. rapidata/api_client/models/i_selection_demographic_selection.py +98 -0
  401. rapidata/api_client/models/i_selection_effort_capped_selection.py +101 -0
  402. rapidata/api_client/models/i_selection_labeling_selection.py +103 -0
  403. rapidata/api_client/models/i_selection_shuffling_selection.py +106 -0
  404. rapidata/api_client/models/i_selection_static_selection.py +96 -0
  405. rapidata/api_client/models/i_selection_validation_selection.py +98 -0
  406. rapidata/api_client/models/i_user_filter_model.py +296 -0
  407. rapidata/api_client/models/i_user_filter_model_age_user_filter_model.py +104 -0
  408. rapidata/api_client/models/i_user_filter_model_and_user_filter_model.py +106 -0
  409. rapidata/api_client/models/i_user_filter_model_campaign_user_filter_model.py +96 -0
  410. rapidata/api_client/models/i_user_filter_model_country_user_filter_model.py +96 -0
  411. rapidata/api_client/models/i_user_filter_model_custom_user_filter_model.py +98 -0
  412. rapidata/api_client/models/i_user_filter_model_device_user_filter_model.py +104 -0
  413. rapidata/api_client/models/i_user_filter_model_gender_user_filter_model.py +104 -0
  414. rapidata/api_client/models/i_user_filter_model_language_user_filter_model.py +96 -0
  415. rapidata/api_client/models/i_user_filter_model_new_user_filter_model.py +94 -0
  416. rapidata/api_client/models/i_user_filter_model_not_user_filter_model.py +102 -0
  417. rapidata/api_client/models/i_user_filter_model_or_user_filter_model.py +106 -0
  418. rapidata/api_client/models/i_user_filter_model_response_count_user_filter_model.py +101 -0
  419. rapidata/api_client/models/i_user_filter_model_user_score_user_filter_model.py +105 -0
  420. rapidata/api_client/models/i_validation_metadata_input.py +140 -0
  421. rapidata/api_client/models/i_validation_metadata_input_prompt_asset_metadata_input.py +100 -0
  422. rapidata/api_client/models/i_validation_metadata_input_prompt_metadata_input.py +96 -0
  423. rapidata/api_client/models/i_validation_truth.py +280 -0
  424. rapidata/api_client/models/i_validation_truth_attach_category_truth.py +96 -0
  425. rapidata/api_client/models/i_validation_truth_bounding_box_truth.py +102 -0
  426. rapidata/api_client/models/i_validation_truth_compare_truth.py +96 -0
  427. rapidata/api_client/models/i_validation_truth_empty_validation_truth.py +94 -0
  428. rapidata/api_client/models/i_validation_truth_line_truth.py +94 -0
  429. rapidata/api_client/models/i_validation_truth_locate_box_truth.py +108 -0
  430. rapidata/api_client/models/i_validation_truth_model.py +294 -0
  431. rapidata/api_client/models/i_validation_truth_model_attach_category_truth_model.py +96 -0
  432. rapidata/api_client/models/i_validation_truth_model_bounding_box_truth_model.py +102 -0
  433. rapidata/api_client/models/i_validation_truth_model_classify_truth_model.py +96 -0
  434. rapidata/api_client/models/i_validation_truth_model_compare_truth_model.py +96 -0
  435. rapidata/api_client/models/i_validation_truth_model_empty_validation_truth_model.py +94 -0
  436. rapidata/api_client/models/i_validation_truth_model_line_truth_model.py +94 -0
  437. rapidata/api_client/models/i_validation_truth_model_locate_box_truth_model.py +108 -0
  438. rapidata/api_client/models/i_validation_truth_model_multi_compare_truth_model.py +96 -0
  439. rapidata/api_client/models/i_validation_truth_model_named_entity_truth_model.py +104 -0
  440. rapidata/api_client/models/i_validation_truth_model_polygon_truth_model.py +94 -0
  441. rapidata/api_client/models/i_validation_truth_model_scrub_truth_model.py +104 -0
  442. rapidata/api_client/models/i_validation_truth_model_skip_truth_model.py +94 -0
  443. rapidata/api_client/models/i_validation_truth_model_transcription_truth_model.py +115 -0
  444. rapidata/api_client/models/i_validation_truth_multi_compare_truth.py +96 -0
  445. rapidata/api_client/models/i_validation_truth_named_entity_truth.py +104 -0
  446. rapidata/api_client/models/i_validation_truth_polygon_truth.py +94 -0
  447. rapidata/api_client/models/i_validation_truth_scrub_truth.py +104 -0
  448. rapidata/api_client/models/i_validation_truth_skip_truth.py +94 -0
  449. rapidata/api_client/models/i_validation_truth_transcription_truth.py +115 -0
  450. rapidata/api_client/models/i_workflow_config.py +168 -0
  451. rapidata/api_client/models/i_workflow_config_compare_workflow_config.py +142 -0
  452. rapidata/api_client/models/i_workflow_config_evaluation_workflow_config.py +114 -0
  453. rapidata/api_client/models/i_workflow_config_grouped_ranking_workflow_config.py +155 -0
  454. rapidata/api_client/models/i_workflow_config_simple_workflow_config.py +116 -0
  455. rapidata/api_client/models/i_workflow_model.py +168 -0
  456. rapidata/api_client/models/i_workflow_model_compare_workflow_model.py +145 -0
  457. rapidata/api_client/models/i_workflow_model_evaluation_workflow_model.py +115 -0
  458. rapidata/api_client/models/i_workflow_model_grouped_ranking_workflow_model.py +121 -0
  459. rapidata/api_client/models/i_workflow_model_simple_workflow_model.py +119 -0
  460. rapidata/api_client/models/image_dimension_metadata.py +12 -1
  461. rapidata/api_client/models/inquire_file_metadata_result.py +100 -0
  462. rapidata/api_client/models/inspect_report_result.py +2 -2
  463. rapidata/api_client/models/job_definition_revision_state.py +38 -0
  464. rapidata/api_client/models/json_web_key.py +224 -0
  465. rapidata/api_client/models/json_web_key_set.py +95 -0
  466. rapidata/api_client/models/labeling_selection.py +11 -13
  467. rapidata/api_client/models/language_filter.py +98 -0
  468. rapidata/api_client/models/leaderboard_query_result.py +135 -0
  469. rapidata/api_client/models/leaderboard_query_result_paged_result.py +105 -0
  470. rapidata/api_client/models/leaderboards_query_result.py +135 -0
  471. rapidata/api_client/models/line_result.py +3 -3
  472. rapidata/api_client/models/line_result_line.py +97 -0
  473. rapidata/api_client/models/line_result_line_point.py +89 -0
  474. rapidata/api_client/models/local_file_wrapper.py +120 -0
  475. rapidata/api_client/models/locate_coordinate.py +4 -13
  476. rapidata/api_client/models/location_metadata.py +12 -1
  477. rapidata/api_client/models/logic_operator.py +2 -2
  478. rapidata/api_client/models/metadata_i_order_metadata_input.py +154 -0
  479. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_asset_metadata_input.py +100 -0
  480. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_metadata_input.py +96 -0
  481. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_transcription_metadata_input.py +96 -0
  482. rapidata/api_client/models/metadata_prompt_asset_metadata_input.py +100 -0
  483. rapidata/api_client/models/metadata_prompt_metadata_input.py +96 -0
  484. rapidata/api_client/models/metadata_transcription_metadata_input.py +96 -0
  485. rapidata/api_client/models/multi_asset.py +17 -12
  486. rapidata/api_client/models/multi_asset_assets_inner.py +170 -0
  487. rapidata/api_client/models/multi_asset_input.py +130 -0
  488. rapidata/api_client/models/multi_asset_input1.py +110 -0
  489. rapidata/api_client/models/multi_asset_input1_assets_inner.py +198 -0
  490. rapidata/api_client/models/multi_asset_input2.py +110 -0
  491. rapidata/api_client/models/multi_asset_input3.py +110 -0
  492. rapidata/api_client/models/multi_asset_input3_assets_inner.py +198 -0
  493. rapidata/api_client/models/multi_asset_input_assets_inner.py +156 -0
  494. rapidata/api_client/models/multi_asset_model.py +3 -3
  495. rapidata/api_client/models/multi_compare_truth.py +96 -0
  496. rapidata/api_client/models/naive_referee_info.py +96 -0
  497. rapidata/api_client/models/naive_referee_model.py +2 -2
  498. rapidata/api_client/models/named_classification.py +4 -13
  499. rapidata/api_client/models/never_ending_referee_info.py +94 -0
  500. rapidata/api_client/models/new_user_filter.py +96 -0
  501. rapidata/api_client/models/newsletter_model.py +6 -6
  502. rapidata/api_client/models/not_available_yet_result.py +4 -13
  503. rapidata/api_client/models/not_filter.py +117 -0
  504. rapidata/api_client/models/not_user_filter_model.py +3 -3
  505. rapidata/api_client/models/null_asset.py +14 -9
  506. rapidata/api_client/models/online_pair_maker_config_model.py +3 -3
  507. rapidata/api_client/models/option_of_aggregator_type.py +49 -0
  508. rapidata/api_client/models/or_filter.py +121 -0
  509. rapidata/api_client/models/or_user_filter_model.py +3 -3
  510. rapidata/api_client/models/order_model.py +15 -14
  511. rapidata/api_client/models/order_state.py +2 -2
  512. rapidata/api_client/models/original_filename_metadata.py +12 -1
  513. rapidata/api_client/models/page_info.py +2 -7
  514. rapidata/api_client/models/paged_result_aggregated_orders_model.py +105 -0
  515. rapidata/api_client/models/paged_result_benchmark_query_result.py +105 -0
  516. rapidata/api_client/models/paged_result_campaign_query_result.py +105 -0
  517. rapidata/api_client/models/paged_result_clients_query_result.py +105 -0
  518. rapidata/api_client/models/paged_result_datapoint_model.py +105 -0
  519. rapidata/api_client/models/paged_result_get_compare_workflow_results_result.py +105 -0
  520. rapidata/api_client/models/paged_result_get_grouped_ranking_workflow_results_result.py +105 -0
  521. rapidata/api_client/models/paged_result_get_validation_rapids_result.py +105 -0
  522. rapidata/api_client/models/paged_result_get_workflow_results_result.py +105 -0
  523. rapidata/api_client/models/paged_result_i_workflow_model.py +105 -0
  524. rapidata/api_client/models/paged_result_leaderboard_query_result.py +105 -0
  525. rapidata/api_client/models/paged_result_leaderboards_query_result.py +105 -0
  526. rapidata/api_client/models/paged_result_of_aggregated_orders_model.py +103 -0
  527. rapidata/api_client/models/paged_result_of_benchmark_query_result.py +103 -0
  528. rapidata/api_client/models/paged_result_of_campaign_query_result.py +103 -0
  529. rapidata/api_client/models/paged_result_of_clients_query_result.py +103 -0
  530. rapidata/api_client/models/paged_result_of_get_compare_workflow_results_result.py +103 -0
  531. rapidata/api_client/models/paged_result_of_get_grouped_ranking_workflow_results_result.py +103 -0
  532. rapidata/api_client/models/paged_result_of_get_validation_rapids_result.py +103 -0
  533. rapidata/api_client/models/paged_result_of_get_workflow_results_result.py +103 -0
  534. rapidata/api_client/models/paged_result_of_i_workflow_model.py +103 -0
  535. rapidata/api_client/models/paged_result_of_leaderboards_query_result.py +103 -0
  536. rapidata/api_client/models/paged_result_of_order_model.py +103 -0
  537. rapidata/api_client/models/paged_result_of_participant_by_benchmark.py +103 -0
  538. rapidata/api_client/models/paged_result_of_prompt_by_benchmark_result.py +103 -0
  539. rapidata/api_client/models/paged_result_of_query_audiences_result.py +103 -0
  540. rapidata/api_client/models/paged_result_of_query_datapoints_by_dataset_id_result.py +103 -0
  541. rapidata/api_client/models/paged_result_of_query_job_definitions_result.py +103 -0
  542. rapidata/api_client/models/paged_result_of_query_job_revisions_result.py +103 -0
  543. rapidata/api_client/models/paged_result_of_query_jobs_result.py +103 -0
  544. rapidata/api_client/models/paged_result_of_query_rapids_for_audience_result.py +103 -0
  545. rapidata/api_client/models/paged_result_of_query_validation_rapid_eligibility_result.py +103 -0
  546. rapidata/api_client/models/paged_result_of_rapid_model.py +103 -0
  547. rapidata/api_client/models/paged_result_of_runs_by_leaderboard_result.py +103 -0
  548. rapidata/api_client/models/paged_result_of_sample_by_identifier.py +103 -0
  549. rapidata/api_client/models/paged_result_of_sample_by_participant.py +103 -0
  550. rapidata/api_client/models/paged_result_of_standing_by_leaderboard.py +103 -0
  551. rapidata/api_client/models/paged_result_of_validation_set_model.py +103 -0
  552. rapidata/api_client/models/paged_result_order_model.py +105 -0
  553. rapidata/api_client/models/paged_result_participant_by_benchmark.py +105 -0
  554. rapidata/api_client/models/paged_result_potential_validation_rapid.py +105 -0
  555. rapidata/api_client/models/paged_result_prompt_by_benchmark_result.py +105 -0
  556. rapidata/api_client/models/paged_result_query_audiences_result.py +105 -0
  557. rapidata/api_client/models/paged_result_query_datapoints_by_dataset_id_result.py +105 -0
  558. rapidata/api_client/models/paged_result_query_validation_rapid_eligibility_result.py +105 -0
  559. rapidata/api_client/models/paged_result_rapid_model.py +105 -0
  560. rapidata/api_client/models/paged_result_runs_by_leaderboard_result.py +105 -0
  561. rapidata/api_client/models/paged_result_sample_by_identifier.py +105 -0
  562. rapidata/api_client/models/paged_result_sample_by_participant.py +105 -0
  563. rapidata/api_client/models/paged_result_standing_by_leaderboard.py +105 -0
  564. rapidata/api_client/models/paged_result_validation_set_model.py +105 -0
  565. rapidata/api_client/models/participant_by_benchmark.py +94 -0
  566. rapidata/api_client/models/participant_by_benchmark_paged_result.py +105 -0
  567. rapidata/api_client/models/participant_by_leaderboard.py +113 -0
  568. rapidata/api_client/models/participant_by_leaderboard_paged_result.py +105 -0
  569. rapidata/api_client/models/participant_status.py +38 -0
  570. rapidata/api_client/models/pipeline_id_workflow_config_put_request.py +140 -0
  571. rapidata/api_client/models/polygon_result.py +3 -3
  572. rapidata/api_client/models/polygon_result_coordinate.py +89 -0
  573. rapidata/api_client/models/polygon_result_shape.py +95 -0
  574. rapidata/api_client/models/potential_validation_rapid.py +103 -0
  575. rapidata/api_client/models/potential_validation_rapid_paged_result.py +105 -0
  576. rapidata/api_client/models/potential_validation_rapid_truth.py +280 -0
  577. rapidata/api_client/models/preliminary_download_model.py +5 -5
  578. rapidata/api_client/models/preview_order_model.py +92 -0
  579. rapidata/api_client/models/probabilistic_attach_category_referee_info.py +98 -0
  580. rapidata/api_client/models/problem_details.py +2 -20
  581. rapidata/api_client/models/prompt_asset_metadata_input.py +100 -0
  582. rapidata/api_client/models/prompt_asset_metadata_input_asset.py +154 -0
  583. rapidata/api_client/models/prompt_by_benchmark_result.py +112 -0
  584. rapidata/api_client/models/prompt_by_benchmark_result_paged_result.py +105 -0
  585. rapidata/api_client/models/prompt_by_leaderboard_result.py +90 -0
  586. rapidata/api_client/models/prompt_by_leaderboard_result_paged_result.py +105 -0
  587. rapidata/api_client/models/prompt_metadata.py +12 -1
  588. rapidata/api_client/models/prompt_metadata_input.py +2 -2
  589. rapidata/api_client/models/prompt_type.py +38 -0
  590. rapidata/api_client/models/proxy_file_wrapper.py +129 -0
  591. rapidata/api_client/models/public_order_model.py +2 -2
  592. rapidata/api_client/models/public_rapid_response.py +112 -0
  593. rapidata/api_client/models/query_audiences_result.py +118 -0
  594. rapidata/api_client/models/query_datapoints_by_dataset_id_result.py +95 -0
  595. rapidata/api_client/models/query_job_definitions_result.py +97 -0
  596. rapidata/api_client/models/query_job_revisions_result.py +95 -0
  597. rapidata/api_client/models/query_jobs_result.py +103 -0
  598. rapidata/api_client/models/query_model.py +10 -5
  599. rapidata/api_client/models/query_rapids_for_audience_result.py +150 -0
  600. rapidata/api_client/models/query_validation_model.py +97 -0
  601. rapidata/api_client/models/query_validation_rapid_eligibility_model_query_validation_model.py +107 -0
  602. rapidata/api_client/models/query_validation_rapid_eligibility_result.py +103 -0
  603. rapidata/api_client/models/query_validation_rapid_eligibility_result_truth.py +280 -0
  604. rapidata/api_client/models/rapid_issue.py +2 -2
  605. rapidata/api_client/models/rapid_modality.py +46 -0
  606. rapidata/api_client/models/rapid_model.py +157 -0
  607. rapidata/api_client/models/rapid_model_paged_result.py +105 -0
  608. rapidata/api_client/models/rapid_model_referee.py +154 -0
  609. rapidata/api_client/models/rapid_result_model.py +7 -7
  610. rapidata/api_client/models/rapid_skipped_model.py +5 -5
  611. rapidata/api_client/models/rapid_state.py +3 -2
  612. rapidata/api_client/models/read_bridge_token_keys_result.py +10 -24
  613. rapidata/api_client/models/reference_asset_input.py +100 -0
  614. rapidata/api_client/models/report_model.py +9 -15
  615. rapidata/api_client/models/response_count_filter.py +103 -0
  616. rapidata/api_client/models/response_count_user_filter_model.py +2 -8
  617. rapidata/api_client/models/retrieval_mode.py +2 -2
  618. rapidata/api_client/models/root_filter.py +5 -14
  619. rapidata/api_client/models/run_status.py +39 -0
  620. rapidata/api_client/models/runs_by_leaderboard_result.py +104 -0
  621. rapidata/api_client/models/runs_by_leaderboard_result_paged_result.py +105 -0
  622. rapidata/api_client/models/sample_by_identifier.py +125 -0
  623. rapidata/api_client/models/sample_by_identifier_paged_result.py +105 -0
  624. rapidata/api_client/models/sample_by_participant.py +121 -0
  625. rapidata/api_client/models/sample_by_participant_paged_result.py +105 -0
  626. rapidata/api_client/models/scrub_range.py +2 -2
  627. rapidata/api_client/models/send_survey_model.py +87 -0
  628. rapidata/api_client/models/simple_workflow_config.py +15 -7
  629. rapidata/api_client/models/simple_workflow_config_blueprint.py +37 -23
  630. rapidata/api_client/models/simple_workflow_config_model.py +11 -3
  631. rapidata/api_client/models/simple_workflow_model.py +14 -4
  632. rapidata/api_client/models/simple_workflow_model1.py +4 -11
  633. rapidata/api_client/models/simple_workflow_model_blueprint.py +1 -1
  634. rapidata/api_client/models/sort_criterion.py +5 -11
  635. rapidata/api_client/models/sort_direction.py +2 -2
  636. rapidata/api_client/models/source_url_metadata.py +12 -1
  637. rapidata/api_client/models/standing_by_benchmark.py +113 -0
  638. rapidata/api_client/models/standing_by_leaderboard.py +113 -0
  639. rapidata/api_client/models/standing_by_leaderboard_paged_result.py +105 -0
  640. rapidata/api_client/models/standing_status.py +38 -0
  641. rapidata/api_client/models/standings_by_benchmark_result.py +95 -0
  642. rapidata/api_client/models/standings_by_leaderboard_result.py +95 -0
  643. rapidata/api_client/models/start_preliminary_download_result.py +87 -0
  644. rapidata/api_client/models/sticky_state.py +3 -2
  645. rapidata/api_client/models/stream_file_wrapper.py +138 -0
  646. rapidata/api_client/models/streams_metadata.py +113 -0
  647. rapidata/api_client/models/streams_metadata_model.py +100 -0
  648. rapidata/api_client/models/string_segment.py +105 -0
  649. rapidata/api_client/models/submit_coco_model.py +1 -3
  650. rapidata/api_client/models/submit_order_model.py +92 -0
  651. rapidata/api_client/models/submit_participant_result.py +89 -0
  652. rapidata/api_client/models/submit_prompt_model.py +107 -0
  653. rapidata/api_client/models/submit_prompt_model_prompt_asset.py +202 -0
  654. rapidata/api_client/models/tags_by_benchmark_result.py +87 -0
  655. rapidata/api_client/models/text_asset.py +15 -10
  656. rapidata/api_client/models/text_asset_input.py +120 -0
  657. rapidata/api_client/models/text_metadata.py +18 -2
  658. rapidata/api_client/models/text_metadata_input.py +111 -0
  659. rapidata/api_client/models/text_metadata_model.py +7 -2
  660. rapidata/api_client/models/transcription_metadata.py +9 -1
  661. rapidata/api_client/models/transcription_metadata_input.py +2 -2
  662. rapidata/api_client/models/transcription_word.py +2 -2
  663. rapidata/api_client/models/translated_string.py +2 -2
  664. rapidata/api_client/models/unlock_order_result.py +2 -2
  665. rapidata/api_client/models/update_access_model.py +1 -1
  666. rapidata/api_client/models/update_audience_request.py +113 -0
  667. rapidata/api_client/models/update_benchmark_model.py +99 -0
  668. rapidata/api_client/models/update_benchmark_name_model.py +87 -0
  669. rapidata/api_client/models/update_campaign_model.py +11 -11
  670. rapidata/api_client/models/update_dataset_name_model.py +5 -5
  671. rapidata/api_client/models/update_dimensions_model.py +3 -3
  672. rapidata/api_client/models/update_job_definition_endpoint_input.py +92 -0
  673. rapidata/api_client/models/update_job_endpoint_input.py +92 -0
  674. rapidata/api_client/models/update_leaderboard_model.py +106 -0
  675. rapidata/api_client/models/update_leaderboard_name_model.py +87 -0
  676. rapidata/api_client/models/update_leaderboard_response_config_model.py +89 -0
  677. rapidata/api_client/models/update_order_name_model.py +5 -5
  678. rapidata/api_client/models/update_participant_model.py +92 -0
  679. rapidata/api_client/models/update_participant_name_model.py +87 -0
  680. rapidata/api_client/models/update_priority_model.py +87 -0
  681. rapidata/api_client/models/update_prompt_tags_model.py +87 -0
  682. rapidata/api_client/models/update_should_alert_model.py +87 -0
  683. rapidata/api_client/models/update_validation_rapid_model.py +28 -12
  684. rapidata/api_client/models/update_validation_rapid_model_context_asset.py +160 -0
  685. rapidata/api_client/models/update_validation_rapid_model_truth.py +26 -12
  686. rapidata/api_client/models/update_validation_set_model.py +120 -0
  687. rapidata/api_client/models/upload_asset_result.py +102 -0
  688. rapidata/api_client/models/upload_file_from_url_result.py +87 -0
  689. rapidata/api_client/models/upload_file_result.py +87 -0
  690. rapidata/api_client/models/upload_files_from_s3_bucket_model.py +12 -2
  691. rapidata/api_client/models/upload_text_sources_to_dataset_model.py +3 -3
  692. rapidata/api_client/models/url_asset_input.py +100 -0
  693. rapidata/api_client/models/user_action_restriction.py +37 -0
  694. rapidata/api_client/models/user_action_restriction_filter.py +101 -0
  695. rapidata/api_client/models/user_score_filter.py +102 -0
  696. rapidata/api_client/models/user_state.py +38 -0
  697. rapidata/api_client/models/user_state_filter.py +101 -0
  698. rapidata/api_client/models/validation_chance.py +20 -3
  699. rapidata/api_client/models/validation_problem_details.py +117 -0
  700. rapidata/api_client/models/validation_set_model.py +39 -5
  701. rapidata/api_client/models/validation_set_overview_model.py +2 -2
  702. rapidata/api_client/models/validation_set_validation_set_id_rapid_post_payload_parameter.py +252 -0
  703. rapidata/api_client/models/validation_set_validation_set_id_rapid_post_truth_parameter.py +280 -0
  704. rapidata/api_client/models/validation_set_zip_post_request_blueprint.py +252 -0
  705. rapidata/api_client/models/video_duration_metadata.py +109 -0
  706. rapidata/api_client/models/video_duration_metadata_model.py +96 -0
  707. rapidata/api_client/models/vote_matrix_result.py +91 -0
  708. rapidata/api_client/models/workflow_aggregation_step_model.py +3 -12
  709. rapidata/api_client/models/workflow_config_artifact_model_workflow_config.py +23 -9
  710. rapidata/api_client/models/workflow_state.py +2 -2
  711. rapidata/api_client/models/zip_entry_file_wrapper.py +151 -0
  712. rapidata/api_client/rest.py +2 -2
  713. rapidata/api_client_README.md +469 -309
  714. rapidata/rapidata_client/__init__.py +23 -22
  715. rapidata/rapidata_client/api/rapidata_api_client.py +253 -0
  716. rapidata/rapidata_client/audience/__init__.py +2 -0
  717. rapidata/rapidata_client/audience/audience_example_handler.py +168 -0
  718. rapidata/rapidata_client/audience/rapidata_audience.py +287 -0
  719. rapidata/rapidata_client/audience/rapidata_audience_manager.py +162 -0
  720. rapidata/rapidata_client/benchmark/__init__.py +0 -0
  721. rapidata/rapidata_client/benchmark/_detail_mapper.py +34 -0
  722. rapidata/rapidata_client/benchmark/leaderboard/__init__.py +0 -0
  723. rapidata/rapidata_client/benchmark/leaderboard/rapidata_leaderboard.py +257 -0
  724. rapidata/rapidata_client/benchmark/participant/__init__.py +0 -0
  725. rapidata/rapidata_client/benchmark/participant/_participant.py +146 -0
  726. rapidata/rapidata_client/benchmark/rapidata_benchmark.py +592 -0
  727. rapidata/rapidata_client/benchmark/rapidata_benchmark_manager.py +216 -0
  728. rapidata/rapidata_client/config/__init__.py +4 -0
  729. rapidata/rapidata_client/config/logger.py +135 -0
  730. rapidata/rapidata_client/config/logging_config.py +55 -0
  731. rapidata/rapidata_client/config/managed_print.py +6 -0
  732. rapidata/rapidata_client/config/order_config.py +14 -0
  733. rapidata/rapidata_client/config/rapidata_config.py +36 -0
  734. rapidata/rapidata_client/config/tracer.py +184 -0
  735. rapidata/rapidata_client/config/upload_config.py +64 -0
  736. rapidata/rapidata_client/datapoints/__init__.py +8 -0
  737. rapidata/rapidata_client/datapoints/_asset_uploader.py +194 -0
  738. rapidata/rapidata_client/datapoints/_datapoint.py +92 -0
  739. rapidata/rapidata_client/datapoints/_datapoint_uploader.py +47 -0
  740. rapidata/rapidata_client/datapoints/_datapoints_validator.py +70 -0
  741. rapidata/rapidata_client/datapoints/_single_flight_cache.py +82 -0
  742. rapidata/rapidata_client/datapoints/assets/__init__.py +0 -0
  743. rapidata/rapidata_client/datapoints/assets/constants.py +7 -0
  744. rapidata/rapidata_client/{metadata → datapoints/metadata}/__init__.py +1 -1
  745. rapidata/rapidata_client/datapoints/metadata/_private_text_metadata.py +16 -0
  746. rapidata/rapidata_client/datapoints/metadata/_prompt_identifier_metadata.py +14 -0
  747. rapidata/rapidata_client/datapoints/metadata/_public_text_metadata.py +16 -0
  748. rapidata/rapidata_client/{metadata → datapoints/metadata}/_select_words_metadata.py +4 -5
  749. rapidata/rapidata_client/dataset/__init__.py +1 -0
  750. rapidata/rapidata_client/dataset/_rapidata_dataset.py +55 -0
  751. rapidata/rapidata_client/demographic/demographic_manager.py +44 -19
  752. rapidata/rapidata_client/exceptions/__init__.py +1 -0
  753. rapidata/rapidata_client/exceptions/failed_upload_exception.py +27 -0
  754. rapidata/rapidata_client/filter/__init__.py +3 -0
  755. rapidata/rapidata_client/filter/_backend_filter_mapper.py +134 -0
  756. rapidata/rapidata_client/filter/_base_filter.py +58 -2
  757. rapidata/rapidata_client/filter/age_filter.py +26 -10
  758. rapidata/rapidata_client/filter/and_filter.py +55 -0
  759. rapidata/rapidata_client/filter/campaign_filter.py +21 -10
  760. rapidata/rapidata_client/filter/country_filter.py +46 -12
  761. rapidata/rapidata_client/filter/custom_filter.py +25 -12
  762. rapidata/rapidata_client/filter/device_filter.py +38 -0
  763. rapidata/rapidata_client/filter/gender_filter.py +25 -10
  764. rapidata/rapidata_client/filter/language_filter.py +51 -21
  765. rapidata/rapidata_client/filter/models/age_group.py +14 -12
  766. rapidata/rapidata_client/filter/models/device_type.py +20 -0
  767. rapidata/rapidata_client/filter/models/gender.py +12 -8
  768. rapidata/rapidata_client/filter/new_user_filter.py +14 -4
  769. rapidata/rapidata_client/filter/not_filter.py +35 -11
  770. rapidata/rapidata_client/filter/or_filter.py +36 -11
  771. rapidata/rapidata_client/filter/rapidata_filters.py +30 -25
  772. rapidata/rapidata_client/filter/response_count_filter.py +51 -20
  773. rapidata/rapidata_client/filter/user_score_filter.py +62 -24
  774. rapidata/rapidata_client/job/__init__.py +3 -0
  775. rapidata/rapidata_client/job/job_definition.py +110 -0
  776. rapidata/rapidata_client/job/job_manager.py +758 -0
  777. rapidata/rapidata_client/job/rapidata_job.py +326 -0
  778. rapidata/rapidata_client/order/__init__.py +2 -0
  779. rapidata/rapidata_client/order/_rapidata_order_builder.py +286 -193
  780. rapidata/rapidata_client/order/rapidata_order.py +329 -153
  781. rapidata/rapidata_client/order/rapidata_order_manager.py +722 -420
  782. rapidata/rapidata_client/rapidata_client.py +130 -26
  783. rapidata/rapidata_client/referee/__init__.py +1 -1
  784. rapidata/rapidata_client/referee/_base_referee.py +14 -3
  785. rapidata/rapidata_client/referee/_early_stopping_referee.py +32 -17
  786. rapidata/rapidata_client/referee/_naive_referee.py +24 -3
  787. rapidata/rapidata_client/results/__init__.py +3 -0
  788. rapidata/rapidata_client/{order → results}/rapidata_results.py +98 -67
  789. rapidata/rapidata_client/selection/__init__.py +2 -1
  790. rapidata/rapidata_client/selection/_base_selection.py +9 -2
  791. rapidata/rapidata_client/selection/ab_test_selection.py +28 -20
  792. rapidata/rapidata_client/selection/capped_selection.py +23 -16
  793. rapidata/rapidata_client/selection/conditional_validation_selection.py +43 -24
  794. rapidata/rapidata_client/selection/demographic_selection.py +21 -6
  795. rapidata/rapidata_client/selection/effort_selection.py +49 -0
  796. rapidata/rapidata_client/selection/labeling_selection.py +36 -12
  797. rapidata/rapidata_client/selection/{retrieval_modes.py → rapidata_retrieval_modes.py} +10 -7
  798. rapidata/rapidata_client/selection/rapidata_selections.py +31 -21
  799. rapidata/rapidata_client/selection/shuffling_selection.py +21 -13
  800. rapidata/rapidata_client/selection/static_selection.py +20 -9
  801. rapidata/rapidata_client/selection/validation_selection.py +20 -4
  802. rapidata/rapidata_client/settings/__init__.py +4 -1
  803. rapidata/rapidata_client/settings/_rapidata_setting.py +22 -3
  804. rapidata/rapidata_client/settings/alert_on_fast_response.py +8 -5
  805. rapidata/rapidata_client/settings/allow_neither_both.py +17 -0
  806. rapidata/rapidata_client/settings/custom_setting.py +3 -2
  807. rapidata/rapidata_client/settings/free_text_minimum_characters.py +9 -4
  808. rapidata/rapidata_client/settings/models/translation_behaviour_options.py +3 -2
  809. rapidata/rapidata_client/settings/mute_video.py +15 -0
  810. rapidata/rapidata_client/settings/no_shuffle.py +4 -2
  811. rapidata/rapidata_client/settings/play_video_until_the_end.py +7 -4
  812. rapidata/rapidata_client/settings/rapidata_settings.py +28 -16
  813. rapidata/rapidata_client/settings/swap_context_instruction.py +20 -0
  814. rapidata/rapidata_client/settings/translation_behaviour.py +7 -5
  815. rapidata/rapidata_client/utils/__init__.py +3 -0
  816. rapidata/rapidata_client/utils/threaded_uploader.py +153 -0
  817. rapidata/rapidata_client/validation/__init__.py +2 -0
  818. rapidata/rapidata_client/validation/rapidata_validation_set.py +106 -12
  819. rapidata/rapidata_client/validation/rapids/__init__.py +2 -0
  820. rapidata/rapidata_client/validation/rapids/_validation_rapid_uploader.py +48 -0
  821. rapidata/rapidata_client/validation/rapids/box.py +37 -12
  822. rapidata/rapidata_client/validation/rapids/rapids.py +29 -104
  823. rapidata/rapidata_client/validation/rapids/rapids_manager.py +371 -214
  824. rapidata/rapidata_client/validation/validation_set_manager.py +529 -227
  825. rapidata/rapidata_client/workflow/__init__.py +2 -2
  826. rapidata/rapidata_client/workflow/_base_workflow.py +25 -7
  827. rapidata/rapidata_client/workflow/_classify_workflow.py +58 -15
  828. rapidata/rapidata_client/workflow/_compare_workflow.py +44 -9
  829. rapidata/rapidata_client/workflow/_draw_workflow.py +40 -10
  830. rapidata/rapidata_client/workflow/_evaluation_workflow.py +28 -7
  831. rapidata/rapidata_client/workflow/_free_text_workflow.py +46 -9
  832. rapidata/rapidata_client/workflow/_locate_workflow.py +40 -10
  833. rapidata/rapidata_client/workflow/_multi_ranking_workflow.py +90 -0
  834. rapidata/rapidata_client/workflow/_select_words_workflow.py +51 -11
  835. rapidata/rapidata_client/workflow/_timestamp_workflow.py +42 -11
  836. rapidata/service/__init__.py +0 -1
  837. rapidata/service/credential_manager.py +18 -18
  838. rapidata/service/openapi_service.py +128 -28
  839. rapidata/types/__init__.py +149 -0
  840. rapidata-3.0.1.dist-info/METADATA +32 -0
  841. rapidata-3.0.1.dist-info/RECORD +1089 -0
  842. {rapidata-2.23.2.dist-info → rapidata-3.0.1.dist-info}/WHEEL +1 -1
  843. rapidata/rapidata_client/api/rapidata_exception.py +0 -107
  844. rapidata/rapidata_client/assets/__init__.py +0 -10
  845. rapidata/rapidata_client/assets/_base_asset.py +0 -11
  846. rapidata/rapidata_client/assets/_media_asset.py +0 -306
  847. rapidata/rapidata_client/assets/_multi_asset.py +0 -66
  848. rapidata/rapidata_client/assets/_sessions.py +0 -35
  849. rapidata/rapidata_client/assets/_text_asset.py +0 -34
  850. rapidata/rapidata_client/assets/data_type_enum.py +0 -7
  851. rapidata/rapidata_client/country_codes/__init__.py +0 -1
  852. rapidata/rapidata_client/country_codes/country_codes.py +0 -19
  853. rapidata/rapidata_client/logging/__init__.py +0 -2
  854. rapidata/rapidata_client/logging/logger.py +0 -47
  855. rapidata/rapidata_client/logging/output_manager.py +0 -16
  856. rapidata/rapidata_client/metadata/_private_text_metadata.py +0 -17
  857. rapidata/rapidata_client/metadata/_prompt_metadata.py +0 -18
  858. rapidata/rapidata_client/metadata/_public_text_metadata.py +0 -17
  859. rapidata/rapidata_client/order/_rapidata_dataset.py +0 -443
  860. rapidata/rapidata_client/workflow/_ranking_workflow.py +0 -51
  861. rapidata/service/local_file_service.py +0 -25
  862. rapidata-2.23.2.dist-info/METADATA +0 -34
  863. rapidata-2.23.2.dist-info/RECORD +0 -523
  864. /rapidata/rapidata_client/{metadata → datapoints/metadata}/_base_metadata.py +0 -0
  865. {rapidata-2.23.2.dist-info → rapidata-3.0.1.dist-info/licenses}/LICENSE +0 -0
@@ -0,0 +1,2216 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Rapidata Asset API
5
+
6
+ The API for the Rapidata Asset service
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, StrictFloat, StrictInt, StrictStr
20
+ from typing import Optional, Union
21
+ from typing_extensions import Annotated
22
+ from rapidata.api_client.models.create_demographic_rapid_model import CreateDemographicRapidModel
23
+ from rapidata.api_client.models.create_rapid_result import CreateRapidResult
24
+ from rapidata.api_client.models.get_public_responses_result import GetPublicResponsesResult
25
+ from rapidata.api_client.models.get_responses_for_rapid_result import GetResponsesForRapidResult
26
+ from rapidata.api_client.models.paged_result_of_query_validation_rapid_eligibility_result import PagedResultOfQueryValidationRapidEligibilityResult
27
+ from rapidata.api_client.models.paged_result_of_rapid_model import PagedResultOfRapidModel
28
+ from rapidata.api_client.models.query_model import QueryModel
29
+ from rapidata.api_client.models.query_validation_rapid_eligibility_model_query_validation_model import QueryValidationRapidEligibilityModelQueryValidationModel
30
+ from rapidata.api_client.models.update_validation_rapid_model import UpdateValidationRapidModel
31
+
32
+ from rapidata.api_client.api_client import ApiClient, RequestSerialized
33
+ from rapidata.api_client.api_response import ApiResponse
34
+ from rapidata.api_client.rest import RESTResponseType
35
+
36
+
37
+ class CustomerRapidApi:
38
+ """NOTE: This class is auto generated by OpenAPI Generator
39
+ Ref: https://openapi-generator.tech
40
+
41
+ Do not edit the class manually.
42
+ """
43
+
44
+ def __init__(self, api_client=None) -> None:
45
+ if api_client is None:
46
+ api_client = ApiClient.get_default()
47
+ self.api_client = api_client
48
+
49
+
50
+ @validate_call
51
+ def rapid_correlation_id_validation_potential_get(
52
+ self,
53
+ correlation_id: StrictStr,
54
+ min_responses: Optional[StrictInt] = None,
55
+ min_confidence: Optional[Union[StrictFloat, StrictInt]] = None,
56
+ target_group_id: Optional[StrictStr] = None,
57
+ request: Optional[QueryValidationRapidEligibilityModelQueryValidationModel] = None,
58
+ _request_timeout: Union[
59
+ None,
60
+ Annotated[StrictFloat, Field(gt=0)],
61
+ Tuple[
62
+ Annotated[StrictFloat, Field(gt=0)],
63
+ Annotated[StrictFloat, Field(gt=0)]
64
+ ]
65
+ ] = None,
66
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
67
+ _content_type: Optional[StrictStr] = None,
68
+ _headers: Optional[Dict[StrictStr, Any]] = None,
69
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
70
+ ) -> PagedResultOfQueryValidationRapidEligibilityResult:
71
+ """Queries rapids that are potentially eligible for validation set creation.
72
+
73
+
74
+ :param correlation_id: (required)
75
+ :type correlation_id: str
76
+ :param min_responses:
77
+ :type min_responses: int
78
+ :param min_confidence:
79
+ :type min_confidence: float
80
+ :param target_group_id:
81
+ :type target_group_id: str
82
+ :param request:
83
+ :type request: QueryValidationRapidEligibilityModelQueryValidationModel
84
+ :param _request_timeout: timeout setting for this request. If one
85
+ number provided, it will be total request
86
+ timeout. It can also be a pair (tuple) of
87
+ (connection, read) timeouts.
88
+ :type _request_timeout: int, tuple(int, int), optional
89
+ :param _request_auth: set to override the auth_settings for an a single
90
+ request; this effectively ignores the
91
+ authentication in the spec for a single request.
92
+ :type _request_auth: dict, optional
93
+ :param _content_type: force content-type for the request.
94
+ :type _content_type: str, Optional
95
+ :param _headers: set to override the headers for a single
96
+ request; this effectively ignores the headers
97
+ in the spec for a single request.
98
+ :type _headers: dict, optional
99
+ :param _host_index: set to override the host_index for a single
100
+ request; this effectively ignores the host_index
101
+ in the spec for a single request.
102
+ :type _host_index: int, optional
103
+ :return: Returns the result object.
104
+ """ # noqa: E501
105
+
106
+ _param = self._rapid_correlation_id_validation_potential_get_serialize(
107
+ correlation_id=correlation_id,
108
+ min_responses=min_responses,
109
+ min_confidence=min_confidence,
110
+ target_group_id=target_group_id,
111
+ request=request,
112
+ _request_auth=_request_auth,
113
+ _content_type=_content_type,
114
+ _headers=_headers,
115
+ _host_index=_host_index
116
+ )
117
+
118
+ _response_types_map: Dict[str, Optional[str]] = {
119
+ '200': "PagedResultOfQueryValidationRapidEligibilityResult",
120
+ }
121
+ response_data = self.api_client.call_api(
122
+ *_param,
123
+ _request_timeout=_request_timeout
124
+ )
125
+ response_data.read()
126
+ return self.api_client.response_deserialize(
127
+ response_data=response_data,
128
+ response_types_map=_response_types_map,
129
+ ).data
130
+
131
+
132
+ @validate_call
133
+ def rapid_correlation_id_validation_potential_get_with_http_info(
134
+ self,
135
+ correlation_id: StrictStr,
136
+ min_responses: Optional[StrictInt] = None,
137
+ min_confidence: Optional[Union[StrictFloat, StrictInt]] = None,
138
+ target_group_id: Optional[StrictStr] = None,
139
+ request: Optional[QueryValidationRapidEligibilityModelQueryValidationModel] = None,
140
+ _request_timeout: Union[
141
+ None,
142
+ Annotated[StrictFloat, Field(gt=0)],
143
+ Tuple[
144
+ Annotated[StrictFloat, Field(gt=0)],
145
+ Annotated[StrictFloat, Field(gt=0)]
146
+ ]
147
+ ] = None,
148
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
149
+ _content_type: Optional[StrictStr] = None,
150
+ _headers: Optional[Dict[StrictStr, Any]] = None,
151
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
152
+ ) -> ApiResponse[PagedResultOfQueryValidationRapidEligibilityResult]:
153
+ """Queries rapids that are potentially eligible for validation set creation.
154
+
155
+
156
+ :param correlation_id: (required)
157
+ :type correlation_id: str
158
+ :param min_responses:
159
+ :type min_responses: int
160
+ :param min_confidence:
161
+ :type min_confidence: float
162
+ :param target_group_id:
163
+ :type target_group_id: str
164
+ :param request:
165
+ :type request: QueryValidationRapidEligibilityModelQueryValidationModel
166
+ :param _request_timeout: timeout setting for this request. If one
167
+ number provided, it will be total request
168
+ timeout. It can also be a pair (tuple) of
169
+ (connection, read) timeouts.
170
+ :type _request_timeout: int, tuple(int, int), optional
171
+ :param _request_auth: set to override the auth_settings for an a single
172
+ request; this effectively ignores the
173
+ authentication in the spec for a single request.
174
+ :type _request_auth: dict, optional
175
+ :param _content_type: force content-type for the request.
176
+ :type _content_type: str, Optional
177
+ :param _headers: set to override the headers for a single
178
+ request; this effectively ignores the headers
179
+ in the spec for a single request.
180
+ :type _headers: dict, optional
181
+ :param _host_index: set to override the host_index for a single
182
+ request; this effectively ignores the host_index
183
+ in the spec for a single request.
184
+ :type _host_index: int, optional
185
+ :return: Returns the result object.
186
+ """ # noqa: E501
187
+
188
+ _param = self._rapid_correlation_id_validation_potential_get_serialize(
189
+ correlation_id=correlation_id,
190
+ min_responses=min_responses,
191
+ min_confidence=min_confidence,
192
+ target_group_id=target_group_id,
193
+ request=request,
194
+ _request_auth=_request_auth,
195
+ _content_type=_content_type,
196
+ _headers=_headers,
197
+ _host_index=_host_index
198
+ )
199
+
200
+ _response_types_map: Dict[str, Optional[str]] = {
201
+ '200': "PagedResultOfQueryValidationRapidEligibilityResult",
202
+ }
203
+ response_data = self.api_client.call_api(
204
+ *_param,
205
+ _request_timeout=_request_timeout
206
+ )
207
+ response_data.read()
208
+ return self.api_client.response_deserialize(
209
+ response_data=response_data,
210
+ response_types_map=_response_types_map,
211
+ )
212
+
213
+
214
+ @validate_call
215
+ def rapid_correlation_id_validation_potential_get_without_preload_content(
216
+ self,
217
+ correlation_id: StrictStr,
218
+ min_responses: Optional[StrictInt] = None,
219
+ min_confidence: Optional[Union[StrictFloat, StrictInt]] = None,
220
+ target_group_id: Optional[StrictStr] = None,
221
+ request: Optional[QueryValidationRapidEligibilityModelQueryValidationModel] = None,
222
+ _request_timeout: Union[
223
+ None,
224
+ Annotated[StrictFloat, Field(gt=0)],
225
+ Tuple[
226
+ Annotated[StrictFloat, Field(gt=0)],
227
+ Annotated[StrictFloat, Field(gt=0)]
228
+ ]
229
+ ] = None,
230
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
231
+ _content_type: Optional[StrictStr] = None,
232
+ _headers: Optional[Dict[StrictStr, Any]] = None,
233
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
234
+ ) -> RESTResponseType:
235
+ """Queries rapids that are potentially eligible for validation set creation.
236
+
237
+
238
+ :param correlation_id: (required)
239
+ :type correlation_id: str
240
+ :param min_responses:
241
+ :type min_responses: int
242
+ :param min_confidence:
243
+ :type min_confidence: float
244
+ :param target_group_id:
245
+ :type target_group_id: str
246
+ :param request:
247
+ :type request: QueryValidationRapidEligibilityModelQueryValidationModel
248
+ :param _request_timeout: timeout setting for this request. If one
249
+ number provided, it will be total request
250
+ timeout. It can also be a pair (tuple) of
251
+ (connection, read) timeouts.
252
+ :type _request_timeout: int, tuple(int, int), optional
253
+ :param _request_auth: set to override the auth_settings for an a single
254
+ request; this effectively ignores the
255
+ authentication in the spec for a single request.
256
+ :type _request_auth: dict, optional
257
+ :param _content_type: force content-type for the request.
258
+ :type _content_type: str, Optional
259
+ :param _headers: set to override the headers for a single
260
+ request; this effectively ignores the headers
261
+ in the spec for a single request.
262
+ :type _headers: dict, optional
263
+ :param _host_index: set to override the host_index for a single
264
+ request; this effectively ignores the host_index
265
+ in the spec for a single request.
266
+ :type _host_index: int, optional
267
+ :return: Returns the result object.
268
+ """ # noqa: E501
269
+
270
+ _param = self._rapid_correlation_id_validation_potential_get_serialize(
271
+ correlation_id=correlation_id,
272
+ min_responses=min_responses,
273
+ min_confidence=min_confidence,
274
+ target_group_id=target_group_id,
275
+ request=request,
276
+ _request_auth=_request_auth,
277
+ _content_type=_content_type,
278
+ _headers=_headers,
279
+ _host_index=_host_index
280
+ )
281
+
282
+ _response_types_map: Dict[str, Optional[str]] = {
283
+ '200': "PagedResultOfQueryValidationRapidEligibilityResult",
284
+ }
285
+ response_data = self.api_client.call_api(
286
+ *_param,
287
+ _request_timeout=_request_timeout
288
+ )
289
+ return response_data.response
290
+
291
+
292
+ def _rapid_correlation_id_validation_potential_get_serialize(
293
+ self,
294
+ correlation_id,
295
+ min_responses,
296
+ min_confidence,
297
+ target_group_id,
298
+ request,
299
+ _request_auth,
300
+ _content_type,
301
+ _headers,
302
+ _host_index,
303
+ ) -> RequestSerialized:
304
+
305
+ _host = None
306
+
307
+ _collection_formats: Dict[str, str] = {
308
+ }
309
+
310
+ _path_params: Dict[str, str] = {}
311
+ _query_params: List[Tuple[str, str]] = []
312
+ _header_params: Dict[str, Optional[str]] = _headers or {}
313
+ _form_params: List[Tuple[str, str]] = []
314
+ _files: Dict[
315
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
316
+ ] = {}
317
+ _body_params: Optional[bytes] = None
318
+
319
+ # process the path parameters
320
+ if correlation_id is not None:
321
+ _path_params['correlationId'] = correlation_id
322
+ # process the query parameters
323
+ if min_responses is not None:
324
+
325
+ _query_params.append(('MinResponses', min_responses))
326
+
327
+ if min_confidence is not None:
328
+
329
+ _query_params.append(('MinConfidence', min_confidence))
330
+
331
+ if target_group_id is not None:
332
+
333
+ _query_params.append(('TargetGroupId', target_group_id))
334
+
335
+ if request is not None:
336
+
337
+ _query_params.append(('request', request))
338
+
339
+ # process the header parameters
340
+ # process the form parameters
341
+ # process the body parameter
342
+
343
+
344
+ # set the HTTP header `Accept`
345
+ if 'Accept' not in _header_params:
346
+ _header_params['Accept'] = self.api_client.select_header_accept(
347
+ [
348
+ 'text/plain',
349
+ 'application/json',
350
+ 'text/json'
351
+ ]
352
+ )
353
+
354
+
355
+ # authentication setting
356
+ _auth_settings: List[str] = [
357
+ 'OAuth2',
358
+ 'OpenIdConnect',
359
+ 'Bearer'
360
+ ]
361
+
362
+ return self.api_client.param_serialize(
363
+ method='GET',
364
+ resource_path='/rapid/{correlationId}/validation-potential',
365
+ path_params=_path_params,
366
+ query_params=_query_params,
367
+ header_params=_header_params,
368
+ body=_body_params,
369
+ post_params=_form_params,
370
+ files=_files,
371
+ auth_settings=_auth_settings,
372
+ collection_formats=_collection_formats,
373
+ _host=_host,
374
+ _request_auth=_request_auth
375
+ )
376
+
377
+
378
+
379
+
380
+ @validate_call
381
+ def rapid_demographic_post(
382
+ self,
383
+ create_demographic_rapid_model: Annotated[CreateDemographicRapidModel, Field(description="The model containing the demographic rapid.")],
384
+ _request_timeout: Union[
385
+ None,
386
+ Annotated[StrictFloat, Field(gt=0)],
387
+ Tuple[
388
+ Annotated[StrictFloat, Field(gt=0)],
389
+ Annotated[StrictFloat, Field(gt=0)]
390
+ ]
391
+ ] = None,
392
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
393
+ _content_type: Optional[StrictStr] = None,
394
+ _headers: Optional[Dict[StrictStr, Any]] = None,
395
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
396
+ ) -> CreateRapidResult:
397
+ """Creates a new Demographic Rapid with JSON body.
398
+
399
+
400
+ :param create_demographic_rapid_model: The model containing the demographic rapid. (required)
401
+ :type create_demographic_rapid_model: CreateDemographicRapidModel
402
+ :param _request_timeout: timeout setting for this request. If one
403
+ number provided, it will be total request
404
+ timeout. It can also be a pair (tuple) of
405
+ (connection, read) timeouts.
406
+ :type _request_timeout: int, tuple(int, int), optional
407
+ :param _request_auth: set to override the auth_settings for an a single
408
+ request; this effectively ignores the
409
+ authentication in the spec for a single request.
410
+ :type _request_auth: dict, optional
411
+ :param _content_type: force content-type for the request.
412
+ :type _content_type: str, Optional
413
+ :param _headers: set to override the headers for a single
414
+ request; this effectively ignores the headers
415
+ in the spec for a single request.
416
+ :type _headers: dict, optional
417
+ :param _host_index: set to override the host_index for a single
418
+ request; this effectively ignores the host_index
419
+ in the spec for a single request.
420
+ :type _host_index: int, optional
421
+ :return: Returns the result object.
422
+ """ # noqa: E501
423
+
424
+ _param = self._rapid_demographic_post_serialize(
425
+ create_demographic_rapid_model=create_demographic_rapid_model,
426
+ _request_auth=_request_auth,
427
+ _content_type=_content_type,
428
+ _headers=_headers,
429
+ _host_index=_host_index
430
+ )
431
+
432
+ _response_types_map: Dict[str, Optional[str]] = {
433
+ '200': "CreateRapidResult",
434
+ }
435
+ response_data = self.api_client.call_api(
436
+ *_param,
437
+ _request_timeout=_request_timeout
438
+ )
439
+ response_data.read()
440
+ return self.api_client.response_deserialize(
441
+ response_data=response_data,
442
+ response_types_map=_response_types_map,
443
+ ).data
444
+
445
+
446
+ @validate_call
447
+ def rapid_demographic_post_with_http_info(
448
+ self,
449
+ create_demographic_rapid_model: Annotated[CreateDemographicRapidModel, Field(description="The model containing the demographic rapid.")],
450
+ _request_timeout: Union[
451
+ None,
452
+ Annotated[StrictFloat, Field(gt=0)],
453
+ Tuple[
454
+ Annotated[StrictFloat, Field(gt=0)],
455
+ Annotated[StrictFloat, Field(gt=0)]
456
+ ]
457
+ ] = None,
458
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
459
+ _content_type: Optional[StrictStr] = None,
460
+ _headers: Optional[Dict[StrictStr, Any]] = None,
461
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
462
+ ) -> ApiResponse[CreateRapidResult]:
463
+ """Creates a new Demographic Rapid with JSON body.
464
+
465
+
466
+ :param create_demographic_rapid_model: The model containing the demographic rapid. (required)
467
+ :type create_demographic_rapid_model: CreateDemographicRapidModel
468
+ :param _request_timeout: timeout setting for this request. If one
469
+ number provided, it will be total request
470
+ timeout. It can also be a pair (tuple) of
471
+ (connection, read) timeouts.
472
+ :type _request_timeout: int, tuple(int, int), optional
473
+ :param _request_auth: set to override the auth_settings for an a single
474
+ request; this effectively ignores the
475
+ authentication in the spec for a single request.
476
+ :type _request_auth: dict, optional
477
+ :param _content_type: force content-type for the request.
478
+ :type _content_type: str, Optional
479
+ :param _headers: set to override the headers for a single
480
+ request; this effectively ignores the headers
481
+ in the spec for a single request.
482
+ :type _headers: dict, optional
483
+ :param _host_index: set to override the host_index for a single
484
+ request; this effectively ignores the host_index
485
+ in the spec for a single request.
486
+ :type _host_index: int, optional
487
+ :return: Returns the result object.
488
+ """ # noqa: E501
489
+
490
+ _param = self._rapid_demographic_post_serialize(
491
+ create_demographic_rapid_model=create_demographic_rapid_model,
492
+ _request_auth=_request_auth,
493
+ _content_type=_content_type,
494
+ _headers=_headers,
495
+ _host_index=_host_index
496
+ )
497
+
498
+ _response_types_map: Dict[str, Optional[str]] = {
499
+ '200': "CreateRapidResult",
500
+ }
501
+ response_data = self.api_client.call_api(
502
+ *_param,
503
+ _request_timeout=_request_timeout
504
+ )
505
+ response_data.read()
506
+ return self.api_client.response_deserialize(
507
+ response_data=response_data,
508
+ response_types_map=_response_types_map,
509
+ )
510
+
511
+
512
+ @validate_call
513
+ def rapid_demographic_post_without_preload_content(
514
+ self,
515
+ create_demographic_rapid_model: Annotated[CreateDemographicRapidModel, Field(description="The model containing the demographic rapid.")],
516
+ _request_timeout: Union[
517
+ None,
518
+ Annotated[StrictFloat, Field(gt=0)],
519
+ Tuple[
520
+ Annotated[StrictFloat, Field(gt=0)],
521
+ Annotated[StrictFloat, Field(gt=0)]
522
+ ]
523
+ ] = None,
524
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
525
+ _content_type: Optional[StrictStr] = None,
526
+ _headers: Optional[Dict[StrictStr, Any]] = None,
527
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
528
+ ) -> RESTResponseType:
529
+ """Creates a new Demographic Rapid with JSON body.
530
+
531
+
532
+ :param create_demographic_rapid_model: The model containing the demographic rapid. (required)
533
+ :type create_demographic_rapid_model: CreateDemographicRapidModel
534
+ :param _request_timeout: timeout setting for this request. If one
535
+ number provided, it will be total request
536
+ timeout. It can also be a pair (tuple) of
537
+ (connection, read) timeouts.
538
+ :type _request_timeout: int, tuple(int, int), optional
539
+ :param _request_auth: set to override the auth_settings for an a single
540
+ request; this effectively ignores the
541
+ authentication in the spec for a single request.
542
+ :type _request_auth: dict, optional
543
+ :param _content_type: force content-type for the request.
544
+ :type _content_type: str, Optional
545
+ :param _headers: set to override the headers for a single
546
+ request; this effectively ignores the headers
547
+ in the spec for a single request.
548
+ :type _headers: dict, optional
549
+ :param _host_index: set to override the host_index for a single
550
+ request; this effectively ignores the host_index
551
+ in the spec for a single request.
552
+ :type _host_index: int, optional
553
+ :return: Returns the result object.
554
+ """ # noqa: E501
555
+
556
+ _param = self._rapid_demographic_post_serialize(
557
+ create_demographic_rapid_model=create_demographic_rapid_model,
558
+ _request_auth=_request_auth,
559
+ _content_type=_content_type,
560
+ _headers=_headers,
561
+ _host_index=_host_index
562
+ )
563
+
564
+ _response_types_map: Dict[str, Optional[str]] = {
565
+ '200': "CreateRapidResult",
566
+ }
567
+ response_data = self.api_client.call_api(
568
+ *_param,
569
+ _request_timeout=_request_timeout
570
+ )
571
+ return response_data.response
572
+
573
+
574
+ def _rapid_demographic_post_serialize(
575
+ self,
576
+ create_demographic_rapid_model,
577
+ _request_auth,
578
+ _content_type,
579
+ _headers,
580
+ _host_index,
581
+ ) -> RequestSerialized:
582
+
583
+ _host = None
584
+
585
+ _collection_formats: Dict[str, str] = {
586
+ }
587
+
588
+ _path_params: Dict[str, str] = {}
589
+ _query_params: List[Tuple[str, str]] = []
590
+ _header_params: Dict[str, Optional[str]] = _headers or {}
591
+ _form_params: List[Tuple[str, str]] = []
592
+ _files: Dict[
593
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
594
+ ] = {}
595
+ _body_params: Optional[bytes] = None
596
+
597
+ # process the path parameters
598
+ # process the query parameters
599
+ # process the header parameters
600
+ # process the form parameters
601
+ # process the body parameter
602
+ if create_demographic_rapid_model is not None:
603
+ _body_params = create_demographic_rapid_model
604
+
605
+
606
+ # set the HTTP header `Accept`
607
+ if 'Accept' not in _header_params:
608
+ _header_params['Accept'] = self.api_client.select_header_accept(
609
+ [
610
+ 'text/plain',
611
+ 'application/json',
612
+ 'text/json'
613
+ ]
614
+ )
615
+
616
+ # set the HTTP header `Content-Type`
617
+ if _content_type:
618
+ _header_params['Content-Type'] = _content_type
619
+ else:
620
+ _default_content_type = (
621
+ self.api_client.select_header_content_type(
622
+ [
623
+ 'application/json',
624
+ 'text/json',
625
+ 'application/*+json'
626
+ ]
627
+ )
628
+ )
629
+ if _default_content_type is not None:
630
+ _header_params['Content-Type'] = _default_content_type
631
+
632
+ # authentication setting
633
+ _auth_settings: List[str] = [
634
+ 'OAuth2',
635
+ 'OpenIdConnect',
636
+ 'Bearer'
637
+ ]
638
+
639
+ return self.api_client.param_serialize(
640
+ method='POST',
641
+ resource_path='/rapid/demographic',
642
+ path_params=_path_params,
643
+ query_params=_query_params,
644
+ header_params=_header_params,
645
+ body=_body_params,
646
+ post_params=_form_params,
647
+ files=_files,
648
+ auth_settings=_auth_settings,
649
+ collection_formats=_collection_formats,
650
+ _host=_host,
651
+ _request_auth=_request_auth
652
+ )
653
+
654
+
655
+
656
+
657
+ @validate_call
658
+ def rapid_global_responses_get(
659
+ self,
660
+ _request_timeout: Union[
661
+ None,
662
+ Annotated[StrictFloat, Field(gt=0)],
663
+ Tuple[
664
+ Annotated[StrictFloat, Field(gt=0)],
665
+ Annotated[StrictFloat, Field(gt=0)]
666
+ ]
667
+ ] = None,
668
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
669
+ _content_type: Optional[StrictStr] = None,
670
+ _headers: Optional[Dict[StrictStr, Any]] = None,
671
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
672
+ ) -> GetPublicResponsesResult:
673
+ """A public endpoint to query the most recent responses globally
674
+
675
+
676
+ :param _request_timeout: timeout setting for this request. If one
677
+ number provided, it will be total request
678
+ timeout. It can also be a pair (tuple) of
679
+ (connection, read) timeouts.
680
+ :type _request_timeout: int, tuple(int, int), optional
681
+ :param _request_auth: set to override the auth_settings for an a single
682
+ request; this effectively ignores the
683
+ authentication in the spec for a single request.
684
+ :type _request_auth: dict, optional
685
+ :param _content_type: force content-type for the request.
686
+ :type _content_type: str, Optional
687
+ :param _headers: set to override the headers for a single
688
+ request; this effectively ignores the headers
689
+ in the spec for a single request.
690
+ :type _headers: dict, optional
691
+ :param _host_index: set to override the host_index for a single
692
+ request; this effectively ignores the host_index
693
+ in the spec for a single request.
694
+ :type _host_index: int, optional
695
+ :return: Returns the result object.
696
+ """ # noqa: E501
697
+
698
+ _param = self._rapid_global_responses_get_serialize(
699
+ _request_auth=_request_auth,
700
+ _content_type=_content_type,
701
+ _headers=_headers,
702
+ _host_index=_host_index
703
+ )
704
+
705
+ _response_types_map: Dict[str, Optional[str]] = {
706
+ '200': "GetPublicResponsesResult",
707
+ }
708
+ response_data = self.api_client.call_api(
709
+ *_param,
710
+ _request_timeout=_request_timeout
711
+ )
712
+ response_data.read()
713
+ return self.api_client.response_deserialize(
714
+ response_data=response_data,
715
+ response_types_map=_response_types_map,
716
+ ).data
717
+
718
+
719
+ @validate_call
720
+ def rapid_global_responses_get_with_http_info(
721
+ self,
722
+ _request_timeout: Union[
723
+ None,
724
+ Annotated[StrictFloat, Field(gt=0)],
725
+ Tuple[
726
+ Annotated[StrictFloat, Field(gt=0)],
727
+ Annotated[StrictFloat, Field(gt=0)]
728
+ ]
729
+ ] = None,
730
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
731
+ _content_type: Optional[StrictStr] = None,
732
+ _headers: Optional[Dict[StrictStr, Any]] = None,
733
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
734
+ ) -> ApiResponse[GetPublicResponsesResult]:
735
+ """A public endpoint to query the most recent responses globally
736
+
737
+
738
+ :param _request_timeout: timeout setting for this request. If one
739
+ number provided, it will be total request
740
+ timeout. It can also be a pair (tuple) of
741
+ (connection, read) timeouts.
742
+ :type _request_timeout: int, tuple(int, int), optional
743
+ :param _request_auth: set to override the auth_settings for an a single
744
+ request; this effectively ignores the
745
+ authentication in the spec for a single request.
746
+ :type _request_auth: dict, optional
747
+ :param _content_type: force content-type for the request.
748
+ :type _content_type: str, Optional
749
+ :param _headers: set to override the headers for a single
750
+ request; this effectively ignores the headers
751
+ in the spec for a single request.
752
+ :type _headers: dict, optional
753
+ :param _host_index: set to override the host_index for a single
754
+ request; this effectively ignores the host_index
755
+ in the spec for a single request.
756
+ :type _host_index: int, optional
757
+ :return: Returns the result object.
758
+ """ # noqa: E501
759
+
760
+ _param = self._rapid_global_responses_get_serialize(
761
+ _request_auth=_request_auth,
762
+ _content_type=_content_type,
763
+ _headers=_headers,
764
+ _host_index=_host_index
765
+ )
766
+
767
+ _response_types_map: Dict[str, Optional[str]] = {
768
+ '200': "GetPublicResponsesResult",
769
+ }
770
+ response_data = self.api_client.call_api(
771
+ *_param,
772
+ _request_timeout=_request_timeout
773
+ )
774
+ response_data.read()
775
+ return self.api_client.response_deserialize(
776
+ response_data=response_data,
777
+ response_types_map=_response_types_map,
778
+ )
779
+
780
+
781
+ @validate_call
782
+ def rapid_global_responses_get_without_preload_content(
783
+ self,
784
+ _request_timeout: Union[
785
+ None,
786
+ Annotated[StrictFloat, Field(gt=0)],
787
+ Tuple[
788
+ Annotated[StrictFloat, Field(gt=0)],
789
+ Annotated[StrictFloat, Field(gt=0)]
790
+ ]
791
+ ] = None,
792
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
793
+ _content_type: Optional[StrictStr] = None,
794
+ _headers: Optional[Dict[StrictStr, Any]] = None,
795
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
796
+ ) -> RESTResponseType:
797
+ """A public endpoint to query the most recent responses globally
798
+
799
+
800
+ :param _request_timeout: timeout setting for this request. If one
801
+ number provided, it will be total request
802
+ timeout. It can also be a pair (tuple) of
803
+ (connection, read) timeouts.
804
+ :type _request_timeout: int, tuple(int, int), optional
805
+ :param _request_auth: set to override the auth_settings for an a single
806
+ request; this effectively ignores the
807
+ authentication in the spec for a single request.
808
+ :type _request_auth: dict, optional
809
+ :param _content_type: force content-type for the request.
810
+ :type _content_type: str, Optional
811
+ :param _headers: set to override the headers for a single
812
+ request; this effectively ignores the headers
813
+ in the spec for a single request.
814
+ :type _headers: dict, optional
815
+ :param _host_index: set to override the host_index for a single
816
+ request; this effectively ignores the host_index
817
+ in the spec for a single request.
818
+ :type _host_index: int, optional
819
+ :return: Returns the result object.
820
+ """ # noqa: E501
821
+
822
+ _param = self._rapid_global_responses_get_serialize(
823
+ _request_auth=_request_auth,
824
+ _content_type=_content_type,
825
+ _headers=_headers,
826
+ _host_index=_host_index
827
+ )
828
+
829
+ _response_types_map: Dict[str, Optional[str]] = {
830
+ '200': "GetPublicResponsesResult",
831
+ }
832
+ response_data = self.api_client.call_api(
833
+ *_param,
834
+ _request_timeout=_request_timeout
835
+ )
836
+ return response_data.response
837
+
838
+
839
+ def _rapid_global_responses_get_serialize(
840
+ self,
841
+ _request_auth,
842
+ _content_type,
843
+ _headers,
844
+ _host_index,
845
+ ) -> RequestSerialized:
846
+
847
+ _host = None
848
+
849
+ _collection_formats: Dict[str, str] = {
850
+ }
851
+
852
+ _path_params: Dict[str, str] = {}
853
+ _query_params: List[Tuple[str, str]] = []
854
+ _header_params: Dict[str, Optional[str]] = _headers or {}
855
+ _form_params: List[Tuple[str, str]] = []
856
+ _files: Dict[
857
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
858
+ ] = {}
859
+ _body_params: Optional[bytes] = None
860
+
861
+ # process the path parameters
862
+ # process the query parameters
863
+ # process the header parameters
864
+ # process the form parameters
865
+ # process the body parameter
866
+
867
+
868
+ # set the HTTP header `Accept`
869
+ if 'Accept' not in _header_params:
870
+ _header_params['Accept'] = self.api_client.select_header_accept(
871
+ [
872
+ 'text/plain',
873
+ 'application/json',
874
+ 'text/json'
875
+ ]
876
+ )
877
+
878
+
879
+ # authentication setting
880
+ _auth_settings: List[str] = [
881
+ 'OAuth2',
882
+ 'OpenIdConnect',
883
+ 'Bearer'
884
+ ]
885
+
886
+ return self.api_client.param_serialize(
887
+ method='GET',
888
+ resource_path='/rapid/global-responses',
889
+ path_params=_path_params,
890
+ query_params=_query_params,
891
+ header_params=_header_params,
892
+ body=_body_params,
893
+ post_params=_form_params,
894
+ files=_files,
895
+ auth_settings=_auth_settings,
896
+ collection_formats=_collection_formats,
897
+ _host=_host,
898
+ _request_auth=_request_auth
899
+ )
900
+
901
+
902
+
903
+
904
+ @validate_call
905
+ def rapid_rapid_id_delete(
906
+ self,
907
+ rapid_id: Annotated[StrictStr, Field(description="The rapid to be deleted")],
908
+ _request_timeout: Union[
909
+ None,
910
+ Annotated[StrictFloat, Field(gt=0)],
911
+ Tuple[
912
+ Annotated[StrictFloat, Field(gt=0)],
913
+ Annotated[StrictFloat, Field(gt=0)]
914
+ ]
915
+ ] = None,
916
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
917
+ _content_type: Optional[StrictStr] = None,
918
+ _headers: Optional[Dict[StrictStr, Any]] = None,
919
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
920
+ ) -> None:
921
+ """Deletes a rapid.
922
+
923
+
924
+ :param rapid_id: The rapid to be deleted (required)
925
+ :type rapid_id: str
926
+ :param _request_timeout: timeout setting for this request. If one
927
+ number provided, it will be total request
928
+ timeout. It can also be a pair (tuple) of
929
+ (connection, read) timeouts.
930
+ :type _request_timeout: int, tuple(int, int), optional
931
+ :param _request_auth: set to override the auth_settings for an a single
932
+ request; this effectively ignores the
933
+ authentication in the spec for a single request.
934
+ :type _request_auth: dict, optional
935
+ :param _content_type: force content-type for the request.
936
+ :type _content_type: str, Optional
937
+ :param _headers: set to override the headers for a single
938
+ request; this effectively ignores the headers
939
+ in the spec for a single request.
940
+ :type _headers: dict, optional
941
+ :param _host_index: set to override the host_index for a single
942
+ request; this effectively ignores the host_index
943
+ in the spec for a single request.
944
+ :type _host_index: int, optional
945
+ :return: Returns the result object.
946
+ """ # noqa: E501
947
+
948
+ _param = self._rapid_rapid_id_delete_serialize(
949
+ rapid_id=rapid_id,
950
+ _request_auth=_request_auth,
951
+ _content_type=_content_type,
952
+ _headers=_headers,
953
+ _host_index=_host_index
954
+ )
955
+
956
+ _response_types_map: Dict[str, Optional[str]] = {
957
+ '204': None,
958
+ }
959
+ response_data = self.api_client.call_api(
960
+ *_param,
961
+ _request_timeout=_request_timeout
962
+ )
963
+ response_data.read()
964
+ return self.api_client.response_deserialize(
965
+ response_data=response_data,
966
+ response_types_map=_response_types_map,
967
+ ).data
968
+
969
+
970
+ @validate_call
971
+ def rapid_rapid_id_delete_with_http_info(
972
+ self,
973
+ rapid_id: Annotated[StrictStr, Field(description="The rapid to be deleted")],
974
+ _request_timeout: Union[
975
+ None,
976
+ Annotated[StrictFloat, Field(gt=0)],
977
+ Tuple[
978
+ Annotated[StrictFloat, Field(gt=0)],
979
+ Annotated[StrictFloat, Field(gt=0)]
980
+ ]
981
+ ] = None,
982
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
983
+ _content_type: Optional[StrictStr] = None,
984
+ _headers: Optional[Dict[StrictStr, Any]] = None,
985
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
986
+ ) -> ApiResponse[None]:
987
+ """Deletes a rapid.
988
+
989
+
990
+ :param rapid_id: The rapid to be deleted (required)
991
+ :type rapid_id: str
992
+ :param _request_timeout: timeout setting for this request. If one
993
+ number provided, it will be total request
994
+ timeout. It can also be a pair (tuple) of
995
+ (connection, read) timeouts.
996
+ :type _request_timeout: int, tuple(int, int), optional
997
+ :param _request_auth: set to override the auth_settings for an a single
998
+ request; this effectively ignores the
999
+ authentication in the spec for a single request.
1000
+ :type _request_auth: dict, optional
1001
+ :param _content_type: force content-type for the request.
1002
+ :type _content_type: str, Optional
1003
+ :param _headers: set to override the headers for a single
1004
+ request; this effectively ignores the headers
1005
+ in the spec for a single request.
1006
+ :type _headers: dict, optional
1007
+ :param _host_index: set to override the host_index for a single
1008
+ request; this effectively ignores the host_index
1009
+ in the spec for a single request.
1010
+ :type _host_index: int, optional
1011
+ :return: Returns the result object.
1012
+ """ # noqa: E501
1013
+
1014
+ _param = self._rapid_rapid_id_delete_serialize(
1015
+ rapid_id=rapid_id,
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
+ '204': None,
1024
+ }
1025
+ response_data = self.api_client.call_api(
1026
+ *_param,
1027
+ _request_timeout=_request_timeout
1028
+ )
1029
+ response_data.read()
1030
+ return self.api_client.response_deserialize(
1031
+ response_data=response_data,
1032
+ response_types_map=_response_types_map,
1033
+ )
1034
+
1035
+
1036
+ @validate_call
1037
+ def rapid_rapid_id_delete_without_preload_content(
1038
+ self,
1039
+ rapid_id: Annotated[StrictStr, Field(description="The rapid to be deleted")],
1040
+ _request_timeout: Union[
1041
+ None,
1042
+ Annotated[StrictFloat, Field(gt=0)],
1043
+ Tuple[
1044
+ Annotated[StrictFloat, Field(gt=0)],
1045
+ Annotated[StrictFloat, Field(gt=0)]
1046
+ ]
1047
+ ] = None,
1048
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1049
+ _content_type: Optional[StrictStr] = None,
1050
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1051
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1052
+ ) -> RESTResponseType:
1053
+ """Deletes a rapid.
1054
+
1055
+
1056
+ :param rapid_id: The rapid to be deleted (required)
1057
+ :type rapid_id: str
1058
+ :param _request_timeout: timeout setting for this request. If one
1059
+ number provided, it will be total request
1060
+ timeout. It can also be a pair (tuple) of
1061
+ (connection, read) timeouts.
1062
+ :type _request_timeout: int, tuple(int, int), optional
1063
+ :param _request_auth: set to override the auth_settings for an a single
1064
+ request; this effectively ignores the
1065
+ authentication in the spec for a single request.
1066
+ :type _request_auth: dict, optional
1067
+ :param _content_type: force content-type for the request.
1068
+ :type _content_type: str, Optional
1069
+ :param _headers: set to override the headers for a single
1070
+ request; this effectively ignores the headers
1071
+ in the spec for a single request.
1072
+ :type _headers: dict, optional
1073
+ :param _host_index: set to override the host_index for a single
1074
+ request; this effectively ignores the host_index
1075
+ in the spec for a single request.
1076
+ :type _host_index: int, optional
1077
+ :return: Returns the result object.
1078
+ """ # noqa: E501
1079
+
1080
+ _param = self._rapid_rapid_id_delete_serialize(
1081
+ rapid_id=rapid_id,
1082
+ _request_auth=_request_auth,
1083
+ _content_type=_content_type,
1084
+ _headers=_headers,
1085
+ _host_index=_host_index
1086
+ )
1087
+
1088
+ _response_types_map: Dict[str, Optional[str]] = {
1089
+ '204': None,
1090
+ }
1091
+ response_data = self.api_client.call_api(
1092
+ *_param,
1093
+ _request_timeout=_request_timeout
1094
+ )
1095
+ return response_data.response
1096
+
1097
+
1098
+ def _rapid_rapid_id_delete_serialize(
1099
+ self,
1100
+ rapid_id,
1101
+ _request_auth,
1102
+ _content_type,
1103
+ _headers,
1104
+ _host_index,
1105
+ ) -> RequestSerialized:
1106
+
1107
+ _host = None
1108
+
1109
+ _collection_formats: Dict[str, str] = {
1110
+ }
1111
+
1112
+ _path_params: Dict[str, str] = {}
1113
+ _query_params: List[Tuple[str, str]] = []
1114
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1115
+ _form_params: List[Tuple[str, str]] = []
1116
+ _files: Dict[
1117
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1118
+ ] = {}
1119
+ _body_params: Optional[bytes] = None
1120
+
1121
+ # process the path parameters
1122
+ if rapid_id is not None:
1123
+ _path_params['rapidId'] = rapid_id
1124
+ # process the query parameters
1125
+ # process the header parameters
1126
+ # process the form parameters
1127
+ # process the body parameter
1128
+
1129
+
1130
+
1131
+
1132
+ # authentication setting
1133
+ _auth_settings: List[str] = [
1134
+ 'OAuth2',
1135
+ 'OpenIdConnect',
1136
+ 'Bearer'
1137
+ ]
1138
+
1139
+ return self.api_client.param_serialize(
1140
+ method='DELETE',
1141
+ resource_path='/rapid/{rapidId}',
1142
+ path_params=_path_params,
1143
+ query_params=_query_params,
1144
+ header_params=_header_params,
1145
+ body=_body_params,
1146
+ post_params=_form_params,
1147
+ files=_files,
1148
+ auth_settings=_auth_settings,
1149
+ collection_formats=_collection_formats,
1150
+ _host=_host,
1151
+ _request_auth=_request_auth
1152
+ )
1153
+
1154
+
1155
+
1156
+
1157
+ @validate_call
1158
+ def rapid_rapid_id_responses_get(
1159
+ self,
1160
+ rapid_id: Annotated[StrictStr, Field(description="The rapid to get the responses for.")],
1161
+ _request_timeout: Union[
1162
+ None,
1163
+ Annotated[StrictFloat, Field(gt=0)],
1164
+ Tuple[
1165
+ Annotated[StrictFloat, Field(gt=0)],
1166
+ Annotated[StrictFloat, Field(gt=0)]
1167
+ ]
1168
+ ] = None,
1169
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1170
+ _content_type: Optional[StrictStr] = None,
1171
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1172
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1173
+ ) -> GetResponsesForRapidResult:
1174
+ """Gets all responses for a given rapid.
1175
+
1176
+
1177
+ :param rapid_id: The rapid to get the responses for. (required)
1178
+ :type rapid_id: str
1179
+ :param _request_timeout: timeout setting for this request. If one
1180
+ number provided, it will be total request
1181
+ timeout. It can also be a pair (tuple) of
1182
+ (connection, read) timeouts.
1183
+ :type _request_timeout: int, tuple(int, int), optional
1184
+ :param _request_auth: set to override the auth_settings for an a single
1185
+ request; this effectively ignores the
1186
+ authentication in the spec for a single request.
1187
+ :type _request_auth: dict, optional
1188
+ :param _content_type: force content-type for the request.
1189
+ :type _content_type: str, Optional
1190
+ :param _headers: set to override the headers for a single
1191
+ request; this effectively ignores the headers
1192
+ in the spec for a single request.
1193
+ :type _headers: dict, optional
1194
+ :param _host_index: set to override the host_index for a single
1195
+ request; this effectively ignores the host_index
1196
+ in the spec for a single request.
1197
+ :type _host_index: int, optional
1198
+ :return: Returns the result object.
1199
+ """ # noqa: E501
1200
+
1201
+ _param = self._rapid_rapid_id_responses_get_serialize(
1202
+ rapid_id=rapid_id,
1203
+ _request_auth=_request_auth,
1204
+ _content_type=_content_type,
1205
+ _headers=_headers,
1206
+ _host_index=_host_index
1207
+ )
1208
+
1209
+ _response_types_map: Dict[str, Optional[str]] = {
1210
+ '200': "GetResponsesForRapidResult",
1211
+ }
1212
+ response_data = self.api_client.call_api(
1213
+ *_param,
1214
+ _request_timeout=_request_timeout
1215
+ )
1216
+ response_data.read()
1217
+ return self.api_client.response_deserialize(
1218
+ response_data=response_data,
1219
+ response_types_map=_response_types_map,
1220
+ ).data
1221
+
1222
+
1223
+ @validate_call
1224
+ def rapid_rapid_id_responses_get_with_http_info(
1225
+ self,
1226
+ rapid_id: Annotated[StrictStr, Field(description="The rapid to get the responses for.")],
1227
+ _request_timeout: Union[
1228
+ None,
1229
+ Annotated[StrictFloat, Field(gt=0)],
1230
+ Tuple[
1231
+ Annotated[StrictFloat, Field(gt=0)],
1232
+ Annotated[StrictFloat, Field(gt=0)]
1233
+ ]
1234
+ ] = None,
1235
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1236
+ _content_type: Optional[StrictStr] = None,
1237
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1238
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1239
+ ) -> ApiResponse[GetResponsesForRapidResult]:
1240
+ """Gets all responses for a given rapid.
1241
+
1242
+
1243
+ :param rapid_id: The rapid to get the responses for. (required)
1244
+ :type rapid_id: str
1245
+ :param _request_timeout: timeout setting for this request. If one
1246
+ number provided, it will be total request
1247
+ timeout. It can also be a pair (tuple) of
1248
+ (connection, read) timeouts.
1249
+ :type _request_timeout: int, tuple(int, int), optional
1250
+ :param _request_auth: set to override the auth_settings for an a single
1251
+ request; this effectively ignores the
1252
+ authentication in the spec for a single request.
1253
+ :type _request_auth: dict, optional
1254
+ :param _content_type: force content-type for the request.
1255
+ :type _content_type: str, Optional
1256
+ :param _headers: set to override the headers for a single
1257
+ request; this effectively ignores the headers
1258
+ in the spec for a single request.
1259
+ :type _headers: dict, optional
1260
+ :param _host_index: set to override the host_index for a single
1261
+ request; this effectively ignores the host_index
1262
+ in the spec for a single request.
1263
+ :type _host_index: int, optional
1264
+ :return: Returns the result object.
1265
+ """ # noqa: E501
1266
+
1267
+ _param = self._rapid_rapid_id_responses_get_serialize(
1268
+ rapid_id=rapid_id,
1269
+ _request_auth=_request_auth,
1270
+ _content_type=_content_type,
1271
+ _headers=_headers,
1272
+ _host_index=_host_index
1273
+ )
1274
+
1275
+ _response_types_map: Dict[str, Optional[str]] = {
1276
+ '200': "GetResponsesForRapidResult",
1277
+ }
1278
+ response_data = self.api_client.call_api(
1279
+ *_param,
1280
+ _request_timeout=_request_timeout
1281
+ )
1282
+ response_data.read()
1283
+ return self.api_client.response_deserialize(
1284
+ response_data=response_data,
1285
+ response_types_map=_response_types_map,
1286
+ )
1287
+
1288
+
1289
+ @validate_call
1290
+ def rapid_rapid_id_responses_get_without_preload_content(
1291
+ self,
1292
+ rapid_id: Annotated[StrictStr, Field(description="The rapid to get the responses for.")],
1293
+ _request_timeout: Union[
1294
+ None,
1295
+ Annotated[StrictFloat, Field(gt=0)],
1296
+ Tuple[
1297
+ Annotated[StrictFloat, Field(gt=0)],
1298
+ Annotated[StrictFloat, Field(gt=0)]
1299
+ ]
1300
+ ] = None,
1301
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1302
+ _content_type: Optional[StrictStr] = None,
1303
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1304
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1305
+ ) -> RESTResponseType:
1306
+ """Gets all responses for a given rapid.
1307
+
1308
+
1309
+ :param rapid_id: The rapid to get the responses for. (required)
1310
+ :type rapid_id: str
1311
+ :param _request_timeout: timeout setting for this request. If one
1312
+ number provided, it will be total request
1313
+ timeout. It can also be a pair (tuple) of
1314
+ (connection, read) timeouts.
1315
+ :type _request_timeout: int, tuple(int, int), optional
1316
+ :param _request_auth: set to override the auth_settings for an a single
1317
+ request; this effectively ignores the
1318
+ authentication in the spec for a single request.
1319
+ :type _request_auth: dict, optional
1320
+ :param _content_type: force content-type for the request.
1321
+ :type _content_type: str, Optional
1322
+ :param _headers: set to override the headers for a single
1323
+ request; this effectively ignores the headers
1324
+ in the spec for a single request.
1325
+ :type _headers: dict, optional
1326
+ :param _host_index: set to override the host_index for a single
1327
+ request; this effectively ignores the host_index
1328
+ in the spec for a single request.
1329
+ :type _host_index: int, optional
1330
+ :return: Returns the result object.
1331
+ """ # noqa: E501
1332
+
1333
+ _param = self._rapid_rapid_id_responses_get_serialize(
1334
+ rapid_id=rapid_id,
1335
+ _request_auth=_request_auth,
1336
+ _content_type=_content_type,
1337
+ _headers=_headers,
1338
+ _host_index=_host_index
1339
+ )
1340
+
1341
+ _response_types_map: Dict[str, Optional[str]] = {
1342
+ '200': "GetResponsesForRapidResult",
1343
+ }
1344
+ response_data = self.api_client.call_api(
1345
+ *_param,
1346
+ _request_timeout=_request_timeout
1347
+ )
1348
+ return response_data.response
1349
+
1350
+
1351
+ def _rapid_rapid_id_responses_get_serialize(
1352
+ self,
1353
+ rapid_id,
1354
+ _request_auth,
1355
+ _content_type,
1356
+ _headers,
1357
+ _host_index,
1358
+ ) -> RequestSerialized:
1359
+
1360
+ _host = None
1361
+
1362
+ _collection_formats: Dict[str, str] = {
1363
+ }
1364
+
1365
+ _path_params: Dict[str, str] = {}
1366
+ _query_params: List[Tuple[str, str]] = []
1367
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1368
+ _form_params: List[Tuple[str, str]] = []
1369
+ _files: Dict[
1370
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1371
+ ] = {}
1372
+ _body_params: Optional[bytes] = None
1373
+
1374
+ # process the path parameters
1375
+ if rapid_id is not None:
1376
+ _path_params['rapidId'] = rapid_id
1377
+ # process the query parameters
1378
+ # process the header parameters
1379
+ # process the form parameters
1380
+ # process the body parameter
1381
+
1382
+
1383
+ # set the HTTP header `Accept`
1384
+ if 'Accept' not in _header_params:
1385
+ _header_params['Accept'] = self.api_client.select_header_accept(
1386
+ [
1387
+ 'text/plain',
1388
+ 'application/json',
1389
+ 'text/json'
1390
+ ]
1391
+ )
1392
+
1393
+
1394
+ # authentication setting
1395
+ _auth_settings: List[str] = [
1396
+ 'OAuth2',
1397
+ 'OpenIdConnect',
1398
+ 'Bearer'
1399
+ ]
1400
+
1401
+ return self.api_client.param_serialize(
1402
+ method='GET',
1403
+ resource_path='/rapid/{rapidId}/responses',
1404
+ path_params=_path_params,
1405
+ query_params=_query_params,
1406
+ header_params=_header_params,
1407
+ body=_body_params,
1408
+ post_params=_form_params,
1409
+ files=_files,
1410
+ auth_settings=_auth_settings,
1411
+ collection_formats=_collection_formats,
1412
+ _host=_host,
1413
+ _request_auth=_request_auth
1414
+ )
1415
+
1416
+
1417
+
1418
+
1419
+ @validate_call
1420
+ def rapid_rapid_id_unflag_post(
1421
+ self,
1422
+ rapid_id: Annotated[StrictStr, Field(description="The id of the rapid to unflag")],
1423
+ _request_timeout: Union[
1424
+ None,
1425
+ Annotated[StrictFloat, Field(gt=0)],
1426
+ Tuple[
1427
+ Annotated[StrictFloat, Field(gt=0)],
1428
+ Annotated[StrictFloat, Field(gt=0)]
1429
+ ]
1430
+ ] = None,
1431
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1432
+ _content_type: Optional[StrictStr] = None,
1433
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1434
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1435
+ ) -> None:
1436
+ """Unflags a flagged rapid. This will add the rapid back to the active labeling pool and prevent it from being flagged again.
1437
+
1438
+
1439
+ :param rapid_id: The id of the rapid to unflag (required)
1440
+ :type rapid_id: str
1441
+ :param _request_timeout: timeout setting for this request. If one
1442
+ number provided, it will be total request
1443
+ timeout. It can also be a pair (tuple) of
1444
+ (connection, read) timeouts.
1445
+ :type _request_timeout: int, tuple(int, int), optional
1446
+ :param _request_auth: set to override the auth_settings for an a single
1447
+ request; this effectively ignores the
1448
+ authentication in the spec for a single request.
1449
+ :type _request_auth: dict, optional
1450
+ :param _content_type: force content-type for the request.
1451
+ :type _content_type: str, Optional
1452
+ :param _headers: set to override the headers for a single
1453
+ request; this effectively ignores the headers
1454
+ in the spec for a single request.
1455
+ :type _headers: dict, optional
1456
+ :param _host_index: set to override the host_index for a single
1457
+ request; this effectively ignores the host_index
1458
+ in the spec for a single request.
1459
+ :type _host_index: int, optional
1460
+ :return: Returns the result object.
1461
+ """ # noqa: E501
1462
+
1463
+ _param = self._rapid_rapid_id_unflag_post_serialize(
1464
+ rapid_id=rapid_id,
1465
+ _request_auth=_request_auth,
1466
+ _content_type=_content_type,
1467
+ _headers=_headers,
1468
+ _host_index=_host_index
1469
+ )
1470
+
1471
+ _response_types_map: Dict[str, Optional[str]] = {
1472
+ '204': None,
1473
+ }
1474
+ response_data = self.api_client.call_api(
1475
+ *_param,
1476
+ _request_timeout=_request_timeout
1477
+ )
1478
+ response_data.read()
1479
+ return self.api_client.response_deserialize(
1480
+ response_data=response_data,
1481
+ response_types_map=_response_types_map,
1482
+ ).data
1483
+
1484
+
1485
+ @validate_call
1486
+ def rapid_rapid_id_unflag_post_with_http_info(
1487
+ self,
1488
+ rapid_id: Annotated[StrictStr, Field(description="The id of the rapid to unflag")],
1489
+ _request_timeout: Union[
1490
+ None,
1491
+ Annotated[StrictFloat, Field(gt=0)],
1492
+ Tuple[
1493
+ Annotated[StrictFloat, Field(gt=0)],
1494
+ Annotated[StrictFloat, Field(gt=0)]
1495
+ ]
1496
+ ] = None,
1497
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1498
+ _content_type: Optional[StrictStr] = None,
1499
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1500
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1501
+ ) -> ApiResponse[None]:
1502
+ """Unflags a flagged rapid. This will add the rapid back to the active labeling pool and prevent it from being flagged again.
1503
+
1504
+
1505
+ :param rapid_id: The id of the rapid to unflag (required)
1506
+ :type rapid_id: str
1507
+ :param _request_timeout: timeout setting for this request. If one
1508
+ number provided, it will be total request
1509
+ timeout. It can also be a pair (tuple) of
1510
+ (connection, read) timeouts.
1511
+ :type _request_timeout: int, tuple(int, int), optional
1512
+ :param _request_auth: set to override the auth_settings for an a single
1513
+ request; this effectively ignores the
1514
+ authentication in the spec for a single request.
1515
+ :type _request_auth: dict, optional
1516
+ :param _content_type: force content-type for the request.
1517
+ :type _content_type: str, Optional
1518
+ :param _headers: set to override the headers for a single
1519
+ request; this effectively ignores the headers
1520
+ in the spec for a single request.
1521
+ :type _headers: dict, optional
1522
+ :param _host_index: set to override the host_index for a single
1523
+ request; this effectively ignores the host_index
1524
+ in the spec for a single request.
1525
+ :type _host_index: int, optional
1526
+ :return: Returns the result object.
1527
+ """ # noqa: E501
1528
+
1529
+ _param = self._rapid_rapid_id_unflag_post_serialize(
1530
+ rapid_id=rapid_id,
1531
+ _request_auth=_request_auth,
1532
+ _content_type=_content_type,
1533
+ _headers=_headers,
1534
+ _host_index=_host_index
1535
+ )
1536
+
1537
+ _response_types_map: Dict[str, Optional[str]] = {
1538
+ '204': None,
1539
+ }
1540
+ response_data = self.api_client.call_api(
1541
+ *_param,
1542
+ _request_timeout=_request_timeout
1543
+ )
1544
+ response_data.read()
1545
+ return self.api_client.response_deserialize(
1546
+ response_data=response_data,
1547
+ response_types_map=_response_types_map,
1548
+ )
1549
+
1550
+
1551
+ @validate_call
1552
+ def rapid_rapid_id_unflag_post_without_preload_content(
1553
+ self,
1554
+ rapid_id: Annotated[StrictStr, Field(description="The id of the rapid to unflag")],
1555
+ _request_timeout: Union[
1556
+ None,
1557
+ Annotated[StrictFloat, Field(gt=0)],
1558
+ Tuple[
1559
+ Annotated[StrictFloat, Field(gt=0)],
1560
+ Annotated[StrictFloat, Field(gt=0)]
1561
+ ]
1562
+ ] = None,
1563
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1564
+ _content_type: Optional[StrictStr] = None,
1565
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1566
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1567
+ ) -> RESTResponseType:
1568
+ """Unflags a flagged rapid. This will add the rapid back to the active labeling pool and prevent it from being flagged again.
1569
+
1570
+
1571
+ :param rapid_id: The id of the rapid to unflag (required)
1572
+ :type rapid_id: str
1573
+ :param _request_timeout: timeout setting for this request. If one
1574
+ number provided, it will be total request
1575
+ timeout. It can also be a pair (tuple) of
1576
+ (connection, read) timeouts.
1577
+ :type _request_timeout: int, tuple(int, int), optional
1578
+ :param _request_auth: set to override the auth_settings for an a single
1579
+ request; this effectively ignores the
1580
+ authentication in the spec for a single request.
1581
+ :type _request_auth: dict, optional
1582
+ :param _content_type: force content-type for the request.
1583
+ :type _content_type: str, Optional
1584
+ :param _headers: set to override the headers for a single
1585
+ request; this effectively ignores the headers
1586
+ in the spec for a single request.
1587
+ :type _headers: dict, optional
1588
+ :param _host_index: set to override the host_index for a single
1589
+ request; this effectively ignores the host_index
1590
+ in the spec for a single request.
1591
+ :type _host_index: int, optional
1592
+ :return: Returns the result object.
1593
+ """ # noqa: E501
1594
+
1595
+ _param = self._rapid_rapid_id_unflag_post_serialize(
1596
+ rapid_id=rapid_id,
1597
+ _request_auth=_request_auth,
1598
+ _content_type=_content_type,
1599
+ _headers=_headers,
1600
+ _host_index=_host_index
1601
+ )
1602
+
1603
+ _response_types_map: Dict[str, Optional[str]] = {
1604
+ '204': None,
1605
+ }
1606
+ response_data = self.api_client.call_api(
1607
+ *_param,
1608
+ _request_timeout=_request_timeout
1609
+ )
1610
+ return response_data.response
1611
+
1612
+
1613
+ def _rapid_rapid_id_unflag_post_serialize(
1614
+ self,
1615
+ rapid_id,
1616
+ _request_auth,
1617
+ _content_type,
1618
+ _headers,
1619
+ _host_index,
1620
+ ) -> RequestSerialized:
1621
+
1622
+ _host = None
1623
+
1624
+ _collection_formats: Dict[str, str] = {
1625
+ }
1626
+
1627
+ _path_params: Dict[str, str] = {}
1628
+ _query_params: List[Tuple[str, str]] = []
1629
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1630
+ _form_params: List[Tuple[str, str]] = []
1631
+ _files: Dict[
1632
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1633
+ ] = {}
1634
+ _body_params: Optional[bytes] = None
1635
+
1636
+ # process the path parameters
1637
+ if rapid_id is not None:
1638
+ _path_params['rapidId'] = rapid_id
1639
+ # process the query parameters
1640
+ # process the header parameters
1641
+ # process the form parameters
1642
+ # process the body parameter
1643
+
1644
+
1645
+
1646
+
1647
+ # authentication setting
1648
+ _auth_settings: List[str] = [
1649
+ 'OAuth2',
1650
+ 'OpenIdConnect',
1651
+ 'Bearer'
1652
+ ]
1653
+
1654
+ return self.api_client.param_serialize(
1655
+ method='POST',
1656
+ resource_path='/rapid/{rapidId}/unflag',
1657
+ path_params=_path_params,
1658
+ query_params=_query_params,
1659
+ header_params=_header_params,
1660
+ body=_body_params,
1661
+ post_params=_form_params,
1662
+ files=_files,
1663
+ auth_settings=_auth_settings,
1664
+ collection_formats=_collection_formats,
1665
+ _host=_host,
1666
+ _request_auth=_request_auth
1667
+ )
1668
+
1669
+
1670
+
1671
+
1672
+ @validate_call
1673
+ def rapid_validation_rapid_id_patch(
1674
+ self,
1675
+ rapid_id: Annotated[StrictStr, Field(description="The id of the rapid to update")],
1676
+ update_validation_rapid_model: Annotated[UpdateValidationRapidModel, Field(description="The body request")],
1677
+ _request_timeout: Union[
1678
+ None,
1679
+ Annotated[StrictFloat, Field(gt=0)],
1680
+ Tuple[
1681
+ Annotated[StrictFloat, Field(gt=0)],
1682
+ Annotated[StrictFloat, Field(gt=0)]
1683
+ ]
1684
+ ] = None,
1685
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1686
+ _content_type: Optional[StrictStr] = None,
1687
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1688
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1689
+ ) -> None:
1690
+ """Updates the validation information of a Rapid.
1691
+
1692
+
1693
+ :param rapid_id: The id of the rapid to update (required)
1694
+ :type rapid_id: str
1695
+ :param update_validation_rapid_model: The body request (required)
1696
+ :type update_validation_rapid_model: UpdateValidationRapidModel
1697
+ :param _request_timeout: timeout setting for this request. If one
1698
+ number provided, it will be total request
1699
+ timeout. It can also be a pair (tuple) of
1700
+ (connection, read) timeouts.
1701
+ :type _request_timeout: int, tuple(int, int), optional
1702
+ :param _request_auth: set to override the auth_settings for an a single
1703
+ request; this effectively ignores the
1704
+ authentication in the spec for a single request.
1705
+ :type _request_auth: dict, optional
1706
+ :param _content_type: force content-type for the request.
1707
+ :type _content_type: str, Optional
1708
+ :param _headers: set to override the headers for a single
1709
+ request; this effectively ignores the headers
1710
+ in the spec for a single request.
1711
+ :type _headers: dict, optional
1712
+ :param _host_index: set to override the host_index for a single
1713
+ request; this effectively ignores the host_index
1714
+ in the spec for a single request.
1715
+ :type _host_index: int, optional
1716
+ :return: Returns the result object.
1717
+ """ # noqa: E501
1718
+
1719
+ _param = self._rapid_validation_rapid_id_patch_serialize(
1720
+ rapid_id=rapid_id,
1721
+ update_validation_rapid_model=update_validation_rapid_model,
1722
+ _request_auth=_request_auth,
1723
+ _content_type=_content_type,
1724
+ _headers=_headers,
1725
+ _host_index=_host_index
1726
+ )
1727
+
1728
+ _response_types_map: Dict[str, Optional[str]] = {
1729
+ '204': None,
1730
+ }
1731
+ response_data = self.api_client.call_api(
1732
+ *_param,
1733
+ _request_timeout=_request_timeout
1734
+ )
1735
+ response_data.read()
1736
+ return self.api_client.response_deserialize(
1737
+ response_data=response_data,
1738
+ response_types_map=_response_types_map,
1739
+ ).data
1740
+
1741
+
1742
+ @validate_call
1743
+ def rapid_validation_rapid_id_patch_with_http_info(
1744
+ self,
1745
+ rapid_id: Annotated[StrictStr, Field(description="The id of the rapid to update")],
1746
+ update_validation_rapid_model: Annotated[UpdateValidationRapidModel, Field(description="The body request")],
1747
+ _request_timeout: Union[
1748
+ None,
1749
+ Annotated[StrictFloat, Field(gt=0)],
1750
+ Tuple[
1751
+ Annotated[StrictFloat, Field(gt=0)],
1752
+ Annotated[StrictFloat, Field(gt=0)]
1753
+ ]
1754
+ ] = None,
1755
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1756
+ _content_type: Optional[StrictStr] = None,
1757
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1758
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1759
+ ) -> ApiResponse[None]:
1760
+ """Updates the validation information of a Rapid.
1761
+
1762
+
1763
+ :param rapid_id: The id of the rapid to update (required)
1764
+ :type rapid_id: str
1765
+ :param update_validation_rapid_model: The body request (required)
1766
+ :type update_validation_rapid_model: UpdateValidationRapidModel
1767
+ :param _request_timeout: timeout setting for this request. If one
1768
+ number provided, it will be total request
1769
+ timeout. It can also be a pair (tuple) of
1770
+ (connection, read) timeouts.
1771
+ :type _request_timeout: int, tuple(int, int), optional
1772
+ :param _request_auth: set to override the auth_settings for an a single
1773
+ request; this effectively ignores the
1774
+ authentication in the spec for a single request.
1775
+ :type _request_auth: dict, optional
1776
+ :param _content_type: force content-type for the request.
1777
+ :type _content_type: str, Optional
1778
+ :param _headers: set to override the headers for a single
1779
+ request; this effectively ignores the headers
1780
+ in the spec for a single request.
1781
+ :type _headers: dict, optional
1782
+ :param _host_index: set to override the host_index for a single
1783
+ request; this effectively ignores the host_index
1784
+ in the spec for a single request.
1785
+ :type _host_index: int, optional
1786
+ :return: Returns the result object.
1787
+ """ # noqa: E501
1788
+
1789
+ _param = self._rapid_validation_rapid_id_patch_serialize(
1790
+ rapid_id=rapid_id,
1791
+ update_validation_rapid_model=update_validation_rapid_model,
1792
+ _request_auth=_request_auth,
1793
+ _content_type=_content_type,
1794
+ _headers=_headers,
1795
+ _host_index=_host_index
1796
+ )
1797
+
1798
+ _response_types_map: Dict[str, Optional[str]] = {
1799
+ '204': None,
1800
+ }
1801
+ response_data = self.api_client.call_api(
1802
+ *_param,
1803
+ _request_timeout=_request_timeout
1804
+ )
1805
+ response_data.read()
1806
+ return self.api_client.response_deserialize(
1807
+ response_data=response_data,
1808
+ response_types_map=_response_types_map,
1809
+ )
1810
+
1811
+
1812
+ @validate_call
1813
+ def rapid_validation_rapid_id_patch_without_preload_content(
1814
+ self,
1815
+ rapid_id: Annotated[StrictStr, Field(description="The id of the rapid to update")],
1816
+ update_validation_rapid_model: Annotated[UpdateValidationRapidModel, Field(description="The body request")],
1817
+ _request_timeout: Union[
1818
+ None,
1819
+ Annotated[StrictFloat, Field(gt=0)],
1820
+ Tuple[
1821
+ Annotated[StrictFloat, Field(gt=0)],
1822
+ Annotated[StrictFloat, Field(gt=0)]
1823
+ ]
1824
+ ] = None,
1825
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1826
+ _content_type: Optional[StrictStr] = None,
1827
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1828
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1829
+ ) -> RESTResponseType:
1830
+ """Updates the validation information of a Rapid.
1831
+
1832
+
1833
+ :param rapid_id: The id of the rapid to update (required)
1834
+ :type rapid_id: str
1835
+ :param update_validation_rapid_model: The body request (required)
1836
+ :type update_validation_rapid_model: UpdateValidationRapidModel
1837
+ :param _request_timeout: timeout setting for this request. If one
1838
+ number provided, it will be total request
1839
+ timeout. It can also be a pair (tuple) of
1840
+ (connection, read) timeouts.
1841
+ :type _request_timeout: int, tuple(int, int), optional
1842
+ :param _request_auth: set to override the auth_settings for an a single
1843
+ request; this effectively ignores the
1844
+ authentication in the spec for a single request.
1845
+ :type _request_auth: dict, optional
1846
+ :param _content_type: force content-type for the request.
1847
+ :type _content_type: str, Optional
1848
+ :param _headers: set to override the headers for a single
1849
+ request; this effectively ignores the headers
1850
+ in the spec for a single request.
1851
+ :type _headers: dict, optional
1852
+ :param _host_index: set to override the host_index for a single
1853
+ request; this effectively ignores the host_index
1854
+ in the spec for a single request.
1855
+ :type _host_index: int, optional
1856
+ :return: Returns the result object.
1857
+ """ # noqa: E501
1858
+
1859
+ _param = self._rapid_validation_rapid_id_patch_serialize(
1860
+ rapid_id=rapid_id,
1861
+ update_validation_rapid_model=update_validation_rapid_model,
1862
+ _request_auth=_request_auth,
1863
+ _content_type=_content_type,
1864
+ _headers=_headers,
1865
+ _host_index=_host_index
1866
+ )
1867
+
1868
+ _response_types_map: Dict[str, Optional[str]] = {
1869
+ '204': None,
1870
+ }
1871
+ response_data = self.api_client.call_api(
1872
+ *_param,
1873
+ _request_timeout=_request_timeout
1874
+ )
1875
+ return response_data.response
1876
+
1877
+
1878
+ def _rapid_validation_rapid_id_patch_serialize(
1879
+ self,
1880
+ rapid_id,
1881
+ update_validation_rapid_model,
1882
+ _request_auth,
1883
+ _content_type,
1884
+ _headers,
1885
+ _host_index,
1886
+ ) -> RequestSerialized:
1887
+
1888
+ _host = None
1889
+
1890
+ _collection_formats: Dict[str, str] = {
1891
+ }
1892
+
1893
+ _path_params: Dict[str, str] = {}
1894
+ _query_params: List[Tuple[str, str]] = []
1895
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1896
+ _form_params: List[Tuple[str, str]] = []
1897
+ _files: Dict[
1898
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1899
+ ] = {}
1900
+ _body_params: Optional[bytes] = None
1901
+
1902
+ # process the path parameters
1903
+ if rapid_id is not None:
1904
+ _path_params['rapidId'] = rapid_id
1905
+ # process the query parameters
1906
+ # process the header parameters
1907
+ # process the form parameters
1908
+ # process the body parameter
1909
+ if update_validation_rapid_model is not None:
1910
+ _body_params = update_validation_rapid_model
1911
+
1912
+
1913
+
1914
+ # set the HTTP header `Content-Type`
1915
+ if _content_type:
1916
+ _header_params['Content-Type'] = _content_type
1917
+ else:
1918
+ _default_content_type = (
1919
+ self.api_client.select_header_content_type(
1920
+ [
1921
+ 'application/json',
1922
+ 'text/json',
1923
+ 'application/*+json'
1924
+ ]
1925
+ )
1926
+ )
1927
+ if _default_content_type is not None:
1928
+ _header_params['Content-Type'] = _default_content_type
1929
+
1930
+ # authentication setting
1931
+ _auth_settings: List[str] = [
1932
+ 'OAuth2',
1933
+ 'OpenIdConnect',
1934
+ 'Bearer'
1935
+ ]
1936
+
1937
+ return self.api_client.param_serialize(
1938
+ method='PATCH',
1939
+ resource_path='/rapid/validation/{rapidId}',
1940
+ path_params=_path_params,
1941
+ query_params=_query_params,
1942
+ header_params=_header_params,
1943
+ body=_body_params,
1944
+ post_params=_form_params,
1945
+ files=_files,
1946
+ auth_settings=_auth_settings,
1947
+ collection_formats=_collection_formats,
1948
+ _host=_host,
1949
+ _request_auth=_request_auth
1950
+ )
1951
+
1952
+
1953
+
1954
+
1955
+ @validate_call
1956
+ def rapids_flagged_get(
1957
+ self,
1958
+ request: Annotated[Optional[QueryModel], Field(description="The request to use to filter, sort and page the results")] = None,
1959
+ _request_timeout: Union[
1960
+ None,
1961
+ Annotated[StrictFloat, Field(gt=0)],
1962
+ Tuple[
1963
+ Annotated[StrictFloat, Field(gt=0)],
1964
+ Annotated[StrictFloat, Field(gt=0)]
1965
+ ]
1966
+ ] = None,
1967
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1968
+ _content_type: Optional[StrictStr] = None,
1969
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1970
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1971
+ ) -> PagedResultOfRapidModel:
1972
+ """Allows querying all rapids that have been flagged.
1973
+
1974
+
1975
+ :param request: The request to use to filter, sort and page the results
1976
+ :type request: QueryModel
1977
+ :param _request_timeout: timeout setting for this request. If one
1978
+ number provided, it will be total request
1979
+ timeout. It can also be a pair (tuple) of
1980
+ (connection, read) timeouts.
1981
+ :type _request_timeout: int, tuple(int, int), optional
1982
+ :param _request_auth: set to override the auth_settings for an a single
1983
+ request; this effectively ignores the
1984
+ authentication in the spec for a single request.
1985
+ :type _request_auth: dict, optional
1986
+ :param _content_type: force content-type for the request.
1987
+ :type _content_type: str, Optional
1988
+ :param _headers: set to override the headers for a single
1989
+ request; this effectively ignores the headers
1990
+ in the spec for a single request.
1991
+ :type _headers: dict, optional
1992
+ :param _host_index: set to override the host_index for a single
1993
+ request; this effectively ignores the host_index
1994
+ in the spec for a single request.
1995
+ :type _host_index: int, optional
1996
+ :return: Returns the result object.
1997
+ """ # noqa: E501
1998
+
1999
+ _param = self._rapids_flagged_get_serialize(
2000
+ request=request,
2001
+ _request_auth=_request_auth,
2002
+ _content_type=_content_type,
2003
+ _headers=_headers,
2004
+ _host_index=_host_index
2005
+ )
2006
+
2007
+ _response_types_map: Dict[str, Optional[str]] = {
2008
+ '200': "PagedResultOfRapidModel",
2009
+ }
2010
+ response_data = self.api_client.call_api(
2011
+ *_param,
2012
+ _request_timeout=_request_timeout
2013
+ )
2014
+ response_data.read()
2015
+ return self.api_client.response_deserialize(
2016
+ response_data=response_data,
2017
+ response_types_map=_response_types_map,
2018
+ ).data
2019
+
2020
+
2021
+ @validate_call
2022
+ def rapids_flagged_get_with_http_info(
2023
+ self,
2024
+ request: Annotated[Optional[QueryModel], Field(description="The request to use to filter, sort and page the results")] = None,
2025
+ _request_timeout: Union[
2026
+ None,
2027
+ Annotated[StrictFloat, Field(gt=0)],
2028
+ Tuple[
2029
+ Annotated[StrictFloat, Field(gt=0)],
2030
+ Annotated[StrictFloat, Field(gt=0)]
2031
+ ]
2032
+ ] = None,
2033
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2034
+ _content_type: Optional[StrictStr] = None,
2035
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2036
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2037
+ ) -> ApiResponse[PagedResultOfRapidModel]:
2038
+ """Allows querying all rapids that have been flagged.
2039
+
2040
+
2041
+ :param request: The request to use to filter, sort and page the results
2042
+ :type request: QueryModel
2043
+ :param _request_timeout: timeout setting for this request. If one
2044
+ number provided, it will be total request
2045
+ timeout. It can also be a pair (tuple) of
2046
+ (connection, read) timeouts.
2047
+ :type _request_timeout: int, tuple(int, int), optional
2048
+ :param _request_auth: set to override the auth_settings for an a single
2049
+ request; this effectively ignores the
2050
+ authentication in the spec for a single request.
2051
+ :type _request_auth: dict, optional
2052
+ :param _content_type: force content-type for the request.
2053
+ :type _content_type: str, Optional
2054
+ :param _headers: set to override the headers for a single
2055
+ request; this effectively ignores the headers
2056
+ in the spec for a single request.
2057
+ :type _headers: dict, optional
2058
+ :param _host_index: set to override the host_index for a single
2059
+ request; this effectively ignores the host_index
2060
+ in the spec for a single request.
2061
+ :type _host_index: int, optional
2062
+ :return: Returns the result object.
2063
+ """ # noqa: E501
2064
+
2065
+ _param = self._rapids_flagged_get_serialize(
2066
+ request=request,
2067
+ _request_auth=_request_auth,
2068
+ _content_type=_content_type,
2069
+ _headers=_headers,
2070
+ _host_index=_host_index
2071
+ )
2072
+
2073
+ _response_types_map: Dict[str, Optional[str]] = {
2074
+ '200': "PagedResultOfRapidModel",
2075
+ }
2076
+ response_data = self.api_client.call_api(
2077
+ *_param,
2078
+ _request_timeout=_request_timeout
2079
+ )
2080
+ response_data.read()
2081
+ return self.api_client.response_deserialize(
2082
+ response_data=response_data,
2083
+ response_types_map=_response_types_map,
2084
+ )
2085
+
2086
+
2087
+ @validate_call
2088
+ def rapids_flagged_get_without_preload_content(
2089
+ self,
2090
+ request: Annotated[Optional[QueryModel], Field(description="The request to use to filter, sort and page the results")] = None,
2091
+ _request_timeout: Union[
2092
+ None,
2093
+ Annotated[StrictFloat, Field(gt=0)],
2094
+ Tuple[
2095
+ Annotated[StrictFloat, Field(gt=0)],
2096
+ Annotated[StrictFloat, Field(gt=0)]
2097
+ ]
2098
+ ] = None,
2099
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2100
+ _content_type: Optional[StrictStr] = None,
2101
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2102
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2103
+ ) -> RESTResponseType:
2104
+ """Allows querying all rapids that have been flagged.
2105
+
2106
+
2107
+ :param request: The request to use to filter, sort and page the results
2108
+ :type request: QueryModel
2109
+ :param _request_timeout: timeout setting for this request. If one
2110
+ number provided, it will be total request
2111
+ timeout. It can also be a pair (tuple) of
2112
+ (connection, read) timeouts.
2113
+ :type _request_timeout: int, tuple(int, int), optional
2114
+ :param _request_auth: set to override the auth_settings for an a single
2115
+ request; this effectively ignores the
2116
+ authentication in the spec for a single request.
2117
+ :type _request_auth: dict, optional
2118
+ :param _content_type: force content-type for the request.
2119
+ :type _content_type: str, Optional
2120
+ :param _headers: set to override the headers for a single
2121
+ request; this effectively ignores the headers
2122
+ in the spec for a single request.
2123
+ :type _headers: dict, optional
2124
+ :param _host_index: set to override the host_index for a single
2125
+ request; this effectively ignores the host_index
2126
+ in the spec for a single request.
2127
+ :type _host_index: int, optional
2128
+ :return: Returns the result object.
2129
+ """ # noqa: E501
2130
+
2131
+ _param = self._rapids_flagged_get_serialize(
2132
+ request=request,
2133
+ _request_auth=_request_auth,
2134
+ _content_type=_content_type,
2135
+ _headers=_headers,
2136
+ _host_index=_host_index
2137
+ )
2138
+
2139
+ _response_types_map: Dict[str, Optional[str]] = {
2140
+ '200': "PagedResultOfRapidModel",
2141
+ }
2142
+ response_data = self.api_client.call_api(
2143
+ *_param,
2144
+ _request_timeout=_request_timeout
2145
+ )
2146
+ return response_data.response
2147
+
2148
+
2149
+ def _rapids_flagged_get_serialize(
2150
+ self,
2151
+ request,
2152
+ _request_auth,
2153
+ _content_type,
2154
+ _headers,
2155
+ _host_index,
2156
+ ) -> RequestSerialized:
2157
+
2158
+ _host = None
2159
+
2160
+ _collection_formats: Dict[str, str] = {
2161
+ }
2162
+
2163
+ _path_params: Dict[str, str] = {}
2164
+ _query_params: List[Tuple[str, str]] = []
2165
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2166
+ _form_params: List[Tuple[str, str]] = []
2167
+ _files: Dict[
2168
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2169
+ ] = {}
2170
+ _body_params: Optional[bytes] = None
2171
+
2172
+ # process the path parameters
2173
+ # process the query parameters
2174
+ if request is not None:
2175
+
2176
+ _query_params.append(('request', request))
2177
+
2178
+ # process the header parameters
2179
+ # process the form parameters
2180
+ # process the body parameter
2181
+
2182
+
2183
+ # set the HTTP header `Accept`
2184
+ if 'Accept' not in _header_params:
2185
+ _header_params['Accept'] = self.api_client.select_header_accept(
2186
+ [
2187
+ 'text/plain',
2188
+ 'application/json',
2189
+ 'text/json'
2190
+ ]
2191
+ )
2192
+
2193
+
2194
+ # authentication setting
2195
+ _auth_settings: List[str] = [
2196
+ 'OAuth2',
2197
+ 'OpenIdConnect',
2198
+ 'Bearer'
2199
+ ]
2200
+
2201
+ return self.api_client.param_serialize(
2202
+ method='GET',
2203
+ resource_path='/rapids/flagged',
2204
+ path_params=_path_params,
2205
+ query_params=_query_params,
2206
+ header_params=_header_params,
2207
+ body=_body_params,
2208
+ post_params=_form_params,
2209
+ files=_files,
2210
+ auth_settings=_auth_settings,
2211
+ collection_formats=_collection_formats,
2212
+ _host=_host,
2213
+ _request_auth=_request_auth
2214
+ )
2215
+
2216
+