rapidata 2.5.0__py3-none-any.whl → 2.7.0__py3-none-any.whl

rapidata/api_client/models/update_validation_rapid_model.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.update_validation_rapid_model_truth import UpdateValidationRapidModelTruth
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdateValidationRapidModel(BaseModel):
+    """
+    The model for updating a validation rapid.
+    """ # noqa: E501
+    truth: UpdateValidationRapidModelTruth
+    explanation: Optional[StrictStr]
+    prompt: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["truth", "explanation", "prompt"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of UpdateValidationRapidModel from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of truth
+        if self.truth:
+            _dict['truth'] = self.truth.to_dict()
+        # set to None if explanation (nullable) is None
+        # and model_fields_set contains the field
+        if self.explanation is None and "explanation" in self.model_fields_set:
+            _dict['explanation'] = None
+
+        # set to None if prompt (nullable) is None
+        # and model_fields_set contains the field
+        if self.prompt is None and "prompt" in self.model_fields_set:
+            _dict['prompt'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateValidationRapidModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "truth": UpdateValidationRapidModelTruth.from_dict(obj["truth"]) if obj.get("truth") is not None else None,
+            "explanation": obj.get("explanation"),
+            "prompt": obj.get("prompt")
+        })
+        return _obj
+
+

rapidata/api_client/models/update_validation_rapid_model_truth.py

