rapidata 2.21.5__py3-none-any.whl → 2.22.0__py3-none-any.whl

rapidata/api_client/models/update_validation_rapid_model.py

@@ -17,8 +17,8 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
 from rapidata.api_client.models.update_validation_rapid_model_truth import UpdateValidationRapidModelTruth
 from typing import Optional, Set
 from typing_extensions import Self
@@ -30,7 +30,8 @@ class UpdateValidationRapidModel(BaseModel):
     truth: UpdateValidationRapidModelTruth
     explanation: Optional[StrictStr] = None
     prompt: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["truth", "explanation", "prompt"]
+    random_correct_probability: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="randomCorrectProbability")
+    __properties: ClassVar[List[str]] = ["truth", "explanation", "prompt", "randomCorrectProbability"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -84,6 +85,11 @@ class UpdateValidationRapidModel(BaseModel):
         if self.prompt is None and "prompt" in self.model_fields_set:
             _dict['prompt'] = None
 
+        # set to None if random_correct_probability (nullable) is None
+        # and model_fields_set contains the field
+        if self.random_correct_probability is None and "random_correct_probability" in self.model_fields_set:
+            _dict['randomCorrectProbability'] = None
+
         return _dict
 
     @classmethod
@@ -98,7 +104,8 @@ class UpdateValidationRapidModel(BaseModel):
         _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")
+            "prompt": obj.get("prompt"),
+            "randomCorrectProbability": obj.get("randomCorrectProbability")
         })
         return _obj
 

rapidata/api_client/models/update_validation_rapid_model_truth.py

@@ -26,12 +26,13 @@ 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.skip_truth import SkipTruth
 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"]
+UPDATEVALIDATIONRAPIDMODELTRUTH_ONE_OF_SCHEMAS = ["AttachCategoryTruth", "BoundingBoxTruth", "CompareTruth", "EmptyValidationTruth", "LineTruth", "LocateBoxTruth", "NamedEntityTruth", "PolygonTruth", "ScrubTruth", "SkipTruth", "TranscriptionTruth"]
 
 class UpdateValidationRapidModelTruth(BaseModel):
     """
@@ -53,12 +54,14 @@ class UpdateValidationRapidModelTruth(BaseModel):
     oneof_schema_7_validator: Optional[EmptyValidationTruth] = None
     # data type: CompareTruth
     oneof_schema_8_validator: Optional[CompareTruth] = None
+    # data type: SkipTruth
+    oneof_schema_9_validator: Optional[SkipTruth] = None
     # data type: AttachCategoryTruth
-    oneof_schema_9_validator: Optional[AttachCategoryTruth] = None
+    oneof_schema_10_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" }
+    oneof_schema_11_validator: Optional[BoundingBoxTruth] = None
+    actual_instance: Optional[Union[AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, SkipTruth, TranscriptionTruth]] = None
+    one_of_schemas: Set[str] = { "AttachCategoryTruth", "BoundingBoxTruth", "CompareTruth", "EmptyValidationTruth", "LineTruth", "LocateBoxTruth", "NamedEntityTruth", "PolygonTruth", "ScrubTruth", "SkipTruth", "TranscriptionTruth" }
 
     model_config = ConfigDict(
         validate_assignment=True,
@@ -124,6 +127,11 @@ class UpdateValidationRapidModelTruth(BaseModel):
             error_messages.append(f"Error! Input type `{type(v)}` is not `CompareTruth`")
         else:
             match += 1
+        # validate data type: SkipTruth
+        if not isinstance(v, SkipTruth):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `SkipTruth`")
+        else:
+            match += 1
         # validate data type: AttachCategoryTruth
         if not isinstance(v, AttachCategoryTruth):
             error_messages.append(f"Error! Input type `{type(v)}` is not `AttachCategoryTruth`")
@@ -136,10 +144,10 @@ class UpdateValidationRapidModelTruth(BaseModel):
             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))
+            raise ValueError("Multiple matches found when setting `actual_instance` in UpdateValidationRapidModelTruth with oneOf schemas: AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, SkipTruth, 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))
+            raise ValueError("No match found when setting `actual_instance` in UpdateValidationRapidModelTruth with oneOf schemas: AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, SkipTruth, TranscriptionTruth. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -202,6 +210,12 @@ class UpdateValidationRapidModelTruth(BaseModel):
             match += 1
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
+        # deserialize data into SkipTruth
+        try:
+            instance.actual_instance = SkipTruth.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)
@@ -217,10 +231,10 @@ class UpdateValidationRapidModelTruth(BaseModel):
 
         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))
+            raise ValueError("Multiple matches found when deserializing the JSON string into UpdateValidationRapidModelTruth with oneOf schemas: AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, SkipTruth, 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))
+            raise ValueError("No match found when deserializing the JSON string into UpdateValidationRapidModelTruth with oneOf schemas: AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, SkipTruth, TranscriptionTruth. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -234,7 +248,7 @@ class UpdateValidationRapidModelTruth(BaseModel):
         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]]:
+    def to_dict(self) -> Optional[Union[Dict[str, Any], AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, ScrubTruth, SkipTruth, TranscriptionTruth]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None

rapidata/api_client/rest.py

@@ -286,3 +286,4 @@ class RESTClientObject:
         
         If the issue persists, please reach out to us at 'info@rapidata.ai', we're happy to help you.
         """
