rapidata 2.35.3__py3-none-any.whl → 2.36.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.
- rapidata/__init__.py +1 -1
- rapidata/api_client/__init__.py +25 -4
- rapidata/api_client/api/__init__.py +1 -0
- rapidata/api_client/api/benchmark_api.py +294 -0
- rapidata/api_client/api/campaign_api.py +268 -0
- rapidata/api_client/api/customer_rapid_api.py +247 -0
- rapidata/api_client/api/leaderboard_api.py +295 -6
- rapidata/api_client/api/pipeline_api.py +0 -873
- rapidata/api_client/api/sample_api.py +299 -0
- rapidata/api_client/api/validation_set_api.py +537 -312
- rapidata/api_client/models/__init__.py +24 -4
- rapidata/api_client/models/add_validation_rapid_model.py +12 -2
- rapidata/api_client/models/add_validation_rapid_model_truth.py +7 -1
- rapidata/api_client/models/and_filter.py +121 -0
- rapidata/api_client/models/and_filter_filters_inner.py +268 -0
- rapidata/api_client/models/asset_type.py +40 -0
- rapidata/api_client/models/boost_mode.py +37 -0
- rapidata/api_client/models/boost_query_result.py +10 -1
- rapidata/api_client/models/campaign_filter.py +98 -0
- rapidata/api_client/models/change_boost_model.py +89 -0
- rapidata/api_client/models/compare_rapid_blueprint.py +5 -3
- rapidata/api_client/models/compare_rapid_blueprint1.py +96 -0
- rapidata/api_client/models/country_filter.py +98 -0
- rapidata/api_client/models/create_leaderboard_model.py +32 -2
- rapidata/api_client/models/demographic_filter.py +100 -0
- rapidata/api_client/models/feature_flag_model.py +4 -4
- rapidata/api_client/models/free_text_payload.py +10 -3
- rapidata/api_client/models/free_text_rapid_blueprint.py +10 -3
- rapidata/api_client/models/get_compare_ab_summary_result.py +4 -2
- rapidata/api_client/models/get_leaderboard_by_id_result.py +29 -2
- rapidata/api_client/models/get_public_responses_result.py +95 -0
- rapidata/api_client/models/get_sample_by_id_result.py +126 -0
- rapidata/api_client/models/language_filter.py +98 -0
- rapidata/api_client/models/leaderboard_query_result.py +29 -2
- rapidata/api_client/models/new_user_filter.py +96 -0
- rapidata/api_client/models/not_filter.py +117 -0
- rapidata/api_client/models/or_filter.py +121 -0
- rapidata/api_client/models/prompt_type.py +38 -0
- rapidata/api_client/models/public_rapid_response.py +112 -0
- rapidata/api_client/models/rapid_modality.py +46 -0
- rapidata/api_client/models/response_count_filter.py +109 -0
- rapidata/api_client/models/sample_by_identifier.py +126 -0
- rapidata/api_client/models/sample_by_identifier_paged_result.py +105 -0
- rapidata/api_client/models/simple_workflow_config_blueprint.py +37 -23
- rapidata/api_client/models/update_leaderboard_model.py +91 -0
- rapidata/api_client/models/user_score_filter.py +102 -0
- rapidata/api_client/models/user_state.py +38 -0
- rapidata/api_client/models/user_state_filter.py +101 -0
- rapidata/api_client/models/validation_set_model.py +54 -3
- rapidata/api_client_README.md +33 -10
- rapidata/rapidata_client/benchmark/rapidata_benchmark.py +26 -2
- rapidata/rapidata_client/order/rapidata_order_manager.py +298 -219
- rapidata/rapidata_client/workflow/_compare_workflow.py +7 -2
- rapidata/rapidata_client/workflow/_free_text_workflow.py +9 -2
- {rapidata-2.35.3.dist-info → rapidata-2.36.1.dist-info}/METADATA +1 -1
- {rapidata-2.35.3.dist-info → rapidata-2.36.1.dist-info}/RECORD +58 -32
- {rapidata-2.35.3.dist-info → rapidata-2.36.1.dist-info}/LICENSE +0 -0
- {rapidata-2.35.3.dist-info → rapidata-2.36.1.dist-info}/WHEEL +0 -0
rapidata/api_client_README.md
CHANGED
|
@@ -81,9 +81,11 @@ Class | Method | HTTP request | Description
|
|
|
81
81
|
*BenchmarkApi* | [**benchmark_benchmark_id_participants_post**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participants_post) | **POST** /benchmark/{benchmarkId}/participants | Creates a participant in a benchmark.
|
|
82
82
|
*BenchmarkApi* | [**benchmark_benchmark_id_prompt_post**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_prompt_post) | **POST** /benchmark/{benchmarkId}/prompt | Adds a new prompt to a benchmark.
|
|
83
83
|
*BenchmarkApi* | [**benchmark_benchmark_id_prompts_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_prompts_get) | **GET** /benchmark/{benchmarkId}/prompts | Returns the paged prompts of a benchmark by its ID.
|
|
84
|
+
*BenchmarkApi* | [**benchmark_benchmark_id_samples_identifier_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_samples_identifier_get) | **GET** /benchmark/{benchmarkId}/samples/{identifier} | Returns the paged prompts of a benchmark by its ID.
|
|
84
85
|
*BenchmarkApi* | [**benchmark_benchmark_id_tags_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_tags_get) | **GET** /benchmark/{benchmarkId}/tags | Query all tags within a benchmark
|
|
85
86
|
*BenchmarkApi* | [**benchmark_post**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_post) | **POST** /benchmark | Creates a benchmark
|
|
86
87
|
*BenchmarkApi* | [**benchmarks_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmarks_get) | **GET** /benchmarks | Queries all benchmarks of the user.
|
|
88
|
+
*CampaignApi* | [**campaign_boost_put**](rapidata/api_client/docs/CampaignApi.md#campaign_boost_put) | **PUT** /campaign/boost | Updates the boost with manual boosts.
|
|
87
89
|
*CampaignApi* | [**campaign_boost_status_get**](rapidata/api_client/docs/CampaignApi.md#campaign_boost_status_get) | **GET** /campaign/boost/status | Gets the status of the boost.
|
|
88
90
|
*CampaignApi* | [**campaign_campaign_id_pause_post**](rapidata/api_client/docs/CampaignApi.md#campaign_campaign_id_pause_post) | **POST** /campaign/{campaignId}/pause | Pauses a campaign.
|
|
89
91
|
*CampaignApi* | [**campaign_campaign_id_resume_post**](rapidata/api_client/docs/CampaignApi.md#campaign_campaign_id_resume_post) | **POST** /campaign/{campaignId}/resume | Resumes a campaign.
|
|
@@ -99,6 +101,7 @@ Class | Method | HTTP request | Description
|
|
|
99
101
|
*CompareWorkflowApi* | [**workflow_compare_workflow_id_results_get**](rapidata/api_client/docs/CompareWorkflowApi.md#workflow_compare_workflow_id_results_get) | **GET** /workflow/compare/{workflowId}/results | Get the result overview for a compare workflow.
|
|
100
102
|
*CustomerRapidApi* | [**rapid_correlation_id_validation_potential_get**](rapidata/api_client/docs/CustomerRapidApi.md#rapid_correlation_id_validation_potential_get) | **GET** /rapid/{correlationId}/validation-potential | Queries rapids that are potentially eligible for validation set creation.
|
|
101
103
|
*CustomerRapidApi* | [**rapid_demographic_post**](rapidata/api_client/docs/CustomerRapidApi.md#rapid_demographic_post) | **POST** /rapid/demographic | Creates a new Demographic Rapid.
|
|
104
|
+
*CustomerRapidApi* | [**rapid_global_responses_get**](rapidata/api_client/docs/CustomerRapidApi.md#rapid_global_responses_get) | **GET** /rapid/global-responses | A public endpoint to query the most recent responses globally
|
|
102
105
|
*CustomerRapidApi* | [**rapid_rapid_id_delete**](rapidata/api_client/docs/CustomerRapidApi.md#rapid_rapid_id_delete) | **DELETE** /rapid/{rapidId} | Deletes a rapid.
|
|
103
106
|
*CustomerRapidApi* | [**rapid_rapid_id_responses_get**](rapidata/api_client/docs/CustomerRapidApi.md#rapid_rapid_id_responses_get) | **GET** /rapid/{rapidId}/responses | Gets all responses for a given rapid.
|
|
104
107
|
*CustomerRapidApi* | [**rapid_rapid_id_unflag_post**](rapidata/api_client/docs/CustomerRapidApi.md#rapid_rapid_id_unflag_post) | **POST** /rapid/{rapidId}/unflag | Unflags a flagged rapid. This will add the rapid back to the active labeling pool and prevent it from being flagged again.
|
|
@@ -133,6 +136,7 @@ Class | Method | HTTP request | Description
|
|
|
133
136
|
*LeaderboardApi* | [**leaderboard_leaderboard_id_participants_get**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_participants_get) | **GET** /leaderboard/{leaderboardId}/participants | queries all the participants connected to leaderboard by its ID.
|
|
134
137
|
*LeaderboardApi* | [**leaderboard_leaderboard_id_participants_participant_id_submit_post**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_participants_participant_id_submit_post) | **POST** /leaderboard/{leaderboardId}/participants/{participantId}/submit | Submits a participant to a leaderboard.
|
|
135
138
|
*LeaderboardApi* | [**leaderboard_leaderboard_id_participants_post**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_participants_post) | **POST** /leaderboard/{leaderboardId}/participants | Creates a participant in a leaderboard.
|
|
139
|
+
*LeaderboardApi* | [**leaderboard_leaderboard_id_patch**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_patch) | **PATCH** /leaderboard/{leaderboardId} | Updates the response config of a leaderboard.
|
|
136
140
|
*LeaderboardApi* | [**leaderboard_leaderboard_id_prompts_get**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_prompts_get) | **GET** /leaderboard/{leaderboardId}/prompts | returns the paged prompts of a leaderboard by its ID.
|
|
137
141
|
*LeaderboardApi* | [**leaderboard_leaderboard_id_prompts_post**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_prompts_post) | **POST** /leaderboard/{leaderboardId}/prompts | adds a new prompt to a leaderboard.
|
|
138
142
|
*LeaderboardApi* | [**leaderboard_leaderboard_id_response_config_put**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_response_config_put) | **PUT** /leaderboard/{leaderboardId}/response-config | Updates the response config of a leaderboard.
|
|
@@ -172,14 +176,12 @@ Class | Method | HTTP request | Description
|
|
|
172
176
|
*ParticipantApi* | [**participants_participant_id_submit_post**](rapidata/api_client/docs/ParticipantApi.md#participants_participant_id_submit_post) | **POST** /participants/{participantId}/submit | Submits a participant to a benchmark.
|
|
173
177
|
*PipelineApi* | [**pipeline_id_workflow_config_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_config_artifact_id_put) | **PUT** /pipeline/{id}/workflow-config/{artifactId} | Updates the workflow configuration for a pipeline.
|
|
174
178
|
*PipelineApi* | [**pipeline_id_workflow_config_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_config_put) | **PUT** /pipeline/{id}/workflow-config | Updates the workflow configuration for a pipeline.
|
|
175
|
-
*PipelineApi* | [**pipeline_pipeline_id_campaign_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_campaign_artifact_id_put) | **PUT** /pipeline/{pipelineId}/campaign/{artifactId} | Updates a specific campaign for a pipeline.
|
|
176
|
-
*PipelineApi* | [**pipeline_pipeline_id_campaign_post**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_campaign_post) | **POST** /pipeline/{pipelineId}/campaign | Adds a campaign to a pipeline.
|
|
177
|
-
*PipelineApi* | [**pipeline_pipeline_id_campaign_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_campaign_put) | **PUT** /pipeline/{pipelineId}/campaign | Updates a specific campaign for a pipeline.
|
|
178
179
|
*PipelineApi* | [**pipeline_pipeline_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_get) | **GET** /pipeline/{pipelineId} | Gets a pipeline by its id.
|
|
179
180
|
*PipelineApi* | [**pipeline_pipeline_id_preliminary_download_post**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_preliminary_download_post) | **POST** /pipeline/{pipelineId}/preliminary-download | Initiates a preliminary download of the pipeline.
|
|
180
181
|
*PipelineApi* | [**pipeline_preliminary_download_preliminary_download_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_preliminary_download_preliminary_download_id_get) | **GET** /pipeline/preliminary-download/{preliminaryDownloadId} | Gets the preliminary download.
|
|
181
182
|
*PromptApi* | [**benchmark_prompt_prompt_id_tags_put**](rapidata/api_client/docs/PromptApi.md#benchmark_prompt_prompt_id_tags_put) | **PUT** /benchmark-prompt/{promptId}/tags | Updates the tags associated with a prompt.
|
|
182
183
|
*RapidataIdentityAPIApi* | [**root_get**](rapidata/api_client/docs/RapidataIdentityAPIApi.md#root_get) | **GET** / |
|
|
184
|
+
*SampleApi* | [**benchmark_sample_sample_id_get**](rapidata/api_client/docs/SampleApi.md#benchmark_sample_sample_id_get) | **GET** /benchmark-sample/{sampleId} | Gets a sample by its Id.
|
|
183
185
|
*SimpleWorkflowApi* | [**workflow_simple_workflow_id_results_get**](rapidata/api_client/docs/SimpleWorkflowApi.md#workflow_simple_workflow_id_results_get) | **GET** /workflow/simple/{workflowId}/results | Get the result overview for a simple workflow.
|
|
184
186
|
*UserInfoApi* | [**connect_userinfo_get**](rapidata/api_client/docs/UserInfoApi.md#connect_userinfo_get) | **GET** /connect/userinfo | Retrieves information about the authenticated user.
|
|
185
187
|
*UserRapidApi* | [**rapid_rapid_bag_is_valid_get**](rapidata/api_client/docs/UserRapidApi.md#rapid_rapid_bag_is_valid_get) | **GET** /rapid/rapid-bag/is-valid | Validates that the rapids associated with the current user are active.
|
|
@@ -188,21 +190,22 @@ Class | Method | HTTP request | Description
|
|
|
188
190
|
*UserRapidApi* | [**rapid_response_post**](rapidata/api_client/docs/UserRapidApi.md#rapid_response_post) | **POST** /rapid/response | Submits a response for a Rapid.
|
|
189
191
|
*UserRapidApi* | [**rapid_skip_post**](rapidata/api_client/docs/UserRapidApi.md#rapid_skip_post) | **POST** /rapid/skip | Skips a Rapid for the user.
|
|
190
192
|
*ValidationSetApi* | [**validation_set_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_post) | **POST** /validation-set | Creates a new empty validation set.
|
|
193
|
+
*ValidationSetApi* | [**validation_set_recommended_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_recommended_get) | **GET** /validation-set/recommended | Gets a validation set that is available to the user and best matches the provided parameters.
|
|
191
194
|
*ValidationSetApi* | [**validation_set_validation_set_id_delete**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_delete) | **DELETE** /validation-set/{validationSetId} | Gets a validation set by the id.
|
|
192
195
|
*ValidationSetApi* | [**validation_set_validation_set_id_dimensions_patch**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_dimensions_patch) | **PATCH** /validation-set/{validationSetId}/dimensions | Updates the dimensions of all rapids within a validation set.
|
|
193
196
|
*ValidationSetApi* | [**validation_set_validation_set_id_dimensions_put**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_dimensions_put) | **PUT** /validation-set/{validationSetId}/dimensions | Updates the dimensions of all rapids within a validation set.
|
|
194
197
|
*ValidationSetApi* | [**validation_set_validation_set_id_export_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_export_get) | **GET** /validation-set/{validationSetId}/export | Exports all rapids of a validation-set to a file.
|
|
195
198
|
*ValidationSetApi* | [**validation_set_validation_set_id_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_get) | **GET** /validation-set/{validationSetId} | Gets a validation set by the id.
|
|
196
|
-
*ValidationSetApi* | [**validation_set_validation_set_id_rapid_files_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_rapid_files_post) | **POST** /validation-set/{validationSetId}/rapid/files | Adds a new validation rapid to the specified validation set using files to create the assets.
|
|
197
199
|
*ValidationSetApi* | [**validation_set_validation_set_id_rapid_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_rapid_post) | **POST** /validation-set/{validationSetId}/rapid | Adds a new validation rapid to the specified validation set using files to create the assets.
|
|
198
|
-
*ValidationSetApi* | [**validation_set_validation_set_id_rapid_texts_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_rapid_texts_post) | **POST** /validation-set/{validationSetId}/rapid/texts | Adds a new validation rapid to the specified validation set using text sources to create the assets.
|
|
199
200
|
*ValidationSetApi* | [**validation_set_validation_set_id_rapids_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_rapids_get) | **GET** /validation-set/{validationSetId}/rapids | Queries the validation rapids for a specific validation set.
|
|
200
201
|
*ValidationSetApi* | [**validation_set_validation_set_id_shouldalert_patch**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_shouldalert_patch) | **PATCH** /validation-set/{validationSetId}/shouldalert | Updates the dimensions of all rapids within a validation set.
|
|
201
202
|
*ValidationSetApi* | [**validation_set_validation_set_id_shouldalert_put**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_shouldalert_put) | **PUT** /validation-set/{validationSetId}/shouldalert | Updates the of all rapshouldAlert property of all rapids within a validation set.
|
|
203
|
+
*ValidationSetApi* | [**validation_set_validation_set_id_update_labeling_hints_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_update_labeling_hints_post) | **POST** /validation-set/{validationSetId}/update-labeling-hints | Refreshes the labeling hints for a validation set.
|
|
204
|
+
*ValidationSetApi* | [**validation_set_validation_set_id_visibility_patch**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_visibility_patch) | **PATCH** /validation-set/{validationSetId}/visibility | Updates the visibility of a validation set.
|
|
202
205
|
*ValidationSetApi* | [**validation_set_zip_compare_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_zip_compare_post) | **POST** /validation-set/zip/compare | Imports a compare validation set from a zip file.
|
|
203
206
|
*ValidationSetApi* | [**validation_set_zip_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_zip_post) | **POST** /validation-set/zip | Imports a validation set from a zip file.
|
|
204
207
|
*ValidationSetApi* | [**validation_sets_available_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_sets_available_get) | **GET** /validation-sets/available | Gets the available validation sets for the current user.
|
|
205
|
-
*ValidationSetApi* | [**validation_sets_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_sets_get) | **GET** /validation-sets | Queries validation sets based on the provided filter, paging and sorting criteria.
|
|
208
|
+
*ValidationSetApi* | [**validation_sets_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_sets_get) | **GET** /validation-sets | Queries available validation sets based on the provided filter, paging and sorting criteria.
|
|
206
209
|
*WorkflowApi* | [**workflow_delete_delete**](rapidata/api_client/docs/WorkflowApi.md#workflow_delete_delete) | **DELETE** /workflow/delete | Deletes a workflow.
|
|
207
210
|
*WorkflowApi* | [**workflow_workflow_id_compare_ab_summary_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_workflow_id_compare_ab_summary_get) | **GET** /workflow/{workflowId}/compare-ab-summary | Calculates a summary of the results for a simple compare workflow. The summary includes the number of times an asset at each index was the winner.
|
|
208
211
|
*WorkflowApi* | [**workflow_workflow_id_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_workflow_id_get) | **GET** /workflow/{workflowId} | Get a workflow by its ID.
|
|
@@ -215,29 +218,30 @@ Class | Method | HTTP request | Description
|
|
|
215
218
|
|
|
216
219
|
- [AbTestSelection](rapidata/api_client/docs/AbTestSelection.md)
|
|
217
220
|
- [AbTestSelectionAInner](rapidata/api_client/docs/AbTestSelectionAInner.md)
|
|
218
|
-
- [AddCampaignArtifactResult](rapidata/api_client/docs/AddCampaignArtifactResult.md)
|
|
219
|
-
- [AddCampaignModel](rapidata/api_client/docs/AddCampaignModel.md)
|
|
220
221
|
- [AddUserResponseResult](rapidata/api_client/docs/AddUserResponseResult.md)
|
|
221
222
|
- [AddValidationRapidModel](rapidata/api_client/docs/AddValidationRapidModel.md)
|
|
222
223
|
- [AddValidationRapidModelPayload](rapidata/api_client/docs/AddValidationRapidModelPayload.md)
|
|
223
224
|
- [AddValidationRapidModelTruth](rapidata/api_client/docs/AddValidationRapidModelTruth.md)
|
|
224
225
|
- [AddValidationRapidResult](rapidata/api_client/docs/AddValidationRapidResult.md)
|
|
225
|
-
- [AddValidationTextRapidModel](rapidata/api_client/docs/AddValidationTextRapidModel.md)
|
|
226
226
|
- [AgeGroup](rapidata/api_client/docs/AgeGroup.md)
|
|
227
227
|
- [AgeUserFilterModel](rapidata/api_client/docs/AgeUserFilterModel.md)
|
|
228
228
|
- [AggregatorType](rapidata/api_client/docs/AggregatorType.md)
|
|
229
|
+
- [AndFilter](rapidata/api_client/docs/AndFilter.md)
|
|
230
|
+
- [AndFilterFiltersInner](rapidata/api_client/docs/AndFilterFiltersInner.md)
|
|
229
231
|
- [AndUserFilterModel](rapidata/api_client/docs/AndUserFilterModel.md)
|
|
230
232
|
- [AndUserFilterModelFiltersInner](rapidata/api_client/docs/AndUserFilterModelFiltersInner.md)
|
|
231
233
|
- [AreRapidsActiveResult](rapidata/api_client/docs/AreRapidsActiveResult.md)
|
|
232
234
|
- [AssetMetadata](rapidata/api_client/docs/AssetMetadata.md)
|
|
233
235
|
- [AssetMetadataAsset](rapidata/api_client/docs/AssetMetadataAsset.md)
|
|
234
236
|
- [AssetMetadataModel](rapidata/api_client/docs/AssetMetadataModel.md)
|
|
237
|
+
- [AssetType](rapidata/api_client/docs/AssetType.md)
|
|
235
238
|
- [AttachCategoryRapidBlueprint](rapidata/api_client/docs/AttachCategoryRapidBlueprint.md)
|
|
236
239
|
- [AttachCategoryResult](rapidata/api_client/docs/AttachCategoryResult.md)
|
|
237
240
|
- [AttachCategoryTruth](rapidata/api_client/docs/AttachCategoryTruth.md)
|
|
238
241
|
- [BenchmarkQueryResult](rapidata/api_client/docs/BenchmarkQueryResult.md)
|
|
239
242
|
- [BenchmarkQueryResultPagedResult](rapidata/api_client/docs/BenchmarkQueryResultPagedResult.md)
|
|
240
243
|
- [BoostLeaderboardModel](rapidata/api_client/docs/BoostLeaderboardModel.md)
|
|
244
|
+
- [BoostMode](rapidata/api_client/docs/BoostMode.md)
|
|
241
245
|
- [BoostQueryResult](rapidata/api_client/docs/BoostQueryResult.md)
|
|
242
246
|
- [BoostStatus](rapidata/api_client/docs/BoostStatus.md)
|
|
243
247
|
- [BoundingBoxPayload](rapidata/api_client/docs/BoundingBoxPayload.md)
|
|
@@ -246,11 +250,13 @@ Class | Method | HTTP request | Description
|
|
|
246
250
|
- [BoundingBoxTruth](rapidata/api_client/docs/BoundingBoxTruth.md)
|
|
247
251
|
- [BoxShape](rapidata/api_client/docs/BoxShape.md)
|
|
248
252
|
- [CampaignArtifactModel](rapidata/api_client/docs/CampaignArtifactModel.md)
|
|
253
|
+
- [CampaignFilter](rapidata/api_client/docs/CampaignFilter.md)
|
|
249
254
|
- [CampaignQueryResult](rapidata/api_client/docs/CampaignQueryResult.md)
|
|
250
255
|
- [CampaignQueryResultPagedResult](rapidata/api_client/docs/CampaignQueryResultPagedResult.md)
|
|
251
256
|
- [CampaignStatus](rapidata/api_client/docs/CampaignStatus.md)
|
|
252
257
|
- [CampaignUserFilterModel](rapidata/api_client/docs/CampaignUserFilterModel.md)
|
|
253
258
|
- [CappedSelection](rapidata/api_client/docs/CappedSelection.md)
|
|
259
|
+
- [ChangeBoostModel](rapidata/api_client/docs/ChangeBoostModel.md)
|
|
254
260
|
- [ClassificationMetadata](rapidata/api_client/docs/ClassificationMetadata.md)
|
|
255
261
|
- [ClassificationMetadataFilterConfig](rapidata/api_client/docs/ClassificationMetadataFilterConfig.md)
|
|
256
262
|
- [ClassificationMetadataModel](rapidata/api_client/docs/ClassificationMetadataModel.md)
|
|
@@ -281,6 +287,7 @@ Class | Method | HTTP request | Description
|
|
|
281
287
|
- [CountClassificationMetadataFilterConfig](rapidata/api_client/docs/CountClassificationMetadataFilterConfig.md)
|
|
282
288
|
- [CountMetadata](rapidata/api_client/docs/CountMetadata.md)
|
|
283
289
|
- [CountMetadataModel](rapidata/api_client/docs/CountMetadataModel.md)
|
|
290
|
+
- [CountryFilter](rapidata/api_client/docs/CountryFilter.md)
|
|
284
291
|
- [CountryUserFilterModel](rapidata/api_client/docs/CountryUserFilterModel.md)
|
|
285
292
|
- [CreateBenchmarkModel](rapidata/api_client/docs/CreateBenchmarkModel.md)
|
|
286
293
|
- [CreateBenchmarkParticipantModel](rapidata/api_client/docs/CreateBenchmarkParticipantModel.md)
|
|
@@ -324,6 +331,7 @@ Class | Method | HTTP request | Description
|
|
|
324
331
|
- [DatasetDatasetIdDatapointsPostRequestMetadataInner](rapidata/api_client/docs/DatasetDatasetIdDatapointsPostRequestMetadataInner.md)
|
|
325
332
|
- [DatasetEvaluationStepModel](rapidata/api_client/docs/DatasetEvaluationStepModel.md)
|
|
326
333
|
- [Demographic](rapidata/api_client/docs/Demographic.md)
|
|
334
|
+
- [DemographicFilter](rapidata/api_client/docs/DemographicFilter.md)
|
|
327
335
|
- [DemographicMetadataModel](rapidata/api_client/docs/DemographicMetadataModel.md)
|
|
328
336
|
- [DemographicSelection](rapidata/api_client/docs/DemographicSelection.md)
|
|
329
337
|
- [DynamicClientRegistrationRequest](rapidata/api_client/docs/DynamicClientRegistrationRequest.md)
|
|
@@ -375,8 +383,10 @@ Class | Method | HTTP request | Description
|
|
|
375
383
|
- [GetPipelineByIdResult](rapidata/api_client/docs/GetPipelineByIdResult.md)
|
|
376
384
|
- [GetPipelineByIdResultArtifactsValue](rapidata/api_client/docs/GetPipelineByIdResultArtifactsValue.md)
|
|
377
385
|
- [GetPublicOrdersResult](rapidata/api_client/docs/GetPublicOrdersResult.md)
|
|
386
|
+
- [GetPublicResponsesResult](rapidata/api_client/docs/GetPublicResponsesResult.md)
|
|
378
387
|
- [GetRapidResponsesResult](rapidata/api_client/docs/GetRapidResponsesResult.md)
|
|
379
388
|
- [GetResponsesResult](rapidata/api_client/docs/GetResponsesResult.md)
|
|
389
|
+
- [GetSampleByIdResult](rapidata/api_client/docs/GetSampleByIdResult.md)
|
|
380
390
|
- [GetSimpleWorkflowResultsModel](rapidata/api_client/docs/GetSimpleWorkflowResultsModel.md)
|
|
381
391
|
- [GetStandingByIdResult](rapidata/api_client/docs/GetStandingByIdResult.md)
|
|
382
392
|
- [GetValidationRapidsResult](rapidata/api_client/docs/GetValidationRapidsResult.md)
|
|
@@ -400,6 +410,7 @@ Class | Method | HTTP request | Description
|
|
|
400
410
|
- [JsonWebKey](rapidata/api_client/docs/JsonWebKey.md)
|
|
401
411
|
- [JsonWebKeySet](rapidata/api_client/docs/JsonWebKeySet.md)
|
|
402
412
|
- [LabelingSelection](rapidata/api_client/docs/LabelingSelection.md)
|
|
413
|
+
- [LanguageFilter](rapidata/api_client/docs/LanguageFilter.md)
|
|
403
414
|
- [LanguageUserFilterModel](rapidata/api_client/docs/LanguageUserFilterModel.md)
|
|
404
415
|
- [LeaderboardQueryResult](rapidata/api_client/docs/LeaderboardQueryResult.md)
|
|
405
416
|
- [LeaderboardQueryResultPagedResult](rapidata/api_client/docs/LeaderboardQueryResultPagedResult.md)
|
|
@@ -440,15 +451,18 @@ Class | Method | HTTP request | Description
|
|
|
440
451
|
- [NamedEntityTruth](rapidata/api_client/docs/NamedEntityTruth.md)
|
|
441
452
|
- [NeverEndingRefereeConfig](rapidata/api_client/docs/NeverEndingRefereeConfig.md)
|
|
442
453
|
- [NeverEndingRefereeInfo](rapidata/api_client/docs/NeverEndingRefereeInfo.md)
|
|
454
|
+
- [NewUserFilter](rapidata/api_client/docs/NewUserFilter.md)
|
|
443
455
|
- [NewUserFilterModel](rapidata/api_client/docs/NewUserFilterModel.md)
|
|
444
456
|
- [NewsletterModel](rapidata/api_client/docs/NewsletterModel.md)
|
|
445
457
|
- [NotAvailableYetResult](rapidata/api_client/docs/NotAvailableYetResult.md)
|
|
458
|
+
- [NotFilter](rapidata/api_client/docs/NotFilter.md)
|
|
446
459
|
- [NotUserFilterModel](rapidata/api_client/docs/NotUserFilterModel.md)
|
|
447
460
|
- [NullAsset](rapidata/api_client/docs/NullAsset.md)
|
|
448
461
|
- [NullAssetModel](rapidata/api_client/docs/NullAssetModel.md)
|
|
449
462
|
- [OnlinePairMakerConfig](rapidata/api_client/docs/OnlinePairMakerConfig.md)
|
|
450
463
|
- [OnlinePairMakerConfigModel](rapidata/api_client/docs/OnlinePairMakerConfigModel.md)
|
|
451
464
|
- [OnlinePairMakerInformation](rapidata/api_client/docs/OnlinePairMakerInformation.md)
|
|
465
|
+
- [OrFilter](rapidata/api_client/docs/OrFilter.md)
|
|
452
466
|
- [OrUserFilterModel](rapidata/api_client/docs/OrUserFilterModel.md)
|
|
453
467
|
- [OrderModel](rapidata/api_client/docs/OrderModel.md)
|
|
454
468
|
- [OrderModelPagedResult](rapidata/api_client/docs/OrderModelPagedResult.md)
|
|
@@ -480,12 +494,15 @@ Class | Method | HTTP request | Description
|
|
|
480
494
|
- [PromptMetadata](rapidata/api_client/docs/PromptMetadata.md)
|
|
481
495
|
- [PromptMetadataInput](rapidata/api_client/docs/PromptMetadataInput.md)
|
|
482
496
|
- [PromptMetadataModel](rapidata/api_client/docs/PromptMetadataModel.md)
|
|
497
|
+
- [PromptType](rapidata/api_client/docs/PromptType.md)
|
|
483
498
|
- [ProxyFileWrapper](rapidata/api_client/docs/ProxyFileWrapper.md)
|
|
484
499
|
- [PublicOrderModel](rapidata/api_client/docs/PublicOrderModel.md)
|
|
500
|
+
- [PublicRapidResponse](rapidata/api_client/docs/PublicRapidResponse.md)
|
|
485
501
|
- [PublicTextMetadataInput](rapidata/api_client/docs/PublicTextMetadataInput.md)
|
|
486
502
|
- [QueryModel](rapidata/api_client/docs/QueryModel.md)
|
|
487
503
|
- [QueryValidationModel](rapidata/api_client/docs/QueryValidationModel.md)
|
|
488
504
|
- [RapidIssue](rapidata/api_client/docs/RapidIssue.md)
|
|
505
|
+
- [RapidModality](rapidata/api_client/docs/RapidModality.md)
|
|
489
506
|
- [RapidModel](rapidata/api_client/docs/RapidModel.md)
|
|
490
507
|
- [RapidModelPagedResult](rapidata/api_client/docs/RapidModelPagedResult.md)
|
|
491
508
|
- [RapidModelReferee](rapidata/api_client/docs/RapidModelReferee.md)
|
|
@@ -499,12 +516,15 @@ Class | Method | HTTP request | Description
|
|
|
499
516
|
- [RegisterTemporaryCustomerModel](rapidata/api_client/docs/RegisterTemporaryCustomerModel.md)
|
|
500
517
|
- [RegisterTemporaryCustomerResult](rapidata/api_client/docs/RegisterTemporaryCustomerResult.md)
|
|
501
518
|
- [ReportModel](rapidata/api_client/docs/ReportModel.md)
|
|
519
|
+
- [ResponseCountFilter](rapidata/api_client/docs/ResponseCountFilter.md)
|
|
502
520
|
- [ResponseCountUserFilterModel](rapidata/api_client/docs/ResponseCountUserFilterModel.md)
|
|
503
521
|
- [RetrievalMode](rapidata/api_client/docs/RetrievalMode.md)
|
|
504
522
|
- [RootFilter](rapidata/api_client/docs/RootFilter.md)
|
|
505
523
|
- [RunStatus](rapidata/api_client/docs/RunStatus.md)
|
|
506
524
|
- [RunsByLeaderboardResult](rapidata/api_client/docs/RunsByLeaderboardResult.md)
|
|
507
525
|
- [RunsByLeaderboardResultPagedResult](rapidata/api_client/docs/RunsByLeaderboardResultPagedResult.md)
|
|
526
|
+
- [SampleByIdentifier](rapidata/api_client/docs/SampleByIdentifier.md)
|
|
527
|
+
- [SampleByIdentifierPagedResult](rapidata/api_client/docs/SampleByIdentifierPagedResult.md)
|
|
508
528
|
- [SampleByParticipant](rapidata/api_client/docs/SampleByParticipant.md)
|
|
509
529
|
- [SampleByParticipantPagedResult](rapidata/api_client/docs/SampleByParticipantPagedResult.md)
|
|
510
530
|
- [ScrubPayload](rapidata/api_client/docs/ScrubPayload.md)
|
|
@@ -560,9 +580,9 @@ Class | Method | HTTP request | Description
|
|
|
560
580
|
- [TranslatedString](rapidata/api_client/docs/TranslatedString.md)
|
|
561
581
|
- [UnlockOrderResult](rapidata/api_client/docs/UnlockOrderResult.md)
|
|
562
582
|
- [UpdateBenchmarkNameModel](rapidata/api_client/docs/UpdateBenchmarkNameModel.md)
|
|
563
|
-
- [UpdateCampaignModel](rapidata/api_client/docs/UpdateCampaignModel.md)
|
|
564
583
|
- [UpdateDatasetNameModel](rapidata/api_client/docs/UpdateDatasetNameModel.md)
|
|
565
584
|
- [UpdateDimensionsModel](rapidata/api_client/docs/UpdateDimensionsModel.md)
|
|
585
|
+
- [UpdateLeaderboardModel](rapidata/api_client/docs/UpdateLeaderboardModel.md)
|
|
566
586
|
- [UpdateLeaderboardNameModel](rapidata/api_client/docs/UpdateLeaderboardNameModel.md)
|
|
567
587
|
- [UpdateLeaderboardResponseConfigModel](rapidata/api_client/docs/UpdateLeaderboardResponseConfigModel.md)
|
|
568
588
|
- [UpdateOrderNameModel](rapidata/api_client/docs/UpdateOrderNameModel.md)
|
|
@@ -574,7 +594,10 @@ Class | Method | HTTP request | Description
|
|
|
574
594
|
- [UploadCocoResult](rapidata/api_client/docs/UploadCocoResult.md)
|
|
575
595
|
- [UploadFromS3Result](rapidata/api_client/docs/UploadFromS3Result.md)
|
|
576
596
|
- [UrlAssetInput](rapidata/api_client/docs/UrlAssetInput.md)
|
|
597
|
+
- [UserScoreFilter](rapidata/api_client/docs/UserScoreFilter.md)
|
|
577
598
|
- [UserScoreUserFilterModel](rapidata/api_client/docs/UserScoreUserFilterModel.md)
|
|
599
|
+
- [UserState](rapidata/api_client/docs/UserState.md)
|
|
600
|
+
- [UserStateFilter](rapidata/api_client/docs/UserStateFilter.md)
|
|
578
601
|
- [ValidationChance](rapidata/api_client/docs/ValidationChance.md)
|
|
579
602
|
- [ValidationSelection](rapidata/api_client/docs/ValidationSelection.md)
|
|
580
603
|
- [ValidationSetModel](rapidata/api_client/docs/ValidationSetModel.md)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import re
|
|
2
|
-
from typing import Literal, Optional
|
|
2
|
+
from typing import Literal, Optional, Sequence
|
|
3
3
|
from rapidata.api_client.models.root_filter import RootFilter
|
|
4
4
|
from rapidata.api_client.models.filter import Filter
|
|
5
5
|
from rapidata.api_client.models.query_model import QueryModel
|
|
@@ -15,7 +15,9 @@ from rapidata.api_client.models.submit_prompt_model_prompt_asset import (
|
|
|
15
15
|
from rapidata.api_client.models.url_asset_input import UrlAssetInput
|
|
16
16
|
from rapidata.api_client.models.file_asset_model import FileAssetModel
|
|
17
17
|
from rapidata.api_client.models.source_url_metadata_model import SourceUrlMetadataModel
|
|
18
|
-
|
|
18
|
+
from rapidata.api_client.models.and_user_filter_model_filters_inner import (
|
|
19
|
+
AndUserFilterModelFiltersInner,
|
|
20
|
+
)
|
|
19
21
|
|
|
20
22
|
from rapidata.rapidata_client.benchmark.participant._participant import (
|
|
21
23
|
BenchmarkParticipant,
|
|
@@ -28,6 +30,8 @@ from rapidata.rapidata_client.benchmark.leaderboard.rapidata_leaderboard import
|
|
|
28
30
|
)
|
|
29
31
|
from rapidata.rapidata_client.datapoints.assets import MediaAsset
|
|
30
32
|
from rapidata.rapidata_client.benchmark._detail_mapper import DetailMapper
|
|
33
|
+
from rapidata.rapidata_client.filter import RapidataFilter
|
|
34
|
+
from rapidata.rapidata_client.settings import RapidataSetting
|
|
31
35
|
|
|
32
36
|
|
|
33
37
|
class RapidataBenchmark:
|
|
@@ -260,6 +264,9 @@ class RapidataBenchmark:
|
|
|
260
264
|
inverse_ranking: bool = False,
|
|
261
265
|
level_of_detail: Literal["low", "medium", "high", "very high"] = "low",
|
|
262
266
|
min_responses_per_matchup: int = 3,
|
|
267
|
+
validation_set_id: str | None = None,
|
|
268
|
+
filters: Sequence[RapidataFilter] = [],
|
|
269
|
+
settings: Sequence[RapidataSetting] = [],
|
|
263
270
|
) -> RapidataLeaderboard:
|
|
264
271
|
"""
|
|
265
272
|
Creates a new leaderboard for the benchmark.
|
|
@@ -272,6 +279,9 @@ class RapidataBenchmark:
|
|
|
272
279
|
inverse_ranking: Whether to inverse the ranking of the leaderboard. (if the question is inversed, e.g. "Which video is worse?")
|
|
273
280
|
level_of_detail: The level of detail of the leaderboard. This will effect how many comparisons are done per model evaluation. (default: "low")
|
|
274
281
|
min_responses_per_matchup: The minimum number of responses required to be considered for the leaderboard. (default: 3)
|
|
282
|
+
validation_set_id: The id of the validation set that should be attached to the leaderboard. (default: None)
|
|
283
|
+
filters: The filters that should be applied to the leaderboard. Will determine who can solve answer in the leaderboard. (default: [])
|
|
284
|
+
settings: The settings that should be applied to the leaderboard. Will determine the behavior of the tasks on the leaderboard. (default: [])
|
|
275
285
|
"""
|
|
276
286
|
if not isinstance(min_responses_per_matchup, int):
|
|
277
287
|
raise ValueError("Min responses per matchup must be an integer")
|
|
@@ -289,6 +299,20 @@ class RapidataBenchmark:
|
|
|
289
299
|
isInversed=inverse_ranking,
|
|
290
300
|
minResponses=min_responses_per_matchup,
|
|
291
301
|
responseBudget=DetailMapper.get_budget(level_of_detail),
|
|
302
|
+
validationSetId=validation_set_id,
|
|
303
|
+
filters=(
|
|
304
|
+
[
|
|
305
|
+
AndUserFilterModelFiltersInner(filter._to_model())
|
|
306
|
+
for filter in filters
|
|
307
|
+
]
|
|
308
|
+
if filters
|
|
309
|
+
else None
|
|
310
|
+
),
|
|
311
|
+
featureFlags=(
|
|
312
|
+
[setting._to_feature_flag() for setting in settings]
|
|
313
|
+
if settings
|
|
314
|
+
else None
|
|
315
|
+
),
|
|
292
316
|
)
|
|
293
317
|
)
|
|
294
318
|
|