rapidata 2.36.0__py3-none-any.whl → 2.36.2__py3-none-any.whl

rapidata/api_client/models/source_url_metadata.py

@@ -28,7 +28,7 @@ class SourceUrlMetadata(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for SourceUrlMetadata", alias="_t")
     url: StrictStr
-    visibilities: Optional[StrictStr] = None
+    visibilities: Optional[List[StrictStr]] = None
     __properties: ClassVar[List[str]] = ["_t", "url", "visibilities"]
 
     @field_validator('t')
@@ -38,6 +38,17 @@ class SourceUrlMetadata(BaseModel):
             raise ValueError("must be one of enum values ('SourceUrlMetadata')")
         return value
 
+    @field_validator('visibilities')
+    def visibilities_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']):
+                raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

rapidata/api_client/models/standing_by_leaderboard.py

@@ -17,8 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
+from rapidata.api_client.models.standing_status import StandingStatus
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -30,20 +31,13 @@ class StandingByLeaderboard(BaseModel):
     name: StrictStr
     leaderboard_id: StrictStr = Field(alias="leaderboardId")
     dataset_id: Optional[StrictStr] = Field(default=None, alias="datasetId")
-    status: StrictStr
+    status: StandingStatus
     score: Optional[Union[StrictFloat, StrictInt]] = None
     wins: StrictInt
     total_matches: StrictInt = Field(alias="totalMatches")
     is_disabled: StrictBool = Field(alias="isDisabled")
     __properties: ClassVar[List[str]] = ["id", "name", "leaderboardId", "datasetId", "status", "score", "wins", "totalMatches", "isDisabled"]
 
-    @field_validator('status')
-    def status_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['Created', 'Active', 'Idle']):
-            raise ValueError("must be one of enum values ('Created', 'Active', 'Idle')")
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

rapidata/api_client/models/streams_metadata.py

@@ -30,7 +30,7 @@ class StreamsMetadata(BaseModel):
     has_audio: Optional[StrictBool] = Field(default=None, alias="hasAudio")
     has_video: Optional[StrictBool] = Field(default=None, alias="hasVideo")
     has_subtitles: Optional[StrictBool] = Field(default=None, alias="hasSubtitles")
-    visibilities: Optional[StrictStr] = None
+    visibilities: Optional[List[StrictStr]] = None
     __properties: ClassVar[List[str]] = ["_t", "hasAudio", "hasVideo", "hasSubtitles", "visibilities"]
 
     @field_validator('t')
@@ -40,6 +40,17 @@ class StreamsMetadata(BaseModel):
             raise ValueError("must be one of enum values ('StreamsMetadata')")
         return value
 
+    @field_validator('visibilities')
+    def visibilities_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']):
+                raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

rapidata/api_client/models/text_metadata.py

@@ -28,7 +28,7 @@ class TextMetadata(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for TextMetadata", alias="_t")
     text: StrictStr
-    visibilities: Optional[StrictStr] = None
+    visibilities: Optional[List[StrictStr]] = None
     __properties: ClassVar[List[str]] = ["_t", "text", "visibilities"]
 
     @field_validator('t')
@@ -38,6 +38,17 @@ class TextMetadata(BaseModel):
             raise ValueError("must be one of enum values ('TextMetadata')")
         return value
 
+    @field_validator('visibilities')
+    def visibilities_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']):
+                raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

rapidata/api_client/models/transcription_metadata.py

@@ -28,7 +28,7 @@ class TranscriptionMetadata(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for TranscriptionMetadata", alias="_t")
     transcription: StrictStr
-    visibilities: StrictStr
+    visibilities: List[StrictStr]
     __properties: ClassVar[List[str]] = ["_t", "transcription", "visibilities"]
 
     @field_validator('t')
@@ -38,6 +38,14 @@ class TranscriptionMetadata(BaseModel):
             raise ValueError("must be one of enum values ('TranscriptionMetadata')")
         return value
 
+    @field_validator('visibilities')
+    def visibilities_validate_enum(cls, value):
+        """Validates the enum"""
+        for i in value:
+            if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']):
+                raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

rapidata/api_client/models/update_leaderboard_model.py

@@ -0,0 +1,91 @@
+# 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, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UpdateLeaderboardModel(BaseModel):
+    """
+    The model used to update a leaderboard.
+    """ # noqa: E501
+    name: Optional[StrictStr] = None
+    response_budget: Optional[StrictInt] = Field(default=None, alias="responseBudget")
+    min_responses: Optional[StrictInt] = Field(default=None, alias="minResponses")
+    __properties: ClassVar[List[str]] = ["name", "responseBudget", "minResponses"]
+
+    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 UpdateLeaderboardModel 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateLeaderboardModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "responseBudget": obj.get("responseBudget"),
+            "minResponses": obj.get("minResponses")
+        })
+        return _obj
+
+

