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

shaped/autogen/models/{ascending.py → retrieval_scores_value.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
@@ -17,29 +16,26 @@ from inspect import getfullargspec
 import json
 import pprint
 import re  # noqa: F401
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, ValidationError, field_validator
-from typing import Optional
-from shaped.autogen.models.tunable_bool import TunableBool
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, ValidationError, field_validator
+from typing import Optional, Union
 from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
 from typing_extensions import Literal, Self
 from pydantic import Field
 
-ASCENDING_ANY_OF_SCHEMAS = ["TunableBool", "bool"]
+RETRIEVALSCORESVALUE_ANY_OF_SCHEMAS = ["float"]
 
-class Ascending(BaseModel):
+class RetrievalScoresValue(BaseModel):
     """
-    Ascending
+    RetrievalScoresValue
     """
 
-    # data type: bool
-    anyof_schema_1_validator: Optional[StrictBool] = None
-    # data type: TunableBool
-    anyof_schema_2_validator: Optional[TunableBool] = None
+    # data type: float
+    anyof_schema_1_validator: Optional[Union[StrictFloat, StrictInt]] = None
     if TYPE_CHECKING:
-        actual_instance: Optional[Union[TunableBool, bool]] = None
+        actual_instance: Optional[Union[float]] = None
     else:
         actual_instance: Any = None
-    any_of_schemas: Set[str] = { "TunableBool", "bool" }
+    any_of_schemas: Set[str] = { "float" }
 
     model_config = {
         "validate_assignment": True,
@@ -58,23 +54,20 @@ class Ascending(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_anyof(cls, v):
-        instance = Ascending.model_construct()
+        if v is None:
+            return v
+
+        instance = RetrievalScoresValue.model_construct()
         error_messages = []
-        # validate data type: bool
+        # validate data type: float
         try:
             instance.anyof_schema_1_validator = v
             return v
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
-        # validate data type: TunableBool
-        if not isinstance(v, TunableBool):
-            error_messages.append(f"Error! Input type `{type(v)}` is not `TunableBool`")
-        else:
-            return v
-
         if error_messages:
             # no match
-            raise ValueError("No match found when setting the actual_instance in Ascending with anyOf schemas: TunableBool, bool. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting the actual_instance in RetrievalScoresValue with anyOf schemas: float. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -86,8 +79,11 @@ class Ascending(BaseModel):
     def from_json(cls, json_str: str) -> Self:
         """Returns the object represented by the json string"""
         instance = cls.model_construct()
+        if json_str is None:
+            return instance
+
         error_messages = []
-        # deserialize data into bool
+        # deserialize data into float
         try:
             # validation
             instance.anyof_schema_1_validator = json.loads(json_str)
@@ -96,16 +92,10 @@ class Ascending(BaseModel):
             return instance
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
-        # anyof_schema_2_validator: Optional[TunableBool] = None
-        try:
-            instance.actual_instance = TunableBool.from_json(json_str)
-            return instance
-        except (ValidationError, ValueError) as e:
-             error_messages.append(str(e))
 
         if error_messages:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into Ascending with anyOf schemas: TunableBool, bool. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into RetrievalScoresValue with anyOf schemas: float. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -119,7 +109,7 @@ class Ascending(BaseModel):
         else:
             return json.dumps(self.actual_instance)
 
-    def to_dict(self) -> Optional[Union[Dict[str, Any], TunableBool, bool]]:
+    def to_dict(self) -> Optional[Union[Dict[str, Any], float]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None

shaped/autogen/models/{rank_query_config_retrieve_inner.py → retrieve_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
@@ -27,11 +26,11 @@ from pydantic import StrictStr, Field
 from typing import Union, List, Set, Optional, Dict
 from typing_extensions import Literal, Self
 
-RANKQUERYCONFIGRETRIEVEINNER_ONE_OF_SCHEMAS = ["CandidateAttributesRetrieveStep", "CandidateIdsRetrieveStep", "ColumnOrderRetrieveStep", "FilterRetrieveStep", "SimilarityRetrieveStep", "TextSearchRetrieveStep"]
+RETRIEVEINNER_ONE_OF_SCHEMAS = ["CandidateAttributesRetrieveStep", "CandidateIdsRetrieveStep", "ColumnOrderRetrieveStep", "FilterRetrieveStep", "SimilarityRetrieveStep", "TextSearchRetrieveStep"]
 
-class RankQueryConfigRetrieveInner(BaseModel):
+class RetrieveInner(BaseModel):
     """
-    RankQueryConfigRetrieveInner
+    RetrieveInner
     """
     # data type: ColumnOrderRetrieveStep
     oneof_schema_1_validator: Optional[ColumnOrderRetrieveStep] = None
@@ -69,7 +68,7 @@ class RankQueryConfigRetrieveInner(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_oneof(cls, v):
-        instance = RankQueryConfigRetrieveInner.model_construct()
+        instance = RetrieveInner.model_construct()
         error_messages = []
         match = 0
         # validate data type: ColumnOrderRetrieveStep
@@ -104,10 +103,10 @@ class RankQueryConfigRetrieveInner(BaseModel):
             match += 1
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when setting `actual_instance` in RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when setting `actual_instance` in RetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when setting `actual_instance` in RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting `actual_instance` in RetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -161,10 +160,10 @@ class RankQueryConfigRetrieveInner(BaseModel):
 
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when deserializing the JSON string into RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when deserializing the JSON string into RetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into RankQueryConfigRetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into RetrieveInner with oneOf schemas: CandidateAttributesRetrieveStep, CandidateIdsRetrieveStep, ColumnOrderRetrieveStep, FilterRetrieveStep, SimilarityRetrieveStep, TextSearchRetrieveStep. Details: " + ", ".join(error_messages))
         else:
             return instance
 

shaped/autogen/models/retrieve_step_explanation.py

@@ -0,0 +1,171 @@
+# 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 RetrieveStepExplanation(BaseModel):
+    """
+    Explanation for a retrieval 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.")
+    retrieval_method: Optional[StrictStr] = None
+    retrieved_count: Optional[StrictInt] = None
+    limit: Optional[StrictInt] = None
+    pagination_offset: Optional[StrictInt] = None
+    filter_predicate: Optional[StrictStr] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["step_name", "step_type", "input_count", "output_count", "filtered_count", "execution_time_ms", "metadata", "retrieval_method", "retrieved_count", "limit", "pagination_offset", "filter_predicate"]
+
+    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 RetrieveStepExplanation 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 retrieval_method (nullable) is None
+        # and model_fields_set contains the field
+        if self.retrieval_method is None and "retrieval_method" in self.model_fields_set:
+            _dict['retrieval_method'] = None
+
+        # set to None if retrieved_count (nullable) is None
+        # and model_fields_set contains the field
+        if self.retrieved_count is None and "retrieved_count" in self.model_fields_set:
+            _dict['retrieved_count'] = None
+
+        # set to None if limit (nullable) is None
+        # and model_fields_set contains the field
+        if self.limit is None and "limit" in self.model_fields_set:
+            _dict['limit'] = None
+
+        # set to None if pagination_offset (nullable) is None
+        # and model_fields_set contains the field
+        if self.pagination_offset is None and "pagination_offset" in self.model_fields_set:
+            _dict['pagination_offset'] = None
+
+        # set to None if filter_predicate (nullable) is None
+        # and model_fields_set contains the field
+        if self.filter_predicate is None and "filter_predicate" in self.model_fields_set:
+            _dict['filter_predicate'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RetrieveStepExplanation 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"),
+            "retrieval_method": obj.get("retrieval_method"),
+            "retrieved_count": obj.get("retrieved_count"),
+            "limit": obj.get("limit"),
+            "pagination_offset": obj.get("pagination_offset"),
+            "filter_predicate": obj.get("filter_predicate")
+        })
+        # 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/retriever.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/retriever1.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/rollout_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/rudderstack_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/sampling_strategy.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/saved_query_info_response.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
@@ -18,7 +17,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,7 +27,9 @@ class SavedQueryInfoResponse(BaseModel):
     """ # noqa: E501
     name: StrictStr = Field(description="The name of the saved query.")
     params: List[StrictStr] = Field(description="List of parameter names that this query accepts.")
-    __properties: ClassVar[List[str]] = ["name", "params"]
+    query: Optional[StrictStr] = None
+    query_type: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["name", "params", "query", "query_type"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -69,6 +70,16 @@ class SavedQueryInfoResponse(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # set to None if query (nullable) is None
+        # and model_fields_set contains the field
+        if self.query is None and "query" in self.model_fields_set:
+            _dict['query'] = None
+
+        # set to None if query_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.query_type is None and "query_type" in self.model_fields_set:
+            _dict['query_type'] = None
+
         return _dict
 
     @classmethod
@@ -82,7 +93,9 @@ class SavedQueryInfoResponse(BaseModel):
 
         _obj = cls.model_validate({
             "name": obj.get("name"),
-            "params": obj.get("params")
+            "params": obj.get("params"),
+            "query": obj.get("query"),
+            "query_type": obj.get("query_type")
         })
         return _obj
 

shaped/autogen/models/saved_query_list_response.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/saved_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/schema_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