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

shaped/autogen/models/entity_journey.py

@@ -0,0 +1,152 @@
+# 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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EntityJourney(BaseModel):
+    """
+    Tracks a single entity's journey through the query pipeline.  Shows which retrievers found it, scores at each stage, filtering/reordering impact, and final position. Used in RankQueryConfig queries for both items and users.
+    """ # noqa: E501
+    entity_id: StrictStr = Field(description="External entity identifier (item_id or user_id as a string). This is the original ID format from your dataset.")
+    inner_entity_id: Optional[StrictInt] = None
+    retrieved_by: Optional[List[StrictStr]] = Field(default=None, description="List of retrieval step names that found this entity. Shows which retrievers contributed this entity to the candidate set.")
+    retrieval_scores: Optional[Dict[str, Union[StrictFloat, StrictInt]]] = Field(default=None, description="Scores from each retrieval step. Dictionary mapping step names to their scores for this entity.")
+    retrieval_rank: Optional[Dict[str, StrictInt]] = Field(default=None, description="Rank position from each retrieval step. Dictionary mapping step names to their rank positions for this entity.")
+    filter_results: Optional[Dict[str, StrictBool]] = Field(default=None, description="Results from each filter step. Dictionary mapping filter step names to whether this entity passed (true) or failed (false) the filter.")
+    filtered_out_by: Optional[StrictStr] = None
+    score: Optional[Union[StrictFloat, StrictInt]] = None
+    score_rank: Optional[StrictInt] = None
+    reorder_changes: Optional[List[Optional[Dict[str, Any]]]] = Field(default=None, description="List of position changes from reordering steps. Each entry contains step name, before position, and after position.")
+    final_position: Optional[StrictInt] = None
+    final_score: Optional[Union[StrictFloat, StrictInt]] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["entity_id", "inner_entity_id", "retrieved_by", "retrieval_scores", "retrieval_rank", "filter_results", "filtered_out_by", "score", "score_rank", "reorder_changes", "final_position", "final_score"]
+
+    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 EntityJourney 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,
+        )
+        # 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 inner_entity_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.inner_entity_id is None and "inner_entity_id" in self.model_fields_set:
+            _dict['inner_entity_id'] = None
+
+        # set to None if filtered_out_by (nullable) is None
+        # and model_fields_set contains the field
+        if self.filtered_out_by is None and "filtered_out_by" in self.model_fields_set:
+            _dict['filtered_out_by'] = None
+
+        # 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 score_rank (nullable) is None
+        # and model_fields_set contains the field
+        if self.score_rank is None and "score_rank" in self.model_fields_set:
+            _dict['score_rank'] = None
+
+        # set to None if final_position (nullable) is None
+        # and model_fields_set contains the field
+        if self.final_position is None and "final_position" in self.model_fields_set:
+            _dict['final_position'] = None
+
+        # set to None if final_score (nullable) is None
+        # and model_fields_set contains the field
+        if self.final_score is None and "final_score" in self.model_fields_set:
+            _dict['final_score'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EntityJourney from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "entity_id": obj.get("entity_id"),
+            "inner_entity_id": obj.get("inner_entity_id"),
+            "retrieved_by": obj.get("retrieved_by"),
+            "retrieval_scores": obj.get("retrieval_scores"),
+            "retrieval_rank": obj.get("retrieval_rank"),
+            "filter_results": obj.get("filter_results"),
+            "filtered_out_by": obj.get("filtered_out_by"),
+            "score": obj.get("score"),
+            "score_rank": obj.get("score_rank"),
+            "reorder_changes": obj.get("reorder_changes"),
+            "final_position": obj.get("final_position"),
+            "final_score": obj.get("final_score")
+        })
+        # 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/entity_type.py

@@ -0,0 +1,38 @@
+# 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
+from enum import Enum
+from typing_extensions import Self
+
+
+class EntityType(str, Enum):
+    """
+    Enum for entity types used in query processing.
+    """
+
+    """
+    allowed enum values
+    """
+    USER = 'user'
+    ITEM = 'item'
+    ITEM_ATTRIBUTE = 'item_attribute'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of EntityType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

shaped/autogen/models/evaluation_config.py

