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

shaped/autogen/models/shaped_internal_recsys_policies_widedeep_model_policy_wide_deep_model_policy_config.py

@@ -0,0 +1,137 @@
+# 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.4
+    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, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.n_epochs2 import NEpochs2
+from shaped.autogen.models.val_split import ValSplit
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig(BaseModel):
+    """
+    ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig
+    """ # noqa: E501
+    policy_type: Optional[StrictStr] = 'widedeep'
+    name: Optional[StrictStr] = None
+    val_split: Optional[ValSplit] = None
+    n_epochs: Optional[NEpochs2] = None
+    num_workers: Optional[StrictInt] = 0
+    normalize_numerical_features: Optional[StrictBool] = Field(default=True, description="Enable NormalizeNumerical transform for entity features.")
+    use_derived_timestamp_features: Optional[StrictBool] = Field(default=True, description="Enable TimestampSinCosEncoder and TimestampCountEncoder for entity features.")
+    balance_labels: Optional[StrictBool] = Field(default=True, description="Enable BalanceLabel transform for interactions.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "val_split", "n_epochs", "num_workers", "normalize_numerical_features", "use_derived_timestamp_features", "balance_labels"]
+
+    @field_validator('policy_type')
+    def policy_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['widedeep']):
+            raise ValueError("must be one of enum values ('widedeep')")
+        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 ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig 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 val_split
+        if self.val_split:
+            _dict['val_split'] = self.val_split.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of n_epochs
+        if self.n_epochs:
+            _dict['n_epochs'] = self.n_epochs.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 name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesWidedeepModelPolicyWideDeepModelPolicyConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'widedeep',
+            "name": obj.get("name"),
+            "val_split": ValSplit.from_dict(obj["val_split"]) if obj.get("val_split") is not None else None,
+            "n_epochs": NEpochs2.from_dict(obj["n_epochs"]) if obj.get("n_epochs") is not None else None,
+            "num_workers": obj.get("num_workers") if obj.get("num_workers") is not None else 0,
+            "normalize_numerical_features": obj.get("normalize_numerical_features") if obj.get("normalize_numerical_features") is not None else True,
+            "use_derived_timestamp_features": obj.get("use_derived_timestamp_features") if obj.get("use_derived_timestamp_features") is not None else True,
+            "balance_labels": obj.get("balance_labels") if obj.get("balance_labels") is not None else True
+        })
+        # 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/shaped_internal_recsys_policies_xgboost_model_policy_xg_boost_model_policy_config.py

