rapidata 2.37.0__py3-none-any.whl → 3.0.0a8__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


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

Files changed (743) hide show
  1. rapidata/__init__.py +23 -15
  2. rapidata/api_client/__init__.py +84 -427
  3. rapidata/api_client/api/__init__.py +5 -2
  4. rapidata/api_client/api/asset_api.py +853 -0
  5. rapidata/api_client/api/audience_api.py +2505 -0
  6. rapidata/api_client/api/benchmark_api.py +618 -253
  7. rapidata/api_client/api/campaign_api.py +322 -32
  8. rapidata/api_client/api/client_api.py +38 -33
  9. rapidata/api_client/api/compare_workflow_api.py +11 -10
  10. rapidata/api_client/api/customer_rapid_api.py +119 -125
  11. rapidata/api_client/api/datapoint_api.py +8 -6
  12. rapidata/api_client/api/dataset_api.py +240 -1516
  13. rapidata/api_client/api/evaluation_workflow_api.py +29 -82
  14. rapidata/api_client/api/feedback_api.py +11 -11
  15. rapidata/api_client/api/grouped_ranking_workflow_api.py +319 -0
  16. rapidata/api_client/api/identity_api.py +26 -300
  17. rapidata/api_client/api/job_api.py +3902 -0
  18. rapidata/api_client/api/job_definition_api.py +319 -0
  19. rapidata/api_client/api/job_revision_api.py +335 -0
  20. rapidata/api_client/api/leaderboard_api.py +139 -2355
  21. rapidata/api_client/api/newsletter_api.py +20 -19
  22. rapidata/api_client/api/order_api.py +375 -91
  23. rapidata/api_client/api/participant_api.py +80 -118
  24. rapidata/api_client/api/pipeline_api.py +24 -607
  25. rapidata/api_client/api/prompt_api.py +11 -11
  26. rapidata/api_client/api/rapidata_identity_api_api.py +5 -4
  27. rapidata/api_client/api/sample_api.py +5 -4
  28. rapidata/api_client/api/simple_workflow_api.py +11 -10
  29. rapidata/api_client/api/survey_api.py +304 -0
  30. rapidata/api_client/api/user_rapid_api.py +35 -31
  31. rapidata/api_client/api/validation_set_api.py +337 -2043
  32. rapidata/api_client/api/workflow_api.py +32 -26
  33. rapidata/api_client/api_client.py +2 -2
  34. rapidata/api_client/configuration.py +16 -29
  35. rapidata/api_client/exceptions.py +2 -2
  36. rapidata/api_client/models/__init__.py +65 -400
  37. rapidata/api_client/models/ab_test_selection_a_inner.py +1 -1
  38. rapidata/api_client/models/add_rapid_to_audience_model.py +144 -0
  39. rapidata/api_client/models/add_user_response_result.py +10 -5
  40. rapidata/api_client/models/add_validation_rapid_model.py +34 -36
  41. rapidata/api_client/models/add_validation_rapid_model_asset.py +154 -0
  42. rapidata/api_client/models/add_validation_rapid_model_context_asset.py +160 -0
  43. rapidata/api_client/models/add_validation_rapid_model_metadata_inner.py +140 -0
  44. rapidata/api_client/models/add_validation_rapid_new_model.py +137 -0
  45. rapidata/api_client/models/add_validation_rapid_new_model_asset.py +182 -0
  46. rapidata/api_client/models/add_validation_rapid_new_model_truth.py +286 -0
  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_filters_inner.py +24 -10
  52. rapidata/api_client/models/are_rapids_active_result.py +2 -2
  53. rapidata/api_client/models/asset_metadata.py +2 -8
  54. rapidata/api_client/models/attach_category_rapid_blueprint.py +13 -3
  55. rapidata/api_client/models/attach_category_rapid_blueprint_category.py +89 -0
  56. rapidata/api_client/models/audience_job_state.py +38 -0
  57. rapidata/api_client/models/audience_status.py +39 -0
  58. rapidata/api_client/models/benchmark_query_result.py +5 -3
  59. rapidata/api_client/models/boost_leaderboard_model.py +5 -5
  60. rapidata/api_client/models/boost_query_result.py +4 -4
  61. rapidata/api_client/models/boost_query_result_boost_mode.py +37 -0
  62. rapidata/api_client/models/boost_query_result_boost_status.py +39 -0
  63. rapidata/api_client/models/boosting_profile.py +91 -0
  64. rapidata/api_client/models/box_shape.py +4 -33
  65. rapidata/api_client/models/campaign_query_result.py +13 -5
  66. rapidata/api_client/models/campaign_status.py +2 -2
  67. rapidata/api_client/models/change_boost_model.py +5 -5
  68. rapidata/api_client/models/classify_payload.py +14 -15
  69. rapidata/api_client/models/classify_payload_category.py +89 -0
  70. rapidata/api_client/models/client_model.py +25 -35
  71. rapidata/api_client/models/clients_query_result.py +5 -5
  72. rapidata/api_client/models/clone_order_model.py +4 -4
  73. rapidata/api_client/models/clone_order_result.py +9 -4
  74. rapidata/api_client/models/compare_workflow_config.py +19 -18
  75. rapidata/api_client/models/compare_workflow_config_context_asset.py +174 -0
  76. rapidata/api_client/models/compare_workflow_config_model.py +3 -3
  77. rapidata/api_client/models/compare_workflow_model.py +25 -7
  78. rapidata/api_client/models/compare_workflow_model1.py +20 -9
  79. rapidata/api_client/models/compare_workflow_model_context_asset.py +160 -0
  80. rapidata/api_client/models/compare_workflow_model_metadata_inner.py +154 -0
  81. rapidata/api_client/models/compare_workflow_model_pair_maker_config.py +1 -1
  82. rapidata/api_client/models/comparison_operator.py +2 -2
  83. rapidata/api_client/models/conditional_validation_selection.py +6 -11
  84. rapidata/api_client/models/conditional_validation_selection_validation_chance.py +103 -0
  85. rapidata/api_client/models/confidence_interval.py +89 -0
  86. rapidata/api_client/models/create_audience_request.py +122 -0
  87. rapidata/api_client/models/create_audience_result.py +87 -0
  88. rapidata/api_client/models/create_benchmark_model.py +5 -5
  89. rapidata/api_client/models/create_benchmark_participant_model.py +5 -5
  90. rapidata/api_client/models/create_benchmark_participant_result.py +4 -4
  91. rapidata/api_client/models/create_benchmark_prompt_result.py +87 -0
  92. rapidata/api_client/models/create_benchmark_result.py +2 -2
  93. rapidata/api_client/models/create_bridge_token_result.py +2 -2
  94. rapidata/api_client/models/create_client_model.py +6 -13
  95. rapidata/api_client/models/create_complex_order_model.py +9 -9
  96. rapidata/api_client/models/create_complex_order_result.py +2 -2
  97. rapidata/api_client/models/create_customer_client_result.py +2 -2
  98. rapidata/api_client/models/create_datapoint_from_files_model.py +3 -3
  99. rapidata/api_client/models/create_datapoint_from_text_sources_model.py +3 -3
  100. rapidata/api_client/models/create_datapoint_from_urls_model.py +3 -3
  101. rapidata/api_client/models/create_datapoint_model.py +124 -0
  102. rapidata/api_client/models/create_datapoint_model_asset.py +154 -0
  103. rapidata/api_client/models/create_datapoint_model_context_asset.py +160 -0
  104. rapidata/api_client/models/create_datapoint_model_metadata_inner.py +154 -0
  105. rapidata/api_client/models/create_datapoint_result.py +2 -2
  106. rapidata/api_client/models/create_dataset_endpoint_input.py +87 -0
  107. rapidata/api_client/models/create_dataset_endpoint_output.py +87 -0
  108. rapidata/api_client/models/create_demographic_rapid_model.py +33 -10
  109. rapidata/api_client/models/create_demographic_rapid_model_asset.py +160 -0
  110. rapidata/api_client/models/create_demographic_rapid_model_context_asset.py +160 -0
  111. rapidata/api_client/models/create_demographic_rapid_model_new.py +119 -0
  112. rapidata/api_client/models/create_empty_validation_set_result.py +2 -2
  113. rapidata/api_client/models/create_job_definition_endpoint_input.py +119 -0
  114. rapidata/api_client/models/create_job_definition_endpoint_output.py +89 -0
  115. rapidata/api_client/models/create_job_endpoint_input.py +100 -0
  116. rapidata/api_client/models/create_job_endpoint_output.py +89 -0
  117. rapidata/api_client/models/create_job_revision_endpoint_input.py +127 -0
  118. rapidata/api_client/models/create_job_revision_endpoint_output.py +89 -0
  119. rapidata/api_client/models/create_leaderboard_model.py +23 -26
  120. rapidata/api_client/models/create_leaderboard_result.py +2 -2
  121. rapidata/api_client/models/create_order_definition_model.py +119 -0
  122. rapidata/api_client/models/create_order_definition_result.py +87 -0
  123. rapidata/api_client/models/create_order_definition_revision_model.py +117 -0
  124. rapidata/api_client/models/create_order_definition_revision_result.py +87 -0
  125. rapidata/api_client/models/create_order_model.py +33 -62
  126. rapidata/api_client/models/create_order_model_referee.py +12 -12
  127. rapidata/api_client/models/create_order_model_workflow.py +35 -21
  128. rapidata/api_client/models/create_order_result.py +2 -2
  129. rapidata/api_client/models/create_rapid_result.py +2 -2
  130. rapidata/api_client/models/create_sample_model.py +13 -7
  131. rapidata/api_client/models/create_sample_model_asset.py +154 -0
  132. rapidata/api_client/models/create_sample_model_obsolete.py +87 -0
  133. rapidata/api_client/models/create_simple_pipeline_model_pipeline_steps_inner.py +8 -22
  134. rapidata/api_client/models/create_unsupported_order_model.py +6 -6
  135. rapidata/api_client/models/create_validation_set_model.py +5 -5
  136. rapidata/api_client/models/datapoint_model.py +3 -3
  137. rapidata/api_client/models/datapoint_state.py +2 -2
  138. rapidata/api_client/models/definition_type.py +49 -0
  139. rapidata/api_client/models/dynamic_client_registration_request.py +21 -36
  140. rapidata/api_client/models/early_stopping_referee_model.py +3 -3
  141. rapidata/api_client/models/elo_config.py +2 -2
  142. rapidata/api_client/models/elo_config_model.py +6 -6
  143. rapidata/api_client/models/entity_tag_header_value.py +93 -0
  144. rapidata/api_client/models/evaluation_workflow_model.py +4 -4
  145. rapidata/api_client/models/existing_asset_input.py +109 -0
  146. rapidata/api_client/models/existing_asset_input_metadata_value.py +126 -0
  147. rapidata/api_client/models/feature_flag.py +2 -2
  148. rapidata/api_client/models/feature_flag_model.py +2 -2
  149. rapidata/api_client/models/feedback_model.py +7 -7
  150. rapidata/api_client/models/file_asset.py +3 -5
  151. rapidata/api_client/models/file_asset_input_file.py +8 -22
  152. rapidata/api_client/models/file_asset_metadata_value.py +252 -0
  153. rapidata/api_client/models/file_asset_model_metadata_value.py +18 -88
  154. rapidata/api_client/models/file_stream_result.py +122 -0
  155. rapidata/api_client/models/file_type.py +2 -2
  156. rapidata/api_client/models/filter.py +2 -2
  157. rapidata/api_client/models/filter_operator.py +2 -2
  158. rapidata/api_client/models/fork_benchmark_result.py +87 -0
  159. rapidata/api_client/models/form_file_wrapper.py +17 -2
  160. rapidata/api_client/models/gender_user_filter_model.py +2 -2
  161. rapidata/api_client/models/gender_user_filter_model_gender.py +38 -0
  162. rapidata/api_client/models/get_asset_metadata_result.py +100 -0
  163. rapidata/api_client/models/get_audience_by_id_result.py +118 -0
  164. rapidata/api_client/models/get_available_validation_sets_result.py +2 -2
  165. rapidata/api_client/models/get_benchmark_by_id_result.py +8 -4
  166. rapidata/api_client/models/get_boost_result.py +97 -0
  167. rapidata/api_client/models/get_boost_result_boost_mode.py +37 -0
  168. rapidata/api_client/models/get_boost_result_boost_status.py +39 -0
  169. rapidata/api_client/models/get_compare_ab_summary_result.py +3 -5
  170. rapidata/api_client/models/get_compare_workflow_results_model.py +7 -7
  171. rapidata/api_client/models/get_compare_workflow_results_result.py +5 -5
  172. rapidata/api_client/models/get_datapoint_by_id_result.py +7 -12
  173. rapidata/api_client/models/get_datapoint_by_id_result_asset.py +170 -0
  174. rapidata/api_client/models/get_dataset_by_id_result.py +2 -2
  175. rapidata/api_client/models/get_dataset_progress_result.py +2 -2
  176. rapidata/api_client/models/get_evaluation_workflow_results_model.py +119 -0
  177. rapidata/api_client/models/get_failed_datapoints_result.py +5 -5
  178. rapidata/api_client/models/get_failed_datapoints_result_datapoint.py +100 -0
  179. rapidata/api_client/models/get_file_metadata_result.py +100 -0
  180. rapidata/api_client/models/get_grouped_ranking_workflow_results_model.py +106 -0
  181. rapidata/api_client/models/get_grouped_ranking_workflow_results_result.py +97 -0
  182. rapidata/api_client/models/get_grouped_ranking_workflow_results_result_paged_result.py +105 -0
  183. rapidata/api_client/models/get_job_by_id_endpoint_output.py +130 -0
  184. rapidata/api_client/models/get_job_definition_by_id_endpoint_output.py +95 -0
  185. rapidata/api_client/models/get_job_revision_endpoint_output.py +133 -0
  186. rapidata/api_client/models/get_leaderboard_by_id_result.py +5 -5
  187. rapidata/api_client/models/get_order_by_id_result.py +12 -5
  188. rapidata/api_client/models/get_participant_by_id_result.py +4 -6
  189. rapidata/api_client/models/get_pipeline_by_id_result.py +5 -5
  190. rapidata/api_client/models/get_public_orders_result.py +2 -2
  191. rapidata/api_client/models/get_public_responses_result.py +5 -5
  192. rapidata/api_client/models/get_public_responses_result_response.py +112 -0
  193. rapidata/api_client/models/get_rapid_responses_result.py +3 -3
  194. rapidata/api_client/models/get_recommended_validation_set_result.py +2 -2
  195. rapidata/api_client/models/get_responses_for_rapid_result.py +106 -0
  196. rapidata/api_client/models/get_responses_for_rapid_result_response.py +103 -0
  197. rapidata/api_client/models/get_responses_for_rapid_result_response_result.py +266 -0
  198. rapidata/api_client/models/get_responses_result.py +5 -5
  199. rapidata/api_client/models/get_responses_result_response.py +103 -0
  200. rapidata/api_client/models/get_sample_by_id_result.py +7 -8
  201. rapidata/api_client/models/get_simple_workflow_results_model.py +20 -15
  202. rapidata/api_client/models/get_standing_by_id_result.py +3 -5
  203. rapidata/api_client/models/get_validation_rapids_result.py +29 -32
  204. rapidata/api_client/models/get_validation_set_by_id_result.py +10 -4
  205. rapidata/api_client/models/get_workflow_by_id_result.py +5 -5
  206. rapidata/api_client/models/get_workflow_by_id_result_workflow.py +23 -9
  207. rapidata/api_client/models/get_workflow_progress_result.py +2 -2
  208. rapidata/api_client/models/get_workflow_results_result.py +31 -14
  209. rapidata/api_client/models/get_workflow_results_result_response.py +103 -0
  210. rapidata/api_client/models/google_one_tap_login_model.py +4 -4
  211. rapidata/api_client/models/grouped_ranking_workflow_config.py +155 -0
  212. rapidata/api_client/models/grouped_ranking_workflow_config_context_assets_value.py +170 -0
  213. rapidata/api_client/models/grouped_ranking_workflow_model.py +147 -0
  214. rapidata/api_client/models/grouped_ranking_workflow_model1.py +121 -0
  215. rapidata/api_client/models/i_artifact_model.py +182 -0
  216. rapidata/api_client/models/i_artifact_model_campaign_artifact_model.py +98 -0
  217. rapidata/api_client/models/i_artifact_model_dataset_artifact_model.py +98 -0
  218. rapidata/api_client/models/i_artifact_model_file_artifact_model.py +98 -0
  219. rapidata/api_client/models/i_artifact_model_workflow_artifact_model.py +98 -0
  220. rapidata/api_client/models/i_artifact_model_workflow_config_artifact_model.py +102 -0
  221. rapidata/api_client/models/i_asset.py +170 -0
  222. rapidata/api_client/models/i_asset_file_asset.py +111 -0
  223. rapidata/api_client/models/i_asset_input.py +156 -0
  224. rapidata/api_client/models/i_asset_input_existing_asset_input.py +118 -0
  225. rapidata/api_client/models/i_asset_input_multi_asset_input.py +128 -0
  226. rapidata/api_client/models/i_asset_input_text_asset_input.py +118 -0
  227. rapidata/api_client/models/i_asset_model.py +170 -0
  228. rapidata/api_client/models/i_asset_model_file_asset_model.py +113 -0
  229. rapidata/api_client/models/i_asset_model_multi_asset_model.py +123 -0
  230. rapidata/api_client/models/i_asset_model_null_asset_model.py +111 -0
  231. rapidata/api_client/models/i_asset_model_text_asset_model.py +113 -0
  232. rapidata/api_client/models/i_asset_multi_asset.py +121 -0
  233. rapidata/api_client/models/i_asset_null_asset.py +109 -0
  234. rapidata/api_client/models/i_asset_text_asset.py +111 -0
  235. rapidata/api_client/models/i_audience_filter.py +184 -0
  236. rapidata/api_client/models/i_audience_filter_and_audience_filter.py +106 -0
  237. rapidata/api_client/models/i_audience_filter_country_audience_filter.py +96 -0
  238. rapidata/api_client/models/i_audience_filter_country_filter.py +96 -0
  239. rapidata/api_client/models/i_audience_filter_language_audience_filter.py +96 -0
  240. rapidata/api_client/models/i_audience_filter_language_filter.py +96 -0
  241. rapidata/api_client/models/i_audience_filter_not_audience_filter.py +102 -0
  242. rapidata/api_client/models/i_audience_filter_or_audience_filter.py +106 -0
  243. rapidata/api_client/models/i_campaign_filter.py +296 -0
  244. rapidata/api_client/models/i_campaign_filter_and_filter.py +117 -0
  245. rapidata/api_client/models/i_campaign_filter_campaign_filter.py +98 -0
  246. rapidata/api_client/models/i_campaign_filter_campaign_session_count_filter.py +101 -0
  247. rapidata/api_client/models/i_campaign_filter_country_filter.py +98 -0
  248. rapidata/api_client/models/i_campaign_filter_demographic_filter.py +100 -0
  249. rapidata/api_client/models/i_campaign_filter_device_filter.py +106 -0
  250. rapidata/api_client/models/i_campaign_filter_language_filter.py +98 -0
  251. rapidata/api_client/models/i_campaign_filter_new_user_filter.py +96 -0
  252. rapidata/api_client/models/i_campaign_filter_not_filter.py +113 -0
  253. rapidata/api_client/models/i_campaign_filter_or_filter.py +117 -0
  254. rapidata/api_client/models/i_campaign_filter_response_count_filter.py +103 -0
  255. rapidata/api_client/models/i_campaign_filter_user_action_restriction_filter.py +106 -0
  256. rapidata/api_client/models/i_campaign_filter_user_score_filter.py +102 -0
  257. rapidata/api_client/models/i_campaign_filter_user_state_filter.py +106 -0
  258. rapidata/api_client/models/i_dataset_metadata_input.py +154 -0
  259. rapidata/api_client/models/i_dataset_metadata_input_prompt_asset_metadata_input.py +100 -0
  260. rapidata/api_client/models/i_dataset_metadata_input_prompt_metadata_input.py +96 -0
  261. rapidata/api_client/models/i_dataset_metadata_input_transcription_metadata_input.py +96 -0
  262. rapidata/api_client/models/i_dataset_model.py +126 -0
  263. rapidata/api_client/models/i_dataset_model_clone_dataset_model.py +98 -0
  264. rapidata/api_client/models/i_metadata.py +252 -0
  265. rapidata/api_client/models/i_metadata_classification_metadata.py +109 -0
  266. rapidata/api_client/models/i_metadata_count_metadata.py +109 -0
  267. rapidata/api_client/models/i_metadata_duration_metadata.py +110 -0
  268. rapidata/api_client/models/i_metadata_file_type_metadata.py +110 -0
  269. rapidata/api_client/models/i_metadata_image_dimension_metadata.py +111 -0
  270. rapidata/api_client/models/i_metadata_input.py +126 -0
  271. rapidata/api_client/models/i_metadata_input_text_metadata_input.py +111 -0
  272. rapidata/api_client/models/i_metadata_location_metadata.py +111 -0
  273. rapidata/api_client/models/i_metadata_model.py +252 -0
  274. rapidata/api_client/models/i_metadata_model_classification_metadata_model.py +96 -0
  275. rapidata/api_client/models/i_metadata_model_count_metadata_model.py +96 -0
  276. rapidata/api_client/models/i_metadata_model_file_type_metadata_model.py +97 -0
  277. rapidata/api_client/models/i_metadata_model_image_dimension_metadata_model.py +98 -0
  278. rapidata/api_client/models/i_metadata_model_location_metadata_model.py +98 -0
  279. rapidata/api_client/models/i_metadata_model_original_filename_metadata_model.py +96 -0
  280. rapidata/api_client/models/i_metadata_model_source_url_metadata_model.py +96 -0
  281. rapidata/api_client/models/i_metadata_model_streams_metadata_model.py +100 -0
  282. rapidata/api_client/models/i_metadata_model_text_metadata_model.py +101 -0
  283. rapidata/api_client/models/i_metadata_model_video_duration_metadata_model.py +97 -0
  284. rapidata/api_client/models/i_metadata_original_filename_metadata.py +109 -0
  285. rapidata/api_client/models/i_metadata_source_url_metadata.py +109 -0
  286. rapidata/api_client/models/i_metadata_streams_metadata.py +113 -0
  287. rapidata/api_client/models/i_metadata_text_metadata.py +114 -0
  288. rapidata/api_client/models/i_metadata_video_duration_metadata.py +110 -0
  289. rapidata/api_client/models/i_order_workflow_model.py +168 -0
  290. rapidata/api_client/models/i_order_workflow_model_compare_workflow_model.py +146 -0
  291. rapidata/api_client/models/i_order_workflow_model_evaluation_workflow_model.py +108 -0
  292. rapidata/api_client/models/i_order_workflow_model_grouped_ranking_workflow_model.py +147 -0
  293. rapidata/api_client/models/i_order_workflow_model_simple_workflow_model.py +110 -0
  294. rapidata/api_client/models/i_pair_maker_config.py +126 -0
  295. rapidata/api_client/models/i_pair_maker_config_model.py +126 -0
  296. rapidata/api_client/models/i_pair_maker_config_model_online_pair_maker_config_model.py +98 -0
  297. rapidata/api_client/models/i_pair_maker_config_online_pair_maker_config.py +98 -0
  298. rapidata/api_client/models/i_pair_maker_information.py +126 -0
  299. rapidata/api_client/models/i_pair_maker_information_online_pair_maker_information.py +100 -0
  300. rapidata/api_client/models/i_pipeline_artifact_model.py +126 -0
  301. rapidata/api_client/models/i_pipeline_artifact_model_create_dataset_artifact_model.py +102 -0
  302. rapidata/api_client/models/i_pipeline_model.py +126 -0
  303. rapidata/api_client/models/i_pipeline_model_create_simple_pipeline_model.py +116 -0
  304. rapidata/api_client/models/i_pipeline_step_model.py +168 -0
  305. rapidata/api_client/models/i_pipeline_step_model_dataset_evaluation_step_model.py +102 -0
  306. rapidata/api_client/models/i_pipeline_step_model_send_completion_mail_step_model.py +98 -0
  307. rapidata/api_client/models/i_pipeline_step_model_workflow_aggregation_step_model.py +103 -0
  308. rapidata/api_client/models/i_pipeline_step_model_workflow_labeling_step_model.py +96 -0
  309. rapidata/api_client/models/i_rapid_blueprint.py +252 -0
  310. rapidata/api_client/models/i_rapid_blueprint_attach_category_rapid_blueprint.py +108 -0
  311. rapidata/api_client/models/i_rapid_blueprint_bounding_box_rapid_blueprint.py +96 -0
  312. rapidata/api_client/models/i_rapid_blueprint_compare_rapid_blueprint.py +98 -0
  313. rapidata/api_client/models/i_rapid_blueprint_free_text_rapid_blueprint.py +105 -0
  314. rapidata/api_client/models/i_rapid_blueprint_line_rapid_blueprint.py +96 -0
  315. rapidata/api_client/models/i_rapid_blueprint_locate_rapid_blueprint.py +96 -0
  316. rapidata/api_client/models/i_rapid_blueprint_named_entity_rapid_blueprint.py +98 -0
  317. rapidata/api_client/models/i_rapid_blueprint_polygon_rapid_blueprint.py +96 -0
  318. rapidata/api_client/models/i_rapid_blueprint_scrub_rapid_blueprint.py +96 -0
  319. rapidata/api_client/models/i_rapid_blueprint_transcription_rapid_blueprint.py +96 -0
  320. rapidata/api_client/models/i_rapid_payload.py +252 -0
  321. rapidata/api_client/models/i_rapid_payload_bounding_box_payload.py +96 -0
  322. rapidata/api_client/models/i_rapid_payload_classify_payload.py +106 -0
  323. rapidata/api_client/models/i_rapid_payload_compare_payload.py +96 -0
  324. rapidata/api_client/models/i_rapid_payload_free_text_payload.py +105 -0
  325. rapidata/api_client/models/i_rapid_payload_line_payload.py +96 -0
  326. rapidata/api_client/models/i_rapid_payload_locate_payload.py +96 -0
  327. rapidata/api_client/models/i_rapid_payload_named_entity_payload.py +98 -0
  328. rapidata/api_client/models/i_rapid_payload_polygon_payload.py +96 -0
  329. rapidata/api_client/models/i_rapid_payload_scrub_payload.py +96 -0
  330. rapidata/api_client/models/i_rapid_payload_transcription_payload.py +106 -0
  331. rapidata/api_client/models/i_rapid_result.py +266 -0
  332. rapidata/api_client/models/i_rapid_result_attach_category_result.py +98 -0
  333. rapidata/api_client/models/i_rapid_result_bounding_box_result.py +106 -0
  334. rapidata/api_client/models/i_rapid_result_compare_result.py +98 -0
  335. rapidata/api_client/models/i_rapid_result_free_text_result.py +98 -0
  336. rapidata/api_client/models/i_rapid_result_line_result.py +106 -0
  337. rapidata/api_client/models/i_rapid_result_locate_result.py +106 -0
  338. rapidata/api_client/models/i_rapid_result_named_entity_result.py +106 -0
  339. rapidata/api_client/models/i_rapid_result_polygon_result.py +106 -0
  340. rapidata/api_client/models/i_rapid_result_scrub_result.py +98 -0
  341. rapidata/api_client/models/i_rapid_result_skip_result.py +96 -0
  342. rapidata/api_client/models/i_rapid_result_transcription_result.py +106 -0
  343. rapidata/api_client/models/i_referee_config.py +154 -0
  344. rapidata/api_client/models/i_referee_config_naive_referee_config.py +96 -0
  345. rapidata/api_client/models/i_referee_config_never_ending_referee_config.py +94 -0
  346. rapidata/api_client/models/i_referee_config_probabilistic_attach_category_referee_config.py +98 -0
  347. rapidata/api_client/models/i_referee_info.py +154 -0
  348. rapidata/api_client/models/i_referee_info_naive_referee_info.py +96 -0
  349. rapidata/api_client/models/i_referee_info_never_ending_referee_info.py +94 -0
  350. rapidata/api_client/models/i_referee_info_probabilistic_attach_category_referee_info.py +98 -0
  351. rapidata/api_client/models/i_referee_model.py +140 -0
  352. rapidata/api_client/models/i_referee_model_early_stopping_referee_model.py +98 -0
  353. rapidata/api_client/models/i_referee_model_naive_referee_model.py +96 -0
  354. rapidata/api_client/models/i_selection.py +240 -0
  355. rapidata/api_client/models/i_selection_ab_test_selection.py +122 -0
  356. rapidata/api_client/models/i_selection_capped_selection.py +108 -0
  357. rapidata/api_client/models/i_selection_conditional_validation_selection.py +110 -0
  358. rapidata/api_client/models/i_selection_demographic_selection.py +98 -0
  359. rapidata/api_client/models/i_selection_effort_capped_selection.py +101 -0
  360. rapidata/api_client/models/i_selection_labeling_selection.py +103 -0
  361. rapidata/api_client/models/i_selection_shuffling_selection.py +106 -0
  362. rapidata/api_client/models/i_selection_static_selection.py +96 -0
  363. rapidata/api_client/models/i_selection_validation_selection.py +98 -0
  364. rapidata/api_client/models/i_user_filter_model.py +296 -0
  365. rapidata/api_client/models/i_user_filter_model_age_user_filter_model.py +104 -0
  366. rapidata/api_client/models/i_user_filter_model_and_user_filter_model.py +106 -0
  367. rapidata/api_client/models/i_user_filter_model_campaign_user_filter_model.py +96 -0
  368. rapidata/api_client/models/i_user_filter_model_country_user_filter_model.py +96 -0
  369. rapidata/api_client/models/i_user_filter_model_custom_user_filter_model.py +98 -0
  370. rapidata/api_client/models/i_user_filter_model_device_user_filter_model.py +104 -0
  371. rapidata/api_client/models/i_user_filter_model_gender_user_filter_model.py +104 -0
  372. rapidata/api_client/models/i_user_filter_model_language_user_filter_model.py +96 -0
  373. rapidata/api_client/models/i_user_filter_model_new_user_filter_model.py +94 -0
  374. rapidata/api_client/models/i_user_filter_model_not_user_filter_model.py +102 -0
  375. rapidata/api_client/models/i_user_filter_model_or_user_filter_model.py +106 -0
  376. rapidata/api_client/models/i_user_filter_model_response_count_user_filter_model.py +101 -0
  377. rapidata/api_client/models/i_user_filter_model_user_score_user_filter_model.py +105 -0
  378. rapidata/api_client/models/i_validation_metadata_input.py +140 -0
  379. rapidata/api_client/models/i_validation_metadata_input_prompt_asset_metadata_input.py +100 -0
  380. rapidata/api_client/models/i_validation_metadata_input_prompt_metadata_input.py +96 -0
  381. rapidata/api_client/models/i_validation_truth.py +280 -0
  382. rapidata/api_client/models/i_validation_truth_attach_category_truth.py +96 -0
  383. rapidata/api_client/models/i_validation_truth_bounding_box_truth.py +102 -0
  384. rapidata/api_client/models/i_validation_truth_compare_truth.py +96 -0
  385. rapidata/api_client/models/i_validation_truth_empty_validation_truth.py +94 -0
  386. rapidata/api_client/models/i_validation_truth_line_truth.py +94 -0
  387. rapidata/api_client/models/i_validation_truth_locate_box_truth.py +108 -0
  388. rapidata/api_client/models/i_validation_truth_model.py +294 -0
  389. rapidata/api_client/models/i_validation_truth_model_attach_category_truth_model.py +96 -0
  390. rapidata/api_client/models/i_validation_truth_model_bounding_box_truth_model.py +102 -0
  391. rapidata/api_client/models/i_validation_truth_model_classify_truth_model.py +96 -0
  392. rapidata/api_client/models/i_validation_truth_model_compare_truth_model.py +96 -0
  393. rapidata/api_client/models/i_validation_truth_model_empty_validation_truth_model.py +94 -0
  394. rapidata/api_client/models/i_validation_truth_model_line_truth_model.py +94 -0
  395. rapidata/api_client/models/i_validation_truth_model_locate_box_truth_model.py +108 -0
  396. rapidata/api_client/models/i_validation_truth_model_multi_compare_truth_model.py +96 -0
  397. rapidata/api_client/models/i_validation_truth_model_named_entity_truth_model.py +104 -0
  398. rapidata/api_client/models/i_validation_truth_model_polygon_truth_model.py +94 -0
  399. rapidata/api_client/models/i_validation_truth_model_scrub_truth_model.py +104 -0
  400. rapidata/api_client/models/i_validation_truth_model_skip_truth_model.py +94 -0
  401. rapidata/api_client/models/i_validation_truth_model_transcription_truth_model.py +115 -0
  402. rapidata/api_client/models/i_validation_truth_multi_compare_truth.py +96 -0
  403. rapidata/api_client/models/i_validation_truth_named_entity_truth.py +104 -0
  404. rapidata/api_client/models/i_validation_truth_polygon_truth.py +94 -0
  405. rapidata/api_client/models/i_validation_truth_scrub_truth.py +104 -0
  406. rapidata/api_client/models/i_validation_truth_skip_truth.py +94 -0
  407. rapidata/api_client/models/i_validation_truth_transcription_truth.py +115 -0
  408. rapidata/api_client/models/i_workflow_config.py +168 -0
  409. rapidata/api_client/models/i_workflow_config_compare_workflow_config.py +142 -0
  410. rapidata/api_client/models/i_workflow_config_evaluation_workflow_config.py +114 -0
  411. rapidata/api_client/models/i_workflow_config_grouped_ranking_workflow_config.py +155 -0
  412. rapidata/api_client/models/i_workflow_config_simple_workflow_config.py +116 -0
  413. rapidata/api_client/models/i_workflow_model.py +168 -0
  414. rapidata/api_client/models/i_workflow_model_compare_workflow_model.py +145 -0
  415. rapidata/api_client/models/i_workflow_model_evaluation_workflow_model.py +115 -0
  416. rapidata/api_client/models/i_workflow_model_grouped_ranking_workflow_model.py +121 -0
  417. rapidata/api_client/models/i_workflow_model_simple_workflow_model.py +119 -0
  418. rapidata/api_client/models/inquire_file_metadata_result.py +100 -0
  419. rapidata/api_client/models/inspect_report_result.py +2 -2
  420. rapidata/api_client/models/job_definition_revision_state.py +38 -0
  421. rapidata/api_client/models/json_web_key.py +2 -36
  422. rapidata/api_client/models/json_web_key_set.py +2 -22
  423. rapidata/api_client/models/labeling_selection.py +9 -2
  424. rapidata/api_client/models/leaderboards_query_result.py +135 -0
  425. rapidata/api_client/models/line_result.py +3 -3
  426. rapidata/api_client/models/line_result_line.py +97 -0
  427. rapidata/api_client/models/line_result_line_point.py +89 -0
  428. rapidata/api_client/models/locate_coordinate.py +4 -13
  429. rapidata/api_client/models/logic_operator.py +2 -2
  430. rapidata/api_client/models/metadata_i_order_metadata_input.py +154 -0
  431. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_asset_metadata_input.py +100 -0
  432. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_metadata_input.py +96 -0
  433. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_transcription_metadata_input.py +96 -0
  434. rapidata/api_client/models/metadata_prompt_asset_metadata_input.py +100 -0
  435. rapidata/api_client/models/metadata_prompt_metadata_input.py +96 -0
  436. rapidata/api_client/models/metadata_transcription_metadata_input.py +96 -0
  437. rapidata/api_client/models/multi_asset.py +6 -6
  438. rapidata/api_client/models/multi_asset_assets_inner.py +170 -0
  439. rapidata/api_client/models/multi_asset_input.py +21 -1
  440. rapidata/api_client/models/multi_asset_input1_assets_inner.py +40 -12
  441. rapidata/api_client/models/multi_asset_input3_assets_inner.py +40 -12
  442. rapidata/api_client/models/multi_asset_input_assets_inner.py +16 -30
  443. rapidata/api_client/models/multi_asset_model.py +3 -3
  444. rapidata/api_client/models/naive_referee_model.py +2 -2
  445. rapidata/api_client/models/named_classification.py +4 -13
  446. rapidata/api_client/models/newsletter_model.py +6 -6
  447. rapidata/api_client/models/not_available_yet_result.py +4 -13
  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/option_of_aggregator_type.py +49 -0
  451. rapidata/api_client/models/order_model.py +12 -5
  452. rapidata/api_client/models/order_state.py +2 -2
  453. rapidata/api_client/models/page_info.py +2 -7
  454. rapidata/api_client/models/paged_result_aggregated_orders_model.py +105 -0
  455. rapidata/api_client/models/paged_result_benchmark_query_result.py +105 -0
  456. rapidata/api_client/models/paged_result_campaign_query_result.py +105 -0
  457. rapidata/api_client/models/paged_result_clients_query_result.py +105 -0
  458. rapidata/api_client/models/paged_result_datapoint_model.py +105 -0
  459. rapidata/api_client/models/paged_result_get_compare_workflow_results_result.py +105 -0
  460. rapidata/api_client/models/paged_result_get_grouped_ranking_workflow_results_result.py +105 -0
  461. rapidata/api_client/models/paged_result_get_validation_rapids_result.py +105 -0
  462. rapidata/api_client/models/paged_result_get_workflow_results_result.py +105 -0
  463. rapidata/api_client/models/paged_result_i_workflow_model.py +105 -0
  464. rapidata/api_client/models/paged_result_leaderboard_query_result.py +105 -0
  465. rapidata/api_client/models/paged_result_leaderboards_query_result.py +105 -0
  466. rapidata/api_client/models/paged_result_of_aggregated_orders_model.py +103 -0
  467. rapidata/api_client/models/paged_result_of_benchmark_query_result.py +103 -0
  468. rapidata/api_client/models/paged_result_of_campaign_query_result.py +103 -0
  469. rapidata/api_client/models/paged_result_of_clients_query_result.py +103 -0
  470. rapidata/api_client/models/paged_result_of_get_compare_workflow_results_result.py +103 -0
  471. rapidata/api_client/models/paged_result_of_get_grouped_ranking_workflow_results_result.py +103 -0
  472. rapidata/api_client/models/paged_result_of_get_validation_rapids_result.py +103 -0
  473. rapidata/api_client/models/paged_result_of_get_workflow_results_result.py +103 -0
  474. rapidata/api_client/models/paged_result_of_i_workflow_model.py +103 -0
  475. rapidata/api_client/models/paged_result_of_leaderboards_query_result.py +103 -0
  476. rapidata/api_client/models/paged_result_of_order_model.py +103 -0
  477. rapidata/api_client/models/paged_result_of_participant_by_benchmark.py +103 -0
  478. rapidata/api_client/models/paged_result_of_prompt_by_benchmark_result.py +103 -0
  479. rapidata/api_client/models/paged_result_of_query_audiences_result.py +103 -0
  480. rapidata/api_client/models/paged_result_of_query_datapoints_by_dataset_id_result.py +103 -0
  481. rapidata/api_client/models/paged_result_of_query_job_definitions_result.py +103 -0
  482. rapidata/api_client/models/paged_result_of_query_job_revisions_result.py +103 -0
  483. rapidata/api_client/models/paged_result_of_query_jobs_result.py +103 -0
  484. rapidata/api_client/models/paged_result_of_query_rapids_for_audience_result.py +103 -0
  485. rapidata/api_client/models/paged_result_of_query_validation_rapid_eligibility_result.py +103 -0
  486. rapidata/api_client/models/paged_result_of_rapid_model.py +103 -0
  487. rapidata/api_client/models/paged_result_of_runs_by_leaderboard_result.py +103 -0
  488. rapidata/api_client/models/paged_result_of_sample_by_identifier.py +103 -0
  489. rapidata/api_client/models/paged_result_of_sample_by_participant.py +103 -0
  490. rapidata/api_client/models/paged_result_of_standing_by_leaderboard.py +103 -0
  491. rapidata/api_client/models/paged_result_of_validation_set_model.py +103 -0
  492. rapidata/api_client/models/paged_result_order_model.py +105 -0
  493. rapidata/api_client/models/paged_result_participant_by_benchmark.py +105 -0
  494. rapidata/api_client/models/paged_result_potential_validation_rapid.py +105 -0
  495. rapidata/api_client/models/paged_result_prompt_by_benchmark_result.py +105 -0
  496. rapidata/api_client/models/paged_result_query_audiences_result.py +105 -0
  497. rapidata/api_client/models/paged_result_query_datapoints_by_dataset_id_result.py +105 -0
  498. rapidata/api_client/models/paged_result_query_validation_rapid_eligibility_result.py +105 -0
  499. rapidata/api_client/models/paged_result_rapid_model.py +105 -0
  500. rapidata/api_client/models/paged_result_runs_by_leaderboard_result.py +105 -0
  501. rapidata/api_client/models/paged_result_sample_by_identifier.py +105 -0
  502. rapidata/api_client/models/paged_result_sample_by_participant.py +105 -0
  503. rapidata/api_client/models/paged_result_standing_by_leaderboard.py +105 -0
  504. rapidata/api_client/models/paged_result_validation_set_model.py +105 -0
  505. rapidata/api_client/models/participant_by_benchmark.py +3 -5
  506. rapidata/api_client/models/participant_status.py +2 -2
  507. rapidata/api_client/models/polygon_result.py +3 -3
  508. rapidata/api_client/models/polygon_result_coordinate.py +89 -0
  509. rapidata/api_client/models/polygon_result_shape.py +95 -0
  510. rapidata/api_client/models/preliminary_download_model.py +5 -5
  511. rapidata/api_client/models/preview_order_model.py +5 -5
  512. rapidata/api_client/models/problem_details.py +2 -20
  513. rapidata/api_client/models/prompt_asset_metadata_input.py +4 -6
  514. rapidata/api_client/models/prompt_asset_metadata_input_asset.py +25 -41
  515. rapidata/api_client/models/prompt_by_benchmark_result.py +5 -5
  516. rapidata/api_client/models/prompt_metadata_input.py +5 -7
  517. rapidata/api_client/models/proxy_file_wrapper.py +17 -2
  518. rapidata/api_client/models/public_order_model.py +2 -2
  519. rapidata/api_client/models/query_audiences_result.py +118 -0
  520. rapidata/api_client/models/query_datapoints_by_dataset_id_result.py +95 -0
  521. rapidata/api_client/models/query_job_definitions_result.py +97 -0
  522. rapidata/api_client/models/query_job_revisions_result.py +95 -0
  523. rapidata/api_client/models/query_jobs_result.py +103 -0
  524. rapidata/api_client/models/query_model.py +10 -5
  525. rapidata/api_client/models/query_rapids_for_audience_result.py +150 -0
  526. rapidata/api_client/models/query_validation_rapid_eligibility_model_query_validation_model.py +107 -0
  527. rapidata/api_client/models/query_validation_rapid_eligibility_result.py +103 -0
  528. rapidata/api_client/models/query_validation_rapid_eligibility_result_truth.py +280 -0
  529. rapidata/api_client/models/rapid_issue.py +2 -2
  530. rapidata/api_client/models/rapid_model.py +30 -40
  531. rapidata/api_client/models/rapid_result_model.py +7 -7
  532. rapidata/api_client/models/rapid_skipped_model.py +5 -5
  533. rapidata/api_client/models/rapid_state.py +2 -2
  534. rapidata/api_client/models/read_bridge_token_keys_result.py +10 -24
  535. rapidata/api_client/models/reference_asset_input.py +100 -0
  536. rapidata/api_client/models/report_model.py +7 -7
  537. rapidata/api_client/models/retrieval_mode.py +2 -2
  538. rapidata/api_client/models/root_filter.py +2 -2
  539. rapidata/api_client/models/run_status.py +2 -2
  540. rapidata/api_client/models/runs_by_leaderboard_result.py +3 -3
  541. rapidata/api_client/models/sample_by_identifier.py +7 -8
  542. rapidata/api_client/models/sample_by_participant.py +7 -8
  543. rapidata/api_client/models/scrub_range.py +2 -2
  544. rapidata/api_client/models/send_survey_model.py +87 -0
  545. rapidata/api_client/models/simple_workflow_config.py +3 -3
  546. rapidata/api_client/models/simple_workflow_model.py +2 -2
  547. rapidata/api_client/models/simple_workflow_model1.py +4 -11
  548. rapidata/api_client/models/simple_workflow_model_blueprint.py +1 -1
  549. rapidata/api_client/models/sort_criterion.py +2 -2
  550. rapidata/api_client/models/sort_direction.py +2 -2
  551. rapidata/api_client/models/standing_by_benchmark.py +113 -0
  552. rapidata/api_client/models/standing_by_leaderboard.py +16 -12
  553. rapidata/api_client/models/standing_status.py +2 -2
  554. rapidata/api_client/models/standings_by_benchmark_result.py +95 -0
  555. rapidata/api_client/models/standings_by_leaderboard_result.py +2 -2
  556. rapidata/api_client/models/start_preliminary_download_result.py +87 -0
  557. rapidata/api_client/models/sticky_state.py +3 -2
  558. rapidata/api_client/models/stream_file_wrapper.py +25 -3
  559. rapidata/api_client/models/string_segment.py +105 -0
  560. rapidata/api_client/models/submit_order_model.py +5 -5
  561. rapidata/api_client/models/submit_participant_result.py +2 -2
  562. rapidata/api_client/models/submit_prompt_model.py +9 -14
  563. rapidata/api_client/models/submit_prompt_model_prompt_asset.py +40 -12
  564. rapidata/api_client/models/tags_by_benchmark_result.py +2 -2
  565. rapidata/api_client/models/text_asset.py +3 -5
  566. rapidata/api_client/models/text_asset_input.py +21 -1
  567. rapidata/api_client/models/text_metadata.py +6 -1
  568. rapidata/api_client/models/text_metadata_input.py +111 -0
  569. rapidata/api_client/models/text_metadata_model.py +7 -2
  570. rapidata/api_client/models/transcription_metadata_input.py +5 -7
  571. rapidata/api_client/models/transcription_word.py +2 -2
  572. rapidata/api_client/models/translated_string.py +2 -2
  573. rapidata/api_client/models/unlock_order_result.py +2 -2
  574. rapidata/api_client/models/update_audience_request.py +113 -0
  575. rapidata/api_client/models/update_benchmark_model.py +99 -0
  576. rapidata/api_client/models/update_benchmark_name_model.py +5 -5
  577. rapidata/api_client/models/update_campaign_model.py +11 -11
  578. rapidata/api_client/models/update_dataset_name_model.py +5 -5
  579. rapidata/api_client/models/update_dimensions_model.py +3 -3
  580. rapidata/api_client/models/update_job_definition_endpoint_input.py +92 -0
  581. rapidata/api_client/models/update_leaderboard_model.py +18 -3
  582. rapidata/api_client/models/update_leaderboard_name_model.py +5 -5
  583. rapidata/api_client/models/update_leaderboard_response_config_model.py +5 -5
  584. rapidata/api_client/models/update_order_name_model.py +5 -5
  585. rapidata/api_client/models/update_participant_model.py +92 -0
  586. rapidata/api_client/models/update_participant_name_model.py +5 -5
  587. rapidata/api_client/models/update_priority_model.py +87 -0
  588. rapidata/api_client/models/update_prompt_tags_model.py +5 -5
  589. rapidata/api_client/models/update_should_alert_model.py +4 -4
  590. rapidata/api_client/models/update_validation_rapid_model.py +35 -14
  591. rapidata/api_client/models/update_validation_rapid_model_context_asset.py +160 -0
  592. rapidata/api_client/models/update_validation_set_model.py +120 -0
  593. rapidata/api_client/models/upload_asset_result.py +102 -0
  594. rapidata/api_client/models/upload_file_from_url_result.py +87 -0
  595. rapidata/api_client/models/upload_file_result.py +87 -0
  596. rapidata/api_client/models/user_action_restriction.py +37 -0
  597. rapidata/api_client/models/user_action_restriction_filter.py +101 -0
  598. rapidata/api_client/models/validation_chance.py +20 -3
  599. rapidata/api_client/models/validation_problem_details.py +117 -0
  600. rapidata/api_client/models/validation_set_model.py +11 -16
  601. rapidata/api_client/models/validation_set_overview_model.py +2 -2
  602. rapidata/api_client/models/workflow_config_artifact_model_workflow_config.py +23 -9
  603. rapidata/api_client/models/workflow_state.py +2 -2
  604. rapidata/api_client/models/zip_entry_file_wrapper.py +33 -2
  605. rapidata/api_client/rest.py +2 -2
  606. rapidata/api_client_README.md +371 -326
  607. rapidata/rapidata_client/__init__.py +14 -11
  608. rapidata/rapidata_client/api/{rapidata_exception.py → rapidata_api_client.py} +119 -2
  609. rapidata/rapidata_client/audience/__init__.py +2 -0
  610. rapidata/rapidata_client/audience/audience_example_handler.py +168 -0
  611. rapidata/rapidata_client/audience/rapidata_audience.py +287 -0
  612. rapidata/rapidata_client/audience/rapidata_audience_manager.py +162 -0
  613. rapidata/rapidata_client/benchmark/_detail_mapper.py +11 -9
  614. rapidata/rapidata_client/benchmark/leaderboard/rapidata_leaderboard.py +98 -54
  615. rapidata/rapidata_client/benchmark/participant/_participant.py +57 -32
  616. rapidata/rapidata_client/benchmark/rapidata_benchmark.py +384 -246
  617. rapidata/rapidata_client/benchmark/rapidata_benchmark_manager.py +137 -81
  618. rapidata/rapidata_client/config/__init__.py +3 -0
  619. rapidata/rapidata_client/config/logger.py +135 -0
  620. rapidata/rapidata_client/config/logging_config.py +55 -0
  621. rapidata/rapidata_client/config/managed_print.py +6 -0
  622. rapidata/rapidata_client/config/order_config.py +14 -0
  623. rapidata/rapidata_client/config/rapidata_config.py +15 -10
  624. rapidata/rapidata_client/config/tracer.py +184 -0
  625. rapidata/rapidata_client/config/upload_config.py +64 -0
  626. rapidata/rapidata_client/datapoints/__init__.py +0 -3
  627. rapidata/rapidata_client/datapoints/_asset_uploader.py +184 -0
  628. rapidata/rapidata_client/datapoints/_datapoint.py +72 -176
  629. rapidata/rapidata_client/datapoints/_datapoint_uploader.py +47 -0
  630. rapidata/rapidata_client/datapoints/_datapoints_validator.py +70 -0
  631. rapidata/rapidata_client/datapoints/assets/__init__.py +0 -10
  632. rapidata/rapidata_client/datapoints/metadata/__init__.py +0 -2
  633. rapidata/rapidata_client/datapoints/metadata/_private_text_metadata.py +5 -6
  634. rapidata/rapidata_client/datapoints/metadata/_prompt_identifier_metadata.py +4 -5
  635. rapidata/rapidata_client/datapoints/metadata/_public_text_metadata.py +5 -6
  636. rapidata/rapidata_client/datapoints/metadata/_select_words_metadata.py +3 -4
  637. rapidata/rapidata_client/dataset/__init__.py +1 -0
  638. rapidata/rapidata_client/dataset/_rapidata_dataset.py +55 -0
  639. rapidata/rapidata_client/demographic/demographic_manager.py +44 -19
  640. rapidata/rapidata_client/exceptions/failed_upload_exception.py +10 -65
  641. rapidata/rapidata_client/filter/_backend_filter_mapper.py +134 -0
  642. rapidata/rapidata_client/filter/_base_filter.py +13 -8
  643. rapidata/rapidata_client/filter/age_filter.py +26 -10
  644. rapidata/rapidata_client/filter/and_filter.py +36 -11
  645. rapidata/rapidata_client/filter/campaign_filter.py +21 -10
  646. rapidata/rapidata_client/filter/country_filter.py +46 -12
  647. rapidata/rapidata_client/filter/custom_filter.py +25 -12
  648. rapidata/rapidata_client/filter/gender_filter.py +25 -10
  649. rapidata/rapidata_client/filter/language_filter.py +51 -21
  650. rapidata/rapidata_client/filter/models/age_group.py +14 -12
  651. rapidata/rapidata_client/filter/models/gender.py +12 -8
  652. rapidata/rapidata_client/filter/new_user_filter.py +14 -4
  653. rapidata/rapidata_client/filter/not_filter.py +35 -11
  654. rapidata/rapidata_client/filter/or_filter.py +36 -11
  655. rapidata/rapidata_client/filter/rapidata_filters.py +17 -23
  656. rapidata/rapidata_client/filter/response_count_filter.py +40 -14
  657. rapidata/rapidata_client/filter/user_score_filter.py +62 -24
  658. rapidata/rapidata_client/job/__init__.py +3 -0
  659. rapidata/rapidata_client/job/job_definition.py +110 -0
  660. rapidata/rapidata_client/job/job_manager.py +758 -0
  661. rapidata/rapidata_client/job/rapidata_job.py +326 -0
  662. rapidata/rapidata_client/order/__init__.py +2 -0
  663. rapidata/rapidata_client/order/_rapidata_order_builder.py +236 -196
  664. rapidata/rapidata_client/order/rapidata_order.py +271 -176
  665. rapidata/rapidata_client/order/rapidata_order_manager.py +520 -364
  666. rapidata/rapidata_client/rapidata_client.py +96 -29
  667. rapidata/rapidata_client/referee/__init__.py +1 -1
  668. rapidata/rapidata_client/referee/_base_referee.py +14 -3
  669. rapidata/rapidata_client/referee/_early_stopping_referee.py +32 -17
  670. rapidata/rapidata_client/referee/_naive_referee.py +24 -3
  671. rapidata/rapidata_client/results/__init__.py +3 -0
  672. rapidata/rapidata_client/{order → results}/rapidata_results.py +86 -63
  673. rapidata/rapidata_client/selection/_base_selection.py +9 -2
  674. rapidata/rapidata_client/selection/ab_test_selection.py +28 -20
  675. rapidata/rapidata_client/selection/capped_selection.py +23 -16
  676. rapidata/rapidata_client/selection/conditional_validation_selection.py +43 -24
  677. rapidata/rapidata_client/selection/demographic_selection.py +21 -6
  678. rapidata/rapidata_client/selection/effort_selection.py +20 -8
  679. rapidata/rapidata_client/selection/labeling_selection.py +21 -10
  680. rapidata/rapidata_client/selection/rapidata_selections.py +23 -14
  681. rapidata/rapidata_client/selection/shuffling_selection.py +21 -13
  682. rapidata/rapidata_client/selection/static_selection.py +19 -8
  683. rapidata/rapidata_client/selection/validation_selection.py +20 -4
  684. rapidata/rapidata_client/settings/__init__.py +2 -0
  685. rapidata/rapidata_client/settings/_rapidata_setting.py +22 -3
  686. rapidata/rapidata_client/settings/alert_on_fast_response.py +8 -5
  687. rapidata/rapidata_client/settings/allow_neither_both.py +3 -0
  688. rapidata/rapidata_client/settings/custom_setting.py +3 -2
  689. rapidata/rapidata_client/settings/free_text_minimum_characters.py +9 -4
  690. rapidata/rapidata_client/settings/models/translation_behaviour_options.py +3 -2
  691. rapidata/rapidata_client/settings/mute_video.py +15 -0
  692. rapidata/rapidata_client/settings/no_shuffle.py +4 -2
  693. rapidata/rapidata_client/settings/play_video_until_the_end.py +7 -4
  694. rapidata/rapidata_client/settings/rapidata_settings.py +22 -9
  695. rapidata/rapidata_client/settings/swap_context_instruction.py +20 -0
  696. rapidata/rapidata_client/settings/translation_behaviour.py +7 -5
  697. rapidata/rapidata_client/utils/__init__.py +3 -0
  698. rapidata/rapidata_client/utils/threaded_uploader.py +153 -0
  699. rapidata/rapidata_client/validation/__init__.py +2 -0
  700. rapidata/rapidata_client/validation/rapidata_validation_set.py +68 -21
  701. rapidata/rapidata_client/validation/rapids/__init__.py +2 -0
  702. rapidata/rapidata_client/validation/rapids/_validation_rapid_uploader.py +48 -0
  703. rapidata/rapidata_client/validation/rapids/box.py +37 -12
  704. rapidata/rapidata_client/validation/rapids/rapids.py +28 -109
  705. rapidata/rapidata_client/validation/rapids/rapids_manager.py +369 -211
  706. rapidata/rapidata_client/validation/validation_set_manager.py +417 -294
  707. rapidata/rapidata_client/workflow/__init__.py +2 -2
  708. rapidata/rapidata_client/workflow/_base_workflow.py +17 -26
  709. rapidata/rapidata_client/workflow/_classify_workflow.py +44 -17
  710. rapidata/rapidata_client/workflow/_compare_workflow.py +33 -14
  711. rapidata/rapidata_client/workflow/_draw_workflow.py +35 -13
  712. rapidata/rapidata_client/workflow/_evaluation_workflow.py +20 -6
  713. rapidata/rapidata_client/workflow/_free_text_workflow.py +34 -15
  714. rapidata/rapidata_client/workflow/_locate_workflow.py +35 -13
  715. rapidata/rapidata_client/workflow/_multi_ranking_workflow.py +90 -0
  716. rapidata/rapidata_client/workflow/_select_words_workflow.py +38 -32
  717. rapidata/rapidata_client/workflow/_timestamp_workflow.py +35 -13
  718. rapidata/service/__init__.py +0 -1
  719. rapidata/service/credential_manager.py +1 -1
  720. rapidata/service/openapi_service.py +99 -23
  721. rapidata/types/__init__.py +149 -0
  722. rapidata-3.0.0a8.dist-info/METADATA +32 -0
  723. rapidata-3.0.0a8.dist-info/RECORD +1083 -0
  724. {rapidata-2.37.0.dist-info → rapidata-3.0.0a8.dist-info}/WHEEL +1 -1
  725. rapidata/rapidata_client/country_codes/__init__.py +0 -1
  726. rapidata/rapidata_client/country_codes/country_codes.py +0 -19
  727. rapidata/rapidata_client/datapoints/assets/_base_asset.py +0 -11
  728. rapidata/rapidata_client/datapoints/assets/_media_asset.py +0 -318
  729. rapidata/rapidata_client/datapoints/assets/_multi_asset.py +0 -61
  730. rapidata/rapidata_client/datapoints/assets/_sessions.py +0 -40
  731. rapidata/rapidata_client/datapoints/assets/_text_asset.py +0 -34
  732. rapidata/rapidata_client/datapoints/assets/data_type_enum.py +0 -8
  733. rapidata/rapidata_client/datapoints/metadata/_media_asset_metadata.py +0 -22
  734. rapidata/rapidata_client/datapoints/metadata/_prompt_metadata.py +0 -18
  735. rapidata/rapidata_client/logging/__init__.py +0 -2
  736. rapidata/rapidata_client/logging/logger.py +0 -122
  737. rapidata/rapidata_client/logging/output_manager.py +0 -20
  738. rapidata/rapidata_client/order/_rapidata_dataset.py +0 -447
  739. rapidata/rapidata_client/workflow/_ranking_workflow.py +0 -71
  740. rapidata/service/local_file_service.py +0 -25
  741. rapidata-2.37.0.dist-info/METADATA +0 -35
  742. rapidata-2.37.0.dist-info/RECORD +0 -687
  743. {rapidata-2.37.0.dist-info → rapidata-3.0.0a8.dist-info/licenses}/LICENSE +0 -0
