shaped 2.0.1__py3-none-any.whl → 2.0.2__py3-none-any.whl

shaped/autogen/models/rank_query_config.py

@@ -0,0 +1,167 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.0
+    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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.entity_type import EntityType
+from shaped.autogen.models.rank_query_config_filter_inner import RankQueryConfigFilterInner
+from shaped.autogen.models.rank_query_config_reorder_inner import RankQueryConfigReorderInner
+from shaped.autogen.models.rank_query_config_retrieve_inner import RankQueryConfigRetrieveInner
+from shaped.autogen.models.score import Score
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RankQueryConfig(BaseModel):
+    """
+    Config for a query pipeline that ranks entities (items or users) based on the given definition. The entity type is determined by the 'from' field.
+    """ # noqa: E501
+    columns: Optional[List[StrictStr]] = None
+    embeddings: Optional[List[StrictStr]] = None
+    retrieve: Optional[List[RankQueryConfigRetrieveInner]] = Field(default=None, description="List of retrieval steps to execute.")
+    filter: Optional[List[RankQueryConfigFilterInner]] = None
+    score: Optional[Score] = None
+    reorder: Optional[List[RankQueryConfigReorderInner]] = Field(default=None, description="List of reordering steps to apply.")
+    limit: Optional[StrictInt] = None
+    type: Optional[StrictStr] = Field(default='rank', description="Query config type discriminator.")
+    var_from: Optional[EntityType] = Field(default=None, alias="from")
+    __properties: ClassVar[List[str]] = ["columns", "embeddings", "retrieve", "filter", "score", "reorder", "limit", "type", "from"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['rank']):
+            raise ValueError("must be one of enum values ('rank')")
+        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 RankQueryConfig 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 each item in retrieve (list)
+        _items = []
+        if self.retrieve:
+            for _item_retrieve in self.retrieve:
+                if _item_retrieve:
+                    _items.append(_item_retrieve.to_dict())
+            _dict['retrieve'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in filter (list)
+        _items = []
+        if self.filter:
+            for _item_filter in self.filter:
+                if _item_filter:
+                    _items.append(_item_filter.to_dict())
+            _dict['filter'] = _items
+        # override the default output from pydantic by calling `to_dict()` of score
+        if self.score:
+            _dict['score'] = self.score.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in reorder (list)
+        _items = []
+        if self.reorder:
+            for _item_reorder in self.reorder:
+                if _item_reorder:
+                    _items.append(_item_reorder.to_dict())
+            _dict['reorder'] = _items
+        # set to None if columns (nullable) is None
+        # and model_fields_set contains the field
+        if self.columns is None and "columns" in self.model_fields_set:
+            _dict['columns'] = None
+
+        # set to None if embeddings (nullable) is None
+        # and model_fields_set contains the field
+        if self.embeddings is None and "embeddings" in self.model_fields_set:
+            _dict['embeddings'] = None
+
+        # set to None if filter (nullable) is None
+        # and model_fields_set contains the field
+        if self.filter is None and "filter" in self.model_fields_set:
+            _dict['filter'] = None
+
+        # set to None if limit (nullable) is None
+        # and model_fields_set contains the field
+        if self.limit is None and "limit" in self.model_fields_set:
+            _dict['limit'] = None
+
+        # set to None if var_from (nullable) is None
+        # and model_fields_set contains the field
+        if self.var_from is None and "var_from" in self.model_fields_set:
+            _dict['from'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RankQueryConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "columns": obj.get("columns"),
+            "embeddings": obj.get("embeddings"),
+            "retrieve": [RankQueryConfigRetrieveInner.from_dict(_item) for _item in obj["retrieve"]] if obj.get("retrieve") is not None else None,
+            "filter": [RankQueryConfigFilterInner.from_dict(_item) for _item in obj["filter"]] if obj.get("filter") is not None else None,
+            "score": Score.from_dict(obj["score"]) if obj.get("score") is not None else None,
+            "reorder": [RankQueryConfigReorderInner.from_dict(_item) for _item in obj["reorder"]] if obj.get("reorder") is not None else None,
+            "limit": obj.get("limit"),
+            "type": obj.get("type") if obj.get("type") is not None else 'rank',
+            "from": obj.get("from")
+        })
+        return _obj
+
+

shaped/autogen/models/rank_query_config_filter_inner.py

