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

rapidata/api_client/models/__init__.py

@@ -21,7 +21,6 @@ from rapidata.api_client.models.add_validation_rapid_model import AddValidationR
 from rapidata.api_client.models.add_validation_rapid_model_payload import AddValidationRapidModelPayload
 from rapidata.api_client.models.add_validation_rapid_model_truth import AddValidationRapidModelTruth
 from rapidata.api_client.models.add_validation_rapid_result import AddValidationRapidResult
-from rapidata.api_client.models.add_validation_text_rapid_model import AddValidationTextRapidModel
 from rapidata.api_client.models.age_group import AgeGroup
 from rapidata.api_client.models.age_user_filter_model import AgeUserFilterModel
 from rapidata.api_client.models.aggregator_type import AggregatorType
@@ -33,6 +32,7 @@ from rapidata.api_client.models.are_rapids_active_result import AreRapidsActiveR
 from rapidata.api_client.models.asset_metadata import AssetMetadata
 from rapidata.api_client.models.asset_metadata_asset import AssetMetadataAsset
 from rapidata.api_client.models.asset_metadata_model import AssetMetadataModel
+from rapidata.api_client.models.asset_type import AssetType
 from rapidata.api_client.models.attach_category_rapid_blueprint import AttachCategoryRapidBlueprint
 from rapidata.api_client.models.attach_category_result import AttachCategoryResult
 from rapidata.api_client.models.attach_category_truth import AttachCategoryTruth
@@ -292,6 +292,7 @@ from rapidata.api_client.models.prompt_by_benchmark_result_paged_result import P
 from rapidata.api_client.models.prompt_metadata import PromptMetadata
 from rapidata.api_client.models.prompt_metadata_input import PromptMetadataInput
 from rapidata.api_client.models.prompt_metadata_model import PromptMetadataModel
+from rapidata.api_client.models.prompt_type import PromptType
 from rapidata.api_client.models.proxy_file_wrapper import ProxyFileWrapper
 from rapidata.api_client.models.public_order_model import PublicOrderModel
 from rapidata.api_client.models.public_rapid_response import PublicRapidResponse
@@ -299,6 +300,7 @@ from rapidata.api_client.models.public_text_metadata_input import PublicTextMeta
 from rapidata.api_client.models.query_model import QueryModel
 from rapidata.api_client.models.query_validation_model import QueryValidationModel
 from rapidata.api_client.models.rapid_issue import RapidIssue
+from rapidata.api_client.models.rapid_modality import RapidModality
 from rapidata.api_client.models.rapid_model import RapidModel
 from rapidata.api_client.models.rapid_model_paged_result import RapidModelPagedResult
 from rapidata.api_client.models.rapid_model_referee import RapidModelReferee
@@ -378,6 +380,7 @@ from rapidata.api_client.models.unlock_order_result import UnlockOrderResult
 from rapidata.api_client.models.update_benchmark_name_model import UpdateBenchmarkNameModel
 from rapidata.api_client.models.update_dataset_name_model import UpdateDatasetNameModel
 from rapidata.api_client.models.update_dimensions_model import UpdateDimensionsModel
+from rapidata.api_client.models.update_leaderboard_model import UpdateLeaderboardModel
 from rapidata.api_client.models.update_leaderboard_name_model import UpdateLeaderboardNameModel
 from rapidata.api_client.models.update_leaderboard_response_config_model import UpdateLeaderboardResponseConfigModel
 from rapidata.api_client.models.update_order_name_model import UpdateOrderNameModel

rapidata/api_client/models/add_validation_rapid_model.py

