rapidata 2.24.0__py3-none-any.whl → 3.0.1__py3-none-any.whl

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

Potentially problematic release.


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

Files changed (866) hide show
  1. rapidata/__init__.py +31 -14
  2. rapidata/api_client/__init__.py +84 -321
  3. rapidata/api_client/api/__init__.py +12 -3
  4. rapidata/api_client/api/asset_api.py +853 -0
  5. rapidata/api_client/api/audience_api.py +3044 -0
  6. rapidata/api_client/api/benchmark_api.py +4307 -0
  7. rapidata/api_client/api/campaign_api.py +232 -207
  8. rapidata/api_client/api/client_api.py +166 -145
  9. rapidata/api_client/api/coco_api.py +0 -571
  10. rapidata/api_client/api/compare_workflow_api.py +11 -10
  11. rapidata/api_client/api/customer_rapid_api.py +2216 -0
  12. rapidata/api_client/api/datapoint_api.py +8 -797
  13. rapidata/api_client/api/dataset_api.py +276 -2858
  14. rapidata/api_client/api/evaluation_workflow_api.py +29 -82
  15. rapidata/api_client/api/feedback_api.py +11 -281
  16. rapidata/api_client/api/grouped_ranking_workflow_api.py +319 -0
  17. rapidata/api_client/api/identity_api.py +83 -1171
  18. rapidata/api_client/api/job_api.py +4200 -0
  19. rapidata/api_client/api/job_definition_api.py +319 -0
  20. rapidata/api_client/api/job_revision_api.py +335 -0
  21. rapidata/api_client/api/leaderboard_api.py +2855 -0
  22. rapidata/api_client/api/newsletter_api.py +30 -317
  23. rapidata/api_client/api/order_api.py +758 -5487
  24. rapidata/api_client/api/participant_api.py +2181 -0
  25. rapidata/api_client/api/pipeline_api.py +24 -1783
  26. rapidata/api_client/api/prompt_api.py +320 -0
  27. rapidata/api_client/api/rapidata_identity_api_api.py +5 -4
  28. rapidata/api_client/api/sample_api.py +300 -0
  29. rapidata/api_client/api/simple_workflow_api.py +11 -10
  30. rapidata/api_client/api/survey_api.py +304 -0
  31. rapidata/api_client/api/user_rapid_api.py +1389 -0
  32. rapidata/api_client/api/validation_set_api.py +512 -3232
  33. rapidata/api_client/api/workflow_api.py +32 -825
  34. rapidata/api_client/api_client.py +2 -2
  35. rapidata/api_client/configuration.py +16 -29
  36. rapidata/api_client/exceptions.py +2 -2
  37. rapidata/api_client/models/__init__.py +65 -300
  38. rapidata/api_client/models/ab_test_selection_a_inner.py +27 -13
  39. rapidata/api_client/models/add_campaign_model.py +8 -3
  40. rapidata/api_client/models/add_rapid_to_audience_model.py +144 -0
  41. rapidata/api_client/models/add_user_response_result.py +10 -5
  42. rapidata/api_client/models/add_validation_rapid_model.py +49 -28
  43. rapidata/api_client/models/add_validation_rapid_model_asset.py +154 -0
  44. rapidata/api_client/models/add_validation_rapid_model_context_asset.py +160 -0
  45. rapidata/api_client/models/add_validation_rapid_model_metadata_inner.py +140 -0
  46. rapidata/api_client/models/add_validation_rapid_model_truth.py +32 -12
  47. rapidata/api_client/models/add_validation_rapid_new_model.py +137 -0
  48. rapidata/api_client/models/add_validation_rapid_new_model_asset.py +182 -0
  49. rapidata/api_client/models/add_validation_rapid_new_model_truth.py +286 -0
  50. rapidata/api_client/models/add_validation_text_rapid_model.py +4 -6
  51. rapidata/api_client/models/age_user_filter_model.py +2 -2
  52. rapidata/api_client/models/age_user_filter_model_age_group.py +41 -0
  53. rapidata/api_client/models/aggregated_orders_model.py +98 -0
  54. rapidata/api_client/models/aggregator_type.py +4 -2
  55. rapidata/api_client/models/and_filter.py +121 -0
  56. rapidata/api_client/models/and_filter_filters_inner.py +282 -0
  57. rapidata/api_client/models/and_user_filter_model.py +106 -0
  58. rapidata/api_client/models/and_user_filter_model_filters_inner.py +282 -0
  59. rapidata/api_client/models/are_rapids_active_result.py +2 -2
  60. rapidata/api_client/models/asset_metadata.py +11 -9
  61. rapidata/api_client/models/asset_metadata_model.py +2 -8
  62. rapidata/api_client/models/asset_type.py +40 -0
  63. rapidata/api_client/models/attach_category_rapid_blueprint.py +13 -3
  64. rapidata/api_client/models/attach_category_rapid_blueprint_category.py +89 -0
  65. rapidata/api_client/models/audience_job_state.py +38 -0
  66. rapidata/api_client/models/audience_status.py +39 -0
  67. rapidata/api_client/models/benchmark_query_result.py +98 -0
  68. rapidata/api_client/models/benchmark_query_result_paged_result.py +105 -0
  69. rapidata/api_client/models/boost_leaderboard_model.py +89 -0
  70. rapidata/api_client/models/boost_mode.py +37 -0
  71. rapidata/api_client/models/boost_query_result.py +97 -0
  72. rapidata/api_client/models/boost_query_result_boost_mode.py +37 -0
  73. rapidata/api_client/models/boost_query_result_boost_status.py +39 -0
  74. rapidata/api_client/models/boost_status.py +39 -0
  75. rapidata/api_client/models/boosting_profile.py +91 -0
  76. rapidata/api_client/models/box_shape.py +4 -33
  77. rapidata/api_client/models/campaign_filter.py +98 -0
  78. rapidata/api_client/models/campaign_query_result.py +15 -13
  79. rapidata/api_client/models/campaign_status.py +2 -2
  80. rapidata/api_client/models/change_boost_model.py +89 -0
  81. rapidata/api_client/models/classification_metadata.py +12 -1
  82. rapidata/api_client/models/classify_payload.py +14 -15
  83. rapidata/api_client/models/classify_payload_category.py +89 -0
  84. rapidata/api_client/models/client_model.py +181 -0
  85. rapidata/api_client/models/clients_query_result.py +5 -5
  86. rapidata/api_client/models/clone_order_model.py +6 -8
  87. rapidata/api_client/models/clone_order_result.py +9 -4
  88. rapidata/api_client/models/compare_rapid_blueprint.py +5 -3
  89. rapidata/api_client/models/compare_rapid_blueprint1.py +96 -0
  90. rapidata/api_client/models/compare_result.py +1 -10
  91. rapidata/api_client/models/compare_workflow_config.py +34 -23
  92. rapidata/api_client/models/compare_workflow_config_context_asset.py +174 -0
  93. rapidata/api_client/models/compare_workflow_config_metadata_value.py +57 -15
  94. rapidata/api_client/models/compare_workflow_config_model.py +15 -5
  95. rapidata/api_client/models/compare_workflow_model.py +34 -6
  96. rapidata/api_client/models/compare_workflow_model1.py +20 -9
  97. rapidata/api_client/models/compare_workflow_model_context_asset.py +160 -0
  98. rapidata/api_client/models/compare_workflow_model_metadata_inner.py +154 -0
  99. rapidata/api_client/models/compare_workflow_model_pair_maker_config.py +1 -1
  100. rapidata/api_client/models/comparison_operator.py +2 -2
  101. rapidata/api_client/models/conditional_validation_selection.py +8 -11
  102. rapidata/api_client/models/conditional_validation_selection_validation_chance.py +103 -0
  103. rapidata/api_client/models/confidence_interval.py +89 -0
  104. rapidata/api_client/models/count_metadata.py +12 -1
  105. rapidata/api_client/models/country_filter.py +98 -0
  106. rapidata/api_client/models/create_audience_request.py +122 -0
  107. rapidata/api_client/models/create_audience_result.py +87 -0
  108. rapidata/api_client/models/create_benchmark_model.py +87 -0
  109. rapidata/api_client/models/create_benchmark_participant_model.py +87 -0
  110. rapidata/api_client/models/create_benchmark_participant_result.py +89 -0
  111. rapidata/api_client/models/create_benchmark_prompt_result.py +87 -0
  112. rapidata/api_client/models/create_benchmark_result.py +87 -0
  113. rapidata/api_client/models/create_bridge_token_result.py +2 -2
  114. rapidata/api_client/models/create_client_model.py +6 -13
  115. rapidata/api_client/models/create_complex_order_model.py +9 -9
  116. rapidata/api_client/models/create_complex_order_result.py +6 -4
  117. rapidata/api_client/models/create_customer_client_result.py +89 -0
  118. rapidata/api_client/models/create_datapoint_model.py +124 -0
  119. rapidata/api_client/models/create_datapoint_model_asset.py +154 -0
  120. rapidata/api_client/models/create_datapoint_model_context_asset.py +160 -0
  121. rapidata/api_client/models/create_datapoint_model_metadata_inner.py +154 -0
  122. rapidata/api_client/models/create_datapoint_result.py +6 -18
  123. rapidata/api_client/models/create_dataset_endpoint_input.py +87 -0
  124. rapidata/api_client/models/create_dataset_endpoint_output.py +87 -0
  125. rapidata/api_client/models/create_demographic_rapid_model.py +45 -7
  126. rapidata/api_client/models/create_demographic_rapid_model_asset.py +160 -0
  127. rapidata/api_client/models/create_demographic_rapid_model_context_asset.py +160 -0
  128. rapidata/api_client/models/create_demographic_rapid_model_new.py +119 -0
  129. rapidata/api_client/models/create_empty_validation_set_result.py +2 -2
  130. rapidata/api_client/models/create_job_definition_endpoint_input.py +119 -0
  131. rapidata/api_client/models/create_job_definition_endpoint_output.py +89 -0
  132. rapidata/api_client/models/create_job_endpoint_input.py +100 -0
  133. rapidata/api_client/models/create_job_endpoint_output.py +89 -0
  134. rapidata/api_client/models/create_job_revision_endpoint_input.py +127 -0
  135. rapidata/api_client/models/create_job_revision_endpoint_output.py +89 -0
  136. rapidata/api_client/models/create_leaderboard_model.py +147 -0
  137. rapidata/api_client/models/create_leaderboard_participant_model.py +87 -0
  138. rapidata/api_client/models/create_leaderboard_participant_result.py +89 -0
  139. rapidata/api_client/models/create_leaderboard_result.py +99 -0
  140. rapidata/api_client/models/create_order_definition_model.py +119 -0
  141. rapidata/api_client/models/create_order_definition_result.py +87 -0
  142. rapidata/api_client/models/create_order_definition_revision_model.py +117 -0
  143. rapidata/api_client/models/create_order_definition_revision_result.py +87 -0
  144. rapidata/api_client/models/create_order_model.py +30 -103
  145. rapidata/api_client/models/create_order_model_referee.py +12 -12
  146. rapidata/api_client/models/create_order_model_workflow.py +35 -21
  147. rapidata/api_client/models/create_order_result.py +6 -4
  148. rapidata/api_client/models/create_rapid_result.py +2 -2
  149. rapidata/api_client/models/create_sample_model.py +93 -0
  150. rapidata/api_client/models/create_sample_model_asset.py +154 -0
  151. rapidata/api_client/models/create_sample_model_obsolete.py +87 -0
  152. rapidata/api_client/models/create_simple_pipeline_model_pipeline_steps_inner.py +8 -22
  153. rapidata/api_client/models/create_unsupported_order_model.py +6 -6
  154. rapidata/api_client/models/create_validation_set_model.py +5 -5
  155. rapidata/api_client/models/datapoint.py +3 -3
  156. rapidata/api_client/models/datapoint_metadata_model.py +3 -3
  157. rapidata/api_client/models/datapoint_model.py +3 -3
  158. rapidata/api_client/models/datapoint_model_paged_result.py +105 -0
  159. rapidata/api_client/models/datapoint_state.py +2 -2
  160. rapidata/api_client/models/dataset_dataset_id_datapoints_post_request_metadata_inner.py +182 -0
  161. rapidata/api_client/models/definition_type.py +49 -0
  162. rapidata/api_client/models/demographic_filter.py +100 -0
  163. rapidata/api_client/models/dynamic_client_registration_request.py +160 -0
  164. rapidata/api_client/models/early_stopping_referee_model.py +3 -3
  165. rapidata/api_client/models/effort_capped_selection.py +106 -0
  166. rapidata/api_client/models/elo_config.py +2 -2
  167. rapidata/api_client/models/elo_config_model.py +6 -6
  168. rapidata/api_client/models/entity_tag_header_value.py +93 -0
  169. rapidata/api_client/models/evaluation_workflow_config.py +13 -3
  170. rapidata/api_client/models/evaluation_workflow_model.py +16 -6
  171. rapidata/api_client/models/existing_asset_input.py +109 -0
  172. rapidata/api_client/models/existing_asset_input_metadata_value.py +126 -0
  173. rapidata/api_client/models/feature_flag.py +2 -2
  174. rapidata/api_client/models/feature_flag_model.py +6 -6
  175. rapidata/api_client/models/feedback_model.py +7 -7
  176. rapidata/api_client/models/file_asset.py +3 -5
  177. rapidata/api_client/models/file_asset_input.py +104 -0
  178. rapidata/api_client/models/file_asset_input1.py +104 -0
  179. rapidata/api_client/models/file_asset_input1_file.py +168 -0
  180. rapidata/api_client/models/file_asset_input2.py +104 -0
  181. rapidata/api_client/models/file_asset_input3.py +104 -0
  182. rapidata/api_client/models/file_asset_input_file.py +168 -0
  183. rapidata/api_client/models/file_asset_metadata_value.py +252 -0
  184. rapidata/api_client/models/file_asset_model.py +1 -3
  185. rapidata/api_client/models/file_asset_model_metadata_value.py +43 -73
  186. rapidata/api_client/models/file_stream_result.py +122 -0
  187. rapidata/api_client/models/file_type.py +39 -0
  188. rapidata/api_client/models/file_type_metadata.py +110 -0
  189. rapidata/api_client/models/file_type_metadata_model.py +97 -0
  190. rapidata/api_client/models/filter.py +7 -25
  191. rapidata/api_client/models/filter_operator.py +3 -2
  192. rapidata/api_client/models/fork_benchmark_result.py +87 -0
  193. rapidata/api_client/models/form_file_wrapper.py +135 -0
  194. rapidata/api_client/models/free_text_payload.py +10 -3
  195. rapidata/api_client/models/free_text_rapid_blueprint.py +10 -3
  196. rapidata/api_client/models/gender_user_filter_model.py +2 -2
  197. rapidata/api_client/models/gender_user_filter_model_gender.py +38 -0
  198. rapidata/api_client/models/get_asset_metadata_result.py +100 -0
  199. rapidata/api_client/models/get_audience_by_id_result.py +118 -0
  200. rapidata/api_client/models/get_audience_user_state_metrics_result.py +87 -0
  201. rapidata/api_client/models/get_available_validation_sets_result.py +2 -2
  202. rapidata/api_client/models/get_benchmark_by_id_query.py +96 -0
  203. rapidata/api_client/models/get_benchmark_by_id_query_result.py +94 -0
  204. rapidata/api_client/models/get_benchmark_by_id_query_result_paged_result.py +105 -0
  205. rapidata/api_client/models/get_benchmark_by_id_result.py +98 -0
  206. rapidata/api_client/models/get_boost_result.py +97 -0
  207. rapidata/api_client/models/get_boost_result_boost_mode.py +37 -0
  208. rapidata/api_client/models/get_boost_result_boost_status.py +39 -0
  209. rapidata/api_client/models/get_compare_ab_summary_result.py +5 -5
  210. rapidata/api_client/models/get_compare_workflow_results_model.py +7 -7
  211. rapidata/api_client/models/get_compare_workflow_results_result.py +5 -5
  212. rapidata/api_client/models/get_datapoint_by_id_result.py +10 -21
  213. rapidata/api_client/models/get_datapoint_by_id_result_asset.py +170 -0
  214. rapidata/api_client/models/get_dataset_by_id_result.py +2 -2
  215. rapidata/api_client/models/get_dataset_progress_result.py +2 -2
  216. rapidata/api_client/models/get_evaluation_workflow_results_model.py +119 -0
  217. rapidata/api_client/models/get_failed_datapoints_result.py +5 -5
  218. rapidata/api_client/models/get_failed_datapoints_result_datapoint.py +100 -0
  219. rapidata/api_client/models/get_file_metadata_result.py +100 -0
  220. rapidata/api_client/models/get_grouped_ranking_workflow_results_model.py +106 -0
  221. rapidata/api_client/models/get_grouped_ranking_workflow_results_result.py +97 -0
  222. rapidata/api_client/models/get_grouped_ranking_workflow_results_result_paged_result.py +105 -0
  223. rapidata/api_client/models/get_job_by_id_endpoint_output.py +130 -0
  224. rapidata/api_client/models/get_job_definition_by_id_endpoint_output.py +95 -0
  225. rapidata/api_client/models/get_job_revision_endpoint_output.py +133 -0
  226. rapidata/api_client/models/get_leaderboard_by_id_result.py +135 -0
  227. rapidata/api_client/models/get_order_by_id_result.py +12 -5
  228. rapidata/api_client/models/get_participant_by_id_result.py +91 -0
  229. rapidata/api_client/models/get_pipeline_by_id_result.py +5 -5
  230. rapidata/api_client/models/get_public_orders_result.py +2 -2
  231. rapidata/api_client/models/get_public_responses_result.py +95 -0
  232. rapidata/api_client/models/get_public_responses_result_response.py +112 -0
  233. rapidata/api_client/models/get_rapid_responses_result.py +6 -12
  234. rapidata/api_client/models/get_recommended_validation_set_result.py +95 -0
  235. rapidata/api_client/models/get_responses_for_rapid_result.py +106 -0
  236. rapidata/api_client/models/get_responses_for_rapid_result_response.py +103 -0
  237. rapidata/api_client/models/get_responses_for_rapid_result_response_result.py +266 -0
  238. rapidata/api_client/models/get_responses_result.py +5 -5
  239. rapidata/api_client/models/get_responses_result_response.py +103 -0
  240. rapidata/api_client/models/get_sample_by_id_result.py +125 -0
  241. rapidata/api_client/models/get_simple_workflow_results_model.py +20 -15
  242. rapidata/api_client/models/get_standing_by_id_result.py +96 -0
  243. rapidata/api_client/models/get_validation_rapids_result.py +33 -33
  244. rapidata/api_client/models/get_validation_rapids_result_truth.py +25 -11
  245. rapidata/api_client/models/get_validation_set_by_id_result.py +10 -4
  246. rapidata/api_client/models/get_workflow_by_id_result.py +5 -5
  247. rapidata/api_client/models/get_workflow_by_id_result_workflow.py +23 -9
  248. rapidata/api_client/models/get_workflow_progress_result.py +5 -11
  249. rapidata/api_client/models/get_workflow_results_result.py +34 -23
  250. rapidata/api_client/models/get_workflow_results_result_response.py +103 -0
  251. rapidata/api_client/models/google_one_tap_login_model.py +4 -4
  252. rapidata/api_client/models/grouped_ranking_workflow_config.py +155 -0
  253. rapidata/api_client/models/grouped_ranking_workflow_config_context_assets_value.py +170 -0
  254. rapidata/api_client/models/grouped_ranking_workflow_model.py +147 -0
  255. rapidata/api_client/models/grouped_ranking_workflow_model1.py +121 -0
  256. rapidata/api_client/models/i_artifact_model.py +182 -0
  257. rapidata/api_client/models/i_artifact_model_campaign_artifact_model.py +98 -0
  258. rapidata/api_client/models/i_artifact_model_dataset_artifact_model.py +98 -0
  259. rapidata/api_client/models/i_artifact_model_file_artifact_model.py +98 -0
  260. rapidata/api_client/models/i_artifact_model_workflow_artifact_model.py +98 -0
  261. rapidata/api_client/models/i_artifact_model_workflow_config_artifact_model.py +102 -0
  262. rapidata/api_client/models/i_asset.py +170 -0
  263. rapidata/api_client/models/i_asset_file_asset.py +111 -0
  264. rapidata/api_client/models/i_asset_input.py +156 -0
  265. rapidata/api_client/models/i_asset_input_existing_asset_input.py +118 -0
  266. rapidata/api_client/models/i_asset_input_multi_asset_input.py +128 -0
  267. rapidata/api_client/models/i_asset_input_text_asset_input.py +118 -0
  268. rapidata/api_client/models/i_asset_model.py +170 -0
  269. rapidata/api_client/models/i_asset_model_file_asset_model.py +113 -0
  270. rapidata/api_client/models/i_asset_model_multi_asset_model.py +123 -0
  271. rapidata/api_client/models/i_asset_model_null_asset_model.py +111 -0
  272. rapidata/api_client/models/i_asset_model_text_asset_model.py +113 -0
  273. rapidata/api_client/models/i_asset_multi_asset.py +121 -0
  274. rapidata/api_client/models/i_asset_null_asset.py +109 -0
  275. rapidata/api_client/models/i_asset_text_asset.py +111 -0
  276. rapidata/api_client/models/i_audience_filter.py +184 -0
  277. rapidata/api_client/models/i_audience_filter_and_audience_filter.py +106 -0
  278. rapidata/api_client/models/i_audience_filter_country_audience_filter.py +96 -0
  279. rapidata/api_client/models/i_audience_filter_country_filter.py +96 -0
  280. rapidata/api_client/models/i_audience_filter_language_audience_filter.py +96 -0
  281. rapidata/api_client/models/i_audience_filter_language_filter.py +96 -0
  282. rapidata/api_client/models/i_audience_filter_not_audience_filter.py +102 -0
  283. rapidata/api_client/models/i_audience_filter_or_audience_filter.py +106 -0
  284. rapidata/api_client/models/i_campaign_filter.py +296 -0
  285. rapidata/api_client/models/i_campaign_filter_and_filter.py +117 -0
  286. rapidata/api_client/models/i_campaign_filter_campaign_filter.py +98 -0
  287. rapidata/api_client/models/i_campaign_filter_campaign_session_count_filter.py +101 -0
  288. rapidata/api_client/models/i_campaign_filter_country_filter.py +98 -0
  289. rapidata/api_client/models/i_campaign_filter_demographic_filter.py +100 -0
  290. rapidata/api_client/models/i_campaign_filter_device_filter.py +106 -0
  291. rapidata/api_client/models/i_campaign_filter_language_filter.py +98 -0
  292. rapidata/api_client/models/i_campaign_filter_new_user_filter.py +96 -0
  293. rapidata/api_client/models/i_campaign_filter_not_filter.py +113 -0
  294. rapidata/api_client/models/i_campaign_filter_or_filter.py +117 -0
  295. rapidata/api_client/models/i_campaign_filter_response_count_filter.py +103 -0
  296. rapidata/api_client/models/i_campaign_filter_user_action_restriction_filter.py +106 -0
  297. rapidata/api_client/models/i_campaign_filter_user_score_filter.py +102 -0
  298. rapidata/api_client/models/i_campaign_filter_user_state_filter.py +106 -0
  299. rapidata/api_client/models/i_dataset_metadata_input.py +154 -0
  300. rapidata/api_client/models/i_dataset_metadata_input_prompt_asset_metadata_input.py +100 -0
  301. rapidata/api_client/models/i_dataset_metadata_input_prompt_metadata_input.py +96 -0
  302. rapidata/api_client/models/i_dataset_metadata_input_transcription_metadata_input.py +96 -0
  303. rapidata/api_client/models/i_dataset_model.py +126 -0
  304. rapidata/api_client/models/i_dataset_model_clone_dataset_model.py +98 -0
  305. rapidata/api_client/models/i_metadata.py +252 -0
  306. rapidata/api_client/models/i_metadata_classification_metadata.py +109 -0
  307. rapidata/api_client/models/i_metadata_count_metadata.py +109 -0
  308. rapidata/api_client/models/i_metadata_duration_metadata.py +110 -0
  309. rapidata/api_client/models/i_metadata_file_type_metadata.py +110 -0
  310. rapidata/api_client/models/i_metadata_image_dimension_metadata.py +111 -0
  311. rapidata/api_client/models/i_metadata_input.py +126 -0
  312. rapidata/api_client/models/i_metadata_input_text_metadata_input.py +111 -0
  313. rapidata/api_client/models/i_metadata_location_metadata.py +111 -0
  314. rapidata/api_client/models/i_metadata_model.py +252 -0
  315. rapidata/api_client/models/i_metadata_model_classification_metadata_model.py +96 -0
  316. rapidata/api_client/models/i_metadata_model_count_metadata_model.py +96 -0
  317. rapidata/api_client/models/i_metadata_model_file_type_metadata_model.py +97 -0
  318. rapidata/api_client/models/i_metadata_model_image_dimension_metadata_model.py +98 -0
  319. rapidata/api_client/models/i_metadata_model_location_metadata_model.py +98 -0
  320. rapidata/api_client/models/i_metadata_model_original_filename_metadata_model.py +96 -0
  321. rapidata/api_client/models/i_metadata_model_source_url_metadata_model.py +96 -0
  322. rapidata/api_client/models/i_metadata_model_streams_metadata_model.py +100 -0
  323. rapidata/api_client/models/i_metadata_model_text_metadata_model.py +101 -0
  324. rapidata/api_client/models/i_metadata_model_video_duration_metadata_model.py +97 -0
  325. rapidata/api_client/models/i_metadata_original_filename_metadata.py +109 -0
  326. rapidata/api_client/models/i_metadata_source_url_metadata.py +109 -0
  327. rapidata/api_client/models/i_metadata_streams_metadata.py +113 -0
  328. rapidata/api_client/models/i_metadata_text_metadata.py +114 -0
  329. rapidata/api_client/models/i_metadata_video_duration_metadata.py +110 -0
  330. rapidata/api_client/models/i_order_workflow_model.py +168 -0
  331. rapidata/api_client/models/i_order_workflow_model_compare_workflow_model.py +146 -0
  332. rapidata/api_client/models/i_order_workflow_model_evaluation_workflow_model.py +108 -0
  333. rapidata/api_client/models/i_order_workflow_model_grouped_ranking_workflow_model.py +147 -0
  334. rapidata/api_client/models/i_order_workflow_model_simple_workflow_model.py +110 -0
  335. rapidata/api_client/models/i_pair_maker_config.py +126 -0
  336. rapidata/api_client/models/i_pair_maker_config_model.py +126 -0
  337. rapidata/api_client/models/i_pair_maker_config_model_online_pair_maker_config_model.py +98 -0
  338. rapidata/api_client/models/i_pair_maker_config_online_pair_maker_config.py +98 -0
  339. rapidata/api_client/models/i_pair_maker_information.py +126 -0
  340. rapidata/api_client/models/i_pair_maker_information_online_pair_maker_information.py +100 -0
  341. rapidata/api_client/models/i_pipeline_artifact_model.py +126 -0
  342. rapidata/api_client/models/i_pipeline_artifact_model_create_dataset_artifact_model.py +102 -0
  343. rapidata/api_client/models/i_pipeline_model.py +126 -0
  344. rapidata/api_client/models/i_pipeline_model_create_simple_pipeline_model.py +116 -0
  345. rapidata/api_client/models/i_pipeline_step_model.py +168 -0
  346. rapidata/api_client/models/i_pipeline_step_model_dataset_evaluation_step_model.py +102 -0
  347. rapidata/api_client/models/i_pipeline_step_model_send_completion_mail_step_model.py +98 -0
  348. rapidata/api_client/models/i_pipeline_step_model_workflow_aggregation_step_model.py +103 -0
  349. rapidata/api_client/models/i_pipeline_step_model_workflow_labeling_step_model.py +96 -0
  350. rapidata/api_client/models/i_rapid_blueprint.py +252 -0
  351. rapidata/api_client/models/i_rapid_blueprint_attach_category_rapid_blueprint.py +108 -0
  352. rapidata/api_client/models/i_rapid_blueprint_bounding_box_rapid_blueprint.py +96 -0
  353. rapidata/api_client/models/i_rapid_blueprint_compare_rapid_blueprint.py +98 -0
  354. rapidata/api_client/models/i_rapid_blueprint_free_text_rapid_blueprint.py +105 -0
  355. rapidata/api_client/models/i_rapid_blueprint_line_rapid_blueprint.py +96 -0
  356. rapidata/api_client/models/i_rapid_blueprint_locate_rapid_blueprint.py +96 -0
  357. rapidata/api_client/models/i_rapid_blueprint_named_entity_rapid_blueprint.py +98 -0
  358. rapidata/api_client/models/i_rapid_blueprint_polygon_rapid_blueprint.py +96 -0
  359. rapidata/api_client/models/i_rapid_blueprint_scrub_rapid_blueprint.py +96 -0
  360. rapidata/api_client/models/i_rapid_blueprint_transcription_rapid_blueprint.py +96 -0
  361. rapidata/api_client/models/i_rapid_payload.py +252 -0
  362. rapidata/api_client/models/i_rapid_payload_bounding_box_payload.py +96 -0
  363. rapidata/api_client/models/i_rapid_payload_classify_payload.py +106 -0
  364. rapidata/api_client/models/i_rapid_payload_compare_payload.py +96 -0
  365. rapidata/api_client/models/i_rapid_payload_free_text_payload.py +105 -0
  366. rapidata/api_client/models/i_rapid_payload_line_payload.py +96 -0
  367. rapidata/api_client/models/i_rapid_payload_locate_payload.py +96 -0
  368. rapidata/api_client/models/i_rapid_payload_named_entity_payload.py +98 -0
  369. rapidata/api_client/models/i_rapid_payload_polygon_payload.py +96 -0
  370. rapidata/api_client/models/i_rapid_payload_scrub_payload.py +96 -0
  371. rapidata/api_client/models/i_rapid_payload_transcription_payload.py +106 -0
  372. rapidata/api_client/models/i_rapid_result.py +266 -0
  373. rapidata/api_client/models/i_rapid_result_attach_category_result.py +98 -0
  374. rapidata/api_client/models/i_rapid_result_bounding_box_result.py +106 -0
  375. rapidata/api_client/models/i_rapid_result_compare_result.py +98 -0
  376. rapidata/api_client/models/i_rapid_result_free_text_result.py +98 -0
  377. rapidata/api_client/models/i_rapid_result_line_result.py +106 -0
  378. rapidata/api_client/models/i_rapid_result_locate_result.py +106 -0
  379. rapidata/api_client/models/i_rapid_result_named_entity_result.py +106 -0
  380. rapidata/api_client/models/i_rapid_result_polygon_result.py +106 -0
  381. rapidata/api_client/models/i_rapid_result_scrub_result.py +98 -0
  382. rapidata/api_client/models/i_rapid_result_skip_result.py +96 -0
  383. rapidata/api_client/models/i_rapid_result_transcription_result.py +106 -0
  384. rapidata/api_client/models/i_referee_config.py +154 -0
  385. rapidata/api_client/models/i_referee_config_naive_referee_config.py +96 -0
  386. rapidata/api_client/models/i_referee_config_never_ending_referee_config.py +94 -0
  387. rapidata/api_client/models/i_referee_config_probabilistic_attach_category_referee_config.py +98 -0
  388. rapidata/api_client/models/i_referee_info.py +154 -0
  389. rapidata/api_client/models/i_referee_info_naive_referee_info.py +96 -0
  390. rapidata/api_client/models/i_referee_info_never_ending_referee_info.py +94 -0
  391. rapidata/api_client/models/i_referee_info_probabilistic_attach_category_referee_info.py +98 -0
  392. rapidata/api_client/models/i_referee_model.py +140 -0
  393. rapidata/api_client/models/i_referee_model_early_stopping_referee_model.py +98 -0
  394. rapidata/api_client/models/i_referee_model_naive_referee_model.py +96 -0
  395. rapidata/api_client/models/i_selection.py +240 -0
  396. rapidata/api_client/models/i_selection_ab_test_selection.py +122 -0
  397. rapidata/api_client/models/i_selection_capped_selection.py +108 -0
  398. rapidata/api_client/models/i_selection_conditional_validation_selection.py +110 -0
  399. rapidata/api_client/models/i_selection_demographic_selection.py +98 -0
  400. rapidata/api_client/models/i_selection_effort_capped_selection.py +101 -0
  401. rapidata/api_client/models/i_selection_labeling_selection.py +103 -0
  402. rapidata/api_client/models/i_selection_shuffling_selection.py +106 -0
  403. rapidata/api_client/models/i_selection_static_selection.py +96 -0
  404. rapidata/api_client/models/i_selection_validation_selection.py +98 -0
  405. rapidata/api_client/models/i_user_filter_model.py +296 -0
  406. rapidata/api_client/models/i_user_filter_model_age_user_filter_model.py +104 -0
  407. rapidata/api_client/models/i_user_filter_model_and_user_filter_model.py +106 -0
  408. rapidata/api_client/models/i_user_filter_model_campaign_user_filter_model.py +96 -0
  409. rapidata/api_client/models/i_user_filter_model_country_user_filter_model.py +96 -0
  410. rapidata/api_client/models/i_user_filter_model_custom_user_filter_model.py +98 -0
  411. rapidata/api_client/models/i_user_filter_model_device_user_filter_model.py +104 -0
  412. rapidata/api_client/models/i_user_filter_model_gender_user_filter_model.py +104 -0
  413. rapidata/api_client/models/i_user_filter_model_language_user_filter_model.py +96 -0
  414. rapidata/api_client/models/i_user_filter_model_new_user_filter_model.py +94 -0
  415. rapidata/api_client/models/i_user_filter_model_not_user_filter_model.py +102 -0
  416. rapidata/api_client/models/i_user_filter_model_or_user_filter_model.py +106 -0
  417. rapidata/api_client/models/i_user_filter_model_response_count_user_filter_model.py +101 -0
  418. rapidata/api_client/models/i_user_filter_model_user_score_user_filter_model.py +105 -0
  419. rapidata/api_client/models/i_validation_metadata_input.py +140 -0
  420. rapidata/api_client/models/i_validation_metadata_input_prompt_asset_metadata_input.py +100 -0
  421. rapidata/api_client/models/i_validation_metadata_input_prompt_metadata_input.py +96 -0
  422. rapidata/api_client/models/i_validation_truth.py +280 -0
  423. rapidata/api_client/models/i_validation_truth_attach_category_truth.py +96 -0
  424. rapidata/api_client/models/i_validation_truth_bounding_box_truth.py +102 -0
  425. rapidata/api_client/models/i_validation_truth_compare_truth.py +96 -0
  426. rapidata/api_client/models/i_validation_truth_empty_validation_truth.py +94 -0
  427. rapidata/api_client/models/i_validation_truth_line_truth.py +94 -0
  428. rapidata/api_client/models/i_validation_truth_locate_box_truth.py +108 -0
  429. rapidata/api_client/models/i_validation_truth_model.py +294 -0
  430. rapidata/api_client/models/i_validation_truth_model_attach_category_truth_model.py +96 -0
  431. rapidata/api_client/models/i_validation_truth_model_bounding_box_truth_model.py +102 -0
  432. rapidata/api_client/models/i_validation_truth_model_classify_truth_model.py +96 -0
  433. rapidata/api_client/models/i_validation_truth_model_compare_truth_model.py +96 -0
  434. rapidata/api_client/models/i_validation_truth_model_empty_validation_truth_model.py +94 -0
  435. rapidata/api_client/models/i_validation_truth_model_line_truth_model.py +94 -0
  436. rapidata/api_client/models/i_validation_truth_model_locate_box_truth_model.py +108 -0
  437. rapidata/api_client/models/i_validation_truth_model_multi_compare_truth_model.py +96 -0
  438. rapidata/api_client/models/i_validation_truth_model_named_entity_truth_model.py +104 -0
  439. rapidata/api_client/models/i_validation_truth_model_polygon_truth_model.py +94 -0
  440. rapidata/api_client/models/i_validation_truth_model_scrub_truth_model.py +104 -0
  441. rapidata/api_client/models/i_validation_truth_model_skip_truth_model.py +94 -0
  442. rapidata/api_client/models/i_validation_truth_model_transcription_truth_model.py +115 -0
  443. rapidata/api_client/models/i_validation_truth_multi_compare_truth.py +96 -0
  444. rapidata/api_client/models/i_validation_truth_named_entity_truth.py +104 -0
  445. rapidata/api_client/models/i_validation_truth_polygon_truth.py +94 -0
  446. rapidata/api_client/models/i_validation_truth_scrub_truth.py +104 -0
  447. rapidata/api_client/models/i_validation_truth_skip_truth.py +94 -0
  448. rapidata/api_client/models/i_validation_truth_transcription_truth.py +115 -0
  449. rapidata/api_client/models/i_workflow_config.py +168 -0
  450. rapidata/api_client/models/i_workflow_config_compare_workflow_config.py +142 -0
  451. rapidata/api_client/models/i_workflow_config_evaluation_workflow_config.py +114 -0
  452. rapidata/api_client/models/i_workflow_config_grouped_ranking_workflow_config.py +155 -0
  453. rapidata/api_client/models/i_workflow_config_simple_workflow_config.py +116 -0
  454. rapidata/api_client/models/i_workflow_model.py +168 -0
  455. rapidata/api_client/models/i_workflow_model_compare_workflow_model.py +145 -0
  456. rapidata/api_client/models/i_workflow_model_evaluation_workflow_model.py +115 -0
  457. rapidata/api_client/models/i_workflow_model_grouped_ranking_workflow_model.py +121 -0
  458. rapidata/api_client/models/i_workflow_model_simple_workflow_model.py +119 -0
  459. rapidata/api_client/models/image_dimension_metadata.py +12 -1
  460. rapidata/api_client/models/inquire_file_metadata_result.py +100 -0
  461. rapidata/api_client/models/inspect_report_result.py +2 -2
  462. rapidata/api_client/models/job_definition_revision_state.py +38 -0
  463. rapidata/api_client/models/json_web_key.py +224 -0
  464. rapidata/api_client/models/json_web_key_set.py +95 -0
  465. rapidata/api_client/models/labeling_selection.py +11 -13
  466. rapidata/api_client/models/language_filter.py +98 -0
  467. rapidata/api_client/models/leaderboard_query_result.py +135 -0
  468. rapidata/api_client/models/leaderboard_query_result_paged_result.py +105 -0
  469. rapidata/api_client/models/leaderboards_query_result.py +135 -0
  470. rapidata/api_client/models/line_result.py +3 -3
  471. rapidata/api_client/models/line_result_line.py +97 -0
  472. rapidata/api_client/models/line_result_line_point.py +89 -0
  473. rapidata/api_client/models/local_file_wrapper.py +120 -0
  474. rapidata/api_client/models/locate_coordinate.py +4 -13
  475. rapidata/api_client/models/location_metadata.py +12 -1
  476. rapidata/api_client/models/logic_operator.py +2 -2
  477. rapidata/api_client/models/metadata_i_order_metadata_input.py +154 -0
  478. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_asset_metadata_input.py +100 -0
  479. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_metadata_input.py +96 -0
  480. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_transcription_metadata_input.py +96 -0
  481. rapidata/api_client/models/metadata_prompt_asset_metadata_input.py +100 -0
  482. rapidata/api_client/models/metadata_prompt_metadata_input.py +96 -0
  483. rapidata/api_client/models/metadata_transcription_metadata_input.py +96 -0
  484. rapidata/api_client/models/multi_asset.py +6 -6
  485. rapidata/api_client/models/multi_asset_assets_inner.py +170 -0
  486. rapidata/api_client/models/multi_asset_input.py +130 -0
  487. rapidata/api_client/models/multi_asset_input1.py +110 -0
  488. rapidata/api_client/models/multi_asset_input1_assets_inner.py +198 -0
  489. rapidata/api_client/models/multi_asset_input2.py +110 -0
  490. rapidata/api_client/models/multi_asset_input3.py +110 -0
  491. rapidata/api_client/models/multi_asset_input3_assets_inner.py +198 -0
  492. rapidata/api_client/models/multi_asset_input_assets_inner.py +156 -0
  493. rapidata/api_client/models/multi_asset_model.py +4 -4
  494. rapidata/api_client/models/multi_compare_truth.py +96 -0
  495. rapidata/api_client/models/naive_referee_info.py +96 -0
  496. rapidata/api_client/models/naive_referee_model.py +2 -2
  497. rapidata/api_client/models/named_classification.py +4 -13
  498. rapidata/api_client/models/never_ending_referee_info.py +94 -0
  499. rapidata/api_client/models/new_user_filter.py +96 -0
  500. rapidata/api_client/models/newsletter_model.py +6 -6
  501. rapidata/api_client/models/not_available_yet_result.py +4 -13
  502. rapidata/api_client/models/not_filter.py +117 -0
  503. rapidata/api_client/models/not_user_filter_model.py +3 -3
  504. rapidata/api_client/models/null_asset.py +3 -5
  505. rapidata/api_client/models/null_asset_model.py +1 -3
  506. rapidata/api_client/models/online_pair_maker_config_model.py +3 -3
  507. rapidata/api_client/models/option_of_aggregator_type.py +49 -0
  508. rapidata/api_client/models/or_filter.py +121 -0
  509. rapidata/api_client/models/or_user_filter_model.py +3 -3
  510. rapidata/api_client/models/order_model.py +15 -14
  511. rapidata/api_client/models/order_state.py +2 -2
  512. rapidata/api_client/models/original_filename_metadata.py +12 -1
  513. rapidata/api_client/models/page_info.py +2 -7
  514. rapidata/api_client/models/paged_result_aggregated_orders_model.py +105 -0
  515. rapidata/api_client/models/paged_result_benchmark_query_result.py +105 -0
  516. rapidata/api_client/models/paged_result_campaign_query_result.py +105 -0
  517. rapidata/api_client/models/paged_result_clients_query_result.py +105 -0
  518. rapidata/api_client/models/paged_result_datapoint_model.py +105 -0
  519. rapidata/api_client/models/paged_result_get_compare_workflow_results_result.py +105 -0
  520. rapidata/api_client/models/paged_result_get_grouped_ranking_workflow_results_result.py +105 -0
  521. rapidata/api_client/models/paged_result_get_validation_rapids_result.py +105 -0
  522. rapidata/api_client/models/paged_result_get_workflow_results_result.py +105 -0
  523. rapidata/api_client/models/paged_result_i_workflow_model.py +105 -0
  524. rapidata/api_client/models/paged_result_leaderboard_query_result.py +105 -0
  525. rapidata/api_client/models/paged_result_leaderboards_query_result.py +105 -0
  526. rapidata/api_client/models/paged_result_of_aggregated_orders_model.py +103 -0
  527. rapidata/api_client/models/paged_result_of_benchmark_query_result.py +103 -0
  528. rapidata/api_client/models/paged_result_of_campaign_query_result.py +103 -0
  529. rapidata/api_client/models/paged_result_of_clients_query_result.py +103 -0
  530. rapidata/api_client/models/paged_result_of_get_compare_workflow_results_result.py +103 -0
  531. rapidata/api_client/models/paged_result_of_get_grouped_ranking_workflow_results_result.py +103 -0
  532. rapidata/api_client/models/paged_result_of_get_validation_rapids_result.py +103 -0
  533. rapidata/api_client/models/paged_result_of_get_workflow_results_result.py +103 -0
  534. rapidata/api_client/models/paged_result_of_i_workflow_model.py +103 -0
  535. rapidata/api_client/models/paged_result_of_leaderboards_query_result.py +103 -0
  536. rapidata/api_client/models/paged_result_of_order_model.py +103 -0
  537. rapidata/api_client/models/paged_result_of_participant_by_benchmark.py +103 -0
  538. rapidata/api_client/models/paged_result_of_prompt_by_benchmark_result.py +103 -0
  539. rapidata/api_client/models/paged_result_of_query_audiences_result.py +103 -0
  540. rapidata/api_client/models/paged_result_of_query_datapoints_by_dataset_id_result.py +103 -0
  541. rapidata/api_client/models/paged_result_of_query_job_definitions_result.py +103 -0
  542. rapidata/api_client/models/paged_result_of_query_job_revisions_result.py +103 -0
  543. rapidata/api_client/models/paged_result_of_query_jobs_result.py +103 -0
  544. rapidata/api_client/models/paged_result_of_query_rapids_for_audience_result.py +103 -0
  545. rapidata/api_client/models/paged_result_of_query_validation_rapid_eligibility_result.py +103 -0
  546. rapidata/api_client/models/paged_result_of_rapid_model.py +103 -0
  547. rapidata/api_client/models/paged_result_of_runs_by_leaderboard_result.py +103 -0
  548. rapidata/api_client/models/paged_result_of_sample_by_identifier.py +103 -0
  549. rapidata/api_client/models/paged_result_of_sample_by_participant.py +103 -0
  550. rapidata/api_client/models/paged_result_of_standing_by_leaderboard.py +103 -0
  551. rapidata/api_client/models/paged_result_of_validation_set_model.py +103 -0
  552. rapidata/api_client/models/paged_result_order_model.py +105 -0
  553. rapidata/api_client/models/paged_result_participant_by_benchmark.py +105 -0
  554. rapidata/api_client/models/paged_result_potential_validation_rapid.py +105 -0
  555. rapidata/api_client/models/paged_result_prompt_by_benchmark_result.py +105 -0
  556. rapidata/api_client/models/paged_result_query_audiences_result.py +105 -0
  557. rapidata/api_client/models/paged_result_query_datapoints_by_dataset_id_result.py +105 -0
  558. rapidata/api_client/models/paged_result_query_validation_rapid_eligibility_result.py +105 -0
  559. rapidata/api_client/models/paged_result_rapid_model.py +105 -0
  560. rapidata/api_client/models/paged_result_runs_by_leaderboard_result.py +105 -0
  561. rapidata/api_client/models/paged_result_sample_by_identifier.py +105 -0
  562. rapidata/api_client/models/paged_result_sample_by_participant.py +105 -0
  563. rapidata/api_client/models/paged_result_standing_by_leaderboard.py +105 -0
  564. rapidata/api_client/models/paged_result_validation_set_model.py +105 -0
  565. rapidata/api_client/models/participant_by_benchmark.py +94 -0
  566. rapidata/api_client/models/participant_by_benchmark_paged_result.py +105 -0
  567. rapidata/api_client/models/participant_by_leaderboard.py +113 -0
  568. rapidata/api_client/models/participant_by_leaderboard_paged_result.py +105 -0
  569. rapidata/api_client/models/participant_status.py +38 -0
  570. rapidata/api_client/models/pipeline_id_workflow_config_put_request.py +140 -0
  571. rapidata/api_client/models/polygon_result.py +3 -3
  572. rapidata/api_client/models/polygon_result_coordinate.py +89 -0
  573. rapidata/api_client/models/polygon_result_shape.py +95 -0
  574. rapidata/api_client/models/potential_validation_rapid.py +103 -0
  575. rapidata/api_client/models/potential_validation_rapid_paged_result.py +105 -0
  576. rapidata/api_client/models/potential_validation_rapid_truth.py +280 -0
  577. rapidata/api_client/models/preliminary_download_model.py +5 -5
  578. rapidata/api_client/models/preview_order_model.py +92 -0
  579. rapidata/api_client/models/probabilistic_attach_category_referee_info.py +98 -0
  580. rapidata/api_client/models/problem_details.py +2 -20
  581. rapidata/api_client/models/prompt_asset_metadata_input.py +6 -8
  582. rapidata/api_client/models/prompt_asset_metadata_input_asset.py +154 -0
  583. rapidata/api_client/models/prompt_by_benchmark_result.py +112 -0
  584. rapidata/api_client/models/prompt_by_benchmark_result_paged_result.py +105 -0
  585. rapidata/api_client/models/prompt_by_leaderboard_result.py +90 -0
  586. rapidata/api_client/models/prompt_by_leaderboard_result_paged_result.py +105 -0
  587. rapidata/api_client/models/prompt_metadata.py +12 -1
  588. rapidata/api_client/models/prompt_metadata_input.py +2 -2
  589. rapidata/api_client/models/prompt_type.py +38 -0
  590. rapidata/api_client/models/proxy_file_wrapper.py +129 -0
  591. rapidata/api_client/models/public_order_model.py +2 -2
  592. rapidata/api_client/models/public_rapid_response.py +112 -0
  593. rapidata/api_client/models/query_audiences_result.py +118 -0
  594. rapidata/api_client/models/query_datapoints_by_dataset_id_result.py +95 -0
  595. rapidata/api_client/models/query_job_definitions_result.py +97 -0
  596. rapidata/api_client/models/query_job_revisions_result.py +95 -0
  597. rapidata/api_client/models/query_jobs_result.py +103 -0
  598. rapidata/api_client/models/query_model.py +10 -5
  599. rapidata/api_client/models/query_rapids_for_audience_result.py +150 -0
  600. rapidata/api_client/models/query_validation_model.py +97 -0
  601. rapidata/api_client/models/query_validation_rapid_eligibility_model_query_validation_model.py +107 -0
  602. rapidata/api_client/models/query_validation_rapid_eligibility_result.py +103 -0
  603. rapidata/api_client/models/query_validation_rapid_eligibility_result_truth.py +280 -0
  604. rapidata/api_client/models/rapid_issue.py +2 -2
  605. rapidata/api_client/models/rapid_modality.py +46 -0
  606. rapidata/api_client/models/rapid_model.py +157 -0
  607. rapidata/api_client/models/rapid_model_paged_result.py +105 -0
  608. rapidata/api_client/models/rapid_model_referee.py +154 -0
  609. rapidata/api_client/models/rapid_result_model.py +7 -7
  610. rapidata/api_client/models/rapid_skipped_model.py +5 -5
  611. rapidata/api_client/models/rapid_state.py +3 -2
  612. rapidata/api_client/models/read_bridge_token_keys_result.py +10 -24
  613. rapidata/api_client/models/reference_asset_input.py +100 -0
  614. rapidata/api_client/models/report_model.py +9 -15
  615. rapidata/api_client/models/response_count_filter.py +103 -0
  616. rapidata/api_client/models/response_count_user_filter_model.py +2 -8
  617. rapidata/api_client/models/retrieval_mode.py +2 -2
  618. rapidata/api_client/models/root_filter.py +5 -14
  619. rapidata/api_client/models/run_status.py +39 -0
  620. rapidata/api_client/models/runs_by_leaderboard_result.py +104 -0
  621. rapidata/api_client/models/runs_by_leaderboard_result_paged_result.py +105 -0
  622. rapidata/api_client/models/sample_by_identifier.py +125 -0
  623. rapidata/api_client/models/sample_by_identifier_paged_result.py +105 -0
  624. rapidata/api_client/models/sample_by_participant.py +121 -0
  625. rapidata/api_client/models/sample_by_participant_paged_result.py +105 -0
  626. rapidata/api_client/models/scrub_range.py +2 -2
  627. rapidata/api_client/models/send_survey_model.py +87 -0
  628. rapidata/api_client/models/simple_workflow_config.py +15 -7
  629. rapidata/api_client/models/simple_workflow_config_blueprint.py +37 -23
  630. rapidata/api_client/models/simple_workflow_config_model.py +11 -3
  631. rapidata/api_client/models/simple_workflow_model.py +14 -4
  632. rapidata/api_client/models/simple_workflow_model1.py +4 -11
  633. rapidata/api_client/models/simple_workflow_model_blueprint.py +1 -1
  634. rapidata/api_client/models/sort_criterion.py +5 -11
  635. rapidata/api_client/models/sort_direction.py +2 -2
  636. rapidata/api_client/models/source_url_metadata.py +12 -1
  637. rapidata/api_client/models/standing_by_benchmark.py +113 -0
  638. rapidata/api_client/models/standing_by_leaderboard.py +113 -0
  639. rapidata/api_client/models/standing_by_leaderboard_paged_result.py +105 -0
  640. rapidata/api_client/models/standing_status.py +38 -0
  641. rapidata/api_client/models/standings_by_benchmark_result.py +95 -0
  642. rapidata/api_client/models/standings_by_leaderboard_result.py +95 -0
  643. rapidata/api_client/models/start_preliminary_download_result.py +87 -0
  644. rapidata/api_client/models/sticky_state.py +3 -2
  645. rapidata/api_client/models/stream_file_wrapper.py +138 -0
  646. rapidata/api_client/models/streams_metadata.py +113 -0
  647. rapidata/api_client/models/streams_metadata_model.py +100 -0
  648. rapidata/api_client/models/string_segment.py +105 -0
  649. rapidata/api_client/models/submit_coco_model.py +1 -3
  650. rapidata/api_client/models/submit_order_model.py +92 -0
  651. rapidata/api_client/models/submit_participant_result.py +89 -0
  652. rapidata/api_client/models/submit_prompt_model.py +107 -0
  653. rapidata/api_client/models/submit_prompt_model_prompt_asset.py +202 -0
  654. rapidata/api_client/models/tags_by_benchmark_result.py +87 -0
  655. rapidata/api_client/models/text_asset.py +3 -5
  656. rapidata/api_client/models/text_asset_input.py +120 -0
  657. rapidata/api_client/models/text_asset_model.py +1 -3
  658. rapidata/api_client/models/text_metadata.py +18 -2
  659. rapidata/api_client/models/text_metadata_input.py +111 -0
  660. rapidata/api_client/models/text_metadata_model.py +7 -2
  661. rapidata/api_client/models/transcription_metadata.py +9 -1
  662. rapidata/api_client/models/transcription_metadata_input.py +2 -2
  663. rapidata/api_client/models/transcription_word.py +2 -2
  664. rapidata/api_client/models/translated_string.py +2 -2
  665. rapidata/api_client/models/unlock_order_result.py +2 -2
  666. rapidata/api_client/models/update_access_model.py +1 -1
  667. rapidata/api_client/models/update_audience_request.py +113 -0
  668. rapidata/api_client/models/update_benchmark_model.py +99 -0
  669. rapidata/api_client/models/update_benchmark_name_model.py +87 -0
  670. rapidata/api_client/models/update_campaign_model.py +11 -11
  671. rapidata/api_client/models/update_dataset_name_model.py +5 -5
  672. rapidata/api_client/models/update_dimensions_model.py +3 -3
  673. rapidata/api_client/models/update_job_definition_endpoint_input.py +92 -0
  674. rapidata/api_client/models/update_job_endpoint_input.py +92 -0
  675. rapidata/api_client/models/update_leaderboard_model.py +106 -0
  676. rapidata/api_client/models/update_leaderboard_name_model.py +87 -0
  677. rapidata/api_client/models/update_leaderboard_response_config_model.py +89 -0
  678. rapidata/api_client/models/update_order_name_model.py +5 -5
  679. rapidata/api_client/models/update_participant_model.py +92 -0
  680. rapidata/api_client/models/update_participant_name_model.py +87 -0
  681. rapidata/api_client/models/update_priority_model.py +87 -0
  682. rapidata/api_client/models/update_prompt_tags_model.py +87 -0
  683. rapidata/api_client/models/update_should_alert_model.py +87 -0
  684. rapidata/api_client/models/update_validation_rapid_model.py +28 -12
  685. rapidata/api_client/models/update_validation_rapid_model_context_asset.py +160 -0
  686. rapidata/api_client/models/update_validation_rapid_model_truth.py +26 -12
  687. rapidata/api_client/models/update_validation_set_model.py +120 -0
  688. rapidata/api_client/models/upload_asset_result.py +102 -0
  689. rapidata/api_client/models/upload_file_from_url_result.py +87 -0
  690. rapidata/api_client/models/upload_file_result.py +87 -0
  691. rapidata/api_client/models/upload_files_from_s3_bucket_model.py +12 -2
  692. rapidata/api_client/models/upload_text_sources_to_dataset_model.py +3 -3
  693. rapidata/api_client/models/user_action_restriction.py +37 -0
  694. rapidata/api_client/models/user_action_restriction_filter.py +101 -0
  695. rapidata/api_client/models/user_score_filter.py +102 -0
  696. rapidata/api_client/models/user_state.py +38 -0
  697. rapidata/api_client/models/user_state_filter.py +101 -0
  698. rapidata/api_client/models/validation_chance.py +20 -3
  699. rapidata/api_client/models/validation_problem_details.py +117 -0
  700. rapidata/api_client/models/validation_set_model.py +39 -5
  701. rapidata/api_client/models/validation_set_overview_model.py +2 -2
  702. rapidata/api_client/models/validation_set_validation_set_id_rapid_post_payload_parameter.py +252 -0
  703. rapidata/api_client/models/validation_set_validation_set_id_rapid_post_truth_parameter.py +280 -0
  704. rapidata/api_client/models/validation_set_zip_post_request_blueprint.py +252 -0
  705. rapidata/api_client/models/video_duration_metadata.py +109 -0
  706. rapidata/api_client/models/video_duration_metadata_model.py +96 -0
  707. rapidata/api_client/models/vote_matrix_result.py +91 -0
  708. rapidata/api_client/models/workflow_aggregation_step_model.py +3 -12
  709. rapidata/api_client/models/workflow_config_artifact_model_workflow_config.py +23 -9
  710. rapidata/api_client/models/workflow_state.py +2 -2
  711. rapidata/api_client/models/zip_entry_file_wrapper.py +151 -0
  712. rapidata/api_client/rest.py +2 -2
  713. rapidata/api_client_README.md +468 -317
  714. rapidata/rapidata_client/__init__.py +23 -22
  715. rapidata/rapidata_client/api/rapidata_api_client.py +253 -0
  716. rapidata/rapidata_client/audience/__init__.py +2 -0
  717. rapidata/rapidata_client/audience/audience_example_handler.py +168 -0
  718. rapidata/rapidata_client/audience/rapidata_audience.py +287 -0
  719. rapidata/rapidata_client/audience/rapidata_audience_manager.py +162 -0
  720. rapidata/rapidata_client/benchmark/__init__.py +0 -0
  721. rapidata/rapidata_client/benchmark/_detail_mapper.py +34 -0
  722. rapidata/rapidata_client/benchmark/leaderboard/__init__.py +0 -0
  723. rapidata/rapidata_client/benchmark/leaderboard/rapidata_leaderboard.py +257 -0
  724. rapidata/rapidata_client/benchmark/participant/__init__.py +0 -0
  725. rapidata/rapidata_client/benchmark/participant/_participant.py +146 -0
  726. rapidata/rapidata_client/benchmark/rapidata_benchmark.py +592 -0
  727. rapidata/rapidata_client/benchmark/rapidata_benchmark_manager.py +216 -0
  728. rapidata/rapidata_client/config/__init__.py +4 -0
  729. rapidata/rapidata_client/config/logger.py +135 -0
  730. rapidata/rapidata_client/config/logging_config.py +55 -0
  731. rapidata/rapidata_client/config/managed_print.py +6 -0
  732. rapidata/rapidata_client/config/order_config.py +14 -0
  733. rapidata/rapidata_client/config/rapidata_config.py +36 -0
  734. rapidata/rapidata_client/config/tracer.py +184 -0
  735. rapidata/rapidata_client/config/upload_config.py +64 -0
  736. rapidata/rapidata_client/datapoints/__init__.py +8 -0
  737. rapidata/rapidata_client/datapoints/_asset_uploader.py +194 -0
  738. rapidata/rapidata_client/datapoints/_datapoint.py +92 -0
  739. rapidata/rapidata_client/datapoints/_datapoint_uploader.py +47 -0
  740. rapidata/rapidata_client/datapoints/_datapoints_validator.py +70 -0
  741. rapidata/rapidata_client/datapoints/_single_flight_cache.py +82 -0
  742. rapidata/rapidata_client/datapoints/assets/__init__.py +0 -0
  743. rapidata/rapidata_client/datapoints/assets/constants.py +7 -0
  744. rapidata/rapidata_client/{metadata → datapoints/metadata}/__init__.py +1 -2
  745. rapidata/rapidata_client/datapoints/metadata/_private_text_metadata.py +16 -0
  746. rapidata/rapidata_client/datapoints/metadata/_prompt_identifier_metadata.py +14 -0
  747. rapidata/rapidata_client/datapoints/metadata/_public_text_metadata.py +16 -0
  748. rapidata/rapidata_client/{metadata → datapoints/metadata}/_select_words_metadata.py +4 -5
  749. rapidata/rapidata_client/dataset/__init__.py +1 -0
  750. rapidata/rapidata_client/dataset/_rapidata_dataset.py +55 -0
  751. rapidata/rapidata_client/demographic/demographic_manager.py +44 -19
  752. rapidata/rapidata_client/exceptions/__init__.py +1 -0
  753. rapidata/rapidata_client/exceptions/failed_upload_exception.py +27 -0
  754. rapidata/rapidata_client/filter/__init__.py +3 -0
  755. rapidata/rapidata_client/filter/_backend_filter_mapper.py +134 -0
  756. rapidata/rapidata_client/filter/_base_filter.py +58 -2
  757. rapidata/rapidata_client/filter/age_filter.py +26 -10
  758. rapidata/rapidata_client/filter/and_filter.py +55 -0
  759. rapidata/rapidata_client/filter/campaign_filter.py +21 -10
  760. rapidata/rapidata_client/filter/country_filter.py +46 -12
  761. rapidata/rapidata_client/filter/custom_filter.py +25 -12
  762. rapidata/rapidata_client/filter/device_filter.py +38 -0
  763. rapidata/rapidata_client/filter/gender_filter.py +25 -10
  764. rapidata/rapidata_client/filter/language_filter.py +51 -21
  765. rapidata/rapidata_client/filter/models/age_group.py +14 -12
  766. rapidata/rapidata_client/filter/models/device_type.py +20 -0
  767. rapidata/rapidata_client/filter/models/gender.py +12 -8
  768. rapidata/rapidata_client/filter/new_user_filter.py +14 -4
  769. rapidata/rapidata_client/filter/not_filter.py +35 -11
  770. rapidata/rapidata_client/filter/or_filter.py +36 -11
  771. rapidata/rapidata_client/filter/rapidata_filters.py +30 -25
  772. rapidata/rapidata_client/filter/response_count_filter.py +51 -20
  773. rapidata/rapidata_client/filter/user_score_filter.py +62 -24
  774. rapidata/rapidata_client/job/__init__.py +3 -0
  775. rapidata/rapidata_client/job/job_definition.py +110 -0
  776. rapidata/rapidata_client/job/job_manager.py +758 -0
  777. rapidata/rapidata_client/job/rapidata_job.py +326 -0
  778. rapidata/rapidata_client/order/__init__.py +2 -0
  779. rapidata/rapidata_client/order/_rapidata_order_builder.py +286 -193
  780. rapidata/rapidata_client/order/rapidata_order.py +329 -153
  781. rapidata/rapidata_client/order/rapidata_order_manager.py +712 -430
  782. rapidata/rapidata_client/rapidata_client.py +130 -26
  783. rapidata/rapidata_client/referee/__init__.py +1 -1
  784. rapidata/rapidata_client/referee/_base_referee.py +14 -3
  785. rapidata/rapidata_client/referee/_early_stopping_referee.py +32 -17
  786. rapidata/rapidata_client/referee/_naive_referee.py +24 -3
  787. rapidata/rapidata_client/results/__init__.py +3 -0
  788. rapidata/rapidata_client/{order → results}/rapidata_results.py +98 -67
  789. rapidata/rapidata_client/selection/__init__.py +2 -1
  790. rapidata/rapidata_client/selection/_base_selection.py +9 -2
  791. rapidata/rapidata_client/selection/ab_test_selection.py +28 -20
  792. rapidata/rapidata_client/selection/capped_selection.py +23 -16
  793. rapidata/rapidata_client/selection/conditional_validation_selection.py +43 -24
  794. rapidata/rapidata_client/selection/demographic_selection.py +21 -6
  795. rapidata/rapidata_client/selection/effort_selection.py +49 -0
  796. rapidata/rapidata_client/selection/labeling_selection.py +36 -12
  797. rapidata/rapidata_client/selection/{retrieval_modes.py → rapidata_retrieval_modes.py} +10 -7
  798. rapidata/rapidata_client/selection/rapidata_selections.py +31 -21
  799. rapidata/rapidata_client/selection/shuffling_selection.py +21 -13
  800. rapidata/rapidata_client/selection/static_selection.py +20 -9
  801. rapidata/rapidata_client/selection/validation_selection.py +20 -4
  802. rapidata/rapidata_client/settings/__init__.py +4 -1
  803. rapidata/rapidata_client/settings/_rapidata_setting.py +22 -3
  804. rapidata/rapidata_client/settings/alert_on_fast_response.py +8 -5
  805. rapidata/rapidata_client/settings/allow_neither_both.py +17 -0
  806. rapidata/rapidata_client/settings/custom_setting.py +3 -2
  807. rapidata/rapidata_client/settings/free_text_minimum_characters.py +9 -4
  808. rapidata/rapidata_client/settings/models/translation_behaviour_options.py +3 -2
  809. rapidata/rapidata_client/settings/mute_video.py +15 -0
  810. rapidata/rapidata_client/settings/no_shuffle.py +4 -2
  811. rapidata/rapidata_client/settings/play_video_until_the_end.py +7 -4
  812. rapidata/rapidata_client/settings/rapidata_settings.py +28 -16
  813. rapidata/rapidata_client/settings/swap_context_instruction.py +20 -0
  814. rapidata/rapidata_client/settings/translation_behaviour.py +7 -5
  815. rapidata/rapidata_client/utils/__init__.py +3 -0
  816. rapidata/rapidata_client/utils/threaded_uploader.py +153 -0
  817. rapidata/rapidata_client/validation/__init__.py +2 -0
  818. rapidata/rapidata_client/validation/rapidata_validation_set.py +106 -12
  819. rapidata/rapidata_client/validation/rapids/__init__.py +2 -0
  820. rapidata/rapidata_client/validation/rapids/_validation_rapid_uploader.py +48 -0
  821. rapidata/rapidata_client/validation/rapids/box.py +37 -12
  822. rapidata/rapidata_client/validation/rapids/rapids.py +29 -104
  823. rapidata/rapidata_client/validation/rapids/rapids_manager.py +371 -214
  824. rapidata/rapidata_client/validation/validation_set_manager.py +529 -227
  825. rapidata/rapidata_client/workflow/__init__.py +2 -2
  826. rapidata/rapidata_client/workflow/_base_workflow.py +25 -7
  827. rapidata/rapidata_client/workflow/_classify_workflow.py +58 -15
  828. rapidata/rapidata_client/workflow/_compare_workflow.py +44 -9
  829. rapidata/rapidata_client/workflow/_draw_workflow.py +40 -10
  830. rapidata/rapidata_client/workflow/_evaluation_workflow.py +28 -7
  831. rapidata/rapidata_client/workflow/_free_text_workflow.py +46 -9
  832. rapidata/rapidata_client/workflow/_locate_workflow.py +40 -10
  833. rapidata/rapidata_client/workflow/_multi_ranking_workflow.py +90 -0
  834. rapidata/rapidata_client/workflow/_select_words_workflow.py +51 -11
  835. rapidata/rapidata_client/workflow/_timestamp_workflow.py +42 -11
  836. rapidata/service/__init__.py +0 -1
  837. rapidata/service/credential_manager.py +18 -18
  838. rapidata/service/openapi_service.py +128 -28
  839. rapidata/types/__init__.py +149 -0
  840. rapidata-3.0.1.dist-info/METADATA +32 -0
  841. rapidata-3.0.1.dist-info/RECORD +1089 -0
  842. {rapidata-2.24.0.dist-info → rapidata-3.0.1.dist-info}/WHEEL +1 -1
  843. rapidata/rapidata_client/api/rapidata_exception.py +0 -107
  844. rapidata/rapidata_client/assets/__init__.py +0 -10
  845. rapidata/rapidata_client/assets/_base_asset.py +0 -11
  846. rapidata/rapidata_client/assets/_media_asset.py +0 -306
  847. rapidata/rapidata_client/assets/_multi_asset.py +0 -66
  848. rapidata/rapidata_client/assets/_sessions.py +0 -35
  849. rapidata/rapidata_client/assets/_text_asset.py +0 -34
  850. rapidata/rapidata_client/assets/data_type_enum.py +0 -7
  851. rapidata/rapidata_client/country_codes/__init__.py +0 -1
  852. rapidata/rapidata_client/country_codes/country_codes.py +0 -19
  853. rapidata/rapidata_client/logging/__init__.py +0 -2
  854. rapidata/rapidata_client/logging/logger.py +0 -47
  855. rapidata/rapidata_client/logging/output_manager.py +0 -16
  856. rapidata/rapidata_client/metadata/_media_asset_metadata.py +0 -15
  857. rapidata/rapidata_client/metadata/_private_text_metadata.py +0 -17
  858. rapidata/rapidata_client/metadata/_prompt_metadata.py +0 -18
  859. rapidata/rapidata_client/metadata/_public_text_metadata.py +0 -17
  860. rapidata/rapidata_client/order/_rapidata_dataset.py +0 -443
  861. rapidata/rapidata_client/workflow/_ranking_workflow.py +0 -51
  862. rapidata/service/local_file_service.py +0 -25
  863. rapidata-2.24.0.dist-info/METADATA +0 -34
  864. rapidata-2.24.0.dist-info/RECORD +0 -530
  865. /rapidata/rapidata_client/{metadata → datapoints/metadata}/_base_metadata.py +0 -0
  866. {rapidata-2.24.0.dist-info → rapidata-3.0.1.dist-info/licenses}/LICENSE +0 -0
