shaped 0.14.0__tar.gz → 1.0.1__tar.gz

{shaped-0.14.0 → shaped-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: shaped
-Version: 0.14.0
+Version: 1.0.1
 Summary: CLI and SDK tools for interacting with the Shaped API.
 Home-page: https://github.com/shaped-ai/shaped-cli
 Author: Shaped Team
@@ -26,11 +26,21 @@ Requires-Dist: numpy==1.26.4
 Requires-Dist: urllib3<2.1.0,>=1.25.3
 Requires-Dist: python-dateutil
 Requires-Dist: typing-extensions>=4.7.1
-Requires-Dist: pytest==6.2.5
+Requires-Dist: pytest>=6.2.5
 Requires-Dist: pytest-mock==3.14.0
 
 # Python SDK
 
+## Installation
+
+### Local Development
+
+```sh
+pip install -e .
+```
+
+### Pip Installation
+
 ```sh
 pip install shaped
 ```
@@ -112,16 +122,24 @@ print(api_response)
 To recreate the autogenerated code:
 
 1. `brew install openapi-generator`
-2. Copy across `openapi.yaml` from the `shaped-docs` repository to `/sdk` 
-3. Navigate to `/sdk` and run the command:
+2. Copy across `openapi.yaml` from the `shaped-docs` repository to `~` 
+1. Change `-g python` to the language you want to generate
+1. Change `-o python/` to the directory you want to output to
+3. Navigate to `~` and run the command:
 
-```
+### Python
+```bash
 openapi-generator generate -g python -i openapi.yaml -o python/ -p packageName=shaped.autogen --global-property models,apis,apiDocs=false,modelDocs=false,modelTests=false,apiTests=false,supportingFiles=api_client.py:api_response.py:configuration.py:exceptions.py:rest.py:__init__.py
 ```
 
-## Testing
-`pytest sdk/python/tests/test_rank.py --api-key 'api_key'`
+### Node.js
+```bash
+openapi-generator generate -i openapi.yaml -g javascript -o nodejs/src -c config.yaml --global-property models,apis,apiDocs=false,modelDocs=false,modelTests=false,apiTests=false,supportingFiles=ApiClient.js
+```
 
+## Testing
+`pytest python/tests/test_rank.py --api-key 'api_key'`
+`npm test`
 ---
 
 # Shaped CLI

{shaped-0.14.0 → shaped-1.0.1}/README.md

@@ -1,5 +1,15 @@
 # Python SDK
 
+## Installation
+
+### Local Development
+
+```sh
+pip install -e .
+```
+
+### Pip Installation
+
 ```sh
 pip install shaped
 ```
@@ -81,16 +91,24 @@ print(api_response)
 To recreate the autogenerated code:
 
 1. `brew install openapi-generator`
-2. Copy across `openapi.yaml` from the `shaped-docs` repository to `/sdk` 
-3. Navigate to `/sdk` and run the command:
+2. Copy across `openapi.yaml` from the `shaped-docs` repository to `~` 
+1. Change `-g python` to the language you want to generate
+1. Change `-o python/` to the directory you want to output to
+3. Navigate to `~` and run the command:
 
-```
+### Python
+```bash
 openapi-generator generate -g python -i openapi.yaml -o python/ -p packageName=shaped.autogen --global-property models,apis,apiDocs=false,modelDocs=false,modelTests=false,apiTests=false,supportingFiles=api_client.py:api_response.py:configuration.py:exceptions.py:rest.py:__init__.py
 ```
 
-## Testing
-`pytest sdk/python/tests/test_rank.py --api-key 'api_key'`
+### Node.js
+```bash
+openapi-generator generate -i openapi.yaml -g javascript -o nodejs/src -c config.yaml --global-property models,apis,apiDocs=false,modelDocs=false,modelTests=false,apiTests=false,supportingFiles=ApiClient.js
+```
 
+## Testing
+`pytest python/tests/test_rank.py --api-key 'api_key'`
+`npm test`
 ---
 
 # Shaped CLI

{shaped-0.14.0 → shaped-1.0.1}/pyproject.toml

@@ -3,6 +3,7 @@ requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 [tool.ruff]
 exclude = [
-    "sdk/python/shaped/autogen",
-    "sdk/python/shaped/__init__.py",
+    "python/shaped/autogen",
+    "python/shaped/__init__.py",
+    "nodejs",
 ]

{shaped-0.14.0/sdk → shaped-1.0.1}/python/shaped/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 from .client import Client
 from .autogen.models.inference_config import InferenceConfig
 from .autogen.models.retriever_top_k_override import RetrieverTopKOverride

{shaped-0.14.0/sdk → shaped-1.0.1}/python/shaped/autogen/__init__.py

@@ -73,6 +73,7 @@ from shaped.autogen.models.rank_grid_attribute_response import RankGridAttribute
 from shaped.autogen.models.rank_response import RankResponse
 from shaped.autogen.models.redshift_dataset_config import RedshiftDatasetConfig
 from shaped.autogen.models.retrieve_request import RetrieveRequest
+from shaped.autogen.models.retrieve_response import RetrieveResponse
 from shaped.autogen.models.retriever_top_k_override import RetrieverTopKOverride
 from shaped.autogen.models.rudder_stack_dataset_config import RudderStackDatasetConfig
 from shaped.autogen.models.segment_dataset_config import SegmentDatasetConfig

{shaped-0.14.0/sdk → shaped-1.0.1}/python/shaped/autogen/api/dataset_api.py

@@ -272,7 +272,9 @@ class DatasetApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -561,7 +563,9 @@ class DatasetApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -837,7 +841,9 @@ class DatasetApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1100,7 +1106,9 @@ class DatasetApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters

{shaped-0.14.0/sdk → shaped-1.0.1}/python/shaped/autogen/api/model_inference_api.py

@@ -31,6 +31,7 @@ from shaped.autogen.models.rank_grid_attribute_request1 import RankGridAttribute
 from shaped.autogen.models.rank_grid_attribute_response import RankGridAttributeResponse
 from shaped.autogen.models.rank_response import RankResponse
 from shaped.autogen.models.retrieve_request import RetrieveRequest
+from shaped.autogen.models.retrieve_response import RetrieveResponse
 from shaped.autogen.models.similar_item_request import SimilarItemRequest
 from shaped.autogen.models.similar_response import SimilarResponse
 from shaped.autogen.models.similar_users_request import SimilarUsersRequest
@@ -297,7 +298,9 @@ class ModelInferenceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -601,7 +604,9 @@ class ModelInferenceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -905,7 +910,9 @@ class ModelInferenceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1209,7 +1216,9 @@ class ModelInferenceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1513,7 +1522,9 @@ class ModelInferenceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1817,7 +1828,9 @@ class ModelInferenceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1895,7 +1908,7 @@ class ModelInferenceApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> RankResponse:
+    ) -> RetrieveResponse:
         """Retrieve
 
         Retrieve returns relevant item_ids for the given input text or user query. It can be used instead of rank if the filtering, scoring and ordering stages aren't needed for the final ranking. Typically people use this endpoint over rank if they want to reduce latency and complexity of the ranking pipeline and only need a subset of the functionality, e.g. just search but without personalization. 
@@ -1939,7 +1952,7 @@ class ModelInferenceApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "RankResponse",
+            '200': "RetrieveResponse",
             '422': "HTTPValidationError",
         }
         response_data = self.api_client.call_api(
@@ -1971,7 +1984,7 @@ class ModelInferenceApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[RankResponse]:
+    ) -> ApiResponse[RetrieveResponse]:
         """Retrieve
 
         Retrieve returns relevant item_ids for the given input text or user query. It can be used instead of rank if the filtering, scoring and ordering stages aren't needed for the final ranking. Typically people use this endpoint over rank if they want to reduce latency and complexity of the ranking pipeline and only need a subset of the functionality, e.g. just search but without personalization. 
