rapidata 2.14.1__py3-none-any.whl → 2.16.0__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/api_client/__init__.py +18 -7
- rapidata/api_client/api/__init__.py +2 -1
- rapidata/api_client/api/campaign_api.py +868 -92
- rapidata/api_client/api/client_api.py +292 -20
- rapidata/api_client/api/coco_api.py +594 -8
- rapidata/api_client/api/compare_workflow_api.py +23 -23
- rapidata/api_client/api/datapoint_api.py +548 -26
- rapidata/api_client/api/dataset_api.py +2198 -186
- rapidata/api_client/api/feedback_api.py +306 -0
- rapidata/api_client/api/identity_api.py +1143 -78
- rapidata/api_client/api/newsletter_api.py +299 -11
- rapidata/api_client/api/order_api.py +5570 -516
- rapidata/api_client/api/pipeline_api.py +263 -524
- rapidata/api_client/api/rapid_api.py +1930 -254
- rapidata/api_client/api/simple_workflow_api.py +23 -23
- rapidata/api_client/api/validation_api.py +283 -0
- rapidata/api_client/api/validation_set_api.py +5259 -0
- rapidata/api_client/api/workflow_api.py +929 -134
- rapidata/api_client/models/__init__.py +16 -6
- rapidata/api_client/models/ab_test_selection_a_inner.py +24 -10
- rapidata/api_client/models/add_campaign_model.py +9 -2
- rapidata/api_client/models/add_user_response_result.py +106 -0
- rapidata/api_client/models/add_user_response_result_validation_truth.py +258 -0
- rapidata/api_client/models/add_validation_rapid_model.py +3 -3
- rapidata/api_client/models/add_validation_text_rapid_model.py +3 -3
- rapidata/api_client/models/are_rapids_active_result.py +87 -0
- rapidata/api_client/models/campaign_query_result.py +2 -2
- rapidata/api_client/models/campaign_status.py +1 -0
- rapidata/api_client/models/compare_workflow_model.py +3 -3
- rapidata/api_client/models/create_datapoint_from_files_model.py +102 -0
- rapidata/api_client/models/create_datapoint_from_files_model_metadata_inner.py +168 -0
- rapidata/api_client/models/create_datapoint_from_text_sources_model.py +109 -0
- rapidata/api_client/models/create_datapoint_from_urls_model.py +4 -4
- rapidata/api_client/models/create_datapoints_from_s3_bucket_model.py +124 -0
- rapidata/api_client/models/create_order_model.py +15 -1
- rapidata/api_client/models/create_rapid_result.py +87 -0
- rapidata/api_client/models/create_validation_set_model.py +87 -0
- rapidata/api_client/models/datapoint_metadata_model.py +3 -3
- rapidata/api_client/models/evaluation_workflow_model.py +1 -1
- rapidata/api_client/models/get_validation_rapids_query.py +123 -0
- rapidata/api_client/models/get_validation_rapids_query_paged_result.py +105 -0
- rapidata/api_client/models/order_model.py +2 -2
- rapidata/api_client/models/order_state.py +1 -0
- rapidata/api_client/models/pipeline_id_workflow_artifact_id_put_request.py +140 -0
- rapidata/api_client/models/query_validation_rapids_result.py +3 -3
- rapidata/api_client/models/rapid_issue.py +4 -0
- rapidata/api_client/models/report_model.py +4 -4
- rapidata/api_client/models/shuffling_selection.py +106 -0
- rapidata/api_client/models/update_dataset_name_model.py +87 -0
- rapidata/api_client/models/update_dimensions_model.py +87 -0
- rapidata/api_client/models/update_order_name_model.py +87 -0
- rapidata/api_client/models/upload_text_sources_to_dataset_model.py +3 -3
- rapidata/api_client/models/user_score_user_filter_model.py +9 -2
- rapidata/api_client_README.md +154 -84
- rapidata/rapidata_client/demographic/demographic_manager.py +36 -1
- rapidata/rapidata_client/filter/user_score_filter.py +4 -1
- rapidata/rapidata_client/order/_rapidata_dataset.py +10 -11
- rapidata/rapidata_client/order/_rapidata_order_builder.py +3 -1
- rapidata/rapidata_client/order/rapidata_order.py +8 -10
- rapidata/rapidata_client/order/rapidata_order_manager.py +11 -2
- rapidata/rapidata_client/order/rapidata_results.py +1 -1
- rapidata/rapidata_client/validation/rapidata_validation_set.py +11 -0
- rapidata/rapidata_client/validation/rapids/rapids.py +3 -5
- rapidata/rapidata_client/validation/validation_set_manager.py +36 -21
- rapidata/rapidata_client/workflow/_ranking_workflow.py +2 -2
- {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/METADATA +1 -1
- {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/RECORD +69 -51
- {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/LICENSE +0 -0
- {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/WHEEL +0 -0
rapidata/api_client_README.md
CHANGED
|
@@ -56,12 +56,13 @@ configuration.api_key['bearer'] = os.environ["API_KEY"]
|
|
|
56
56
|
with rapidata.api_client.ApiClient(configuration) as api_client:
|
|
57
57
|
# Create an instance of the API class
|
|
58
58
|
api_instance = rapidata.api_client.CampaignApi(api_client)
|
|
59
|
+
campaign_id = 'campaign_id_example' # str | id of the campaign that should be paused
|
|
59
60
|
|
|
60
61
|
try:
|
|
61
|
-
#
|
|
62
|
-
api_instance.
|
|
62
|
+
# Pauses a campaign.
|
|
63
|
+
api_instance.campaign_campaign_id_pause_post(campaign_id)
|
|
63
64
|
except ApiException as e:
|
|
64
|
-
print("Exception when calling CampaignApi->
|
|
65
|
+
print("Exception when calling CampaignApi->campaign_campaign_id_pause_post: %s\n" % e)
|
|
65
66
|
|
|
66
67
|
```
|
|
67
68
|
|
|
@@ -71,89 +72,148 @@ All URIs are relative to *http://localhost*
|
|
|
71
72
|
|
|
72
73
|
Class | Method | HTTP request | Description
|
|
73
74
|
------------ | ------------- | ------------- | -------------
|
|
74
|
-
*CampaignApi* | [**
|
|
75
|
-
*CampaignApi* | [**
|
|
76
|
-
*CampaignApi* | [**
|
|
77
|
-
*CampaignApi* | [**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*ClientApi* | [**
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
75
|
+
*CampaignApi* | [**campaign_campaign_id_pause_post**](rapidata/api_client/docs/CampaignApi.md#campaign_campaign_id_pause_post) | **POST** /campaign/{campaignId}/pause | Pauses a campaign.
|
|
76
|
+
*CampaignApi* | [**campaign_campaign_id_resume_post**](rapidata/api_client/docs/CampaignApi.md#campaign_campaign_id_resume_post) | **POST** /campaign/{campaignId}/resume | Resumes a campaign.
|
|
77
|
+
*CampaignApi* | [**campaign_monitor_get**](rapidata/api_client/docs/CampaignApi.md#campaign_monitor_get) | **GET** /campaign/monitor | The monitor endpoint is used to monitor the health of the service
|
|
78
|
+
*CampaignApi* | [**campaign_pause_post**](rapidata/api_client/docs/CampaignApi.md#campaign_pause_post) | **POST** /campaign/pause | Pauses a campaign.
|
|
79
|
+
*CampaignApi* | [**campaign_query_get**](rapidata/api_client/docs/CampaignApi.md#campaign_query_get) | **GET** /campaign/query | Queries orders based on a filter, page, and sort criteria.
|
|
80
|
+
*CampaignApi* | [**campaign_resume_post**](rapidata/api_client/docs/CampaignApi.md#campaign_resume_post) | **POST** /campaign/resume | Resumes a campaign.
|
|
81
|
+
*CampaignApi* | [**campaigns_get**](rapidata/api_client/docs/CampaignApi.md#campaigns_get) | **GET** /campaigns | Queries orders based on a filter, page, and sort criteria.
|
|
82
|
+
*ClientApi* | [**client_client_id_delete**](rapidata/api_client/docs/ClientApi.md#client_client_id_delete) | **DELETE** /client/{clientId} | Deletes a customers' client.
|
|
83
|
+
*ClientApi* | [**client_post**](rapidata/api_client/docs/ClientApi.md#client_post) | **POST** /client | Creates a new client for the current customer.
|
|
84
|
+
*ClientApi* | [**client_query_get**](rapidata/api_client/docs/ClientApi.md#client_query_get) | **GET** /client/query | Gets the clients for the current customer.
|
|
85
|
+
*ClientApi* | [**client_setreferrer_post**](rapidata/api_client/docs/ClientApi.md#client_setreferrer_post) | **POST** /client/setreferrer | Sets the referrer for the current customer.
|
|
86
|
+
*ClientApi* | [**clients_get**](rapidata/api_client/docs/ClientApi.md#clients_get) | **GET** /clients | Queries the clients for the current customer.
|
|
87
|
+
*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.
|
|
88
|
+
*CocoApi* | [**coco_post**](rapidata/api_client/docs/CocoApi.md#coco_post) | **POST** /coco | Uploads a CoCo set to the system.
|
|
89
|
+
*CocoApi* | [**coco_submit_post**](rapidata/api_client/docs/CocoApi.md#coco_submit_post) | **POST** /coco/submit | Creates a new validation set based on a previously uploaded CoCo set.
|
|
90
|
+
*CocoApi* | [**coco_upload_post**](rapidata/api_client/docs/CocoApi.md#coco_upload_post) | **POST** /coco/upload | Uploads a CoCo set to the system.
|
|
91
|
+
*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.
|
|
92
|
+
*DatapointApi* | [**datapoint_datapoint_id_delete**](rapidata/api_client/docs/DatapointApi.md#datapoint_datapoint_id_delete) | **DELETE** /datapoint/{datapointId} | Deletes a datapoint by its id.
|
|
93
|
+
*DatapointApi* | [**datapoint_datapoint_id_get**](rapidata/api_client/docs/DatapointApi.md#datapoint_datapoint_id_get) | **GET** /datapoint/{datapointId} | Gets a datapoint by its id.
|
|
94
|
+
*DatapointApi* | [**datapoint_delete_delete**](rapidata/api_client/docs/DatapointApi.md#datapoint_delete_delete) | **DELETE** /datapoint/delete | Delete a datapoint.
|
|
95
|
+
*DatapointApi* | [**datapoint_getalldatapointsbydatasetid_get**](rapidata/api_client/docs/DatapointApi.md#datapoint_getalldatapointsbydatasetid_get) | **GET** /datapoint/getalldatapointsbydatasetid | Get all datapoints of a dataset.
|
|
96
|
+
*DatapointApi* | [**datapoint_getbyid_get**](rapidata/api_client/docs/DatapointApi.md#datapoint_getbyid_get) | **GET** /datapoint/getbyid | Get a datapoint by its id.
|
|
97
|
+
*DatasetApi* | [**dataset_createdatapoint_post**](rapidata/api_client/docs/DatasetApi.md#dataset_createdatapoint_post) | **POST** /dataset/createdatapoint | Creates a single datapoint.
|
|
98
|
+
*DatasetApi* | [**dataset_creattextdatapoint_post**](rapidata/api_client/docs/DatasetApi.md#dataset_creattextdatapoint_post) | **POST** /dataset/creattextdatapoint | Creates new datapoints from text sources.
|
|
99
|
+
*DatasetApi* | [**dataset_dataset_id_datapoints_csv_post**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_datapoints_csv_post) | **POST** /dataset/{datasetId}/datapoints/csv | Creates multiple datapoints from a csv.
|
|
90
100
|
*DatasetApi* | [**dataset_dataset_id_datapoints_failed_get**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_datapoints_failed_get) | **GET** /dataset/{datasetId}/datapoints/failed | Gets a list of all datapoints that failed to upload.
|
|
91
|
-
*DatasetApi* | [**
|
|
101
|
+
*DatasetApi* | [**dataset_dataset_id_datapoints_files_post**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_datapoints_files_post) | **POST** /dataset/{datasetId}/datapoints/files | Creates a single datapoint by uploading files.
|
|
102
|
+
*DatasetApi* | [**dataset_dataset_id_datapoints_get**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_datapoints_get) | **GET** /dataset/{datasetId}/datapoints | Gets all datapoints of a dataset.
|
|
103
|
+
*DatasetApi* | [**dataset_dataset_id_datapoints_s3_post**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_datapoints_s3_post) | **POST** /dataset/{datasetId}/datapoints/s3 | Uploads files from an S3 bucket to a dataset.
|
|
104
|
+
*DatasetApi* | [**dataset_dataset_id_datapoints_texts_post**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_datapoints_texts_post) | **POST** /dataset/{datasetId}/datapoints/texts | Creates a single datapoint from text sources.
|
|
105
|
+
*DatasetApi* | [**dataset_dataset_id_datapoints_urls_post**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_datapoints_urls_post) | **POST** /dataset/{datasetId}/datapoints/urls | Creates a single datapoint where the assets are fetched from the specified urls.
|
|
106
|
+
*DatasetApi* | [**dataset_dataset_id_get**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_get) | **GET** /dataset/{datasetId} | Gets a dataset by its id.
|
|
107
|
+
*DatasetApi* | [**dataset_dataset_id_name_patch**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_name_patch) | **PATCH** /dataset/{datasetId}/name | Updates the name of a dataset.
|
|
92
108
|
*DatasetApi* | [**dataset_dataset_id_progress_get**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_progress_get) | **GET** /dataset/{datasetId}/progress | Gets the upload progress of a dataset.
|
|
93
|
-
*DatasetApi* | [**
|
|
94
|
-
*DatasetApi* | [**dataset_import_post**](rapidata/api_client/docs/DatasetApi.md#dataset_import_post) | **POST** /
|
|
95
|
-
*DatasetApi* | [**
|
|
96
|
-
*DatasetApi* | [**
|
|
97
|
-
*
|
|
98
|
-
*IdentityApi* | [**
|
|
99
|
-
*IdentityApi* | [**
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*OrderApi* | [**
|
|
109
|
-
*OrderApi* | [**
|
|
110
|
-
*OrderApi* | [**
|
|
111
|
-
*OrderApi* | [**
|
|
112
|
-
*OrderApi* | [**
|
|
113
|
-
*OrderApi* | [**
|
|
114
|
-
*OrderApi* | [**
|
|
115
|
-
*OrderApi* | [**
|
|
116
|
-
*OrderApi* | [**
|
|
117
|
-
*OrderApi* | [**
|
|
118
|
-
*OrderApi* | [**
|
|
119
|
-
*OrderApi* | [**
|
|
120
|
-
*OrderApi* | [**
|
|
121
|
-
*OrderApi* | [**
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
109
|
+
*DatasetApi* | [**dataset_getbyid_get**](rapidata/api_client/docs/DatasetApi.md#dataset_getbyid_get) | **GET** /dataset/getbyid | Gets a dataset by its id.
|
|
110
|
+
*DatasetApi* | [**dataset_import_post**](rapidata/api_client/docs/DatasetApi.md#dataset_import_post) | **POST** /dataset/import | Imports datapoints from a csv file.
|
|
111
|
+
*DatasetApi* | [**dataset_updatename_post**](rapidata/api_client/docs/DatasetApi.md#dataset_updatename_post) | **POST** /dataset/updatename | Updates the name of a dataset.
|
|
112
|
+
*DatasetApi* | [**dataset_uploadfilesfroms3_post**](rapidata/api_client/docs/DatasetApi.md#dataset_uploadfilesfroms3_post) | **POST** /dataset/uploadfilesfroms3 | Uploads files from an S3 bucket to a dataset.
|
|
113
|
+
*FeedbackApi* | [**feedback_feedback_post**](rapidata/api_client/docs/FeedbackApi.md#feedback_feedback_post) | **POST** /feedback/feedback | Submits feedback about our services.
|
|
114
|
+
*IdentityApi* | [**identity_bridge_token_get**](rapidata/api_client/docs/IdentityApi.md#identity_bridge_token_get) | **GET** /identity/bridge-token | Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
|
|
115
|
+
*IdentityApi* | [**identity_bridge_token_post**](rapidata/api_client/docs/IdentityApi.md#identity_bridge_token_post) | **POST** /identity/bridge-token | Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
|
|
116
|
+
*IdentityApi* | [**identity_createbridgetoken_post**](rapidata/api_client/docs/IdentityApi.md#identity_createbridgetoken_post) | **POST** /identity/createbridgetoken | Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
|
|
117
|
+
*IdentityApi* | [**identity_readbridgetoken_get**](rapidata/api_client/docs/IdentityApi.md#identity_readbridgetoken_get) | **GET** /identity/readbridgetoken | Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
|
|
118
|
+
*IdentityApi* | [**identity_referrer_post**](rapidata/api_client/docs/IdentityApi.md#identity_referrer_post) | **POST** /identity/referrer | Sets the referrer for the current customer.
|
|
119
|
+
*IdentityApi* | [**identity_registertemporary_post**](rapidata/api_client/docs/IdentityApi.md#identity_registertemporary_post) | **POST** /identity/registertemporary | Registers and logs in a temporary customer.
|
|
120
|
+
*IdentityApi* | [**identity_temporary_post**](rapidata/api_client/docs/IdentityApi.md#identity_temporary_post) | **POST** /identity/temporary | Registers and logs in a temporary customer.
|
|
121
|
+
*NewsletterApi* | [**newsletter_post**](rapidata/api_client/docs/NewsletterApi.md#newsletter_post) | **POST** /newsletter | Signs a user up to the newsletter.
|
|
122
|
+
*NewsletterApi* | [**newsletter_subscribe_post**](rapidata/api_client/docs/NewsletterApi.md#newsletter_subscribe_post) | **POST** /newsletter/subscribe | Signs a user up to the newsletter.
|
|
123
|
+
*NewsletterApi* | [**newsletter_unsubscribe_post**](rapidata/api_client/docs/NewsletterApi.md#newsletter_unsubscribe_post) | **POST** /newsletter/unsubscribe | Unsubscribes a user from the newsletter.
|
|
124
|
+
*OrderApi* | [**order_approve_post**](rapidata/api_client/docs/OrderApi.md#order_approve_post) | **POST** /order/approve | Approves an order that has been submitted for manual approval.
|
|
125
|
+
*OrderApi* | [**order_cloneorder_post**](rapidata/api_client/docs/OrderApi.md#order_cloneorder_post) | **POST** /order/cloneorder | Clones an existing order.
|
|
126
|
+
*OrderApi* | [**order_complex_post**](rapidata/api_client/docs/OrderApi.md#order_complex_post) | **POST** /order/complex | Creates a new order with a custom pipeline.
|
|
127
|
+
*OrderApi* | [**order_create_post**](rapidata/api_client/docs/OrderApi.md#order_create_post) | **POST** /order/create | Used to create a new order.
|
|
128
|
+
*OrderApi* | [**order_createcomplexorder_post**](rapidata/api_client/docs/OrderApi.md#order_createcomplexorder_post) | **POST** /order/createcomplexorder | Creates a new order with a custom pipeline.
|
|
129
|
+
*OrderApi* | [**order_createunsupportedorder_post**](rapidata/api_client/docs/OrderApi.md#order_createunsupportedorder_post) | **POST** /order/createunsupportedorder | Notifies the admins that a user wants to create an order with an unsupported label type or data type.
|
|
130
|
+
*OrderApi* | [**order_delete_delete**](rapidata/api_client/docs/OrderApi.md#order_delete_delete) | **DELETE** /order/delete | Deletes an order.
|
|
131
|
+
*OrderApi* | [**order_getbyid_get**](rapidata/api_client/docs/OrderApi.md#order_getbyid_get) | **GET** /order/getbyid | Retrieves an order by its id.
|
|
132
|
+
*OrderApi* | [**order_getorderresults_get**](rapidata/api_client/docs/OrderApi.md#order_getorderresults_get) | **GET** /order/getorderresults | Aggregates the results of an order.
|
|
133
|
+
*OrderApi* | [**order_getpublic_get**](rapidata/api_client/docs/OrderApi.md#order_getpublic_get) | **GET** /order/getpublic | Retrieves orders that are public and can be cloned by any user.
|
|
134
|
+
*OrderApi* | [**order_order_id_approve_post**](rapidata/api_client/docs/OrderApi.md#order_order_id_approve_post) | **POST** /order/{orderId}/approve | Approves an order that has been submitted for manual approval.
|
|
135
|
+
*OrderApi* | [**order_order_id_clone_post**](rapidata/api_client/docs/OrderApi.md#order_order_id_clone_post) | **POST** /order/{orderId}/clone | Clones an existing order.
|
|
136
|
+
*OrderApi* | [**order_order_id_delete**](rapidata/api_client/docs/OrderApi.md#order_order_id_delete) | **DELETE** /order/{orderId} | Deletes an order.
|
|
137
|
+
*OrderApi* | [**order_order_id_demo_patch**](rapidata/api_client/docs/OrderApi.md#order_order_id_demo_patch) | **PATCH** /order/{orderId}/demo | Updates whether an order is a demo or not.
|
|
138
|
+
*OrderApi* | [**order_order_id_download_results_get**](rapidata/api_client/docs/OrderApi.md#order_order_id_download_results_get) | **GET** /order/{orderId}/download-results | Aggregates the results of an order and returns it as a file attachment.
|
|
139
|
+
*OrderApi* | [**order_order_id_get**](rapidata/api_client/docs/OrderApi.md#order_order_id_get) | **GET** /order/{orderId} | Retrieves an order by its id.
|
|
140
|
+
*OrderApi* | [**order_order_id_name_patch**](rapidata/api_client/docs/OrderApi.md#order_order_id_name_patch) | **PATCH** /order/{orderId}/name | Updates the name of an order.
|
|
141
|
+
*OrderApi* | [**order_order_id_pause_post**](rapidata/api_client/docs/OrderApi.md#order_order_id_pause_post) | **POST** /order/{orderId}/pause | Pauses an order that is processing. Meaning all campaigns in the order will be paused.
|
|
142
|
+
*OrderApi* | [**order_order_id_preview_post**](rapidata/api_client/docs/OrderApi.md#order_order_id_preview_post) | **POST** /order/{orderId}/preview | Puts the order into preview mode, where one can inspect what our labelers receive.
|
|
143
|
+
*OrderApi* | [**order_order_id_results_get**](rapidata/api_client/docs/OrderApi.md#order_order_id_results_get) | **GET** /order/{orderId}/results | Aggregates the results of an order and returns the result as a json body.
|
|
144
|
+
*OrderApi* | [**order_order_id_resume_post**](rapidata/api_client/docs/OrderApi.md#order_order_id_resume_post) | **POST** /order/{orderId}/resume | Resumes a paused order. Meaning all campaigns in the order will be resumed.
|
|
145
|
+
*OrderApi* | [**order_order_id_retry_post**](rapidata/api_client/docs/OrderApi.md#order_order_id_retry_post) | **POST** /order/{orderId}/retry | Retries a failed order.
|
|
146
|
+
*OrderApi* | [**order_order_id_share_patch**](rapidata/api_client/docs/OrderApi.md#order_order_id_share_patch) | **PATCH** /order/{orderId}/share | Updates whether an order is public or not.
|
|
147
|
+
*OrderApi* | [**order_order_id_submit_post**](rapidata/api_client/docs/OrderApi.md#order_order_id_submit_post) | **POST** /order/{orderId}/submit | Submits an order for approval.
|
|
148
|
+
*OrderApi* | [**order_order_id_unlock_post**](rapidata/api_client/docs/OrderApi.md#order_order_id_unlock_post) | **POST** /order/{orderId}/unlock | Unlocks a newly cloned order.
|
|
149
|
+
*OrderApi* | [**order_pause_post**](rapidata/api_client/docs/OrderApi.md#order_pause_post) | **POST** /order/pause | Pauses an order that is processing. Meaning all campaigns in the order will be paused.
|
|
150
|
+
*OrderApi* | [**order_post**](rapidata/api_client/docs/OrderApi.md#order_post) | **POST** /order | Used to create a new order.
|
|
151
|
+
*OrderApi* | [**order_query_get**](rapidata/api_client/docs/OrderApi.md#order_query_get) | **GET** /order/query | Queries orders based on a filter, page, and sort criteria.
|
|
152
|
+
*OrderApi* | [**order_result_get**](rapidata/api_client/docs/OrderApi.md#order_result_get) | **GET** /order/result | Aggregates the results of an order.
|
|
153
|
+
*OrderApi* | [**order_resume_post**](rapidata/api_client/docs/OrderApi.md#order_resume_post) | **POST** /order/resume | Resumes a paused order. Meaning all campaigns in the order will be resumed.
|
|
154
|
+
*OrderApi* | [**order_retryfailed_post**](rapidata/api_client/docs/OrderApi.md#order_retryfailed_post) | **POST** /order/retryfailed | Retries a failed order.
|
|
155
|
+
*OrderApi* | [**order_share_put**](rapidata/api_client/docs/OrderApi.md#order_share_put) | **PUT** /order/share | Updates whether an order is public or not.
|
|
156
|
+
*OrderApi* | [**order_submit_post**](rapidata/api_client/docs/OrderApi.md#order_submit_post) | **POST** /order/submit | Submits an order for approval.
|
|
157
|
+
*OrderApi* | [**order_unlock_post**](rapidata/api_client/docs/OrderApi.md#order_unlock_post) | **POST** /order/unlock | Unlocks a newly cloned order.
|
|
158
|
+
*OrderApi* | [**order_unsupported_post**](rapidata/api_client/docs/OrderApi.md#order_unsupported_post) | **POST** /order/unsupported | Notifies the admins that a user wants to create an order with an unsupported label type or data type.
|
|
159
|
+
*OrderApi* | [**order_updateaccess_put**](rapidata/api_client/docs/OrderApi.md#order_updateaccess_put) | **PUT** /order/updateaccess | Updates whether an order is public or not.
|
|
160
|
+
*OrderApi* | [**order_updateordername_put**](rapidata/api_client/docs/OrderApi.md#order_updateordername_put) | **PUT** /order/updateordername | Updates the name of an order.
|
|
161
|
+
*OrderApi* | [**orders_get**](rapidata/api_client/docs/OrderApi.md#orders_get) | **GET** /orders | Queries orders based on a filter, page, and sort criteria.
|
|
162
|
+
*OrderApi* | [**orders_public_get**](rapidata/api_client/docs/OrderApi.md#orders_public_get) | **GET** /orders/public | Retrieves orders that are public and can be cloned by any user.
|
|
163
|
+
*PipelineApi* | [**pipeline_id_workflow_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_artifact_id_put) | **PUT** /pipeline/{id}/workflow/{artifactId} | Updates the workflow configuration for a pipeline.
|
|
164
|
+
*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.
|
|
165
|
+
*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.
|
|
166
|
+
*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.
|
|
167
|
+
*PipelineApi* | [**pipeline_pipeline_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_get) | **GET** /pipeline/{pipelineId} | Gets a pipeline by its id.
|
|
128
168
|
*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.
|
|
129
|
-
*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.
|
|
130
|
-
*RapidApi* | [**
|
|
131
|
-
*RapidApi* | [**
|
|
132
|
-
*RapidApi* | [**
|
|
169
|
+
*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.
|
|
170
|
+
*RapidApi* | [**rapid_adduserguess_post**](rapidata/api_client/docs/RapidApi.md#rapid_adduserguess_post) | **POST** /rapid/adduserguess | Submits a user guess for a Rapid.
|
|
171
|
+
*RapidApi* | [**rapid_createdemographicrapid_post**](rapidata/api_client/docs/RapidApi.md#rapid_createdemographicrapid_post) | **POST** /rapid/createdemographicrapid | Creates a new Demographic Rapid.
|
|
172
|
+
*RapidApi* | [**rapid_demographic_post**](rapidata/api_client/docs/RapidApi.md#rapid_demographic_post) | **POST** /rapid/demographic | Creates a new Demographic Rapid.
|
|
173
|
+
*RapidApi* | [**rapid_queryvalidationrapids_get**](rapidata/api_client/docs/RapidApi.md#rapid_queryvalidationrapids_get) | **GET** /rapid/queryvalidationrapids | Queries the validation rapids for a specific validation set.
|
|
174
|
+
*RapidApi* | [**rapid_rapid_bag_is_valid_get**](rapidata/api_client/docs/RapidApi.md#rapid_rapid_bag_is_valid_get) | **GET** /rapid/rapid-bag/is-valid | Validates that the rapids associated with the current user are active.
|
|
133
175
|
*RapidApi* | [**rapid_rapid_id_delete**](rapidata/api_client/docs/RapidApi.md#rapid_rapid_id_delete) | **DELETE** /rapid/{rapidId} | Deletes a rapid.
|
|
176
|
+
*RapidApi* | [**rapid_rapid_id_report_post**](rapidata/api_client/docs/RapidApi.md#rapid_rapid_id_report_post) | **POST** /rapid/{rapidId}/report | Used to report an issue with a rapid.
|
|
134
177
|
*RapidApi* | [**rapid_rapid_id_responses_get**](rapidata/api_client/docs/RapidApi.md#rapid_rapid_id_responses_get) | **GET** /rapid/{rapidId}/responses | Gets all responses for a given rapid.
|
|
135
|
-
*RapidApi* | [**
|
|
136
|
-
*RapidApi* | [**
|
|
137
|
-
*RapidApi* | [**
|
|
138
|
-
*RapidApi* | [**
|
|
178
|
+
*RapidApi* | [**rapid_report_post**](rapidata/api_client/docs/RapidApi.md#rapid_report_post) | **POST** /rapid/report | Used to report an issue with a rapid.
|
|
179
|
+
*RapidApi* | [**rapid_report_report_id_get**](rapidata/api_client/docs/RapidApi.md#rapid_report_report_id_get) | **GET** /rapid/report/{reportId} | Inspects a report's dump. can be used to restore zustand state or anything alike.
|
|
180
|
+
*RapidApi* | [**rapid_response_post**](rapidata/api_client/docs/RapidApi.md#rapid_response_post) | **POST** /rapid/response | Submits a response for a Rapid.
|
|
181
|
+
*RapidApi* | [**rapid_skip_post**](rapidata/api_client/docs/RapidApi.md#rapid_skip_post) | **POST** /rapid/skip | Skips a Rapid for the user.
|
|
182
|
+
*RapidApi* | [**rapid_skipuserguess_post**](rapidata/api_client/docs/RapidApi.md#rapid_skipuserguess_post) | **POST** /rapid/skipuserguess | Skips a Rapid for the user.
|
|
183
|
+
*RapidApi* | [**rapid_validatecurrentrapidbag_get**](rapidata/api_client/docs/RapidApi.md#rapid_validatecurrentrapidbag_get) | **GET** /rapid/validatecurrentrapidbag | Validates that the rapids associated with the current user are active.
|
|
184
|
+
*RapidApi* | [**rapid_validation_rapid_id_patch**](rapidata/api_client/docs/RapidApi.md#rapid_validation_rapid_id_patch) | **PATCH** /rapid/validation/{rapidId} | Updates the validation information of a rapid.
|
|
139
185
|
*RapidApi* | [**rapid_validation_rapid_id_put**](rapidata/api_client/docs/RapidApi.md#rapid_validation_rapid_id_put) | **PUT** /rapid/validation/{rapidId} | Updates the validation information of a rapid.
|
|
140
186
|
*RapidataIdentityAPIApi* | [**root_get**](rapidata/api_client/docs/RapidataIdentityAPIApi.md#root_get) | **GET** / |
|
|
141
|
-
*SimpleWorkflowApi* | [**
|
|
187
|
+
*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.
|
|
142
188
|
*UserInfoApi* | [**connect_userinfo_get**](rapidata/api_client/docs/UserInfoApi.md#connect_userinfo_get) | **GET** /connect/userinfo | Retrieves information about the authenticated user.
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
189
|
+
*ValidationSetApi* | [**validation_addvalidationrapid_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_addvalidationrapid_post) | **POST** /validation/addvalidationrapid | Adds a new validation rapid to the specified validation set.
|
|
190
|
+
*ValidationSetApi* | [**validation_addvalidationtextrapid_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_addvalidationtextrapid_post) | **POST** /validation/addvalidationtextrapid | Adds a new validation rapid to the specified validation set.
|
|
191
|
+
*ValidationSetApi* | [**validation_createvalidationset_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_createvalidationset_post) | **POST** /validation/createvalidationset | Creates a new empty validation set.
|
|
192
|
+
*ValidationSetApi* | [**validation_getavailablevalidationsets_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_getavailablevalidationsets_get) | **GET** /validation/getavailablevalidationsets | Gets the available validation sets for the current user.
|
|
193
|
+
*ValidationSetApi* | [**validation_getbyid_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_getbyid_get) | **GET** /validation/getbyid | Gets a validation set by the id.
|
|
194
|
+
*ValidationSetApi* | [**validation_import_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_import_post) | **POST** /validation/import | Imports a validation set from a zip file.
|
|
195
|
+
*ValidationSetApi* | [**validation_importcompare_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_importcompare_post) | **POST** /validation/importcompare | Imports a compare validation set from a zip file.
|
|
196
|
+
*ValidationSetApi* | [**validation_queryvalidationsets_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_queryvalidationsets_get) | **GET** /validation/queryvalidationsets | Queries validation sets based on the provided filter, paging and sorting criteria.
|
|
197
|
+
*ValidationSetApi* | [**validation_set_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_post) | **POST** /validation-set | Creates a new empty validation set.
|
|
198
|
+
*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.
|
|
199
|
+
*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.
|
|
200
|
+
*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.
|
|
201
|
+
*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.
|
|
202
|
+
*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.
|
|
203
|
+
*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.
|
|
204
|
+
*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.
|
|
205
|
+
*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.
|
|
206
|
+
*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.
|
|
207
|
+
*ValidationSetApi* | [**validation_validation_set_id_dimensions_patch**](rapidata/api_client/docs/ValidationSetApi.md#validation_validation_set_id_dimensions_patch) | **PATCH** /validation/{validationSetId}/dimensions | Updates the dimensions of all rapids within a validation set.
|
|
208
|
+
*WorkflowApi* | [**workflow_delete_delete**](rapidata/api_client/docs/WorkflowApi.md#workflow_delete_delete) | **DELETE** /workflow/delete | Deletes a workflow.
|
|
209
|
+
*WorkflowApi* | [**workflow_getbyid_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_getbyid_get) | **GET** /workflow/getbyid | Get a workflow by its ID.
|
|
210
|
+
*WorkflowApi* | [**workflow_getprogress_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_getprogress_get) | **GET** /workflow/getprogress | Get the progress of a workflow.
|
|
211
|
+
*WorkflowApi* | [**workflow_query_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_query_get) | **GET** /workflow/query | Queries workflows based on the provided filter, page, and sort criteria.
|
|
212
|
+
*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.
|
|
213
|
+
*WorkflowApi* | [**workflow_workflow_id_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_workflow_id_get) | **GET** /workflow/{workflowId} | Get a workflow by its ID.
|
|
214
|
+
*WorkflowApi* | [**workflow_workflow_id_progress_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_workflow_id_progress_get) | **GET** /workflow/{workflowId}/progress | Get the progress of a workflow.
|
|
215
|
+
*WorkflowApi* | [**workflow_workflow_id_responses_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_workflow_id_responses_get) | **GET** /workflow/{workflowId}/responses | Gets the limit most recent or oldest responses for a workflow. The responses are not guaranteed to be of any specific rapid. Instead, this endpoint returns all responses to any rapid in the workflow.
|
|
216
|
+
*WorkflowApi* | [**workflows_get**](rapidata/api_client/docs/WorkflowApi.md#workflows_get) | **GET** /workflows | Queries workflows based on the provided filter, page, and sort criteria.
|
|
157
217
|
|
|
158
218
|
|
|
159
219
|
## Documentation For Models
|
|
@@ -162,6 +222,8 @@ Class | Method | HTTP request | Description
|
|
|
162
222
|
- [AbTestSelectionAInner](rapidata/api_client/docs/AbTestSelectionAInner.md)
|
|
163
223
|
- [AddCampaignArtifactResult](rapidata/api_client/docs/AddCampaignArtifactResult.md)
|
|
164
224
|
- [AddCampaignModel](rapidata/api_client/docs/AddCampaignModel.md)
|
|
225
|
+
- [AddUserResponseResult](rapidata/api_client/docs/AddUserResponseResult.md)
|
|
226
|
+
- [AddUserResponseResultValidationTruth](rapidata/api_client/docs/AddUserResponseResultValidationTruth.md)
|
|
165
227
|
- [AddValidationRapidModel](rapidata/api_client/docs/AddValidationRapidModel.md)
|
|
166
228
|
- [AddValidationRapidModelPayload](rapidata/api_client/docs/AddValidationRapidModelPayload.md)
|
|
167
229
|
- [AddValidationRapidModelTruth](rapidata/api_client/docs/AddValidationRapidModelTruth.md)
|
|
@@ -170,6 +232,7 @@ Class | Method | HTTP request | Description
|
|
|
170
232
|
- [AgeGroup](rapidata/api_client/docs/AgeGroup.md)
|
|
171
233
|
- [AgeUserFilterModel](rapidata/api_client/docs/AgeUserFilterModel.md)
|
|
172
234
|
- [AggregatorType](rapidata/api_client/docs/AggregatorType.md)
|
|
235
|
+
- [AreRapidsActiveResult](rapidata/api_client/docs/AreRapidsActiveResult.md)
|
|
173
236
|
- [AttachCategoryRapidBlueprint](rapidata/api_client/docs/AttachCategoryRapidBlueprint.md)
|
|
174
237
|
- [AttachCategoryResult](rapidata/api_client/docs/AttachCategoryResult.md)
|
|
175
238
|
- [AttachCategoryTruth](rapidata/api_client/docs/AttachCategoryTruth.md)
|
|
@@ -220,9 +283,12 @@ Class | Method | HTTP request | Description
|
|
|
220
283
|
- [CreateComplexOrderModel](rapidata/api_client/docs/CreateComplexOrderModel.md)
|
|
221
284
|
- [CreateComplexOrderModelPipeline](rapidata/api_client/docs/CreateComplexOrderModelPipeline.md)
|
|
222
285
|
- [CreateComplexOrderResult](rapidata/api_client/docs/CreateComplexOrderResult.md)
|
|
286
|
+
- [CreateDatapointFromFilesModel](rapidata/api_client/docs/CreateDatapointFromFilesModel.md)
|
|
287
|
+
- [CreateDatapointFromFilesModelMetadataInner](rapidata/api_client/docs/CreateDatapointFromFilesModelMetadataInner.md)
|
|
288
|
+
- [CreateDatapointFromTextSourcesModel](rapidata/api_client/docs/CreateDatapointFromTextSourcesModel.md)
|
|
223
289
|
- [CreateDatapointFromUrlsModel](rapidata/api_client/docs/CreateDatapointFromUrlsModel.md)
|
|
224
|
-
- [CreateDatapointFromUrlsModelMetadataInner](rapidata/api_client/docs/CreateDatapointFromUrlsModelMetadataInner.md)
|
|
225
290
|
- [CreateDatapointResult](rapidata/api_client/docs/CreateDatapointResult.md)
|
|
291
|
+
- [CreateDatapointsFromS3BucketModel](rapidata/api_client/docs/CreateDatapointsFromS3BucketModel.md)
|
|
226
292
|
- [CreateDatasetArtifactModel](rapidata/api_client/docs/CreateDatasetArtifactModel.md)
|
|
227
293
|
- [CreateDatasetArtifactModelDataset](rapidata/api_client/docs/CreateDatasetArtifactModelDataset.md)
|
|
228
294
|
- [CreateDemographicRapidModel](rapidata/api_client/docs/CreateDemographicRapidModel.md)
|
|
@@ -232,10 +298,12 @@ Class | Method | HTTP request | Description
|
|
|
232
298
|
- [CreateOrderModelUserFiltersInner](rapidata/api_client/docs/CreateOrderModelUserFiltersInner.md)
|
|
233
299
|
- [CreateOrderModelWorkflow](rapidata/api_client/docs/CreateOrderModelWorkflow.md)
|
|
234
300
|
- [CreateOrderResult](rapidata/api_client/docs/CreateOrderResult.md)
|
|
301
|
+
- [CreateRapidResult](rapidata/api_client/docs/CreateRapidResult.md)
|
|
235
302
|
- [CreateSimplePipelineModel](rapidata/api_client/docs/CreateSimplePipelineModel.md)
|
|
236
303
|
- [CreateSimplePipelineModelArtifactsInner](rapidata/api_client/docs/CreateSimplePipelineModelArtifactsInner.md)
|
|
237
304
|
- [CreateSimplePipelineModelPipelineStepsInner](rapidata/api_client/docs/CreateSimplePipelineModelPipelineStepsInner.md)
|
|
238
305
|
- [CreateUnsupportedOrderModel](rapidata/api_client/docs/CreateUnsupportedOrderModel.md)
|
|
306
|
+
- [CreateValidationSetModel](rapidata/api_client/docs/CreateValidationSetModel.md)
|
|
239
307
|
- [CustomUserFilterModel](rapidata/api_client/docs/CustomUserFilterModel.md)
|
|
240
308
|
- [Datapoint](rapidata/api_client/docs/Datapoint.md)
|
|
241
309
|
- [DatapointAsset](rapidata/api_client/docs/DatapointAsset.md)
|
|
@@ -285,12 +353,13 @@ Class | Method | HTTP request | Description
|
|
|
285
353
|
- [GetSimpleWorkflowResultsModel](rapidata/api_client/docs/GetSimpleWorkflowResultsModel.md)
|
|
286
354
|
- [GetSimpleWorkflowResultsResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResult.md)
|
|
287
355
|
- [GetSimpleWorkflowResultsResultPagedResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResultPagedResult.md)
|
|
356
|
+
- [GetValidationRapidsQuery](rapidata/api_client/docs/GetValidationRapidsQuery.md)
|
|
357
|
+
- [GetValidationRapidsQueryPagedResult](rapidata/api_client/docs/GetValidationRapidsQueryPagedResult.md)
|
|
288
358
|
- [GetValidationSetByIdResult](rapidata/api_client/docs/GetValidationSetByIdResult.md)
|
|
289
359
|
- [GetWorkflowByIdResult](rapidata/api_client/docs/GetWorkflowByIdResult.md)
|
|
290
360
|
- [GetWorkflowByIdResultWorkflow](rapidata/api_client/docs/GetWorkflowByIdResultWorkflow.md)
|
|
291
361
|
- [GetWorkflowProgressResult](rapidata/api_client/docs/GetWorkflowProgressResult.md)
|
|
292
362
|
- [IWorkflowModelPagedResult](rapidata/api_client/docs/IWorkflowModelPagedResult.md)
|
|
293
|
-
- [IdentityReadBridgeTokenGet202Response](rapidata/api_client/docs/IdentityReadBridgeTokenGet202Response.md)
|
|
294
363
|
- [ImageDimensionMetadata](rapidata/api_client/docs/ImageDimensionMetadata.md)
|
|
295
364
|
- [ImageDimensionMetadataModel](rapidata/api_client/docs/ImageDimensionMetadataModel.md)
|
|
296
365
|
- [ImportFromFileResult](rapidata/api_client/docs/ImportFromFileResult.md)
|
|
@@ -336,7 +405,7 @@ Class | Method | HTTP request | Description
|
|
|
336
405
|
- [OriginalFilenameMetadata](rapidata/api_client/docs/OriginalFilenameMetadata.md)
|
|
337
406
|
- [OriginalFilenameMetadataModel](rapidata/api_client/docs/OriginalFilenameMetadataModel.md)
|
|
338
407
|
- [PageInfo](rapidata/api_client/docs/PageInfo.md)
|
|
339
|
-
- [
|
|
408
|
+
- [PipelineIdWorkflowArtifactIdPutRequest](rapidata/api_client/docs/PipelineIdWorkflowArtifactIdPutRequest.md)
|
|
340
409
|
- [PolygonPayload](rapidata/api_client/docs/PolygonPayload.md)
|
|
341
410
|
- [PolygonRapidBlueprint](rapidata/api_client/docs/PolygonRapidBlueprint.md)
|
|
342
411
|
- [PolygonResult](rapidata/api_client/docs/PolygonResult.md)
|
|
@@ -345,7 +414,6 @@ Class | Method | HTTP request | Description
|
|
|
345
414
|
- [PreliminaryDownloadResult](rapidata/api_client/docs/PreliminaryDownloadResult.md)
|
|
346
415
|
- [PrivateTextMetadataInput](rapidata/api_client/docs/PrivateTextMetadataInput.md)
|
|
347
416
|
- [ProbabilisticAttachCategoryRefereeConfig](rapidata/api_client/docs/ProbabilisticAttachCategoryRefereeConfig.md)
|
|
348
|
-
- [ProblemDetails](rapidata/api_client/docs/ProblemDetails.md)
|
|
349
417
|
- [PromptMetadata](rapidata/api_client/docs/PromptMetadata.md)
|
|
350
418
|
- [PromptMetadataInput](rapidata/api_client/docs/PromptMetadataInput.md)
|
|
351
419
|
- [PromptMetadataModel](rapidata/api_client/docs/PromptMetadataModel.md)
|
|
@@ -356,7 +424,6 @@ Class | Method | HTTP request | Description
|
|
|
356
424
|
- [QueryValidationRapidsResultAsset](rapidata/api_client/docs/QueryValidationRapidsResultAsset.md)
|
|
357
425
|
- [QueryValidationRapidsResultPagedResult](rapidata/api_client/docs/QueryValidationRapidsResultPagedResult.md)
|
|
358
426
|
- [QueryValidationRapidsResultPayload](rapidata/api_client/docs/QueryValidationRapidsResultPayload.md)
|
|
359
|
-
- [QueryValidationRapidsResultTruth](rapidata/api_client/docs/QueryValidationRapidsResultTruth.md)
|
|
360
427
|
- [QueryWorkflowsModel](rapidata/api_client/docs/QueryWorkflowsModel.md)
|
|
361
428
|
- [RapidIssue](rapidata/api_client/docs/RapidIssue.md)
|
|
362
429
|
- [RapidResponse](rapidata/api_client/docs/RapidResponse.md)
|
|
@@ -377,6 +444,7 @@ Class | Method | HTTP request | Description
|
|
|
377
444
|
- [ScrubTruth](rapidata/api_client/docs/ScrubTruth.md)
|
|
378
445
|
- [SendCompletionMailStepModel](rapidata/api_client/docs/SendCompletionMailStepModel.md)
|
|
379
446
|
- [Shape](rapidata/api_client/docs/Shape.md)
|
|
447
|
+
- [ShufflingSelection](rapidata/api_client/docs/ShufflingSelection.md)
|
|
380
448
|
- [SimpleWorkflowConfig](rapidata/api_client/docs/SimpleWorkflowConfig.md)
|
|
381
449
|
- [SimpleWorkflowConfigModel](rapidata/api_client/docs/SimpleWorkflowConfigModel.md)
|
|
382
450
|
- [SimpleWorkflowConfigModelBlueprint](rapidata/api_client/docs/SimpleWorkflowConfigModelBlueprint.md)
|
|
@@ -407,7 +475,9 @@ Class | Method | HTTP request | Description
|
|
|
407
475
|
- [UnlockOrderResult](rapidata/api_client/docs/UnlockOrderResult.md)
|
|
408
476
|
- [UpdateAccessModel](rapidata/api_client/docs/UpdateAccessModel.md)
|
|
409
477
|
- [UpdateCampaignModel](rapidata/api_client/docs/UpdateCampaignModel.md)
|
|
410
|
-
- [
|
|
478
|
+
- [UpdateDatasetNameModel](rapidata/api_client/docs/UpdateDatasetNameModel.md)
|
|
479
|
+
- [UpdateDimensionsModel](rapidata/api_client/docs/UpdateDimensionsModel.md)
|
|
480
|
+
- [UpdateOrderNameModel](rapidata/api_client/docs/UpdateOrderNameModel.md)
|
|
411
481
|
- [UpdateValidationRapidModel](rapidata/api_client/docs/UpdateValidationRapidModel.md)
|
|
412
482
|
- [UpdateValidationRapidModelTruth](rapidata/api_client/docs/UpdateValidationRapidModelTruth.md)
|
|
413
483
|
- [UploadCocoResult](rapidata/api_client/docs/UploadCocoResult.md)
|
|
@@ -2,6 +2,8 @@ from rapidata.service.openapi_service import OpenAPIService
|
|
|
2
2
|
from rapidata.rapidata_client.assets import MediaAsset
|
|
3
3
|
from rapidata.api_client.models.create_demographic_rapid_model import CreateDemographicRapidModel
|
|
4
4
|
from rapidata.api_client.models.classify_payload import ClassifyPayload
|
|
5
|
+
import requests
|
|
6
|
+
from requests.adapters import HTTPAdapter, Retry
|
|
5
7
|
|
|
6
8
|
|
|
7
9
|
class DemographicManager:
|
|
@@ -23,5 +25,38 @@ class DemographicManager:
|
|
|
23
25
|
title=instruction
|
|
24
26
|
)
|
|
25
27
|
)
|
|
26
|
-
|
|
28
|
+
session = self._get_session()
|
|
29
|
+
media.session = session
|
|
30
|
+
|
|
31
|
+
self._openapi_service.rapid_api.rapid_demographic_post(model=model, file=[media.to_file()])
|
|
32
|
+
|
|
33
|
+
def _get_session(self, max_retries: int = 5, max_workers: int = 10) -> requests.Session:
|
|
34
|
+
"""Get a requests session with retry logic.
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
Args:
|
|
38
|
+
max_retries (int): The maximum number of retries.
|
|
39
|
+
max_workers (int): The maximum number of workers.
|
|
40
|
+
|
|
41
|
+
Returns:
|
|
42
|
+
requests.Session: A requests session with retry logic.
|
|
43
|
+
"""
|
|
44
|
+
session = requests.Session()
|
|
45
|
+
retries = Retry(
|
|
46
|
+
total=max_retries,
|
|
47
|
+
backoff_factor=1,
|
|
48
|
+
status_forcelist=[500, 502, 503, 504],
|
|
49
|
+
allowed_methods=["GET"],
|
|
50
|
+
respect_retry_after_header=True
|
|
51
|
+
)
|
|
52
|
+
|
|
53
|
+
adapter = HTTPAdapter(
|
|
54
|
+
pool_connections=max_workers * 2,
|
|
55
|
+
pool_maxsize=max_workers * 4,
|
|
56
|
+
max_retries=retries
|
|
57
|
+
)
|
|
58
|
+
session.mount('http://', adapter)
|
|
59
|
+
session.mount('https://', adapter)
|
|
60
|
+
|
|
61
|
+
return session
|
|
27
62
|
|
|
@@ -13,6 +13,7 @@ class UserScoreFilter(RapidataFilter):
|
|
|
13
13
|
Args:
|
|
14
14
|
lower_bound (float): The lower bound of the user score.
|
|
15
15
|
upper_bound (float): The upper bound of the user score.
|
|
16
|
+
dimension (str): The dimension of the userScore to be considerd for the filter.
|
|
16
17
|
|
|
17
18
|
Example:
|
|
18
19
|
```python
|
|
@@ -20,7 +21,7 @@ class UserScoreFilter(RapidataFilter):
|
|
|
20
21
|
```
|
|
21
22
|
This will only show the order to users that have a UserScore of >=0.5 and <=0.9
|
|
22
23
|
"""
|
|
23
|
-
def __init__(self, lower_bound: float = 0.0, upper_bound: float = 1.0):
|
|
24
|
+
def __init__(self, lower_bound: float = 0.0, upper_bound: float = 1.0, dimension: str | None = None):
|
|
24
25
|
if lower_bound < 0 or lower_bound > 1:
|
|
25
26
|
raise ValueError("The lower bound must be between 0 and 1.")
|
|
26
27
|
if upper_bound < 0 or upper_bound > 1:
|
|
@@ -30,10 +31,12 @@ class UserScoreFilter(RapidataFilter):
|
|
|
30
31
|
|
|
31
32
|
self.upper_bound = upper_bound
|
|
32
33
|
self.lower_bound = lower_bound
|
|
34
|
+
self.dimension = dimension
|
|
33
35
|
|
|
34
36
|
def _to_model(self):
|
|
35
37
|
return UserScoreUserFilterModel(
|
|
36
38
|
_t="UserScoreFilter",
|
|
37
39
|
upperbound=self.upper_bound,
|
|
38
40
|
lowerbound=self.lower_bound,
|
|
41
|
+
dimension=self.dimension,
|
|
39
42
|
)
|
|
@@ -2,12 +2,12 @@ from itertools import zip_longest
|
|
|
2
2
|
|
|
3
3
|
from rapidata.api_client.models.datapoint_metadata_model import DatapointMetadataModel
|
|
4
4
|
from rapidata.api_client.models.create_datapoint_from_urls_model import (
|
|
5
|
-
|
|
5
|
+
CreateDatapointFromUrlsModel,
|
|
6
6
|
)
|
|
7
|
+
from rapidata.api_client.models.create_datapoint_from_files_model import CreateDatapointFromFilesModel
|
|
7
8
|
from rapidata.api_client.models.create_datapoint_from_urls_model import CreateDatapointFromUrlsModel
|
|
8
|
-
from rapidata.api_client.models.
|
|
9
|
-
|
|
10
|
-
)
|
|
9
|
+
from rapidata.api_client.models.create_datapoint_from_text_sources_model import CreateDatapointFromTextSourcesModel
|
|
10
|
+
from rapidata.api_client.models.create_datapoint_from_files_model_metadata_inner import CreateDatapointFromFilesModelMetadataInner
|
|
11
11
|
from rapidata.rapidata_client.metadata._base_metadata import Metadata
|
|
12
12
|
from rapidata.rapidata_client.assets import TextAsset, MediaAsset, MultiAsset
|
|
13
13
|
from rapidata.service import LocalFileService
|
|
@@ -54,13 +54,12 @@ class RapidataDataset:
|
|
|
54
54
|
else:
|
|
55
55
|
raise ValueError(f"Unsupported asset type: {type(text_asset)}")
|
|
56
56
|
|
|
57
|
-
model =
|
|
58
|
-
datasetId=self.dataset_id,
|
|
57
|
+
model = CreateDatapointFromTextSourcesModel(
|
|
59
58
|
textSources=texts,
|
|
60
59
|
sortIndex=index,
|
|
61
60
|
)
|
|
62
61
|
|
|
63
|
-
upload_response = self.openapi_service.dataset_api.
|
|
62
|
+
upload_response = self.openapi_service.dataset_api.dataset_dataset_id_datapoints_texts_post(dataset_id=self.dataset_id, create_datapoint_from_text_sources_model=model)
|
|
64
63
|
|
|
65
64
|
if upload_response.errors:
|
|
66
65
|
raise ValueError(f"Error uploading text datapoint: {upload_response.errors}")
|
|
@@ -116,7 +115,7 @@ class RapidataDataset:
|
|
|
116
115
|
|
|
117
116
|
meta_model = meta.to_model() if meta else None
|
|
118
117
|
|
|
119
|
-
metadata = [
|
|
118
|
+
metadata = [CreateDatapointFromFilesModelMetadataInner(meta_model)] if meta_model else []
|
|
120
119
|
|
|
121
120
|
local_paths: bool = assets[0].is_local()
|
|
122
121
|
files: list[StrictStr] = []
|
|
@@ -125,12 +124,12 @@ class RapidataDataset:
|
|
|
125
124
|
files.append(asset.path)
|
|
126
125
|
|
|
127
126
|
if local_paths:
|
|
128
|
-
model =
|
|
129
|
-
datasetId=self.dataset_id,
|
|
127
|
+
model = CreateDatapointFromFilesModel(
|
|
130
128
|
metadata=metadata,
|
|
131
129
|
sortIndex=index,
|
|
132
130
|
)
|
|
133
|
-
upload_response = self.openapi_service.dataset_api.
|
|
131
|
+
upload_response = self.openapi_service.dataset_api.dataset_dataset_id_datapoints_files_post(
|
|
132
|
+
dataset_id=self.dataset_id,
|
|
134
133
|
model=model,
|
|
135
134
|
files=files # type: ignore
|
|
136
135
|
)
|
|
@@ -124,7 +124,7 @@ class RapidataOrderBuilder:
|
|
|
124
124
|
create_order_model=order_model
|
|
125
125
|
)
|
|
126
126
|
|
|
127
|
-
self.order_id = result.order_id
|
|
127
|
+
self.order_id = str(result.order_id)
|
|
128
128
|
|
|
129
129
|
self.__dataset = (
|
|
130
130
|
RapidataDataset(result.dataset_id, self.__openapi_service)
|
|
@@ -182,6 +182,8 @@ class RapidataOrderBuilder:
|
|
|
182
182
|
raise ValueError(
|
|
183
183
|
"Media paths must all be of the same type: MediaAsset, TextAsset, or MultiAsset."
|
|
184
184
|
)
|
|
185
|
+
|
|
186
|
+
self.__openapi_service.order_api.order_order_id_preview_post(self.order_id)
|
|
185
187
|
|
|
186
188
|
return order
|
|
187
189
|
|