@@ -1,172 +1,180 @@
1
- from typing import Sequence, Optional
2
- from urllib3._collections import HTTPHeaderDict # type: ignore[import]
3
- from itertools import zip_longest
1
+ from __future__ import annotations
4
2
 
5
- from rapidata.service.openapi_service import OpenAPIService
6
- from rapidata.rapidata_client.assets.data_type_enum import RapidataDataTypes
7
- from rapidata.rapidata_client.order.rapidata_order import RapidataOrder
8
- from rapidata.rapidata_client.order._rapidata_order_builder import RapidataOrderBuilder
9
- from rapidata.rapidata_client.metadata import PromptMetadata, SelectWordsMetadata, PrivateTextMetadata, MediaAssetMetadata, Metadata
10
- from rapidata.rapidata_client.referee._naive_referee import NaiveReferee
11
- from rapidata.rapidata_client.referee._early_stopping_referee import EarlyStoppingReferee
12
- from rapidata.rapidata_client.selection._base_selection import RapidataSelection
13
- from rapidata.rapidata_client.workflow import (
14
- Workflow,
15
- ClassifyWorkflow,
16
- CompareWorkflow,
17
- FreeTextWorkflow,
18
- SelectWordsWorkflow,
19
- LocateWorkflow,
20
- DrawWorkflow,
21
- TimestampWorkflow,
22
- RankingWorkflow
3
+ from typing import Literal, Optional, Sequence, get_args, TYPE_CHECKING
4
+
5
+ from rapidata.rapidata_client.config import logger
6
+ from rapidata.rapidata_client.config.tracer import tracer
7
+ from rapidata.rapidata_client.datapoints._asset_uploader import AssetUploader
8
+ from rapidata.rapidata_client.datapoints._datapoint import Datapoint
9
+ from rapidata.rapidata_client.datapoints._datapoints_validator import (
10
+ DatapointsValidator,
23
11
  )
24
- from rapidata.rapidata_client.selection.validation_selection import ValidationSelection
25
- from rapidata.rapidata_client.selection.labeling_selection import LabelingSelection
26
- from rapidata.rapidata_client.assets import MediaAsset, TextAsset, MultiAsset
27
12
  from rapidata.rapidata_client.filter import RapidataFilter
28
13
  from rapidata.rapidata_client.filter.rapidata_filters import RapidataFilters
29
- from rapidata.rapidata_client.settings import RapidataSettings, RapidataSetting
14
+ from rapidata.rapidata_client.settings import RapidataSetting, RapidataSettings
30
15
  from rapidata.rapidata_client.selection.rapidata_selections import RapidataSelections
31
- from rapidata.rapidata_client.logging import logger
32
-
33
- from rapidata.api_client.exceptions import BadRequestException
34
- from rapidata.api_client.models.query_model import QueryModel
35
- from rapidata.api_client.models.page_info import PageInfo
36
- from rapidata.api_client.models.root_filter import RootFilter
37
- from rapidata.api_client.models.filter import Filter
38
- from rapidata.api_client.models.sort_criterion import SortCriterion
16
+ from rapidata.service.openapi_service import OpenAPIService
39
17
 
40
- from tqdm import tqdm
18
+ if TYPE_CHECKING:
19
+ from rapidata.rapidata_client.order._rapidata_order_builder import (
20
+ StickyStateLiteral,
21
+ )
22
+ from rapidata.rapidata_client.order.rapidata_order import RapidataOrder
23
+ from rapidata.rapidata_client.selection._base_selection import RapidataSelection
24
+ from rapidata.rapidata_client.workflow import (
25
+ Workflow,
26
+ )
41
27
 
42
28
 
43
29
  class RapidataOrderManager:
44
30
  """
45
31
  Handels everything regarding the orders from creation to retrieval.
46
-
32
+
47
33
  Attributes:
48
34
  filters (RapidataFilters): The RapidataFilters instance.
49
35
  settings (RapidataSettings): The RapidataSettings instance.
50
36
  selections (RapidataSelections): The RapidataSelections instance."""
51
37
 
52
38
  def __init__(self, openapi_service: OpenAPIService):
53
- self._openapi_service = openapi_service
39
+ self.__openapi_service = openapi_service
54
40
  self.filters = RapidataFilters
55
41
  self.settings = RapidataSettings
56
42
  self.selections = RapidataSelections
57
- self.__priority = 50
43
+ from rapidata.rapidata_client.order._rapidata_order_builder import (
44
+ StickyStateLiteral,
45
+ )
46
+
47
+ self.__priority: int | None = None
48
+ self.__sticky_state: StickyStateLiteral | None = None
49
+ self._asset_uploader = AssetUploader(openapi_service)
58
50
  logger.debug("RapidataOrderManager initialized")
59
51
 
60
- def __get_selections(self, validation_set_id: str | None, labeling_amount=3) -> Sequence[RapidataSelection]:
61
- if validation_set_id:
62
- return [ValidationSelection(validation_set_id=validation_set_id), LabelingSelection(amount=labeling_amount-1)]
63
- return [LabelingSelection(amount=labeling_amount)]
64
-
65
- def _create_general_order(self,
66
- name: str,
67
- workflow: Workflow,
68
- assets: list[MediaAsset] | list[TextAsset] | list[MultiAsset],
69
- responses_per_datapoint: int = 10,
70
- contexts: list[str] | None = None,
71
- media_contexts: list[str] | None = None,
72
- validation_set_id: str | None = None,
73
- confidence_threshold: float | None = None,
74
- filters: Sequence[RapidataFilter] = [],
75
- settings: Sequence[RapidataSetting] = [],
76
- sentences: list[str] | None = None,
77
- selections: Sequence[RapidataSelection] = [],
78
- private_notes: list[str] | None = None,
79
- default_labeling_amount: int = 3
80
- ) -> RapidataOrder:
81
-
82
- if contexts and len(contexts) != len(assets):
83
- raise ValueError("Number of contexts must match number of datapoints")
84
-
85
- if media_contexts and len(media_contexts) != len(assets):
86
- raise ValueError("Number of media contexts must match number of datapoints")
87
-
88
- if sentences and len(sentences) != len(assets):
89
- raise ValueError("Number of sentences must match number of datapoints")
90
-
91
- if private_notes and len(private_notes) != len(assets):
92
- raise ValueError("Number of private notes must match number of datapoints")
93
-
94
- if sentences and contexts:
95
- raise ValueError("You can only use contexts or sentences, not both")
52
+ def _create_general_order(
53
+ self,
54
+ name: str,
55
+ workflow: Workflow,
56
+ datapoints: list[Datapoint],
57
+ responses_per_datapoint: int = 10,
58
+ validation_set_id: str | None = None,
59
+ confidence_threshold: float | None = None,
60
+ filters: Sequence[RapidataFilter] | None = None,
61
+ settings: Sequence[RapidataSetting] | None = None,
62
+ selections: Sequence[RapidataSelection] | None = None,
63
+ ) -> RapidataOrder:
64
+ if filters is None:
65
+ filters = []
66
+ if settings is None:
67
+ settings = []
68
+ if selections is None:
69
+ selections = []
96
70
 
97
71
  if not confidence_threshold:
72
+ from rapidata.rapidata_client.referee._naive_referee import NaiveReferee
73
+
98
74
  referee = NaiveReferee(responses=responses_per_datapoint)
99
75
  else:
76
+ from rapidata.rapidata_client.referee._early_stopping_referee import (
77
+ EarlyStoppingReferee,
78
+ )
79
+
100
80
  referee = EarlyStoppingReferee(
101
81
  threshold=confidence_threshold,
102
- max_vote_count=responses_per_datapoint,
82
+ max_responses=responses_per_datapoint,
103
83
  )
104
84
 
85
+ logger.debug(
86
+ "Creating order with parameters: name %s, workflow %s, datapoints %s, responses_per_datapoint %s, validation_set_id %s, confidence_threshold %s, filters %s, settings %s, selections %s",
87
+ name,
88
+ workflow,
89
+ datapoints,
90
+ responses_per_datapoint,
91
+ validation_set_id,
92
+ confidence_threshold,
93
+ filters,
94
+ settings,
95
+ selections,
96
+ )
105
97
 
106
- order_builder = RapidataOrderBuilder(name=name, openapi_service=self._openapi_service)
98
+ from rapidata.rapidata_client.order._rapidata_order_builder import (
99
+ RapidataOrderBuilder,
100
+ )
101
+
102
+ order_builder = RapidataOrderBuilder(
103
+ name=name, openapi_service=self.__openapi_service
104
+ )
107
105
 
108
106
  if selections and validation_set_id:
109
- logger.warning("Warning: Both selections and validation_set_id provided. Ignoring validation_set_id.")
110
-
111
- if not selections:
112
- selections = self.__get_selections(validation_set_id, labeling_amount=default_labeling_amount)
113
-
114
- prompts_metadata = [PromptMetadata(prompt=prompt) for prompt in contexts] if contexts else None
115
- sentence_metadata = [SelectWordsMetadata(select_words=sentence) for sentence in sentences] if sentences else None
116
-
117
- if prompts_metadata and sentence_metadata:
118
- raise ValueError("You can only use contexts or sentences, not both")
119
-
120
- asset_metadata: Sequence[Metadata] = [MediaAssetMetadata(url=context) for context in media_contexts] if media_contexts else []
121
- prompt_metadata: Sequence[Metadata] = prompts_metadata or sentence_metadata or []
122
- private_notes_metadata: Sequence[Metadata] = [PrivateTextMetadata(text=text) for text in private_notes] if private_notes else []
123
-
124
- multi_metadata = [[item for item in items if item is not None]
125
- for items in zip_longest(prompt_metadata, asset_metadata, private_notes_metadata)]
126
-
127
- order = (order_builder
128
- ._workflow(workflow)
129
- ._media(
130
- assets=assets,
131
- multi_metadata=multi_metadata
132
- )
133
- ._referee(referee)
134
- ._filters(filters)
135
- ._selections(selections)
136
- ._settings(settings)
137
- ._priority(self.__priority)
138
- ._create()
139
- )
107
+ logger.warning(
108
+ "Warning: Both selections and validation_set_id provided. Ignoring validation_set_id."
109
+ )
110
+
111
+ order = (
112
+ order_builder._set_workflow(workflow)
113
+ ._set_datapoints(datapoints=datapoints)
114
+ ._set_referee(referee)
115
+ ._set_filters(filters)
116
+ ._set_selections(selections)
117
+ ._set_settings(settings)
118
+ ._set_validation_set_id(validation_set_id if not selections else None)
119
+ ._set_priority(self.__priority)
120
+ ._set_sticky_state(self.__sticky_state)
121
+ ._create()
122
+ )
123
+ logger.debug("Order created: %s", order)
140
124
  return order
141
-
142
- def _set_priority(self, priority: int):
125
+
126
+ def _set_priority(self, priority: int | None):
127
+ if priority is not None and not isinstance(priority, int):
128
+ raise TypeError("Priority must be an integer or None")
129
+
130
+ if priority is not None and priority < 0:
131
+ raise ValueError("Priority must be greater than 0 or None")
132
+
143
133
  self.__priority = priority
144
-
145
- def create_classification_order(self,
146
- name: str,
147
- instruction: str,
148
- answer_options: list[str],
149
- datapoints: list[str],
150
- data_type: str = RapidataDataTypes.MEDIA,
151
- responses_per_datapoint: int = 10,
152
- contexts: list[str] | None = None,
153
- media_contexts: list[str] | None = None,
154
- validation_set_id: str | None = None,
155
- confidence_threshold: float | None = None,
156
- filters: Sequence[RapidataFilter] = [],
157
- settings: Sequence[RapidataSetting] = [],
158
- selections: Sequence[RapidataSelection] = [],
159
- private_notes: list[str] | None = None,
160
- ) -> RapidataOrder:
134
+
135
+ def _set_sticky_state(self, sticky_state: StickyStateLiteral | None):
136
+ from rapidata.rapidata_client.order._rapidata_order_builder import (
137
+ StickyStateLiteral,
138
+ )
139
+
140
+ sticky_state_valid_values = get_args(StickyStateLiteral)
141
+
142
+ if sticky_state is not None and sticky_state not in sticky_state_valid_values:
143
+ raise ValueError(
144
+ f"Sticky state must be one of {sticky_state_valid_values} or None"
145
+ )
146
+
147
+ self.__sticky_state = sticky_state
148
+
149
+ def create_classification_order(
150
+ self,
151
+ name: str,
152
+ instruction: str,
153
+ answer_options: list[str],
154
+ datapoints: list[str],
155
+ data_type: Literal["media", "text"] = "media",
156
+ responses_per_datapoint: int = 10,
157
+ contexts: list[str] | None = None,
158
+ media_contexts: list[str] | None = None,
159
+ validation_set_id: str | None = None,
160
+ confidence_threshold: float | None = None,
161
+ filters: Sequence[RapidataFilter] | None = None,
162
+ settings: Sequence[RapidataSetting] | None = None,
163
+ selections: Sequence[RapidataSelection] | None = None,
164
+ private_notes: list[str] | None = None,
165
+ ) -> RapidataOrder:
161
166
  """Create a classification order.
162
-
167
+
168
+ With this order you can have a datapoint (image, text, video, audio) be classified into one of the answer options.
169
+ Each response will be exactly one of the answer options.
170
+
163
171
  Args:
164
172
  name (str): The name of the order. (Will not be shown to the labeler)
165
173
  instruction (str): The instruction for how the data should be classified.
166
174
  answer_options (list[str]): The list of options for the classification.
167
175
  datapoints (list[str]): The list of datapoints for the classification - each datapoint will be labeled.
168
- data_type (str, optional): The data type of the datapoints. Defaults to RapidataDataTypes.MEDIA. \n
169
- Other option: RapidataDataTypes.TEXT ("text").
176
+ data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n
177
+ Other option: "text".
170
178
  responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10.
171
179
  contexts (list[str], optional): The list of contexts for the classification. Defaults to None.\n
172
180
  If provided has to be the same length as datapoints and will be shown in addition to the instruction and options. (Therefore will be different for each datapoint)
@@ -181,58 +189,84 @@ class RapidataOrderManager:
181
189
  settings (Sequence[RapidataSetting], optional): The list of settings for the classification. Defaults to []. Decides how the tasks should be shown.
182
190
  selections (Sequence[RapidataSelection], optional): The list of selections for the classification. Defaults to []. Decides in what order the tasks should be shown.
183
191
  private_notes (list[str], optional): The list of private notes for the classification. Defaults to None.
184
- If provided has to be the same length as datapoints.\n
192
+ If provided has to be the same length as datapoints.\n
185
193
  This will NOT be shown to the labelers but will be included in the result purely for your own reference.
194
+
195
+ Example:
196
+ ```python
197
+ from rapidata import RapidataClient, NoShuffle
198
+
199
+ rapi = RapidataClient()
200
+ order = rapi.order.create_classification_order(
201
+ name="Image Quality Rating",
202
+ instruction="How would you rate the quality of this image?",
203
+ answer_options=["1: Poor", "2: Fair", "3: Good", "4: Excellent"],
204
+ datapoints=["https://example.com/image1.jpg", "https://example.com/image2.jpg"],
205
+ responses_per_datapoint=15,
206
+ settings=[NoShuffle()], # Keep options in order for Likert scale
207
+ ).run()
208
+
209
+ results = order.get_results()
210
+ ```
186
211
  """
187
-
188
- if data_type == RapidataDataTypes.MEDIA:
189
- assets = [MediaAsset(path=path) for path in datapoints]
190
- elif data_type == RapidataDataTypes.TEXT:
191
- assets = [TextAsset(text=text) for text in datapoints]
192
- else:
193
- raise ValueError(f"Unsupported data type: {data_type}, must be one of {RapidataDataTypes._possible_values()}")
194
-
195
- return self._create_general_order(
196
- name=name,
197
- workflow=ClassifyWorkflow(
198
- instruction=instruction,
199
- answer_options=answer_options
200
- ),
201
- assets=assets,
202
- responses_per_datapoint=responses_per_datapoint,
203
- contexts=contexts,
204
- media_contexts=media_contexts,
205
- validation_set_id=validation_set_id,
206
- confidence_threshold=confidence_threshold,
207
- filters=filters,
208
- selections=selections,
209
- settings=settings,
210
- private_notes=private_notes
211
- )
212
-
213
- def create_compare_order(self,
214
- name: str,
215
- instruction: str,
216
- datapoints: list[list[str]],
217
- data_type: str = RapidataDataTypes.MEDIA,
218
- responses_per_datapoint: int = 10,
219
- contexts: list[str] | None = None,
220
- media_contexts: list[str] | None = None,
221
- validation_set_id: str | None = None,
222
- confidence_threshold: float | None = None,
223
- filters: Sequence[RapidataFilter] = [],
224
- settings: Sequence[RapidataSetting] = [],
225
- selections: Sequence[RapidataSelection] = [],
226
- private_notes: list[str] | None = None,
227
- ) -> RapidataOrder:
212
+ with tracer.start_as_current_span(
213
+ "RapidataOrderManager.create_classification_order"
214
+ ):
215
+ if not isinstance(datapoints, list) or not all(
216
+ isinstance(datapoint, str) for datapoint in datapoints
217
+ ):
218
+ raise ValueError("Datapoints must be a list of strings")
219
+
220
+ from rapidata.rapidata_client.workflow import ClassifyWorkflow
221
+
222
+ datapoints_instances = DatapointsValidator.map_datapoints(
223
+ datapoints=datapoints,
224
+ contexts=contexts,
225
+ media_contexts=media_contexts,
226
+ private_notes=private_notes,
227
+ data_type=data_type,
228
+ )
229
+ return self._create_general_order(
230
+ name=name,
231
+ workflow=ClassifyWorkflow(
232
+ instruction=instruction, answer_options=answer_options
233
+ ),
234
+ datapoints=datapoints_instances,
235
+ responses_per_datapoint=responses_per_datapoint,
236
+ validation_set_id=validation_set_id,
237
+ confidence_threshold=confidence_threshold,
238
+ filters=filters,
239
+ selections=selections,
240
+ settings=settings,
241
+ )
242
+
243
+ def create_compare_order(
244
+ self,
245
+ name: str,
246
+ instruction: str,
247
+ datapoints: list[list[str]],
248
+ data_type: Literal["media", "text"] = "media",
249
+ responses_per_datapoint: int = 10,
250
+ contexts: list[str] | None = None,
251
+ media_contexts: list[str] | None = None,
252
+ a_b_names: list[str] | None = None,
253
+ validation_set_id: str | None = None,
254
+ confidence_threshold: float | None = None,
255
+ filters: Sequence[RapidataFilter] | None = None,
256
+ settings: Sequence[RapidataSetting] | None = None,
257
+ selections: Sequence[RapidataSelection] | None = None,
258
+ private_notes: list[str] | None = None,
259
+ ) -> RapidataOrder:
228
260
  """Create a compare order.
229
261
 
262
+ With this order you compare two datapoints (image, text, video, audio) and the annotators will choose one of the two based on the instruction.
263
+
230
264
  Args:
231
265
  name (str): The name of the order. (Will not be shown to the labeler)
232
266
  instruction (str): The instruction for the comparison. Will be shown along side each datapoint.
233
267
  datapoints (list[list[str]]): Outher list is the datapoints, inner list is the options for the comparison - each datapoint will be labeled.
234
- data_type (str, optional): The data type of the datapoints. Defaults to RapidataDataTypes.MEDIA. \n
235
- Other option: RapidataDataTypes.TEXT ("text").
268
+ data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n
269
+ Other option: "text".
236
270
  responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10.
237
271
  contexts (list[str], optional): The list of contexts for the comparison. Defaults to None.\n
238
272
  If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint)
@@ -240,6 +274,15 @@ class RapidataOrderManager:
240
274
  media_contexts (list[str], optional): The list of media contexts i.e. links to the images / videos for the comparison. Defaults to None.\n
241
275
  If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint)
242
276
  Will be matched up with the datapoints using the list index.
277
+ a_b_names (list[str], optional): Custom naming for the two opposing models defined by the index in the datapoints list. Defaults to None.\n
278
+ If provided has to be a list of exactly two strings.
279
+ example:
280
+ ```python
281
+ datapoints = [["path_to_image_A", "path_to_image_B"], ["path_to_text_A", "path_to_text_B"]]
282
+ a_b_naming = ["Model A", "Model B"]
283
+ ```
284
+ The results will then correctly show "Model A" and "Model B".
285
+ If not provided, the results will be shown as "A" and "B".
243
286
  validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n
244
287
  If provided, one validation task will be shown infront of the datapoints that will be labeled.
245
288
  confidence_threshold (float, optional): The probability threshold for the comparison. Defaults to None.\n
@@ -248,156 +291,301 @@ class RapidataOrderManager:
248
291
  settings (Sequence[RapidataSetting], optional): The list of settings for the comparison. Defaults to []. Decides how the tasks should be shown.
249
292
  selections (Sequence[RapidataSelection], optional): The list of selections for the comparison. Defaults to []. Decides in what order the tasks should be shown.
250
293
  private_notes (list[str], optional): The list of private notes for the comparison. Defaults to None.\n
251
- If provided has to be the same length as datapoints.\n
294
+ If provided has to be the same length as datapoints.\n
252
295
  This will NOT be shown to the labelers but will be included in the result purely for your own reference.
253
- """
254
296
 
255
- if data_type == RapidataDataTypes.MEDIA:
256
- assets = [MultiAsset([MediaAsset(path=path) for path in datapoint]) for datapoint in datapoints]
257
- elif data_type == RapidataDataTypes.TEXT:
258
- assets = [MultiAsset([TextAsset(text=text) for text in datapoint]) for datapoint in datapoints]
259
- else:
260
- raise ValueError(f"Unsupported data type: {data_type}, must be one of {RapidataDataTypes._possible_values()}")
261
-
262
- return self._create_general_order(
263
- name=name,
264
- workflow=CompareWorkflow(
265
- instruction=instruction
266
- ),
267
- assets=assets,
268
- responses_per_datapoint=responses_per_datapoint,
269
- contexts=contexts,
270
- media_contexts=media_contexts,
271
- validation_set_id=validation_set_id,
272
- confidence_threshold=confidence_threshold,
273
- filters=filters,
274
- selections=selections,
275
- settings=settings,
276
- private_notes=private_notes
277
- )
297
+ Example:
298
+ ```python
299
+ from rapidata import RapidataClient
300
+
301
+ rapi = RapidataClient()
302
+ order = rapi.order.create_compare_order(
303
+ name="Image Prompt Alignment",
304
+ instruction="Which image follows the prompt more accurately?",
305
+ datapoints=[
306
+ ["https://example.com/model_a_img1.jpg", "https://example.com/model_b_img1.jpg"],
307
+ ["https://example.com/model_a_img2.jpg", "https://example.com/model_b_img2.jpg"],
308
+ ],
309
+ contexts=["A cat sitting on a red couch", "A blue car in the rain"],
310
+ responses_per_datapoint=25,
311
+ a_b_names=["Flux", "Midjourney"], # Optional: label the models in results
312
+ ).run()
313
+
314
+ results = order.get_results()
315
+ ```
316
+ """
317
+ with tracer.start_as_current_span("RapidataOrderManager.create_compare_order"):
318
+ if any(not isinstance(datapoint, list) for datapoint in datapoints):
319
+ raise ValueError("Each datapoint must be a list of 2 paths/texts")
320
+
321
+ if any(len(set(datapoint)) != 2 for datapoint in datapoints):
322
+ raise ValueError(
323
+ "Each datapoint must contain exactly two unique options"
324
+ )
325
+
326
+ if a_b_names is not None and len(a_b_names) != 2:
327
+ raise ValueError(
328
+ "A_B_naming must be a list of exactly two strings or None"
329
+ )
330
+
331
+ from rapidata.rapidata_client.workflow import CompareWorkflow
332
+
333
+ datapoints_instances = DatapointsValidator.map_datapoints(
334
+ datapoints=datapoints,
335
+ contexts=contexts,
336
+ media_contexts=media_contexts,
337
+ private_notes=private_notes,
338
+ data_type=data_type,
339
+ )
340
+ return self._create_general_order(
341
+ name=name,
342
+ workflow=CompareWorkflow(instruction=instruction, a_b_names=a_b_names),
343
+ datapoints=datapoints_instances,
344
+ responses_per_datapoint=responses_per_datapoint,
345
+ validation_set_id=validation_set_id,
346
+ confidence_threshold=confidence_threshold,
347
+ filters=filters,
348
+ selections=selections,
349
+ settings=settings,
350
+ )
278
351
 
279
- def create_ranking_order(self,
280
- name: str,
281
- instruction: str,
282
- datapoints: list[str],
283
- total_comparison_budget: int,
284
- responses_per_comparison: int = 5,
285
- data_type: str = RapidataDataTypes.MEDIA,
286
- random_comparisons_ratio: float = 0.5,
287
- context: Optional[str] = None,
288
- validation_set_id: Optional[str] = None,
289
- filters: Sequence[RapidataFilter] = [],
290
- settings: Sequence[RapidataSetting] = [],
291
- selections: Sequence[RapidataSelection] = []
292
- ) -> RapidataOrder:
352
+ def create_ranking_order(
353
+ self,
354
+ name: str,
355
+ instruction: str,
356
+ datapoints: list[list[str]],
357
+ comparison_budget_per_ranking: int,
358
+ responses_per_comparison: int = 1,
359
+ data_type: Literal["media", "text"] = "media",
360
+ random_comparisons_ratio: float = 0.5,
361
+ contexts: Optional[list[str]] = None,
362
+ media_contexts: Optional[list[str]] = None,
363
+ validation_set_id: Optional[str] = None,
364
+ filters: Sequence[RapidataFilter] | None = None,
365
+ settings: Sequence[RapidataSetting] | None = None,
366
+ selections: Sequence[RapidataSelection] | None = None,
367
+ ) -> RapidataOrder:
293
368
  """
294
369
  Create a ranking order.
295
370
 
371
+ With this order you can have a multiple lists of datapoints (image, text, video, audio) be ranked based on the instruction.
372
+ Each list will be ranked independently, based on comparison matchups.
373
+
296
374
  Args:
297
375
  name (str): The name of the order.
298
- instruction (str): The question asked from People when They see two datapoints.
299
- datapoints (list[str]): A list of datapoints that will participate in the ranking.
300
- total_comparison_budget (int): The total number of (pairwise-)comparisons that can be made.
301
- responses_per_comparison (int, optional): The number of responses collected per comparison.
302
- data_type (str, optional): The data type of the datapoints. Defaults to RapidataDataTypes.MEDIA. \n
303
- Other option: RapidataDataTypes.TEXT ("text").
304
- random_comparisons_ratio (float, optional): The fraction of random comparisons in the ranking process.
305
- The rest will focus on pairing similarly ranked datapoints. Defaults to 0.5 and can be left untouched.
306
- context (str, optional): The context for all the comparison. Defaults to None.\n
307
- If provided will be shown in addition to the instruction for all the matchups.
376
+ instruction (str): The instruction for the ranking. Will be shown with each matchup.
377
+ datapoints (list[list[str]]): The outer list is determines the independent rankings, the inner list is the datapoints for each ranking.
378
+ comparison_budget_per_ranking (int): The number of comparisons that will be collected per ranking (outer list of datapoints).
379
+ responses_per_comparison (int, optional): The number of responses that will be collected per comparison. Defaults to 1.
380
+ data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n
381
+ Other option: "text".
382
+ random_comparisons_ratio (float, optional): The ratio of random comparisons to the total number of comparisons. Defaults to 0.5.
383
+ contexts (list[str], optional): The list of contexts for the ranking. Defaults to None.\n
384
+ If provided has to be the same length as the outer list of datapoints and will be shown in addition to the instruction. (Therefore will be different for each ranking)
385
+ Will be matched up with the datapoints using the list index.
386
+ media_contexts (list[str], optional): The list of media contexts for the ranking i.e links to the images / videos. Defaults to None.\n
387
+ If provided has to be the same length as the outer list of datapoints and will be shown in addition to the instruction. (Therefore will be different for each ranking)
388
+ Will be matched up with the datapoints using the list index.
308
389
  validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n
309
390
  If provided, one validation task will be shown infront of the datapoints that will be labeled.
310
- filters (Sequence[RapidataFilter], optional): The list of filters for the order. Defaults to []. Decides who the tasks should be shown to.
311
- settings (Sequence[RapidataSetting], optional): The list of settings for the order. Defaults to []. Decides how the tasks should be shown.
312
- selections (Sequence[RapidataSelection], optional): The list of selections for the order. Defaults to []. Decides in what order the tasks should be shown.
391
+ filters (Sequence[RapidataFilter], optional): The list of filters for the ranking. Defaults to []. Decides who the tasks should be shown to.
392
+ settings (Sequence[RapidataSetting], optional): The list of settings for the ranking. Defaults to []. Decides how the tasks should be shown.
393
+ selections (Sequence[RapidataSelection], optional): The list of selections for the ranking. Defaults to []. Decides in what order the tasks should be shown.
394
+
395
+ Example:
396
+ ```python
397
+ from rapidata import RapidataClient
398
+
399
+ rapi = RapidataClient()
400
+ # Rank 12 images by preference using 50 pairwise comparisons
401
+ order = rapi.order.create_ranking_order(
402
+ name="Image Quality Ranking",
403
+ instruction="Which image looks better?",
404
+ datapoints=[["img1.jpg", "img2.jpg", "img3.jpg", "img4.jpg", "img5.jpg",
405
+ "img6.jpg", "img7.jpg", "img8.jpg", "img9.jpg", "img10.jpg",
406
+ "img11.jpg", "img12.jpg"]],
407
+ comparison_budget_per_ranking=50,
408
+ random_comparisons_ratio=0.5, # 50% random, 50% close matchups
409
+ ).run()
410
+
411
+ results = order.get_results() # Returns ranked list with scores
412
+ ```
313
413
  """
414
+ with tracer.start_as_current_span("RapidataOrderManager.create_ranking_order"):
415
+ if contexts and len(contexts) != len(datapoints):
416
+ raise ValueError(
417
+ "Number of contexts must match the number of sets that will be ranked"
418
+ )
419
+ if media_contexts and len(media_contexts) != len(datapoints):
420
+ raise ValueError(
421
+ "Number of media contexts must match the number of sets that will be ranked"
422
+ )
423
+ if not isinstance(datapoints, list) or not all(
424
+ isinstance(dp, list) for dp in datapoints
425
+ ):
426
+ raise ValueError(
427
+ "Datapoints must be a list of lists. Outer list is the independent rankings, inner list is the datapoints for each ranking."
428
+ )
429
+ if not all(len(set(dp)) == len(dp) for dp in datapoints):
430
+ raise ValueError("Each inner list must contain unique datapoints.")
431
+
432
+ if not all(len(inner_list) >= 2 for inner_list in datapoints):
433
+ raise ValueError(
434
+ "Each ranking must contain at least two unique datapoints."
435
+ )
436
+
437
+ from rapidata.rapidata_client.workflow import MultiRankingWorkflow
438
+ from rapidata.api_client.models.i_asset_input import IAssetInput
439
+ from rapidata.api_client.models.i_asset_input_existing_asset_input import (
440
+ IAssetInputExistingAssetInput,
441
+ )
314
442
 
315
- if data_type == RapidataDataTypes.MEDIA:
316
- assets = [MediaAsset(path=path) for path in datapoints]
317
- elif data_type == RapidataDataTypes.TEXT:
318
- assets = [TextAsset(text=text) for text in datapoints]
319
- else:
320
- raise ValueError(f"Unsupported data type: {data_type}, must be one of {RapidataDataTypes._possible_values()}")
321
-
322
- return self._create_general_order(
323
- name=name,
324
- workflow=RankingWorkflow(
325
- criteria=instruction,
326
- total_comparison_budget=total_comparison_budget,
327
- random_comparisons_ratio=random_comparisons_ratio,
328
- context=context
329
- ),
330
- assets=assets,
331
- responses_per_datapoint=responses_per_comparison,
332
- validation_set_id=validation_set_id,
333
- filters=filters,
334
- selections=selections,
335
- settings=settings,
336
- )
443
+ datapoints_instances = []
444
+ for i, datapoint in enumerate(datapoints):
445
+ for d in datapoint:
446
+ datapoints_instances.append(
447
+ Datapoint(
448
+ asset=d,
449
+ data_type=data_type,
450
+ context=contexts[i] if contexts else None,
451
+ media_context=media_contexts[i] if media_contexts else None,
452
+ group=str(i),
453
+ )
454
+ )
455
+
456
+ contexts_dict = (
457
+ {str(i): context for i, context in enumerate(contexts)}
458
+ if contexts
459
+ else None
460
+ )
461
+
462
+ media_contexts_dict = (
463
+ {
464
+ str(i): IAssetInput(
465
+ actual_instance=IAssetInputExistingAssetInput(
466
+ _t="ExistingAssetInput",
467
+ name=self._asset_uploader.upload_asset(media_context),
468
+ )
469
+ )
470
+ for i, media_context in enumerate(media_contexts)
471
+ }
472
+ if media_contexts
473
+ else None
474
+ )
475
+
476
+ return self._create_general_order(
477
+ name=name,
478
+ workflow=MultiRankingWorkflow(
479
+ instruction=instruction,
480
+ comparison_budget_per_ranking=comparison_budget_per_ranking,
481
+ random_comparisons_ratio=random_comparisons_ratio,
482
+ contexts=contexts_dict,
483
+ media_contexts=media_contexts_dict,
484
+ ),
485
+ datapoints=datapoints_instances,
486
+ responses_per_datapoint=responses_per_comparison,
487
+ validation_set_id=validation_set_id,
488
+ filters=filters,
489
+ selections=selections,
490
+ settings=settings,
491
+ )
337
492
 
338
- def create_free_text_order(self,
339
- name: str,
340
- instruction: str,
341
- datapoints: list[str],
342
- data_type: str = RapidataDataTypes.MEDIA,
343
- responses_per_datapoint: int = 10,
344
- filters: Sequence[RapidataFilter] = [],
345
- settings: Sequence[RapidataSetting] = [],
346
- selections: Sequence[RapidataSelection] = [],
347
- private_notes: list[str] | None = None,
348
- ) -> RapidataOrder:
493
+ def create_free_text_order(
494
+ self,
495
+ name: str,
496
+ instruction: str,
497
+ datapoints: list[str],
498
+ data_type: Literal["media", "text"] = "media",
499
+ responses_per_datapoint: int = 10,
500
+ contexts: list[str] | None = None,
501
+ media_contexts: list[str] | None = None,
502
+ filters: Sequence[RapidataFilter] | None = None,
503
+ settings: Sequence[RapidataSetting] | None = None,
504
+ selections: Sequence[RapidataSelection] | None = None,
505
+ private_notes: list[str] | None = None,
506
+ ) -> RapidataOrder:
349
507
  """Create a free text order.
350
508
 
509
+ With this order you can have a datapoint (image, text, video, audio) be labeled with free text.
510
+ The annotators will be shown a datapoint and will be asked to answer a question with free text.
511
+
351
512
  Args:
352
513
  name (str): The name of the order.
353
514
  instruction (str): The instruction to answer with free text. Will be shown along side each datapoint.
354
515
  datapoints (list[str]): The list of datapoints for the free text - each datapoint will be labeled.
355
- data_type (str, optional): The data type of the datapoints. Defaults to RapidataDataTypes.MEDIA. \n
356
- Other option: RapidataDataTypes.TEXT ("text").
516
+ data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n
517
+ Other option: "text".
357
518
  responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10.
519
+ contexts (list[str], optional): The list of contexts for the free text. Defaults to None.\n
520
+ If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint)
521
+ Will be matched up with the datapoints using the list index.
522
+ media_contexts (list[str], optional): The list of media contexts for the free text i.e links to the images / videos. Defaults to None.\n
523
+ If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint)
524
+ Will be matched up with the datapoints using the list index.
358
525
  filters (Sequence[RapidataFilter], optional): The list of filters for the free text. Defaults to []. Decides who the tasks should be shown to.
