rapidata 2.42.1__py3-none-any.whl → 2.42.3__py3-none-any.whl

rapidata/api_client/models/grouped_ranking_workflow_model1.py

@@ -0,0 +1,121 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.compare_workflow_model1_referee import CompareWorkflowModel1Referee
+from rapidata.api_client.models.elo_config import EloConfig
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GroupedRankingWorkflowModel1(BaseModel):
+    """
+    GroupedRankingWorkflowModel1
+    """ # noqa: E501
+    t: StrictStr = Field(description="Discriminator value for GroupedRankingWorkflowModel", alias="_t")
+    id: StrictStr
+    referee: CompareWorkflowModel1Referee
+    state: StrictStr
+    criteria: StrictStr
+    name: StrictStr
+    owner_mail: Optional[StrictStr] = Field(default=None, alias="ownerMail")
+    elo_config: EloConfig = Field(alias="eloConfig")
+    __properties: ClassVar[List[str]] = ["_t", "id", "referee", "state", "criteria", "name", "ownerMail", "eloConfig"]
+
+    @field_validator('t')
+    def t_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['GroupedRankingWorkflowModel']):
+            raise ValueError("must be one of enum values ('GroupedRankingWorkflowModel')")
+        return value
+
+    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 GroupedRankingWorkflowModel1 from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of referee
+        if self.referee:
+            _dict['referee'] = self.referee.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of elo_config
+        if self.elo_config:
+            _dict['eloConfig'] = self.elo_config.to_dict()
+        # set to None if owner_mail (nullable) is None
+        # and model_fields_set contains the field
+        if self.owner_mail is None and "owner_mail" in self.model_fields_set:
+            _dict['ownerMail'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GroupedRankingWorkflowModel1 from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "_t": obj.get("_t") if obj.get("_t") is not None else 'GroupedRankingWorkflowModel',
+            "id": obj.get("id"),
+            "referee": CompareWorkflowModel1Referee.from_dict(obj["referee"]) if obj.get("referee") is not None else None,
+            "state": obj.get("state"),
+            "criteria": obj.get("criteria"),
+            "name": obj.get("name"),
+            "ownerMail": obj.get("ownerMail"),
+            "eloConfig": EloConfig.from_dict(obj["eloConfig"]) if obj.get("eloConfig") is not None else None
+        })
+        return _obj
+
+

rapidata/api_client/models/multi_asset.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.file_asset_metadata_value import FileAssetMetadataValue
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,7 +28,7 @@ class MultiAsset(BaseModel):
     MultiAsset
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for MultiAsset", alias="_t")
-    assets: List[AssetMetadataAsset]
+    assets: List[MultiAssetAssetsInner]
     metadata: Optional[Dict[str, FileAssetMetadataValue]] = None
     __properties: ClassVar[List[str]] = ["_t", "assets", "metadata"]
 
@@ -104,7 +105,7 @@ class MultiAsset(BaseModel):
 
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'MultiAsset',
-            "assets": [AssetMetadataAsset.from_dict(_item) for _item in obj["assets"]] if obj.get("assets") is not None else None,
+            "assets": [MultiAssetAssetsInner.from_dict(_item) for _item in obj["assets"]] if obj.get("assets") is not None else None,
             "metadata": dict(
                 (_k, FileAssetMetadataValue.from_dict(_v))
                 for _k, _v in obj["metadata"].items()
@@ -114,8 +115,7 @@ class MultiAsset(BaseModel):
         })
         return _obj
 
-from rapidata.api_client.models.asset_metadata_asset import AssetMetadataAsset
-from rapidata.api_client.models.file_asset_metadata_value import FileAssetMetadataValue
+from rapidata.api_client.models.multi_asset_assets_inner import MultiAssetAssetsInner
 # TODO: Rewrite to not use raise_errors
 MultiAsset.model_rebuild(raise_errors=False)
 

rapidata/api_client/models/multi_asset_assets_inner.py

