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

shaped/autogen/models/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_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.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
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from shaped.autogen.models.ascending import Ascending
+from typing_extensions import Self
+
+
+class ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig(
+    BaseModel
+):
+    """
+    ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig
+    """  # noqa: E501
+
+    policy_type: Optional[StrictStr] = "chronological"
+    name: Optional[StrictStr] = None
+    event_values: Optional[List[StrictStr]] = None
+    time_col: Optional[StrictStr] = None
+    ascending: Optional[Ascending] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "policy_type",
+        "name",
+        "event_values",
+        "time_col",
+        "ascending",
+    ]
+
+    @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(["chronological"]):
+            raise ValueError("must be one of enum values ('chronological')")
+        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 ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig 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 ascending
+        if self.ascending:
+            _dict["ascending"] = self.ascending.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
+
+        # 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
+
+        # set to None if time_col (nullable) is None
+        # and model_fields_set contains the field
+        if self.time_col is None and "time_col" in self.model_fields_set:
+            _dict["time_col"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig 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 "chronological"
+                ),
+                "name": obj.get("name"),
+                "event_values": obj.get("event_values"),
+                "time_col": obj.get("time_col"),
+                "ascending": (
+                    Ascending.from_dict(obj["ascending"])
+                    if obj.get("ascending") 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/shaped_internal_recsys_policies_elsa_model_policy_elsa_model_policy_elsa_model_policy_config.py

@@ -0,0 +1,141 @@
+# 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.factors import Factors
+from shaped.autogen.models.lr1 import Lr1
+from shaped.autogen.models.training_strategy import TrainingStrategy
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig(BaseModel):
+    """
+    ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig
+    """ # noqa: E501
+    policy_type: Optional[StrictStr] = 'elsa'
+    name: Optional[StrictStr] = None
+    event_values: Optional[List[StrictStr]] = None
+    batch_size: Optional[StrictInt] = Field(default=512, description="Number of samples processed before updating model weights.")
+    n_epochs: Optional[StrictInt] = Field(default=1, description="Number of complete passes through the training dataset.")
+    factors: Optional[Factors] = None
+    lr: Optional[Lr1] = None
+    device: Optional[StrictStr] = None
+    strategy: Optional[TrainingStrategy] = None
+    patience: Optional[StrictInt] = Field(default=3, description="Number of epochs to wait without improvement before early stopping.")
+    balance_labels: Optional[StrictBool] = Field(default=True, description="Enable BalanceLabel transform for interactions.")
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "batch_size", "n_epochs", "factors", "lr", "device", "strategy", "patience", "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(['elsa']):
+            raise ValueError("must be one of enum values ('elsa')")
+        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 ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig 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 factors
+        if self.factors:
+            _dict['factors'] = self.factors.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of lr
+        if self.lr:
+            _dict['lr'] = self.lr.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
+
+        # set to None if device (nullable) is None
+        # and model_fields_set contains the field
+        if self.device is None and "device" in self.model_fields_set:
+            _dict['device'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyConfig 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 'elsa',
+            "name": obj.get("name"),
+            "event_values": obj.get("event_values"),
+            "batch_size": obj.get("batch_size") if obj.get("batch_size") is not None else 512,
+            "n_epochs": obj.get("n_epochs") if obj.get("n_epochs") is not None else 1,
+            "factors": Factors.from_dict(obj["factors"]) if obj.get("factors") is not None else None,
+            "lr": Lr1.from_dict(obj["lr"]) if obj.get("lr") is not None else None,
+            "device": obj.get("device"),
+            "strategy": obj.get("strategy"),
+            "patience": obj.get("patience") if obj.get("patience") is not None else 3,
+            "balance_labels": obj.get("balance_labels") if obj.get("balance_labels") is not None else True
+        })
+        return _obj
+
+

shaped/autogen/models/shaped_internal_recsys_policies_gsasrec_model_policy_gsasrec_model_policy_gsas_rec_model_policy_config.py