359
526
  settings (Sequence[RapidataSetting], optional): The list of settings for the free text. Defaults to []. Decides how the tasks should be shown.
360
527
  selections (Sequence[RapidataSelection], optional): The list of selections for the free text. Defaults to []. Decides in what order the tasks should be shown.
361
528
  private_notes (list[str], optional): The list of private notes for the free text. Defaults to None.\n
362
- If provided has to be the same length as datapoints.\n
529
+ If provided has to be the same length as datapoints.\n
363
530
  This will NOT be shown to the labelers but will be included in the result purely for your own reference.
531
+
532
+ Example:
533
+ ```python
534
+ from rapidata import RapidataClient, FreeTextMinimumCharacters
535
+
536
+ rapi = RapidataClient()
537
+ order = rapi.order.create_free_text_order(
538
+ name="Image Captioning",
539
+ instruction="Describe what you see in this image in detail",
540
+ datapoints=["https://example.com/image1.jpg", "https://example.com/image2.jpg"],
541
+ responses_per_datapoint=5,
542
+ settings=[FreeTextMinimumCharacters(20)], # Require at least 20 characters
543
+ ).run()
544
+
545
+ results = order.get_results()
546
+ ```
364
547
  """
548
+ with tracer.start_as_current_span(
549
+ "RapidataOrderManager.create_free_text_order"
550
+ ):
551
+ from rapidata.rapidata_client.workflow import FreeTextWorkflow
552
+
553
+ datapoints_instances = DatapointsValidator.map_datapoints(
554
+ datapoints=datapoints,
555
+ contexts=contexts,
556
+ media_contexts=media_contexts,
557
+ private_notes=private_notes,
558
+ data_type=data_type,
559
+ )
560
+ return self._create_general_order(
561
+ name=name,
562
+ workflow=FreeTextWorkflow(instruction=instruction),
563
+ datapoints=datapoints_instances,
564
+ responses_per_datapoint=responses_per_datapoint,
565
+ filters=filters,
566
+ selections=selections,
567
+ settings=settings,
568
+ )
365
569
 
366
- if data_type == RapidataDataTypes.MEDIA:
367
- assets = [MediaAsset(path=path) for path in datapoints]
368
- elif data_type == RapidataDataTypes.TEXT:
369
- assets = [TextAsset(text=text) for text in datapoints]
370
- else:
371
- raise ValueError(f"Unsupported data type: {data_type}, must be one of {RapidataDataTypes._possible_values()}")
372
-
373
- return self._create_general_order(
374
- name=name,
375
- workflow=FreeTextWorkflow(
376
- instruction=instruction
377
- ),
378
- assets=assets,
379
- responses_per_datapoint=responses_per_datapoint,
380
- filters=filters,
381
- selections=selections,
382
- settings=settings,
383
- default_labeling_amount=1,
384
- private_notes=private_notes
385
- )
386
-
387
- def create_select_words_order(self,
388
- name: str,
389
- instruction: str,
390
- datapoints: list[str],
391
- sentences: list[str],
392
- responses_per_datapoint: int = 10,
393
- validation_set_id: str | None = None,
394
- filters: Sequence[RapidataFilter] = [],
395
- settings: Sequence[RapidataSetting] = [],
396
- selections: Sequence[RapidataSelection] = [],
397
- private_notes: list[str] | None = None,
398
- ) -> RapidataOrder:
570
+ def create_select_words_order(
571
+ self,
572
+ name: str,
573
+ instruction: str,
574
+ datapoints: list[str],
575
+ sentences: list[str],
576
+ responses_per_datapoint: int = 10,
577
+ validation_set_id: str | None = None,
578
+ filters: Sequence[RapidataFilter] | None = None,
579
+ settings: Sequence[RapidataSetting] | None = None,
580
+ selections: Sequence[RapidataSelection] | None = None,
581
+ private_notes: list[str] | None = None,
582
+ ) -> RapidataOrder:
399
583
  """Create a select words order.