@@ -2015,7 +2028,7 @@ class ModelInferenceApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "RankResponse",
+            '200': "RetrieveResponse",
             '422': "HTTPValidationError",
         }
         response_data = self.api_client.call_api(
@@ -2091,7 +2104,7 @@ class ModelInferenceApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "RankResponse",
+            '200': "RetrieveResponse",
             '422': "HTTPValidationError",
         }
         response_data = self.api_client.call_api(
@@ -2121,7 +2134,9 @@ class ModelInferenceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -2425,7 +2440,9 @@ class ModelInferenceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -2742,7 +2759,9 @@ class ModelInferenceApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters

{shaped-0.14.0/sdk → shaped-1.0.1}/python/shaped/autogen/api/model_management_api.py

@@ -273,7 +273,9 @@ class ModelManagementApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -549,7 +551,9 @@ class ModelManagementApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -812,7 +816,9 @@ class ModelManagementApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1086,7 +1092,9 @@ class ModelManagementApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters
@@ -1375,7 +1383,9 @@ class ModelManagementApi:
         _query_params: List[Tuple[str, str]] = []
         _header_params: Dict[str, Optional[str]] = _headers or {}
         _form_params: List[Tuple[str, str]] = []
-        _files: Dict[str, Union[str, bytes]] = {}
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
         _body_params: Optional[bytes] = None
 
         # process the path parameters

{shaped-0.14.0/sdk → shaped-1.0.1}/python/shaped/autogen/api_client.py

@@ -15,6 +15,7 @@
 import datetime
 from dateutil.parser import parse
 from enum import Enum
+import decimal
 import json
 import mimetypes
 import os
@@ -66,6 +67,7 @@ class ApiClient:
         'bool': bool,
         'date': datetime.date,
         'datetime': datetime.datetime,
+        'decimal': decimal.Decimal,
         'object': object,
     }
     _pool = None