@@ -0,0 +1,170 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from rapidata.api_client.models.file_asset import FileAsset
+from rapidata.api_client.models.null_asset import NullAsset
+from rapidata.api_client.models.text_asset import TextAsset
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+MULTIASSETASSETSINNER_ONE_OF_SCHEMAS = ["FileAsset", "MultiAsset", "NullAsset", "TextAsset"]
+
+class MultiAssetAssetsInner(BaseModel):
+    """
+    MultiAssetAssetsInner
+    """
+    # data type: FileAsset
+    oneof_schema_1_validator: Optional[FileAsset] = None
+    # data type: MultiAsset
+    oneof_schema_2_validator: Optional[MultiAsset] = None
+    # data type: NullAsset
+    oneof_schema_3_validator: Optional[NullAsset] = None
+    # data type: TextAsset
+    oneof_schema_4_validator: Optional[TextAsset] = None
+    actual_instance: Optional[Union[FileAsset, MultiAsset, NullAsset, TextAsset]] = None
+    one_of_schemas: Set[str] = { "FileAsset", "MultiAsset", "NullAsset", "TextAsset" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    discriminator_value_class_map: Dict[str, str] = {
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = MultiAssetAssetsInner.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: FileAsset
+        if not isinstance(v, FileAsset):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `FileAsset`")
+        else:
+            match += 1
+        # validate data type: MultiAsset
+        if not isinstance(v, MultiAsset):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `MultiAsset`")
+        else:
+            match += 1
+        # validate data type: NullAsset
+        if not isinstance(v, NullAsset):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NullAsset`")
+        else:
+            match += 1
+        # validate data type: TextAsset
+        if not isinstance(v, TextAsset):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TextAsset`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in MultiAssetAssetsInner with oneOf schemas: FileAsset, MultiAsset, NullAsset, TextAsset. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in MultiAssetAssetsInner with oneOf schemas: FileAsset, MultiAsset, NullAsset, TextAsset. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into FileAsset
+        try:
+            instance.actual_instance = FileAsset.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into MultiAsset
+        try:
+            instance.actual_instance = MultiAsset.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into NullAsset
+        try:
+            instance.actual_instance = NullAsset.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into TextAsset
+        try:
+            instance.actual_instance = TextAsset.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into MultiAssetAssetsInner with oneOf schemas: FileAsset, MultiAsset, NullAsset, TextAsset. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into MultiAssetAssetsInner with oneOf schemas: FileAsset, MultiAsset, NullAsset, TextAsset. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], FileAsset, MultiAsset, NullAsset, TextAsset]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+from rapidata.api_client.models.multi_asset import MultiAsset
+# TODO: Rewrite to not use raise_errors
+MultiAssetAssetsInner.model_rebuild(raise_errors=False)
+

rapidata/api_client/models/null_asset.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.file_asset_metadata_value import FileAssetMetadataValue
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -105,7 +106,4 @@ class NullAsset(BaseModel):
         })
         return _obj
 
-from rapidata.api_client.models.file_asset_metadata_value import FileAssetMetadataValue
-# TODO: Rewrite to not use raise_errors
-NullAsset.model_rebuild(raise_errors=False)
 

rapidata/api_client/models/text_asset.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.file_asset_metadata_value import FileAssetMetadataValue
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -107,7 +108,4 @@ class TextAsset(BaseModel):
         })
         return _obj
 
-from rapidata.api_client.models.file_asset_metadata_value import FileAssetMetadataValue
-# TODO: Rewrite to not use raise_errors
-TextAsset.model_rebuild(raise_errors=False)
 

rapidata/api_client/models/workflow_config_artifact_model_workflow_config.py

@@ -19,12 +19,13 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, f
 from typing import Any, List, Optional
 from rapidata.api_client.models.compare_workflow_config import CompareWorkflowConfig
 from rapidata.api_client.models.evaluation_workflow_config import EvaluationWorkflowConfig
+from rapidata.api_client.models.grouped_ranking_workflow_config import GroupedRankingWorkflowConfig
 from rapidata.api_client.models.simple_workflow_config import SimpleWorkflowConfig
 from pydantic import StrictStr, Field
 from typing import Union, List, Set, Optional, Dict
 from typing_extensions import Literal, Self
 
