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

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

Potentially problematic release.


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

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