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

shaped/autogen/models/score_step_explanation.py

@@ -0,0 +1,224 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from shaped.autogen.models.retrieval_scores_value import RetrievalScoresValue
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScoreStepExplanation(BaseModel):
+    """
+    Explanation for a scoring step.
+    """ # noqa: E501
+    step_name: Optional[StrictStr] = None
+    step_type: Optional[StrictStr] = Field(default='', description="Type of step. Examples: 'column_order', 'similarity', 'text_search', 'prebuilt', 'expression', 'score_ensemble', 'diversity', etc.")
+    input_count: Optional[StrictInt] = None
+    output_count: Optional[StrictInt] = None
+    filtered_count: Optional[StrictInt] = None
+    execution_time_ms: Optional[Union[StrictFloat, StrictInt]] = None
+    metadata: Optional[Dict[str, Any]] = Field(default=None, description="Additional step-specific metadata. Contains implementation details specific to the step type.")
+    score_type: Optional[StrictStr] = None
+    value_model: Optional[StrictStr] = None
+    score_distribution: Optional[Dict[str, Union[StrictFloat, StrictInt]]] = None
+    items_scored: Optional[StrictInt] = None
+    scoring_policy_scores: Optional[Dict[str, List[Optional[RetrievalScoresValue]]]] = None
+    is_user_found_in_feature_store: Optional[StrictBool] = None
+    user_interaction_count: Optional[StrictInt] = None
+    user_feature_column_count: Optional[StrictInt] = None
+    item_feature_column_count: Optional[StrictInt] = None
+    candidate_item_features_count: Optional[StrictInt] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["step_name", "step_type", "input_count", "output_count", "filtered_count", "execution_time_ms", "metadata", "score_type", "value_model", "score_distribution", "items_scored", "scoring_policy_scores", "is_user_found_in_feature_store", "user_interaction_count", "user_feature_column_count", "item_feature_column_count", "candidate_item_features_count"]
+
+    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 ScoreStepExplanation from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each value in scoring_policy_scores (dict of array)
+        _field_dict_of_array = {}
+        if self.scoring_policy_scores:
+            for _key_scoring_policy_scores in self.scoring_policy_scores:
+                if self.scoring_policy_scores[_key_scoring_policy_scores] is not None:
+                    _field_dict_of_array[_key_scoring_policy_scores] = [
+                        _item.to_dict() for _item in self.scoring_policy_scores[_key_scoring_policy_scores]
+                    ]
+            _dict['scoring_policy_scores'] = _field_dict_of_array
+        # 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 step_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.step_name is None and "step_name" in self.model_fields_set:
+            _dict['step_name'] = None
+
+        # set to None if input_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.input_count is None and "input_count" in self.model_fields_set:
+            _dict['input_count'] = None
+
+        # set to None if output_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.output_count is None and "output_count" in self.model_fields_set:
+            _dict['output_count'] = None
+
+        # set to None if filtered_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.filtered_count is None and "filtered_count" in self.model_fields_set:
+            _dict['filtered_count'] = None
+
+        # set to None if execution_time_ms (nullable) is None
+        # and model_fields_set contains the field
+        if self.execution_time_ms is None and "execution_time_ms" in self.model_fields_set:
+            _dict['execution_time_ms'] = None
+
+        # set to None if score_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.score_type is None and "score_type" in self.model_fields_set:
+            _dict['score_type'] = None
+
+        # set to None if value_model (nullable) is None
+        # and model_fields_set contains the field
+        if self.value_model is None and "value_model" in self.model_fields_set:
+            _dict['value_model'] = None
+
+        # set to None if score_distribution (nullable) is None
+        # and model_fields_set contains the field
+        if self.score_distribution is None and "score_distribution" in self.model_fields_set:
+            _dict['score_distribution'] = None
+
+        # set to None if items_scored (nullable) is None
+        # and model_fields_set contains the field
+        if self.items_scored is None and "items_scored" in self.model_fields_set:
+            _dict['items_scored'] = None
+
+        # set to None if scoring_policy_scores (nullable) is None
+        # and model_fields_set contains the field
+        if self.scoring_policy_scores is None and "scoring_policy_scores" in self.model_fields_set:
+            _dict['scoring_policy_scores'] = None
+
+        # set to None if is_user_found_in_feature_store (nullable) is None
+        # and model_fields_set contains the field
+        if self.is_user_found_in_feature_store is None and "is_user_found_in_feature_store" in self.model_fields_set:
+            _dict['is_user_found_in_feature_store'] = None
+
+        # set to None if user_interaction_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_interaction_count is None and "user_interaction_count" in self.model_fields_set:
+            _dict['user_interaction_count'] = None
+
+        # set to None if user_feature_column_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_feature_column_count is None and "user_feature_column_count" in self.model_fields_set:
+            _dict['user_feature_column_count'] = None
+
+        # set to None if item_feature_column_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.item_feature_column_count is None and "item_feature_column_count" in self.model_fields_set:
+            _dict['item_feature_column_count'] = None
+
+        # set to None if candidate_item_features_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.candidate_item_features_count is None and "candidate_item_features_count" in self.model_fields_set:
+            _dict['candidate_item_features_count'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScoreStepExplanation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "step_name": obj.get("step_name"),
+            "step_type": obj.get("step_type") if obj.get("step_type") is not None else '',
+            "input_count": obj.get("input_count"),
+            "output_count": obj.get("output_count"),
+            "filtered_count": obj.get("filtered_count"),
+            "execution_time_ms": obj.get("execution_time_ms"),
+            "metadata": obj.get("metadata"),
+            "score_type": obj.get("score_type"),
+            "value_model": obj.get("value_model"),
+            "score_distribution": obj.get("score_distribution"),
+            "items_scored": obj.get("items_scored"),
+            "scoring_policy_scores": dict(
+                (_k,
+                        [RetrievalScoresValue.from_dict(_item) for _item in _v]
+                        if _v is not None
+                        else None
+                )
+                for _k, _v in obj.get("scoring_policy_scores", {}).items()
+            ),
+            "is_user_found_in_feature_store": obj.get("is_user_found_in_feature_store"),
+            "user_interaction_count": obj.get("user_interaction_count"),
+            "user_feature_column_count": obj.get("user_feature_column_count"),
+            "item_feature_column_count": obj.get("item_feature_column_count"),
+            "candidate_item_features_count": obj.get("candidate_item_features_count")
+        })
+        # 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/search_config.py