-WORKFLOWCONFIGARTIFACTMODELWORKFLOWCONFIG_ONE_OF_SCHEMAS = ["CompareWorkflowConfig", "EvaluationWorkflowConfig", "SimpleWorkflowConfig"]
+WORKFLOWCONFIGARTIFACTMODELWORKFLOWCONFIG_ONE_OF_SCHEMAS = ["CompareWorkflowConfig", "EvaluationWorkflowConfig", "GroupedRankingWorkflowConfig", "SimpleWorkflowConfig"]
 
 class WorkflowConfigArtifactModelWorkflowConfig(BaseModel):
     """
@@ -34,10 +35,12 @@ class WorkflowConfigArtifactModelWorkflowConfig(BaseModel):
     oneof_schema_1_validator: Optional[CompareWorkflowConfig] = None
     # data type: EvaluationWorkflowConfig
     oneof_schema_2_validator: Optional[EvaluationWorkflowConfig] = None
+    # data type: GroupedRankingWorkflowConfig
+    oneof_schema_3_validator: Optional[GroupedRankingWorkflowConfig] = None
     # data type: SimpleWorkflowConfig
-    oneof_schema_3_validator: Optional[SimpleWorkflowConfig] = None
-    actual_instance: Optional[Union[CompareWorkflowConfig, EvaluationWorkflowConfig, SimpleWorkflowConfig]] = None
-    one_of_schemas: Set[str] = { "CompareWorkflowConfig", "EvaluationWorkflowConfig", "SimpleWorkflowConfig" }
+    oneof_schema_4_validator: Optional[SimpleWorkflowConfig] = None
+    actual_instance: Optional[Union[CompareWorkflowConfig, EvaluationWorkflowConfig, GroupedRankingWorkflowConfig, SimpleWorkflowConfig]] = None
+    one_of_schemas: Set[str] = { "CompareWorkflowConfig", "EvaluationWorkflowConfig", "GroupedRankingWorkflowConfig", "SimpleWorkflowConfig" }
 
     model_config = ConfigDict(
         validate_assignment=True,
@@ -73,6 +76,11 @@ class WorkflowConfigArtifactModelWorkflowConfig(BaseModel):
             error_messages.append(f"Error! Input type `{type(v)}` is not `EvaluationWorkflowConfig`")
         else:
             match += 1
+        # validate data type: GroupedRankingWorkflowConfig
+        if not isinstance(v, GroupedRankingWorkflowConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `GroupedRankingWorkflowConfig`")
+        else:
+            match += 1
         # validate data type: SimpleWorkflowConfig
         if not isinstance(v, SimpleWorkflowConfig):
             error_messages.append(f"Error! Input type `{type(v)}` is not `SimpleWorkflowConfig`")
@@ -80,10 +88,10 @@ class WorkflowConfigArtifactModelWorkflowConfig(BaseModel):
             match += 1
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when setting `actual_instance` in WorkflowConfigArtifactModelWorkflowConfig with oneOf schemas: CompareWorkflowConfig, EvaluationWorkflowConfig, SimpleWorkflowConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when setting `actual_instance` in WorkflowConfigArtifactModelWorkflowConfig with oneOf schemas: CompareWorkflowConfig, EvaluationWorkflowConfig, GroupedRankingWorkflowConfig, SimpleWorkflowConfig. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when setting `actual_instance` in WorkflowConfigArtifactModelWorkflowConfig with oneOf schemas: CompareWorkflowConfig, EvaluationWorkflowConfig, SimpleWorkflowConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting `actual_instance` in WorkflowConfigArtifactModelWorkflowConfig with oneOf schemas: CompareWorkflowConfig, EvaluationWorkflowConfig, GroupedRankingWorkflowConfig, SimpleWorkflowConfig. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -110,6 +118,12 @@ class WorkflowConfigArtifactModelWorkflowConfig(BaseModel):
             match += 1
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
+        # deserialize data into GroupedRankingWorkflowConfig
+        try:
+            instance.actual_instance = GroupedRankingWorkflowConfig.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
         # deserialize data into SimpleWorkflowConfig
         try:
             instance.actual_instance = SimpleWorkflowConfig.from_json(json_str)
@@ -119,10 +133,10 @@ class WorkflowConfigArtifactModelWorkflowConfig(BaseModel):
 
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when deserializing the JSON string into WorkflowConfigArtifactModelWorkflowConfig with oneOf schemas: CompareWorkflowConfig, EvaluationWorkflowConfig, SimpleWorkflowConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when deserializing the JSON string into WorkflowConfigArtifactModelWorkflowConfig with oneOf schemas: CompareWorkflowConfig, EvaluationWorkflowConfig, GroupedRankingWorkflowConfig, SimpleWorkflowConfig. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into WorkflowConfigArtifactModelWorkflowConfig with oneOf schemas: CompareWorkflowConfig, EvaluationWorkflowConfig, SimpleWorkflowConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into WorkflowConfigArtifactModelWorkflowConfig with oneOf schemas: CompareWorkflowConfig, EvaluationWorkflowConfig, GroupedRankingWorkflowConfig, SimpleWorkflowConfig. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -136,7 +150,7 @@ class WorkflowConfigArtifactModelWorkflowConfig(BaseModel):
         else:
             return json.dumps(self.actual_instance)
 
-    def to_dict(self) -> Optional[Union[Dict[str, Any], CompareWorkflowConfig, EvaluationWorkflowConfig, SimpleWorkflowConfig]]:
+    def to_dict(self) -> Optional[Union[Dict[str, Any], CompareWorkflowConfig, EvaluationWorkflowConfig, GroupedRankingWorkflowConfig, SimpleWorkflowConfig]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None

rapidata/api_client_README.md

@@ -128,6 +128,7 @@ Class | Method | HTTP request | Description
 *DatasetApi* | [**dataset_dataset_id_progress_get**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_progress_get) | **GET** /dataset/{datasetId}/progress | Gets the upload progress of 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_post**](rapidata/api_client/docs/FeedbackApi.md#feedback_post) | **POST** /feedback | Submits feedback about our services.
+*GroupedRankingWorkflowApi* | [**workflow_grouped_ranking_workflow_id_results_get**](rapidata/api_client/docs/GroupedRankingWorkflowApi.md#workflow_grouped_ranking_workflow_id_results_get) | **GET** /workflow/grouped-ranking/{workflowId}/results | Get the result overview for a multi compare workflow.
 *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_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.
@@ -228,7 +229,6 @@ Class | Method | HTTP request | Description
  - [AndUserFilterModelFiltersInner](rapidata/api_client/docs/AndUserFilterModelFiltersInner.md)
  - [AreRapidsActiveResult](rapidata/api_client/docs/AreRapidsActiveResult.md)
  - [AssetMetadata](rapidata/api_client/docs/AssetMetadata.md)
- - [AssetMetadataAsset](rapidata/api_client/docs/AssetMetadataAsset.md)
  - [AssetMetadataModel](rapidata/api_client/docs/AssetMetadataModel.md)
  - [AttachCategoryRapidBlueprint](rapidata/api_client/docs/AttachCategoryRapidBlueprint.md)
  - [AttachCategoryResult](rapidata/api_client/docs/AttachCategoryResult.md)
@@ -378,6 +378,9 @@ Class | Method | HTTP request | Description
  - [GetDatasetProgressResult](rapidata/api_client/docs/GetDatasetProgressResult.md)
  - [GetEvaluationWorkflowResultsModel](rapidata/api_client/docs/GetEvaluationWorkflowResultsModel.md)
  - [GetFailedDatapointsResult](rapidata/api_client/docs/GetFailedDatapointsResult.md)
+ - [GetGroupedRankingWorkflowResultsModel](rapidata/api_client/docs/GetGroupedRankingWorkflowResultsModel.md)
+ - [GetGroupedRankingWorkflowResultsResult](rapidata/api_client/docs/GetGroupedRankingWorkflowResultsResult.md)
+ - [GetGroupedRankingWorkflowResultsResultPagedResult](rapidata/api_client/docs/GetGroupedRankingWorkflowResultsResultPagedResult.md)
  - [GetLeaderboardByIdResult](rapidata/api_client/docs/GetLeaderboardByIdResult.md)
  - [GetOrderByIdResult](rapidata/api_client/docs/GetOrderByIdResult.md)
  - [GetParticipantByIdResult](rapidata/api_client/docs/GetParticipantByIdResult.md)
@@ -403,6 +406,9 @@ Class | Method | HTTP request | Description
  - [GetWorkflowResultsResult](rapidata/api_client/docs/GetWorkflowResultsResult.md)
  - [GetWorkflowResultsResultPagedResult](rapidata/api_client/docs/GetWorkflowResultsResultPagedResult.md)
  - [GoogleOneTapLoginModel](rapidata/api_client/docs/GoogleOneTapLoginModel.md)
+ - [GroupedRankingWorkflowConfig](rapidata/api_client/docs/GroupedRankingWorkflowConfig.md)
+ - [GroupedRankingWorkflowModel](rapidata/api_client/docs/GroupedRankingWorkflowModel.md)
+ - [GroupedRankingWorkflowModel1](rapidata/api_client/docs/GroupedRankingWorkflowModel1.md)
  - [IWorkflowModelPagedResult](rapidata/api_client/docs/IWorkflowModelPagedResult.md)
  - [ImageDimensionMetadata](rapidata/api_client/docs/ImageDimensionMetadata.md)
  - [ImageDimensionMetadataModel](rapidata/api_client/docs/ImageDimensionMetadataModel.md)
@@ -431,6 +437,7 @@ Class | Method | HTTP request | Description
  - [LocationMetadataModel](rapidata/api_client/docs/LocationMetadataModel.md)
  - [LogicOperator](rapidata/api_client/docs/LogicOperator.md)
  - [MultiAsset](rapidata/api_client/docs/MultiAsset.md)
+ - [MultiAssetAssetsInner](rapidata/api_client/docs/MultiAssetAssetsInner.md)
  - [MultiAssetInput](rapidata/api_client/docs/MultiAssetInput.md)
  - [MultiAssetInputAssetsInner](rapidata/api_client/docs/MultiAssetInputAssetsInner.md)
  - [MultiAssetModel](rapidata/api_client/docs/MultiAssetModel.md)

rapidata/rapidata_client/order/_rapidata_order_builder.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional, Sequence
+from typing import Literal, Optional, Sequence, get_args
 import random
 import urllib.parse
 import webbrowser
@@ -43,6 +43,8 @@ from rapidata.rapidata_client.api.rapidata_api_client import (
     suppress_rapidata_error_logging,
 )
 
+StickyStateLiteral = Literal["Temporary", "Permanent", "Passive"]
+
 
 class RapidataOrderBuilder:
     """Builder object for creating Rapidata orders.