@@ -0,0 +1,252 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from rapidata.api_client.models.attach_category_truth import AttachCategoryTruth
+from rapidata.api_client.models.bounding_box_truth import BoundingBoxTruth
+from rapidata.api_client.models.compare_truth import CompareTruth
+from rapidata.api_client.models.empty_validation_truth import EmptyValidationTruth
+from rapidata.api_client.models.line_truth import LineTruth
+from rapidata.api_client.models.locate_box_truth import LocateBoxTruth
+from rapidata.api_client.models.named_entity_truth import NamedEntityTruth
+from rapidata.api_client.models.polygon_truth import PolygonTruth
+from rapidata.api_client.models.scrub_truth import ScrubTruth
+from rapidata.api_client.models.transcription_truth import TranscriptionTruth
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+UPDATEVALIDATIONRAPIDMODELTRUTH_ONE_OF_SCHEMAS = ["AttachCategoryTruth", "BoundingBoxTruth", "CompareTruth", "EmptyValidationTruth", "LineTruth", "LocateBoxTruth", "NamedEntityTruth", "PolygonTruth", "ScrubTruth", "TranscriptionTruth"]
+
+class UpdateValidationRapidModelTruth(BaseModel):
+    """
+    
+    """
+    # data type: TranscriptionTruth
+    oneof_schema_1_validator: Optional[TranscriptionTruth] = None
+    # data type: ScrubTruth
+    oneof_schema_2_validator: Optional[ScrubTruth] = None
+    # data type: PolygonTruth
+    oneof_schema_3_validator: Optional[PolygonTruth] = None
+    # data type: NamedEntityTruth
+    oneof_schema_4_validator: Optional[NamedEntityTruth] = None
+    # data type: LocateBoxTruth
+    oneof_schema_5_validator: Optional[LocateBoxTruth] = None
+    # data type: LineTruth
+    oneof_schema_6_validator: Optional[LineTruth] = None
+    # data type: EmptyValidationTruth
+    oneof_schema_7_validator: Optional[EmptyValidationTruth] = None
+    # data type: CompareTruth
+    oneof_schema_8_validator: Optional[CompareTruth] = None
+    # data type: AttachCategoryTruth
+    oneof_schema_9_validator: Optional[AttachCategoryTruth] = None
+    # data type: BoundingBoxTruth
+    oneof_schema_10_validator: Optional[BoundingBoxTruth] = None
+    actual_instance: Optional[Union[AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, TranscriptionTruth]] = None
+    one_of_schemas: Set[str] = { "AttachCategoryTruth", "BoundingBoxTruth", "CompareTruth", "EmptyValidationTruth", "LineTruth", "LocateBoxTruth", "NamedEntityTruth", "PolygonTruth", "ScrubTruth", "TranscriptionTruth" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    discriminator_value_class_map: Dict[str, str] = {
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = UpdateValidationRapidModelTruth.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: TranscriptionTruth
+        if not isinstance(v, TranscriptionTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TranscriptionTruth`")
+        else:
+            match += 1
+        # validate data type: ScrubTruth
+        if not isinstance(v, ScrubTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ScrubTruth`")
+        else:
+            match += 1
+        # validate data type: PolygonTruth
+        if not isinstance(v, PolygonTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PolygonTruth`")
+        else:
+            match += 1
+        # validate data type: NamedEntityTruth
+        if not isinstance(v, NamedEntityTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NamedEntityTruth`")
+        else:
+            match += 1
+        # validate data type: LocateBoxTruth
+        if not isinstance(v, LocateBoxTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `LocateBoxTruth`")
+        else:
+            match += 1
+        # validate data type: LineTruth
+        if not isinstance(v, LineTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `LineTruth`")
+        else:
+            match += 1
+        # validate data type: EmptyValidationTruth
+        if not isinstance(v, EmptyValidationTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `EmptyValidationTruth`")
+        else:
+            match += 1
+        # validate data type: CompareTruth
+        if not isinstance(v, CompareTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CompareTruth`")
+        else:
+            match += 1
+        # validate data type: AttachCategoryTruth
+        if not isinstance(v, AttachCategoryTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `AttachCategoryTruth`")
+        else:
+            match += 1
+        # validate data type: BoundingBoxTruth
+        if not isinstance(v, BoundingBoxTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `BoundingBoxTruth`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in UpdateValidationRapidModelTruth with oneOf schemas: AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, TranscriptionTruth. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in UpdateValidationRapidModelTruth with oneOf schemas: AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, TranscriptionTruth. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into TranscriptionTruth
+        try:
+            instance.actual_instance = TranscriptionTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ScrubTruth
+        try:
+            instance.actual_instance = ScrubTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into PolygonTruth
+        try:
+            instance.actual_instance = PolygonTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into NamedEntityTruth
+        try:
+            instance.actual_instance = NamedEntityTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into LocateBoxTruth
+        try:
+            instance.actual_instance = LocateBoxTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into LineTruth
+        try:
+            instance.actual_instance = LineTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into EmptyValidationTruth
+        try:
+            instance.actual_instance = EmptyValidationTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CompareTruth
+        try:
+            instance.actual_instance = CompareTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into AttachCategoryTruth
+        try:
+            instance.actual_instance = AttachCategoryTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into BoundingBoxTruth
+        try:
+            instance.actual_instance = BoundingBoxTruth.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into UpdateValidationRapidModelTruth with oneOf schemas: AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, TranscriptionTruth. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into UpdateValidationRapidModelTruth with oneOf schemas: AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, TranscriptionTruth. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, TranscriptionTruth]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

rapidata/api_client_README.md

@@ -81,7 +81,7 @@ Class | Method | HTTP request | Description
 *ClientApi* | [**client_set_referrer_post**](rapidata/api_client/docs/ClientApi.md#client_set_referrer_post) | **POST** /Client/SetReferrer | Sets the referrer for the current customer.
 *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.
 *CocoApi* | [**coco_upload_post**](rapidata/api_client/docs/CocoApi.md#coco_upload_post) | **POST** /Coco/Upload | Uploads a CoCo set to the system.
-*CompareWorkflowApi* | [**compare_workflow_get_result_overview_get**](rapidata/api_client/docs/CompareWorkflowApi.md#compare_workflow_get_result_overview_get) | **GET** /CompareWorkflow/GetResultOverview | Get the result overview for a compare workflow.
+*CompareWorkflowApi* | [**workflow_compare_id_results_get**](rapidata/api_client/docs/CompareWorkflowApi.md#workflow_compare_id_results_get) | **GET** /workflow/compare/{id}/results | Get the result overview for a compare workflow.
 *DatapointApi* | [**datapoint_delete_delete**](rapidata/api_client/docs/DatapointApi.md#datapoint_delete_delete) | **DELETE** /Datapoint/Delete | Delete a datapoint.
 *DatapointApi* | [**datapoint_get_all_datapoints_by_dataset_id_get**](rapidata/api_client/docs/DatapointApi.md#datapoint_get_all_datapoints_by_dataset_id_get) | **GET** /Datapoint/GetAllDatapointsByDatasetId | Get all datapoints of a dataset.
 *DatapointApi* | [**datapoint_get_by_id_get**](rapidata/api_client/docs/DatapointApi.md#datapoint_get_by_id_get) | **GET** /Datapoint/GetById | Get a datapoint by its id.
@@ -124,14 +124,17 @@ Class | Method | HTTP request | Description
 *PipelineApi* | [**pipeline_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_get) | **GET** /Pipeline/{id} | Gets a pipeline by its id.
 *PipelineApi* | [**pipeline_id_workflow_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_artifact_id_put) | **PUT** /pipeline/{id}/workflow/{artifact-id} | Updates the workflow configuration for a pipeline.
 *PipelineApi* | [**pipeline_id_workflow_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_put) | **PUT** /pipeline/{id}/workflow | Updates the workflow configuration for a pipeline.
+*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.
+*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. If it's still processing the request will return 202 Accepted.
 *RapidApi* | [**rapid_add_user_guess_post**](rapidata/api_client/docs/RapidApi.md#rapid_add_user_guess_post) | **POST** /Rapid/AddUserGuess | Submits a user guess for a Rapid.
 *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_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.
 *RapidApi* | [**rapid_validate_current_rapid_bag_get**](rapidata/api_client/docs/RapidApi.md#rapid_validate_current_rapid_bag_get) | **GET** /Rapid/ValidateCurrentRapidBag | Validates that the rapids associated with the current user are active.
+*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.
 *RapidataIdentityAPIApi* | [**root_get**](rapidata/api_client/docs/RapidataIdentityAPIApi.md#root_get) | **GET** / | 
-*SimpleWorkflowApi* | [**simple_workflow_get_result_overview_get**](rapidata/api_client/docs/SimpleWorkflowApi.md#simple_workflow_get_result_overview_get) | **GET** /SimpleWorkflow/GetResultOverview | Get the result overview for a simple workflow.
+*SimpleWorkflowApi* | [**workflow_simple_id_results_get**](rapidata/api_client/docs/SimpleWorkflowApi.md#workflow_simple_id_results_get) | **GET** /workflow/simple/{id}/results | Get the result overview for a simple workflow.
 *UserInfoApi* | [**connect_userinfo_get**](rapidata/api_client/docs/UserInfoApi.md#connect_userinfo_get) | **GET** /connect/userinfo | Retrieves information about the authenticated user.
 *ValidationApi* | [**validation_add_validation_rapid_post**](rapidata/api_client/docs/ValidationApi.md#validation_add_validation_rapid_post) | **POST** /Validation/AddValidationRapid | Adds a new validation rapid to the specified validation set.
 *ValidationApi* | [**validation_add_validation_text_rapid_post**](rapidata/api_client/docs/ValidationApi.md#validation_add_validation_text_rapid_post) | **POST** /Validation/AddValidationTextRapid | Adds a new validation rapid to the specified validation set.
@@ -144,12 +147,13 @@ Class | Method | HTTP request | Description
 *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_get_result_overview_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_get_result_overview_get) | **GET** /Workflow/GetResultOverview | Get the result overview for a 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.
 
 
 ## Documentation For Models
 
+ - [AbTestSelection](rapidata/api_client/docs/AbTestSelection.md)
+ - [AbTestSelectionAInner](rapidata/api_client/docs/AbTestSelectionAInner.md)
  - [AddCampaignArtifactResult](rapidata/api_client/docs/AddCampaignArtifactResult.md)
  - [AddCampaignModel](rapidata/api_client/docs/AddCampaignModel.md)
  - [AddValidationRapidModel](rapidata/api_client/docs/AddValidationRapidModel.md)
@@ -175,7 +179,6 @@ 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)
- - [CappedSelectionSelectionsInner](rapidata/api_client/docs/CappedSelectionSelectionsInner.md)
  - [ClassificationMetadata](rapidata/api_client/docs/ClassificationMetadata.md)
  - [ClassificationMetadataFilterConfig](rapidata/api_client/docs/ClassificationMetadataFilterConfig.md)
  - [ClassificationMetadataModel](rapidata/api_client/docs/ClassificationMetadataModel.md)
@@ -185,6 +188,7 @@ Class | Method | HTTP request | Description
  - [CloneDatasetModel](rapidata/api_client/docs/CloneDatasetModel.md)
  - [CloneOrderModel](rapidata/api_client/docs/CloneOrderModel.md)
  - [CloneOrderResult](rapidata/api_client/docs/CloneOrderResult.md)
+ - [CompareMatchStatus](rapidata/api_client/docs/CompareMatchStatus.md)
  - [ComparePayload](rapidata/api_client/docs/ComparePayload.md)
  - [CompareRapidBlueprint](rapidata/api_client/docs/CompareRapidBlueprint.md)
  - [CompareResult](rapidata/api_client/docs/CompareResult.md)
@@ -193,14 +197,11 @@ Class | Method | HTTP request | Description
  - [CompareWorkflowConfigModel](rapidata/api_client/docs/CompareWorkflowConfigModel.md)
  - [CompareWorkflowConfigModelPairMakerConfig](rapidata/api_client/docs/CompareWorkflowConfigModelPairMakerConfig.md)
  - [CompareWorkflowConfigPairMakerConfig](rapidata/api_client/docs/CompareWorkflowConfigPairMakerConfig.md)
- - [CompareWorkflowGetResultOverviewGet200Response](rapidata/api_client/docs/CompareWorkflowGetResultOverviewGet200Response.md)
  - [CompareWorkflowModel](rapidata/api_client/docs/CompareWorkflowModel.md)
  - [CompareWorkflowModel1](rapidata/api_client/docs/CompareWorkflowModel1.md)
  - [CompareWorkflowModel1PairMakerInformation](rapidata/api_client/docs/CompareWorkflowModel1PairMakerInformation.md)
  - [CompareWorkflowModel1Referee](rapidata/api_client/docs/CompareWorkflowModel1Referee.md)
  - [CompareWorkflowModelPairMakerConfig](rapidata/api_client/docs/CompareWorkflowModelPairMakerConfig.md)
- - [CompletedRapidModel](rapidata/api_client/docs/CompletedRapidModel.md)
- - [CompletedRapidModelAsset](rapidata/api_client/docs/CompletedRapidModelAsset.md)
  - [ConditionalValidationSelection](rapidata/api_client/docs/ConditionalValidationSelection.md)
  - [Coordinate](rapidata/api_client/docs/Coordinate.md)
  - [CountClassificationMetadataFilterConfig](rapidata/api_client/docs/CountClassificationMetadataFilterConfig.md)
@@ -261,28 +262,29 @@ Class | Method | HTTP request | Description
  - [Gender](rapidata/api_client/docs/Gender.md)
  - [GenderUserFilterModel](rapidata/api_client/docs/GenderUserFilterModel.md)
  - [GetAvailableValidationSetsResult](rapidata/api_client/docs/GetAvailableValidationSetsResult.md)
- - [GetClassifyWorkflowResultOverviewResult](rapidata/api_client/docs/GetClassifyWorkflowResultOverviewResult.md)
- - [GetCompareWorkflowResultOverviewResult](rapidata/api_client/docs/GetCompareWorkflowResultOverviewResult.md)
- - [GetCompareWorkflowResultOverviewSmallResult](rapidata/api_client/docs/GetCompareWorkflowResultOverviewSmallResult.md)
+ - [GetCompareWorkflowResultsModel](rapidata/api_client/docs/GetCompareWorkflowResultsModel.md)
+ - [GetCompareWorkflowResultsResult](rapidata/api_client/docs/GetCompareWorkflowResultsResult.md)
+ - [GetCompareWorkflowResultsResultAsset](rapidata/api_client/docs/GetCompareWorkflowResultsResultAsset.md)
+ - [GetCompareWorkflowResultsResultPagedResult](rapidata/api_client/docs/GetCompareWorkflowResultsResultPagedResult.md)
  - [GetDatapointsByDatasetIdResult](rapidata/api_client/docs/GetDatapointsByDatasetIdResult.md)
  - [GetDatasetByIdResult](rapidata/api_client/docs/GetDatasetByIdResult.md)
  - [GetOrderByIdResult](rapidata/api_client/docs/GetOrderByIdResult.md)
  - [GetPipelineByIdResult](rapidata/api_client/docs/GetPipelineByIdResult.md)
  - [GetPipelineByIdResultArtifactsValue](rapidata/api_client/docs/GetPipelineByIdResultArtifactsValue.md)
  - [GetPublicOrdersResult](rapidata/api_client/docs/GetPublicOrdersResult.md)
- - [GetSimpleWorkflowResultOverviewResult](rapidata/api_client/docs/GetSimpleWorkflowResultOverviewResult.md)
+ - [GetSimpleWorkflowResultsModel](rapidata/api_client/docs/GetSimpleWorkflowResultsModel.md)
+ - [GetSimpleWorkflowResultsResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResult.md)
+ - [GetSimpleWorkflowResultsResultPagedResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResultPagedResult.md)
  - [GetValidationSetByIdResult](rapidata/api_client/docs/GetValidationSetByIdResult.md)
  - [GetWorkflowByIdResult](rapidata/api_client/docs/GetWorkflowByIdResult.md)
  - [GetWorkflowByIdResultWorkflow](rapidata/api_client/docs/GetWorkflowByIdResultWorkflow.md)
  - [GetWorkflowProgressResult](rapidata/api_client/docs/GetWorkflowProgressResult.md)
- - [GetWorkflowResultOverviewResult](rapidata/api_client/docs/GetWorkflowResultOverviewResult.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)
- - [InProgressRapidModel](rapidata/api_client/docs/InProgressRapidModel.md)
  - [LabelingSelection](rapidata/api_client/docs/LabelingSelection.md)
  - [LanguageUserFilterModel](rapidata/api_client/docs/LanguageUserFilterModel.md)
  - [Line](rapidata/api_client/docs/Line.md)
@@ -316,7 +318,6 @@ Class | Method | HTTP request | Description
  - [NeverEndingRefereeConfig](rapidata/api_client/docs/NeverEndingRefereeConfig.md)
  - [NewsletterModel](rapidata/api_client/docs/NewsletterModel.md)
  - [NotAvailableYetResult](rapidata/api_client/docs/NotAvailableYetResult.md)
- - [NotStartedRapidModel](rapidata/api_client/docs/NotStartedRapidModel.md)
  - [NullAsset](rapidata/api_client/docs/NullAsset.md)
  - [NullAssetModel](rapidata/api_client/docs/NullAssetModel.md)
  - [NullAssetModel1](rapidata/api_client/docs/NullAssetModel1.md)
@@ -338,6 +339,8 @@ Class | Method | HTTP request | Description
  - [PreArrangedPairMakerConfig](rapidata/api_client/docs/PreArrangedPairMakerConfig.md)
  - [PreArrangedPairMakerConfigModel](rapidata/api_client/docs/PreArrangedPairMakerConfigModel.md)
  - [PreArrangedPairMakerInformation](rapidata/api_client/docs/PreArrangedPairMakerInformation.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)
  - [ProblemDetails](rapidata/api_client/docs/ProblemDetails.md)
@@ -355,13 +358,13 @@ Class | Method | HTTP request | Description
  - [QueryValidationRapidsResultTruth](rapidata/api_client/docs/QueryValidationRapidsResultTruth.md)
  - [QueryValidationSetModel](rapidata/api_client/docs/QueryValidationSetModel.md)
  - [QueryWorkflowsModel](rapidata/api_client/docs/QueryWorkflowsModel.md)
- - [RankedDatapointModel](rapidata/api_client/docs/RankedDatapointModel.md)
- - [RapidAnswer](rapidata/api_client/docs/RapidAnswer.md)
- - [RapidAnswerResult](rapidata/api_client/docs/RapidAnswerResult.md)
  - [RapidIssue](rapidata/api_client/docs/RapidIssue.md)
+ - [RapidResponse](rapidata/api_client/docs/RapidResponse.md)
+ - [RapidResponseResult](rapidata/api_client/docs/RapidResponseResult.md)
  - [RapidResultModel](rapidata/api_client/docs/RapidResultModel.md)
  - [RapidResultModelResult](rapidata/api_client/docs/RapidResultModelResult.md)
  - [RapidSkippedModel](rapidata/api_client/docs/RapidSkippedModel.md)
+ - [RapidState](rapidata/api_client/docs/RapidState.md)
  - [ReadBridgeTokenKeysResult](rapidata/api_client/docs/ReadBridgeTokenKeysResult.md)
  - [RegisterTemporaryCustomerModel](rapidata/api_client/docs/RegisterTemporaryCustomerModel.md)
  - [RegisterTemporaryCustomerResult](rapidata/api_client/docs/RegisterTemporaryCustomerResult.md)
@@ -377,7 +380,6 @@ Class | Method | HTTP request | Description
  - [SimpleWorkflowConfig](rapidata/api_client/docs/SimpleWorkflowConfig.md)
  - [SimpleWorkflowConfigModel](rapidata/api_client/docs/SimpleWorkflowConfigModel.md)
  - [SimpleWorkflowConfigModelBlueprint](rapidata/api_client/docs/SimpleWorkflowConfigModelBlueprint.md)
- - [SimpleWorkflowGetResultOverviewGet200Response](rapidata/api_client/docs/SimpleWorkflowGetResultOverviewGet200Response.md)
  - [SimpleWorkflowModel](rapidata/api_client/docs/SimpleWorkflowModel.md)
  - [SimpleWorkflowModel1](rapidata/api_client/docs/SimpleWorkflowModel1.md)
  - [SimpleWorkflowModelBlueprint](rapidata/api_client/docs/SimpleWorkflowModelBlueprint.md)
@@ -407,6 +409,8 @@ Class | Method | HTTP request | Description
  - [UpdateAccessModel](rapidata/api_client/docs/UpdateAccessModel.md)
  - [UpdateCampaignModel](rapidata/api_client/docs/UpdateCampaignModel.md)
  - [UpdateOrderModel](rapidata/api_client/docs/UpdateOrderModel.md)
+ - [UpdateValidationRapidModel](rapidata/api_client/docs/UpdateValidationRapidModel.md)
+ - [UpdateValidationRapidModelTruth](rapidata/api_client/docs/UpdateValidationRapidModelTruth.md)
  - [UploadCocoResult](rapidata/api_client/docs/UploadCocoResult.md)
  - [UploadDatapointsResult](rapidata/api_client/docs/UploadDatapointsResult.md)
  - [UploadFilesFromS3BucketModel](rapidata/api_client/docs/UploadFilesFromS3BucketModel.md)

rapidata/rapidata_client/order/_rapidata_order_builder.py

@@ -1,5 +1,5 @@
-from rapidata.api_client.models.capped_selection_selections_inner import (
-    CappedSelectionSelectionsInner,
+from rapidata.api_client.models.ab_test_selection_a_inner import (
+    AbTestSelectionAInner,
 )
 from rapidata.api_client.models.create_order_model import CreateOrderModel
 from rapidata.api_client.models.create_order_model_referee import (
@@ -92,7 +92,7 @@ class RapidataOrderBuilder:
                 else None
             ),
             selections=[
-                CappedSelectionSelectionsInner(selection._to_model())
+                AbTestSelectionAInner(selection._to_model())
                 for selection in self.__selections
             ],
             priority=self.__priority,

rapidata/rapidata_client/order/rapidata_order.py

@@ -6,6 +6,7 @@ from rapidata.api_client.exceptions import ApiException
 from rapidata.api_client.models.order_state import OrderState
 from typing import Optional, cast, Any
 from rapidata.api_client.models.workflow_artifact_model import WorkflowArtifactModel
+from rapidata.api_client.models.preliminary_download_model import PreliminaryDownloadModel
 from tqdm import tqdm
 
 class RapidataOrder:
@@ -34,6 +35,7 @@ class RapidataOrder:
         self.__openapi_service = openapi_service
         self.__dataset = dataset
         self.__workflow_id = None
+        self.__pipeline_id = ""
 
     def run(self, print_link: bool=True):
         """
@@ -103,20 +105,29 @@ class RapidataOrder:
 
                 sleep(refresh_rate)
 
+    def __get_pipeline_id(self):
+        if self.__pipeline_id:
+            return self.__pipeline_id
+
+        self.__pipeline_id = self.__openapi_service.order_api.order_get_by_id_get(self.order_id).pipeline_id
+        return self.__pipeline_id
+
     def __get_workflow_id(self):
         if self.__workflow_id:
             return self.__workflow_id
 
         for _ in range(10): # Try for 20 seconds to get the workflow id if workflow has not started by then, raise an exception
             try:
-                order_result = self.__openapi_service.order_api.order_get_by_id_get(self.order_id)
-                pipeline = self.__openapi_service.pipeline_api.pipeline_id_get(order_result.pipeline_id)
+                self.__get_pipeline_id()
+                pipeline = self.__openapi_service.pipeline_api.pipeline_id_get(self.__pipeline_id)
                 self.__workflow_id = cast(WorkflowArtifactModel, pipeline.artifacts["workflow-artifact"].actual_instance).workflow_id
                 break
             except Exception:
                 sleep(2)
+
         if not self.__workflow_id:
             raise Exception("Something went wrong when trying to get the order progress.")
+        
         return self.__workflow_id
     
     def __get_workflow_progress(self):
@@ -133,16 +144,42 @@ class RapidataOrder:
             raise Exception(f"Failed to get progress. Please try again in a few seconds.")
         
         return progress
-
+    
+    def __get_preliminary_results(self) -> dict[str, Any]:
+        pipeline_id = self.__get_pipeline_id()
+        try: 
+            download_id = self.__openapi_service.pipeline_api.pipeline_pipeline_id_preliminary_download_post(pipeline_id, PreliminaryDownloadModel(sendEmail=False)).download_id
+            while not (preliminary_results := self.__openapi_service.pipeline_api.pipeline_preliminary_download_preliminary_download_id_get(preliminary_download_id=download_id)):
+                sleep(1)
+            return json.loads(preliminary_results.decode())
         
-    def get_results(self) -> dict[str, Any]:
+        except ApiException as e:
+            # Handle API exceptions
+            raise Exception(f"Failed to get preliminary order results: {str(e)}") from e
+        except json.JSONDecodeError as e:
+            # Handle JSON parsing errors
+            raise Exception(f"Failed to parse preliminary order results: {str(e)}") from e
+
+    def get_results(self, preliminary_results=False) -> dict[str, Any]:
         """
         Gets the results of the order. 
         If the order is still processing, this method will block until the order is completed and then return the results.
 
+        Args:
+            preliminary_results: If True, returns the preliminary results of the order. Defaults to False. 
+                Note that preliminary results are not final and may not contain all the datapoints & responses. Only the onese that are already available.
+                This will throw an exception if there are no responses available yet.
+
         Returns: 
             The results of the order.
         """
+
+        if preliminary_results and self.get_status() not in [OrderState.COMPLETED]:
+            return self.__get_preliminary_results()
+        
+        elif preliminary_results and self.get_status() in [OrderState.COMPLETED]:
+            print("Order is already completed. Returning final results.")
+
         while self.get_status() not in [OrderState.COMPLETED, OrderState.PAUSED, OrderState.MANUALREVIEW, OrderState.FAILED]:
             sleep(5)