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

shaped/autogen/models/response_get_view_details_views_view_name_get.py

@@ -0,0 +1,134 @@
+# 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.view_details_ai import ViewDetailsAI
+from shaped.autogen.models.view_details_sql import ViewDetailsSQL
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+RESPONSEGETVIEWDETAILSVIEWSVIEWNAMEGET_ANY_OF_SCHEMAS = ["ViewDetailsAI", "ViewDetailsSQL"]
+
+class ResponseGetViewDetailsViewsViewNameGet(BaseModel):
+    """
+    ResponseGetViewDetailsViewsViewNameGet
+    """
+
+    # data type: ViewDetailsSQL
+    anyof_schema_1_validator: Optional[ViewDetailsSQL] = None
+    # data type: ViewDetailsAI
+    anyof_schema_2_validator: Optional[ViewDetailsAI] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[ViewDetailsAI, ViewDetailsSQL]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "ViewDetailsAI", "ViewDetailsSQL" }
+
+    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 = ResponseGetViewDetailsViewsViewNameGet.model_construct()
+        error_messages = []
+        # validate data type: ViewDetailsSQL
+        if not isinstance(v, ViewDetailsSQL):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ViewDetailsSQL`")
+        else:
+            return v
+
+        # validate data type: ViewDetailsAI
+        if not isinstance(v, ViewDetailsAI):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ViewDetailsAI`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in ResponseGetViewDetailsViewsViewNameGet with anyOf schemas: ViewDetailsAI, ViewDetailsSQL. 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[ViewDetailsSQL] = None
+        try:
+            instance.actual_instance = ViewDetailsSQL.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[ViewDetailsAI] = None
+        try:
+            instance.actual_instance = ViewDetailsAI.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 ResponseGetViewDetailsViewsViewNameGet with anyOf schemas: ViewDetailsAI, ViewDetailsSQL. 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], ViewDetailsAI, ViewDetailsSQL]]:
+        """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/result.py

@@ -0,0 +1,145 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from shaped.autogen.models.journey import Journey
+from shaped.autogen.models.result_embeddings_value import ResultEmbeddingsValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Result(BaseModel):
+    """
+    A single result entity (item, user, or attribute).  Represents one ranked entity in the query results with its score, optional attributes, optional embeddings, and optional journey explanation.
+    """ # noqa: E501
+    id: StrictStr = Field(description="Entity identifier. For items this is the item_id, for users this is the user_id, and for attributes this is the attribute value.")
+    score: Optional[Union[StrictFloat, StrictInt]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    embeddings: Optional[Dict[str, Optional[ResultEmbeddingsValue]]] = None
+    journey: Optional[Journey] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id", "score", "metadata", "embeddings", "journey"]
+
+    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 Result 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _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 value in embeddings (dict)
+        _field_dict = {}
+        if self.embeddings:
+            for _key_embeddings in self.embeddings:
+                if self.embeddings[_key_embeddings]:
+                    _field_dict[_key_embeddings] = self.embeddings[_key_embeddings].to_dict()
+            _dict['embeddings'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of journey
+        if self.journey:
+            _dict['journey'] = self.journey.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if score (nullable) is None
+        # and model_fields_set contains the field
+        if self.score is None and "score" in self.model_fields_set:
+            _dict['score'] = None
+
+        # 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 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 journey (nullable) is None
+        # and model_fields_set contains the field
+        if self.journey is None and "journey" in self.model_fields_set:
+            _dict['journey'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Result from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "score": obj.get("score"),
+            "metadata": obj.get("metadata"),
+            "embeddings": dict(
+                (_k, ResultEmbeddingsValue.from_dict(_v))
+                for _k, _v in obj["embeddings"].items()
+            )
+            if obj.get("embeddings") is not None
+            else None,
+            "journey": Journey.from_dict(obj["journey"]) if obj.get("journey") is not None else None
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

shaped/autogen/models/result_embeddings_value.py

@@ -0,0 +1,127 @@
+# 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, StrictFloat, StrictInt, StrictStr, ValidationError, field_validator
+from typing import List, Optional, Union
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+RESULTEMBEDDINGSVALUE_ANY_OF_SCHEMAS = ["List[float]"]
+
+class ResultEmbeddingsValue(BaseModel):
+    """
+    ResultEmbeddingsValue
+    """
+
+    # data type: List[float]
+    anyof_schema_1_validator: Optional[List[Union[StrictFloat, StrictInt]]] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[List[float]]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "List[float]" }
+
+    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):
+        if v is None:
+            return v
+
+        instance = ResultEmbeddingsValue.model_construct()
+        error_messages = []
+        # validate data type: List[float]
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in ResultEmbeddingsValue with anyOf schemas: List[float]. 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()
+        if json_str is None:
+            return instance
+
+        error_messages = []
+        # deserialize data into List[float]
+        try:
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
+            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 ResultEmbeddingsValue with anyOf schemas: List[float]. 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], List[float]]]:
+        """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/retriever.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
+
+RETRIEVER_ONE_OF_SCHEMAS = ["CandidateAttributesRetrieveStep", "CandidateIdsRetrieveStep", "ColumnOrderRetrieveStep", "FilterRetrieveStep", "SimilarityRetrieveStep", "TextSearchRetrieveStep"]
+
+class Retriever(BaseModel):
+    """
+    Retrieve step to use as source for boosting.
+    """
+    # 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 = Retriever.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 Retriever 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 Retriever 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 Retriever 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 Retriever 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())
+
+