@@ -71,9 +73,7 @@ class RapidataOrderBuilder:
         self.__selections: list[RapidataSelection] = []
         self.__priority: int | None = None
         self.__datapoints: list[Datapoint] = []
-        self.__sticky_state_value: Literal["None", "Temporary", "Permanent"] | None = (
-            None
-        )
+        self.__sticky_state_value: StickyStateLiteral | None = None
         self.__validation_set_manager: ValidationSetManager = ValidationSetManager(
             self.__openapi_service
         )
@@ -147,6 +147,7 @@ class RapidataOrderBuilder:
                         self.__openapi_service.validation_api.validation_set_recommended_get(
                             asset_type=[self.__datapoints[0].get_asset_type()],
                             modality=[self.__workflow.modality],
+                            instruction=self.__workflow._get_instruction(),
                             prompt_type=[
                                 t.value for t in self.__datapoints[0].get_prompt_type()
                             ],
@@ -453,18 +454,16 @@ class RapidataOrderBuilder:
         return self
 
     def _sticky_state(
-        self, sticky_state: Literal["None", "Temporary", "Permanent"] | None = None
+        self, sticky_state: StickyStateLiteral | None = None
     ) -> "RapidataOrderBuilder":
         """
         Set the sticky state for the order.
         """
-        if sticky_state is not None and sticky_state not in [
-            "None",
-            "Temporary",
-            "Permanent",
-        ]:
-            raise TypeError(
-                "Sticky state must be of type Literal['None', 'Temporary', 'Permanent']."
+        sticky_state_valid_values = get_args(StickyStateLiteral)
+
+        if sticky_state is not None and sticky_state not in sticky_state_valid_values:
+            raise ValueError(
+                f"Sticky state must be one of {sticky_state_valid_values} or None"
             )
 
         self.__sticky_state_value = sticky_state