rapidata/api_client/models/update_should_alert_model.py

@@ -26,7 +26,7 @@ class UpdateShouldAlertModel(BaseModel):
     """
     The model for updating the shouldAlert field of all rapids within a validation set.
     """ # noqa: E501
-    should_alert: StrictBool = Field(description="If the users should be alerted if answering wrong.", alias="shouldAlert")
+    should_alert: StrictBool = Field(description="A flag indicating whether the users should be alerted if they answer incorrectly.", alias="shouldAlert")
     __properties: ClassVar[List[str]] = ["shouldAlert"]
 
     model_config = ConfigDict(

rapidata/api_client/models/validation_set_model.py

@@ -18,8 +18,8 @@ import re  # noqa: F401
 import json
 
 from datetime import datetime
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -29,10 +29,46 @@ class ValidationSetModel(BaseModel):
     """ # noqa: E501
     id: StrictStr
     name: StrictStr
+    asset_type: Optional[List[StrictStr]] = Field(default=None, alias="assetType")
+    modality: Optional[List[StrictStr]] = None
+    prompt_type: Optional[List[StrictStr]] = Field(default=None, alias="promptType")
     owner_id: StrictStr = Field(alias="ownerId")
     owner_mail: StrictStr = Field(alias="ownerMail")
     created_at: datetime = Field(alias="createdAt")
-    __properties: ClassVar[List[str]] = ["id", "name", "ownerId", "ownerMail", "createdAt"]
+    __properties: ClassVar[List[str]] = ["id", "name", "assetType", "modality", "promptType", "ownerId", "ownerMail", "createdAt"]
+
+    @field_validator('asset_type')
+    def asset_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['None', 'Image', 'Video', 'Audio', 'Text']):
+                raise ValueError("each list item must be one of ('None', 'Image', 'Video', 'Audio', 'Text')")
+        return value
+
+    @field_validator('modality')
+    def modality_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['None', 'BoundingBox', 'Classify', 'Compare', 'FreeText', 'Line', 'Locate', 'NamedEntity', 'Polygon', 'Scrub', 'Transcription']):
+                raise ValueError("each list item must be one of ('None', 'BoundingBox', 'Classify', 'Compare', 'FreeText', 'Line', 'Locate', 'NamedEntity', 'Polygon', 'Scrub', 'Transcription')")
+        return value
+
+    @field_validator('prompt_type')
+    def prompt_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['None', 'Text', 'Asset']):
+                raise ValueError("each list item must be one of ('None', 'Text', 'Asset')")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -87,6 +123,9 @@ class ValidationSetModel(BaseModel):
         _obj = cls.model_validate({
             "id": obj.get("id"),
             "name": obj.get("name"),
+            "assetType": obj.get("assetType"),
+            "modality": obj.get("modality"),
+            "promptType": obj.get("promptType"),
             "ownerId": obj.get("ownerId"),
             "ownerMail": obj.get("ownerMail"),
             "createdAt": obj.get("createdAt")

rapidata/api_client/models/video_duration_metadata.py

@@ -28,7 +28,7 @@ class VideoDurationMetadata(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for VideoDurationMetadata", alias="_t")
     duration: StrictStr
-    visibilities: Optional[StrictStr] = None
+    visibilities: Optional[List[StrictStr]] = None
     __properties: ClassVar[List[str]] = ["_t", "duration", "visibilities"]
 
     @field_validator('t')
@@ -38,6 +38,17 @@ class VideoDurationMetadata(BaseModel):
             raise ValueError("must be one of enum values ('VideoDurationMetadata')")
         return value
 
+    @field_validator('visibilities')
+    def visibilities_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All']):
+                raise ValueError("each list item must be one of ('None', 'Users', 'Customers', 'Admins', 'Dashboard', 'All')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,

rapidata/api_client/models/workflow_aggregation_step_model.py

@@ -19,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.aggregator_type import AggregatorType
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -30,7 +31,7 @@ class WorkflowAggregationStepModel(BaseModel):
     campaign_artifact_id: StrictStr = Field(description="The campaign artifact id", alias="campaignArtifactId")
     workflow_artifact_id: StrictStr = Field(description="The workflow artifact id", alias="workflowArtifactId")
     file_artifact_id: StrictStr = Field(description="The file artifact id", alias="fileArtifactId")
-    aggregator_type: Optional[StrictStr] = Field(default='NonCommittal', description="The type of the aggregator", alias="aggregatorType")
+    aggregator_type: Optional[AggregatorType] = Field(default=None, alias="aggregatorType")
     __properties: ClassVar[List[str]] = ["_t", "campaignArtifactId", "workflowArtifactId", "fileArtifactId", "aggregatorType"]
 
     @field_validator('t')
@@ -40,16 +41,6 @@ class WorkflowAggregationStepModel(BaseModel):
             raise ValueError("must be one of enum values ('WorkflowAggregationStepModel')")
         return value
 
-    @field_validator('aggregator_type')
-    def aggregator_type_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText', 'Scrub']):
-            raise ValueError("must be one of enum values ('NonCommittal', 'MajorityVote', 'SimpleMatchup', 'LocateCluster', 'Classification', 'Locate', 'BoundingBox', 'Line', 'Transcription', 'SinglePointLocate', 'FreeText', 'Scrub')")
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -105,7 +96,7 @@ class WorkflowAggregationStepModel(BaseModel):
             "campaignArtifactId": obj.get("campaignArtifactId"),
             "workflowArtifactId": obj.get("workflowArtifactId"),
             "fileArtifactId": obj.get("fileArtifactId"),
-            "aggregatorType": obj.get("aggregatorType") if obj.get("aggregatorType") is not None else 'NonCommittal'
+            "aggregatorType": obj.get("aggregatorType")
         })
         return _obj
 

rapidata/api_client_README.md

@@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
 *LeaderboardApi* | [**leaderboard_leaderboard_id_participants_get**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_participants_get) | **GET** /leaderboard/{leaderboardId}/participants | queries all the participants connected to leaderboard by its ID.
 *LeaderboardApi* | [**leaderboard_leaderboard_id_participants_participant_id_submit_post**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_participants_participant_id_submit_post) | **POST** /leaderboard/{leaderboardId}/participants/{participantId}/submit | Submits a participant to a leaderboard.
 *LeaderboardApi* | [**leaderboard_leaderboard_id_participants_post**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_participants_post) | **POST** /leaderboard/{leaderboardId}/participants | Creates a participant in a leaderboard.
+*LeaderboardApi* | [**leaderboard_leaderboard_id_patch**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_patch) | **PATCH** /leaderboard/{leaderboardId} | Updates the response config of a leaderboard.
 *LeaderboardApi* | [**leaderboard_leaderboard_id_prompts_get**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_prompts_get) | **GET** /leaderboard/{leaderboardId}/prompts | returns the paged prompts of a leaderboard by its ID.
 *LeaderboardApi* | [**leaderboard_leaderboard_id_prompts_post**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_prompts_post) | **POST** /leaderboard/{leaderboardId}/prompts | adds a new prompt to a leaderboard.
 *LeaderboardApi* | [**leaderboard_leaderboard_id_response_config_put**](rapidata/api_client/docs/LeaderboardApi.md#leaderboard_leaderboard_id_response_config_put) | **PUT** /leaderboard/{leaderboardId}/response-config | Updates the response config of a leaderboard.
@@ -189,21 +190,22 @@ Class | Method | HTTP request | Description
 *UserRapidApi* | [**rapid_response_post**](rapidata/api_client/docs/UserRapidApi.md#rapid_response_post) | **POST** /rapid/response | Submits a response for a Rapid.
 *UserRapidApi* | [**rapid_skip_post**](rapidata/api_client/docs/UserRapidApi.md#rapid_skip_post) | **POST** /rapid/skip | Skips a Rapid for the user.
 *ValidationSetApi* | [**validation_set_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_post) | **POST** /validation-set | Creates a new empty validation set.
+*ValidationSetApi* | [**validation_set_recommended_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_recommended_get) | **GET** /validation-set/recommended | Gets a validation set that is available to the user and best matches the provided parameters.
 *ValidationSetApi* | [**validation_set_validation_set_id_delete**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_delete) | **DELETE** /validation-set/{validationSetId} | Gets a validation set by the id.
 *ValidationSetApi* | [**validation_set_validation_set_id_dimensions_patch**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_dimensions_patch) | **PATCH** /validation-set/{validationSetId}/dimensions | Updates the dimensions of all rapids within a validation set.
 *ValidationSetApi* | [**validation_set_validation_set_id_dimensions_put**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_dimensions_put) | **PUT** /validation-set/{validationSetId}/dimensions | Updates the dimensions of all rapids within a validation set.
 *ValidationSetApi* | [**validation_set_validation_set_id_export_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_export_get) | **GET** /validation-set/{validationSetId}/export | Exports all rapids of a validation-set to a file.
 *ValidationSetApi* | [**validation_set_validation_set_id_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_get) | **GET** /validation-set/{validationSetId} | Gets a validation set by the id.
-*ValidationSetApi* | [**validation_set_validation_set_id_rapid_files_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_rapid_files_post) | **POST** /validation-set/{validationSetId}/rapid/files | Adds a new validation rapid to the specified validation set using files to create the assets.
 *ValidationSetApi* | [**validation_set_validation_set_id_rapid_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_rapid_post) | **POST** /validation-set/{validationSetId}/rapid | Adds a new validation rapid to the specified validation set using files to create the assets.
-*ValidationSetApi* | [**validation_set_validation_set_id_rapid_texts_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_rapid_texts_post) | **POST** /validation-set/{validationSetId}/rapid/texts | Adds a new validation rapid to the specified validation set using text sources to create the assets.
 *ValidationSetApi* | [**validation_set_validation_set_id_rapids_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_rapids_get) | **GET** /validation-set/{validationSetId}/rapids | Queries the validation rapids for a specific validation set.
 *ValidationSetApi* | [**validation_set_validation_set_id_shouldalert_patch**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_shouldalert_patch) | **PATCH** /validation-set/{validationSetId}/shouldalert | Updates the dimensions of all rapids within a validation set.
 *ValidationSetApi* | [**validation_set_validation_set_id_shouldalert_put**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_shouldalert_put) | **PUT** /validation-set/{validationSetId}/shouldalert | Updates the  of all rapshouldAlert property of all rapids within a validation set.
+*ValidationSetApi* | [**validation_set_validation_set_id_update_labeling_hints_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_update_labeling_hints_post) | **POST** /validation-set/{validationSetId}/update-labeling-hints | Refreshes the labeling hints for a validation set.
+*ValidationSetApi* | [**validation_set_validation_set_id_visibility_patch**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_validation_set_id_visibility_patch) | **PATCH** /validation-set/{validationSetId}/visibility | Updates the visibility of a validation set.
 *ValidationSetApi* | [**validation_set_zip_compare_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_zip_compare_post) | **POST** /validation-set/zip/compare | Imports a compare validation set from a zip file.
 *ValidationSetApi* | [**validation_set_zip_post**](rapidata/api_client/docs/ValidationSetApi.md#validation_set_zip_post) | **POST** /validation-set/zip | Imports a validation set from a zip file.
 *ValidationSetApi* | [**validation_sets_available_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_sets_available_get) | **GET** /validation-sets/available | Gets the available validation sets for the current user.
-*ValidationSetApi* | [**validation_sets_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_sets_get) | **GET** /validation-sets | Queries validation sets based on the provided filter, paging and sorting criteria.
+*ValidationSetApi* | [**validation_sets_get**](rapidata/api_client/docs/ValidationSetApi.md#validation_sets_get) | **GET** /validation-sets | Queries available validation sets based on the provided filter, paging and sorting criteria.
 *WorkflowApi* | [**workflow_delete_delete**](rapidata/api_client/docs/WorkflowApi.md#workflow_delete_delete) | **DELETE** /workflow/delete | Deletes a workflow.
 *WorkflowApi* | [**workflow_workflow_id_compare_ab_summary_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_workflow_id_compare_ab_summary_get) | **GET** /workflow/{workflowId}/compare-ab-summary | Calculates a summary of the results for a simple compare workflow. The summary includes the number of times an asset at each index was the winner.
 *WorkflowApi* | [**workflow_workflow_id_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_workflow_id_get) | **GET** /workflow/{workflowId} | Get a workflow by its ID.
@@ -221,7 +223,6 @@ Class | Method | HTTP request | Description
  - [AddValidationRapidModelPayload](rapidata/api_client/docs/AddValidationRapidModelPayload.md)
  - [AddValidationRapidModelTruth](rapidata/api_client/docs/AddValidationRapidModelTruth.md)
  - [AddValidationRapidResult](rapidata/api_client/docs/AddValidationRapidResult.md)
- - [AddValidationTextRapidModel](rapidata/api_client/docs/AddValidationTextRapidModel.md)
  - [AgeGroup](rapidata/api_client/docs/AgeGroup.md)
  - [AgeUserFilterModel](rapidata/api_client/docs/AgeUserFilterModel.md)
  - [AggregatorType](rapidata/api_client/docs/AggregatorType.md)
@@ -383,6 +384,7 @@ Class | Method | HTTP request | Description
  - [GetPublicOrdersResult](rapidata/api_client/docs/GetPublicOrdersResult.md)
  - [GetPublicResponsesResult](rapidata/api_client/docs/GetPublicResponsesResult.md)
  - [GetRapidResponsesResult](rapidata/api_client/docs/GetRapidResponsesResult.md)
+ - [GetRecommendedValidationSetResult](rapidata/api_client/docs/GetRecommendedValidationSetResult.md)
  - [GetResponsesResult](rapidata/api_client/docs/GetResponsesResult.md)
  - [GetSampleByIdResult](rapidata/api_client/docs/GetSampleByIdResult.md)
  - [GetSimpleWorkflowResultsModel](rapidata/api_client/docs/GetSimpleWorkflowResultsModel.md)
@@ -428,7 +430,6 @@ Class | Method | HTTP request | Description
  - [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)
  - [MultiAsset](rapidata/api_client/docs/MultiAsset.md)
  - [MultiAssetInput](rapidata/api_client/docs/MultiAssetInput.md)
  - [MultiAssetInput1](rapidata/api_client/docs/MultiAssetInput1.md)
@@ -485,6 +486,7 @@ Class | Method | HTTP request | Description
  - [PrivateTextMetadataInput](rapidata/api_client/docs/PrivateTextMetadataInput.md)
  - [ProbabilisticAttachCategoryRefereeConfig](rapidata/api_client/docs/ProbabilisticAttachCategoryRefereeConfig.md)
  - [ProbabilisticAttachCategoryRefereeInfo](rapidata/api_client/docs/ProbabilisticAttachCategoryRefereeInfo.md)
+ - [ProblemDetails](rapidata/api_client/docs/ProblemDetails.md)
  - [PromptAssetMetadataInput](rapidata/api_client/docs/PromptAssetMetadataInput.md)
  - [PromptAssetMetadataInputAsset](rapidata/api_client/docs/PromptAssetMetadataInputAsset.md)
  - [PromptByBenchmarkResult](rapidata/api_client/docs/PromptByBenchmarkResult.md)
@@ -578,6 +580,7 @@ Class | Method | HTTP request | Description
  - [UpdateBenchmarkNameModel](rapidata/api_client/docs/UpdateBenchmarkNameModel.md)
  - [UpdateDatasetNameModel](rapidata/api_client/docs/UpdateDatasetNameModel.md)
  - [UpdateDimensionsModel](rapidata/api_client/docs/UpdateDimensionsModel.md)
+ - [UpdateLeaderboardModel](rapidata/api_client/docs/UpdateLeaderboardModel.md)
  - [UpdateLeaderboardNameModel](rapidata/api_client/docs/UpdateLeaderboardNameModel.md)
  - [UpdateLeaderboardResponseConfigModel](rapidata/api_client/docs/UpdateLeaderboardResponseConfigModel.md)
  - [UpdateOrderNameModel](rapidata/api_client/docs/UpdateOrderNameModel.md)

rapidata/rapidata_client/__init__.py

@@ -6,7 +6,7 @@ from .selection import (
     ConditionalValidationSelection,
     CappedSelection,
     ShufflingSelection,
-    RetrievalMode,
+    RapidataRetrievalMode,
     EffortSelection,
 )
 from .datapoints import Datapoint

rapidata/rapidata_client/benchmark/participant/_participant.py

@@ -7,7 +7,7 @@ from rapidata.rapidata_client.logging import logger
 from rapidata.rapidata_client.logging.output_manager import RapidataOutputManager
 from rapidata.api_client.models.create_sample_model import CreateSampleModel
 from rapidata.service.openapi_service import OpenAPIService
-from rapidata.rapidata_client.config.config import rapidata_config
+from rapidata.rapidata_client.config.rapidata_config import rapidata_config
 from rapidata.rapidata_client.api.rapidata_exception import (
     suppress_rapidata_error_logging,
 )
@@ -42,7 +42,7 @@ class BenchmarkParticipant:
             urls = [asset.path]
 
         last_exception = None
-        for attempt in range(rapidata_config.upload_max_retries):
+        for attempt in range(rapidata_config.uploadMaxRetries):
             try:
                 with suppress_rapidata_error_logging():
                     self.__openapi_service.participant_api.participant_participant_id_sample_post(
@@ -56,7 +56,7 @@ class BenchmarkParticipant:
 
             except Exception as e:
                 last_exception = e
-                if attempt < rapidata_config.upload_max_retries - 1:
+                if attempt < rapidata_config.uploadMaxRetries - 1:
                     # Exponential backoff: wait 1s, then 2s, then 4s
                     retry_delay = 2**attempt
                     time.sleep(retry_delay)
@@ -64,7 +64,7 @@ class BenchmarkParticipant:
                     logger.debug(
                         "Retrying %s of %s...",
                         attempt + 1,
-                        rapidata_config.upload_max_retries,
+                        rapidata_config.uploadMaxRetries,
                     )
 
         logger.error(f"Upload failed for {identifier}. Error: {str(last_exception)}")
@@ -90,7 +90,7 @@ class BenchmarkParticipant:
         total_uploads = len(assets)
 
         with ThreadPoolExecutor(
-            max_workers=rapidata_config.max_upload_workers
+            max_workers=rapidata_config.maxUploadWorkers
         ) as executor:
             futures = [
                 executor.submit(

rapidata/rapidata_client/benchmark/rapidata_benchmark.py

@@ -18,6 +18,7 @@ from rapidata.api_client.models.source_url_metadata_model import SourceUrlMetada
 from rapidata.api_client.models.and_user_filter_model_filters_inner import (
     AndUserFilterModelFiltersInner,
 )
+from rapidata.api_client.models.filter_operator import FilterOperator
 
 from rapidata.rapidata_client.benchmark.participant._participant import (
     BenchmarkParticipant,
@@ -150,7 +151,7 @@ class RapidataBenchmark:
                                 filters=[
                                     Filter(
                                         field="BenchmarkId",
-                                        operator="Eq",
+                                        operator=FilterOperator.EQ,
                                         value=self.id,
                                     )
                                 ]

rapidata/rapidata_client/benchmark/rapidata_benchmark_manager.py

@@ -7,6 +7,8 @@ from rapidata.api_client.models.page_info import PageInfo
 from rapidata.api_client.models.root_filter import RootFilter
 from rapidata.api_client.models.filter import Filter
 from rapidata.api_client.models.sort_criterion import SortCriterion
+from rapidata.api_client.models.sort_direction import SortDirection
+from rapidata.api_client.models.filter_operator import FilterOperator
 
 
 class RapidataBenchmarkManager:
@@ -139,10 +141,16 @@ class RapidataBenchmarkManager:
             QueryModel(
                 page=PageInfo(index=1, size=amount),
                 filter=RootFilter(
-                    filters=[Filter(field="Name", operator="Contains", value=name)]
+                    filters=[
+                        Filter(
+                            field="Name", operator=FilterOperator.CONTAINS, value=name
+                        )
+                    ]
                 ),
                 sortCriteria=[
-                    SortCriterion(direction="Desc", propertyName="CreatedAt")
+                    SortCriterion(
+                        direction=SortDirection.DESC, propertyName="CreatedAt"
+                    )
                 ],
             )
         )

rapidata/rapidata_client/config/__init__.py

@@ -1 +1 @@
-from .config import rapidata_config
+from .rapidata_config import rapidata_config

rapidata/rapidata_client/config/rapidata_config.py

@@ -0,0 +1,31 @@
+from pydantic import BaseModel, Field
+
+
+class RapidataConfig(BaseModel):
+    """
+    Holds the configuration for the Rapidata client.
+
+    To adjust the configurations used, you can modify the `rapidata_config` object.
+
+    Args:
+        maxUploadWorkers (int): The maximum number of worker threads for processing media paths. Defaults to 10.
+        uploadMaxRetries (int): The maximum number of retries for failed uploads. Defaults to 3.
+        enableBetaFeatures (bool): Whether to enable beta features. Defaults to False.
+        minOrderDatapointsForValidation (int): The minimum number of datapoints required so that an automatic validationset gets created if no recommended was found. Defaults to 50.
+        autoValidationSetSize (int): The maximum size of the auto-generated validation set. Defaults to 20.
+
+    Example:
+        ```python
+        from rapidata import rapidata_config
+        rapidata_config.maxUploadWorkers = 20
+        ```
+    """
+
+    maxUploadWorkers: int = Field(default=10)
+    uploadMaxRetries: int = Field(default=3)
+    enableBetaFeatures: bool = False
+    minOrderDatapointsForValidation: int = Field(default=50)
+    autoValidationSetSize: int = Field(default=20)
+
+
+rapidata_config = RapidataConfig()

rapidata/rapidata_client/datapoints/__init__.py

@@ -1,3 +1,11 @@
-from .datapoint import Datapoint
+from ._datapoint import Datapoint
 from .assets import MediaAsset, MultiAsset, TextAsset
-from .metadata import Metadata, PromptMetadata, PrivateTextMetadata, PublicTextMetadata, SelectWordsMetadata, MediaAssetMetadata, PromptIdentifierMetadata
+from .metadata import (
+    Metadata,
+    PromptMetadata,
+    PrivateTextMetadata,
+    PublicTextMetadata,
+    SelectWordsMetadata,
+    MediaAssetMetadata,
+    PromptIdentifierMetadata,
+)