@@ -338,6 +340,7 @@ class ApiClient:
         If obj is str, int, long, float, bool, return directly.
         If obj is datetime.datetime, datetime.date
             convert to string in iso8601 format.
+        If obj is decimal.Decimal return string representation.
         If obj is list, sanitize each element in the list.
         If obj is dict, return the dict.
         If obj is OpenAPI model, return the properties dict.
@@ -363,6 +366,8 @@ class ApiClient:
             )
         elif isinstance(obj, (datetime.datetime, datetime.date)):
             return obj.isoformat()
+        elif isinstance(obj, decimal.Decimal):
+            return str(obj)
 
         elif isinstance(obj, dict):
             obj_dict = obj
@@ -399,12 +404,12 @@ class ApiClient:
                 data = json.loads(response_text)
             except ValueError:
                 data = response_text
-        elif content_type.startswith("application/json"):
+        elif re.match(r'^application/(json|[\w!#$&.+-^_]+\+json)\s*(;|$)', content_type, re.IGNORECASE):
             if response_text == "":
                 data = ""
             else:
                 data = json.loads(response_text)
-        elif content_type.startswith("text/plain"):
+        elif re.match(r'^text\/[a-z.+-]+\s*(;|$)', content_type, re.IGNORECASE):
             data = response_text
         else:
             raise ApiException(
@@ -454,6 +459,8 @@ class ApiClient:
             return self.__deserialize_date(data)
         elif klass == datetime.datetime:
             return self.__deserialize_datetime(data)
+        elif klass == decimal.Decimal:
+            return decimal.Decimal(data)
         elif issubclass(klass, Enum):
             return self.__deserialize_enum(data, klass)
         else:
@@ -528,7 +535,10 @@ class ApiClient:
 
         return "&".join(["=".join(map(str, item)) for item in new_params])
 
-    def files_parameters(self, files: Dict[str, Union[str, bytes]]):
+    def files_parameters(
+        self,
+        files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]],
+    ):
         """Builds form parameters.
 
         :param files: File parameters.
@@ -543,6 +553,12 @@ class ApiClient:
             elif isinstance(v, bytes):
                 filename = k
                 filedata = v
+            elif isinstance(v, tuple):
+                filename, filedata = v
+            elif isinstance(v, list):
+                for file_param in v:
+                    params.extend(self.files_parameters({k: file_param}))
+                continue
             else:
                 raise ValueError("Unsupported file value")
             mimetype = (