rapidata 2.28.5__py3-none-any.whl → 2.29.1__py3-none-any.whl

rapidata/api_client_README.md

@@ -55,15 +55,14 @@ configuration.api_key['bearer'] = os.environ["API_KEY"]
 # Enter a context with an instance of the API client
 with rapidata.api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
-    api_instance = rapidata.api_client.CampaignApi(api_client)
+    api_instance = rapidata.api_client.BenchmarkApi(api_client)
+    benchmark_id = 'benchmark_id_example' # str | 
 
     try:
-        # Gets the status of the boost.
-        api_response = api_instance.campaign_boost_status_get()
-        print("The response of CampaignApi->campaign_boost_status_get:\n")
-        pprint(api_response)
+        # Deletes a single benchmark.
+        api_instance.benchmark_benchmark_id_delete(benchmark_id)
     except ApiException as e:
-        print("Exception when calling CampaignApi->campaign_boost_status_get: %s\n" % e)
+        print("Exception when calling BenchmarkApi->benchmark_benchmark_id_delete: %s\n" % e)
 
 ```
 
@@ -73,6 +72,17 @@ All URIs are relative to *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*BenchmarkApi* | [**benchmark_benchmark_id_delete**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_delete) | **DELETE** /benchmark/{benchmarkId} | Deletes a single benchmark.
+*BenchmarkApi* | [**benchmark_benchmark_id_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_get) | **GET** /benchmark/{benchmarkId} | Returns a single benchmark by its ID.
+*BenchmarkApi* | [**benchmark_benchmark_id_participant_participant_id_delete**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participant_participant_id_delete) | **DELETE** /benchmark/{benchmarkId}/participant/{participantId} | Deletes a participant on a benchmark.
+*BenchmarkApi* | [**benchmark_benchmark_id_participant_participant_id_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participant_participant_id_get) | **GET** /benchmark/{benchmarkId}/participant/{participantId} | Gets a participant by it's Id.
+*BenchmarkApi* | [**benchmark_benchmark_id_participants_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participants_get) | **GET** /benchmark/{benchmarkId}/participants | Query all participants within a benchmark
+*BenchmarkApi* | [**benchmark_benchmark_id_participants_participant_id_submit_post**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participants_participant_id_submit_post) | **POST** /benchmark/{benchmarkId}/participants/{participantId}/submit | Submits a participant to a benchmark.
+*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.
+*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.
+*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.
+*BenchmarkApi* | [**benchmark_post**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_post) | **POST** /benchmark | Creates a benchmark
+*BenchmarkApi* | [**benchmarks_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmarks_get) | **GET** /benchmarks | Queries all benchmarks of the user.
 *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.
 *CampaignApi* | [**campaign_campaign_id_pause_post**](rapidata/api_client/docs/CampaignApi.md#campaign_campaign_id_pause_post) | **POST** /campaign/{campaignId}/pause | Pauses a campaign.
 *CampaignApi* | [**campaign_campaign_id_resume_post**](rapidata/api_client/docs/CampaignApi.md#campaign_campaign_id_resume_post) | **POST** /campaign/{campaignId}/resume | Resumes a campaign.
@@ -86,6 +96,7 @@ Class | Method | HTTP request | Description
 *CocoApi* | [**coco_coco_set_id_submit_post**](rapidata/api_client/docs/CocoApi.md#coco_coco_set_id_submit_post) | **POST** /coco/{cocoSetId}/submit | Creates a new validation set based on a previously uploaded CoCo set.
 *CocoApi* | [**coco_post**](rapidata/api_client/docs/CocoApi.md#coco_post) | **POST** /coco | Uploads a CoCo set to the system.
 *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.
+*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.
 *CustomerRapidApi* | [**rapid_demographic_post**](rapidata/api_client/docs/CustomerRapidApi.md#rapid_demographic_post) | **POST** /rapid/demographic | Creates a new Demographic Rapid.
 *CustomerRapidApi* | [**rapid_rapid_id_delete**](rapidata/api_client/docs/CustomerRapidApi.md#rapid_rapid_id_delete) | **DELETE** /rapid/{rapidId} | Deletes a rapid.
 *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.
@@ -112,14 +123,18 @@ Class | Method | HTTP request | Description
 *IdentityApi* | [**identity_google_one_tap_post**](rapidata/api_client/docs/IdentityApi.md#identity_google_one_tap_post) | **POST** /identity/google-one-tap | Signs in a user using a token received from Google One Tap.
 *IdentityApi* | [**identity_referrer_post**](rapidata/api_client/docs/IdentityApi.md#identity_referrer_post) | **POST** /identity/referrer | Sets the referrer for the current customer.
 *IdentityApi* | [**identity_temporary_post**](rapidata/api_client/docs/IdentityApi.md#identity_temporary_post) | **POST** /identity/temporary | Registers and logs in a temporary customer.
+*LeaderboardApi* | [**benchmark_standing_leaderboard_id_participant_id_get**](rapidata/api_client/docs/LeaderboardApi.md#benchmark_standing_leaderboard_id_participant_id_get) | **GET** /benchmark/standing/{leaderboardId}/{participantId} | Gets a standing by leaderboardId and participantId.
+*LeaderboardApi* | [**leaderboard_leaderboard_id_boost_post**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_boost_post) | **POST** /leaderboard/{leaderboardId}/boost | Boosts a subset of participants within a leaderboard.
 *LeaderboardApi* | [**leaderboard_leaderboard_id_delete**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_delete) | **DELETE** /leaderboard/{leaderboardId} | Deletes a leaderboard by its ID.
 *LeaderboardApi* | [**leaderboard_leaderboard_id_get**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_get) | **GET** /leaderboard/{leaderboardId} | Gets a leaderboard by its ID.
-*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 of a leaderboard by its ID.
+*LeaderboardApi* | [**leaderboard_leaderboard_id_participant_participant_id_get**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_participant_participant_id_get) | **GET** /leaderboard/{leaderboardId}/participant/{participantId} | Gets a participant by its ID.
+*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.
 *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.
 *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.
 *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.
 *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.
-*LeaderboardApi* | [**leaderboard_participant_participant_id_get**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_participant_participant_id_get) | **GET** /leaderboard/participant/{participantId} | Gets a participant by its ID.
+*LeaderboardApi* | [**leaderboard_leaderboard_id_refresh_post**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_refresh_post) | **POST** /leaderboard/{leaderboardId}/refresh | This will force an update to all standings of a leaderboard. this could happen if the recorded matches and scores are out of sync
+*LeaderboardApi* | [**leaderboard_leaderboard_id_standings_get**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_standings_get) | **GET** /leaderboard/{leaderboardId}/standings | queries all the participants connected to leaderboard by its ID.
 *LeaderboardApi* | [**leaderboard_post**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_post) | **POST** /leaderboard | Creates a new leaderboard with the specified name and criteria.
 *LeaderboardApi* | [**leaderboards_get**](rapidata/api_client/docs/LeaderboardApi.md#leaderboards_get) | **GET** /leaderboards | Queries all leaderboards of the user.
 *NewsletterApi* | [**newsletter_subscribe_post**](rapidata/api_client/docs/NewsletterApi.md#newsletter_subscribe_post) | **POST** /newsletter/subscribe | Signs a user up to the newsletter.
@@ -195,6 +210,8 @@ Class | Method | HTTP request | Description
  - [AgeGroup](rapidata/api_client/docs/AgeGroup.md)
  - [AgeUserFilterModel](rapidata/api_client/docs/AgeUserFilterModel.md)
  - [AggregatorType](rapidata/api_client/docs/AggregatorType.md)
+ - [AndUserFilterModel](rapidata/api_client/docs/AndUserFilterModel.md)
+ - [AndUserFilterModelFiltersInner](rapidata/api_client/docs/AndUserFilterModelFiltersInner.md)
  - [AreRapidsActiveResult](rapidata/api_client/docs/AreRapidsActiveResult.md)
  - [AssetMetadata](rapidata/api_client/docs/AssetMetadata.md)
  - [AssetMetadataAsset](rapidata/api_client/docs/AssetMetadataAsset.md)
@@ -202,7 +219,9 @@ Class | Method | HTTP request | Description
  - [AttachCategoryRapidBlueprint](rapidata/api_client/docs/AttachCategoryRapidBlueprint.md)
  - [AttachCategoryResult](rapidata/api_client/docs/AttachCategoryResult.md)
  - [AttachCategoryTruth](rapidata/api_client/docs/AttachCategoryTruth.md)
- - [BaseError](rapidata/api_client/docs/BaseError.md)
+ - [BenchmarkQueryResult](rapidata/api_client/docs/BenchmarkQueryResult.md)
+ - [BenchmarkQueryResultPagedResult](rapidata/api_client/docs/BenchmarkQueryResultPagedResult.md)
+ - [BoostLeaderboardModel](rapidata/api_client/docs/BoostLeaderboardModel.md)
  - [BoostQueryResult](rapidata/api_client/docs/BoostQueryResult.md)
  - [BoostStatus](rapidata/api_client/docs/BoostStatus.md)
  - [BoundingBoxPayload](rapidata/api_client/docs/BoundingBoxPayload.md)
@@ -247,6 +266,10 @@ Class | Method | HTTP request | Description
  - [CountMetadata](rapidata/api_client/docs/CountMetadata.md)
  - [CountMetadataModel](rapidata/api_client/docs/CountMetadataModel.md)
  - [CountryUserFilterModel](rapidata/api_client/docs/CountryUserFilterModel.md)
+ - [CreateBenchmarkModel](rapidata/api_client/docs/CreateBenchmarkModel.md)
+ - [CreateBenchmarkParticipantModel](rapidata/api_client/docs/CreateBenchmarkParticipantModel.md)
+ - [CreateBenchmarkParticipantResult](rapidata/api_client/docs/CreateBenchmarkParticipantResult.md)
+ - [CreateBenchmarkResult](rapidata/api_client/docs/CreateBenchmarkResult.md)
  - [CreateBridgeTokenResult](rapidata/api_client/docs/CreateBridgeTokenResult.md)
  - [CreateClientModel](rapidata/api_client/docs/CreateClientModel.md)
  - [CreateComplexOrderModel](rapidata/api_client/docs/CreateComplexOrderModel.md)
@@ -263,12 +286,9 @@ Class | Method | HTTP request | Description
  - [CreateDemographicRapidModel](rapidata/api_client/docs/CreateDemographicRapidModel.md)
  - [CreateEmptyValidationSetResult](rapidata/api_client/docs/CreateEmptyValidationSetResult.md)
  - [CreateLeaderboardModel](rapidata/api_client/docs/CreateLeaderboardModel.md)
- - [CreateLeaderboardParticipantModel](rapidata/api_client/docs/CreateLeaderboardParticipantModel.md)
- - [CreateLeaderboardParticipantResult](rapidata/api_client/docs/CreateLeaderboardParticipantResult.md)
  - [CreateLeaderboardResult](rapidata/api_client/docs/CreateLeaderboardResult.md)
  - [CreateOrderModel](rapidata/api_client/docs/CreateOrderModel.md)
  - [CreateOrderModelReferee](rapidata/api_client/docs/CreateOrderModelReferee.md)
- - [CreateOrderModelUserFiltersInner](rapidata/api_client/docs/CreateOrderModelUserFiltersInner.md)
  - [CreateOrderModelWorkflow](rapidata/api_client/docs/CreateOrderModelWorkflow.md)
  - [CreateOrderResult](rapidata/api_client/docs/CreateOrderResult.md)
  - [CreateRapidResult](rapidata/api_client/docs/CreateRapidResult.md)
@@ -303,6 +323,12 @@ Class | Method | HTTP request | Description
  - [FeedbackModel](rapidata/api_client/docs/FeedbackModel.md)
  - [FileArtifactModel](rapidata/api_client/docs/FileArtifactModel.md)
  - [FileAsset](rapidata/api_client/docs/FileAsset.md)
+ - [FileAssetInput](rapidata/api_client/docs/FileAssetInput.md)
+ - [FileAssetInput1](rapidata/api_client/docs/FileAssetInput1.md)
+ - [FileAssetInput1File](rapidata/api_client/docs/FileAssetInput1File.md)
+ - [FileAssetInput2](rapidata/api_client/docs/FileAssetInput2.md)
+ - [FileAssetInput3](rapidata/api_client/docs/FileAssetInput3.md)
+ - [FileAssetInputFile](rapidata/api_client/docs/FileAssetInputFile.md)
  - [FileAssetModel](rapidata/api_client/docs/FileAssetModel.md)
  - [FileAssetModelMetadataValue](rapidata/api_client/docs/FileAssetModelMetadataValue.md)
  - [FileType](rapidata/api_client/docs/FileType.md)
@@ -310,12 +336,14 @@ Class | Method | HTTP request | Description
  - [FileTypeMetadataModel](rapidata/api_client/docs/FileTypeMetadataModel.md)
  - [Filter](rapidata/api_client/docs/Filter.md)
  - [FilterOperator](rapidata/api_client/docs/FilterOperator.md)
+ - [FormFileWrapper](rapidata/api_client/docs/FormFileWrapper.md)
  - [FreeTextPayload](rapidata/api_client/docs/FreeTextPayload.md)
  - [FreeTextRapidBlueprint](rapidata/api_client/docs/FreeTextRapidBlueprint.md)
  - [FreeTextResult](rapidata/api_client/docs/FreeTextResult.md)
  - [Gender](rapidata/api_client/docs/Gender.md)
  - [GenderUserFilterModel](rapidata/api_client/docs/GenderUserFilterModel.md)
  - [GetAvailableValidationSetsResult](rapidata/api_client/docs/GetAvailableValidationSetsResult.md)
+ - [GetBenchmarkByIdResult](rapidata/api_client/docs/GetBenchmarkByIdResult.md)
  - [GetCompareAbSummaryResult](rapidata/api_client/docs/GetCompareAbSummaryResult.md)
  - [GetCompareWorkflowResultsModel](rapidata/api_client/docs/GetCompareWorkflowResultsModel.md)
  - [GetCompareWorkflowResultsResult](rapidata/api_client/docs/GetCompareWorkflowResultsResult.md)
@@ -333,6 +361,7 @@ Class | Method | HTTP request | Description
  - [GetRapidResponsesResult](rapidata/api_client/docs/GetRapidResponsesResult.md)
  - [GetResponsesResult](rapidata/api_client/docs/GetResponsesResult.md)
  - [GetSimpleWorkflowResultsModel](rapidata/api_client/docs/GetSimpleWorkflowResultsModel.md)
+ - [GetStandingByIdResult](rapidata/api_client/docs/GetStandingByIdResult.md)
  - [GetValidationRapidsResult](rapidata/api_client/docs/GetValidationRapidsResult.md)
  - [GetValidationRapidsResultAsset](rapidata/api_client/docs/GetValidationRapidsResultAsset.md)
  - [GetValidationRapidsResultPagedResult](rapidata/api_client/docs/GetValidationRapidsResultPagedResult.md)
@@ -363,6 +392,7 @@ Class | Method | HTTP request | Description
  - [LineRapidBlueprint](rapidata/api_client/docs/LineRapidBlueprint.md)
  - [LineResult](rapidata/api_client/docs/LineResult.md)
  - [LineTruth](rapidata/api_client/docs/LineTruth.md)
+ - [LocalFileWrapper](rapidata/api_client/docs/LocalFileWrapper.md)
  - [LocateBoxTruth](rapidata/api_client/docs/LocateBoxTruth.md)
  - [LocateCoordinate](rapidata/api_client/docs/LocateCoordinate.md)
  - [LocatePayload](rapidata/api_client/docs/LocatePayload.md)
@@ -374,6 +404,13 @@ Class | Method | HTTP request | Description
  - [LogicOperator](rapidata/api_client/docs/LogicOperator.md)
  - [MetadataVisibilities](rapidata/api_client/docs/MetadataVisibilities.md)
  - [MultiAsset](rapidata/api_client/docs/MultiAsset.md)
+ - [MultiAssetInput](rapidata/api_client/docs/MultiAssetInput.md)
+ - [MultiAssetInput1](rapidata/api_client/docs/MultiAssetInput1.md)
+ - [MultiAssetInput1AssetsInner](rapidata/api_client/docs/MultiAssetInput1AssetsInner.md)
+ - [MultiAssetInput2](rapidata/api_client/docs/MultiAssetInput2.md)
+ - [MultiAssetInput3](rapidata/api_client/docs/MultiAssetInput3.md)
+ - [MultiAssetInput3AssetsInner](rapidata/api_client/docs/MultiAssetInput3AssetsInner.md)
+ - [MultiAssetInputAssetsInner](rapidata/api_client/docs/MultiAssetInputAssetsInner.md)
  - [MultiAssetModel](rapidata/api_client/docs/MultiAssetModel.md)
  - [MultiCompareTruth](rapidata/api_client/docs/MultiCompareTruth.md)
  - [NaiveRefereeConfig](rapidata/api_client/docs/NaiveRefereeConfig.md)
@@ -402,28 +439,34 @@ Class | Method | HTTP request | Description
  - [OriginalFilenameMetadata](rapidata/api_client/docs/OriginalFilenameMetadata.md)
  - [OriginalFilenameMetadataModel](rapidata/api_client/docs/OriginalFilenameMetadataModel.md)
  - [PageInfo](rapidata/api_client/docs/PageInfo.md)
- - [ParticipantByLeaderboard](rapidata/api_client/docs/ParticipantByLeaderboard.md)
- - [ParticipantByLeaderboardPagedResult](rapidata/api_client/docs/ParticipantByLeaderboardPagedResult.md)
+ - [ParticipantByBenchmark](rapidata/api_client/docs/ParticipantByBenchmark.md)
+ - [ParticipantByBenchmarkPagedResult](rapidata/api_client/docs/ParticipantByBenchmarkPagedResult.md)
  - [ParticipantStatus](rapidata/api_client/docs/ParticipantStatus.md)
  - [PipelineIdWorkflowConfigPutRequest](rapidata/api_client/docs/PipelineIdWorkflowConfigPutRequest.md)
  - [PolygonPayload](rapidata/api_client/docs/PolygonPayload.md)
  - [PolygonRapidBlueprint](rapidata/api_client/docs/PolygonRapidBlueprint.md)
  - [PolygonResult](rapidata/api_client/docs/PolygonResult.md)
  - [PolygonTruth](rapidata/api_client/docs/PolygonTruth.md)
+ - [PotentialValidationRapid](rapidata/api_client/docs/PotentialValidationRapid.md)
+ - [PotentialValidationRapidPagedResult](rapidata/api_client/docs/PotentialValidationRapidPagedResult.md)
+ - [PotentialValidationRapidTruth](rapidata/api_client/docs/PotentialValidationRapidTruth.md)
  - [PreliminaryDownloadModel](rapidata/api_client/docs/PreliminaryDownloadModel.md)
  - [PreliminaryDownloadResult](rapidata/api_client/docs/PreliminaryDownloadResult.md)
  - [PrivateTextMetadataInput](rapidata/api_client/docs/PrivateTextMetadataInput.md)
  - [ProbabilisticAttachCategoryRefereeConfig](rapidata/api_client/docs/ProbabilisticAttachCategoryRefereeConfig.md)
  - [ProbabilisticAttachCategoryRefereeInfo](rapidata/api_client/docs/ProbabilisticAttachCategoryRefereeInfo.md)
  - [PromptAssetMetadataInput](rapidata/api_client/docs/PromptAssetMetadataInput.md)
- - [PromptByLeaderboardResult](rapidata/api_client/docs/PromptByLeaderboardResult.md)
- - [PromptByLeaderboardResultPagedResult](rapidata/api_client/docs/PromptByLeaderboardResultPagedResult.md)
+ - [PromptAssetMetadataInputAsset](rapidata/api_client/docs/PromptAssetMetadataInputAsset.md)
+ - [PromptByBenchmarkResult](rapidata/api_client/docs/PromptByBenchmarkResult.md)
+ - [PromptByBenchmarkResultPagedResult](rapidata/api_client/docs/PromptByBenchmarkResultPagedResult.md)
  - [PromptMetadata](rapidata/api_client/docs/PromptMetadata.md)
  - [PromptMetadataInput](rapidata/api_client/docs/PromptMetadataInput.md)
  - [PromptMetadataModel](rapidata/api_client/docs/PromptMetadataModel.md)
+ - [ProxyFileWrapper](rapidata/api_client/docs/ProxyFileWrapper.md)
  - [PublicOrderModel](rapidata/api_client/docs/PublicOrderModel.md)
  - [PublicTextMetadataInput](rapidata/api_client/docs/PublicTextMetadataInput.md)
  - [QueryModel](rapidata/api_client/docs/QueryModel.md)
+ - [QueryValidationModel](rapidata/api_client/docs/QueryValidationModel.md)
  - [RapidIssue](rapidata/api_client/docs/RapidIssue.md)
  - [RapidModel](rapidata/api_client/docs/RapidModel.md)
  - [RapidModelPagedResult](rapidata/api_client/docs/RapidModelPagedResult.md)
@@ -461,14 +504,21 @@ Class | Method | HTTP request | Description
  - [SortDirection](rapidata/api_client/docs/SortDirection.md)
  - [SourceUrlMetadata](rapidata/api_client/docs/SourceUrlMetadata.md)
  - [SourceUrlMetadataModel](rapidata/api_client/docs/SourceUrlMetadataModel.md)
+ - [StandingByLeaderboard](rapidata/api_client/docs/StandingByLeaderboard.md)
+ - [StandingByLeaderboardPagedResult](rapidata/api_client/docs/StandingByLeaderboardPagedResult.md)
+ - [StandingStatus](rapidata/api_client/docs/StandingStatus.md)
  - [StaticSelection](rapidata/api_client/docs/StaticSelection.md)
  - [StickyState](rapidata/api_client/docs/StickyState.md)
+ - [StreamFileWrapper](rapidata/api_client/docs/StreamFileWrapper.md)
  - [StreamsMetadata](rapidata/api_client/docs/StreamsMetadata.md)
  - [StreamsMetadataModel](rapidata/api_client/docs/StreamsMetadataModel.md)
  - [SubmitCocoModel](rapidata/api_client/docs/SubmitCocoModel.md)
  - [SubmitCocoResult](rapidata/api_client/docs/SubmitCocoResult.md)
  - [SubmitParticipantResult](rapidata/api_client/docs/SubmitParticipantResult.md)
+ - [SubmitPromptModel](rapidata/api_client/docs/SubmitPromptModel.md)
+ - [SubmitPromptModelPromptAsset](rapidata/api_client/docs/SubmitPromptModelPromptAsset.md)
  - [TextAsset](rapidata/api_client/docs/TextAsset.md)
+ - [TextAssetInput](rapidata/api_client/docs/TextAssetInput.md)
  - [TextAssetModel](rapidata/api_client/docs/TextAssetModel.md)
  - [TextMetadata](rapidata/api_client/docs/TextMetadata.md)
  - [TextMetadataModel](rapidata/api_client/docs/TextMetadataModel.md)
@@ -509,6 +559,7 @@ Class | Method | HTTP request | Description
  - [WorkflowSplitModel](rapidata/api_client/docs/WorkflowSplitModel.md)
  - [WorkflowSplitModelFilterConfigsInner](rapidata/api_client/docs/WorkflowSplitModelFilterConfigsInner.md)
  - [WorkflowState](rapidata/api_client/docs/WorkflowState.md)
+ - [ZipEntryFileWrapper](rapidata/api_client/docs/ZipEntryFileWrapper.md)
 
 
 <a id="documentation-for-authorization"></a>

rapidata/rapidata_client/benchmark/leaderboard/rapidata_leaderboard.py

@@ -0,0 +1,115 @@
+import pandas as pd
+
+from rapidata.api_client.models.query_model import QueryModel
+from rapidata.api_client.models.page_info import PageInfo
+from rapidata.api_client.models.sort_criterion import SortCriterion
+
+from rapidata.service.openapi_service import OpenAPIService
+
+
+class RapidataLeaderboard:
+    """
+    An instance of a Rapidata leaderboard.
+
+    Used to interact with a specific leaderboard in the Rapidata system, such as retrieving prompts and evaluating models.
+
+    Args:
+        name: The name that will be used to identify the leaderboard on the overview.
+        instruction: The instruction that will determine what how the models will be evaluated.
+        show_prompt: Whether to show the prompt to the users.
+        id: The ID of the leaderboard.
+        openapi_service: The OpenAPIService instance for API interaction.
+    """
+    def __init__(self, 
+                 name: str, 
+                 instruction: str, 
+                 show_prompt: bool, 
+                 inverse_ranking: bool, 
+                 min_responses: int,
+                 response_budget: int,
+                 id: str, 
+                 openapi_service: OpenAPIService):
+        self.__openapi_service = openapi_service
+        self.__name = name
+        self.__instruction = instruction
+        self.__show_prompt = show_prompt
+        self.__inverse_ranking = inverse_ranking
+        self.__min_responses = min_responses
+        self.__response_budget = response_budget
+        self.id = id
+
+    @property
+    def response_budget(self) -> int:
+        """
+        Returns the response budget of the leaderboard.
+        """
+        return self.__response_budget
+    
+    @property
+    def min_responses(self) -> int:
+        """
+        Returns the minimum number of responses required to be considered for the leaderboard.
+        """
+        return self.__min_responses
+    
+    @property
+    def inverse_ranking(self) -> bool:
+        """
+        Returns whether the ranking is inverse.
+        """
+        return self.__inverse_ranking
+    
+    @property
+    def show_prompt(self) -> bool:
+        """
+        Returns whether the prompt is shown to the users.
+        """
+        return self.__show_prompt
+    
+    @property
+    def instruction(self) -> str:
+        """
+        Returns the instruction of the leaderboard.
+        """
+        return self.__instruction
+    
+    @property
+    def name(self) -> str:
+        """
+        Returns the name of the leaderboard.
+        """
+        return self.__name
+
+    def get_standings(self) -> pd.DataFrame:
+        """
+        Returns the standings of the leaderboard.
+        """
+        participants = self.__openapi_service.leaderboard_api.leaderboard_leaderboard_id_standings_get(
+            leaderboard_id=self.id,
+            request=QueryModel(
+                page=PageInfo(index=1, size=1000),
+                sortCriteria=[SortCriterion(direction="Desc", propertyName="Score")]
+            )
+        )
+
+        standings = []
+        for participant in participants.items:
+            standings.append({
+                "name": participant.name,
+                "wins": participant.wins,
+                "total_matches": participant.total_matches,
+                "score": round(participant.score, 2) if participant.score is not None else None,
+            })
+
+        return pd.DataFrame(standings)
+
+    def __str__(self) -> str:
+        return f"RapidataLeaderboard(name={self.name}, instruction={self.instruction}, show_prompt={self.show_prompt}, leaderboard_id={self.id})"
+    
+    def __repr__(self) -> str:
+        return self.__str__()
+
+
+        
+
+

rapidata/rapidata_client/benchmark/rapidata_benchmark.py

@@ -0,0 +1,256 @@
+from rapidata.api_client.models.root_filter import RootFilter
+from rapidata.api_client.models.filter import Filter
+from rapidata.api_client.models.query_model import QueryModel
+from rapidata.api_client.models.page_info import PageInfo
+from rapidata.api_client.models.create_leaderboard_model import CreateLeaderboardModel
+from rapidata.api_client.models.create_benchmark_participant_model import CreateBenchmarkParticipantModel
+from rapidata.api_client.models.submit_prompt_model import SubmitPromptModel
+
+from rapidata.rapidata_client.logging import logger
+from rapidata.service.openapi_service import OpenAPIService
+
+from rapidata.rapidata_client.benchmark.leaderboard.rapidata_leaderboard import RapidataLeaderboard
+from rapidata.rapidata_client.metadata import PromptIdentifierMetadata
+from rapidata.rapidata_client.assets import MediaAsset
+from rapidata.rapidata_client.order._rapidata_dataset import RapidataDataset
+
+class RapidataBenchmark:
+    """
+    An instance of a Rapidata benchmark.
+
+    Used to interact with a specific benchmark in the Rapidata system, such as retrieving prompts and evaluating models.
+
+    Args:
+        name: The name that will be used to identify the benchmark on the overview.
+        id: The id of the benchmark.
+        openapi_service: The OpenAPI service to use to interact with the Rapidata API.
+    """
+    def __init__(self, name: str, id: str, openapi_service: OpenAPIService):
+        self.name = name
+        self.id = id
+        self.__openapi_service = openapi_service
+        self.__prompts: list[str] = []
+        self.__leaderboards: list[RapidataLeaderboard] = []
+        self.__identifiers: list[str] = []
+
+    def __instantiate_prompts(self) -> None:
+        current_page = 1
+        total_pages = None
+        
+        while True:
+            prompts_result = self.__openapi_service.benchmark_api.benchmark_benchmark_id_prompts_get(
+                benchmark_id=self.id,
+                request=QueryModel(
+                    page=PageInfo(
+                        index=current_page,
+                        size=100
+                    )
+                )
+            )
+            
+            if prompts_result.total_pages is None:
+                raise ValueError("An error occurred while fetching prompts: total_pages is None")
+            
+            total_pages = prompts_result.total_pages
+            
+            self.__prompts.extend([prompt.prompt for prompt in prompts_result.items])
+            self.__identifiers.extend([prompt.identifier for prompt in prompts_result.items])
+            
+            if current_page >= total_pages:
+                break
+                
+            current_page += 1
+
+    @property
+    def prompts(self) -> list[str]:
+        """
+        Returns the prompts that are registered for the leaderboard.
+        """
+        if not self.__prompts:
+            self.__instantiate_prompts()
+        
+        return self.__prompts
+    
+    @property
+    def identifiers(self) -> list[str]:
+        if not self.__identifiers:
+            self.__instantiate_prompts()
+        
+        return self.__identifiers
+    
+    @property
+    def leaderboards(self) -> list[RapidataLeaderboard]:
+        """
+        Returns the leaderboards that are registered for the benchmark.
+        """
+        if not self.__leaderboards:
+            current_page = 1
+            total_pages = None
+            
+            while True:
+                leaderboards_result = self.__openapi_service.leaderboard_api.leaderboards_get(
+                    request=QueryModel(
+                        filter=RootFilter(
+                            filters=[
+                                Filter(field="BenchmarkId", operator="Eq", value=self.id)
+                                ]
+                            ),
+                        page=PageInfo(
+                            index=current_page,
+                            size=100
+                        )
+                    )
+                )
+                
+                if leaderboards_result.total_pages is None:
+                    raise ValueError("An error occurred while fetching leaderboards: total_pages is None")
+                
+                total_pages = leaderboards_result.total_pages
+                
+                self.__leaderboards.extend([
+                    RapidataLeaderboard(
+                        leaderboard.name, 
+                        leaderboard.instruction, 
+                        leaderboard.show_prompt, 
+                        leaderboard.is_inversed,
+                        leaderboard.min_responses,
+                        leaderboard.response_budget,
+                        leaderboard.id, 
+                        self.__openapi_service
+                        ) for leaderboard in leaderboards_result.items])
+                
+                if current_page >= total_pages:
+                    break
+                    
+                current_page += 1
+                
+        return self.__leaderboards
+    
+    def add_prompt(self, identifier: str, prompt: str):
+        """
+        Adds a prompt to the benchmark.
+        """
+        if not isinstance(identifier, str) or not isinstance(prompt, str):
+            raise ValueError("Identifier and prompt must be strings.")
+        
+        if identifier in self.identifiers:
+            raise ValueError("Identifier already exists in the benchmark.")
+        
+        self.__identifiers.append(identifier)
+        self.__prompts.append(prompt)
+
+        self.__openapi_service.benchmark_api.benchmark_benchmark_id_prompt_post(
+            benchmark_id=self.id,
+            submit_prompt_model=SubmitPromptModel(
+                identifier=identifier,
+                prompt=prompt,
+            )
+        )
+
+    def create_leaderboard(
+        self, 
+        name: str, 
+        instruction: str, 
+        show_prompt: bool, 
+        inverse_ranking: bool = False,
+        min_responses: int | None = None,
+        response_budget: int | None = None
+    ) -> RapidataLeaderboard:
+        """
+        Creates a new leaderboard for the benchmark.
+
+        Args:
+            name: The name of the leaderboard. (not shown to the users)
+            instruction: The instruction decides how the models will be evaluated.
+            show_prompt: Whether to show the prompt to the users.
+            inverse_ranking: Whether to inverse the ranking of the leaderboard. (if the question is inversed, e.g. "Which video is worse?")
+            min_responses: The minimum amount of responses that get collected per comparison. if None, it will be defaulted.
+            response_budget: The total amount of responses that get collected per new model evaluation. if None, it will be defaulted. Values below 2000 are not recommended.
+        """
+
+        if response_budget is not None and response_budget < 2000:
+            logger.warning("Response budget is below 2000. This is not recommended.")
+
+        leaderboard_result = self.__openapi_service.leaderboard_api.leaderboard_post(
+            create_leaderboard_model=CreateLeaderboardModel(
+                benchmarkId=self.id,
+                name=name,
+                instruction=instruction,
+                showPrompt=show_prompt,
+                isInversed=inverse_ranking,
+                minResponses=min_responses,
+                responseBudget=response_budget
+            )
+        )
+
+        assert leaderboard_result.benchmark_id == self.id, "The leaderboard was not created for the correct benchmark."
+
+        return RapidataLeaderboard(
+            name,
+            instruction,
+            show_prompt,
+            inverse_ranking,
+            leaderboard_result.min_responses,
+            leaderboard_result.response_budget,
+            leaderboard_result.id,
+            self.__openapi_service
+        )
+    
+    def evaluate_model(self, name: str, media: list[str], identifiers: list[str]) -> None:
+        """
+        Evaluates a model on the benchmark across all leaderboards.
+
+        Args:
+            name: The name of the model.
+            media: The generated images/videos that will be used to evaluate the model.
+            identifiers: The identifiers that correspond to the media. The order of the identifiers must match the order of the media.
+                The identifiers that are used must be registered for the benchmark. To see the registered identifiers, use the identifiers property.
+        """
+        if not media:
+            raise ValueError("Media must be a non-empty list of strings")
+        
+        if len(media) != len(identifiers):
+            raise ValueError("Media and identifiers must have the same length")
+        
+        if not all(identifier in self.identifiers for identifier in identifiers):
+            raise ValueError("All identifiers must be in the registered identifiers list. To see the registered identifiers, use the identifiers property.\
+\nTo see the prompts that are associated with the identifiers, use the prompts property.")
+        
+        # happens before the creation of the participant to ensure all media paths are valid
+        assets = []
+        prompts_metadata: list[list[PromptIdentifierMetadata]] = []
+        for media_path, identifier in zip(media, identifiers):
+            assets.append(MediaAsset(media_path))
+            prompts_metadata.append([PromptIdentifierMetadata(identifier=identifier)])
+
+        participant_result = self.__openapi_service.benchmark_api.benchmark_benchmark_id_participants_post(
+            benchmark_id=self.id,
+            create_benchmark_participant_model=CreateBenchmarkParticipantModel(
+                name=name,
+            )
+        )
+
+        dataset = RapidataDataset(participant_result.dataset_id, self.__openapi_service)
+        
+        try:
+            dataset._add_datapoints(assets, prompts_metadata)
+        except Exception as e:
+            logger.warning(f"An error occurred while adding datapoints to the dataset: {e}")
+            upload_progress = self.__openapi_service.dataset_api.dataset_dataset_id_progress_get(
+                dataset_id=dataset.id
+            )
+            if upload_progress.ready == 0:
+                raise RuntimeError("None of the media was uploaded successfully. Please check the media paths and try again.")
+            
+            logger.warning(f"{upload_progress.failed} datapoints failed to upload. \n{upload_progress.ready} datapoints were uploaded successfully. \nEvaluation will continue with the uploaded datapoints.")
+
+        self.__openapi_service.benchmark_api.benchmark_benchmark_id_participants_participant_id_submit_post(
+            benchmark_id=self.id,
+            participant_id=participant_result.participant_id
+        )
+
+    def __str__(self) -> str:
+        return f"RapidataBenchmark(name={self.name}, id={self.id})"
+    
+    def __repr__(self) -> str:
+        return self.__str__()