@@ -1,9 +1,9 @@
1
1
  # coding: utf-8
2
2
 
3
3
  """
4
- Rapidata.Dataset
4
+ Rapidata Asset API
5
5
 
6
- No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ The API for the Rapidata Asset service
7
7
 
8
8
  The version of the OpenAPI document: v1
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
@@ -20,19 +20,15 @@ from pydantic import Field, StrictBool, StrictBytes, StrictStr, field_validator
20
20
  from typing import List, Optional, Tuple, Union
21
21
  from typing_extensions import Annotated
22
22
  from rapidata.api_client.models.add_validation_rapid_model import AddValidationRapidModel
23
- from rapidata.api_client.models.add_validation_rapid_result import AddValidationRapidResult
24
23
  from rapidata.api_client.models.create_empty_validation_set_result import CreateEmptyValidationSetResult
25
24
  from rapidata.api_client.models.create_validation_set_model import CreateValidationSetModel
26
25
  from rapidata.api_client.models.get_available_validation_sets_result import GetAvailableValidationSetsResult
27
26
  from rapidata.api_client.models.get_recommended_validation_set_result import GetRecommendedValidationSetResult
28
- from rapidata.api_client.models.get_validation_rapids_result_paged_result import GetValidationRapidsResultPagedResult
29
27
  from rapidata.api_client.models.get_validation_set_by_id_result import GetValidationSetByIdResult
30
- from rapidata.api_client.models.import_validation_set_from_file_result import ImportValidationSetFromFileResult
28
+ from rapidata.api_client.models.paged_result_of_get_validation_rapids_result import PagedResultOfGetValidationRapidsResult
29
+ from rapidata.api_client.models.paged_result_of_validation_set_model import PagedResultOfValidationSetModel
31
30
  from rapidata.api_client.models.query_model import QueryModel
32
- from rapidata.api_client.models.update_dimensions_model import UpdateDimensionsModel
33
- from rapidata.api_client.models.update_should_alert_model import UpdateShouldAlertModel
34
- from rapidata.api_client.models.validation_set_model_paged_result import ValidationSetModelPagedResult
35
- from rapidata.api_client.models.validation_set_zip_post_request_blueprint import ValidationSetZipPostRequestBlueprint
31
+ from rapidata.api_client.models.update_validation_set_model import UpdateValidationSetModel
36
32
 
37
33
  from rapidata.api_client.api_client import ApiClient, RequestSerialized
38
34
  from rapidata.api_client.api_response import ApiResponse
@@ -55,7 +51,7 @@ class ValidationSetApi:
55
51
  @validate_call
56
52
  def validation_set_post(
57
53
  self,
58
- create_validation_set_model: Annotated[Optional[CreateValidationSetModel], Field(description="The body request for creating a new validation set.")] = None,
54
+ create_validation_set_model: Annotated[CreateValidationSetModel, Field(description="The body request for creating a new validation set.")],
59
55
  _request_timeout: Union[
60
56
  None,
61
57
  Annotated[StrictFloat, Field(gt=0)],
@@ -72,7 +68,7 @@ class ValidationSetApi:
72
68
  """Creates a new empty validation set.
