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

shaped/autogen/models/entity_journey.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.
@@ -19,6 +19,8 @@ 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.inner_entity_id import InnerEntityId
+from shaped.autogen.models.retrieval_scores_value import RetrievalScoresValue
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -27,18 +29,17 @@ class EntityJourney(BaseModel):
     Tracks a single entity's journey through the query pipeline.  Shows which retrievers found it, scores at each stage, filtering/reordering impact, and final position. Used in RankQueryConfig queries for both items and users.
     """ # noqa: E501
     entity_id: StrictStr = Field(description="External entity identifier (item_id or user_id as a string). This is the original ID format from your dataset.")
-    inner_entity_id: Optional[StrictInt] = None
+    inner_entity_id: Optional[InnerEntityId] = None
     retrieved_by: Optional[List[StrictStr]] = Field(default=None, description="List of retrieval step names that found this entity. Shows which retrievers contributed this entity to the candidate set.")
-    retrieval_scores: Optional[Dict[str, Union[StrictFloat, StrictInt]]] = Field(default=None, description="Scores from each retrieval step. Dictionary mapping step names to their scores for this entity.")
+    retrieval_scores: Optional[Dict[str, Optional[RetrievalScoresValue]]] = Field(default=None, description="Scores from each retrieval step. Dictionary mapping step names to their scores for this entity.")
     retrieval_rank: Optional[Dict[str, StrictInt]] = Field(default=None, description="Rank position from each retrieval step. Dictionary mapping step names to their rank positions for this entity.")
     filter_results: Optional[Dict[str, StrictBool]] = Field(default=None, description="Results from each filter step. Dictionary mapping filter step names to whether this entity passed (true) or failed (false) the filter.")
     filtered_out_by: Optional[StrictStr] = None
     score: Optional[Union[StrictFloat, StrictInt]] = None
     score_rank: Optional[StrictInt] = None
-    reorder_changes: Optional[List[Optional[Dict[str, Any]]]] = Field(default=None, description="List of position changes from reordering steps. Each entry contains step name, before position, and after position.")
+    reorder_changes: Optional[List[Dict[str, Any]]] = None
     final_position: Optional[StrictInt] = None
     final_score: Optional[Union[StrictFloat, StrictInt]] = None
-    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["entity_id", "inner_entity_id", "retrieved_by", "retrieval_scores", "retrieval_rank", "filter_results", "filtered_out_by", "score", "score_rank", "reorder_changes", "final_position", "final_score"]
 
     model_config = ConfigDict(
@@ -71,10 +72,8 @@ class EntityJourney(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(
@@ -82,11 +81,16 @@ class EntityJourney(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
-
+        # override the default output from pydantic by calling `to_dict()` of inner_entity_id
+        if self.inner_entity_id:
+            _dict['inner_entity_id'] = self.inner_entity_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in retrieval_scores (dict)
+        _field_dict = {}
+        if self.retrieval_scores:
+            for _key_retrieval_scores in self.retrieval_scores:
+                if self.retrieval_scores[_key_retrieval_scores]:
+                    _field_dict[_key_retrieval_scores] = self.retrieval_scores[_key_retrieval_scores].to_dict()
+            _dict['retrieval_scores'] = _field_dict
         # set to None if inner_entity_id (nullable) is None
         # and model_fields_set contains the field
         if self.inner_entity_id is None and "inner_entity_id" in self.model_fields_set:
@@ -107,6 +111,11 @@ class EntityJourney(BaseModel):
         if self.score_rank is None and "score_rank" in self.model_fields_set:
             _dict['score_rank'] = None
 
+        # set to None if reorder_changes (nullable) is None
+        # and model_fields_set contains the field
+        if self.reorder_changes is None and "reorder_changes" in self.model_fields_set:
+            _dict['reorder_changes'] = None
+
         # set to None if final_position (nullable) is None
         # and model_fields_set contains the field
         if self.final_position is None and "final_position" in self.model_fields_set:
@@ -130,9 +139,14 @@ class EntityJourney(BaseModel):
 
         _obj = cls.model_validate({
             "entity_id": obj.get("entity_id"),
-            "inner_entity_id": obj.get("inner_entity_id"),
+            "inner_entity_id": InnerEntityId.from_dict(obj["inner_entity_id"]) if obj.get("inner_entity_id") is not None else None,
             "retrieved_by": obj.get("retrieved_by"),
-            "retrieval_scores": obj.get("retrieval_scores"),
+            "retrieval_scores": dict(
+                (_k, RetrievalScoresValue.from_dict(_v))
+                for _k, _v in obj["retrieval_scores"].items()
+            )
+            if obj.get("retrieval_scores") is not None
+            else None,
             "retrieval_rank": obj.get("retrieval_rank"),
             "filter_results": obj.get("filter_results"),
             "filtered_out_by": obj.get("filtered_out_by"),
@@ -142,11 +156,6 @@ class EntityJourney(BaseModel):
             "final_position": obj.get("final_position"),
             "final_score": obj.get("final_score")
         })
-        # store additional fields in additional_properties
-        for _key in obj.keys():
-            if _key not in cls.__properties:
-                _obj.additional_properties[_key] = obj.get(_key)
-
         return _obj
 
 

shaped/autogen/models/entity_type.py

@@ -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/evaluation_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/exploration_reorder_step.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/expression_filter_step.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/factors.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/factors1.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/feature.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/feature_type.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/file_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/filter_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.
@@ -19,8 +19,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 +29,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 +72,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 +91,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_dataset.py

@@ -13,69 +13,83 @@
 
 
 from __future__ import annotations
+
 import json
 import pprint
-from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
-from typing import Any, List, Optional
+from typing import Any, Dict, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, ValidationError, field_validator
 from shaped.autogen.models.query_table_config import QueryTableConfig
 from shaped.autogen.models.reference_table_config import ReferenceTableConfig
-from pydantic import StrictStr, Field
-from typing import Union, List, Set, Optional, Dict
-from typing_extensions import Literal, Self
+from typing_extensions import Self
 
 FILTERDATASET_ONE_OF_SCHEMAS = ["QueryTableConfig", "ReferenceTableConfig"]
 
+
 class FilterDataset(BaseModel):
     """
     Dataset configuration for the filter source data.
     """
+
     # data type: QueryTableConfig
     oneof_schema_1_validator: Optional[QueryTableConfig] = None
     # data type: ReferenceTableConfig
     oneof_schema_2_validator: Optional[ReferenceTableConfig] = None
     actual_instance: Optional[Union[QueryTableConfig, ReferenceTableConfig]] = None
-    one_of_schemas: Set[str] = { "QueryTableConfig", "ReferenceTableConfig" }
+    one_of_schemas: Set[str] = {"QueryTableConfig", "ReferenceTableConfig"}
 
     model_config = ConfigDict(
         validate_assignment=True,
         protected_namespaces=(),
     )
 
-
-    discriminator_value_class_map: Dict[str, str] = {
-    }
+    discriminator_value_class_map: Dict[str, str] = {}
 
     def __init__(self, *args, **kwargs) -> None:
         if args:
             if len(args) > 1:
-                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+                raise ValueError(
+                    "If a position argument is used, only 1 is allowed to set `actual_instance`"
+                )
             if kwargs:
-                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+                raise ValueError(
+                    "If a position argument is used, keyword arguments cannot be used."
+                )
             super().__init__(actual_instance=args[0])
         else:
             super().__init__(**kwargs)
 
-    @field_validator('actual_instance')
+    @field_validator("actual_instance")
     def actual_instance_must_validate_oneof(cls, v):
         instance = FilterDataset.model_construct()
         error_messages = []
         match = 0
         # validate data type: QueryTableConfig
         if not isinstance(v, QueryTableConfig):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `QueryTableConfig`")
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `QueryTableConfig`"
+            )
         else:
             match += 1
         # validate data type: ReferenceTableConfig
         if not isinstance(v, ReferenceTableConfig):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `ReferenceTableConfig`")
+            error_messages.append(
+                f"Error! Input type `{type(v)}` is not `ReferenceTableConfig`"
+            )
         else:
             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 FilterDataset 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 FilterDataset with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: "
+                + ", ".join(error_messages)
+            )
         else:
             return v
 
@@ -105,10 +119,16 @@ 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 FilterDataset 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 FilterDataset with oneOf schemas: QueryTableConfig, ReferenceTableConfig. Details: "
+                + ", ".join(error_messages)
+            )
         else:
             return instance
 
@@ -117,17 +137,23 @@ class FilterDataset(BaseModel):
         if self.actual_instance is None:
             return "null"
 
-        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+        if hasattr(self.actual_instance, "to_json") and callable(
+            self.actual_instance.to_json
+        ):
             return self.actual_instance.to_json()
         else:
             return json.dumps(self.actual_instance)
 
-    def to_dict(self) -> Optional[Union[Dict[str, Any], QueryTableConfig, ReferenceTableConfig]]:
+    def to_dict(
+        self,
+    ) -> Optional[Union[Dict[str, Any], QueryTableConfig, ReferenceTableConfig]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None
 
-        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+        if hasattr(self.actual_instance, "to_dict") and callable(
+            self.actual_instance.to_dict
+        ):
             return self.actual_instance.to_dict()
         else:
             # primitive type
@@ -136,5 +162,3 @@ class FilterDataset(BaseModel):
     def to_str(self) -> str:
         """Returns the string representation of the actual instance"""
         return pprint.pformat(self.model_dump())
-
-

shaped/autogen/models/filter_index_type.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/filter_retrieve_step.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/filter_step_explanation.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.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, 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
+
+