@@ -0,0 +1,92 @@
+# 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, StrictBool, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.candidate_retrieval_strategy import CandidateRetrievalStrategy
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EvaluationConfig(BaseModel):
+    """
+    Defines the strategy for offline model evaluation.
+    """ # noqa: E501
+    candidate_source: Optional[CandidateRetrievalStrategy] = Field(default=None, description="Strategy for selecting candidate items for evaluation.")
+    filter_seen_items: Optional[StrictBool] = Field(default=False, description="Whether to filter out items the user has already seen.")
+    evaluation_top_k: Optional[StrictInt] = Field(default=50, description="Number of top items to evaluate (must be between 1 and 300).")
+    __properties: ClassVar[List[str]] = ["candidate_source", "filter_seen_items", "evaluation_top_k"]
+
+    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 EvaluationConfig from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EvaluationConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "candidate_source": obj.get("candidate_source"),
+            "filter_seen_items": obj.get("filter_seen_items") if obj.get("filter_seen_items") is not None else False,
+            "evaluation_top_k": obj.get("evaluation_top_k") if obj.get("evaluation_top_k") is not None else 50
+        })
+        return _obj
+
+

shaped/autogen/models/exploration_reorder_step.py

@@ -0,0 +1,125 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from shaped.autogen.models.retriever1 import Retriever1
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ExplorationReorderStep(BaseModel):
+    """
+    ExplorationReorderStep
+    """ # noqa: E501
+    retriever: Retriever1
+    strength: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.5, description="Exploration strength (0.0-1.0). Closer to 1.0 pulls more items from retriever.")
+    name: Optional[StrictStr] = None
+    type: Optional[StrictStr] = Field(default='exploration', description="Reorder step type discriminator.")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["retriever", "strength", "name", "type"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['exploration']):
+            raise ValueError("must be one of enum values ('exploration')")
+        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 ExplorationReorderStep 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 retriever
+        if self.retriever:
+            _dict['retriever'] = self.retriever.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 ExplorationReorderStep from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "retriever": Retriever1.from_dict(obj["retriever"]) if obj.get("retriever") is not None else None,
+            "strength": obj.get("strength") if obj.get("strength") is not None else 0.5,
+            "name": obj.get("name"),
+            "type": obj.get("type") if obj.get("type") is not None else 'exploration'
+        })
+        # 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/expression_filter_step.py

@@ -0,0 +1,106 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ExpressionFilterStep(BaseModel):
+    """
+    ExpressionFilterStep
+    """ # noqa: E501
+    expression: StrictStr = Field(description="DuckDB filter expression (e.g., item.category == 'electronics').")
+    name: Optional[StrictStr] = None
+    type: Optional[StrictStr] = Field(default='expression', description="Filter step type discriminator.")
+    __properties: ClassVar[List[str]] = ["expression", "name", "type"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['expression']):
+            raise ValueError("must be one of enum values ('expression')")
+        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 ExpressionFilterStep 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 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 ExpressionFilterStep from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "expression": obj.get("expression"),
+            "name": obj.get("name"),
+            "type": obj.get("type") if obj.get("type") is not None else 'expression'
+        })
+        return _obj
+
+

shaped/autogen/models/factors.py

@@ -0,0 +1,136 @@
+# 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, StrictInt, StrictStr, ValidationError, field_validator
+from typing import Optional
+from shaped.autogen.models.tunable_int import TunableInt
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+FACTORS_ANY_OF_SCHEMAS = ["TunableInt", "int"]
+
+class Factors(BaseModel):
+    """
+    Number of latent factors in the matrix factorization.
+    """
+
+    # data type: int
+    anyof_schema_1_validator: Optional[StrictInt] = None
+    # data type: TunableInt
+    anyof_schema_2_validator: Optional[TunableInt] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[TunableInt, int]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "TunableInt", "int" }
+
+    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 = Factors.model_construct()
+        error_messages = []
+        # validate data type: int
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: TunableInt
+        if not isinstance(v, TunableInt):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TunableInt`")
+        else:
+            return v
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in Factors with anyOf schemas: TunableInt, int. 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 = []
+        # deserialize data into int
+        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))
+        # anyof_schema_2_validator: Optional[TunableInt] = None
+        try:
+            instance.actual_instance = TunableInt.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 Factors with anyOf schemas: TunableInt, int. 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], TunableInt, int]]:
+        """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())
+
+