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

shaped/autogen/models/query.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,27 +18,27 @@ import pprint
 import re  # noqa: F401
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
 from typing import Optional
-from shaped.autogen.models.query_any_of import QueryAnyOf
+from shaped.autogen.models.query_config import QueryConfig
 from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
 from typing_extensions import Literal, Self
 from pydantic import Field
 
-QUERY_ANY_OF_SCHEMAS = ["QueryAnyOf", "str"]
+QUERY_ANY_OF_SCHEMAS = ["QueryConfig", "str"]
 
 class Query(BaseModel):
     """
     Query configuration pipeline or SQL query string. Can be either a QueryConfig object or a SQL query string that will be transpiled to a QueryConfig at initialization time.
     """
 
-    # data type: QueryAnyOf
-    anyof_schema_1_validator: Optional[QueryAnyOf] = None
+    # data type: QueryConfig
+    anyof_schema_1_validator: Optional[QueryConfig] = None
     # data type: str
     anyof_schema_2_validator: Optional[StrictStr] = None
     if TYPE_CHECKING:
-        actual_instance: Optional[Union[QueryAnyOf, str]] = None
+        actual_instance: Optional[Union[QueryConfig, str]] = None
     else:
         actual_instance: Any = None
-    any_of_schemas: Set[str] = { "QueryAnyOf", "str" }
+    any_of_schemas: Set[str] = { "QueryConfig", "str" }
 
     model_config = {
         "validate_assignment": True,
@@ -60,9 +59,9 @@ class Query(BaseModel):
     def actual_instance_must_validate_anyof(cls, v):
         instance = Query.model_construct()
         error_messages = []
-        # validate data type: QueryAnyOf
-        if not isinstance(v, QueryAnyOf):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `QueryAnyOf`")
+        # validate data type: QueryConfig
+        if not isinstance(v, QueryConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `QueryConfig`")
         else:
             return v
 
@@ -74,7 +73,7 @@ class Query(BaseModel):
             error_messages.append(str(e))
         if error_messages:
             # no match
-            raise ValueError("No match found when setting the actual_instance in Query with anyOf schemas: QueryAnyOf, str. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting the actual_instance in Query with anyOf schemas: QueryConfig, str. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -87,9 +86,9 @@ class Query(BaseModel):
         """Returns the object represented by the json string"""
         instance = cls.model_construct()
         error_messages = []
-        # anyof_schema_1_validator: Optional[QueryAnyOf] = None
+        # anyof_schema_1_validator: Optional[QueryConfig] = None
         try:
-            instance.actual_instance = QueryAnyOf.from_json(json_str)
+            instance.actual_instance = QueryConfig.from_json(json_str)
             return instance
         except (ValidationError, ValueError) as e:
              error_messages.append(str(e))
@@ -105,7 +104,7 @@ class Query(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into Query with anyOf schemas: QueryAnyOf, str. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into Query with anyOf schemas: QueryConfig, str. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -119,7 +118,7 @@ class Query(BaseModel):
         else:
             return json.dumps(self.actual_instance)
 
-    def to_dict(self) -> Optional[Union[Dict[str, Any], QueryAnyOf, str]]:
+    def to_dict(self) -> Optional[Union[Dict[str, Any], QueryConfig, str]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None

shaped/autogen/models/query1.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,27 +18,27 @@ import pprint
 import re  # noqa: F401
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
 from typing import Optional
-from shaped.autogen.models.query_any_of import QueryAnyOf
+from shaped.autogen.models.query_config import QueryConfig
 from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
 from typing_extensions import Literal, Self
 from pydantic import Field
 
-QUERY1_ANY_OF_SCHEMAS = ["QueryAnyOf", "str"]
+QUERY1_ANY_OF_SCHEMAS = ["QueryConfig", "str"]
 
 class Query1(BaseModel):
     """
     Query configuration or SQL query string. Can be either: - A QueryConfig object defining the retrieval, filtering, scoring, and reordering pipeline. Must include a 'type' field indicating the query type (rank_items, rank_users, rerank_items, etc.). - A SQL query string that will be transpiled to a QueryConfig. Supports a subset of SQL with custom REORDER BY clause.
     """
 
-    # data type: QueryAnyOf
-    anyof_schema_1_validator: Optional[QueryAnyOf] = None
+    # data type: QueryConfig
+    anyof_schema_1_validator: Optional[QueryConfig] = None
     # data type: str
     anyof_schema_2_validator: Optional[StrictStr] = None
     if TYPE_CHECKING:
-        actual_instance: Optional[Union[QueryAnyOf, str]] = None
+        actual_instance: Optional[Union[QueryConfig, str]] = None
     else:
         actual_instance: Any = None
-    any_of_schemas: Set[str] = { "QueryAnyOf", "str" }
+    any_of_schemas: Set[str] = { "QueryConfig", "str" }
 
     model_config = {
         "validate_assignment": True,
@@ -60,9 +59,9 @@ class Query1(BaseModel):
     def actual_instance_must_validate_anyof(cls, v):
         instance = Query1.model_construct()
         error_messages = []
-        # validate data type: QueryAnyOf
-        if not isinstance(v, QueryAnyOf):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `QueryAnyOf`")
+        # validate data type: QueryConfig
+        if not isinstance(v, QueryConfig):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `QueryConfig`")
         else:
             return v
 
@@ -74,7 +73,7 @@ class Query1(BaseModel):
             error_messages.append(str(e))
         if error_messages:
             # no match
-            raise ValueError("No match found when setting the actual_instance in Query1 with anyOf schemas: QueryAnyOf, str. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting the actual_instance in Query1 with anyOf schemas: QueryConfig, str. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -87,9 +86,9 @@ class Query1(BaseModel):
         """Returns the object represented by the json string"""
         instance = cls.model_construct()
         error_messages = []
-        # anyof_schema_1_validator: Optional[QueryAnyOf] = None
+        # anyof_schema_1_validator: Optional[QueryConfig] = None
         try:
-            instance.actual_instance = QueryAnyOf.from_json(json_str)
+            instance.actual_instance = QueryConfig.from_json(json_str)
             return instance
         except (ValidationError, ValueError) as e:
              error_messages.append(str(e))
@@ -105,7 +104,7 @@ class Query1(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into Query1 with anyOf schemas: QueryAnyOf, str. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into Query1 with anyOf schemas: QueryConfig, str. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -119,7 +118,7 @@ class Query1(BaseModel):
         else:
             return json.dumps(self.actual_instance)
 
-    def to_dict(self) -> Optional[Union[Dict[str, Any], QueryAnyOf, str]]:
+    def to_dict(self) -> Optional[Union[Dict[str, Any], QueryConfig, str]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None

shaped/autogen/models/{query_any_of.py → query_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
@@ -23,11 +22,11 @@ from pydantic import StrictStr, Field
 from typing import Union, List, Set, Optional, Dict
 from typing_extensions import Literal, Self
 
-QUERYANYOF_ONE_OF_SCHEMAS = ["RankItemAttributeValuesQueryConfig", "RankQueryConfig"]
+QUERYCONFIG_ONE_OF_SCHEMAS = ["RankItemAttributeValuesQueryConfig", "RankQueryConfig"]
 
-class QueryAnyOf(BaseModel):
+class QueryConfig(BaseModel):
     """
-    QueryAnyOf
+    QueryConfig
     """
     # data type: RankQueryConfig
     oneof_schema_1_validator: Optional[RankQueryConfig] = None
@@ -57,7 +56,7 @@ class QueryAnyOf(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_oneof(cls, v):
-        instance = QueryAnyOf.model_construct()
+        instance = QueryConfig.model_construct()
         error_messages = []
         match = 0
         # validate data type: RankQueryConfig
@@ -72,10 +71,10 @@ class QueryAnyOf(BaseModel):
             match += 1
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when setting `actual_instance` in QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when setting `actual_instance` in QueryConfig with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when setting `actual_instance` in QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting `actual_instance` in QueryConfig with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -105,10 +104,10 @@ class QueryAnyOf(BaseModel):
 
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when deserializing the JSON string into QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when deserializing the JSON string into QueryConfig with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into QueryAnyOf with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into QueryConfig with oneOf schemas: RankItemAttributeValuesQueryConfig, RankQueryConfig. Details: " + ", ".join(error_messages))
         else:
             return instance
 

shaped/autogen/models/query_definition.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/query_encoder.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/query_explanation.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,6 +18,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
+from shaped.autogen.models.inner_uid import InnerUid
 from shaped.autogen.models.pipeline_stage_explanation import PipelineStageExplanation
 from typing import Optional, Set
 from typing_extensions import Self
@@ -38,7 +38,7 @@ class QueryExplanation(BaseModel):
     total_execution_time_ms: Optional[Union[StrictFloat, StrictInt]] = None
     final_result_count: Optional[StrictInt] = None
     limit_applied: Optional[StrictInt] = None
-    inner_uid: Optional[StrictInt] = None
+    inner_uid: Optional[InnerUid] = None
     outer_uid: Optional[StrictStr] = None
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["query_name", "query_type", "parameters", "pagination_id", "retrieve_stage", "filter_stage", "score_stage", "reorder_stage", "total_execution_time_ms", "final_result_count", "limit_applied", "inner_uid", "outer_uid"]
@@ -96,6 +96,9 @@ class QueryExplanation(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of reorder_stage
         if self.reorder_stage:
             _dict['reorder_stage'] = self.reorder_stage.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of inner_uid
+        if self.inner_uid:
+            _dict['inner_uid'] = self.inner_uid.to_dict()
         # puts key-value pairs in additional_properties in the top level
         if self.additional_properties is not None:
             for _key, _value in self.additional_properties.items():
@@ -184,7 +187,7 @@ class QueryExplanation(BaseModel):
             "total_execution_time_ms": obj.get("total_execution_time_ms"),
             "final_result_count": obj.get("final_result_count"),
             "limit_applied": obj.get("limit_applied"),
-            "inner_uid": obj.get("inner_uid"),
+            "inner_uid": InnerUid.from_dict(obj["inner_uid"]) if obj.get("inner_uid") is not None else None,
             "outer_uid": obj.get("outer_uid")
         })
         # store additional fields in additional_properties

shaped/autogen/models/query_request.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/query_result.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/query_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/rank_item_attribute_values_query_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/rank_query_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
@@ -21,8 +20,8 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_v
 from typing import Any, ClassVar, Dict, List, Optional
 from shaped.autogen.models.entity_type import EntityType
 from shaped.autogen.models.rank_query_config_filter_inner import RankQueryConfigFilterInner
-from shaped.autogen.models.rank_query_config_reorder_inner import RankQueryConfigReorderInner
-from shaped.autogen.models.rank_query_config_retrieve_inner import RankQueryConfigRetrieveInner
+from shaped.autogen.models.reorder_inner import ReorderInner
+from shaped.autogen.models.retrieve_inner import RetrieveInner
 from shaped.autogen.models.score import Score
 from typing import Optional, Set
 from typing_extensions import Self
@@ -33,10 +32,10 @@ class RankQueryConfig(BaseModel):
     """ # noqa: E501
     columns: Optional[List[StrictStr]] = None
     embeddings: Optional[List[StrictStr]] = None
-    retrieve: Optional[List[RankQueryConfigRetrieveInner]] = Field(default=None, description="List of retrieval steps to execute.")
+    retrieve: Optional[List[RetrieveInner]] = Field(default=None, description="List of retrieval steps to execute.")
     filter: Optional[List[RankQueryConfigFilterInner]] = None
     score: Optional[Score] = None
-    reorder: Optional[List[RankQueryConfigReorderInner]] = Field(default=None, description="List of reordering steps to apply.")
+    reorder: Optional[List[ReorderInner]] = Field(default=None, description="List of reordering steps to apply.")
     limit: Optional[StrictInt] = None
     type: Optional[StrictStr] = Field(default='rank', description="Query config type discriminator.")
     var_from: Optional[EntityType] = Field(default=None, alias="from")
@@ -154,10 +153,10 @@ class RankQueryConfig(BaseModel):
         _obj = cls.model_validate({
             "columns": obj.get("columns"),
             "embeddings": obj.get("embeddings"),
-            "retrieve": [RankQueryConfigRetrieveInner.from_dict(_item) for _item in obj["retrieve"]] if obj.get("retrieve") is not None else None,
+            "retrieve": [RetrieveInner.from_dict(_item) for _item in obj["retrieve"]] if obj.get("retrieve") is not None else None,
             "filter": [RankQueryConfigFilterInner.from_dict(_item) for _item in obj["filter"]] if obj.get("filter") is not None else None,
             "score": Score.from_dict(obj["score"]) if obj.get("score") is not None else None,
-            "reorder": [RankQueryConfigReorderInner.from_dict(_item) for _item in obj["reorder"]] if obj.get("reorder") is not None else None,
+            "reorder": [ReorderInner.from_dict(_item) for _item in obj["reorder"]] if obj.get("reorder") is not None else None,
             "limit": obj.get("limit"),
             "type": obj.get("type") if obj.get("type") is not None else 'rank',
             "from": obj.get("from")

shaped/autogen/models/rank_query_config_filter_inner.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/recreate_rollout.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