400
584
 
585
+ With this order you can have a datapoint (image, text, video, audio) be labeled with a list of words.
586
+ The annotators will be shown a datapoint as well as a list of sentences split up by spaces.
587
+ They will then select specific words based on the instruction.
588
+
401
589
  Args:
402
590
  name (str): The name of the order.
403
591
  instruction (str): The instruction for how the words should be selected. Will be shown along side each datapoint.
@@ -411,43 +599,67 @@ class RapidataOrderManager:
411
599
  settings (Sequence[RapidataSetting], optional): The list of settings for the select words. Defaults to []. Decides how the tasks should be shown.
412
600
  selections (Sequence[RapidataSelection], optional): The list of selections for the select words. Defaults to []. Decides in what order the tasks should be shown.
413
601
  private_notes (list[str], optional): The list of private notes for the select words. Defaults to None.\n
414
- If provided has to be the same length as datapoints.\n
602
+ If provided has to be the same length as datapoints.\n
415
603
  This will NOT be shown to the labelers but will be included in the result purely for your own reference.
604
+
605
+ Example:
606
+ ```python
607
+ from rapidata import RapidataClient
608
+
609
+ rapi = RapidataClient()
610
+ order = rapi.order.create_select_words_order(
611
+ name="Find Text-Image Mismatches",
612
+ instruction="Select words that don't match what's shown in the image",
613
+ datapoints=["https://example.com/image1.jpg", "https://example.com/image2.jpg"],
614
+ sentences=["A red car on a blue road", "Two cats playing with yarn"],
615
+ responses_per_datapoint=15,
616
+ ).run()
617
+
618
+ results = order.get_results()
619
+ ```
416
620
  """
621
+ with tracer.start_as_current_span(
622
+ "RapidataOrderManager.create_select_words_order"
623
+ ):
624
+ from rapidata.rapidata_client.workflow import SelectWordsWorkflow
625
+
626
+ datapoints_instances = DatapointsValidator.map_datapoints(
627
+ datapoints=datapoints,
628
+ sentences=sentences,
629
+ private_notes=private_notes,
630
+ )
631
+ return self._create_general_order(
632
+ name=name,
633
+ workflow=SelectWordsWorkflow(
634
+ instruction=instruction,
635
+ ),
636
+ datapoints=datapoints_instances,
637
+ responses_per_datapoint=responses_per_datapoint,
638
+ validation_set_id=validation_set_id,
639
+ filters=filters,
640
+ selections=selections,
641
+ settings=settings,
642
+ )
417
643
 
418
- assets = [MediaAsset(path=path) for path in datapoints]
419
-
420
- return self._create_general_order(
421
- name=name,
422
- workflow=SelectWordsWorkflow(
423
- instruction=instruction
424
- ),
425
- assets=assets,
426
- responses_per_datapoint=responses_per_datapoint,
427
- validation_set_id=validation_set_id,
428
- filters=filters,
429
- selections=selections,
430
- settings=settings,
431
- sentences=sentences,
432
- default_labeling_amount=2,
433
- private_notes=private_notes
434
- )
435
-
436
- def create_locate_order(self,
437
- name: str,
438
- instruction: str,
439
- datapoints: list[str],
440
- responses_per_datapoint: int = 10,
441
- contexts: list[str] | None = None,
442
- media_contexts: list[str] | None = None,
443
- validation_set_id: str | None = None,
444
- filters: Sequence[RapidataFilter] = [],
445
- settings: Sequence[RapidataSetting] = [],
446
- selections: Sequence[RapidataSelection] = [],
447
- private_notes: list[str] | None = None,
448
- ) -> RapidataOrder:
644
+ def create_locate_order(
645
+ self,
646
+ name: str,
647
+ instruction: str,
648
+ datapoints: list[str],
649
+ responses_per_datapoint: int = 10,
650
+ contexts: list[str] | None = None,
651
+ media_contexts: list[str] | None = None,
652
+ validation_set_id: str | None = None,
653
+ filters: Sequence[RapidataFilter] | None = None,
654
+ settings: Sequence[RapidataSetting] | None = None,
655
+ selections: Sequence[RapidataSelection] | None = None,
656
+ private_notes: list[str] | None = None,
657
+ ) -> RapidataOrder:
449
658
  """Create a locate order.