@@ -0,0 +1,155 @@
+# 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.4
+    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, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.learning_rate3 import LearningRate3
+from shaped.autogen.models.max_depth import MaxDepth
+from shaped.autogen.models.max_leaves import MaxLeaves
+from shaped.autogen.models.mode1 import Mode1
+from shaped.autogen.models.n_estimators import NEstimators
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig(BaseModel):
+    """
+    ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig
+    """ # noqa: E501
+    policy_type: Optional[StrictStr] = 'xgboost'
+    name: Optional[StrictStr] = None
+    event_values: Optional[List[StrictStr]] = None
+    mode: Optional[Mode1] = None
+    n_estimators: Optional[NEstimators] = None
+    max_depth: Optional[MaxDepth] = None
+    max_leaves: Optional[MaxLeaves] = None
+    n_jobs: Optional[StrictInt] = -1
+    learning_rate: Optional[LearningRate3] = None
+    min_child_weight: Optional[StrictInt] = Field(default=1, description="Minimum sum of instance weight needed in a child node.")
+    use_user_ids_as_features: Optional[StrictBool] = True
+    use_item_ids_as_features: Optional[StrictBool] = True
+    normalize_numerical_features: Optional[StrictBool] = Field(default=True, description="Enable NormalizeNumerical transform for entity features.")
+    use_derived_timestamp_features: Optional[StrictBool] = Field(default=True, description="Enable TimestampSinCosEncoder and TimestampCountEncoder for entity features.")
+    balance_labels: Optional[StrictBool] = Field(default=True, description="Enable BalanceLabel transform for interactions.")
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "mode", "n_estimators", "max_depth", "max_leaves", "n_jobs", "learning_rate", "min_child_weight", "use_user_ids_as_features", "use_item_ids_as_features", "normalize_numerical_features", "use_derived_timestamp_features", "balance_labels"]
+
+    @field_validator('policy_type')
+    def policy_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['xgboost']):
+            raise ValueError("must be one of enum values ('xgboost')")
+        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 ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig 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 mode
+        if self.mode:
+            _dict['mode'] = self.mode.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of n_estimators
+        if self.n_estimators:
+            _dict['n_estimators'] = self.n_estimators.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of max_depth
+        if self.max_depth:
+            _dict['max_depth'] = self.max_depth.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of max_leaves
+        if self.max_leaves:
+            _dict['max_leaves'] = self.max_leaves.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of learning_rate
+        if self.learning_rate:
+            _dict['learning_rate'] = self.learning_rate.to_dict()
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # set to None if event_values (nullable) is None
+        # and model_fields_set contains the field
+        if self.event_values is None and "event_values" in self.model_fields_set:
+            _dict['event_values'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesXgboostModelPolicyXGBoostModelPolicyConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "policy_type": obj.get("policy_type") if obj.get("policy_type") is not None else 'xgboost',
+            "name": obj.get("name"),
+            "event_values": obj.get("event_values"),
+            "mode": Mode1.from_dict(obj["mode"]) if obj.get("mode") is not None else None,
+            "n_estimators": NEstimators.from_dict(obj["n_estimators"]) if obj.get("n_estimators") is not None else None,
+            "max_depth": MaxDepth.from_dict(obj["max_depth"]) if obj.get("max_depth") is not None else None,
+            "max_leaves": MaxLeaves.from_dict(obj["max_leaves"]) if obj.get("max_leaves") is not None else None,
+            "n_jobs": obj.get("n_jobs") if obj.get("n_jobs") is not None else -1,
+            "learning_rate": LearningRate3.from_dict(obj["learning_rate"]) if obj.get("learning_rate") is not None else None,
+            "min_child_weight": obj.get("min_child_weight") if obj.get("min_child_weight") is not None else 1,
+            "use_user_ids_as_features": obj.get("use_user_ids_as_features") if obj.get("use_user_ids_as_features") is not None else True,
+            "use_item_ids_as_features": obj.get("use_item_ids_as_features") if obj.get("use_item_ids_as_features") is not None else True,
+            "normalize_numerical_features": obj.get("normalize_numerical_features") if obj.get("normalize_numerical_features") is not None else True,
+            "use_derived_timestamp_features": obj.get("use_derived_timestamp_features") if obj.get("use_derived_timestamp_features") is not None else True,
+            "balance_labels": obj.get("balance_labels") if obj.get("balance_labels") is not None else True
+        })
+        return _obj
+
+

shaped/autogen/models/shopify_table_config.py

