rapidata 2.27.2__py3-none-any.whl → 2.44.3__py3-none-any.whl

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