rapidata 2.14.0__py3-none-any.whl → 2.15.0__py3-none-any.whl

rapidata/api_client_README.md

@@ -56,12 +56,13 @@ configuration.api_key['bearer'] = os.environ["API_KEY"]
 with rapidata.api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = rapidata.api_client.CampaignApi(api_client)
+    campaign_id = 'campaign_id_example' # str | The campaign id that should be released
 
     try:
-        # The monitor endpoint is used to monitor the health of the service
-        api_instance.campaign_monitor_get()
+        # Releases a campaign from the preview state.  This will make the campaign available for the users to be labeled.
+        api_instance.campaign_campaign_id_release_post(campaign_id)
     except ApiException as e:
-        print("Exception when calling CampaignApi->campaign_monitor_get: %s\n" % e)
+        print("Exception when calling CampaignApi->campaign_campaign_id_release_post: %s\n" % e)
 
 ```
 
@@ -71,6 +72,7 @@ All URIs are relative to *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*CampaignApi* | [**campaign_campaign_id_release_post**](rapidata/api_client/docs/CampaignApi.md#campaign_campaign_id_release_post) | **POST** /campaign/{campaignId}/release | Releases a campaign from the preview state.  This will make the campaign available for the users to be labeled.
 *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
 *CampaignApi* | [**campaign_pause_post**](rapidata/api_client/docs/CampaignApi.md#campaign_pause_post) | **POST** /Campaign/Pause | Pauses a campaign.
 *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.
@@ -109,6 +111,7 @@ Class | Method | HTTP request | Description
 *OrderApi* | [**order_get_by_id_get**](rapidata/api_client/docs/OrderApi.md#order_get_by_id_get) | **GET** /Order/GetById | Retrieves an order by its id.
 *OrderApi* | [**order_get_order_results_get**](rapidata/api_client/docs/OrderApi.md#order_get_order_results_get) | **GET** /Order/GetOrderResults | Aggregates the results of an order.
 *OrderApi* | [**order_get_public_get**](rapidata/api_client/docs/OrderApi.md#order_get_public_get) | **GET** /Order/GetPublic | Retrieves orders that are public and can be cloned by any user.
+*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 it one can inspect what our labelers receive.
 *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.
 *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.
 *OrderApi* | [**order_result_get**](rapidata/api_client/docs/OrderApi.md#order_result_get) | **GET** /Order/Result | Aggregates the results of an order.
@@ -131,6 +134,7 @@ Class | Method | HTTP request | Description
 *RapidApi* | [**rapid_create_demographic_rapid_post**](rapidata/api_client/docs/RapidApi.md#rapid_create_demographic_rapid_post) | **POST** /Rapid/CreateDemographicRapid | Creates a new Demographic Rapid.
 *RapidApi* | [**rapid_query_validation_rapids_get**](rapidata/api_client/docs/RapidApi.md#rapid_query_validation_rapids_get) | **GET** /Rapid/QueryValidationRapids | Queries the validation rapids for a specific validation set.
 *RapidApi* | [**rapid_rapid_id_delete**](rapidata/api_client/docs/RapidApi.md#rapid_rapid_id_delete) | **DELETE** /rapid/{rapidId} | Deletes a rapid.
+*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.
 *RapidApi* | [**rapid_report_id_get**](rapidata/api_client/docs/RapidApi.md#rapid_report_id_get) | **GET** /rapid/report/{id} | Inspects a report's dump. can be used to restore zustand state or anything alike.
 *RapidApi* | [**rapid_report_post**](rapidata/api_client/docs/RapidApi.md#rapid_report_post) | **POST** /Rapid/Report | Used to report an issue with a rapid.
 *RapidApi* | [**rapid_skip_user_guess_post**](rapidata/api_client/docs/RapidApi.md#rapid_skip_user_guess_post) | **POST** /Rapid/SkipUserGuess | Skips a Rapid for the user.
@@ -147,11 +151,12 @@ Class | Method | HTTP request | Description
 *ValidationApi* | [**validation_import_compare_post**](rapidata/api_client/docs/ValidationApi.md#validation_import_compare_post) | **POST** /Validation/ImportCompare | Imports a compare validation set from a zip file.
 *ValidationApi* | [**validation_import_post**](rapidata/api_client/docs/ValidationApi.md#validation_import_post) | **POST** /Validation/Import | Imports a validation set from a zip file.
 *ValidationApi* | [**validation_query_validation_sets_get**](rapidata/api_client/docs/ValidationApi.md#validation_query_validation_sets_get) | **GET** /Validation/QueryValidationSets | Queries validation sets based on the provided filter, paging and sorting criteria.
+*ValidationApi* | [**validation_validation_set_id_dimensions_patch**](rapidata/api_client/docs/ValidationApi.md#validation_validation_set_id_dimensions_patch) | **PATCH** /validation/{validationSetId}/dimensions | Updates the dimensions of all rapids within a validation set.
 *WorkflowApi* | [**workflow_delete_delete**](rapidata/api_client/docs/WorkflowApi.md#workflow_delete_delete) | **DELETE** /Workflow/Delete | Deletes a workflow.
 *WorkflowApi* | [**workflow_get_by_id_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_get_by_id_get) | **GET** /Workflow/GetById | Get a workflow by its ID.
 *WorkflowApi* | [**workflow_get_progress_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_get_progress_get) | **GET** /Workflow/GetProgress | Get the progress of a workflow.
 *WorkflowApi* | [**workflow_id_compare_ab_summary_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_id_compare_ab_summary_get) | **GET** /workflow/{id}/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.
-*WorkflowApi* | [**workflow_id_responses_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_id_responses_get) | **GET** /workflow/{id}/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.
+*WorkflowApi* | [**workflow_id_responses_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_id_responses_get) | **GET** /workflow/{id}/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.
 *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.
 
 
@@ -184,6 +189,7 @@ Class | Method | HTTP request | Description
  - [CampaignStatus](rapidata/api_client/docs/CampaignStatus.md)
  - [CampaignUserFilterModel](rapidata/api_client/docs/CampaignUserFilterModel.md)
  - [CappedSelection](rapidata/api_client/docs/CappedSelection.md)
+ - [ClassificationMetadata](rapidata/api_client/docs/ClassificationMetadata.md)
  - [ClassificationMetadataFilterConfig](rapidata/api_client/docs/ClassificationMetadataFilterConfig.md)
  - [ClassificationMetadataModel](rapidata/api_client/docs/ClassificationMetadataModel.md)
  - [ClassifyPayload](rapidata/api_client/docs/ClassifyPayload.md)
@@ -197,6 +203,7 @@ Class | Method | HTTP request | Description
  - [CompareResult](rapidata/api_client/docs/CompareResult.md)
  - [CompareTruth](rapidata/api_client/docs/CompareTruth.md)
  - [CompareWorkflowConfig](rapidata/api_client/docs/CompareWorkflowConfig.md)
+ - [CompareWorkflowConfigMetadataValue](rapidata/api_client/docs/CompareWorkflowConfigMetadataValue.md)
  - [CompareWorkflowConfigModel](rapidata/api_client/docs/CompareWorkflowConfigModel.md)
  - [CompareWorkflowConfigModelPairMakerConfig](rapidata/api_client/docs/CompareWorkflowConfigModelPairMakerConfig.md)
  - [CompareWorkflowConfigPairMakerConfig](rapidata/api_client/docs/CompareWorkflowConfigPairMakerConfig.md)
@@ -208,6 +215,7 @@ Class | Method | HTTP request | Description
  - [ConditionalValidationSelection](rapidata/api_client/docs/ConditionalValidationSelection.md)
  - [Coordinate](rapidata/api_client/docs/Coordinate.md)
  - [CountClassificationMetadataFilterConfig](rapidata/api_client/docs/CountClassificationMetadataFilterConfig.md)
+ - [CountMetadata](rapidata/api_client/docs/CountMetadata.md)
  - [CountMetadataModel](rapidata/api_client/docs/CountMetadataModel.md)
  - [CountryUserFilterModel](rapidata/api_client/docs/CountryUserFilterModel.md)
  - [CreateBridgeTokenResult](rapidata/api_client/docs/CreateBridgeTokenResult.md)
@@ -276,6 +284,7 @@ Class | Method | HTTP request | Description
  - [GetPipelineByIdResult](rapidata/api_client/docs/GetPipelineByIdResult.md)
  - [GetPipelineByIdResultArtifactsValue](rapidata/api_client/docs/GetPipelineByIdResultArtifactsValue.md)
  - [GetPublicOrdersResult](rapidata/api_client/docs/GetPublicOrdersResult.md)
+ - [GetRapidResponsesResult](rapidata/api_client/docs/GetRapidResponsesResult.md)
  - [GetResponsesResult](rapidata/api_client/docs/GetResponsesResult.md)
  - [GetSimpleWorkflowResultsModel](rapidata/api_client/docs/GetSimpleWorkflowResultsModel.md)
  - [GetSimpleWorkflowResultsResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResult.md)
@@ -286,6 +295,7 @@ Class | Method | HTTP request | Description
  - [GetWorkflowProgressResult](rapidata/api_client/docs/GetWorkflowProgressResult.md)
  - [IWorkflowModelPagedResult](rapidata/api_client/docs/IWorkflowModelPagedResult.md)
  - [IdentityReadBridgeTokenGet202Response](rapidata/api_client/docs/IdentityReadBridgeTokenGet202Response.md)
+ - [ImageDimensionMetadata](rapidata/api_client/docs/ImageDimensionMetadata.md)
  - [ImageDimensionMetadataModel](rapidata/api_client/docs/ImageDimensionMetadataModel.md)
  - [ImportFromFileResult](rapidata/api_client/docs/ImportFromFileResult.md)
  - [ImportValidationSetFromFileResult](rapidata/api_client/docs/ImportValidationSetFromFileResult.md)
@@ -303,9 +313,11 @@ Class | Method | HTTP request | Description
  - [LocatePayload](rapidata/api_client/docs/LocatePayload.md)
  - [LocateRapidBlueprint](rapidata/api_client/docs/LocateRapidBlueprint.md)
  - [LocateResult](rapidata/api_client/docs/LocateResult.md)
+ - [LocationMetadata](rapidata/api_client/docs/LocationMetadata.md)
  - [LocationMetadataExistsFilterConfig](rapidata/api_client/docs/LocationMetadataExistsFilterConfig.md)
  - [LocationMetadataModel](rapidata/api_client/docs/LocationMetadataModel.md)
  - [LogicOperator](rapidata/api_client/docs/LogicOperator.md)
+ - [MetadataVisibilities](rapidata/api_client/docs/MetadataVisibilities.md)
  - [MultiAssetModel](rapidata/api_client/docs/MultiAssetModel.md)
  - [NaiveRefereeConfig](rapidata/api_client/docs/NaiveRefereeConfig.md)
  - [NaiveRefereeModel](rapidata/api_client/docs/NaiveRefereeModel.md)
@@ -325,6 +337,7 @@ Class | Method | HTTP request | Description
  - [OrderModel](rapidata/api_client/docs/OrderModel.md)
  - [OrderModelPagedResult](rapidata/api_client/docs/OrderModelPagedResult.md)
  - [OrderState](rapidata/api_client/docs/OrderState.md)
+ - [OriginalFilenameMetadata](rapidata/api_client/docs/OriginalFilenameMetadata.md)
  - [OriginalFilenameMetadataModel](rapidata/api_client/docs/OriginalFilenameMetadataModel.md)
  - [PageInfo](rapidata/api_client/docs/PageInfo.md)
  - [PipelineIdWorkflowPutRequest](rapidata/api_client/docs/PipelineIdWorkflowPutRequest.md)
@@ -337,6 +350,7 @@ Class | Method | HTTP request | Description
  - [PrivateTextMetadataInput](rapidata/api_client/docs/PrivateTextMetadataInput.md)
  - [ProbabilisticAttachCategoryRefereeConfig](rapidata/api_client/docs/ProbabilisticAttachCategoryRefereeConfig.md)
  - [ProblemDetails](rapidata/api_client/docs/ProblemDetails.md)
+ - [PromptMetadata](rapidata/api_client/docs/PromptMetadata.md)
  - [PromptMetadataInput](rapidata/api_client/docs/PromptMetadataInput.md)
  - [PromptMetadataModel](rapidata/api_client/docs/PromptMetadataModel.md)
  - [PublicOrderModel](rapidata/api_client/docs/PublicOrderModel.md)
@@ -376,12 +390,15 @@ Class | Method | HTTP request | Description
  - [SkipResult](rapidata/api_client/docs/SkipResult.md)
  - [SortCriterion](rapidata/api_client/docs/SortCriterion.md)
  - [SortDirection](rapidata/api_client/docs/SortDirection.md)
+ - [SourceUrlMetadata](rapidata/api_client/docs/SourceUrlMetadata.md)
  - [SourceUrlMetadataModel](rapidata/api_client/docs/SourceUrlMetadataModel.md)
  - [StaticSelection](rapidata/api_client/docs/StaticSelection.md)
  - [SubmitCocoModel](rapidata/api_client/docs/SubmitCocoModel.md)
  - [SubmitCocoResult](rapidata/api_client/docs/SubmitCocoResult.md)
  - [TextAssetModel](rapidata/api_client/docs/TextAssetModel.md)
+ - [TextMetadata](rapidata/api_client/docs/TextMetadata.md)
  - [TextMetadataModel](rapidata/api_client/docs/TextMetadataModel.md)
+ - [TranscriptionMetadata](rapidata/api_client/docs/TranscriptionMetadata.md)
  - [TranscriptionMetadataInput](rapidata/api_client/docs/TranscriptionMetadataInput.md)
  - [TranscriptionMetadataModel](rapidata/api_client/docs/TranscriptionMetadataModel.md)
  - [TranscriptionPayload](rapidata/api_client/docs/TranscriptionPayload.md)
@@ -394,6 +411,7 @@ Class | Method | HTTP request | Description
  - [UnlockOrderResult](rapidata/api_client/docs/UnlockOrderResult.md)
  - [UpdateAccessModel](rapidata/api_client/docs/UpdateAccessModel.md)
  - [UpdateCampaignModel](rapidata/api_client/docs/UpdateCampaignModel.md)
+ - [UpdateDimensionsModel](rapidata/api_client/docs/UpdateDimensionsModel.md)
  - [UpdateOrderModel](rapidata/api_client/docs/UpdateOrderModel.md)
  - [UpdateValidationRapidModel](rapidata/api_client/docs/UpdateValidationRapidModel.md)
  - [UpdateValidationRapidModelTruth](rapidata/api_client/docs/UpdateValidationRapidModelTruth.md)

rapidata/rapidata_client/demographic/demographic_manager.py

@@ -2,6 +2,8 @@ from rapidata.service.openapi_service import OpenAPIService
 from rapidata.rapidata_client.assets import MediaAsset
 from rapidata.api_client.models.create_demographic_rapid_model import CreateDemographicRapidModel
 from rapidata.api_client.models.classify_payload import ClassifyPayload
+import requests
+from requests.adapters import HTTPAdapter, Retry
 
 
 class DemographicManager:
@@ -23,5 +25,38 @@ class DemographicManager:
                 title=instruction
             )
         )
+        session = self._get_session()
+        media.session = session
+        
         self._openapi_service.rapid_api.rapid_create_demographic_rapid_post(model=model, file=[media.to_file()])
+
+    def _get_session(self, max_retries: int = 5, max_workers: int = 10) -> requests.Session:   
+        """Get a requests session with retry logic.
+
+
+        Args:
+            max_retries (int): The maximum number of retries.
+            max_workers (int): The maximum number of workers.
+
+        Returns:
+            requests.Session: A requests session with retry logic.
+        """
+        session = requests.Session()
+        retries = Retry(
+            total=max_retries,
+            backoff_factor=1,
+            status_forcelist=[500, 502, 503, 504],
+            allowed_methods=["GET"],
+            respect_retry_after_header=True
+        )
+
+        adapter = HTTPAdapter(
+            pool_connections=max_workers * 2,
+            pool_maxsize=max_workers * 4,
+            max_retries=retries
+        )
+        session.mount('http://', adapter)
+        session.mount('https://', adapter)
+
+        return session
         

rapidata/rapidata_client/filter/rapidata_filters.py

@@ -14,17 +14,25 @@ class RapidataFilters:
 
     Note that adding multiple filters to the same order will result in a logical AND operation between the filters.
 
-    Warning: this might significantly slow down the number of responses you receive.
+    Warning: 
+        This might significantly slow down the number of responses you receive.
     
     Attributes:
         user_score (UserScoreFilter): The UserScoreFilter instance.
         age (AgeFilter): The AgeFilter instance.
         campaign (CampaignFilter): The CampaignFilter instance.
         country (CountryFilter): The CountryFilter instance.
-        campaign (CampaignFilter): The CampaignFilter instance
         gender (GenderFilter): The GenderFilter instance.
         language (LanguageFilter): The LanguageFilter instance.
         custom_filter (CustomFilter): The CustomFilter instance.
+
+    Example:
+        ```python
+        from rapidata import CountryFilter, LanguageFilter
+        filters=[CountryFilter(["US", "DE"]), LanguageFilter(["en"])]
+        ```
+
+        This ensures the order is only shown to users in the US and Germany whose phones are set to English.
     """
     user_score = UserScoreFilter
     age = AgeFilter 

rapidata/rapidata_client/order/_rapidata_order_builder.py

@@ -182,6 +182,8 @@ class RapidataOrderBuilder:
             raise ValueError(
                 "Media paths must all be of the same type: MediaAsset, TextAsset, or MultiAsset."
             )
+        
+        self.__openapi_service.order_api.order_order_id_preview_post(self.order_id)
 
         return order
 
@@ -235,11 +237,11 @@ class RapidataOrderBuilder:
         if not isinstance(asset, list):
             raise TypeError("Media paths must be provided as a list of paths.")
 
-        # for a in asset:
-        #     if not isinstance(a, (MediaAsset, TextAsset, MultiAsset)):
-        #         raise TypeError(
-        #             "Media paths must be of type MediaAsset, TextAsset, or MultiAsset."
-        #         )
+        for a in asset:
+            if not isinstance(a, (MediaAsset, TextAsset, MultiAsset)):
+                raise TypeError(
+                    "Media paths must be of type MediaAsset, TextAsset, or MultiAsset."
+                )
 
         if metadata:
             for data in metadata:

rapidata/rapidata_client/order/rapidata_order.py

@@ -70,6 +70,7 @@ class RapidataOrder:
 
         States:
             Created: The order has been created but not started yet.\n
+            Preview: The order has been set up and ready but not collecting responses yet.\n
             Submitted: The order has been submitted and is being reviewed.\n
             ManualReview: The order is in manual review - something went wrong with the automatic approval.\n
             Processing: The order is actively being processed.\n
@@ -164,12 +165,9 @@ class RapidataOrder:
         
         Raises:
             Exception: If the order is not in processing state.
-        """
-        if self.get_status() != OrderState.PROCESSING:
-            raise Exception("Order is not processing. Preview unavailable.")
-        
+        """        
         campaign_id = self.__get_campaign_id()
-        auth_url = f"https://rapids.{self.__openapi_service.enviroment}/preview/campaign?id={campaign_id}"
+        auth_url = f"https://app.{self.__openapi_service.enviroment}/order/detail/{self.order_id}/preview?campaignId={campaign_id}"
         could_open_browser = webbrowser.open(auth_url)
         if not could_open_browser:
             encoded_url = urllib.parse.quote(auth_url, safe="%/:=&?~#+!$,;'@()*[]")

rapidata/rapidata_client/order/rapidata_order_manager.py

@@ -247,17 +247,16 @@ class RapidataOrderManager:
                              name: str,
                              instruction: str,
                              datapoints: list[str],
-                             responses_per_comparison: int,
                              total_comparison_budget: int,
+                             responses_per_comparison: int = 5,
+                             data_type: str = RapidataDataTypes.MEDIA,
                              random_comparisons_ratio: float = 0.5,
-                             elo_start: int = 1200,
-                             elo_k_factor: int = 40,
-                             elo_scaling_factor: int = 400,
-                             contexts: Optional[list[str]] = None,
+                             context: Optional[str] = None,
                              validation_set_id: Optional[str] = None,
                              filters: Sequence[RapidataFilter] = [],
                              settings: Sequence[RapidataSetting] = [],
-                             selections: Optional[Sequence[RapidataSelection]] = None) -> RapidataOrder:
+                             selections: Optional[Sequence[RapidataSelection]] = None
+                             ) -> RapidataOrder:
         """
         Create a ranking order.
 
@@ -266,15 +265,13 @@ class RapidataOrderManager:
             instruction (str): The question asked from People when They see two datapoints.
             datapoints (list[str]): A list of datapoints that will participate in the ranking.
             total_comparison_budget (int): The total number of (pairwise-)comparisons that can be made.
-            random_comparisons_ratio (float, optional): The fraction of random comparisons in the ranking process.
-            The rest will focus on pairing similarly ranked datapoints.
-            elo_start (int, optional): The initial ELO rating assigned to each datapoint.
-            elo_k_factor (int, optional): The K-factor used for ELO updates.
-            elo_scaling_factor (int, optional): The scaling factor used in the ELO calculation.
             responses_per_comparison (int, optional): The number of responses collected per comparison.
-            contexts (list[str], optional): The list of contexts for the comparison. Defaults to None.\n
-                If provided has to be the same length as datapoints and will be shown in addition to the instruction.
-                (Therefore will be different for each datapoint) Will be match up with the datapoints using the list index.
+            data_type (str, optional): The data type of the datapoints. Defaults to RapidataDataTypes.MEDIA. \n
+                Other option: RapidataDataTypes.TEXT ("text").
+            random_comparisons_ratio (float, optional): The fraction of random comparisons in the ranking process.
+                The rest will focus on pairing similarly ranked datapoints. Defaults to 0.5 and can be left untouched.
+            context (str, optional): The context for all the comparison. Defaults to None.\n
+                If provided will be shown in addition to the instruction for all the matchups.
             validation_set_id (str, optional): The ID of the validation set. Defaults to None.\n
                 If provided, one validation task will be shown infront of the datapoints that will be labeled.
             filters (Sequence[RapidataFilter], optional): The list of filters for the order. Defaults to []. Decides who the tasks should be shown to.
@@ -282,20 +279,23 @@ class RapidataOrderManager:
             selections (Sequence[RapidataSelection], optional): The list of selections for the order. Defaults to None. Decides in what order the tasks should be shown.
         """
 
-        assets = [MediaAsset(path=path) for path in datapoints]
+        if data_type == RapidataDataTypes.MEDIA:
+            assets = [MediaAsset(path=path) for path in datapoints]
+        elif data_type == RapidataDataTypes.TEXT:
+            assets = [TextAsset(text=text) for text in datapoints]
+        else:
+            raise ValueError(f"Unsupported data type: {data_type}, must be one of {RapidataDataTypes._possible_values()}")
+
         return self._create_general_order(
             name=name,
             workflow=RankingWorkflow(
                 criteria=instruction,
-                elo_start=elo_start,
-                elo_k_factor=elo_k_factor,
-                elo_scaling_factor=elo_scaling_factor,
                 total_comparison_budget=total_comparison_budget,
-                random_comparisons_ratio=random_comparisons_ratio
+                random_comparisons_ratio=random_comparisons_ratio,
+                context=context
             ),
             assets=assets,
             responses_per_datapoint=responses_per_comparison,
-            contexts=contexts,
             validation_set_id=validation_set_id,
             filters=filters,
             selections=selections,

rapidata/rapidata_client/order/rapidata_results.py

@@ -10,7 +10,8 @@ class RapidataResults(dict):
     """
     def to_pandas(self, split_details: bool = False) -> pd.DataFrame:
         """
-        This method is currently under development.
+        Warning:
+            This method is currently under development. The structure of the results may change in the future.
 
         Converts the results to a pandas DataFrame.
         

rapidata/rapidata_client/rapidata_client.py

@@ -42,3 +42,7 @@ class RapidataClient:
         self.validation = ValidationSetManager(openapi_service=self._openapi_service)
 
         self._demographic = DemographicManager(openapi_service=self._openapi_service)
+
+    def reset_credentials(self):
+        """Reset the credentials saved in the configuration file for the current enviroment."""
+        self._openapi_service.reset_credentials()

rapidata/rapidata_client/selection/rapidata_selections.py

@@ -11,21 +11,22 @@ class RapidataSelections:
     Selections are used to define what type of tasks and in what order they are shown to the user. 
     All Tasks are called a "Session". A session can contain multiple tasks of different types.
 
-    Example:
-    ```python
-        selections=[ValidationSelection("your-validation-set-id", 1), 
-                    LabelingSelection(2)]
-    ```
-
-    The above example will create a session with a validation task followed by two labeling tasks.
-
     Attributes:
         labeling (LabelingSelection): The LabelingSelection instance.
         validation (ValidationSelection): The ValidationSelection instance.
         conditional_validation (ConditionalValidationSelection): The ConditionalValidationSelection instance.
         demographic (DemographicSelection): The DemographicSelection instance.
-        capped (CappedSelection): The CappedSelection instance."""
+        capped (CappedSelection): The CappedSelection instance.
     
+    Example:
+        ```python
+        from rapidata import LabelingSelection, ValidationSelection
+        selections=[ValidationSelection("your-validation-set-id", 1), 
+                    LabelingSelection(2)]
+        ```
+
+        This will require annotators to complete one validation task followed by two labeling tasks.
+    """
     labeling = LabelingSelection
     validation = ValidationSelection
     conditional_validation = ConditionalValidationSelection

rapidata/rapidata_client/settings/no_shuffle.py

@@ -2,9 +2,9 @@ from rapidata.rapidata_client.settings._rapidata_setting import RapidataSetting
 
 class NoShuffle(RapidataSetting):
     """
-    Only for classify tasks. If true, the order of the categories will be the same.
+    Only for classification and compare tasks. If true, the order of the categories / images will not be shuffled and presented in the same order as specified.
 
-    If this is not added to the order, it shuffling will be active.
+    If this is not added to the order, the shuffling will be active.
     
     Args:
         value (bool, optional): Whether to disable shuffling. Defaults to True for function call.

rapidata/rapidata_client/settings/rapidata_settings.py

@@ -20,6 +20,14 @@ class RapidataSettings:
         no_shuffle (NoShuffle): The NoShuffle instance.
         play_video_until_the_end (PlayVideoUntilTheEnd): The PlayVideoUntilTheEnd instance.
         custom_setting (CustomSetting): The CustomSetting instance.
+
+    Example:
+        ```python
+        from rapidata import FreeTextMinimumCharacters
+        settings=[FreeTextMinimumCharacters(10)]
+        ```
+
+        This can be used in a free text order to set the minimum number of characters required to submit the task. 
     """
 
     alert_on_fast_response = AlertOnFastResponse

rapidata/rapidata_client/workflow/_ranking_workflow.py

@@ -1,6 +1,11 @@
 from rapidata.api_client import CompareWorkflowModelPairMakerConfig, OnlinePairMakerConfigModel, EloConfigModel
 from rapidata.api_client.models.compare_workflow_model import CompareWorkflowModel
 from rapidata.rapidata_client.workflow._base_workflow import Workflow
+from rapidata.rapidata_client.metadata import PromptMetadata
+from rapidata.api_client.models.create_datapoint_from_urls_model import (
+    CreateDatapointFromUrlsModelMetadataInner,
+)
+
 
 class RankingWorkflow(Workflow):
 
@@ -9,12 +14,17 @@ class RankingWorkflow(Workflow):
                  criteria: str,
                  total_comparison_budget: int,
                  random_comparisons_ratio,
-                 elo_start: int,
-                 elo_k_factor: int,
-                 elo_scaling_factor: int,
+                 elo_start: int = 1200,
+                 elo_k_factor: int = 40,
+                 elo_scaling_factor: int = 400,
+                 context: str | None = None,
                  ):
         super().__init__(type="CompareWorkflowConfig")
 
+        self.context = [CreateDatapointFromUrlsModelMetadataInner(
+            PromptMetadata(context).to_model())
+            ] if context else None
+
         self.criteria = criteria
         self.pair_maker_config = CompareWorkflowModelPairMakerConfig(
             OnlinePairMakerConfigModel(
@@ -36,5 +46,6 @@ class RankingWorkflow(Workflow):
             _t="CompareWorkflow",
             criteria=self.criteria,
             eloConfig=self.elo_config,
-            pairMakerConfig=self.pair_maker_config
+            pairMakerConfig=self.pair_maker_config,
+            metadata=self.context,
         )

rapidata/service/credential_manager.py

@@ -133,6 +133,13 @@ class CredentialManager:
                 return credential
 
         return self._create_new_credentials()
+    
+    def reset_credentials(self) -> None:
+        """Reset the stored credentials for current enviroment."""
+        credentials = self._read_credentials()
+        if self.endpoint in credentials:
+            del credentials[self.endpoint]
+            self._write_credentials(credentials)
 
     def _get_bridge_tokens(self) -> Optional[BridgeToken]:
         """Get bridge tokens from the identity endpoint."""

rapidata/service/openapi_service.py

@@ -8,6 +8,7 @@ from rapidata.api_client.api.workflow_api import WorkflowApi
 from rapidata.api_client.api_client import ApiClient
 from rapidata.api_client.configuration import Configuration
 from rapidata.service.token_manager import TokenManager, TokenInfo
+from rapidata.service.credential_manager import CredentialManager
 
 from importlib.metadata import version, PackageNotFoundError
 
@@ -23,11 +24,11 @@ class OpenAPIService:
     ):
         self.enviroment = enviroment
         endpoint = f"https://api.{enviroment}"
-        token_url = f"https://auth.{enviroment}"
+        self._token_url = f"https://auth.{enviroment}"
         token_manager = TokenManager(
             client_id=client_id,
             client_secret=client_secret,
-            endpoint=token_url,
+            endpoint=self._token_url,
             oauth_scope=oauth_scope,
             cert_path=cert_path,
         )
@@ -42,14 +43,13 @@ class OpenAPIService:
             f"Bearer {token_manager.fetch_token().access_token}"
         )
 
-        self._client_id = client_id
-        self._client_secret = client_secret
-        self._oauth_scope = oauth_scope
-        self._token_url = f"{token_url}/connect/token"
         self._cert_path = cert_path
 
         token_manager.start_token_refresh(token_callback=self._set_token)
 
+    def reset_credentials(self):
+        CredentialManager(endpoint=self._token_url, cert_path=self._cert_path).reset_credentials()
+
     @property
     def order_api(self) -> OrderApi:
         return OrderApi(self.api_client)

{rapidata-2.14.0.dist-info → rapidata-2.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rapidata
-Version: 2.14.0
+Version: 2.15.0
 Summary: Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way.
 License: Apache-2.0
 Author: Rapidata AG