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

shaped/autogen/models/factors.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations

shaped/autogen/models/factors1.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations

shaped/autogen/models/feature.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations

shaped/autogen/models/feature_type.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations

shaped/autogen/models/file_table_config.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations

shaped/autogen/models/filter_config.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations
@@ -19,8 +18,8 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List
-from shaped.autogen.models.filter_dataset import FilterDataset
-from shaped.autogen.models.type import Type
+from shaped.autogen.models.filter_table import FilterTable
+from shaped.autogen.models.filter_type import FilterType
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -29,9 +28,9 @@ class FilterConfig(BaseModel):
     FilterConfig
     """ # noqa: E501
     name: StrictStr = Field(description="Unique identifier for the filter.")
-    filter_dataset: FilterDataset
-    type: Type
-    __properties: ClassVar[List[str]] = ["name", "filter_dataset", "type"]
+    filter_table: FilterTable
+    filter_type: FilterType
+    __properties: ClassVar[List[str]] = ["name", "filter_table", "filter_type"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -72,12 +71,12 @@ class FilterConfig(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of filter_dataset
-        if self.filter_dataset:
-            _dict['filter_dataset'] = self.filter_dataset.to_dict()
-        # override the default output from pydantic by calling `to_dict()` of type
-        if self.type:
-            _dict['type'] = self.type.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of filter_table
+        if self.filter_table:
+            _dict['filter_table'] = self.filter_table.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of filter_type
+        if self.filter_type:
+            _dict['filter_type'] = self.filter_type.to_dict()
         return _dict
 
     @classmethod
@@ -91,8 +90,8 @@ class FilterConfig(BaseModel):
 
         _obj = cls.model_validate({
             "name": obj.get("name"),
-            "filter_dataset": FilterDataset.from_dict(obj["filter_dataset"]) if obj.get("filter_dataset") is not None else None,
-            "type": Type.from_dict(obj["type"]) if obj.get("type") is not None else None
+            "filter_table": FilterTable.from_dict(obj["filter_table"]) if obj.get("filter_table") is not None else None,
+            "filter_type": FilterType.from_dict(obj["filter_type"]) if obj.get("filter_type") is not None else None
         })
         return _obj
 

shaped/autogen/models/filter_index_type.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations

shaped/autogen/models/filter_retrieve_step.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations

shaped/autogen/models/filter_step_explanation.py

@@ -0,0 +1,164 @@
+# 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`
+
+ 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
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FilterStepExplanation(BaseModel):
+    """
+    Explanation for a filter 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.")
+    filter_type: Optional[StrictStr] = None
+    filter_name: Optional[StrictStr] = None
+    expression: Optional[StrictStr] = None
+    items_filtered: 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", "filter_type", "filter_name", "expression", "items_filtered"]
+
+    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 FilterStepExplanation 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 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 filter_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.filter_type is None and "filter_type" in self.model_fields_set:
+            _dict['filter_type'] = None
+
+        # set to None if filter_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.filter_name is None and "filter_name" in self.model_fields_set:
+            _dict['filter_name'] = None
+
+        # set to None if expression (nullable) is None
+        # and model_fields_set contains the field
+        if self.expression is None and "expression" in self.model_fields_set:
+            _dict['expression'] = None
+
+        # set to None if items_filtered (nullable) is None
+        # and model_fields_set contains the field
+        if self.items_filtered is None and "items_filtered" in self.model_fields_set:
+            _dict['items_filtered'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FilterStepExplanation 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"),
+            "filter_type": obj.get("filter_type"),
+            "filter_name": obj.get("filter_name"),
+            "expression": obj.get("expression"),
+            "items_filtered": obj.get("items_filtered")
+        })
+        # 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/{filter_dataset.py → filter_table.py}

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations
@@ -23,9 +22,9 @@ from pydantic import StrictStr, Field
 from typing import Union, List, Set, Optional, Dict
 from typing_extensions import Literal, Self
 
-FILTERDATASET_ONE_OF_SCHEMAS = ["QueryTableConfig", "ReferenceTableConfig"]
+FILTERTABLE_ONE_OF_SCHEMAS = ["QueryTableConfig", "ReferenceTableConfig"]
 
-class FilterDataset(BaseModel):
+class FilterTable(BaseModel):
     """
     Dataset configuration for the filter source data.
     """
@@ -57,7 +56,7 @@ class FilterDataset(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_oneof(cls, v):
-        instance = FilterDataset.model_construct()
+        instance = FilterTable.model_construct()
         error_messages = []
         match = 0
         # validate data type: QueryTableConfig
@@ -72,10 +71,10 @@ class FilterDataset(BaseModel):
             match += 1
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when setting `actual_instance` in FilterDataset with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when setting `actual_instance` in FilterTable with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when setting `actual_instance` in FilterDataset with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting `actual_instance` in FilterTable with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -105,10 +104,10 @@ class FilterDataset(BaseModel):
 
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when deserializing the JSON string into FilterDataset with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when deserializing the JSON string into FilterTable with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into FilterDataset with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into FilterTable with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: " + ", ".join(error_messages))
         else:
             return instance
 

shaped/autogen/models/{type.py → filter_type.py}

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations
@@ -25,9 +24,9 @@ from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
 from typing_extensions import Literal, Self
 from pydantic import Field
 
-TYPE_ANY_OF_SCHEMAS = ["GlobalFilter", "PersonalFilter"]
+FILTERTYPE_ANY_OF_SCHEMAS = ["GlobalFilter", "PersonalFilter"]
 
-class Type(BaseModel):
+class FilterType(BaseModel):
     """
     Filter type (personal or global).
     """
@@ -59,7 +58,7 @@ class Type(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_anyof(cls, v):
-        instance = Type.model_construct()
+        instance = FilterType.model_construct()
         error_messages = []
         # validate data type: PersonalFilter
         if not isinstance(v, PersonalFilter):
@@ -75,7 +74,7 @@ class Type(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when setting the actual_instance in Type with anyOf schemas: GlobalFilter, PersonalFilter. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting the actual_instance in FilterType with anyOf schemas: GlobalFilter, PersonalFilter. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -103,7 +102,7 @@ class Type(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into Type with anyOf schemas: GlobalFilter, PersonalFilter. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into FilterType with anyOf schemas: GlobalFilter, PersonalFilter. Details: " + ", ".join(error_messages))
         else:
             return instance
 

shaped/autogen/models/global_filter.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations

shaped/autogen/models/hidden_dropout_prob.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations

shaped/autogen/models/hidden_size.py

@@ -1,15 +1,14 @@
 # coding: utf-8
 
 """
-    Shaped API
+ 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`
+ 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)
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
 
-    Do not edit the class manually.
-"""  # noqa: E501
+ Do not edit the class manually.
+""" # noqa: E501
 
 
 from __future__ import annotations