450
659
 
660
+ With this order you can have people locate specific objects in a datapoint (image, text, video, audio).
661
+ The annotators will be shown a datapoint and will be asked to select locations based on the instruction.
662
+
451
663
  Args:
452
664
  name (str): The name of the order.
453
665
  instruction (str): The instruction what should be located. Will be shown along side each datapoint.
@@ -464,41 +676,63 @@ class RapidataOrderManager:
464
676
  settings (Sequence[RapidataSetting], optional): The list of settings for the locate. Defaults to []. Decides how the tasks should be shown.
465
677
  selections (Sequence[RapidataSelection], optional): The list of selections for the locate. Defaults to []. Decides in what order the tasks should be shown.
466
678
  private_notes (list[str], optional): The list of private notes for the locate. Defaults to None.\n
467
- If provided has to be the same length as datapoints.\n
679
+ If provided has to be the same length as datapoints.\n
468
680
  This will NOT be shown to the labelers but will be included in the result purely for your own reference.
469
- """
470
681
 
471
- assets = [MediaAsset(path=path) for path in datapoints]
472
-
473
- return self._create_general_order(
474
- name=name,
475
- workflow=LocateWorkflow(target=instruction),
476
- assets=assets,
477
- responses_per_datapoint=responses_per_datapoint,
478
- contexts=contexts,
479
- media_contexts=media_contexts,
480
- validation_set_id=validation_set_id,
481
- filters=filters,
482
- selections=selections,
483
- settings=settings,
484
- private_notes=private_notes
485
- )
682
+ Example:
683
+ ```python
684
+ from rapidata import RapidataClient
685
+
686
+ rapi = RapidataClient()
687
+ order = rapi.order.create_locate_order(
688
+ name="Find Artifacts",
689
+ instruction="Tap on any visual glitches or errors in the image",
690
+ datapoints=["https://example.com/ai_generated1.jpg", "https://example.com/ai_generated2.jpg"],
691
+ responses_per_datapoint=35,
692
+ ).run()
486
693
 
487
- def create_draw_order(self,
488
- name: str,
489
- instruction: str,
490
- datapoints: list[str],
491
- responses_per_datapoint: int = 10,
492
- contexts: list[str] | None = None,
493
- media_contexts: list[str] | None = None,
494
- validation_set_id: str | None = None,
495
- filters: Sequence[RapidataFilter] = [],
496
- settings: Sequence[RapidataSetting] = [],
497
- selections: Sequence[RapidataSelection] = [],
498
- private_notes: list[str] | None = None,
499
- ) -> RapidataOrder:
694
+ results = order.get_results()
695
+ ```
696
+ """
697
+ with tracer.start_as_current_span("RapidataOrderManager.create_locate_order"):
698
+ from rapidata.rapidata_client.workflow import LocateWorkflow
699
+
700
+ datapoints_instances = DatapointsValidator.map_datapoints(
701
+ datapoints=datapoints,
702
+ contexts=contexts,
703
+ media_contexts=media_contexts,
704
+ private_notes=private_notes,
705
+ )
706
+ return self._create_general_order(
707
+ name=name,
708
+ workflow=LocateWorkflow(target=instruction),
709
+ datapoints=datapoints_instances,
710
+ responses_per_datapoint=responses_per_datapoint,
711
+ validation_set_id=validation_set_id,
712
+ filters=filters,
713
+ selections=selections,
714
+ settings=settings,
715
+ )
716
+
717
+ def create_draw_order(
718
+ self,
719
+ name: str,
720
+ instruction: str,
721
+ datapoints: list[str],
722
+ responses_per_datapoint: int = 10,
723
+ contexts: list[str] | None = None,
724
+ media_contexts: list[str] | None = None,
725
+ validation_set_id: str | None = None,
726
+ filters: Sequence[RapidataFilter] | None = None,
727
+ settings: Sequence[RapidataSetting] | None = None,
728
+ selections: Sequence[RapidataSelection] | None = None,
729
+ private_notes: list[str] | None = None,
730
+ ) -> RapidataOrder:
500
731
  """Create a draw order.
501
732
 
733
+ With this order you can have people draw lines on a datapoint (image, text, video, audio).
734
+ The annotators will be shown a datapoint and will be asked to draw lines based on the instruction.
735
+
502
736
  Args:
503
737
  name (str): The name of the order.
504
738
  instruction (str): The instruction for how the lines should be drawn. Will be shown along side each datapoint.
@@ -515,41 +749,66 @@ class RapidataOrderManager:
515
749
  settings (Sequence[RapidataSetting], optional): The list of settings for the draw lines. Defaults to []. Decides how the tasks should be shown.
516
750
  selections (Sequence[RapidataSelection], optional): The list of selections for the draw lines. Defaults to []. Decides in what order the tasks should be shown.
517
751
  private_notes (list[str], optional): The list of private notes for the draw lines. Defaults to None.\n
518
- If provided has to be the same length as datapoints.\n
752
+ If provided has to be the same length as datapoints.\n
519
753
  This will NOT be shown to the labelers but will be included in the result purely for your own reference.
754
+
755
+ Example:
756
+ ```python
757
+ from rapidata import RapidataClient
758
+
759
+ rapi = RapidataClient()
760
+ order = rapi.order.create_draw_order(
761
+ name="Segment Objects",
762
+ instruction="Color in all the cars in the image",
763
+ datapoints=["https://example.com/street1.jpg", "https://example.com/street2.jpg"],
764
+ responses_per_datapoint=35,
765
+ ).run()
766
+
767
+ results = order.get_results()
768
+ ```
520
769
  """