@@ -0,0 +1,156 @@
+# 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.4
+    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, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShopifyTableConfig(BaseModel):
+    """
+    ShopifyTableConfig
+    """ # noqa: E501
+    schema_type: Optional[StrictStr] = Field(default='SHOPIFY', description="Schema type discriminator for Shopify datasets.")
+    name: StrictStr = Field(description="Unique identifier for the Shopify dataset.")
+    description: Optional[StrictStr] = None
+    access_token: StrictStr = Field(description="Shopify API access token.")
+    store: StrictStr = Field(description="Shopify store name (e.g., mystore.myshopify.com).")
+    stream: StrictStr = Field(description="Shopify stream name to sync (e.g., orders, products).")
+    is_plus_account: Optional[StrictBool] = Field(default=False, description="Whether the Shopify account is Plus tier.")
+    schedule_interval: Optional[StrictStr] = None
+    start_date: Optional[StrictStr] = None
+    admin_url: Optional[StrictStr] = None
+    batch_size: Optional[StrictInt] = None
+    unique_keys: Optional[List[StrictStr]] = None
+    verify_ssl: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["schema_type", "name", "description", "access_token", "store", "stream", "is_plus_account", "schedule_interval", "start_date", "admin_url", "batch_size", "unique_keys", "verify_ssl"]
+
+    @field_validator('schema_type')
+    def schema_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SHOPIFY']):
+            raise ValueError("must be one of enum values ('SHOPIFY')")
+        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 ShopifyTableConfig 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,
+        )
+        # set to None if description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict['description'] = None
+
+        # set to None if schedule_interval (nullable) is None
+        # and model_fields_set contains the field
+        if self.schedule_interval is None and "schedule_interval" in self.model_fields_set:
+            _dict['schedule_interval'] = None
+
+        # set to None if start_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.start_date is None and "start_date" in self.model_fields_set:
+            _dict['start_date'] = None
+
+        # set to None if admin_url (nullable) is None
+        # and model_fields_set contains the field
+        if self.admin_url is None and "admin_url" in self.model_fields_set:
+            _dict['admin_url'] = None
+
+        # set to None if batch_size (nullable) is None
+        # and model_fields_set contains the field
+        if self.batch_size is None and "batch_size" in self.model_fields_set:
+            _dict['batch_size'] = None
+
+        # set to None if unique_keys (nullable) is None
+        # and model_fields_set contains the field
+        if self.unique_keys is None and "unique_keys" in self.model_fields_set:
+            _dict['unique_keys'] = None
+
+        # set to None if verify_ssl (nullable) is None
+        # and model_fields_set contains the field
+        if self.verify_ssl is None and "verify_ssl" in self.model_fields_set:
+            _dict['verify_ssl'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShopifyTableConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "schema_type": obj.get("schema_type") if obj.get("schema_type") is not None else 'SHOPIFY',
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "access_token": obj.get("access_token"),
+            "store": obj.get("store"),
+            "stream": obj.get("stream"),
+            "is_plus_account": obj.get("is_plus_account") if obj.get("is_plus_account") is not None else False,
+            "schedule_interval": obj.get("schedule_interval"),
+            "start_date": obj.get("start_date"),
+            "admin_url": obj.get("admin_url"),
+            "batch_size": obj.get("batch_size"),
+            "unique_keys": obj.get("unique_keys"),
+            "verify_ssl": obj.get("verify_ssl")
+        })
+        return _obj
+
+

shaped/autogen/models/similarity_retrieve_step.py

@@ -0,0 +1,123 @@
+# 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.4
+    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, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.query_encoder import QueryEncoder
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SimilarityRetrieveStep(BaseModel):
+    """
+    Performs a search on an embedding index and returns entities.
+    """ # noqa: E501
+    embedding_ref: StrictStr = Field(description="Name of the embedding to use for similarity search.")
+    query_encoder: QueryEncoder
+    where: Optional[StrictStr] = None
+    limit: Optional[StrictInt] = Field(default=100, description="Maximum number of candidates to retrieve.")
+    name: Optional[StrictStr] = None
+    type: Optional[StrictStr] = Field(default='similarity', description="Retrieve step type discriminator.")
+    use_exact_search: Optional[StrictBool] = Field(default=False, description="If True, forces brute-force search, bypassing any index. This can improve recall but is slower.")
+    __properties: ClassVar[List[str]] = ["embedding_ref", "query_encoder", "where", "limit", "name", "type", "use_exact_search"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['similarity']):
+            raise ValueError("must be one of enum values ('similarity')")
+        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 SimilarityRetrieveStep 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 query_encoder
+        if self.query_encoder:
+            _dict['query_encoder'] = self.query_encoder.to_dict()
+        # set to None if where (nullable) is None
+        # and model_fields_set contains the field
+        if self.where is None and "where" in self.model_fields_set:
+            _dict['where'] = None
+
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SimilarityRetrieveStep from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "embedding_ref": obj.get("embedding_ref"),
+            "query_encoder": QueryEncoder.from_dict(obj["query_encoder"]) if obj.get("query_encoder") is not None else None,
+            "where": obj.get("where"),
+            "limit": obj.get("limit") if obj.get("limit") is not None else 100,
+            "name": obj.get("name"),
+            "type": obj.get("type") if obj.get("type") is not None else 'similarity',
+            "use_exact_search": obj.get("use_exact_search") if obj.get("use_exact_search") is not None else False
+        })
+        return _obj
+
+