@@ -30,8 +30,8 @@ class AddValidationRapidModel(BaseModel):
     The model for adding a validation rapid.
     """ # noqa: E501
     payload: AddValidationRapidModelPayload
-    metadata: List[DatasetDatasetIdDatapointsPostRequestMetadataInner] = Field(description="Some metadata to attach to the rapid.")
-    truth: AddValidationRapidModelTruth
+    metadata: Optional[List[DatasetDatasetIdDatapointsPostRequestMetadataInner]] = Field(default=None, description="Some metadata to attach to the rapid.")
+    truth: Optional[AddValidationRapidModelTruth] = None
     random_correct_probability: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The probability for an answer to be correct when randomly guessing.", alias="randomCorrectProbability")
     explanation: Optional[StrictStr] = Field(default=None, description="An explanation for the users if they answer the rapid incorrectly.")
     __properties: ClassVar[List[str]] = ["payload", "metadata", "truth", "randomCorrectProbability", "explanation"]
@@ -88,6 +88,16 @@ class AddValidationRapidModel(BaseModel):
         # 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 metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.metadata is None and "metadata" in self.model_fields_set:
+            _dict['metadata'] = None
+
+        # set to None if truth (nullable) is None
+        # and model_fields_set contains the field
+        if self.truth is None and "truth" in self.model_fields_set:
+            _dict['truth'] = 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:

rapidata/api_client/models/add_validation_rapid_model_truth.py

@@ -87,6 +87,9 @@ class AddValidationRapidModelTruth(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_oneof(cls, v):
+        if v is None:
+            return v
+
         instance = AddValidationRapidModelTruth.model_construct()
         error_messages = []
         match = 0
@@ -164,9 +167,12 @@ class AddValidationRapidModelTruth(BaseModel):
         return cls.from_json(json.dumps(obj))
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: Optional[str]) -> Self:
         """Returns the object represented by the json string"""
         instance = cls.model_construct()
+        if json_str is None:
+            return instance
+
         error_messages = []
         match = 0
 

rapidata/api_client/models/asset_type.py

@@ -0,0 +1,40 @@
+# 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
+from enum import Enum
+from typing_extensions import Self
+
+
+class AssetType(str, Enum):
+    """
+    AssetType
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = 'None'
+    IMAGE = 'Image'
+    VIDEO = 'Video'
+    AUDIO = 'Audio'
+    TEXT = 'Text'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AssetType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/prompt_type.py