@@ -5,7 +5,7 @@
 
     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
+    The version of the OpenAPI document: 2.0.4
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

shaped/autogen/models/segment_table_config.py

@@ -5,7 +5,7 @@
 
     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
+    The version of the OpenAPI document: 2.0.4
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

shaped/autogen/models/sequence_length.py

@@ -5,7 +5,7 @@
 
     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
+    The version of the OpenAPI document: 2.0.4
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

shaped/autogen/models/server_config.py

@@ -5,7 +5,7 @@
 
     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
+    The version of the OpenAPI document: 2.0.4
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -27,6 +27,7 @@ class ServerConfig(BaseModel):
     Low-level configuration for the inference server process.
     """ # noqa: E501
     worker_count: Optional[StrictInt] = Field(default=1, description="Number of worker processes per inference pod.")
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["worker_count"]
 
     model_config = ConfigDict(
@@ -59,8 +60,10 @@ class ServerConfig(BaseModel):
         * `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(
@@ -68,6 +71,11 @@ class ServerConfig(BaseModel):
             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
+
         return _dict
 
     @classmethod
@@ -82,6 +90,11 @@ class ServerConfig(BaseModel):
         _obj = cls.model_validate({
             "worker_count": obj.get("worker_count") if obj.get("worker_count") is not None else 1
         })
+        # 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/setup_engine_response.py

@@ -5,7 +5,7 @@
 
     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
+    The version of the OpenAPI document: 2.0.4
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.

shaped/autogen/models/shaped_internal_recsys_policies_als_model_policy_als_model_policy_config.py

@@ -5,7 +5,7 @@
 
     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
+    The version of the OpenAPI document: 2.0.4
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -38,8 +38,11 @@ class ShapedInternalRecsysPoliciesAlsModelPolicyALSModelPolicyConfig(BaseModel):
     bm25_k1: Optional[Union[StrictFloat, StrictInt]] = Field(default=1.2, description="BM25 coefficient for item frequency factor.")
     bm25_b: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.75, description="BM25 coefficient for document length factor.")
     use_features: Optional[StrictBool] = Field(default=False, description="Whether to use entity features in the model.")
+    normalize_numerical_features: Optional[StrictBool] = Field(default=False, description="Enable NormalizeNumerical transform for entity features.")
+    use_derived_timestamp_features: Optional[StrictBool] = Field(default=False, description="Enable TimestampSinCosEncoder and TimestampCountEncoder for entity features.")
+    balance_labels: Optional[StrictBool] = Field(default=False, description="Enable BalanceLabel transform for interactions.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "factors", "regularization", "bm25", "bm25_k1", "bm25_b", "use_features"]
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "factors", "regularization", "bm25", "bm25_k1", "bm25_b", "use_features", "normalize_numerical_features", "use_derived_timestamp_features", "balance_labels"]
 
     @field_validator('policy_type')
     def policy_type_validate_enum(cls, value):
@@ -136,7 +139,10 @@ class ShapedInternalRecsysPoliciesAlsModelPolicyALSModelPolicyConfig(BaseModel):
             "bm25": Bm25.from_dict(obj["bm25"]) if obj.get("bm25") is not None else None,
             "bm25_k1": obj.get("bm25_k1") if obj.get("bm25_k1") is not None else 1.2,
             "bm25_b": obj.get("bm25_b") if obj.get("bm25_b") is not None else 0.75,
-            "use_features": obj.get("use_features") if obj.get("use_features") is not None else False
+            "use_features": obj.get("use_features") if obj.get("use_features") is not None else False,
+            "normalize_numerical_features": obj.get("normalize_numerical_features") if obj.get("normalize_numerical_features") is not None else False,
+            "use_derived_timestamp_features": obj.get("use_derived_timestamp_features") if obj.get("use_derived_timestamp_features") is not None else False,
+            "balance_labels": obj.get("balance_labels") if obj.get("balance_labels") is not None else False
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

shaped/autogen/models/shaped_internal_recsys_policies_beeformer_model_policy_beeformer_model_policy_beeformer_model_policy_config.py

@@ -5,7 +5,7 @@
 
     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
+    The version of the OpenAPI document: 2.0.4
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -45,7 +45,10 @@ class ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeefor
     max_seq_length: Optional[MaxSeqLength] = None
     embedder_batch_size: Optional[EmbedderBatchSize] = None
     train_distributed: Optional[StrictBool] = Field(default=False, description="Train on multiple devices.")
-    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "device", "seed", "lr", "use_scheduler", "epochs", "max_output", "batch_size", "top_k", "embedder", "use_images", "max_seq_length", "embedder_batch_size", "train_distributed"]
+    normalize_numerical_features: Optional[StrictBool] = Field(default=False, description="Enable NormalizeNumerical transform for entity features.")
+    use_derived_timestamp_features: Optional[StrictBool] = Field(default=False, description="Enable TimestampSinCosEncoder and TimestampCountEncoder for entity features.")
+    balance_labels: Optional[StrictBool] = Field(default=False, description="Enable BalanceLabel transform for interactions.")
+    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "device", "seed", "lr", "use_scheduler", "epochs", "max_output", "batch_size", "top_k", "embedder", "use_images", "max_seq_length", "embedder_batch_size", "train_distributed", "normalize_numerical_features", "use_derived_timestamp_features", "balance_labels"]
 
     @field_validator('policy_type')
     def policy_type_validate_enum(cls, value):
@@ -147,7 +150,10 @@ class ShapedInternalRecsysPoliciesBeeformerModelPolicyBeeformerModelPolicyBeefor
             "use_images": obj.get("use_images") if obj.get("use_images") is not None else False,
             "max_seq_length": MaxSeqLength.from_dict(obj["max_seq_length"]) if obj.get("max_seq_length") is not None else None,
             "embedder_batch_size": EmbedderBatchSize.from_dict(obj["embedder_batch_size"]) if obj.get("embedder_batch_size") is not None else None,
-            "train_distributed": obj.get("train_distributed") if obj.get("train_distributed") is not None else False
+            "train_distributed": obj.get("train_distributed") if obj.get("train_distributed") is not None else False,
+            "normalize_numerical_features": obj.get("normalize_numerical_features") if obj.get("normalize_numerical_features") is not None else False,
+            "use_derived_timestamp_features": obj.get("use_derived_timestamp_features") if obj.get("use_derived_timestamp_features") is not None else False,
+            "balance_labels": obj.get("balance_labels") if obj.get("balance_labels") is not None else False
         })
         return _obj
 

shaped/autogen/models/shaped_internal_recsys_policies_bert_model_policy_bert_model_policy_bert_model_policy_config.py

@@ -5,7 +5,7 @@
 
     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
+    The version of the OpenAPI document: 2.0.4
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+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.attn_dropout_prob import AttnDropoutProb
 from shaped.autogen.models.batch_size import BatchSize
@@ -64,7 +64,10 @@ class ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyC
     sample_ratio: Optional[Union[StrictFloat, StrictInt]] = 0.8
     eval_step: Optional[StrictInt] = 1
     early_stopping_step: Optional[StrictInt] = 5
-    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "batch_size", "eval_batch_size", "n_epochs", "negative_samples_count", "device", "hidden_size", "inner_size", "learning_rate", "attn_dropout_prob", "hidden_act", "hidden_dropout_prob", "n_heads", "n_layers", "layer_norm_eps", "initializer_range", "mask_rate", "loss_type", "max_seq_length", "sample_strategy", "sample_seed", "sample_ratio", "eval_step", "early_stopping_step"]
+    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", "batch_size", "eval_batch_size", "n_epochs", "negative_samples_count", "device", "hidden_size", "inner_size", "learning_rate", "attn_dropout_prob", "hidden_act", "hidden_dropout_prob", "n_heads", "n_layers", "layer_norm_eps", "initializer_range", "mask_rate", "loss_type", "max_seq_length", "sample_strategy", "sample_seed", "sample_ratio", "eval_step", "early_stopping_step", "normalize_numerical_features", "use_derived_timestamp_features", "balance_labels"]
 
     @field_validator('policy_type')
     def policy_type_validate_enum(cls, value):
@@ -202,7 +205,10 @@ class ShapedInternalRecsysPoliciesBertModelPolicyBertModelPolicyBERTModelPolicyC
             "sample_seed": obj.get("sample_seed") if obj.get("sample_seed") is not None else 42,
             "sample_ratio": obj.get("sample_ratio") if obj.get("sample_ratio") is not None else 0.8,
             "eval_step": obj.get("eval_step") if obj.get("eval_step") is not None else 1,
-            "early_stopping_step": obj.get("early_stopping_step") if obj.get("early_stopping_step") is not None else 5
+            "early_stopping_step": obj.get("early_stopping_step") if obj.get("early_stopping_step") is not None else 5,
+            "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/shaped_internal_recsys_policies_chronological_model_policy_chronological_model_policy_config.py

@@ -13,35 +13,45 @@
 
 
 from __future__ import annotations
+
+import json
 import pprint
 import re  # noqa: F401
-import json
+from typing import Any, ClassVar, Dict, List, Optional, Set
 
 from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
-from typing import Any, ClassVar, Dict, List, Optional
 from shaped.autogen.models.ascending import Ascending
-from typing import Optional, Set
 from typing_extensions import Self
 
-class ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig(BaseModel):
+
+class ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig(
+    BaseModel
+):
     """
     ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPolicyConfig
-    """ # noqa: E501
-    policy_type: Optional[StrictStr] = 'chronological'
+    """  # 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')
+    __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']):
+        if value not in set(["chronological"]):
             raise ValueError("must be one of enum values ('chronological')")
         return value
 
@@ -51,7 +61,6 @@ class ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPoli
         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))
@@ -77,9 +86,11 @@ class ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPoli
           are ignored.
         * Fields in `self.additional_properties` are added to the output dict.
         """
-        excluded_fields: Set[str] = set([
-            "additional_properties",
-        ])
+        excluded_fields: Set[str] = set(
+            [
+                "additional_properties",
+            ]
+        )
 
         _dict = self.model_dump(
             by_alias=True,
@@ -88,7 +99,7 @@ class ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPoli
         )
         # override the default output from pydantic by calling `to_dict()` of ascending
         if self.ascending:
-            _dict['ascending'] = self.ascending.to_dict()
+            _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():
@@ -97,17 +108,17 @@ class ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPoli
         # 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
+            _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
+            _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
+            _dict["time_col"] = None
 
         return _dict
 
@@ -120,18 +131,26 @@ class ShapedInternalRecsysPoliciesChronologicalModelPolicyChronologicalModelPoli
         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
-        })
+        _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

@@ -5,7 +5,7 @@
 
     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
+    The version of the OpenAPI document: 2.0.4
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+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
@@ -39,7 +39,8 @@ class ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyC
     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.")
-    __properties: ClassVar[List[str]] = ["policy_type", "name", "event_values", "batch_size", "n_epochs", "factors", "lr", "device", "strategy", "patience"]
+    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):
@@ -132,7 +133,8 @@ class ShapedInternalRecsysPoliciesElsaModelPolicyElsaModelPolicyELSAModelPolicyC
             "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
+            "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