73
69
 
74
70
 
75
- :param create_validation_set_model: The body request for creating a new validation set.
71
+ :param create_validation_set_model: The body request for creating a new validation set. (required)
76
72
  :type create_validation_set_model: CreateValidationSetModel
77
73
  :param _request_timeout: timeout setting for this request. If one
78
74
  number provided, it will be total request
@@ -121,7 +117,7 @@ class ValidationSetApi:
121
117
  @validate_call
122
118
  def validation_set_post_with_http_info(
123
119
  self,
124
- create_validation_set_model: Annotated[Optional[CreateValidationSetModel], Field(description="The body request for creating a new validation set.")] = None,
120
+ create_validation_set_model: Annotated[CreateValidationSetModel, Field(description="The body request for creating a new validation set.")],
125
121
  _request_timeout: Union[
126
122
  None,
127
123
  Annotated[StrictFloat, Field(gt=0)],
@@ -138,7 +134,7 @@ class ValidationSetApi:
138
134
  """Creates a new empty validation set.
139
135
 
140
136
 
141
- :param create_validation_set_model: The body request for creating a new validation set.
137
+ :param create_validation_set_model: The body request for creating a new validation set. (required)
142
138
  :type create_validation_set_model: CreateValidationSetModel
143
139
  :param _request_timeout: timeout setting for this request. If one
144
140
  number provided, it will be total request
@@ -187,7 +183,7 @@ class ValidationSetApi:
187
183
  @validate_call
188
184
  def validation_set_post_without_preload_content(
189
185
  self,
190
- create_validation_set_model: Annotated[Optional[CreateValidationSetModel], Field(description="The body request for creating a new validation set.")] = None,
186
+ create_validation_set_model: Annotated[CreateValidationSetModel, Field(description="The body request for creating a new validation set.")],
191
187
  _request_timeout: Union[
192
188
  None,
193
189
  Annotated[StrictFloat, Field(gt=0)],
@@ -204,7 +200,7 @@ class ValidationSetApi:
204
200
  """Creates a new empty validation set.
205
201
 
206
202
 
207
- :param create_validation_set_model: The body request for creating a new validation set.
203
+ :param create_validation_set_model: The body request for creating a new validation set. (required)
208
204
  :type create_validation_set_model: CreateValidationSetModel
209
205
  :param _request_timeout: timeout setting for this request. If one
210
206
  number provided, it will be total request
@@ -306,8 +302,9 @@ class ValidationSetApi:
306
302
 
307
303
  # authentication setting
308
304
  _auth_settings: List[str] = [
309
- 'bearer',
310
- 'oauth2'
305
+ 'OAuth2',
306
+ 'OpenIdConnect',
307
+ 'Bearer'
311
308
  ]
312
309
 
313
310
  return self.api_client.param_serialize(
@@ -331,10 +328,10 @@ class ValidationSetApi:
331
328
  @validate_call
332
329
  def validation_set_recommended_get(
333
330
  self,
334
- asset_type: Annotated[Optional[List[StrictStr]], Field(description="The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.")] = None,
335
- modality: Annotated[Optional[List[StrictStr]], Field(description="The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.")] = None,
336
- prompt_type: Annotated[Optional[List[StrictStr]], Field(description="The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.")] = None,
337
- instruction: Annotated[Optional[StrictStr], Field(description="An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.")] = None,
331
+ asset_type: Optional[List[StrictStr]] = None,
332
+ modality: Optional[List[StrictStr]] = None,
333
+ prompt_type: Optional[List[StrictStr]] = None,
334
+ instruction: Optional[StrictStr] = None,
338
335
  _request_timeout: Union[
339
336
  None,
340
337
  Annotated[StrictFloat, Field(gt=0)],
@@ -348,17 +345,16 @@ class ValidationSetApi:
348
345
  _headers: Optional[Dict[StrictStr, Any]] = None,
349
346
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
350
347
  ) -> GetRecommendedValidationSetResult:
351
- """Gets a validation set that is available to the user and best matches the provided parameters.
348
+ """validation_set_recommended_get
352
349
 
353
- This is not a hard filter, instead it is used to find validation sets that have similar characteristics to the provided instruction.
354
350
 
355
- :param asset_type: The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.
351
+ :param asset_type:
356
352
  :type asset_type: List[str]
357
- :param modality: The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.
353
+ :param modality:
358
354
  :type modality: List[str]
359
- :param prompt_type: The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.
355
+ :param prompt_type:
360
356
  :type prompt_type: List[str]
361
- :param instruction: An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.
357
+ :param instruction:
362
358
  :type instruction: str
363
359
  :param _request_timeout: timeout setting for this request. If one
364
360
  number provided, it will be total request
@@ -411,10 +407,10 @@ class ValidationSetApi:
411
407
  @validate_call
412
408
  def validation_set_recommended_get_with_http_info(
413
409
  self,
414
- asset_type: Annotated[Optional[List[StrictStr]], Field(description="The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.")] = None,
415
- modality: Annotated[Optional[List[StrictStr]], Field(description="The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.")] = None,
416
- prompt_type: Annotated[Optional[List[StrictStr]], Field(description="The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.")] = None,
417
- instruction: Annotated[Optional[StrictStr], Field(description="An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.")] = None,
410
+ asset_type: Optional[List[StrictStr]] = None,
411
+ modality: Optional[List[StrictStr]] = None,
412
+ prompt_type: Optional[List[StrictStr]] = None,
413
+ instruction: Optional[StrictStr] = None,
418
414
  _request_timeout: Union[
419
415
  None,
420
416
  Annotated[StrictFloat, Field(gt=0)],
@@ -428,17 +424,16 @@ class ValidationSetApi:
428
424
  _headers: Optional[Dict[StrictStr, Any]] = None,
429
425
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
430
426
  ) -> ApiResponse[GetRecommendedValidationSetResult]:
431
- """Gets a validation set that is available to the user and best matches the provided parameters.
427
+ """validation_set_recommended_get
432
428
 
433
- This is not a hard filter, instead it is used to find validation sets that have similar characteristics to the provided instruction.
434
429
 
435
- :param asset_type: The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.
430
+ :param asset_type:
436
431
  :type asset_type: List[str]
437
- :param modality: The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.
432
+ :param modality:
438
433
  :type modality: List[str]
439
- :param prompt_type: The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.
434
+ :param prompt_type:
440
435
  :type prompt_type: List[str]
441
- :param instruction: An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.
436
+ :param instruction:
442
437
  :type instruction: str
443
438
  :param _request_timeout: timeout setting for this request. If one
444
439
  number provided, it will be total request
@@ -491,10 +486,10 @@ class ValidationSetApi:
491
486
  @validate_call
492
487
  def validation_set_recommended_get_without_preload_content(
493
488
  self,
494
- asset_type: Annotated[Optional[List[StrictStr]], Field(description="The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.")] = None,
495
- modality: Annotated[Optional[List[StrictStr]], Field(description="The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.")] = None,
496
- prompt_type: Annotated[Optional[List[StrictStr]], Field(description="The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.")] = None,
497
- instruction: Annotated[Optional[StrictStr], Field(description="An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.")] = None,
489
+ asset_type: Optional[List[StrictStr]] = None,
490
+ modality: Optional[List[StrictStr]] = None,
491
+ prompt_type: Optional[List[StrictStr]] = None,
492
+ instruction: Optional[StrictStr] = None,
498
493
  _request_timeout: Union[
499
494
  None,
500
495
  Annotated[StrictFloat, Field(gt=0)],
@@ -508,17 +503,16 @@ class ValidationSetApi:
508
503
  _headers: Optional[Dict[StrictStr, Any]] = None,
509
504
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
510
505
  ) -> RESTResponseType:
511
- """Gets a validation set that is available to the user and best matches the provided parameters.
506
+ """validation_set_recommended_get
512
507
 
513
- This is not a hard filter, instead it is used to find validation sets that have similar characteristics to the provided instruction.
514
508
 
515
- :param asset_type: The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.
509
+ :param asset_type:
516
510
  :type asset_type: List[str]
517
- :param modality: The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.
511
+ :param modality:
518
512
  :type modality: List[str]
519
- :param prompt_type: The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.
513
+ :param prompt_type:
520
514
  :type prompt_type: List[str]
521
- :param instruction: An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.
515
+ :param instruction:
522
516
  :type instruction: str
523
517
  :param _request_timeout: timeout setting for this request. If one
524
518
  number provided, it will be total request
@@ -629,8 +623,9 @@ class ValidationSetApi:
629
623
 
630
624
  # authentication setting
631
625
  _auth_settings: List[str] = [
632
- 'bearer',
633
- 'oauth2'
626
+ 'OAuth2',
627
+ 'OpenIdConnect',
628
+ 'Bearer'
634
629
  ]
635
630
 
636
631
  return self.api_client.param_serialize(
@@ -881,8 +876,9 @@ class ValidationSetApi:
881
876
 
882
877
  # authentication setting
883
878
  _auth_settings: List[str] = [
884
- 'bearer',
885
- 'oauth2'
879
+ 'OAuth2',
880
+ 'OpenIdConnect',
881
+ 'Bearer'
886
882
  ]
887
883
 
888
884
  return self.api_client.param_serialize(
@@ -904,1714 +900,9 @@ class ValidationSetApi:
904
900
 
905
901
 
906
902
  @validate_call
907
- def validation_set_validation_set_id_dimensions_patch(
908
- self,
909
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
910
- update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The body request for updating the dimensions.")] = None,
911
- _request_timeout: Union[
912
- None,
913
- Annotated[StrictFloat, Field(gt=0)],
914
- Tuple[
915
- Annotated[StrictFloat, Field(gt=0)],
916
- Annotated[StrictFloat, Field(gt=0)]
917
- ]
918
- ] = None,
919
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
920
- _content_type: Optional[StrictStr] = None,
921
- _headers: Optional[Dict[StrictStr, Any]] = None,
922
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
923
- ) -> None:
924
- """Updates the dimensions of all rapids within a validation set.
925
-
926
-
927
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
928
- :type validation_set_id: str
929
- :param update_dimensions_model: The body request for updating the dimensions.
930
- :type update_dimensions_model: UpdateDimensionsModel
931
- :param _request_timeout: timeout setting for this request. If one
932
- number provided, it will be total request
933
- timeout. It can also be a pair (tuple) of
934
- (connection, read) timeouts.
935
- :type _request_timeout: int, tuple(int, int), optional
936
- :param _request_auth: set to override the auth_settings for an a single
937
- request; this effectively ignores the
938
- authentication in the spec for a single request.
939
- :type _request_auth: dict, optional
940
- :param _content_type: force content-type for the request.
941
- :type _content_type: str, Optional
942
- :param _headers: set to override the headers for a single
943
- request; this effectively ignores the headers
944
- in the spec for a single request.
945
- :type _headers: dict, optional
946
- :param _host_index: set to override the host_index for a single
947
- request; this effectively ignores the host_index
948
- in the spec for a single request.
949
- :type _host_index: int, optional
950
- :return: Returns the result object.
951
- """ # noqa: E501
952
-
953
- _param = self._validation_set_validation_set_id_dimensions_patch_serialize(
954
- validation_set_id=validation_set_id,
955
- update_dimensions_model=update_dimensions_model,
956
- _request_auth=_request_auth,
957
- _content_type=_content_type,
958
- _headers=_headers,
959
- _host_index=_host_index
960
- )
961
-
962
- _response_types_map: Dict[str, Optional[str]] = {
963
- '204': None,
964
- }
965
- response_data = self.api_client.call_api(
966
- *_param,
967
- _request_timeout=_request_timeout
968
- )
969
- response_data.read()
970
- return self.api_client.response_deserialize(
971
- response_data=response_data,
972
- response_types_map=_response_types_map,
973
- ).data
974
-
975
-
976
- @validate_call
977
- def validation_set_validation_set_id_dimensions_patch_with_http_info(
978
- self,
979
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
980
- update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The body request for updating the dimensions.")] = None,
981
- _request_timeout: Union[
982
- None,
983
- Annotated[StrictFloat, Field(gt=0)],
984
- Tuple[
985
- Annotated[StrictFloat, Field(gt=0)],
986
- Annotated[StrictFloat, Field(gt=0)]
987
- ]
988
- ] = None,
989
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
990
- _content_type: Optional[StrictStr] = None,
991
- _headers: Optional[Dict[StrictStr, Any]] = None,
992
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
993
- ) -> ApiResponse[None]:
994
- """Updates the dimensions of all rapids within a validation set.
995
-
996
-
997
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
998
- :type validation_set_id: str
999
- :param update_dimensions_model: The body request for updating the dimensions.
1000
- :type update_dimensions_model: UpdateDimensionsModel
1001
- :param _request_timeout: timeout setting for this request. If one
1002
- number provided, it will be total request
1003
- timeout. It can also be a pair (tuple) of
1004
- (connection, read) timeouts.
1005
- :type _request_timeout: int, tuple(int, int), optional
1006
- :param _request_auth: set to override the auth_settings for an a single
1007
- request; this effectively ignores the
1008
- authentication in the spec for a single request.
1009
- :type _request_auth: dict, optional
1010
- :param _content_type: force content-type for the request.
1011
- :type _content_type: str, Optional
1012
- :param _headers: set to override the headers for a single
1013
- request; this effectively ignores the headers
1014
- in the spec for a single request.
1015
- :type _headers: dict, optional
1016
- :param _host_index: set to override the host_index for a single
1017
- request; this effectively ignores the host_index
1018
- in the spec for a single request.
1019
- :type _host_index: int, optional
1020
- :return: Returns the result object.
1021
- """ # noqa: E501
1022
-
1023
- _param = self._validation_set_validation_set_id_dimensions_patch_serialize(
1024
- validation_set_id=validation_set_id,
1025
- update_dimensions_model=update_dimensions_model,
1026
- _request_auth=_request_auth,
1027
- _content_type=_content_type,
1028
- _headers=_headers,
1029
- _host_index=_host_index
1030
- )
1031
-
1032
- _response_types_map: Dict[str, Optional[str]] = {
1033
- '204': None,
1034
- }
1035
- response_data = self.api_client.call_api(
1036
- *_param,
1037
- _request_timeout=_request_timeout
1038
- )
1039
- response_data.read()
1040
- return self.api_client.response_deserialize(
1041
- response_data=response_data,
1042
- response_types_map=_response_types_map,
1043
- )
1044
-
1045
-
1046
- @validate_call
1047
- def validation_set_validation_set_id_dimensions_patch_without_preload_content(
1048
- self,
1049
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
1050
- update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The body request for updating the dimensions.")] = None,
1051
- _request_timeout: Union[
1052
- None,
1053
- Annotated[StrictFloat, Field(gt=0)],
1054
- Tuple[
1055
- Annotated[StrictFloat, Field(gt=0)],
1056
- Annotated[StrictFloat, Field(gt=0)]
1057
- ]
1058
- ] = None,
1059
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1060
- _content_type: Optional[StrictStr] = None,
1061
- _headers: Optional[Dict[StrictStr, Any]] = None,
1062
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1063
- ) -> RESTResponseType:
1064
- """Updates the dimensions of all rapids within a validation set.
1065
-
1066
-
1067
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
1068
- :type validation_set_id: str
1069
- :param update_dimensions_model: The body request for updating the dimensions.
1070
- :type update_dimensions_model: UpdateDimensionsModel
1071
- :param _request_timeout: timeout setting for this request. If one
1072
- number provided, it will be total request
1073
- timeout. It can also be a pair (tuple) of
1074
- (connection, read) timeouts.
1075
- :type _request_timeout: int, tuple(int, int), optional
1076
- :param _request_auth: set to override the auth_settings for an a single
1077
- request; this effectively ignores the
1078
- authentication in the spec for a single request.
1079
- :type _request_auth: dict, optional
1080
- :param _content_type: force content-type for the request.
1081
- :type _content_type: str, Optional
1082
- :param _headers: set to override the headers for a single
1083
- request; this effectively ignores the headers
1084
- in the spec for a single request.
1085
- :type _headers: dict, optional
1086
- :param _host_index: set to override the host_index for a single
1087
- request; this effectively ignores the host_index
1088
- in the spec for a single request.
1089
- :type _host_index: int, optional
1090
- :return: Returns the result object.
1091
- """ # noqa: E501
1092
-
1093
- _param = self._validation_set_validation_set_id_dimensions_patch_serialize(
1094
- validation_set_id=validation_set_id,
1095
- update_dimensions_model=update_dimensions_model,
1096
- _request_auth=_request_auth,
1097
- _content_type=_content_type,
1098
- _headers=_headers,
1099
- _host_index=_host_index
1100
- )
1101
-
1102
- _response_types_map: Dict[str, Optional[str]] = {
1103
- '204': None,
1104
- }
1105
- response_data = self.api_client.call_api(
1106
- *_param,
1107
- _request_timeout=_request_timeout
1108
- )
1109
- return response_data.response
1110
-
1111
-
1112
- def _validation_set_validation_set_id_dimensions_patch_serialize(
1113
- self,
1114
- validation_set_id,
1115
- update_dimensions_model,
1116
- _request_auth,
1117
- _content_type,
1118
- _headers,
1119
- _host_index,
1120
- ) -> RequestSerialized:
1121
-
1122
- _host = None
1123
-
1124
- _collection_formats: Dict[str, str] = {
1125
- }
1126
-
1127
- _path_params: Dict[str, str] = {}
1128
- _query_params: List[Tuple[str, str]] = []
1129
- _header_params: Dict[str, Optional[str]] = _headers or {}
1130
- _form_params: List[Tuple[str, str]] = []
1131
- _files: Dict[
1132
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1133
- ] = {}
1134
- _body_params: Optional[bytes] = None
1135
-
1136
- # process the path parameters
1137
- if validation_set_id is not None:
1138
- _path_params['validationSetId'] = validation_set_id
1139
- # process the query parameters
1140
- # process the header parameters
1141
- # process the form parameters
1142
- # process the body parameter
1143
- if update_dimensions_model is not None:
1144
- _body_params = update_dimensions_model
1145
-
1146
-
1147
-
1148
- # set the HTTP header `Content-Type`
1149
- if _content_type:
1150
- _header_params['Content-Type'] = _content_type
1151
- else:
1152
- _default_content_type = (
1153
- self.api_client.select_header_content_type(
1154
- [
1155
- 'application/json',
1156
- 'text/json',
1157
- 'application/*+json'
1158
- ]
1159
- )
1160
- )
1161
- if _default_content_type is not None:
1162
- _header_params['Content-Type'] = _default_content_type
1163
-
1164
- # authentication setting
1165
- _auth_settings: List[str] = [
1166
- 'bearer',
1167
- 'oauth2'
1168
- ]
1169
-
1170
- return self.api_client.param_serialize(
1171
- method='PATCH',
1172
- resource_path='/validation-set/{validationSetId}/dimensions',
1173
- path_params=_path_params,
1174
- query_params=_query_params,
1175
- header_params=_header_params,
1176
- body=_body_params,
1177
- post_params=_form_params,
1178
- files=_files,
1179
- auth_settings=_auth_settings,
1180
- collection_formats=_collection_formats,
1181
- _host=_host,
1182
- _request_auth=_request_auth
1183
- )
1184
-
1185
-
1186
-
1187
-
1188
- @validate_call
1189
- def validation_set_validation_set_id_dimensions_put(
1190
- self,
1191
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
1192
- update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The body request for updating the dimensions.")] = None,
1193
- _request_timeout: Union[
1194
- None,
1195
- Annotated[StrictFloat, Field(gt=0)],
1196
- Tuple[
1197
- Annotated[StrictFloat, Field(gt=0)],
1198
- Annotated[StrictFloat, Field(gt=0)]
1199
- ]
1200
- ] = None,
1201
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1202
- _content_type: Optional[StrictStr] = None,
1203
- _headers: Optional[Dict[StrictStr, Any]] = None,
1204
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1205
- ) -> None:
1206
- """(Deprecated) Updates the dimensions of all rapids within a validation set.
1207
-
1208
-
1209
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
1210
- :type validation_set_id: str
1211
- :param update_dimensions_model: The body request for updating the dimensions.
1212
- :type update_dimensions_model: UpdateDimensionsModel
1213
- :param _request_timeout: timeout setting for this request. If one
1214
- number provided, it will be total request
1215
- timeout. It can also be a pair (tuple) of
1216
- (connection, read) timeouts.
1217
- :type _request_timeout: int, tuple(int, int), optional
1218
- :param _request_auth: set to override the auth_settings for an a single
1219
- request; this effectively ignores the
1220
- authentication in the spec for a single request.
1221
- :type _request_auth: dict, optional
1222
- :param _content_type: force content-type for the request.
1223
- :type _content_type: str, Optional
1224
- :param _headers: set to override the headers for a single
1225
- request; this effectively ignores the headers
1226
- in the spec for a single request.
1227
- :type _headers: dict, optional
1228
- :param _host_index: set to override the host_index for a single
1229
- request; this effectively ignores the host_index
1230
- in the spec for a single request.
1231
- :type _host_index: int, optional
1232
- :return: Returns the result object.
1233
- """ # noqa: E501
1234
- warnings.warn("PUT /validation-set/{validationSetId}/dimensions is deprecated.", DeprecationWarning)
1235
-
1236
- _param = self._validation_set_validation_set_id_dimensions_put_serialize(
1237
- validation_set_id=validation_set_id,
1238
- update_dimensions_model=update_dimensions_model,
1239
- _request_auth=_request_auth,
1240
- _content_type=_content_type,
1241
- _headers=_headers,
1242
- _host_index=_host_index
1243
- )
1244
-
1245
- _response_types_map: Dict[str, Optional[str]] = {
1246
- '204': None,
1247
- }
1248
- response_data = self.api_client.call_api(
1249
- *_param,
1250
- _request_timeout=_request_timeout
1251
- )
1252
- response_data.read()
1253
- return self.api_client.response_deserialize(
1254
- response_data=response_data,
1255
- response_types_map=_response_types_map,
1256
- ).data
1257
-
1258
-
1259
- @validate_call
1260
- def validation_set_validation_set_id_dimensions_put_with_http_info(
1261
- self,
1262
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
1263
- update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The body request for updating the dimensions.")] = None,
1264
- _request_timeout: Union[
1265
- None,
1266
- Annotated[StrictFloat, Field(gt=0)],
1267
- Tuple[
1268
- Annotated[StrictFloat, Field(gt=0)],
1269
- Annotated[StrictFloat, Field(gt=0)]
1270
- ]
1271
- ] = None,
1272
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1273
- _content_type: Optional[StrictStr] = None,
1274
- _headers: Optional[Dict[StrictStr, Any]] = None,
1275
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1276
- ) -> ApiResponse[None]:
1277
- """(Deprecated) Updates the dimensions of all rapids within a validation set.
1278
-
1279
-
1280
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
1281
- :type validation_set_id: str
1282
- :param update_dimensions_model: The body request for updating the dimensions.
1283
- :type update_dimensions_model: UpdateDimensionsModel
1284
- :param _request_timeout: timeout setting for this request. If one
1285
- number provided, it will be total request
1286
- timeout. It can also be a pair (tuple) of
1287
- (connection, read) timeouts.
1288
- :type _request_timeout: int, tuple(int, int), optional
1289
- :param _request_auth: set to override the auth_settings for an a single
1290
- request; this effectively ignores the
1291
- authentication in the spec for a single request.
1292
- :type _request_auth: dict, optional
1293
- :param _content_type: force content-type for the request.
1294
- :type _content_type: str, Optional
1295
- :param _headers: set to override the headers for a single
1296
- request; this effectively ignores the headers
1297
- in the spec for a single request.
1298
- :type _headers: dict, optional
1299
- :param _host_index: set to override the host_index for a single
1300
- request; this effectively ignores the host_index
1301
- in the spec for a single request.
1302
- :type _host_index: int, optional
1303
- :return: Returns the result object.
1304
- """ # noqa: E501
1305
- warnings.warn("PUT /validation-set/{validationSetId}/dimensions is deprecated.", DeprecationWarning)
1306
-
1307
- _param = self._validation_set_validation_set_id_dimensions_put_serialize(
1308
- validation_set_id=validation_set_id,
1309
- update_dimensions_model=update_dimensions_model,
1310
- _request_auth=_request_auth,
1311
- _content_type=_content_type,
1312
- _headers=_headers,
1313
- _host_index=_host_index
1314
- )
1315
-
1316
- _response_types_map: Dict[str, Optional[str]] = {
1317
- '204': None,
1318
- }
1319
- response_data = self.api_client.call_api(
1320
- *_param,
1321
- _request_timeout=_request_timeout
1322
- )
1323
- response_data.read()
1324
- return self.api_client.response_deserialize(
1325
- response_data=response_data,
1326
- response_types_map=_response_types_map,
1327
- )
1328
-
1329
-
1330
- @validate_call
1331
- def validation_set_validation_set_id_dimensions_put_without_preload_content(
1332
- self,
1333
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
1334
- update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The body request for updating the dimensions.")] = None,
1335
- _request_timeout: Union[
1336
- None,
1337
- Annotated[StrictFloat, Field(gt=0)],
1338
- Tuple[
1339
- Annotated[StrictFloat, Field(gt=0)],
1340
- Annotated[StrictFloat, Field(gt=0)]
1341
- ]
1342
- ] = None,
1343
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1344
- _content_type: Optional[StrictStr] = None,
1345
- _headers: Optional[Dict[StrictStr, Any]] = None,
1346
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1347
- ) -> RESTResponseType:
1348
- """(Deprecated) Updates the dimensions of all rapids within a validation set.
1349
-
1350
-
1351
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
1352
- :type validation_set_id: str
1353
- :param update_dimensions_model: The body request for updating the dimensions.
1354
- :type update_dimensions_model: UpdateDimensionsModel
1355
- :param _request_timeout: timeout setting for this request. If one
1356
- number provided, it will be total request
1357
- timeout. It can also be a pair (tuple) of
1358
- (connection, read) timeouts.
1359
- :type _request_timeout: int, tuple(int, int), optional
1360
- :param _request_auth: set to override the auth_settings for an a single
1361
- request; this effectively ignores the
1362
- authentication in the spec for a single request.
1363
- :type _request_auth: dict, optional
1364
- :param _content_type: force content-type for the request.
1365
- :type _content_type: str, Optional
1366
- :param _headers: set to override the headers for a single
1367
- request; this effectively ignores the headers
1368
- in the spec for a single request.
1369
- :type _headers: dict, optional
1370
- :param _host_index: set to override the host_index for a single
1371
- request; this effectively ignores the host_index
1372
- in the spec for a single request.
1373
- :type _host_index: int, optional
1374
- :return: Returns the result object.
1375
- """ # noqa: E501
1376
- warnings.warn("PUT /validation-set/{validationSetId}/dimensions is deprecated.", DeprecationWarning)
1377
-
1378
- _param = self._validation_set_validation_set_id_dimensions_put_serialize(
1379
- validation_set_id=validation_set_id,
1380
- update_dimensions_model=update_dimensions_model,
1381
- _request_auth=_request_auth,
1382
- _content_type=_content_type,
1383
- _headers=_headers,
1384
- _host_index=_host_index
1385
- )
1386
-
1387
- _response_types_map: Dict[str, Optional[str]] = {
1388
- '204': None,
1389
- }
1390
- response_data = self.api_client.call_api(
1391
- *_param,
1392
- _request_timeout=_request_timeout
1393
- )
1394
- return response_data.response
1395
-
1396
-
1397
- def _validation_set_validation_set_id_dimensions_put_serialize(
1398
- self,
1399
- validation_set_id,
1400
- update_dimensions_model,
1401
- _request_auth,
1402
- _content_type,
1403
- _headers,
1404
- _host_index,
1405
- ) -> RequestSerialized:
1406
-
1407
- _host = None
1408
-
1409
- _collection_formats: Dict[str, str] = {
1410
- }
1411
-
1412
- _path_params: Dict[str, str] = {}
1413
- _query_params: List[Tuple[str, str]] = []
1414
- _header_params: Dict[str, Optional[str]] = _headers or {}
1415
- _form_params: List[Tuple[str, str]] = []
1416
- _files: Dict[
1417
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1418
- ] = {}
1419
- _body_params: Optional[bytes] = None
1420
-
1421
- # process the path parameters
1422
- if validation_set_id is not None:
1423
- _path_params['validationSetId'] = validation_set_id
1424
- # process the query parameters
1425
- # process the header parameters
1426
- # process the form parameters
1427
- # process the body parameter
1428
- if update_dimensions_model is not None:
1429
- _body_params = update_dimensions_model
1430
-
1431
-
1432
-
1433
- # set the HTTP header `Content-Type`
1434
- if _content_type:
1435
- _header_params['Content-Type'] = _content_type
1436
- else:
1437
- _default_content_type = (
1438
- self.api_client.select_header_content_type(
1439
- [
1440
- 'application/json',
1441
- 'text/json',
1442
- 'application/*+json'
1443
- ]
1444
- )
1445
- )
1446
- if _default_content_type is not None:
1447
- _header_params['Content-Type'] = _default_content_type
1448
-
1449
- # authentication setting
1450
- _auth_settings: List[str] = [
1451
- 'bearer',
1452
- 'oauth2'
1453
- ]
1454
-
1455
- return self.api_client.param_serialize(
1456
- method='PUT',
1457
- resource_path='/validation-set/{validationSetId}/dimensions',
1458
- path_params=_path_params,
1459
- query_params=_query_params,
1460
- header_params=_header_params,
1461
- body=_body_params,
1462
- post_params=_form_params,
1463
- files=_files,
1464
- auth_settings=_auth_settings,
1465
- collection_formats=_collection_formats,
1466
- _host=_host,
1467
- _request_auth=_request_auth
1468
- )
1469
-
1470
-
1471
-
1472
-
1473
- @validate_call
1474
- def validation_set_validation_set_id_export_get(
1475
- self,
1476
- validation_set_id: StrictStr,
1477
- _request_timeout: Union[
1478
- None,
1479
- Annotated[StrictFloat, Field(gt=0)],
1480
- Tuple[
1481
- Annotated[StrictFloat, Field(gt=0)],
1482
- Annotated[StrictFloat, Field(gt=0)]
1483
- ]
1484
- ] = None,
1485
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1486
- _content_type: Optional[StrictStr] = None,
1487
- _headers: Optional[Dict[StrictStr, Any]] = None,
1488
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1489
- ) -> bytearray:
1490
- """Exports all rapids of a validation-set to a file.
1491
-
1492
-
1493
- :param validation_set_id: (required)
1494
- :type validation_set_id: str
1495
- :param _request_timeout: timeout setting for this request. If one
1496
- number provided, it will be total request
1497
- timeout. It can also be a pair (tuple) of
1498
- (connection, read) timeouts.
1499
- :type _request_timeout: int, tuple(int, int), optional
1500
- :param _request_auth: set to override the auth_settings for an a single
1501
- request; this effectively ignores the
1502
- authentication in the spec for a single request.
1503
- :type _request_auth: dict, optional
1504
- :param _content_type: force content-type for the request.
1505
- :type _content_type: str, Optional
1506
- :param _headers: set to override the headers for a single
1507
- request; this effectively ignores the headers
1508
- in the spec for a single request.
1509
- :type _headers: dict, optional
1510
- :param _host_index: set to override the host_index for a single
1511
- request; this effectively ignores the host_index
1512
- in the spec for a single request.
1513
- :type _host_index: int, optional
1514
- :return: Returns the result object.
1515
- """ # noqa: E501
1516
-
1517
- _param = self._validation_set_validation_set_id_export_get_serialize(
1518
- validation_set_id=validation_set_id,
1519
- _request_auth=_request_auth,
1520
- _content_type=_content_type,
1521
- _headers=_headers,
1522
- _host_index=_host_index
1523
- )
1524
-
1525
- _response_types_map: Dict[str, Optional[str]] = {
1526
- '200': "bytearray",
1527
- }
1528
- response_data = self.api_client.call_api(
1529
- *_param,
1530
- _request_timeout=_request_timeout
1531
- )
1532
- response_data.read()
1533
- return self.api_client.response_deserialize(
1534
- response_data=response_data,
1535
- response_types_map=_response_types_map,
1536
- ).data
1537
-
1538
-
1539
- @validate_call
1540
- def validation_set_validation_set_id_export_get_with_http_info(
1541
- self,
1542
- validation_set_id: StrictStr,
1543
- _request_timeout: Union[
1544
- None,
1545
- Annotated[StrictFloat, Field(gt=0)],
1546
- Tuple[
1547
- Annotated[StrictFloat, Field(gt=0)],
1548
- Annotated[StrictFloat, Field(gt=0)]
1549
- ]
1550
- ] = None,
1551
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1552
- _content_type: Optional[StrictStr] = None,
1553
- _headers: Optional[Dict[StrictStr, Any]] = None,
1554
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1555
- ) -> ApiResponse[bytearray]:
1556
- """Exports all rapids of a validation-set to a file.
1557
-
1558
-
1559
- :param validation_set_id: (required)
1560
- :type validation_set_id: str
1561
- :param _request_timeout: timeout setting for this request. If one
1562
- number provided, it will be total request
1563
- timeout. It can also be a pair (tuple) of
1564
- (connection, read) timeouts.
1565
- :type _request_timeout: int, tuple(int, int), optional
1566
- :param _request_auth: set to override the auth_settings for an a single
1567
- request; this effectively ignores the
1568
- authentication in the spec for a single request.
1569
- :type _request_auth: dict, optional
1570
- :param _content_type: force content-type for the request.
1571
- :type _content_type: str, Optional
1572
- :param _headers: set to override the headers for a single
1573
- request; this effectively ignores the headers
1574
- in the spec for a single request.
1575
- :type _headers: dict, optional
1576
- :param _host_index: set to override the host_index for a single
1577
- request; this effectively ignores the host_index
1578
- in the spec for a single request.
1579
- :type _host_index: int, optional
1580
- :return: Returns the result object.
1581
- """ # noqa: E501
1582
-
1583
- _param = self._validation_set_validation_set_id_export_get_serialize(
1584
- validation_set_id=validation_set_id,
1585
- _request_auth=_request_auth,
1586
- _content_type=_content_type,
1587
- _headers=_headers,
1588
- _host_index=_host_index
1589
- )
1590
-
1591
- _response_types_map: Dict[str, Optional[str]] = {
1592
- '200': "bytearray",
1593
- }
1594
- response_data = self.api_client.call_api(
1595
- *_param,
1596
- _request_timeout=_request_timeout
1597
- )
1598
- response_data.read()
1599
- return self.api_client.response_deserialize(
1600
- response_data=response_data,
1601
- response_types_map=_response_types_map,
1602
- )
1603
-
1604
-
1605
- @validate_call
1606
- def validation_set_validation_set_id_export_get_without_preload_content(
1607
- self,
1608
- validation_set_id: StrictStr,
1609
- _request_timeout: Union[
1610
- None,
1611
- Annotated[StrictFloat, Field(gt=0)],
1612
- Tuple[
1613
- Annotated[StrictFloat, Field(gt=0)],
1614
- Annotated[StrictFloat, Field(gt=0)]
1615
- ]
1616
- ] = None,
1617
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1618
- _content_type: Optional[StrictStr] = None,
1619
- _headers: Optional[Dict[StrictStr, Any]] = None,
1620
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1621
- ) -> RESTResponseType:
1622
- """Exports all rapids of a validation-set to a file.
1623
-
1624
-
1625
- :param validation_set_id: (required)
1626
- :type validation_set_id: str
1627
- :param _request_timeout: timeout setting for this request. If one
1628
- number provided, it will be total request
1629
- timeout. It can also be a pair (tuple) of
1630
- (connection, read) timeouts.
1631
- :type _request_timeout: int, tuple(int, int), optional
1632
- :param _request_auth: set to override the auth_settings for an a single
1633
- request; this effectively ignores the
1634
- authentication in the spec for a single request.
1635
- :type _request_auth: dict, optional
1636
- :param _content_type: force content-type for the request.
1637
- :type _content_type: str, Optional
1638
- :param _headers: set to override the headers for a single
1639
- request; this effectively ignores the headers
1640
- in the spec for a single request.
1641
- :type _headers: dict, optional
1642
- :param _host_index: set to override the host_index for a single
1643
- request; this effectively ignores the host_index
1644
- in the spec for a single request.
1645
- :type _host_index: int, optional
1646
- :return: Returns the result object.
1647
- """ # noqa: E501
1648
-
1649
- _param = self._validation_set_validation_set_id_export_get_serialize(
1650
- validation_set_id=validation_set_id,
1651
- _request_auth=_request_auth,
1652
- _content_type=_content_type,
1653
- _headers=_headers,
1654
- _host_index=_host_index
1655
- )
1656
-
1657
- _response_types_map: Dict[str, Optional[str]] = {
1658
- '200': "bytearray",
1659
- }
1660
- response_data = self.api_client.call_api(
1661
- *_param,
1662
- _request_timeout=_request_timeout
1663
- )
1664
- return response_data.response
1665
-
1666
-
1667
- def _validation_set_validation_set_id_export_get_serialize(
1668
- self,
1669
- validation_set_id,
1670
- _request_auth,
1671
- _content_type,
1672
- _headers,
1673
- _host_index,
1674
- ) -> RequestSerialized:
1675
-
1676
- _host = None
1677
-
1678
- _collection_formats: Dict[str, str] = {
1679
- }
1680
-
1681
- _path_params: Dict[str, str] = {}
1682
- _query_params: List[Tuple[str, str]] = []
1683
- _header_params: Dict[str, Optional[str]] = _headers or {}
1684
- _form_params: List[Tuple[str, str]] = []
1685
- _files: Dict[
1686
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1687
- ] = {}
1688
- _body_params: Optional[bytes] = None
1689
-
1690
- # process the path parameters
1691
- if validation_set_id is not None:
1692
- _path_params['validationSetId'] = validation_set_id
1693
- # process the query parameters
1694
- # process the header parameters
1695
- # process the form parameters
1696
- # process the body parameter
1697
-
1698
-
1699
- # set the HTTP header `Accept`
1700
- if 'Accept' not in _header_params:
1701
- _header_params['Accept'] = self.api_client.select_header_accept(
1702
- [
1703
- 'text/plain',
1704
- 'application/json',
1705
- 'text/json'
1706
- ]
1707
- )
1708
-
1709
-
1710
- # authentication setting
1711
- _auth_settings: List[str] = [
1712
- 'bearer',
1713
- 'oauth2'
1714
- ]
1715
-
1716
- return self.api_client.param_serialize(
1717
- method='GET',
1718
- resource_path='/validation-set/{validationSetId}/export',
1719
- path_params=_path_params,
1720
- query_params=_query_params,
1721
- header_params=_header_params,
1722
- body=_body_params,
1723
- post_params=_form_params,
1724
- files=_files,
1725
- auth_settings=_auth_settings,
1726
- collection_formats=_collection_formats,
1727
- _host=_host,
1728
- _request_auth=_request_auth
1729
- )
1730
-
1731
-
1732
-
1733
-
1734
- @validate_call
1735
- def validation_set_validation_set_id_get(
1736
- self,
1737
- validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to get.")],
1738
- _request_timeout: Union[
1739
- None,
1740
- Annotated[StrictFloat, Field(gt=0)],
1741
- Tuple[
1742
- Annotated[StrictFloat, Field(gt=0)],
1743
- Annotated[StrictFloat, Field(gt=0)]
1744
- ]
1745
- ] = None,
1746
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1747
- _content_type: Optional[StrictStr] = None,
1748
- _headers: Optional[Dict[StrictStr, Any]] = None,
1749
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1750
- ) -> GetValidationSetByIdResult:
1751
- """Gets a validation set by the id.
1752
-
1753
-
1754
- :param validation_set_id: The id of the validation set to get. (required)
1755
- :type validation_set_id: str
1756
- :param _request_timeout: timeout setting for this request. If one
1757
- number provided, it will be total request
1758
- timeout. It can also be a pair (tuple) of
1759
- (connection, read) timeouts.
1760
- :type _request_timeout: int, tuple(int, int), optional
1761
- :param _request_auth: set to override the auth_settings for an a single
1762
- request; this effectively ignores the
1763
- authentication in the spec for a single request.
1764
- :type _request_auth: dict, optional
1765
- :param _content_type: force content-type for the request.
1766
- :type _content_type: str, Optional
1767
- :param _headers: set to override the headers for a single
1768
- request; this effectively ignores the headers
1769
- in the spec for a single request.
1770
- :type _headers: dict, optional
1771
- :param _host_index: set to override the host_index for a single
1772
- request; this effectively ignores the host_index
1773
- in the spec for a single request.
1774
- :type _host_index: int, optional
1775
- :return: Returns the result object.
1776
- """ # noqa: E501
1777
-
1778
- _param = self._validation_set_validation_set_id_get_serialize(
1779
- validation_set_id=validation_set_id,
1780
- _request_auth=_request_auth,
1781
- _content_type=_content_type,
1782
- _headers=_headers,
1783
- _host_index=_host_index
1784
- )
1785
-
1786
- _response_types_map: Dict[str, Optional[str]] = {
1787
- '200': "GetValidationSetByIdResult",
1788
- }
1789
- response_data = self.api_client.call_api(
1790
- *_param,
1791
- _request_timeout=_request_timeout
1792
- )
1793
- response_data.read()
1794
- return self.api_client.response_deserialize(
1795
- response_data=response_data,
1796
- response_types_map=_response_types_map,
1797
- ).data
1798
-
1799
-
1800
- @validate_call
1801
- def validation_set_validation_set_id_get_with_http_info(
1802
- self,
1803
- validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to get.")],
1804
- _request_timeout: Union[
1805
- None,
1806
- Annotated[StrictFloat, Field(gt=0)],
1807
- Tuple[
1808
- Annotated[StrictFloat, Field(gt=0)],
1809
- Annotated[StrictFloat, Field(gt=0)]
1810
- ]
1811
- ] = None,
1812
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1813
- _content_type: Optional[StrictStr] = None,
1814
- _headers: Optional[Dict[StrictStr, Any]] = None,
1815
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1816
- ) -> ApiResponse[GetValidationSetByIdResult]:
1817
- """Gets a validation set by the id.
1818
-
1819
-
1820
- :param validation_set_id: The id of the validation set to get. (required)
1821
- :type validation_set_id: str
1822
- :param _request_timeout: timeout setting for this request. If one
1823
- number provided, it will be total request
1824
- timeout. It can also be a pair (tuple) of
1825
- (connection, read) timeouts.
1826
- :type _request_timeout: int, tuple(int, int), optional
1827
- :param _request_auth: set to override the auth_settings for an a single
1828
- request; this effectively ignores the
1829
- authentication in the spec for a single request.
1830
- :type _request_auth: dict, optional
1831
- :param _content_type: force content-type for the request.
1832
- :type _content_type: str, Optional
1833
- :param _headers: set to override the headers for a single
1834
- request; this effectively ignores the headers
1835
- in the spec for a single request.
1836
- :type _headers: dict, optional
1837
- :param _host_index: set to override the host_index for a single
1838
- request; this effectively ignores the host_index
1839
- in the spec for a single request.
1840
- :type _host_index: int, optional
1841
- :return: Returns the result object.
1842
- """ # noqa: E501
1843
-
1844
- _param = self._validation_set_validation_set_id_get_serialize(
1845
- validation_set_id=validation_set_id,
1846
- _request_auth=_request_auth,
1847
- _content_type=_content_type,
1848
- _headers=_headers,
1849
- _host_index=_host_index
1850
- )
1851
-
1852
- _response_types_map: Dict[str, Optional[str]] = {
1853
- '200': "GetValidationSetByIdResult",
1854
- }
1855
- response_data = self.api_client.call_api(
1856
- *_param,
1857
- _request_timeout=_request_timeout
1858
- )
1859
- response_data.read()
1860
- return self.api_client.response_deserialize(
1861
- response_data=response_data,
1862
- response_types_map=_response_types_map,
1863
- )
1864
-
1865
-
1866
- @validate_call
1867
- def validation_set_validation_set_id_get_without_preload_content(
1868
- self,
1869
- validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to get.")],
1870
- _request_timeout: Union[
1871
- None,
1872
- Annotated[StrictFloat, Field(gt=0)],
1873
- Tuple[
1874
- Annotated[StrictFloat, Field(gt=0)],
1875
- Annotated[StrictFloat, Field(gt=0)]
1876
- ]
1877
- ] = None,
1878
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1879
- _content_type: Optional[StrictStr] = None,
1880
- _headers: Optional[Dict[StrictStr, Any]] = None,
1881
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1882
- ) -> RESTResponseType:
1883
- """Gets a validation set by the id.
1884
-
1885
-
1886
- :param validation_set_id: The id of the validation set to get. (required)
1887
- :type validation_set_id: str
1888
- :param _request_timeout: timeout setting for this request. If one
1889
- number provided, it will be total request
1890
- timeout. It can also be a pair (tuple) of
1891
- (connection, read) timeouts.
1892
- :type _request_timeout: int, tuple(int, int), optional
1893
- :param _request_auth: set to override the auth_settings for an a single
1894
- request; this effectively ignores the
1895
- authentication in the spec for a single request.
1896
- :type _request_auth: dict, optional
1897
- :param _content_type: force content-type for the request.
1898
- :type _content_type: str, Optional
1899
- :param _headers: set to override the headers for a single
1900
- request; this effectively ignores the headers
1901
- in the spec for a single request.
1902
- :type _headers: dict, optional
1903
- :param _host_index: set to override the host_index for a single
1904
- request; this effectively ignores the host_index
1905
- in the spec for a single request.
1906
- :type _host_index: int, optional
1907
- :return: Returns the result object.
1908
- """ # noqa: E501
1909
-
1910
- _param = self._validation_set_validation_set_id_get_serialize(
1911
- validation_set_id=validation_set_id,
1912
- _request_auth=_request_auth,
1913
- _content_type=_content_type,
1914
- _headers=_headers,
1915
- _host_index=_host_index
1916
- )
1917
-
1918
- _response_types_map: Dict[str, Optional[str]] = {
1919
- '200': "GetValidationSetByIdResult",
1920
- }
1921
- response_data = self.api_client.call_api(
1922
- *_param,
1923
- _request_timeout=_request_timeout
1924
- )
1925
- return response_data.response
1926
-
1927
-
1928
- def _validation_set_validation_set_id_get_serialize(
1929
- self,
1930
- validation_set_id,
1931
- _request_auth,
1932
- _content_type,
1933
- _headers,
1934
- _host_index,
1935
- ) -> RequestSerialized:
1936
-
1937
- _host = None
1938
-
1939
- _collection_formats: Dict[str, str] = {
1940
- }
1941
-
1942
- _path_params: Dict[str, str] = {}
1943
- _query_params: List[Tuple[str, str]] = []
1944
- _header_params: Dict[str, Optional[str]] = _headers or {}
1945
- _form_params: List[Tuple[str, str]] = []
1946
- _files: Dict[
1947
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1948
- ] = {}
1949
- _body_params: Optional[bytes] = None
1950
-
1951
- # process the path parameters
1952
- if validation_set_id is not None:
1953
- _path_params['validationSetId'] = validation_set_id
1954
- # process the query parameters
1955
- # process the header parameters
1956
- # process the form parameters
1957
- # process the body parameter
1958
-
1959
-
1960
- # set the HTTP header `Accept`
1961
- if 'Accept' not in _header_params:
1962
- _header_params['Accept'] = self.api_client.select_header_accept(
1963
- [
1964
- 'text/plain',
1965
- 'application/json',
1966
- 'text/json'
1967
- ]
1968
- )
1969
-
1970
-
1971
- # authentication setting
1972
- _auth_settings: List[str] = [
1973
- 'bearer',
1974
- 'oauth2'
1975
- ]
1976
-
1977
- return self.api_client.param_serialize(
1978
- method='GET',
1979
- resource_path='/validation-set/{validationSetId}',
1980
- path_params=_path_params,
1981
- query_params=_query_params,
1982
- header_params=_header_params,
1983
- body=_body_params,
1984
- post_params=_form_params,
1985
- files=_files,
1986
- auth_settings=_auth_settings,
1987
- collection_formats=_collection_formats,
1988
- _host=_host,
1989
- _request_auth=_request_auth
1990
- )
1991
-
1992
-
1993
-
1994
-
1995
- @validate_call
1996
- def validation_set_validation_set_id_rapid_post(
1997
- self,
1998
- validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
1999
- model: Optional[AddValidationRapidModel] = None,
2000
- files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
2001
- texts: Annotated[Optional[List[StrictStr]], Field(description="The texts to use for the rapid.")] = None,
2002
- urls: Annotated[Optional[List[StrictStr]], Field(description="The urls to use for the rapid")] = None,
2003
- _request_timeout: Union[
2004
- None,
2005
- Annotated[StrictFloat, Field(gt=0)],
2006
- Tuple[
2007
- Annotated[StrictFloat, Field(gt=0)],
2008
- Annotated[StrictFloat, Field(gt=0)]
2009
- ]
2010
- ] = None,
2011
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2012
- _content_type: Optional[StrictStr] = None,
2013
- _headers: Optional[Dict[StrictStr, Any]] = None,
2014
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2015
- ) -> AddValidationRapidResult:
2016
- """Adds a new validation rapid to the specified validation set using files to create the assets.
2017
-
2018
-
2019
- :param validation_set_id: The ID of the validation set to add the rapid to. (required)
2020
- :type validation_set_id: str
2021
- :param model:
2022
- :type model: AddValidationRapidModel
2023
- :param files:
2024
- :type files: List[bytearray]
2025
- :param texts: The texts to use for the rapid.
2026
- :type texts: List[str]
2027
- :param urls: The urls to use for the rapid
2028
- :type urls: List[str]
2029
- :param _request_timeout: timeout setting for this request. If one
2030
- number provided, it will be total request
2031
- timeout. It can also be a pair (tuple) of
2032
- (connection, read) timeouts.
2033
- :type _request_timeout: int, tuple(int, int), optional
2034
- :param _request_auth: set to override the auth_settings for an a single
2035
- request; this effectively ignores the
2036
- authentication in the spec for a single request.
2037
- :type _request_auth: dict, optional
2038
- :param _content_type: force content-type for the request.
2039
- :type _content_type: str, Optional
2040
- :param _headers: set to override the headers for a single
2041
- request; this effectively ignores the headers
2042
- in the spec for a single request.
2043
- :type _headers: dict, optional
2044
- :param _host_index: set to override the host_index for a single
2045
- request; this effectively ignores the host_index
2046
- in the spec for a single request.
2047
- :type _host_index: int, optional
2048
- :return: Returns the result object.
2049
- """ # noqa: E501
2050
-
2051
- _param = self._validation_set_validation_set_id_rapid_post_serialize(
2052
- validation_set_id=validation_set_id,
2053
- model=model,
2054
- files=files,
2055
- texts=texts,
2056
- urls=urls,
2057
- _request_auth=_request_auth,
2058
- _content_type=_content_type,
2059
- _headers=_headers,
2060
- _host_index=_host_index
2061
- )
2062
-
2063
- _response_types_map: Dict[str, Optional[str]] = {
2064
- '200': "AddValidationRapidResult",
2065
- }
2066
- response_data = self.api_client.call_api(
2067
- *_param,
2068
- _request_timeout=_request_timeout
2069
- )
2070
- response_data.read()
2071
- return self.api_client.response_deserialize(
2072
- response_data=response_data,
2073
- response_types_map=_response_types_map,
2074
- ).data
2075
-
2076
-
2077
- @validate_call
2078
- def validation_set_validation_set_id_rapid_post_with_http_info(
2079
- self,
2080
- validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
2081
- model: Optional[AddValidationRapidModel] = None,
2082
- files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
2083
- texts: Annotated[Optional[List[StrictStr]], Field(description="The texts to use for the rapid.")] = None,
2084
- urls: Annotated[Optional[List[StrictStr]], Field(description="The urls to use for the rapid")] = None,
2085
- _request_timeout: Union[
2086
- None,
2087
- Annotated[StrictFloat, Field(gt=0)],
2088
- Tuple[
2089
- Annotated[StrictFloat, Field(gt=0)],
2090
- Annotated[StrictFloat, Field(gt=0)]
2091
- ]
2092
- ] = None,
2093
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2094
- _content_type: Optional[StrictStr] = None,
2095
- _headers: Optional[Dict[StrictStr, Any]] = None,
2096
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2097
- ) -> ApiResponse[AddValidationRapidResult]:
2098
- """Adds a new validation rapid to the specified validation set using files to create the assets.
2099
-
2100
-
2101
- :param validation_set_id: The ID of the validation set to add the rapid to. (required)
2102
- :type validation_set_id: str
2103
- :param model:
2104
- :type model: AddValidationRapidModel
2105
- :param files:
2106
- :type files: List[bytearray]
2107
- :param texts: The texts to use for the rapid.
2108
- :type texts: List[str]
2109
- :param urls: The urls to use for the rapid
2110
- :type urls: List[str]
2111
- :param _request_timeout: timeout setting for this request. If one
2112
- number provided, it will be total request
2113
- timeout. It can also be a pair (tuple) of
2114
- (connection, read) timeouts.
2115
- :type _request_timeout: int, tuple(int, int), optional
2116
- :param _request_auth: set to override the auth_settings for an a single
2117
- request; this effectively ignores the
2118
- authentication in the spec for a single request.
2119
- :type _request_auth: dict, optional
2120
- :param _content_type: force content-type for the request.
2121
- :type _content_type: str, Optional
2122
- :param _headers: set to override the headers for a single
2123
- request; this effectively ignores the headers
2124
- in the spec for a single request.
2125
- :type _headers: dict, optional
2126
- :param _host_index: set to override the host_index for a single
2127
- request; this effectively ignores the host_index
2128
- in the spec for a single request.
2129
- :type _host_index: int, optional
2130
- :return: Returns the result object.
2131
- """ # noqa: E501
2132
-
2133
- _param = self._validation_set_validation_set_id_rapid_post_serialize(
2134
- validation_set_id=validation_set_id,
2135
- model=model,
2136
- files=files,
2137
- texts=texts,
2138
- urls=urls,
2139
- _request_auth=_request_auth,
2140
- _content_type=_content_type,
2141
- _headers=_headers,
2142
- _host_index=_host_index
2143
- )
2144
-
2145
- _response_types_map: Dict[str, Optional[str]] = {
2146
- '200': "AddValidationRapidResult",
2147
- }
2148
- response_data = self.api_client.call_api(
2149
- *_param,
2150
- _request_timeout=_request_timeout
2151
- )
2152
- response_data.read()
2153
- return self.api_client.response_deserialize(
2154
- response_data=response_data,
2155
- response_types_map=_response_types_map,
2156
- )
2157
-
2158
-
2159
- @validate_call
2160
- def validation_set_validation_set_id_rapid_post_without_preload_content(
2161
- self,
2162
- validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
2163
- model: Optional[AddValidationRapidModel] = None,
2164
- files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
2165
- texts: Annotated[Optional[List[StrictStr]], Field(description="The texts to use for the rapid.")] = None,
2166
- urls: Annotated[Optional[List[StrictStr]], Field(description="The urls to use for the rapid")] = None,
2167
- _request_timeout: Union[
2168
- None,
2169
- Annotated[StrictFloat, Field(gt=0)],
2170
- Tuple[
2171
- Annotated[StrictFloat, Field(gt=0)],
2172
- Annotated[StrictFloat, Field(gt=0)]
2173
- ]
2174
- ] = None,
2175
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2176
- _content_type: Optional[StrictStr] = None,
2177
- _headers: Optional[Dict[StrictStr, Any]] = None,
2178
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2179
- ) -> RESTResponseType:
2180
- """Adds a new validation rapid to the specified validation set using files to create the assets.
2181
-
2182
-
2183
- :param validation_set_id: The ID of the validation set to add the rapid to. (required)
2184
- :type validation_set_id: str
2185
- :param model:
2186
- :type model: AddValidationRapidModel
2187
- :param files:
2188
- :type files: List[bytearray]
2189
- :param texts: The texts to use for the rapid.
2190
- :type texts: List[str]
2191
- :param urls: The urls to use for the rapid
2192
- :type urls: List[str]
2193
- :param _request_timeout: timeout setting for this request. If one
2194
- number provided, it will be total request
2195
- timeout. It can also be a pair (tuple) of
2196
- (connection, read) timeouts.
2197
- :type _request_timeout: int, tuple(int, int), optional
2198
- :param _request_auth: set to override the auth_settings for an a single
2199
- request; this effectively ignores the
2200
- authentication in the spec for a single request.
2201
- :type _request_auth: dict, optional
2202
- :param _content_type: force content-type for the request.
2203
- :type _content_type: str, Optional
2204
- :param _headers: set to override the headers for a single
2205
- request; this effectively ignores the headers
2206
- in the spec for a single request.
2207
- :type _headers: dict, optional
2208
- :param _host_index: set to override the host_index for a single
2209
- request; this effectively ignores the host_index
2210
- in the spec for a single request.
2211
- :type _host_index: int, optional
2212
- :return: Returns the result object.
2213
- """ # noqa: E501
2214
-
2215
- _param = self._validation_set_validation_set_id_rapid_post_serialize(
2216
- validation_set_id=validation_set_id,
2217
- model=model,
2218
- files=files,
2219
- texts=texts,
2220
- urls=urls,
2221
- _request_auth=_request_auth,
2222
- _content_type=_content_type,
2223
- _headers=_headers,
2224
- _host_index=_host_index
2225
- )
2226
-
2227
- _response_types_map: Dict[str, Optional[str]] = {
2228
- '200': "AddValidationRapidResult",
2229
- }
2230
- response_data = self.api_client.call_api(
2231
- *_param,
2232
- _request_timeout=_request_timeout
2233
- )
2234
- return response_data.response
2235
-
2236
-
2237
- def _validation_set_validation_set_id_rapid_post_serialize(
2238
- self,
2239
- validation_set_id,
2240
- model,
2241
- files,
2242
- texts,
2243
- urls,
2244
- _request_auth,
2245
- _content_type,
2246
- _headers,
2247
- _host_index,
2248
- ) -> RequestSerialized:
2249
-
2250
- _host = None
2251
-
2252
- _collection_formats: Dict[str, str] = {
2253
- 'files': 'multi',
2254
- 'texts': 'multi',
2255
- 'urls': 'multi',
2256
- }
2257
-
2258
- _path_params: Dict[str, str] = {}
2259
- _query_params: List[Tuple[str, str]] = []
2260
- _header_params: Dict[str, Optional[str]] = _headers or {}
2261
- _form_params: List[Tuple[str, str]] = []
2262
- _files: Dict[
2263
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2264
- ] = {}
2265
- _body_params: Optional[bytes] = None
2266
-
2267
- # process the path parameters
2268
- if validation_set_id is not None:
2269
- _path_params['validationSetId'] = validation_set_id
2270
- # process the query parameters
2271
- # process the header parameters
2272
- # process the form parameters
2273
- if model is not None:
2274
- _form_params.append(('model', model))
2275
- if files is not None:
2276
- _files['files'] = files
2277
- if texts is not None:
2278
- _form_params.append(('texts', texts))
2279
- if urls is not None:
2280
- _form_params.append(('urls', urls))
2281
- # process the body parameter
2282
-
2283
-
2284
- # set the HTTP header `Accept`
2285
- if 'Accept' not in _header_params:
2286
- _header_params['Accept'] = self.api_client.select_header_accept(
2287
- [
2288
- 'text/plain',
2289
- 'application/json',
2290
- 'text/json'
2291
- ]
2292
- )
2293
-
2294
- # set the HTTP header `Content-Type`
2295
- if _content_type:
2296
- _header_params['Content-Type'] = _content_type
2297
- else:
2298
- _default_content_type = (
2299
- self.api_client.select_header_content_type(
2300
- [
2301
- 'multipart/form-data'
2302
- ]
2303
- )
2304
- )
2305
- if _default_content_type is not None:
2306
- _header_params['Content-Type'] = _default_content_type
2307
-
2308
- # authentication setting
2309
- _auth_settings: List[str] = [
2310
- 'bearer',
2311
- 'oauth2'
2312
- ]
2313
-
2314
- return self.api_client.param_serialize(
2315
- method='POST',
2316
- resource_path='/validation-set/{validationSetId}/rapid',
2317
- path_params=_path_params,
2318
- query_params=_query_params,
2319
- header_params=_header_params,
2320
- body=_body_params,
2321
- post_params=_form_params,
2322
- files=_files,
2323
- auth_settings=_auth_settings,
2324
- collection_formats=_collection_formats,
2325
- _host=_host,
2326
- _request_auth=_request_auth
2327
- )
2328
-
2329
-
2330
-
2331
-
2332
- @validate_call
2333
- def validation_set_validation_set_id_rapids_get(
2334
- self,
2335
- validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2336
- model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
2337
- _request_timeout: Union[
2338
- None,
2339
- Annotated[StrictFloat, Field(gt=0)],
2340
- Tuple[
2341
- Annotated[StrictFloat, Field(gt=0)],
2342
- Annotated[StrictFloat, Field(gt=0)]
2343
- ]
2344
- ] = None,
2345
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2346
- _content_type: Optional[StrictStr] = None,
2347
- _headers: Optional[Dict[StrictStr, Any]] = None,
2348
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2349
- ) -> GetValidationRapidsResultPagedResult:
2350
- """Queries the validation rapids for a specific validation set.
2351
-
2352
-
2353
- :param validation_set_id: The validation set to query. (required)
2354
- :type validation_set_id: str
2355
- :param model: The request formatted as a JSON in the query parameters.
2356
- :type model: QueryModel
2357
- :param _request_timeout: timeout setting for this request. If one
2358
- number provided, it will be total request
2359
- timeout. It can also be a pair (tuple) of
2360
- (connection, read) timeouts.
2361
- :type _request_timeout: int, tuple(int, int), optional
2362
- :param _request_auth: set to override the auth_settings for an a single
2363
- request; this effectively ignores the
2364
- authentication in the spec for a single request.
2365
- :type _request_auth: dict, optional
2366
- :param _content_type: force content-type for the request.
2367
- :type _content_type: str, Optional
2368
- :param _headers: set to override the headers for a single
2369
- request; this effectively ignores the headers
2370
- in the spec for a single request.
2371
- :type _headers: dict, optional
2372
- :param _host_index: set to override the host_index for a single
2373
- request; this effectively ignores the host_index
2374
- in the spec for a single request.
2375
- :type _host_index: int, optional
2376
- :return: Returns the result object.
2377
- """ # noqa: E501
2378
-
2379
- _param = self._validation_set_validation_set_id_rapids_get_serialize(
2380
- validation_set_id=validation_set_id,
2381
- model=model,
2382
- _request_auth=_request_auth,
2383
- _content_type=_content_type,
2384
- _headers=_headers,
2385
- _host_index=_host_index
2386
- )
2387
-
2388
- _response_types_map: Dict[str, Optional[str]] = {
2389
- '200': "GetValidationRapidsResultPagedResult",
2390
- }
2391
- response_data = self.api_client.call_api(
2392
- *_param,
2393
- _request_timeout=_request_timeout
2394
- )
2395
- response_data.read()
2396
- return self.api_client.response_deserialize(
2397
- response_data=response_data,
2398
- response_types_map=_response_types_map,
2399
- ).data
2400
-
2401
-
2402
- @validate_call
2403
- def validation_set_validation_set_id_rapids_get_with_http_info(
2404
- self,
2405
- validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2406
- model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
2407
- _request_timeout: Union[
2408
- None,
2409
- Annotated[StrictFloat, Field(gt=0)],
2410
- Tuple[
2411
- Annotated[StrictFloat, Field(gt=0)],
2412
- Annotated[StrictFloat, Field(gt=0)]
2413
- ]
2414
- ] = None,
2415
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2416
- _content_type: Optional[StrictStr] = None,
2417
- _headers: Optional[Dict[StrictStr, Any]] = None,
2418
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2419
- ) -> ApiResponse[GetValidationRapidsResultPagedResult]:
2420
- """Queries the validation rapids for a specific validation set.
2421
-
2422
-
2423
- :param validation_set_id: The validation set to query. (required)
2424
- :type validation_set_id: str
2425
- :param model: The request formatted as a JSON in the query parameters.
2426
- :type model: QueryModel
2427
- :param _request_timeout: timeout setting for this request. If one
2428
- number provided, it will be total request
2429
- timeout. It can also be a pair (tuple) of
2430
- (connection, read) timeouts.
2431
- :type _request_timeout: int, tuple(int, int), optional
2432
- :param _request_auth: set to override the auth_settings for an a single
2433
- request; this effectively ignores the
2434
- authentication in the spec for a single request.
2435
- :type _request_auth: dict, optional
2436
- :param _content_type: force content-type for the request.
2437
- :type _content_type: str, Optional
2438
- :param _headers: set to override the headers for a single
2439
- request; this effectively ignores the headers
2440
- in the spec for a single request.
2441
- :type _headers: dict, optional
2442
- :param _host_index: set to override the host_index for a single
2443
- request; this effectively ignores the host_index
2444
- in the spec for a single request.
2445
- :type _host_index: int, optional
2446
- :return: Returns the result object.
2447
- """ # noqa: E501
2448
-
2449
- _param = self._validation_set_validation_set_id_rapids_get_serialize(
2450
- validation_set_id=validation_set_id,
2451
- model=model,
2452
- _request_auth=_request_auth,
2453
- _content_type=_content_type,
2454
- _headers=_headers,
2455
- _host_index=_host_index
2456
- )
2457
-
2458
- _response_types_map: Dict[str, Optional[str]] = {
2459
- '200': "GetValidationRapidsResultPagedResult",
2460
- }
2461
- response_data = self.api_client.call_api(
2462
- *_param,
2463
- _request_timeout=_request_timeout
2464
- )
2465
- response_data.read()
2466
- return self.api_client.response_deserialize(
2467
- response_data=response_data,
2468
- response_types_map=_response_types_map,
2469
- )
2470
-
2471
-
2472
- @validate_call
2473
- def validation_set_validation_set_id_rapids_get_without_preload_content(
2474
- self,
2475
- validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2476
- model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
2477
- _request_timeout: Union[
2478
- None,
2479
- Annotated[StrictFloat, Field(gt=0)],
2480
- Tuple[
2481
- Annotated[StrictFloat, Field(gt=0)],
2482
- Annotated[StrictFloat, Field(gt=0)]
2483
- ]
2484
- ] = None,
2485
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2486
- _content_type: Optional[StrictStr] = None,
2487
- _headers: Optional[Dict[StrictStr, Any]] = None,
2488
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2489
- ) -> RESTResponseType:
2490
- """Queries the validation rapids for a specific validation set.
2491
-
2492
-
2493
- :param validation_set_id: The validation set to query. (required)
2494
- :type validation_set_id: str
2495
- :param model: The request formatted as a JSON in the query parameters.
2496
- :type model: QueryModel
2497
- :param _request_timeout: timeout setting for this request. If one
2498
- number provided, it will be total request
2499
- timeout. It can also be a pair (tuple) of
2500
- (connection, read) timeouts.
2501
- :type _request_timeout: int, tuple(int, int), optional
2502
- :param _request_auth: set to override the auth_settings for an a single
2503
- request; this effectively ignores the
2504
- authentication in the spec for a single request.
2505
- :type _request_auth: dict, optional
2506
- :param _content_type: force content-type for the request.
2507
- :type _content_type: str, Optional
2508
- :param _headers: set to override the headers for a single
2509
- request; this effectively ignores the headers
2510
- in the spec for a single request.
2511
- :type _headers: dict, optional
2512
- :param _host_index: set to override the host_index for a single
2513
- request; this effectively ignores the host_index
2514
- in the spec for a single request.
2515
- :type _host_index: int, optional
2516
- :return: Returns the result object.
2517
- """ # noqa: E501
2518
-
2519
- _param = self._validation_set_validation_set_id_rapids_get_serialize(
2520
- validation_set_id=validation_set_id,
2521
- model=model,
2522
- _request_auth=_request_auth,
2523
- _content_type=_content_type,
2524
- _headers=_headers,
2525
- _host_index=_host_index
2526
- )
2527
-
2528
- _response_types_map: Dict[str, Optional[str]] = {
2529
- '200': "GetValidationRapidsResultPagedResult",
2530
- }
2531
- response_data = self.api_client.call_api(
2532
- *_param,
2533
- _request_timeout=_request_timeout
2534
- )
2535
- return response_data.response
2536
-
2537
-
2538
- def _validation_set_validation_set_id_rapids_get_serialize(
2539
- self,
2540
- validation_set_id,
2541
- model,
2542
- _request_auth,
2543
- _content_type,
2544
- _headers,
2545
- _host_index,
2546
- ) -> RequestSerialized:
2547
-
2548
- _host = None
2549
-
2550
- _collection_formats: Dict[str, str] = {
2551
- }
2552
-
2553
- _path_params: Dict[str, str] = {}
2554
- _query_params: List[Tuple[str, str]] = []
2555
- _header_params: Dict[str, Optional[str]] = _headers or {}
2556
- _form_params: List[Tuple[str, str]] = []
2557
- _files: Dict[
2558
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2559
- ] = {}
2560
- _body_params: Optional[bytes] = None
2561
-
2562
- # process the path parameters
2563
- if validation_set_id is not None:
2564
- _path_params['validationSetId'] = validation_set_id
2565
- # process the query parameters
2566
- if model is not None:
2567
-
2568
- _query_params.append(('model', model))
2569
-
2570
- # process the header parameters
2571
- # process the form parameters
2572
- # process the body parameter
2573
-
2574
-
2575
- # set the HTTP header `Accept`
2576
- if 'Accept' not in _header_params:
2577
- _header_params['Accept'] = self.api_client.select_header_accept(
2578
- [
2579
- 'text/plain',
2580
- 'application/json',
2581
- 'text/json'
2582
- ]
2583
- )
2584
-
2585
-
2586
- # authentication setting
2587
- _auth_settings: List[str] = [
2588
- 'bearer',
2589
- 'oauth2'
2590
- ]
2591
-
2592
- return self.api_client.param_serialize(
2593
- method='GET',
2594
- resource_path='/validation-set/{validationSetId}/rapids',
2595
- path_params=_path_params,
2596
- query_params=_query_params,
2597
- header_params=_header_params,
2598
- body=_body_params,
2599
- post_params=_form_params,
2600
- files=_files,
2601
- auth_settings=_auth_settings,
2602
- collection_formats=_collection_formats,
2603
- _host=_host,
2604
- _request_auth=_request_auth
2605
- )
2606
-
2607
-
2608
-
2609
-
2610
- @validate_call
2611
- def validation_set_validation_set_id_shouldalert_patch(
903
+ def validation_set_validation_set_id_export_get(
2612
904
  self,
2613
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2614
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
905
+ validation_set_id: StrictStr,
2615
906
  _request_timeout: Union[
2616
907
  None,
2617
908
  Annotated[StrictFloat, Field(gt=0)],
@@ -2624,14 +915,12 @@ class ValidationSetApi:
2624
915
  _content_type: Optional[StrictStr] = None,
2625
916
  _headers: Optional[Dict[StrictStr, Any]] = None,
2626
917
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2627
- ) -> None:
2628
- """Updates the dimensions of all rapids within a validation set.
918
+ ) -> bytearray:
919
+ """Exports all rapids of a validation-set to a file.
2629
920
 
2630
921
 
2631
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
922
+ :param validation_set_id: (required)
2632
923
  :type validation_set_id: str
2633
- :param update_should_alert_model: The body request for updating the shouldAlert property.
2634
- :type update_should_alert_model: UpdateShouldAlertModel
2635
924
  :param _request_timeout: timeout setting for this request. If one
2636
925
  number provided, it will be total request
2637
926
  timeout. It can also be a pair (tuple) of
@@ -2654,9 +943,8 @@ class ValidationSetApi:
2654
943
  :return: Returns the result object.
2655
944
  """ # noqa: E501
2656
945
 
2657
- _param = self._validation_set_validation_set_id_shouldalert_patch_serialize(
946
+ _param = self._validation_set_validation_set_id_export_get_serialize(
2658
947
  validation_set_id=validation_set_id,
2659
- update_should_alert_model=update_should_alert_model,
2660
948
  _request_auth=_request_auth,
2661
949
  _content_type=_content_type,
2662
950
  _headers=_headers,
@@ -2664,7 +952,7 @@ class ValidationSetApi:
2664
952
  )
2665
953
 
2666
954
  _response_types_map: Dict[str, Optional[str]] = {
2667
- '204': None,
955
+ '200': "bytearray",
2668
956
  }
2669
957
  response_data = self.api_client.call_api(
2670
958
  *_param,
@@ -2678,10 +966,9 @@ class ValidationSetApi:
2678
966
 
2679
967
 
2680
968
  @validate_call
2681
- def validation_set_validation_set_id_shouldalert_patch_with_http_info(
969
+ def validation_set_validation_set_id_export_get_with_http_info(
2682
970
  self,
2683
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2684
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
971
+ validation_set_id: StrictStr,
2685
972
  _request_timeout: Union[
2686
973
  None,
2687
974
  Annotated[StrictFloat, Field(gt=0)],
@@ -2694,14 +981,12 @@ class ValidationSetApi:
2694
981
  _content_type: Optional[StrictStr] = None,
2695
982
  _headers: Optional[Dict[StrictStr, Any]] = None,
2696
983
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2697
- ) -> ApiResponse[None]:
2698
- """Updates the dimensions of all rapids within a validation set.
984
+ ) -> ApiResponse[bytearray]:
985
+ """Exports all rapids of a validation-set to a file.
2699
986
 
2700
987
 
2701
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
988
+ :param validation_set_id: (required)
2702
989
  :type validation_set_id: str
2703
- :param update_should_alert_model: The body request for updating the shouldAlert property.
2704
- :type update_should_alert_model: UpdateShouldAlertModel
2705
990
  :param _request_timeout: timeout setting for this request. If one
2706
991
  number provided, it will be total request
2707
992
  timeout. It can also be a pair (tuple) of
@@ -2724,9 +1009,8 @@ class ValidationSetApi:
2724
1009
  :return: Returns the result object.
2725
1010
  """ # noqa: E501
2726
1011
 
2727
- _param = self._validation_set_validation_set_id_shouldalert_patch_serialize(
1012
+ _param = self._validation_set_validation_set_id_export_get_serialize(
2728
1013
  validation_set_id=validation_set_id,
2729
- update_should_alert_model=update_should_alert_model,
2730
1014
  _request_auth=_request_auth,
2731
1015
  _content_type=_content_type,
2732
1016
  _headers=_headers,
@@ -2734,7 +1018,7 @@ class ValidationSetApi:
2734
1018
  )
2735
1019
 
2736
1020
  _response_types_map: Dict[str, Optional[str]] = {
2737
- '204': None,
1021
+ '200': "bytearray",
2738
1022
  }
2739
1023
  response_data = self.api_client.call_api(
2740
1024
  *_param,
@@ -2748,10 +1032,9 @@ class ValidationSetApi:
2748
1032
 
2749
1033
 
2750
1034
  @validate_call
2751
- def validation_set_validation_set_id_shouldalert_patch_without_preload_content(
1035
+ def validation_set_validation_set_id_export_get_without_preload_content(
2752
1036
  self,
2753
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2754
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
1037
+ validation_set_id: StrictStr,
2755
1038
  _request_timeout: Union[
2756
1039
  None,
2757
1040
  Annotated[StrictFloat, Field(gt=0)],
@@ -2765,13 +1048,11 @@ class ValidationSetApi:
2765
1048
  _headers: Optional[Dict[StrictStr, Any]] = None,
2766
1049
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2767
1050
  ) -> RESTResponseType:
2768
- """Updates the dimensions of all rapids within a validation set.
1051
+ """Exports all rapids of a validation-set to a file.
2769
1052
 
2770
1053
 
2771
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
1054
+ :param validation_set_id: (required)
2772
1055
  :type validation_set_id: str
2773
- :param update_should_alert_model: The body request for updating the shouldAlert property.
2774
- :type update_should_alert_model: UpdateShouldAlertModel
2775
1056
  :param _request_timeout: timeout setting for this request. If one
2776
1057
  number provided, it will be total request
2777
1058
  timeout. It can also be a pair (tuple) of
@@ -2794,9 +1075,8 @@ class ValidationSetApi:
2794
1075
  :return: Returns the result object.
2795
1076
  """ # noqa: E501
2796
1077
 
2797
- _param = self._validation_set_validation_set_id_shouldalert_patch_serialize(
1078
+ _param = self._validation_set_validation_set_id_export_get_serialize(
2798
1079
  validation_set_id=validation_set_id,
2799
- update_should_alert_model=update_should_alert_model,
2800
1080
  _request_auth=_request_auth,
2801
1081
  _content_type=_content_type,
2802
1082
  _headers=_headers,
@@ -2804,7 +1084,7 @@ class ValidationSetApi:
2804
1084
  )
2805
1085
 
2806
1086
  _response_types_map: Dict[str, Optional[str]] = {
2807
- '204': None,
1087
+ '200': "bytearray",
2808
1088
  }
2809
1089
  response_data = self.api_client.call_api(
2810
1090
  *_param,
@@ -2813,10 +1093,9 @@ class ValidationSetApi:
2813
1093
  return response_data.response
2814
1094
 
2815
1095
 
2816
- def _validation_set_validation_set_id_shouldalert_patch_serialize(
1096
+ def _validation_set_validation_set_id_export_get_serialize(
2817
1097
  self,
2818
1098
  validation_set_id,
2819
- update_should_alert_model,
2820
1099
  _request_auth,
2821
1100
  _content_type,
2822
1101
  _headers,
@@ -2844,36 +1123,29 @@ class ValidationSetApi:
2844
1123
  # process the header parameters
2845
1124
  # process the form parameters
2846
1125
  # process the body parameter
2847
- if update_should_alert_model is not None:
2848
- _body_params = update_should_alert_model
2849
1126
 
2850
1127
 
2851
-
2852
- # set the HTTP header `Content-Type`
2853
- if _content_type:
2854
- _header_params['Content-Type'] = _content_type
2855
- else:
2856
- _default_content_type = (
2857
- self.api_client.select_header_content_type(
2858
- [
2859
- 'application/json',
2860
- 'text/json',
2861
- 'application/*+json'
2862
- ]
2863
- )
1128
+ # set the HTTP header `Accept`
1129
+ if 'Accept' not in _header_params:
1130
+ _header_params['Accept'] = self.api_client.select_header_accept(
1131
+ [
1132
+ 'text/plain',
1133
+ 'application/json',
1134
+ 'text/json'
1135
+ ]
2864
1136
  )
2865
- if _default_content_type is not None:
2866
- _header_params['Content-Type'] = _default_content_type
1137
+
2867
1138
 
2868
1139
  # authentication setting
2869
1140
  _auth_settings: List[str] = [
2870
- 'bearer',
2871
- 'oauth2'
1141
+ 'OAuth2',
1142
+ 'OpenIdConnect',
1143
+ 'Bearer'
2872
1144
  ]
2873
1145
 
2874
1146
  return self.api_client.param_serialize(
2875
- method='PATCH',
2876
- resource_path='/validation-set/{validationSetId}/shouldalert',
1147
+ method='GET',
1148
+ resource_path='/validation-set/{validationSetId}/export',
2877
1149
  path_params=_path_params,
2878
1150
  query_params=_query_params,
2879
1151
  header_params=_header_params,
@@ -2890,10 +1162,9 @@ class ValidationSetApi:
2890
1162
 
2891
1163
 
2892
1164
  @validate_call
2893
- def validation_set_validation_set_id_shouldalert_put(
1165
+ def validation_set_validation_set_id_get(
2894
1166
  self,
2895
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2896
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
1167
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to get.")],
2897
1168
  _request_timeout: Union[
2898
1169
  None,
2899
1170
  Annotated[StrictFloat, Field(gt=0)],
@@ -2906,14 +1177,12 @@ class ValidationSetApi:
2906
1177
  _content_type: Optional[StrictStr] = None,
2907
1178
  _headers: Optional[Dict[StrictStr, Any]] = None,
2908
1179
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2909
- ) -> None:
2910
- """(Deprecated) Updates the of all rapshouldAlert property of all rapids within a validation set.
1180
+ ) -> GetValidationSetByIdResult:
1181
+ """Gets a validation set by the id.
2911
1182
 
2912
1183
 
2913
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
1184
+ :param validation_set_id: The id of the validation set to get. (required)
2914
1185
  :type validation_set_id: str
2915
- :param update_should_alert_model: The body request for updating the shouldAlert property.
2916
- :type update_should_alert_model: UpdateShouldAlertModel
2917
1186
  :param _request_timeout: timeout setting for this request. If one
2918
1187
  number provided, it will be total request
2919
1188
  timeout. It can also be a pair (tuple) of
@@ -2935,11 +1204,9 @@ class ValidationSetApi:
2935
1204
  :type _host_index: int, optional
2936
1205
  :return: Returns the result object.
2937
1206
  """ # noqa: E501
2938
- warnings.warn("PUT /validation-set/{validationSetId}/shouldalert is deprecated.", DeprecationWarning)
2939
1207
 
2940
- _param = self._validation_set_validation_set_id_shouldalert_put_serialize(
1208
+ _param = self._validation_set_validation_set_id_get_serialize(
2941
1209
  validation_set_id=validation_set_id,
2942
- update_should_alert_model=update_should_alert_model,
2943
1210
  _request_auth=_request_auth,
2944
1211
  _content_type=_content_type,
2945
1212
  _headers=_headers,
@@ -2947,7 +1214,7 @@ class ValidationSetApi:
2947
1214
  )
2948
1215
 
2949
1216
  _response_types_map: Dict[str, Optional[str]] = {
2950
- '204': None,
1217
+ '200': "GetValidationSetByIdResult",
2951
1218
  }
2952
1219
  response_data = self.api_client.call_api(
2953
1220
  *_param,
@@ -2961,10 +1228,9 @@ class ValidationSetApi:
2961
1228
 
2962
1229
 
2963
1230
  @validate_call
2964
- def validation_set_validation_set_id_shouldalert_put_with_http_info(
1231
+ def validation_set_validation_set_id_get_with_http_info(
2965
1232
  self,
2966
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2967
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
1233
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to get.")],
2968
1234
  _request_timeout: Union[
2969
1235
  None,
2970
1236
  Annotated[StrictFloat, Field(gt=0)],
@@ -2977,14 +1243,12 @@ class ValidationSetApi:
2977
1243
  _content_type: Optional[StrictStr] = None,
2978
1244
  _headers: Optional[Dict[StrictStr, Any]] = None,
2979
1245
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2980
- ) -> ApiResponse[None]:
2981
- """(Deprecated) Updates the of all rapshouldAlert property of all rapids within a validation set.
1246
+ ) -> ApiResponse[GetValidationSetByIdResult]:
1247
+ """Gets a validation set by the id.
2982
1248
 
2983
1249
 
2984
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
1250
+ :param validation_set_id: The id of the validation set to get. (required)
2985
1251
  :type validation_set_id: str
2986
- :param update_should_alert_model: The body request for updating the shouldAlert property.
2987
- :type update_should_alert_model: UpdateShouldAlertModel
2988
1252
  :param _request_timeout: timeout setting for this request. If one
2989
1253
  number provided, it will be total request
2990
1254
  timeout. It can also be a pair (tuple) of
@@ -3006,11 +1270,9 @@ class ValidationSetApi:
3006
1270
  :type _host_index: int, optional
3007
1271
  :return: Returns the result object.
3008
1272
  """ # noqa: E501
3009
- warnings.warn("PUT /validation-set/{validationSetId}/shouldalert is deprecated.", DeprecationWarning)
3010
1273
 
3011
- _param = self._validation_set_validation_set_id_shouldalert_put_serialize(
1274
+ _param = self._validation_set_validation_set_id_get_serialize(
3012
1275
  validation_set_id=validation_set_id,
3013
- update_should_alert_model=update_should_alert_model,
3014
1276
  _request_auth=_request_auth,
3015
1277
  _content_type=_content_type,
3016
1278
  _headers=_headers,
@@ -3018,7 +1280,7 @@ class ValidationSetApi:
3018
1280
  )
3019
1281
 
3020
1282
  _response_types_map: Dict[str, Optional[str]] = {
3021
- '204': None,
1283
+ '200': "GetValidationSetByIdResult",
3022
1284
  }
3023
1285
  response_data = self.api_client.call_api(
3024
1286
  *_param,
@@ -3032,10 +1294,9 @@ class ValidationSetApi:
3032
1294
 
3033
1295
 
3034
1296
  @validate_call
3035
- def validation_set_validation_set_id_shouldalert_put_without_preload_content(
1297
+ def validation_set_validation_set_id_get_without_preload_content(
3036
1298
  self,
3037
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
3038
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
1299
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to get.")],
3039
1300
  _request_timeout: Union[
3040
1301
  None,
3041
1302
  Annotated[StrictFloat, Field(gt=0)],
@@ -3049,13 +1310,11 @@ class ValidationSetApi:
3049
1310
  _headers: Optional[Dict[StrictStr, Any]] = None,
3050
1311
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3051
1312
  ) -> RESTResponseType:
3052
- """(Deprecated) Updates the of all rapshouldAlert property of all rapids within a validation set.
1313
+ """Gets a validation set by the id.
3053
1314
 
3054
1315
 
3055
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
1316
+ :param validation_set_id: The id of the validation set to get. (required)
3056
1317
  :type validation_set_id: str
3057
- :param update_should_alert_model: The body request for updating the shouldAlert property.
3058
- :type update_should_alert_model: UpdateShouldAlertModel
3059
1318
  :param _request_timeout: timeout setting for this request. If one
3060
1319
  number provided, it will be total request
3061
1320
  timeout. It can also be a pair (tuple) of
@@ -3077,11 +1336,9 @@ class ValidationSetApi:
3077
1336
  :type _host_index: int, optional
3078
1337
  :return: Returns the result object.
3079
1338
  """ # noqa: E501
3080
- warnings.warn("PUT /validation-set/{validationSetId}/shouldalert is deprecated.", DeprecationWarning)
3081
1339
 
3082
- _param = self._validation_set_validation_set_id_shouldalert_put_serialize(
1340
+ _param = self._validation_set_validation_set_id_get_serialize(
3083
1341
  validation_set_id=validation_set_id,
3084
- update_should_alert_model=update_should_alert_model,
3085
1342
  _request_auth=_request_auth,
3086
1343
  _content_type=_content_type,
3087
1344
  _headers=_headers,
@@ -3089,7 +1346,7 @@ class ValidationSetApi:
3089
1346
  )
3090
1347
 
3091
1348
  _response_types_map: Dict[str, Optional[str]] = {
3092
- '204': None,
1349
+ '200': "GetValidationSetByIdResult",
3093
1350
  }
3094
1351
  response_data = self.api_client.call_api(
3095
1352
  *_param,
@@ -3098,10 +1355,9 @@ class ValidationSetApi:
3098
1355
  return response_data.response
3099
1356
 
3100
1357
 
3101
- def _validation_set_validation_set_id_shouldalert_put_serialize(
1358
+ def _validation_set_validation_set_id_get_serialize(
3102
1359
  self,
3103
1360
  validation_set_id,
3104
- update_should_alert_model,
3105
1361
  _request_auth,
3106
1362
  _content_type,
3107
1363
  _headers,
@@ -3129,36 +1385,29 @@ class ValidationSetApi:
3129
1385
  # process the header parameters
3130
1386
  # process the form parameters
3131
1387
  # process the body parameter
3132
- if update_should_alert_model is not None:
3133
- _body_params = update_should_alert_model
3134
-
3135
1388
 
3136
1389
 
3137
- # set the HTTP header `Content-Type`
3138
- if _content_type:
3139
- _header_params['Content-Type'] = _content_type
3140
- else:
3141
- _default_content_type = (
3142
- self.api_client.select_header_content_type(
3143
- [
3144
- 'application/json',
3145
- 'text/json',
3146
- 'application/*+json'
3147
- ]
3148
- )
1390
+ # set the HTTP header `Accept`
1391
+ if 'Accept' not in _header_params:
1392
+ _header_params['Accept'] = self.api_client.select_header_accept(
1393
+ [
1394
+ 'text/plain',
1395
+ 'application/json',
1396
+ 'text/json'
1397
+ ]
3149
1398
  )
3150
- if _default_content_type is not None:
3151
- _header_params['Content-Type'] = _default_content_type
1399
+
3152
1400
 
3153
1401
  # authentication setting
3154
1402
  _auth_settings: List[str] = [
3155
- 'bearer',
3156
- 'oauth2'
1403
+ 'OAuth2',
1404
+ 'OpenIdConnect',
1405
+ 'Bearer'
3157
1406
  ]
3158
1407
 
3159
1408
  return self.api_client.param_serialize(
3160
- method='PUT',
3161
- resource_path='/validation-set/{validationSetId}/shouldalert',
1409
+ method='GET',
1410
+ resource_path='/validation-set/{validationSetId}',
3162
1411
  path_params=_path_params,
3163
1412
  query_params=_query_params,
3164
1413
  header_params=_header_params,
@@ -3175,9 +1424,10 @@ class ValidationSetApi:
3175
1424
 
3176
1425
 
3177
1426
  @validate_call
3178
- def validation_set_validation_set_id_update_labeling_hints_post(
1427
+ def validation_set_validation_set_id_patch(
3179
1428
  self,
3180
- validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the labeling hints for.")],
1429
+ validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
1430
+ update_validation_set_model: Annotated[UpdateValidationSetModel, Field(description="The body request for updating the shouldAlert property.")],
3181
1431
  _request_timeout: Union[
3182
1432
  None,
3183
1433
  Annotated[StrictFloat, Field(gt=0)],
@@ -3191,12 +1441,13 @@ class ValidationSetApi:
3191
1441
  _headers: Optional[Dict[StrictStr, Any]] = None,
3192
1442
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3193
1443
  ) -> None:
3194
- """Refreshes the labeling hints for a validation set.
1444
+ """Updates different characteristics of a validation set.
3195
1445
 
3196
- This will sample the rapids in the validation set and update the labeling hints based on the sampled rapids.
3197
1446
 
3198
- :param validation_set_id: The id of the validation set to update the labeling hints for. (required)
1447
+ :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
3199
1448
  :type validation_set_id: str
1449
+ :param update_validation_set_model: The body request for updating the shouldAlert property. (required)
1450
+ :type update_validation_set_model: UpdateValidationSetModel
3200
1451
  :param _request_timeout: timeout setting for this request. If one
3201
1452
  number provided, it will be total request
3202
1453
  timeout. It can also be a pair (tuple) of
@@ -3219,8 +1470,9 @@ class ValidationSetApi:
3219
1470
  :return: Returns the result object.
3220
1471
  """ # noqa: E501
3221
1472
 
3222
- _param = self._validation_set_validation_set_id_update_labeling_hints_post_serialize(
1473
+ _param = self._validation_set_validation_set_id_patch_serialize(
3223
1474
  validation_set_id=validation_set_id,
1475
+ update_validation_set_model=update_validation_set_model,
3224
1476
  _request_auth=_request_auth,
3225
1477
  _content_type=_content_type,
3226
1478
  _headers=_headers,
@@ -3242,9 +1494,10 @@ class ValidationSetApi:
3242
1494
 
3243
1495
 
3244
1496
  @validate_call
3245
- def validation_set_validation_set_id_update_labeling_hints_post_with_http_info(
1497
+ def validation_set_validation_set_id_patch_with_http_info(
3246
1498
  self,
3247
- validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the labeling hints for.")],
1499
+ validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
1500
+ update_validation_set_model: Annotated[UpdateValidationSetModel, Field(description="The body request for updating the shouldAlert property.")],
3248
1501
  _request_timeout: Union[
3249
1502
  None,
3250
1503
  Annotated[StrictFloat, Field(gt=0)],
@@ -3258,12 +1511,13 @@ class ValidationSetApi:
3258
1511
  _headers: Optional[Dict[StrictStr, Any]] = None,
3259
1512
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3260
1513
  ) -> ApiResponse[None]:
3261
- """Refreshes the labeling hints for a validation set.
1514
+ """Updates different characteristics of a validation set.
3262
1515
 
3263
- This will sample the rapids in the validation set and update the labeling hints based on the sampled rapids.
3264
1516
 
3265
- :param validation_set_id: The id of the validation set to update the labeling hints for. (required)
1517
+ :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
3266
1518
  :type validation_set_id: str
1519
+ :param update_validation_set_model: The body request for updating the shouldAlert property. (required)
1520
+ :type update_validation_set_model: UpdateValidationSetModel
3267
1521
  :param _request_timeout: timeout setting for this request. If one
3268
1522
  number provided, it will be total request
3269
1523
  timeout. It can also be a pair (tuple) of
@@ -3286,8 +1540,9 @@ class ValidationSetApi:
3286
1540
  :return: Returns the result object.
3287
1541
  """ # noqa: E501
3288
1542
 
3289
- _param = self._validation_set_validation_set_id_update_labeling_hints_post_serialize(
1543
+ _param = self._validation_set_validation_set_id_patch_serialize(
3290
1544
  validation_set_id=validation_set_id,
1545
+ update_validation_set_model=update_validation_set_model,
3291
1546
  _request_auth=_request_auth,
3292
1547
  _content_type=_content_type,
3293
1548
  _headers=_headers,
@@ -3309,9 +1564,10 @@ class ValidationSetApi:
3309
1564
 
3310
1565
 
3311
1566
  @validate_call
3312
- def validation_set_validation_set_id_update_labeling_hints_post_without_preload_content(
1567
+ def validation_set_validation_set_id_patch_without_preload_content(
3313
1568
  self,
3314
- validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the labeling hints for.")],
1569
+ validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
1570
+ update_validation_set_model: Annotated[UpdateValidationSetModel, Field(description="The body request for updating the shouldAlert property.")],
3315
1571
  _request_timeout: Union[
3316
1572
  None,
3317
1573
  Annotated[StrictFloat, Field(gt=0)],
@@ -3325,12 +1581,13 @@ class ValidationSetApi:
3325
1581
  _headers: Optional[Dict[StrictStr, Any]] = None,
3326
1582
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3327
1583
  ) -> RESTResponseType:
3328
- """Refreshes the labeling hints for a validation set.
1584
+ """Updates different characteristics of a validation set.
3329
1585
 
3330
- This will sample the rapids in the validation set and update the labeling hints based on the sampled rapids.
3331
1586
 
3332
- :param validation_set_id: The id of the validation set to update the labeling hints for. (required)
1587
+ :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
3333
1588
  :type validation_set_id: str
1589
+ :param update_validation_set_model: The body request for updating the shouldAlert property. (required)
1590
+ :type update_validation_set_model: UpdateValidationSetModel
3334
1591
  :param _request_timeout: timeout setting for this request. If one
3335
1592
  number provided, it will be total request
3336
1593
  timeout. It can also be a pair (tuple) of
@@ -3353,8 +1610,9 @@ class ValidationSetApi:
3353
1610
  :return: Returns the result object.
3354
1611
  """ # noqa: E501
3355
1612
 
3356
- _param = self._validation_set_validation_set_id_update_labeling_hints_post_serialize(
1613
+ _param = self._validation_set_validation_set_id_patch_serialize(
3357
1614
  validation_set_id=validation_set_id,
1615
+ update_validation_set_model=update_validation_set_model,
3358
1616
  _request_auth=_request_auth,
3359
1617
  _content_type=_content_type,
3360
1618
  _headers=_headers,
@@ -3371,9 +1629,10 @@ class ValidationSetApi:
3371
1629
  return response_data.response
3372
1630
 
3373
1631
 
3374
- def _validation_set_validation_set_id_update_labeling_hints_post_serialize(
1632
+ def _validation_set_validation_set_id_patch_serialize(
3375
1633
  self,
3376
1634
  validation_set_id,
1635
+ update_validation_set_model,
3377
1636
  _request_auth,
3378
1637
  _content_type,
3379
1638
  _headers,
@@ -3401,19 +1660,37 @@ class ValidationSetApi:
3401
1660
  # process the header parameters
3402
1661
  # process the form parameters
3403
1662
  # process the body parameter
1663
+ if update_validation_set_model is not None:
1664
+ _body_params = update_validation_set_model
3404
1665
 
3405
1666
 
3406
1667
 
1668
+ # set the HTTP header `Content-Type`
1669
+ if _content_type:
1670
+ _header_params['Content-Type'] = _content_type
1671
+ else:
1672
+ _default_content_type = (
1673
+ self.api_client.select_header_content_type(
1674
+ [
1675
+ 'application/json',
1676
+ 'text/json',
1677
+ 'application/*+json'
1678
+ ]
1679
+ )
1680
+ )
1681
+ if _default_content_type is not None:
1682
+ _header_params['Content-Type'] = _default_content_type
3407
1683
 
3408
1684
  # authentication setting
3409
1685
  _auth_settings: List[str] = [
3410
- 'bearer',
3411
- 'oauth2'
1686
+ 'OAuth2',
1687
+ 'OpenIdConnect',
1688
+ 'Bearer'
3412
1689
  ]
3413
1690
 
3414
1691
  return self.api_client.param_serialize(
3415
- method='POST',
3416
- resource_path='/validation-set/{validationSetId}/update-labeling-hints',
1692
+ method='PATCH',
1693
+ resource_path='/validation-set/{validationSetId}',
3417
1694
  path_params=_path_params,
3418
1695
  query_params=_query_params,
3419
1696
  header_params=_header_params,
@@ -3430,10 +1707,10 @@ class ValidationSetApi:
3430
1707
 
3431
1708
 
3432
1709
  @validate_call
3433
- def validation_set_validation_set_id_visibility_patch(
1710
+ def validation_set_validation_set_id_rapid_post(
3434
1711
  self,
3435
- validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the visibility for.")],
3436
- is_public: Annotated[Optional[StrictBool], Field(description="Whether the validation set should be public or private.")] = None,
1712
+ validation_set_id: Annotated[StrictStr, Field(description="The validation set to add a rapid to.")],
1713
+ add_validation_rapid_model: Annotated[AddValidationRapidModel, Field(description="The validation rapid data including asset, payload, and metadata.")],
3437
1714
  _request_timeout: Union[
3438
1715
  None,
3439
1716
  Annotated[StrictFloat, Field(gt=0)],
@@ -3447,14 +1724,13 @@ class ValidationSetApi:
3447
1724
  _headers: Optional[Dict[StrictStr, Any]] = None,
3448
1725
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3449
1726
  ) -> None:
3450
- """Updates the visibility of a validation set.
1727
+ """Adds a new validation rapid to the validation set using JSON body.
3451
1728
 
3452
- Public validation sets are used to automatically add a validation set to an order if no validation set is specified. If the validation set is made public, the labeling hints will be updated automatically.
3453
1729
 
3454
- :param validation_set_id: The id of the validation set to update the visibility for. (required)
1730
+ :param validation_set_id: The validation set to add a rapid to. (required)
3455
1731
  :type validation_set_id: str
3456
- :param is_public: Whether the validation set should be public or private.
3457
- :type is_public: bool
1732
+ :param add_validation_rapid_model: The validation rapid data including asset, payload, and metadata. (required)
1733
+ :type add_validation_rapid_model: AddValidationRapidModel
3458
1734
  :param _request_timeout: timeout setting for this request. If one
3459
1735
  number provided, it will be total request
3460
1736
  timeout. It can also be a pair (tuple) of
@@ -3477,9 +1753,9 @@ class ValidationSetApi:
3477
1753
  :return: Returns the result object.
3478
1754
  """ # noqa: E501
3479
1755
 
3480
- _param = self._validation_set_validation_set_id_visibility_patch_serialize(
1756
+ _param = self._validation_set_validation_set_id_rapid_post_serialize(
3481
1757
  validation_set_id=validation_set_id,
3482
- is_public=is_public,
1758
+ add_validation_rapid_model=add_validation_rapid_model,
3483
1759
  _request_auth=_request_auth,
3484
1760
  _content_type=_content_type,
3485
1761
  _headers=_headers,
@@ -3501,10 +1777,10 @@ class ValidationSetApi:
3501
1777
 
3502
1778
 
3503
1779
  @validate_call
3504
- def validation_set_validation_set_id_visibility_patch_with_http_info(
1780
+ def validation_set_validation_set_id_rapid_post_with_http_info(
3505
1781
  self,
3506
- validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the visibility for.")],
3507
- is_public: Annotated[Optional[StrictBool], Field(description="Whether the validation set should be public or private.")] = None,
1782
+ validation_set_id: Annotated[StrictStr, Field(description="The validation set to add a rapid to.")],
1783
+ add_validation_rapid_model: Annotated[AddValidationRapidModel, Field(description="The validation rapid data including asset, payload, and metadata.")],
3508
1784
  _request_timeout: Union[
3509
1785
  None,
3510
1786
  Annotated[StrictFloat, Field(gt=0)],
@@ -3518,14 +1794,13 @@ class ValidationSetApi:
3518
1794
  _headers: Optional[Dict[StrictStr, Any]] = None,
3519
1795
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3520
1796
  ) -> ApiResponse[None]:
3521
- """Updates the visibility of a validation set.
1797
+ """Adds a new validation rapid to the validation set using JSON body.
3522
1798
 
3523
- Public validation sets are used to automatically add a validation set to an order if no validation set is specified. If the validation set is made public, the labeling hints will be updated automatically.
3524
1799
 
3525
- :param validation_set_id: The id of the validation set to update the visibility for. (required)
1800
+ :param validation_set_id: The validation set to add a rapid to. (required)
3526
1801
  :type validation_set_id: str
3527
- :param is_public: Whether the validation set should be public or private.
3528
- :type is_public: bool
1802
+ :param add_validation_rapid_model: The validation rapid data including asset, payload, and metadata. (required)
1803
+ :type add_validation_rapid_model: AddValidationRapidModel
3529
1804
  :param _request_timeout: timeout setting for this request. If one
3530
1805
  number provided, it will be total request
3531
1806
  timeout. It can also be a pair (tuple) of
@@ -3548,9 +1823,9 @@ class ValidationSetApi:
3548
1823
  :return: Returns the result object.
3549
1824
  """ # noqa: E501
3550
1825
 
3551
- _param = self._validation_set_validation_set_id_visibility_patch_serialize(
1826
+ _param = self._validation_set_validation_set_id_rapid_post_serialize(
3552
1827
  validation_set_id=validation_set_id,
3553
- is_public=is_public,
1828
+ add_validation_rapid_model=add_validation_rapid_model,
3554
1829
  _request_auth=_request_auth,
3555
1830
  _content_type=_content_type,
3556
1831
  _headers=_headers,
@@ -3572,10 +1847,10 @@ class ValidationSetApi:
3572
1847
 
3573
1848
 
3574
1849
  @validate_call
3575
- def validation_set_validation_set_id_visibility_patch_without_preload_content(
1850
+ def validation_set_validation_set_id_rapid_post_without_preload_content(
3576
1851
  self,
3577
- validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the visibility for.")],
3578
- is_public: Annotated[Optional[StrictBool], Field(description="Whether the validation set should be public or private.")] = None,
1852
+ validation_set_id: Annotated[StrictStr, Field(description="The validation set to add a rapid to.")],
1853
+ add_validation_rapid_model: Annotated[AddValidationRapidModel, Field(description="The validation rapid data including asset, payload, and metadata.")],
3579
1854
  _request_timeout: Union[
3580
1855
  None,
3581
1856
  Annotated[StrictFloat, Field(gt=0)],
@@ -3589,14 +1864,13 @@ class ValidationSetApi:
3589
1864
  _headers: Optional[Dict[StrictStr, Any]] = None,
3590
1865
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3591
1866
  ) -> RESTResponseType:
3592
- """Updates the visibility of a validation set.
1867
+ """Adds a new validation rapid to the validation set using JSON body.
3593
1868
 
3594
- Public validation sets are used to automatically add a validation set to an order if no validation set is specified. If the validation set is made public, the labeling hints will be updated automatically.
3595
1869
 
3596
- :param validation_set_id: The id of the validation set to update the visibility for. (required)
1870
+ :param validation_set_id: The validation set to add a rapid to. (required)
3597
1871
  :type validation_set_id: str
3598
- :param is_public: Whether the validation set should be public or private.
3599
- :type is_public: bool
1872
+ :param add_validation_rapid_model: The validation rapid data including asset, payload, and metadata. (required)
1873
+ :type add_validation_rapid_model: AddValidationRapidModel
3600
1874
  :param _request_timeout: timeout setting for this request. If one
3601
1875
  number provided, it will be total request
3602
1876
  timeout. It can also be a pair (tuple) of
@@ -3619,9 +1893,9 @@ class ValidationSetApi:
3619
1893
  :return: Returns the result object.
3620
1894
  """ # noqa: E501
3621
1895
 
3622
- _param = self._validation_set_validation_set_id_visibility_patch_serialize(
1896
+ _param = self._validation_set_validation_set_id_rapid_post_serialize(
3623
1897
  validation_set_id=validation_set_id,
3624
- is_public=is_public,
1898
+ add_validation_rapid_model=add_validation_rapid_model,
3625
1899
  _request_auth=_request_auth,
3626
1900
  _content_type=_content_type,
3627
1901
  _headers=_headers,
@@ -3638,10 +1912,10 @@ class ValidationSetApi:
3638
1912
  return response_data.response
3639
1913
 
3640
1914
 
3641
- def _validation_set_validation_set_id_visibility_patch_serialize(
1915
+ def _validation_set_validation_set_id_rapid_post_serialize(
3642
1916
  self,
3643
1917
  validation_set_id,
3644
- is_public,
1918
+ add_validation_rapid_model,
3645
1919
  _request_auth,
3646
1920
  _content_type,
3647
1921
  _headers,
@@ -3666,26 +1940,40 @@ class ValidationSetApi:
3666
1940
  if validation_set_id is not None:
3667
1941
  _path_params['validationSetId'] = validation_set_id
3668
1942
  # process the query parameters
3669
- if is_public is not None:
3670
-
3671
- _query_params.append(('isPublic', is_public))
3672
-
3673
1943
  # process the header parameters
3674
1944
  # process the form parameters
3675
1945
  # process the body parameter
1946
+ if add_validation_rapid_model is not None:
1947
+ _body_params = add_validation_rapid_model
3676
1948
 
3677
1949
 
3678
1950
 
1951
+ # set the HTTP header `Content-Type`
1952
+ if _content_type:
1953
+ _header_params['Content-Type'] = _content_type
1954
+ else:
1955
+ _default_content_type = (
1956
+ self.api_client.select_header_content_type(
1957
+ [
1958
+ 'application/json',
1959
+ 'text/json',
1960
+ 'application/*+json'
1961
+ ]
1962
+ )
1963
+ )
1964
+ if _default_content_type is not None:
1965
+ _header_params['Content-Type'] = _default_content_type
3679
1966
 
3680
1967
  # authentication setting
3681
1968
  _auth_settings: List[str] = [
3682
- 'bearer',
3683
- 'oauth2'
1969
+ 'OAuth2',
1970
+ 'OpenIdConnect',
1971
+ 'Bearer'
3684
1972
  ]
3685
1973
 
3686
1974
  return self.api_client.param_serialize(
3687
- method='PATCH',
3688
- resource_path='/validation-set/{validationSetId}/visibility',
1975
+ method='POST',
1976
+ resource_path='/validation-set/{validationSetId}/rapid',
3689
1977
  path_params=_path_params,
3690
1978
  query_params=_query_params,
3691
1979
  header_params=_header_params,
@@ -3702,9 +1990,10 @@ class ValidationSetApi:
3702
1990
 
3703
1991
 
3704
1992
  @validate_call
3705
- def validation_set_zip_compare_post(
1993
+ def validation_set_validation_set_id_rapids_get(
3706
1994
  self,
3707
- criteria: Optional[StrictStr] = None,
1995
+ validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
1996
+ model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
3708
1997
  _request_timeout: Union[
3709
1998
  None,
3710
1999
  Annotated[StrictFloat, Field(gt=0)],
@@ -3717,12 +2006,14 @@ class ValidationSetApi:
3717
2006
  _content_type: Optional[StrictStr] = None,
3718
2007
  _headers: Optional[Dict[StrictStr, Any]] = None,
3719
2008
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3720
- ) -> ImportValidationSetFromFileResult:
3721
- """Imports a compare validation set from a zip file.
2009
+ ) -> PagedResultOfGetValidationRapidsResult:
2010
+ """Queries the validation rapids for a specific validation set.
3722
2011
 
3723
2012
 
3724
- :param criteria:
3725
- :type criteria: str
2013
+ :param validation_set_id: The validation set to query. (required)
2014
+ :type validation_set_id: str
2015
+ :param model: The request formatted as a JSON in the query parameters.
2016
+ :type model: QueryModel
3726
2017
  :param _request_timeout: timeout setting for this request. If one
3727
2018
  number provided, it will be total request
3728
2019
  timeout. It can also be a pair (tuple) of
@@ -3745,8 +2036,9 @@ class ValidationSetApi:
3745
2036
  :return: Returns the result object.
3746
2037
  """ # noqa: E501
3747
2038
 
3748
- _param = self._validation_set_zip_compare_post_serialize(
3749
- criteria=criteria,
2039
+ _param = self._validation_set_validation_set_id_rapids_get_serialize(
2040
+ validation_set_id=validation_set_id,
2041
+ model=model,
3750
2042
  _request_auth=_request_auth,
3751
2043
  _content_type=_content_type,
3752
2044
  _headers=_headers,
@@ -3754,7 +2046,7 @@ class ValidationSetApi:
3754
2046
  )
3755
2047
 
3756
2048
  _response_types_map: Dict[str, Optional[str]] = {
3757
- '200': "ImportValidationSetFromFileResult",
2049
+ '200': "PagedResultOfGetValidationRapidsResult",
3758
2050
  }
3759
2051
  response_data = self.api_client.call_api(
3760
2052
  *_param,
@@ -3768,9 +2060,10 @@ class ValidationSetApi:
3768
2060
 
3769
2061
 
3770
2062
  @validate_call
3771
- def validation_set_zip_compare_post_with_http_info(
2063
+ def validation_set_validation_set_id_rapids_get_with_http_info(
3772
2064
  self,
3773
- criteria: Optional[StrictStr] = None,
2065
+ validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2066
+ model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
3774
2067
  _request_timeout: Union[
3775
2068
  None,
3776
2069
  Annotated[StrictFloat, Field(gt=0)],
@@ -3783,12 +2076,14 @@ class ValidationSetApi:
3783
2076
  _content_type: Optional[StrictStr] = None,
3784
2077
  _headers: Optional[Dict[StrictStr, Any]] = None,
3785
2078
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3786
- ) -> ApiResponse[ImportValidationSetFromFileResult]:
3787
- """Imports a compare validation set from a zip file.
2079
+ ) -> ApiResponse[PagedResultOfGetValidationRapidsResult]:
2080
+ """Queries the validation rapids for a specific validation set.
3788
2081
 
3789
2082
 
3790
- :param criteria:
3791
- :type criteria: str
2083
+ :param validation_set_id: The validation set to query. (required)
2084
+ :type validation_set_id: str
2085
+ :param model: The request formatted as a JSON in the query parameters.
2086
+ :type model: QueryModel
3792
2087
  :param _request_timeout: timeout setting for this request. If one
3793
2088
  number provided, it will be total request
3794
2089
  timeout. It can also be a pair (tuple) of
@@ -3811,8 +2106,9 @@ class ValidationSetApi:
3811
2106
  :return: Returns the result object.
3812
2107
  """ # noqa: E501
3813
2108
 
3814
- _param = self._validation_set_zip_compare_post_serialize(
3815
- criteria=criteria,
2109
+ _param = self._validation_set_validation_set_id_rapids_get_serialize(
2110
+ validation_set_id=validation_set_id,
2111
+ model=model,
3816
2112
  _request_auth=_request_auth,
3817
2113
  _content_type=_content_type,
3818
2114
  _headers=_headers,
@@ -3820,7 +2116,7 @@ class ValidationSetApi:
3820
2116
  )
3821
2117
 
3822
2118
  _response_types_map: Dict[str, Optional[str]] = {
3823
- '200': "ImportValidationSetFromFileResult",
2119
+ '200': "PagedResultOfGetValidationRapidsResult",
3824
2120
  }
3825
2121
  response_data = self.api_client.call_api(
3826
2122
  *_param,
@@ -3834,9 +2130,10 @@ class ValidationSetApi:
3834
2130
 
3835
2131
 
3836
2132
  @validate_call
3837
- def validation_set_zip_compare_post_without_preload_content(
2133
+ def validation_set_validation_set_id_rapids_get_without_preload_content(
3838
2134
  self,
3839
- criteria: Optional[StrictStr] = None,
2135
+ validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2136
+ model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
3840
2137
  _request_timeout: Union[
3841
2138
  None,
3842
2139
  Annotated[StrictFloat, Field(gt=0)],
@@ -3850,11 +2147,13 @@ class ValidationSetApi:
3850
2147
  _headers: Optional[Dict[StrictStr, Any]] = None,
3851
2148
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3852
2149
  ) -> RESTResponseType:
3853
- """Imports a compare validation set from a zip file.
2150
+ """Queries the validation rapids for a specific validation set.
3854
2151
 
3855
2152
 
3856
- :param criteria:
3857
- :type criteria: str
2153
+ :param validation_set_id: The validation set to query. (required)
2154
+ :type validation_set_id: str
2155
+ :param model: The request formatted as a JSON in the query parameters.
2156
+ :type model: QueryModel
3858
2157
  :param _request_timeout: timeout setting for this request. If one
3859
2158
  number provided, it will be total request
3860
2159
  timeout. It can also be a pair (tuple) of
@@ -3877,8 +2176,9 @@ class ValidationSetApi:
3877
2176
  :return: Returns the result object.
3878
2177
  """ # noqa: E501
3879
2178
 
3880
- _param = self._validation_set_zip_compare_post_serialize(
3881
- criteria=criteria,
2179
+ _param = self._validation_set_validation_set_id_rapids_get_serialize(
2180
+ validation_set_id=validation_set_id,
2181
+ model=model,
3882
2182
  _request_auth=_request_auth,
3883
2183
  _content_type=_content_type,
3884
2184
  _headers=_headers,
@@ -3886,7 +2186,7 @@ class ValidationSetApi:
3886
2186
  )
3887
2187
 
3888
2188
  _response_types_map: Dict[str, Optional[str]] = {
3889
- '200': "ImportValidationSetFromFileResult",
2189
+ '200': "PagedResultOfGetValidationRapidsResult",
3890
2190
  }
3891
2191
  response_data = self.api_client.call_api(
3892
2192
  *_param,
@@ -3895,9 +2195,10 @@ class ValidationSetApi:
3895
2195
  return response_data.response
3896
2196
 
3897
2197
 
3898
- def _validation_set_zip_compare_post_serialize(
2198
+ def _validation_set_validation_set_id_rapids_get_serialize(
3899
2199
  self,
3900
- criteria,
2200
+ validation_set_id,
2201
+ model,
3901
2202
  _request_auth,
3902
2203
  _content_type,
3903
2204
  _headers,
@@ -3919,11 +2220,15 @@ class ValidationSetApi:
3919
2220
  _body_params: Optional[bytes] = None
3920
2221
 
3921
2222
  # process the path parameters
2223
+ if validation_set_id is not None:
2224
+ _path_params['validationSetId'] = validation_set_id
3922
2225
  # process the query parameters
2226
+ if model is not None:
2227
+
2228
+ _query_params.append(('model', model))
2229
+
3923
2230
  # process the header parameters
3924
2231
  # process the form parameters
3925
- if criteria is not None:
3926
- _form_params.append(('Criteria', criteria))
3927
2232
  # process the body parameter
3928
2233
 
3929
2234
 
@@ -3937,29 +2242,17 @@ class ValidationSetApi:
3937
2242
  ]
3938
2243
  )
3939
2244
 
3940
- # set the HTTP header `Content-Type`
3941
- if _content_type:
3942
- _header_params['Content-Type'] = _content_type
3943
- else:
3944
- _default_content_type = (
3945
- self.api_client.select_header_content_type(
3946
- [
3947
- 'multipart/form-data'
3948
- ]
3949
- )
3950
- )
3951
- if _default_content_type is not None:
3952
- _header_params['Content-Type'] = _default_content_type
3953
2245
 
3954
2246
  # authentication setting
3955
2247
  _auth_settings: List[str] = [
3956
- 'bearer',
3957
- 'oauth2'
2248
+ 'OAuth2',
2249
+ 'OpenIdConnect',
2250
+ 'Bearer'
3958
2251
  ]
3959
2252
 
3960
2253
  return self.api_client.param_serialize(
3961
- method='POST',
3962
- resource_path='/validation-set/zip/compare',
2254
+ method='GET',
2255
+ resource_path='/validation-set/{validationSetId}/rapids',
3963
2256
  path_params=_path_params,
3964
2257
  query_params=_query_params,
3965
2258
  header_params=_header_params,
@@ -3976,9 +2269,10 @@ class ValidationSetApi:
3976
2269
 
3977
2270
 
3978
2271
  @validate_call
3979
- def validation_set_zip_post(
2272
+ def validation_set_validation_set_id_visibility_patch(
3980
2273
  self,
3981
- blueprint: Optional[ValidationSetZipPostRequestBlueprint] = None,
2274
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the visibility for.")],
2275
+ is_public: Annotated[Optional[StrictBool], Field(description="Whether the validation set should be public or private.")] = None,
3982
2276
  _request_timeout: Union[
3983
2277
  None,
3984
2278
  Annotated[StrictFloat, Field(gt=0)],
@@ -3991,12 +2285,15 @@ class ValidationSetApi:
3991
2285
  _content_type: Optional[StrictStr] = None,
3992
2286
  _headers: Optional[Dict[StrictStr, Any]] = None,
3993
2287
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3994
- ) -> ImportValidationSetFromFileResult:
3995
- """Imports a validation set from a zip file.
2288
+ ) -> None:
2289
+ """Updates the visibility of a validation set.
3996
2290
 
2291
+ Public validation sets are used to automatically add a validation set to an order if no validation set is specified.
3997
2292
 
3998
- :param blueprint:
3999
- :type blueprint: ValidationSetZipPostRequestBlueprint
2293
+ :param validation_set_id: The id of the validation set to update the visibility for. (required)
2294
+ :type validation_set_id: str
2295
+ :param is_public: Whether the validation set should be public or private.
2296
+ :type is_public: bool
4000
2297
  :param _request_timeout: timeout setting for this request. If one
4001
2298
  number provided, it will be total request
4002
2299
  timeout. It can also be a pair (tuple) of
@@ -4019,8 +2316,9 @@ class ValidationSetApi:
4019
2316
  :return: Returns the result object.
4020
2317
  """ # noqa: E501
4021
2318
 
4022
- _param = self._validation_set_zip_post_serialize(
4023
- blueprint=blueprint,
2319
+ _param = self._validation_set_validation_set_id_visibility_patch_serialize(
2320
+ validation_set_id=validation_set_id,
2321
+ is_public=is_public,
4024
2322
  _request_auth=_request_auth,
4025
2323
  _content_type=_content_type,
4026
2324
  _headers=_headers,
@@ -4028,7 +2326,7 @@ class ValidationSetApi:
4028
2326
  )
4029
2327
 
4030
2328
  _response_types_map: Dict[str, Optional[str]] = {
4031
- '200': "ImportValidationSetFromFileResult",
2329
+ '204': None,
4032
2330
  }
4033
2331
  response_data = self.api_client.call_api(
4034
2332
  *_param,
@@ -4042,9 +2340,10 @@ class ValidationSetApi:
4042
2340
 
4043
2341
 
4044
2342
  @validate_call
4045
- def validation_set_zip_post_with_http_info(
2343
+ def validation_set_validation_set_id_visibility_patch_with_http_info(
4046
2344
  self,
4047
- blueprint: Optional[ValidationSetZipPostRequestBlueprint] = None,
2345
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the visibility for.")],
2346
+ is_public: Annotated[Optional[StrictBool], Field(description="Whether the validation set should be public or private.")] = None,
4048
2347
  _request_timeout: Union[
4049
2348
  None,
4050
2349
  Annotated[StrictFloat, Field(gt=0)],
@@ -4057,12 +2356,15 @@ class ValidationSetApi:
4057
2356
  _content_type: Optional[StrictStr] = None,
4058
2357
  _headers: Optional[Dict[StrictStr, Any]] = None,
4059
2358
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4060
- ) -> ApiResponse[ImportValidationSetFromFileResult]:
4061
- """Imports a validation set from a zip file.
2359
+ ) -> ApiResponse[None]:
2360
+ """Updates the visibility of a validation set.
4062
2361
 
2362
+ Public validation sets are used to automatically add a validation set to an order if no validation set is specified.
4063
2363
 
4064
- :param blueprint:
4065
- :type blueprint: ValidationSetZipPostRequestBlueprint
2364
+ :param validation_set_id: The id of the validation set to update the visibility for. (required)
2365
+ :type validation_set_id: str
2366
+ :param is_public: Whether the validation set should be public or private.
2367
+ :type is_public: bool
4066
2368
  :param _request_timeout: timeout setting for this request. If one
4067
2369
  number provided, it will be total request
4068
2370
  timeout. It can also be a pair (tuple) of
@@ -4085,8 +2387,9 @@ class ValidationSetApi:
4085
2387
  :return: Returns the result object.
4086
2388
  """ # noqa: E501
4087
2389
 
4088
- _param = self._validation_set_zip_post_serialize(
4089
- blueprint=blueprint,
2390
+ _param = self._validation_set_validation_set_id_visibility_patch_serialize(
2391
+ validation_set_id=validation_set_id,
2392
+ is_public=is_public,
4090
2393
  _request_auth=_request_auth,
4091
2394
  _content_type=_content_type,
4092
2395
  _headers=_headers,
@@ -4094,7 +2397,7 @@ class ValidationSetApi:
4094
2397
  )
4095
2398
 
4096
2399
  _response_types_map: Dict[str, Optional[str]] = {
4097
- '200': "ImportValidationSetFromFileResult",
2400
+ '204': None,
4098
2401
  }
4099
2402
  response_data = self.api_client.call_api(
4100
2403
  *_param,
@@ -4108,9 +2411,10 @@ class ValidationSetApi:
4108
2411
 
4109
2412
 
4110
2413
  @validate_call
4111
- def validation_set_zip_post_without_preload_content(
2414
+ def validation_set_validation_set_id_visibility_patch_without_preload_content(
4112
2415
  self,
4113
- blueprint: Optional[ValidationSetZipPostRequestBlueprint] = None,
2416
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the visibility for.")],
2417
+ is_public: Annotated[Optional[StrictBool], Field(description="Whether the validation set should be public or private.")] = None,
4114
2418
  _request_timeout: Union[
4115
2419
  None,
4116
2420
  Annotated[StrictFloat, Field(gt=0)],
@@ -4124,11 +2428,14 @@ class ValidationSetApi:
4124
2428
  _headers: Optional[Dict[StrictStr, Any]] = None,
4125
2429
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4126
2430
  ) -> RESTResponseType:
4127
- """Imports a validation set from a zip file.
2431
+ """Updates the visibility of a validation set.
4128
2432
 
2433
+ Public validation sets are used to automatically add a validation set to an order if no validation set is specified.
4129
2434
 
4130
- :param blueprint:
4131
- :type blueprint: ValidationSetZipPostRequestBlueprint
2435
+ :param validation_set_id: The id of the validation set to update the visibility for. (required)
2436
+ :type validation_set_id: str
2437
+ :param is_public: Whether the validation set should be public or private.
2438
+ :type is_public: bool
4132
2439
  :param _request_timeout: timeout setting for this request. If one
4133
2440
  number provided, it will be total request
4134
2441
  timeout. It can also be a pair (tuple) of
@@ -4151,8 +2458,9 @@ class ValidationSetApi:
4151
2458
  :return: Returns the result object.
4152
2459
  """ # noqa: E501
4153
2460
 
4154
- _param = self._validation_set_zip_post_serialize(
4155
- blueprint=blueprint,
2461
+ _param = self._validation_set_validation_set_id_visibility_patch_serialize(
2462
+ validation_set_id=validation_set_id,
2463
+ is_public=is_public,
4156
2464
  _request_auth=_request_auth,
4157
2465
  _content_type=_content_type,
4158
2466
  _headers=_headers,
@@ -4160,7 +2468,7 @@ class ValidationSetApi:
4160
2468
  )
4161
2469
 
4162
2470
  _response_types_map: Dict[str, Optional[str]] = {
4163
- '200': "ImportValidationSetFromFileResult",
2471
+ '204': None,
4164
2472
  }
4165
2473
  response_data = self.api_client.call_api(
4166
2474
  *_param,
@@ -4169,9 +2477,10 @@ class ValidationSetApi:
4169
2477
  return response_data.response
4170
2478
 
4171
2479
 
4172
- def _validation_set_zip_post_serialize(
2480
+ def _validation_set_validation_set_id_visibility_patch_serialize(
4173
2481
  self,
4174
- blueprint,
2482
+ validation_set_id,
2483
+ is_public,
4175
2484
  _request_auth,
4176
2485
  _content_type,
4177
2486
  _headers,
@@ -4193,47 +2502,30 @@ class ValidationSetApi:
4193
2502
  _body_params: Optional[bytes] = None
4194
2503
 
4195
2504
  # process the path parameters
2505
+ if validation_set_id is not None:
2506
+ _path_params['validationSetId'] = validation_set_id
4196
2507
  # process the query parameters
2508
+ if is_public is not None:
2509
+
2510
+ _query_params.append(('isPublic', is_public))
2511
+
4197
2512
  # process the header parameters
4198
2513
  # process the form parameters
4199
- if blueprint is not None:
4200
- _form_params.append(('Blueprint', blueprint))
4201
2514
  # process the body parameter
4202
2515
 
4203
2516
 
4204
- # set the HTTP header `Accept`
4205
- if 'Accept' not in _header_params:
4206
- _header_params['Accept'] = self.api_client.select_header_accept(
4207
- [
4208
- 'text/plain',
4209
- 'application/json',
4210
- 'text/json'
4211
- ]
4212
- )
4213
2517
 
4214
- # set the HTTP header `Content-Type`
4215
- if _content_type:
4216
- _header_params['Content-Type'] = _content_type
4217
- else:
4218
- _default_content_type = (
4219
- self.api_client.select_header_content_type(
4220
- [
4221
- 'multipart/form-data'
4222
- ]
4223
- )
4224
- )
4225
- if _default_content_type is not None:
4226
- _header_params['Content-Type'] = _default_content_type
4227
2518
 
4228
2519
  # authentication setting
4229
2520
  _auth_settings: List[str] = [
4230
- 'bearer',
4231
- 'oauth2'
2521
+ 'OAuth2',
2522
+ 'OpenIdConnect',
2523
+ 'Bearer'
4232
2524
  ]
4233
2525
 
4234
2526
  return self.api_client.param_serialize(
4235
- method='POST',
4236
- resource_path='/validation-set/zip',
2527
+ method='PATCH',
2528
+ resource_path='/validation-set/{validationSetId}/visibility',
4237
2529
  path_params=_path_params,
4238
2530
  query_params=_query_params,
4239
2531
  header_params=_header_params,
@@ -4473,8 +2765,9 @@ class ValidationSetApi:
4473
2765
 
4474
2766
  # authentication setting
4475
2767
  _auth_settings: List[str] = [
4476
- 'bearer',
4477
- 'oauth2'
2768
+ 'OAuth2',
2769
+ 'OpenIdConnect',
2770
+ 'Bearer'
4478
2771
  ]
4479
2772
 
4480
2773
  return self.api_client.param_serialize(
@@ -4511,7 +2804,7 @@ class ValidationSetApi:
4511
2804
  _content_type: Optional[StrictStr] = None,
4512
2805
  _headers: Optional[Dict[StrictStr, Any]] = None,
4513
2806
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4514
- ) -> ValidationSetModelPagedResult:
2807
+ ) -> PagedResultOfValidationSetModel:
4515
2808
  """Queries available validation sets based on the provided filter, paging and sorting criteria.
4516
2809
 
4517
2810
 
@@ -4548,7 +2841,7 @@ class ValidationSetApi:
4548
2841
  )
4549
2842
 
4550
2843
  _response_types_map: Dict[str, Optional[str]] = {
4551
- '200': "ValidationSetModelPagedResult",
2844
+ '200': "PagedResultOfValidationSetModel",
4552
2845
  }
4553
2846
  response_data = self.api_client.call_api(
4554
2847
  *_param,
@@ -4577,7 +2870,7 @@ class ValidationSetApi:
4577
2870
  _content_type: Optional[StrictStr] = None,
4578
2871
  _headers: Optional[Dict[StrictStr, Any]] = None,
4579
2872
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4580
- ) -> ApiResponse[ValidationSetModelPagedResult]:
2873
+ ) -> ApiResponse[PagedResultOfValidationSetModel]:
4581
2874
  """Queries available validation sets based on the provided filter, paging and sorting criteria.
4582
2875
 
4583
2876
 
@@ -4614,7 +2907,7 @@ class ValidationSetApi:
4614
2907
  )
4615
2908
 
4616
2909
  _response_types_map: Dict[str, Optional[str]] = {
4617
- '200': "ValidationSetModelPagedResult",
2910
+ '200': "PagedResultOfValidationSetModel",
4618
2911
  }
4619
2912
  response_data = self.api_client.call_api(
4620
2913
  *_param,
@@ -4680,7 +2973,7 @@ class ValidationSetApi:
4680
2973
  )
4681
2974
 
4682
2975
  _response_types_map: Dict[str, Optional[str]] = {
4683
- '200': "ValidationSetModelPagedResult",
2976
+ '200': "PagedResultOfValidationSetModel",
4684
2977
  }
4685
2978
  response_data = self.api_client.call_api(
4686
2979
  *_param,
@@ -4736,8 +3029,9 @@ class ValidationSetApi:
4736
3029
 
4737
3030
  # authentication setting
4738
3031
  _auth_settings: List[str] = [
4739
- 'bearer',
4740
- 'oauth2'
3032
+ 'OAuth2',
3033
+ 'OpenIdConnect',
3034
+ 'Bearer'
4741
3035
  ]
4742
3036
 
4743
3037
  return self.api_client.param_serialize(