@@ -0,0 +1,38 @@
+# 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
+from enum import Enum
+from typing_extensions import Self
+
+
+class PromptType(str, Enum):
+    """
+    PromptType
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = 'None'
+    TEXT = 'Text'
+    ASSET = 'Asset'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of PromptType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

rapidata/api_client/models/rapid_modality.py

@@ -0,0 +1,46 @@
+# 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
+from enum import Enum
+from typing_extensions import Self
+
+
+class RapidModality(str, Enum):
+    """
+    RapidModality
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = 'None'
+    BOUNDINGBOX = 'BoundingBox'
+    CLASSIFY = 'Classify'
+    COMPARE = 'Compare'
+    FREETEXT = 'FreeText'
+    LINE = 'Line'
+    LOCATE = 'Locate'
+    NAMEDENTITY = 'NamedEntity'
+    POLYGON = 'Polygon'
+    SCRUB = 'Scrub'
+    TRANSCRIPTION = 'Transcription'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RapidModality from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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/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,43 @@ class ValidationSetModel(BaseModel):
     """ # noqa: E501
     id: StrictStr
     name: StrictStr
+    asset_type: Optional[StrictStr] = Field(default=None, alias="assetType")
+    modality: Optional[StrictStr] = None
+    prompt_type: Optional[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
+
+        if value not in set(['None', 'Image', 'Video', 'Audio', 'Text']):
+            raise ValueError("must be one of enum values ('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
+
+        if value not in set(['None', 'BoundingBox', 'Classify', 'Compare', 'FreeText', 'Line', 'Locate', 'NamedEntity', 'Polygon', 'Scrub', 'Transcription']):
+            raise ValueError("must be one of enum values ('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
+
+        if value not in set(['None', 'Text', 'Asset']):
+            raise ValueError("must be one of enum values ('None', 'Text', 'Asset')")
+        return value
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -73,6 +106,21 @@ class ValidationSetModel(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # set to None if asset_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.asset_type is None and "asset_type" in self.model_fields_set:
+            _dict['assetType'] = None
+
+        # set to None if modality (nullable) is None
+        # and model_fields_set contains the field
+        if self.modality is None and "modality" in self.model_fields_set:
+            _dict['modality'] = None
+
+        # set to None if prompt_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.prompt_type is None and "prompt_type" in self.model_fields_set:
+            _dict['promptType'] = None
+
         return _dict
 
     @classmethod
@@ -87,6 +135,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_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)
@@ -233,6 +234,7 @@ Class | Method | HTTP request | Description
  - [AssetMetadata](rapidata/api_client/docs/AssetMetadata.md)
  - [AssetMetadataAsset](rapidata/api_client/docs/AssetMetadataAsset.md)
  - [AssetMetadataModel](rapidata/api_client/docs/AssetMetadataModel.md)
+ - [AssetType](rapidata/api_client/docs/AssetType.md)
  - [AttachCategoryRapidBlueprint](rapidata/api_client/docs/AttachCategoryRapidBlueprint.md)
  - [AttachCategoryResult](rapidata/api_client/docs/AttachCategoryResult.md)
  - [AttachCategoryTruth](rapidata/api_client/docs/AttachCategoryTruth.md)
@@ -492,6 +494,7 @@ Class | Method | HTTP request | Description
  - [PromptMetadata](rapidata/api_client/docs/PromptMetadata.md)
  - [PromptMetadataInput](rapidata/api_client/docs/PromptMetadataInput.md)
  - [PromptMetadataModel](rapidata/api_client/docs/PromptMetadataModel.md)
+ - [PromptType](rapidata/api_client/docs/PromptType.md)
  - [ProxyFileWrapper](rapidata/api_client/docs/ProxyFileWrapper.md)
  - [PublicOrderModel](rapidata/api_client/docs/PublicOrderModel.md)
  - [PublicRapidResponse](rapidata/api_client/docs/PublicRapidResponse.md)
@@ -499,6 +502,7 @@ Class | Method | HTTP request | Description
  - [QueryModel](rapidata/api_client/docs/QueryModel.md)
  - [QueryValidationModel](rapidata/api_client/docs/QueryValidationModel.md)
  - [RapidIssue](rapidata/api_client/docs/RapidIssue.md)
+ - [RapidModality](rapidata/api_client/docs/RapidModality.md)
  - [RapidModel](rapidata/api_client/docs/RapidModel.md)
  - [RapidModelPagedResult](rapidata/api_client/docs/RapidModelPagedResult.md)
  - [RapidModelReferee](rapidata/api_client/docs/RapidModelReferee.md)
@@ -578,6 +582,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/workflow/_free_text_workflow.py

@@ -1,6 +1,8 @@
 from typing import Any
 from rapidata.api_client.models.simple_workflow_model import SimpleWorkflowModel
-from rapidata.api_client.models.simple_workflow_model_blueprint import SimpleWorkflowModelBlueprint
+from rapidata.api_client.models.simple_workflow_model_blueprint import (
+    SimpleWorkflowModelBlueprint,
+)
 from rapidata.rapidata_client.workflow import Workflow
 from rapidata.api_client.models.free_text_rapid_blueprint import FreeTextRapidBlueprint
 
@@ -17,11 +19,14 @@ class FreeTextWorkflow(Workflow):
 
     Args:
         instruction (str): The instruction to be presented for free text input.
+        validation_system_prompt (str): The system prompt to determine if the provided free text response is spam or not.
+            Should always specify that the LLM should respond with 'not spam' or 'spam'.
     """
 
-    def __init__(self, instruction: str):
+    def __init__(self, instruction: str, validation_system_prompt: str | None = None):
         super().__init__(type="SimpleWorkflowConfig")
         self._instruction = instruction
+        self._validation_system_prompt = validation_system_prompt
 
     def _to_dict(self) -> dict[str, Any]:
         return {
@@ -29,6 +34,7 @@ class FreeTextWorkflow(Workflow):
             "blueprint": {
                 "_t": "FreeTextBlueprint",
                 "question": self._instruction,
+                "validationSystemPrompt": self._validation_system_prompt,
             },
         }
 
@@ -36,6 +42,7 @@ class FreeTextWorkflow(Workflow):
         blueprint = FreeTextRapidBlueprint(
             _t="FreeTextBlueprint",
             question=self._instruction,
+            validationSystemPrompt=self._validation_system_prompt,
         )
 
         return SimpleWorkflowModel(

{rapidata-2.36.0.dist-info → rapidata-2.36.1.dist-info}/METADATA

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