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

shaped/autogen/models/score_ensemble.py

@@ -0,0 +1,127 @@
+# coding: utf-8
+
+"""
+    Shaped API
+
+    Welcome to Shaped's API reference docs. These provide a  detailed view of the endpoints and CLI commands that Shaped provides and brief  explanations of how they should be used.  The Shaped API has four main endpoints:  **Tables** - Provision and manage batch and real-time data connectors.   **Views** - Configure SQL transformations and AI enrichment on your input data. Use SQL to combine multiple data sources or use an LLM to add new categories, extract specific attributes from descriptions, etc.  **Engines** - Deploy and manage your relevance engines. The Engine API exposes configuration for indexing logic, input datasets, externam embeddings, and more.  **Query** - Execute queries against your engines, to return data based on an input query or rerank an existing list. The Query API exposes the retrieve, filter, score, and ranking steps of the 4-stage ranking architecture.  The base URL for each endpoint is: `https://api.shaped.ai/v2`
+
+    The version of the OpenAPI document: 2.0.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ScoreEnsemble(BaseModel):
+    """
+    Scores items using a model expression.  The value_model is a mathematical expression that references trained models. For single models, just use the model name (e.g., \"lightgbm_v1\"). For ensembles, use arithmetic (e.g., \"0.6 * lightgbm_v1 + 0.4 * xgboost_v2\").
+    """ # noqa: E501
+    value_model: StrictStr = Field(description="Mathematical expression combining model outputs (e.g., '0.6 * model1 + 0.4 * model2').")
+    input_user_id: Optional[StrictStr] = None
+    input_user_features: Optional[Dict[str, Any]] = None
+    input_interactions_item_ids: Optional[List[Any]] = None
+    name: Optional[StrictStr] = None
+    type: Optional[StrictStr] = Field(default='score_ensemble', description="Score step type discriminator.")
+    __properties: ClassVar[List[str]] = ["value_model", "input_user_id", "input_user_features", "input_interactions_item_ids", "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(['score_ensemble']):
+            raise ValueError("must be one of enum values ('score_ensemble')")
+        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 ScoreEnsemble 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 input_user_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.input_user_id is None and "input_user_id" in self.model_fields_set:
+            _dict['input_user_id'] = None
+
+        # set to None if input_user_features (nullable) is None
+        # and model_fields_set contains the field
+        if self.input_user_features is None and "input_user_features" in self.model_fields_set:
+            _dict['input_user_features'] = None
+
+        # set to None if input_interactions_item_ids (nullable) is None
+        # and model_fields_set contains the field
+        if self.input_interactions_item_ids is None and "input_interactions_item_ids" in self.model_fields_set:
+            _dict['input_interactions_item_ids'] = None
+
+        # set to None if name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScoreEnsemble from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "value_model": obj.get("value_model"),
+            "input_user_id": obj.get("input_user_id"),
+            "input_user_features": obj.get("input_user_features"),
+            "input_interactions_item_ids": obj.get("input_interactions_item_ids"),
+            "name": obj.get("name"),
+            "type": obj.get("type") if obj.get("type") is not None else 'score_ensemble'
+        })
+        return _obj
+
+

shaped/autogen/models/score_ensemble_policy_config.py

@@ -0,0 +1,165 @@
+# 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 typing_extensions import Self
+
+
+class ScoreEnsemblePolicyConfig(BaseModel):
+    """
+    Configuration for ScoreEnsemblePolicy.  This policy combines multiple scoring policies using a value model to determine the final scores.
+    """  # noqa: E501
+
+    policy_type: Optional[StrictStr] = "score-ensemble"
+    name: Optional[StrictStr] = None
+    policies: Optional[List[ScoreEnsemblePolicyConfigPoliciesInner]] = None
+    value_model: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = [
+        "policy_type",
+        "name",
+        "policies",
+        "value_model",
+    ]
+
+    @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(["score-ensemble"]):
+            raise ValueError("must be one of enum values ('score-ensemble')")
+        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 ScoreEnsemblePolicyConfig 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 item in policies (list)
+        _items = []
+        if self.policies:
+            for _item_policies in self.policies:
+                if _item_policies:
+                    _items.append(_item_policies.to_dict())
+            _dict["policies"] = _items
+        # 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 policies (nullable) is None
+        # and model_fields_set contains the field
+        if self.policies is None and "policies" in self.model_fields_set:
+            _dict["policies"] = 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
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ScoreEnsemblePolicyConfig 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 "score-ensemble"
+                ),
+                "name": obj.get("name"),
+                "policies": (
+                    [
+                        ScoreEnsemblePolicyConfigPoliciesInner.from_dict(_item)
+                        for _item in obj["policies"]
+                    ]
+                    if obj.get("policies") is not None
+                    else None
+                ),
+                "value_model": obj.get("value_model"),
+            }
+        )
+        # 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
+
+
+from shaped.autogen.models.score_ensemble_policy_config_policies_inner import (
+    ScoreEnsemblePolicyConfigPoliciesInner,
+)
+
+# TODO: Rewrite to not use raise_errors
+ScoreEnsemblePolicyConfig.model_rebuild(raise_errors=False)