770
+ with tracer.start_as_current_span("RapidataOrderManager.create_draw_order"):
771
+ from rapidata.rapidata_client.workflow import DrawWorkflow
772
+
773
+ datapoints_instances = DatapointsValidator.map_datapoints(
774
+ datapoints=datapoints,
775
+ contexts=contexts,
776
+ media_contexts=media_contexts,
777
+ private_notes=private_notes,
778
+ )
779
+ return self._create_general_order(
780
+ name=name,
781
+ workflow=DrawWorkflow(target=instruction),
782
+ datapoints=datapoints_instances,
783
+ responses_per_datapoint=responses_per_datapoint,
784
+ validation_set_id=validation_set_id,
785
+ filters=filters,
786
+ selections=selections,
787
+ settings=settings,
788
+ )
521
789
 
522
- assets = [MediaAsset(path=path) for path in datapoints]
523
-
524
- return self._create_general_order(
525
- name=name,
526
- workflow=DrawWorkflow(target=instruction),
527
- assets=assets,
528
- responses_per_datapoint=responses_per_datapoint,
529
- contexts=contexts,
530
- media_contexts=media_contexts,
531
- validation_set_id=validation_set_id,
532
- filters=filters,
533
- selections=selections,
534
- settings=settings,
535
- private_notes=private_notes
536
- )
537
-
538
- def create_timestamp_order(self,
539
- name: str,
540
- instruction: str,
541
- datapoints: list[str],
542
- responses_per_datapoint: int = 10,
543
- contexts: list[str] | None = None,
544
- media_contexts: list[str] | None = None,
545
- validation_set_id: str | None = None,
546
- filters: Sequence[RapidataFilter] = [],
547
- settings: Sequence[RapidataSetting] = [],
548
- selections: Sequence[RapidataSelection] = [],
549
- private_notes: list[str] | None = None,
550
- ) -> RapidataOrder:
790
+ def create_timestamp_order(
791
+ self,
792
+ name: str,
793
+ instruction: str,
794
+ datapoints: list[str],
795
+ responses_per_datapoint: int = 10,
796
+ contexts: list[str] | None = None,
797
+ media_contexts: list[str] | None = None,
798
+ validation_set_id: str | None = None,
799
+ filters: Sequence[RapidataFilter] | None = None,
800
+ settings: Sequence[RapidataSetting] | None = None,
801
+ selections: Sequence[RapidataSelection] | None = None,
802
+ private_notes: list[str] | None = None,
803
+ ) -> RapidataOrder:
551
804
  """Create a timestamp order.
552
805
 
806
+ Warning:
807
+ This order is currently not fully supported and may give unexpected results.
808
+
809
+ With this order you can have people mark specific timestamps in a datapoint (video, audio).
810
+ The annotators will be shown a datapoint and will be asked to select a timestamp based on the instruction.
811
+
553
812
  Args:
554
813
  name (str): The name of the order.
555
814
  instruction (str): The instruction for the timestamp task. Will be shown along side each datapoint.
@@ -566,32 +825,31 @@ class RapidataOrderManager:
566
825
  settings (Sequence[RapidataSetting], optional): The list of settings for the timestamp. Defaults to []. Decides how the tasks should be shown.
567
826
  selections (Sequence[RapidataSelection], optional): The list of selections for the timestamp. Defaults to []. Decides in what order the tasks should be shown.
568
827
  private_notes (list[str], optional): The list of private notes for the timestamp. Defaults to None.\n
569
- If provided has to be the same length as datapoints.\n
828
+ If provided has to be the same length as datapoints.\n
570
829
  This will NOT be shown to the labelers but will be included in the result purely for your own reference.
571
830
  """