+

rapidata/api_client_README.md

@@ -110,11 +110,13 @@ Class | Method | HTTP request | Description
 *DatasetApi* | [**dataset_import_post**](rapidata/api_client/docs/DatasetApi.md#dataset_import_post) | **POST** /dataset/import | Imports datapoints from a csv file.
 *DatasetApi* | [**dataset_updatename_post**](rapidata/api_client/docs/DatasetApi.md#dataset_updatename_post) | **POST** /dataset/updatename | Updates the name of a dataset.
 *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.
+*EvaluationWorkflowApi* | [**workflow_evaluation_workflow_id_results_get**](rapidata/api_client/docs/EvaluationWorkflowApi.md#workflow_evaluation_workflow_id_results_get) | **GET** /workflow/evaluation/{workflowId}/results | Get the results for an evaluation workflow.
 *FeedbackApi* | [**feedback_feedback_post**](rapidata/api_client/docs/FeedbackApi.md#feedback_feedback_post) | **POST** /feedback/feedback | Submits feedback about our services.
 *FeedbackApi* | [**feedback_post**](rapidata/api_client/docs/FeedbackApi.md#feedback_post) | **POST** /feedback | Submits feedback about our services.
 *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.
 *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.
 *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.
+*IdentityApi* | [**identity_google_one_tap_post**](rapidata/api_client/docs/IdentityApi.md#identity_google_one_tap_post) | **POST** /identity/google-one-tap | Signs in a user using a token received from Google One Tap.
 *IdentityApi* | [**identity_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.
 *IdentityApi* | [**identity_referrer_post**](rapidata/api_client/docs/IdentityApi.md#identity_referrer_post) | **POST** /identity/referrer | Sets the referrer for the current customer.
 *IdentityApi* | [**identity_registertemporary_post**](rapidata/api_client/docs/IdentityApi.md#identity_registertemporary_post) | **POST** /identity/registertemporary | Registers and logs in a temporary customer.
@@ -170,21 +172,15 @@ Class | Method | HTTP request | Description
 *PipelineApi* | [**pipeline_pipeline_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_get) | **GET** /pipeline/{pipelineId} | Gets a pipeline by its id.
 *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.
-*RapidApi* | [**rapid_adduserguess_post**](rapidata/api_client/docs/RapidApi.md#rapid_adduserguess_post) | **POST** /rapid/adduserguess | Submits a user guess for a Rapid.
-*RapidApi* | [**rapid_createdemographicrapid_post**](rapidata/api_client/docs/RapidApi.md#rapid_createdemographicrapid_post) | **POST** /rapid/createdemographicrapid | Creates a new Demographic Rapid.
 *RapidApi* | [**rapid_demographic_post**](rapidata/api_client/docs/RapidApi.md#rapid_demographic_post) | **POST** /rapid/demographic | Creates a new Demographic Rapid.
-*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.
 *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.
 *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_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.
 *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_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.
+*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.
 *RapidApi* | [**rapid_response_post**](rapidata/api_client/docs/RapidApi.md#rapid_response_post) | **POST** /rapid/response | Submits a response for a Rapid.
 *RapidApi* | [**rapid_skip_post**](rapidata/api_client/docs/RapidApi.md#rapid_skip_post) | **POST** /rapid/skip | Skips a Rapid for the user.
-*RapidApi* | [**rapid_skipuserguess_post**](rapidata/api_client/docs/RapidApi.md#rapid_skipuserguess_post) | **POST** /rapid/skipuserguess | Skips a Rapid for the user.
-*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.
 *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.
-*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* | [**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.
 *UserInfoApi* | [**connect_userinfo_get**](rapidata/api_client/docs/UserInfoApi.md#connect_userinfo_get) | **GET** /connect/userinfo | Retrieves information about the authenticated user.
@@ -325,6 +321,7 @@ Class | Method | HTTP request | Description
  - [EmptyValidationTruth](rapidata/api_client/docs/EmptyValidationTruth.md)
  - [EvaluationWorkflowConfig](rapidata/api_client/docs/EvaluationWorkflowConfig.md)
  - [EvaluationWorkflowModel](rapidata/api_client/docs/EvaluationWorkflowModel.md)
+ - [EvaluationWorkflowModel1](rapidata/api_client/docs/EvaluationWorkflowModel1.md)
  - [FeatureFlag](rapidata/api_client/docs/FeatureFlag.md)
  - [FeatureFlagModel](rapidata/api_client/docs/FeatureFlagModel.md)
  - [FeedbackModel](rapidata/api_client/docs/FeedbackModel.md)
@@ -355,8 +352,6 @@ Class | Method | HTTP request | Description
  - [GetRapidResponsesResult](rapidata/api_client/docs/GetRapidResponsesResult.md)
  - [GetResponsesResult](rapidata/api_client/docs/GetResponsesResult.md)
  - [GetSimpleWorkflowResultsModel](rapidata/api_client/docs/GetSimpleWorkflowResultsModel.md)
- - [GetSimpleWorkflowResultsResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResult.md)
- - [GetSimpleWorkflowResultsResultPagedResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResultPagedResult.md)
  - [GetValidationRapidsResult](rapidata/api_client/docs/GetValidationRapidsResult.md)
  - [GetValidationRapidsResultAsset](rapidata/api_client/docs/GetValidationRapidsResultAsset.md)
  - [GetValidationRapidsResultPagedResult](rapidata/api_client/docs/GetValidationRapidsResultPagedResult.md)
@@ -366,6 +361,9 @@ Class | Method | HTTP request | Description
  - [GetWorkflowByIdResult](rapidata/api_client/docs/GetWorkflowByIdResult.md)
  - [GetWorkflowByIdResultWorkflow](rapidata/api_client/docs/GetWorkflowByIdResultWorkflow.md)
  - [GetWorkflowProgressResult](rapidata/api_client/docs/GetWorkflowProgressResult.md)
+ - [GetWorkflowResultsResult](rapidata/api_client/docs/GetWorkflowResultsResult.md)
+ - [GetWorkflowResultsResultPagedResult](rapidata/api_client/docs/GetWorkflowResultsResultPagedResult.md)
+ - [GoogleOneTapLoginModel](rapidata/api_client/docs/GoogleOneTapLoginModel.md)
  - [IWorkflowModelPagedResult](rapidata/api_client/docs/IWorkflowModelPagedResult.md)
  - [ImageDimensionMetadata](rapidata/api_client/docs/ImageDimensionMetadata.md)
  - [ImageDimensionMetadataModel](rapidata/api_client/docs/ImageDimensionMetadataModel.md)
@@ -429,8 +427,6 @@ Class | Method | HTTP request | Description
  - [PublicOrderModel](rapidata/api_client/docs/PublicOrderModel.md)
  - [PublicTextMetadataInput](rapidata/api_client/docs/PublicTextMetadataInput.md)
  - [QueryModel](rapidata/api_client/docs/QueryModel.md)
- - [QueryValidationRapidsResult](rapidata/api_client/docs/QueryValidationRapidsResult.md)
- - [QueryValidationRapidsResultPagedResult](rapidata/api_client/docs/QueryValidationRapidsResultPagedResult.md)
  - [QueryWorkflowsModel](rapidata/api_client/docs/QueryWorkflowsModel.md)
  - [RapidIssue](rapidata/api_client/docs/RapidIssue.md)
  - [RapidResponse](rapidata/api_client/docs/RapidResponse.md)
@@ -444,6 +440,7 @@ Class | Method | HTTP request | Description
  - [RegisterTemporaryCustomerResult](rapidata/api_client/docs/RegisterTemporaryCustomerResult.md)
  - [ReportModel](rapidata/api_client/docs/ReportModel.md)
  - [ResponseCountUserFilterModel](rapidata/api_client/docs/ResponseCountUserFilterModel.md)
+ - [RetrievalMode](rapidata/api_client/docs/RetrievalMode.md)
  - [RootFilter](rapidata/api_client/docs/RootFilter.md)
  - [ScrubPayload](rapidata/api_client/docs/ScrubPayload.md)
  - [ScrubRange](rapidata/api_client/docs/ScrubRange.md)
@@ -460,11 +457,13 @@ Class | Method | HTTP request | Description
  - [SimpleWorkflowModel1](rapidata/api_client/docs/SimpleWorkflowModel1.md)
  - [SimpleWorkflowModelBlueprint](rapidata/api_client/docs/SimpleWorkflowModelBlueprint.md)
  - [SkipResult](rapidata/api_client/docs/SkipResult.md)
+ - [SkipTruth](rapidata/api_client/docs/SkipTruth.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)
+ - [StickyState](rapidata/api_client/docs/StickyState.md)
  - [SubmitCocoModel](rapidata/api_client/docs/SubmitCocoModel.md)
  - [SubmitCocoResult](rapidata/api_client/docs/SubmitCocoResult.md)
  - [TextAssetModel](rapidata/api_client/docs/TextAssetModel.md)

rapidata/rapidata_client/__init__.py

@@ -6,6 +6,7 @@ from .selection import (
     ConditionalValidationSelection,
     CappedSelection,
     ShufflingSelection,
+    RetrievalMode,
 )
 from .metadata import (
     PrivateTextMetadata,
@@ -45,4 +46,10 @@ from .filter import (
     ResponseCountFilter,
 )
 
+from .logging import (
+    configure_logger, 
+    logger,
+    OutputManger
+)
+
 from .validation import Box

rapidata/rapidata_client/api/rapidata_exception.py

@@ -2,7 +2,7 @@ from typing import Optional, Any
 from rapidata.api_client.api_client import ApiClient, rest, ApiResponse, ApiResponseT
 from rapidata.api_client.exceptions import ApiException
 import json
-
+from rapidata.rapidata_client.logging import logger
 
 class RapidataError(Exception):
     """Custom error class for Rapidata API errors."""
@@ -97,9 +97,11 @@ class RapidataApiClient(ApiClient):
                     # If we can't parse the body as JSON, use the original message
                     pass
             
-            raise RapidataError(
+            error_formatted =  RapidataError(
                 status_code=status_code, 
                 message=message, 
                 original_exception=e,
                 details=details
-            ) from None
+            )
+            logger.error(f"Error: {error_formatted}")
+            raise error_formatted from None

rapidata/rapidata_client/assets/_media_asset.py

@@ -17,6 +17,7 @@ from pydantic import StrictStr, StrictBytes
 import logging
 from functools import cached_property
 from rapidata.rapidata_client.assets._sessions import SessionManager
+from rapidata.rapidata_client.logging import logger
 
 class MediaAsset(BaseAsset):
     """MediaAsset Class with Lazy Loading
@@ -168,7 +169,7 @@ class MediaAsset(BaseAsset):
     def __check_name_ending(self, name: str) -> str:
         """Check if the media path is valid."""
         if not name.endswith(('.jpg', '.jpeg', '.png', '.gif', '.mp3', '.mp4', '.webp')):
-            print("Warning: Supported file types: jpg, jpeg, png, gif, mp3, mp4. Image might not be displayed correctly.")
+            logger.warning("Warning: Supported file types: jpg, jpeg, png, gif, mp3, mp4. Image might not be displayed correctly.")
             name = name + '.jpg'
         return name
 
@@ -297,3 +298,9 @@ class MediaAsset(BaseAsset):
             return self.path
         else:
             return (self.name, self.content)
+        
+    def __str__(self) -> str:
+        return f"MediaAsset(path={self.path})"
+    
+    def __repr__(self) -> str:
+        return f"MediaAsset(path={self.path})"

rapidata/rapidata_client/assets/_multi_asset.py

@@ -58,3 +58,9 @@ class MultiAsset(BaseAsset):
             Iterator[BaseAsset]: An iterator over the assets.
         """
         return iter(self.assets)
+
+    def __str__(self) -> str:
+        return f"MultiAsset(assets={self.assets})"
+    
+    def __repr__(self) -> str:
+        return f"MultiAsset(assets={self.assets})"

rapidata/rapidata_client/assets/_text_asset.py

@@ -26,3 +26,9 @@ class TextAsset(BaseAsset):
             raise ValueError("Text must be a string")
         
         self.text = text
+
+    def __str__(self) -> str:
+        return f"TextAsset(text={self.text})"
+    
+    def __repr__(self) -> str:
+        return f"TextAsset(text={self.text})"

rapidata/rapidata_client/demographic/demographic_manager.py

@@ -2,13 +2,12 @@ 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
-
+from rapidata.rapidata_client.logging import logger
 
 class DemographicManager:
     def __init__(self, openapi_service: OpenAPIService):
         self._openapi_service = openapi_service
+        logger.debug("DemographicManager initialized")
     
     def create_demographic_rapid(self, 
                                  instruction: str,

rapidata/rapidata_client/logging/__init__.py

@@ -0,0 +1,2 @@
+from .logger import configure_logger, logger
+from .output_manager import managed_print, OutputManger

rapidata/rapidata_client/logging/logger.py

@@ -0,0 +1,47 @@
+import logging
+import os
+from typing import Optional
+
+# Create module-level logger
+logger = logging.getLogger("rapidata")
+
+def configure_logger(
+    level: str = "WARNING",
+    log_file: Optional[str] = None,
+    format_string: str = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+):
+    """Configure the Rapidata logger with custom settings."""
+    # Convert string level to logging level
+    level_map = {
+        "DEBUG": logging.DEBUG,
+        "INFO": logging.INFO, 
+        "WARNING": logging.WARNING,
+        "ERROR": logging.ERROR,
+        "CRITICAL": logging.CRITICAL
+    }
+    
+    numeric_level = level_map.get(level.upper(), logging.INFO)
+    logger.setLevel(numeric_level)
+    
+    # Remove existing handlers if any
+    for handler in logger.handlers[:]:
+        logger.removeHandler(handler)
+    
+    # Create formatter
+    formatter = logging.Formatter(format_string)
+    
+    # Console handler
+    console_handler = logging.StreamHandler()
+    console_handler.setFormatter(formatter)
+    logger.addHandler(console_handler)
+    
+    # File handler (optional)
+    if log_file:
+        log_dir = os.path.dirname(log_file)
+        if log_dir:
+            os.makedirs(log_dir, exist_ok=True)
+        file_handler = logging.FileHandler(log_file)
+        file_handler.setFormatter(formatter)
+        logger.addHandler(file_handler)
+
+configure_logger()

rapidata/rapidata_client/logging/output_manager.py

@@ -0,0 +1,16 @@
+class OutputManger:
+    silent_mode = False
+    
+    @classmethod
+    def enable_silent_mode(cls):
+        cls.silent_mode = True
+        
+    @classmethod
+    def disable_silent_mode(cls):
+        cls.silent_mode = False
+
+def managed_print(*args, **kwargs):
+    if not OutputManger.silent_mode:
+        print(*args, **kwargs)
+
+

rapidata/rapidata_client/order/_rapidata_dataset.py

@@ -17,7 +17,7 @@ from tqdm import tqdm
 
 from pydantic import StrictStr
 from typing import cast, Sequence, Generator
-from logging import Logger
+from rapidata.rapidata_client.logging import logger
 import time
 import threading
 
@@ -33,7 +33,6 @@ class RapidataDataset:
         self.dataset_id = dataset_id
         self.openapi_service = openapi_service
         self.local_file_service = LocalFileService()
-        self._logger = Logger(__name__)
 
     def _add_texts(
         self,
@@ -144,14 +143,14 @@ class RapidataDataset:
                 
             if upload_response.errors:
                 error_msg = f"Error uploading datapoint: {upload_response.errors}"
-                self._logger.error(error_msg)
+                logger.error(error_msg)
                 local_failed.extend(identifiers_to_track)
                 raise ValueError(error_msg)
 
             local_successful.extend(identifiers_to_track)
 
         except Exception as e:
-            self._logger.error(f"\nUpload failed for {identifiers_to_track}: {str(e)}") # \n to avoid same line as tqdm
+            logger.error(f"\nUpload failed for {identifiers_to_track}: {str(e)}") # \n to avoid same line as tqdm
             local_failed.extend(identifiers_to_track)
 
         return local_successful, local_failed
@@ -233,11 +232,11 @@ class RapidataDataset:
                                     # If we're not at 100% but it's been a while with no progress
                                     if stall_count > 5:
                                         # We've polled several times with no progress, assume we're done
-                                        self._logger.warning(f"\nProgress seems stalled at {total_completed}/{total_uploads}. Please try again.")
+                                        logger.warning(f"\nProgress seems stalled at {total_completed}/{total_uploads}. Please try again.")
                                         break
                                 
                         except Exception as e:
-                            self._logger.error(f"\nError checking progress: {str(e)}")
+                            logger.error(f"\nError checking progress: {str(e)}")
                             stall_count += 1
                             
                             if stall_count > 10:  # Too many consecutive errors
@@ -248,7 +247,7 @@ class RapidataDataset:
                         time.sleep(progress_poll_interval)
                 
             except Exception as e:
-                self._logger.error(f"Progress tracking thread error: {str(e)}")
+                logger.error(f"Progress tracking thread error: {str(e)}")
                 progress_error_event.set()
                 
         # Create and return the thread
@@ -308,7 +307,7 @@ class RapidataDataset:
                             successful_uploads.extend(chunk_successful)
                             failed_uploads.extend(chunk_failed)
                         except Exception as e:
-                            self._logger.error(f"Future execution failed: {str(e)}")
+                            logger.error(f"Future execution failed: {str(e)}")
         finally:
             # Signal to the progress tracking thread that all uploads have been submitted
             stop_progress_tracking.set()
@@ -349,14 +348,13 @@ class RapidataDataset:
             
             success_rate = (total_ready / total_uploads * 100) if total_uploads > 0 else 0
             
-            self._logger.info(f"Upload complete: {total_ready} ready, {total_uploads-total_ready} failed ({success_rate:.1f}% success rate)")
-            print(f"Upload complete, {total_ready} ready, {total_uploads-total_ready} failed ({success_rate:.1f}% success rate)")
+            logger.info(f"Upload complete: {total_ready} ready, {total_uploads-total_ready} failed ({success_rate:.1f}% success rate)")
         except Exception as e:
-            self._logger.error(f"Error getting final progress: {str(e)}")
-            self._logger.info(f"Upload summary from local tracking: {len(successful_uploads)} succeeded, {len(failed_uploads)} failed")
+            logger.error(f"Error getting final progress: {str(e)}")
+            logger.info(f"Upload summary from local tracking: {len(successful_uploads)} succeeded, {len(failed_uploads)} failed")
 
         if failed_uploads:
-            print(f"Failed uploads: {failed_uploads}")
+            logger.error(f"Failed uploads: {failed_uploads}")
 
     def _add_media_from_paths(
         self,

rapidata/rapidata_client/order/_rapidata_order_builder.py

@@ -29,6 +29,8 @@ from rapidata.rapidata_client.assets import MediaAsset, TextAsset, MultiAsset, B
 
 from typing import Optional, cast, Sequence
 
+from rapidata.rapidata_client.logging import logger, managed_print
+
 
 class RapidataOrderBuilder:
     """Builder object for creating Rapidata orders.
@@ -73,7 +75,7 @@ class RapidataOrderBuilder:
             raise ValueError("You must provide a workflow to create an order.")
 
         if self.__referee is None:
-            print("No referee provided, using default NaiveReferee.")
+            managed_print("No referee provided, using default NaiveReferee.")
             self.__referee = NaiveReferee()
 
         return CreateOrderModel(
@@ -113,6 +115,7 @@ class RapidataOrderBuilder:
             RapidataOrder: The created RapidataOrder instance.
         """
         order_model = self._to_model()
+        logger.debug(f"Creating order with model: {order_model}")
         if isinstance(
             self.__workflow, CompareWorkflow
         ):  # Temporary fix; will be handled by backend in the future
@@ -125,12 +128,17 @@ class RapidataOrderBuilder:
         )
 
         self.order_id = str(result.order_id)
+        logger.debug(f"Order created with ID: {self.order_id}")
 
         self.__dataset = (
             RapidataDataset(result.dataset_id, self.__openapi_service)
             if result.dataset_id
             else None
         )
+        if self.__dataset:
+            logger.debug(f"Dataset created with ID: {self.__dataset.dataset_id}")
+        else:
+            logger.warning("No dataset created for this order.")
 
         order = RapidataOrder(
             order_id=self.order_id,
@@ -138,6 +146,9 @@ class RapidataOrderBuilder:
             name=self._name,
         )
 
+        logger.debug(f"Order created: {order}")
+        logger.debug("Adding media to the order.")
+
         if all(isinstance(item, MediaAsset) for item in self.__assets) and self.__dataset:
             assets = cast(list[MediaAsset], self.__assets)
             self.__dataset._add_media_from_paths(assets, self.__metadata, max_upload_workers)
@@ -183,6 +194,8 @@ class RapidataOrderBuilder:
                 "Media paths must all be of the same type: MediaAsset, TextAsset, or MultiAsset."
             )
         
+        logger.debug("Media added to the order.")
+        logger.debug("Setting order to preview")
         self.__openapi_service.order_api.order_order_id_preview_post(self.order_id)
 
         return order
@@ -291,7 +304,7 @@ class RapidataOrderBuilder:
                 raise TypeError("Filters must be of type Filter.")
 
         if len(self.__user_filters) > 0:
-            print("Overwriting existing user filters.")
+            managed_print("Overwriting existing user filters.")
 
         self.__user_filters = filters
         return self