shaped 2.0.5__tar.gz → 2.0.10__tar.gz

{shaped-2.0.5 → shaped-2.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shaped
-Version: 2.0.5
+Version: 2.0.10
 Summary: CLI and SDK tools for interacting with the Shaped API.
 Home-page: https://github.com/shaped-ai/magnus
 Author: Shaped Team

{shaped-2.0.5 → shaped-2.0.10}/setup.py

@@ -7,7 +7,7 @@ from setuptools import find_packages, setup
 
 with open("README.md") as f:
     long_description = f.read()
-version = "2.0.5"
+version = "2.0.10"
 setup(
     name="shaped",
     version=version,

{shaped-2.0.5 → shaped-2.0.10}/shaped/autogen/__init__.py

@@ -49,6 +49,7 @@ __all__ = [
     "CandidateIdsRetrieveStep",
     "CandidateRetrievalStrategy",
     "ClickhouseTableConfig",
+    "ColumnIndexConfig",
     "ColumnOrderRetrieveStep",
     "ColumnOrdering",
     "CreateTableResponse",
@@ -105,6 +106,7 @@ __all__ = [
     "HuggingFaceEncoder",
     "IcebergTableConfig",
     "IndexConfig",
+    "IndexType",
     "InnerEntityId",
     "InnerSize",
     "InnerSize1",
@@ -316,6 +318,7 @@ from shaped.autogen.models.candidate_attributes_retrieve_step import CandidateAt
 from shaped.autogen.models.candidate_ids_retrieve_step import CandidateIdsRetrieveStep as CandidateIdsRetrieveStep
 from shaped.autogen.models.candidate_retrieval_strategy import CandidateRetrievalStrategy as CandidateRetrievalStrategy
 from shaped.autogen.models.clickhouse_table_config import ClickhouseTableConfig as ClickhouseTableConfig
+from shaped.autogen.models.column_index_config import ColumnIndexConfig as ColumnIndexConfig
 from shaped.autogen.models.column_order_retrieve_step import ColumnOrderRetrieveStep as ColumnOrderRetrieveStep
 from shaped.autogen.models.column_ordering import ColumnOrdering as ColumnOrdering
 from shaped.autogen.models.create_table_response import CreateTableResponse as CreateTableResponse
@@ -372,6 +375,7 @@ from shaped.autogen.models.http_problem_response import HttpProblemResponse as H
 from shaped.autogen.models.hugging_face_encoder import HuggingFaceEncoder as HuggingFaceEncoder
 from shaped.autogen.models.iceberg_table_config import IcebergTableConfig as IcebergTableConfig
 from shaped.autogen.models.index_config import IndexConfig as IndexConfig
+from shaped.autogen.models.index_type import IndexType as IndexType
 from shaped.autogen.models.inner_entity_id import InnerEntityId as InnerEntityId
 from shaped.autogen.models.inner_size import InnerSize as InnerSize
 from shaped.autogen.models.inner_size1 import InnerSize1 as InnerSize1

{shaped-2.0.5 → shaped-2.0.10}/shaped/autogen/configuration.py

@@ -504,7 +504,7 @@ class Configuration:
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 2.0.5\n"\
+               "Version of the API: 2.0.10\n"\
                "SDK Package Version: 1.0.0".\
                format(env=sys.platform, pyversion=sys.version)
 

{shaped-2.0.5 → shaped-2.0.10}/shaped/autogen/models/__init__.py

@@ -31,6 +31,7 @@ from shaped.autogen.models.candidate_attributes_retrieve_step import CandidateAt
 from shaped.autogen.models.candidate_ids_retrieve_step import CandidateIdsRetrieveStep
 from shaped.autogen.models.candidate_retrieval_strategy import CandidateRetrievalStrategy
 from shaped.autogen.models.clickhouse_table_config import ClickhouseTableConfig
+from shaped.autogen.models.column_index_config import ColumnIndexConfig
 from shaped.autogen.models.column_order_retrieve_step import ColumnOrderRetrieveStep
 from shaped.autogen.models.column_ordering import ColumnOrdering
 from shaped.autogen.models.create_table_response import CreateTableResponse
@@ -87,6 +88,7 @@ from shaped.autogen.models.http_problem_response import HttpProblemResponse
 from shaped.autogen.models.hugging_face_encoder import HuggingFaceEncoder
 from shaped.autogen.models.iceberg_table_config import IcebergTableConfig
 from shaped.autogen.models.index_config import IndexConfig
+from shaped.autogen.models.index_type import IndexType
 from shaped.autogen.models.inner_entity_id import InnerEntityId
 from shaped.autogen.models.inner_size import InnerSize
 from shaped.autogen.models.inner_size1 import InnerSize1

shaped-2.0.10/shaped/autogen/models/column_index_config.py

@@ -0,0 +1,89 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.index_type import IndexType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ColumnIndexConfig(BaseModel):
+    """
+    Configuration for a specific column index in the vector store.
+    """ # noqa: E501
+    column: StrictStr = Field(description="Column name to create an index for.")
+    index_type: Optional[IndexType] = Field(default=None, description="Type of index to create. Options: btree, bitmap, label_list, fts.")
+    __properties: ClassVar[List[str]] = ["column", "index_type"]
+
+    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 ColumnIndexConfig from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ColumnIndexConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "column": obj.get("column"),
+            "index_type": obj.get("index_type")
+        })
+        return _obj
+
+

{shaped-2.0.5 → shaped-2.0.10}/shaped/autogen/models/evaluation_config.py

@@ -26,10 +26,11 @@ class EvaluationConfig(BaseModel):
     """
     Defines the strategy for offline model evaluation.
     """ # noqa: E501
+    enable: Optional[StrictBool] = Field(default=False, description="Whether to perform offline model evaluation.")
     candidate_source: Optional[CandidateRetrievalStrategy] = Field(default=None, description="Strategy for selecting candidate items for evaluation.")
     filter_seen_items: Optional[StrictBool] = Field(default=False, description="Whether to filter out items the user has already seen.")
     evaluation_top_k: Optional[StrictInt] = Field(default=50, description="Number of top items to evaluate (must be between 1 and 300).")
-    __properties: ClassVar[List[str]] = ["candidate_source", "filter_seen_items", "evaluation_top_k"]
+    __properties: ClassVar[List[str]] = ["enable", "candidate_source", "filter_seen_items", "evaluation_top_k"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -82,6 +83,7 @@ class EvaluationConfig(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "enable": obj.get("enable") if obj.get("enable") is not None else False,
             "candidate_source": obj.get("candidate_source"),
             "filter_seen_items": obj.get("filter_seen_items") if obj.get("filter_seen_items") is not None else False,
             "evaluation_top_k": obj.get("evaluation_top_k") if obj.get("evaluation_top_k") is not None else 50

{shaped-2.0.5 → shaped-2.0.10}/shaped/autogen/models/index_config.py

@@ -18,6 +18,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field
 from typing import Any, ClassVar, Dict, List, Optional
+from shaped.autogen.models.column_index_config import ColumnIndexConfig
 from shaped.autogen.models.embedding_config import EmbeddingConfig
 from shaped.autogen.models.search_config import SearchConfig
 from typing import Optional, Set
@@ -29,7 +30,9 @@ class IndexConfig(BaseModel):
     """ # noqa: E501
     lexical_search: Optional[SearchConfig] = Field(default=None, description="BM25 text search configuration.")
     embeddings: Optional[List[EmbeddingConfig]] = Field(default=None, description="List of embedding configurations for vector search.")
-    __properties: ClassVar[List[str]] = ["lexical_search", "embeddings"]
+    user_column_indices: Optional[List[ColumnIndexConfig]] = None
+    item_column_indices: Optional[List[ColumnIndexConfig]] = None
+    __properties: ClassVar[List[str]] = ["lexical_search", "embeddings", "user_column_indices", "item_column_indices"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -80,6 +83,30 @@ class IndexConfig(BaseModel):
                 if _item_embeddings:
                     _items.append(_item_embeddings.to_dict())
             _dict['embeddings'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in user_column_indices (list)
+        _items = []
+        if self.user_column_indices:
+            for _item_user_column_indices in self.user_column_indices:
+                if _item_user_column_indices:
+                    _items.append(_item_user_column_indices.to_dict())
+            _dict['user_column_indices'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in item_column_indices (list)
+        _items = []
+        if self.item_column_indices:
+            for _item_item_column_indices in self.item_column_indices:
+                if _item_item_column_indices:
+                    _items.append(_item_item_column_indices.to_dict())
+            _dict['item_column_indices'] = _items
+        # set to None if user_column_indices (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_column_indices is None and "user_column_indices" in self.model_fields_set:
+            _dict['user_column_indices'] = None
+
+        # set to None if item_column_indices (nullable) is None
+        # and model_fields_set contains the field
+        if self.item_column_indices is None and "item_column_indices" in self.model_fields_set:
+            _dict['item_column_indices'] = None
+
         return _dict
 
     @classmethod
@@ -93,7 +120,9 @@ class IndexConfig(BaseModel):
 
         _obj = cls.model_validate({
             "lexical_search": SearchConfig.from_dict(obj["lexical_search"]) if obj.get("lexical_search") is not None else None,
-            "embeddings": [EmbeddingConfig.from_dict(_item) for _item in obj["embeddings"]] if obj.get("embeddings") is not None else None
+            "embeddings": [EmbeddingConfig.from_dict(_item) for _item in obj["embeddings"]] if obj.get("embeddings") is not None else None,
+            "user_column_indices": [ColumnIndexConfig.from_dict(_item) for _item in obj["user_column_indices"]] if obj.get("user_column_indices") is not None else None,
+            "item_column_indices": [ColumnIndexConfig.from_dict(_item) for _item in obj["item_column_indices"]] if obj.get("item_column_indices") is not None else None
         })
         return _obj
 

shaped-2.0.10/shaped/autogen/models/index_type.py

@@ -0,0 +1,38 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class IndexType(str, Enum):
+    """
+    The underlying index type to build for fast lookups.
+    """
+
+    """
+    allowed enum values
+    """
+    BTREE = 'btree'
+    BITMAP = 'bitmap'
+    LABEL_LIST = 'label_list'
+    FTS = 'fts'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of IndexType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

{shaped-2.0.5 → shaped-2.0.10}/shaped/autogen/models/requests_per_second_scaling_policy.py

@@ -26,7 +26,7 @@ class RequestsPerSecondScalingPolicy(BaseModel):
     RequestsPerSecondScalingPolicy
     """ # noqa: E501
     type: Optional[StrictStr] = Field(default='requests_per_second', description="Scaling policy type discriminator.")
-    target_requests: Optional[Union[StrictFloat, StrictInt]] = Field(default=10.0, description="Target requests per second per replica for scaling.")
+    target_requests: Optional[Union[StrictFloat, StrictInt]] = Field(default=1.0, description="Target requests per second per replica for scaling.")
     additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["type", "target_requests"]
 
@@ -99,7 +99,7 @@ class RequestsPerSecondScalingPolicy(BaseModel):
 
         _obj = cls.model_validate({
             "type": obj.get("type") if obj.get("type") is not None else 'requests_per_second',
-            "target_requests": obj.get("target_requests") if obj.get("target_requests") is not None else 10.0
+            "target_requests": obj.get("target_requests") if obj.get("target_requests") is not None else 1.0
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

{shaped-2.0.5 → shaped-2.0.10}/shaped/autogen/models/setup_engine_response.py

@@ -25,7 +25,7 @@ class SetupEngineResponse(BaseModel):
     """
     SetupEngineResponse
     """ # noqa: E501
-    engine_url: StrictStr = Field(description="URL to access the created or updated engine.")
+    engine_url: StrictStr = Field(description="URL to the console run-health monitor for the engine.")
     __properties: ClassVar[List[str]] = ["engine_url"]
 
     model_config = ConfigDict(

{shaped-2.0.5 → shaped-2.0.10}/shaped/autogen/models/training_compute_config.py

@@ -31,8 +31,7 @@ class TrainingComputeConfig(BaseModel):
     cpu_count: Optional[StrictInt] = Field(default=4, description="Number of CPU cores per training job.")
     force_gpu: Optional[StrictBool] = Field(default=False, description="Whether to force GPU usage even if not needed.")
     disk_size_gb: Optional[StrictInt] = Field(default=64, description="Disk size in GB for training job storage.")
-    use_kubetorch: Optional[StrictBool] = Field(default=True, description="Whether to use kubetorch for running remote jobs.")
-    __properties: ClassVar[List[str]] = ["gpu_type", "gpu_count", "cpu_memory_gb", "cpu_count", "force_gpu", "disk_size_gb", "use_kubetorch"]
+    __properties: ClassVar[List[str]] = ["gpu_type", "gpu_count", "cpu_memory_gb", "cpu_count", "force_gpu", "disk_size_gb"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -90,8 +89,7 @@ class TrainingComputeConfig(BaseModel):
             "cpu_memory_gb": obj.get("cpu_memory_gb") if obj.get("cpu_memory_gb") is not None else 16,
             "cpu_count": obj.get("cpu_count") if obj.get("cpu_count") is not None else 4,
             "force_gpu": obj.get("force_gpu") if obj.get("force_gpu") is not None else False,
-            "disk_size_gb": obj.get("disk_size_gb") if obj.get("disk_size_gb") is not None else 64,
-            "use_kubetorch": obj.get("use_kubetorch") if obj.get("use_kubetorch") is not None else True
+            "disk_size_gb": obj.get("disk_size_gb") if obj.get("disk_size_gb") is not None else 64
         })
         return _obj
 

{shaped-2.0.5 → shaped-2.0.10}/shaped.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shaped
-Version: 2.0.5
+Version: 2.0.10
 Summary: CLI and SDK tools for interacting with the Shaped API.
 Home-page: https://github.com/shaped-ai/magnus
 Author: Shaped Team

{shaped-2.0.5 → shaped-2.0.10}/shaped.egg-info/SOURCES.txt

@@ -36,6 +36,7 @@ setup.py
 ./shaped/autogen/models/candidate_ids_retrieve_step.py
 ./shaped/autogen/models/candidate_retrieval_strategy.py
 ./shaped/autogen/models/clickhouse_table_config.py
+./shaped/autogen/models/column_index_config.py
 ./shaped/autogen/models/column_order_retrieve_step.py
 ./shaped/autogen/models/column_ordering.py
 ./shaped/autogen/models/create_table_response.py
@@ -92,6 +93,7 @@ setup.py
 ./shaped/autogen/models/hugging_face_encoder.py
 ./shaped/autogen/models/iceberg_table_config.py
 ./shaped/autogen/models/index_config.py
+./shaped/autogen/models/index_type.py
 ./shaped/autogen/models/inner_entity_id.py
 ./shaped/autogen/models/inner_size.py
 ./shaped/autogen/models/inner_size1.py
@@ -308,6 +310,7 @@ shaped/autogen/models/candidate_attributes_retrieve_step.py
 shaped/autogen/models/candidate_ids_retrieve_step.py
 shaped/autogen/models/candidate_retrieval_strategy.py
 shaped/autogen/models/clickhouse_table_config.py
+shaped/autogen/models/column_index_config.py
 shaped/autogen/models/column_order_retrieve_step.py
 shaped/autogen/models/column_ordering.py
 shaped/autogen/models/create_table_response.py
@@ -364,6 +367,7 @@ shaped/autogen/models/http_validation_error.py
 shaped/autogen/models/hugging_face_encoder.py
 shaped/autogen/models/iceberg_table_config.py
 shaped/autogen/models/index_config.py
+shaped/autogen/models/index_type.py
 shaped/autogen/models/inner_entity_id.py
 shaped/autogen/models/inner_size.py
 shaped/autogen/models/inner_size1.py

{shaped-2.0.5 → shaped-2.0.10}/tests/test_config_builders.py

@@ -91,14 +91,19 @@ class TestClientIntegration:
 
         # Mock response
         mock_response = Mock()
-        mock_response.engine_url = "https://api.shaped.ai/v2/engines/test-engine"
+        mock_response.engine_url = (
+            "https://console.shaped.ai/monitor/run-health?engine=test-engine"
+        )
         mock_client._engine_api.post_setup_engine_engines_post.return_value = (
             mock_response
         )
 
         result = mock_client.create_engine(engine)
 
-        assert result.engine_url == "https://api.shaped.ai/v2/engines/test-engine"
+        assert (
+            result.engine_url
+            == "https://console.shaped.ai/monitor/run-health?engine=test-engine"
+        )
         mock_client._engine_api.post_setup_engine_engines_post.assert_called_once()
         call_args = mock_client._engine_api.post_setup_engine_engines_post.call_args
         assert call_args.kwargs["engine_config_v2"].name == "test-engine"