572
831
 
573
- assets = [MediaAsset(path=path) for path in datapoints]
574
-
575
- for asset in tqdm(assets, desc="Downloading assets and checking duration"):
576
- if not asset.get_duration():
577
- raise ValueError("The datapoints for this order must have a duration. (e.g. video or audio)")
578
-
579
- return self._create_general_order(
580
- name=name,
581
- workflow=TimestampWorkflow(
582
- instruction=instruction
583
- ),
584
- assets=assets,
585
- responses_per_datapoint=responses_per_datapoint,
586
- contexts=contexts,
587
- media_contexts=media_contexts,
588
- validation_set_id=validation_set_id,
589
- filters=filters,
590
- selections=selections,
591
- settings=settings,
592
- default_labeling_amount=2,
593
- private_notes=private_notes
594
- )
832
+ with tracer.start_as_current_span(
833
+ "RapidataOrderManager.create_timestamp_order"
834
+ ):
835
+ from rapidata.rapidata_client.workflow import TimestampWorkflow
836
+
837
+ datapoints_instances = DatapointsValidator.map_datapoints(
838
+ datapoints=datapoints,
839
+ contexts=contexts,
840
+ media_contexts=media_contexts,
841
+ private_notes=private_notes,
842
+ )
843
+ return self._create_general_order(
844
+ name=name,
845
+ workflow=TimestampWorkflow(instruction=instruction),
846
+ datapoints=datapoints_instances,
847
+ responses_per_datapoint=responses_per_datapoint,
848
+ validation_set_id=validation_set_id,
849
+ filters=filters,
850
+ selections=selections,
851
+ settings=settings,
852
+ )
595
853
 