@@ -0,0 +1,211 @@
+# 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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from shaped.autogen.models.batch_size1 import BatchSize1
+from shaped.autogen.models.dropout_rate import DropoutRate
+from shaped.autogen.models.embedding_dim import EmbeddingDim
+from shaped.autogen.models.learning_rate import LearningRate
+from shaped.autogen.models.n_epochs1 import NEpochs1
+from shaped.autogen.models.neg_per_positive import NegPerPositive
+from shaped.autogen.models.num_blocks import NumBlocks
+from shaped.autogen.models.num_heads import NumHeads
+from shaped.autogen.models.sequence_length import SequenceLength
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShapedInternalRecsysPoliciesGsasrecModelPolicyGsasrecModelPolicyGSASRecModelPolicyConfig(BaseModel):
+    """
+    ShapedInternalRecsysPoliciesGsasrecModelPolicyGsasrecModelPolicyGSASRecModelPolicyConfig
+    """ # noqa: E501
+    policy_type: Optional[StrictStr] = 'gsasrec'
+    name: Optional[StrictStr] = None
+    event_values: Optional[List[StrictStr]] = None
+    batch_size: Optional[BatchSize1] = None
+    eval_batch_size: Optional[StrictInt] = Field(default=32, description="Batch size used during model evaluation.")
+    n_epochs: Optional[NEpochs1] = None
+    device: Optional[StrictStr] = None
+    learning_rate: Optional[LearningRate] = None
+    weight_decay: Optional[Union[StrictFloat, StrictInt]] = Field(default=5.0E-4, description="L2 regularization term to prevent overfitting.")
+    patience: Optional[StrictInt] = Field(default=3, description="Number of epochs to wait without improvement before early stopping.")
+    sequence_length: Optional[SequenceLength] = None
+    embedding_dim: Optional[EmbeddingDim] = None
+    num_heads: Optional[NumHeads] = None
+    num_blocks: Optional[NumBlocks] = None
+    dropout_rate: Optional[DropoutRate] = None
+    reuse_item_embeddings: Optional[StrictBool] = False
+    max_batches_per_epoch: Optional[StrictInt] = 100
+    gbce_t: Optional[Union[StrictFloat, StrictInt]] = 0.75
+    filter_rated: Optional[StrictBool] = False
+    neg_per_positive: Optional[NegPerPositive] = None
+    eval_after_epochs: Optional[StrictInt] = 1
+    split_ratio: Optional[Union[StrictFloat, StrictInt]] = 0.9
+    eps: Optional[Union[StrictFloat, StrictInt]] = 1.0E-10
+    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", "event_values", "batch_size", "eval_batch_size", "n_epochs", "device", "learning_rate", "weight_decay", "patience", "sequence_length", "embedding_dim", "num_heads", "num_blocks", "dropout_rate", "reuse_item_embeddings", "max_batches_per_epoch", "gbce_t", "filter_rated", "neg_per_positive", "eval_after_epochs", "split_ratio", "eps", "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(['gsasrec']):
+            raise ValueError("must be one of enum values ('gsasrec')")
+        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 ShapedInternalRecsysPoliciesGsasrecModelPolicyGsasrecModelPolicyGSASRecModelPolicyConfig 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 batch_size
+        if self.batch_size:
+            _dict['batch_size'] = self.batch_size.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()
+        # 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()
+        # override the default output from pydantic by calling `to_dict()` of sequence_length
+        if self.sequence_length:
+            _dict['sequence_length'] = self.sequence_length.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of embedding_dim
+        if self.embedding_dim:
+            _dict['embedding_dim'] = self.embedding_dim.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of num_heads
+        if self.num_heads:
+            _dict['num_heads'] = self.num_heads.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of num_blocks
+        if self.num_blocks:
+            _dict['num_blocks'] = self.num_blocks.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of dropout_rate
+        if self.dropout_rate:
+            _dict['dropout_rate'] = self.dropout_rate.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of neg_per_positive
+        if self.neg_per_positive:
+            _dict['neg_per_positive'] = self.neg_per_positive.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
+
+        # 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
+
+        # set to None if device (nullable) is None
+        # and model_fields_set contains the field
+        if self.device is None and "device" in self.model_fields_set:
+            _dict['device'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesGsasrecModelPolicyGsasrecModelPolicyGSASRecModelPolicyConfig 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 'gsasrec',
+            "name": obj.get("name"),
+            "event_values": obj.get("event_values"),
+            "batch_size": BatchSize1.from_dict(obj["batch_size"]) if obj.get("batch_size") is not None else None,
+            "eval_batch_size": obj.get("eval_batch_size") if obj.get("eval_batch_size") is not None else 32,
+            "n_epochs": NEpochs1.from_dict(obj["n_epochs"]) if obj.get("n_epochs") is not None else None,
+            "device": obj.get("device"),
+            "learning_rate": LearningRate.from_dict(obj["learning_rate"]) if obj.get("learning_rate") is not None else None,
+            "weight_decay": obj.get("weight_decay") if obj.get("weight_decay") is not None else 5.0E-4,
+            "patience": obj.get("patience") if obj.get("patience") is not None else 3,
+            "sequence_length": SequenceLength.from_dict(obj["sequence_length"]) if obj.get("sequence_length") is not None else None,
+            "embedding_dim": EmbeddingDim.from_dict(obj["embedding_dim"]) if obj.get("embedding_dim") is not None else None,
+            "num_heads": NumHeads.from_dict(obj["num_heads"]) if obj.get("num_heads") is not None else None,
+            "num_blocks": NumBlocks.from_dict(obj["num_blocks"]) if obj.get("num_blocks") is not None else None,
+            "dropout_rate": DropoutRate.from_dict(obj["dropout_rate"]) if obj.get("dropout_rate") is not None else None,
+            "reuse_item_embeddings": obj.get("reuse_item_embeddings") if obj.get("reuse_item_embeddings") is not None else False,
+            "max_batches_per_epoch": obj.get("max_batches_per_epoch") if obj.get("max_batches_per_epoch") is not None else 100,
+            "gbce_t": obj.get("gbce_t") if obj.get("gbce_t") is not None else 0.75,
+            "filter_rated": obj.get("filter_rated") if obj.get("filter_rated") is not None else False,
+            "neg_per_positive": NegPerPositive.from_dict(obj["neg_per_positive"]) if obj.get("neg_per_positive") is not None else None,
+            "eval_after_epochs": obj.get("eval_after_epochs") if obj.get("eval_after_epochs") is not None else 1,
+            "split_ratio": obj.get("split_ratio") if obj.get("split_ratio") is not None else 0.9,
+            "eps": obj.get("eps") if obj.get("eps") is not None else 1.0E-10,
+            "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_item2vec_model_policy_item2_vec_model_policy_config.py

@@ -0,0 +1,140 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.algorithm import Algorithm
+from shaped.autogen.models.embedding_size import EmbeddingSize
+from shaped.autogen.models.window_size import WindowSize
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ShapedInternalRecsysPoliciesItem2vecModelPolicyItem2VecModelPolicyConfig(BaseModel):
+    """
+    ShapedInternalRecsysPoliciesItem2vecModelPolicyItem2VecModelPolicyConfig
+    """ # noqa: E501
+    policy_type: Optional[StrictStr] = 'item2vec'
+    name: Optional[StrictStr] = None
+    event_values: Optional[List[StrictStr]] = None
+    embedding_size: Optional[EmbeddingSize] = None
+    window_size: Optional[WindowSize] = None
+    min_count: Optional[StrictInt] = Field(default=1, description="Minimum number of times an item must appear to be included in the vocabulary.")
+    algorithm: Optional[Algorithm] = None
+    max_window_size: Optional[StrictInt] = Field(default=50, description="Maximum window size for context.")
+    workers: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "embedding_size", "window_size", "min_count", "algorithm", "max_window_size", "workers"]
+
+    @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(['item2vec']):
+            raise ValueError("must be one of enum values ('item2vec')")
+        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 ShapedInternalRecsysPoliciesItem2vecModelPolicyItem2VecModelPolicyConfig 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 embedding_size
+        if self.embedding_size:
+            _dict['embedding_size'] = self.embedding_size.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of window_size
+        if self.window_size:
+            _dict['window_size'] = self.window_size.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of algorithm
+        if self.algorithm:
+            _dict['algorithm'] = self.algorithm.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
+
+        # set to None if workers (nullable) is None
+        # and model_fields_set contains the field
+        if self.workers is None and "workers" in self.model_fields_set:
+            _dict['workers'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ShapedInternalRecsysPoliciesItem2vecModelPolicyItem2VecModelPolicyConfig 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 'item2vec',
+            "name": obj.get("name"),
+            "event_values": obj.get("event_values"),
+            "embedding_size": EmbeddingSize.from_dict(obj["embedding_size"]) if obj.get("embedding_size") is not None else None,
+            "window_size": WindowSize.from_dict(obj["window_size"]) if obj.get("window_size") is not None else None,
+            "min_count": obj.get("min_count") if obj.get("min_count") is not None else 1,
+            "algorithm": Algorithm.from_dict(obj["algorithm"]) if obj.get("algorithm") is not None else None,
+            "max_window_size": obj.get("max_window_size") if obj.get("max_window_size") is not None else 50,
+            "workers": obj.get("workers")
+        })
+        return _obj
+
+