@@ -0,0 +1,149 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from shaped.autogen.models.expression_filter_step import ExpressionFilterStep
+from shaped.autogen.models.prebuilt_filter_step import PrebuiltFilterStep
+from shaped.autogen.models.truncate_filter_step import TruncateFilterStep
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+RANKQUERYCONFIGFILTERINNER_ANY_OF_SCHEMAS = ["ExpressionFilterStep", "PrebuiltFilterStep", "TruncateFilterStep"]
+
+class RankQueryConfigFilterInner(BaseModel):
+    """
+    RankQueryConfigFilterInner
+    """
+
+    # data type: PrebuiltFilterStep
+    anyof_schema_1_validator: Optional[PrebuiltFilterStep] = None
+    # data type: ExpressionFilterStep
+    anyof_schema_2_validator: Optional[ExpressionFilterStep] = None
+    # data type: TruncateFilterStep
+    anyof_schema_3_validator: Optional[TruncateFilterStep] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[ExpressionFilterStep, PrebuiltFilterStep, TruncateFilterStep]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "ExpressionFilterStep", "PrebuiltFilterStep", "TruncateFilterStep" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    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_anyof(cls, v):
+        instance = RankQueryConfigFilterInner.model_construct()
+        error_messages = []
+        # validate data type: PrebuiltFilterStep
+        if not isinstance(v, PrebuiltFilterStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PrebuiltFilterStep`")
+        else:
+            return v
+
+        # validate data type: ExpressionFilterStep
+        if not isinstance(v, ExpressionFilterStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ExpressionFilterStep`")
+        else:
+            return v
+
+        # validate data type: TruncateFilterStep
+        if not isinstance(v, TruncateFilterStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TruncateFilterStep`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in RankQueryConfigFilterInner with anyOf schemas: ExpressionFilterStep, PrebuiltFilterStep, TruncateFilterStep. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: 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 = []
+        # anyof_schema_1_validator: Optional[PrebuiltFilterStep] = None
+        try:
+            instance.actual_instance = PrebuiltFilterStep.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[ExpressionFilterStep] = None
+        try:
+            instance.actual_instance = ExpressionFilterStep.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[TruncateFilterStep] = None
+        try:
+            instance.actual_instance = TruncateFilterStep.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into RankQueryConfigFilterInner with anyOf schemas: ExpressionFilterStep, PrebuiltFilterStep, TruncateFilterStep. 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], ExpressionFilterStep, PrebuiltFilterStep, TruncateFilterStep]]:
+        """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:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

shaped/autogen/models/rank_query_config_reorder_inner.py

@@ -0,0 +1,149 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Optional
+from shaped.autogen.models.boosted_reorder_step import BoostedReorderStep
+from shaped.autogen.models.diversity_reorder_step import DiversityReorderStep
+from shaped.autogen.models.exploration_reorder_step import ExplorationReorderStep
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+RANKQUERYCONFIGREORDERINNER_ANY_OF_SCHEMAS = ["BoostedReorderStep", "DiversityReorderStep", "ExplorationReorderStep"]
+
+class RankQueryConfigReorderInner(BaseModel):
+    """
+    RankQueryConfigReorderInner
+    """
+
+    # data type: ExplorationReorderStep
+    anyof_schema_1_validator: Optional[ExplorationReorderStep] = None
+    # data type: BoostedReorderStep
+    anyof_schema_2_validator: Optional[BoostedReorderStep] = None
+    # data type: DiversityReorderStep
+    anyof_schema_3_validator: Optional[DiversityReorderStep] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[BoostedReorderStep, DiversityReorderStep, ExplorationReorderStep]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "BoostedReorderStep", "DiversityReorderStep", "ExplorationReorderStep" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    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_anyof(cls, v):
+        instance = RankQueryConfigReorderInner.model_construct()
+        error_messages = []
+        # validate data type: ExplorationReorderStep
+        if not isinstance(v, ExplorationReorderStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ExplorationReorderStep`")
+        else:
+            return v
+
+        # validate data type: BoostedReorderStep
+        if not isinstance(v, BoostedReorderStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `BoostedReorderStep`")
+        else:
+            return v
+
+        # validate data type: DiversityReorderStep
+        if not isinstance(v, DiversityReorderStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `DiversityReorderStep`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in RankQueryConfigReorderInner with anyOf schemas: BoostedReorderStep, DiversityReorderStep, ExplorationReorderStep. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: 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 = []
+        # anyof_schema_1_validator: Optional[ExplorationReorderStep] = None
+        try:
+            instance.actual_instance = ExplorationReorderStep.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[BoostedReorderStep] = None
+        try:
+            instance.actual_instance = BoostedReorderStep.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[DiversityReorderStep] = None
+        try:
+            instance.actual_instance = DiversityReorderStep.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into RankQueryConfigReorderInner with anyOf schemas: BoostedReorderStep, DiversityReorderStep, ExplorationReorderStep. 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], BoostedReorderStep, DiversityReorderStep, ExplorationReorderStep]]:
+        """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:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

shaped/autogen/models/rank_query_config_retrieve_inner.py

@@ -0,0 +1,196 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.0
+    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 shaped.autogen.models.candidate_attributes_retrieve_step import CandidateAttributesRetrieveStep
+from shaped.autogen.models.candidate_ids_retrieve_step import CandidateIdsRetrieveStep
+from shaped.autogen.models.column_order_retrieve_step import ColumnOrderRetrieveStep
+from shaped.autogen.models.filter_retrieve_step import FilterRetrieveStep
+from shaped.autogen.models.similarity_retrieve_step import SimilarityRetrieveStep
+from shaped.autogen.models.text_search_retrieve_step import TextSearchRetrieveStep
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+RANKQUERYCONFIGRETRIEVEINNER_ONE_OF_SCHEMAS = ["CandidateAttributesRetrieveStep", "CandidateIdsRetrieveStep", "ColumnOrderRetrieveStep", "FilterRetrieveStep", "SimilarityRetrieveStep", "TextSearchRetrieveStep"]
+
+class RankQueryConfigRetrieveInner(BaseModel):
+    """
+    RankQueryConfigRetrieveInner
+    """
+    # data type: ColumnOrderRetrieveStep
+    oneof_schema_1_validator: Optional[ColumnOrderRetrieveStep] = None
+    # data type: TextSearchRetrieveStep
+    oneof_schema_2_validator: Optional[TextSearchRetrieveStep] = None
+    # data type: SimilarityRetrieveStep
+    oneof_schema_3_validator: Optional[SimilarityRetrieveStep] = None
+    # data type: FilterRetrieveStep
+    oneof_schema_4_validator: Optional[FilterRetrieveStep] = None
+    # data type: CandidateIdsRetrieveStep
+    oneof_schema_5_validator: Optional[CandidateIdsRetrieveStep] = None
+    # data type: CandidateAttributesRetrieveStep
+    oneof_schema_6_validator: Optional[CandidateAttributesRetrieveStep] = None
+    actual_instance: Optional[Union[CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep]] = None
+    one_of_schemas: Set[str] = { "CandidateAttributesRetrieveStep", "CandidateIdsRetrieveStep", "ColumnOrderRetrieveStep", "FilterRetrieveStep", "SimilarityRetrieveStep", "TextSearchRetrieveStep" }
+
+    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 = RankQueryConfigRetrieveInner.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: ColumnOrderRetrieveStep
+        if not isinstance(v, ColumnOrderRetrieveStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ColumnOrderRetrieveStep`")
+        else:
+            match += 1
+        # validate data type: TextSearchRetrieveStep
+        if not isinstance(v, TextSearchRetrieveStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TextSearchRetrieveStep`")
+        else:
+            match += 1
+        # validate data type: SimilarityRetrieveStep
+        if not isinstance(v, SimilarityRetrieveStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `SimilarityRetrieveStep`")
+        else:
+            match += 1
+        # validate data type: FilterRetrieveStep
+        if not isinstance(v, FilterRetrieveStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `FilterRetrieveStep`")
+        else:
+            match += 1
+        # validate data type: CandidateIdsRetrieveStep
+        if not isinstance(v, CandidateIdsRetrieveStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CandidateIdsRetrieveStep`")
+        else:
+            match += 1
+        # validate data type: CandidateAttributesRetrieveStep
+        if not isinstance(v, CandidateAttributesRetrieveStep):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CandidateAttributesRetrieveStep`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. 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 ColumnOrderRetrieveStep
+        try:
+            instance.actual_instance = ColumnOrderRetrieveStep.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into TextSearchRetrieveStep
+        try:
+            instance.actual_instance = TextSearchRetrieveStep.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into SimilarityRetrieveStep
+        try:
+            instance.actual_instance = SimilarityRetrieveStep.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into FilterRetrieveStep
+        try:
+            instance.actual_instance = FilterRetrieveStep.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CandidateIdsRetrieveStep
+        try:
+            instance.actual_instance = CandidateIdsRetrieveStep.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CandidateAttributesRetrieveStep
+        try:
+            instance.actual_instance = CandidateAttributesRetrieveStep.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 RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. 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], CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep]]:
+        """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())
+
+