596
854
  def get_order_by_id(self, order_id: str) -> RapidataOrder:
597
855
  """Get an order by ID.
@@ -602,39 +860,63 @@ class RapidataOrderManager:
602
860
  Returns:
603
861
  RapidataOrder: The Order instance.
604
862
  """
863
+ with tracer.start_as_current_span("RapidataOrderManager.get_order_by_id"):
864
+ from rapidata.rapidata_client.order.rapidata_order import RapidataOrder
605
865
 
606
- try:
607
- order = self._openapi_service.order_api.order_order_id_get(order_id)
608
- except Exception:
609
- raise ValueError(f"Order with ID {order_id} not found.")
866
+ order = self.__openapi_service.order_api.order_order_id_get(order_id)
610
867
 
611
- return RapidataOrder(
612
- order_id=order_id,
613
- name=order.order_name,
614
- openapi_service=self._openapi_service)
868
+ return RapidataOrder(
869
+ order_id=order_id,
870
+ name=order.order_name,
871
+ openapi_service=self.__openapi_service,
872
+ )
615
873
 
616
- def find_orders(self, name: str = "", amount: int = 1) -> list[RapidataOrder]:
874
+ def find_orders(self, name: str = "", amount: int = 10) -> list[RapidataOrder]:
617
875
  """Find your recent orders given criteria. If nothing is provided, it will return the most recent order.
618
876
 
619
877
  Args:
620
878
  name (str, optional): The name of the order - matching order will contain the name. Defaults to "" for any order.
621
- amount (int, optional): The amount of orders to return. Defaults to 1.
879
+ amount (int, optional): The amount of orders to return. Defaults to 10.
622
880
 
623
881
  Returns:
624
882
  list[RapidataOrder]: A list of RapidataOrder instances.
625
883
  """
626
- try:
627
- order_page_result = self._openapi_service.order_api.orders_get(QueryModel(
628
- page=PageInfo(index=1, size=amount),
629
- filter=RootFilter(filters=[Filter(field="OrderName", operator="Contains", value=name)]),
630
- sortCriteria=[SortCriterion(direction="Desc", propertyName="OrderDate")]
631
- ))
884
+ with tracer.start_as_current_span("RapidataOrderManager.find_orders"):
885
+ from rapidata.api_client.models.page_info import PageInfo
886
+ from rapidata.api_client.models.query_model import QueryModel
887
+ from rapidata.api_client.models.root_filter import RootFilter
888
+ from rapidata.api_client.models.filter import Filter
889
+ from rapidata.api_client.models.filter_operator import FilterOperator
890
+ from rapidata.api_client.models.sort_criterion import SortCriterion
891
+ from rapidata.api_client.models.sort_direction import SortDirection
892
+
893
+ order_page_result = self.__openapi_service.order_api.orders_get(
894
+ QueryModel(
895
+ page=PageInfo(index=1, size=amount),
896
+ filter=RootFilter(
897
+ filters=[
898
+ Filter(
899
+ field="OrderName",
900
+ operator=FilterOperator.CONTAINS,
901
+ value=name,
902
+ )
903
+ ]
904
+ ),
905
+ sortCriteria=[
906
+ SortCriterion(
907
+ direction=SortDirection.DESC, propertyName="OrderDate"
908
+ )
909
+ ],
910
+ )
911
+ )
632
912
 
633
- except BadRequestException as e:
634
- raise ValueError(f"Error occured during request. \nError: {e.body} \nTraceid: {e.headers.get('X-Trace-Id') if isinstance(e.headers, HTTPHeaderDict) else 'Unknown'}")
913
+ orders = [
914
+ self.get_order_by_id(order.id) for order in order_page_result.items
915
+ ]
916
+ return orders
635
917
 
636
- except Exception as e:
637
- raise ValueError(f"Unknown error occured: {e}")
918
+ def __str__(self) -> str:
919
+ return "RapidataOrderManager"
638
920
 
639
- orders = [self.get_order_by_id(order.id) for order in order_page_result.items]
640
- return orders
921
+ def __repr__(self) -> str:
922
+ return self.__str__()