simulacrum-sdk 0.2.2__py3-none-any.whl → 0.2.3__py3-none-any.whl

simulacrum/client.py

@@ -41,7 +41,7 @@ class Simulacrum:
         }
 
     def forecast(
-        self, series: Sequence[float] | np.ndarray, horizon: int, model: str = "default"
+        self, series: Sequence[float] | np.ndarray, horizon: int | None = None, model: str = "default"
     ) -> np.ndarray:
         """Request a forecast for the provided time series.
 
@@ -86,6 +86,8 @@ class Simulacrum:
             series=series_to_send, horizon=horizon, model=model
         )
         request_body: Dict[str, Any] = payload.model_dump()
+        # Exclude optional fields that are None (e.g., horizon for onsiteiq)
+        request_body = payload.model_dump(exclude_none=True)
         response_data: Dict[str, Any] = send_request(
             method="POST",
             url=f"{self.base_url}/{model}/v1/forecast",

simulacrum/models.py

@@ -12,7 +12,7 @@ class ForecastRequest(BaseModel):
 
     Attributes:
         series (list[float]): Historical observations used as forecast input.
-        horizon (int): Number of future periods to predict.
+        horizon (int | None): Number of future periods to predict. Optional for the ``"onsiteiq"`` model.
         model (str | None): Identifier of the forecasting model, defaults to ``"default"``.
 
     Example:
@@ -23,7 +23,7 @@ class ForecastRequest(BaseModel):
     """
 
     series: List[float]
-    horizon: int
+    horizon: Optional[int] = None
     model: Optional[str] = "default"
 
     @field_validator("series", mode="before")
@@ -41,6 +41,23 @@ class ForecastRequest(BaseModel):
             return value.astype(float).tolist()
         return list(value)
 
+    @model_validator(mode="after")
+    def _validate_horizon_requirement(self):
+        # Horizon is required for all models except onsiteiq
+        model_name = (self.model or "").lower()
+        if model_name != "onsiteiq" and self.horizon is None:
+            raise ValueError("horizon is required and must be a positive integer for this model")
+
+        # When provided, horizon must be an integer >= 1
+        if self.horizon is not None:
+            if not isinstance(self.horizon, int):
+                raise ValueError(
+                    f"horizon must be an integer (got {type(self.horizon).__name__})"
+                )
+            if self.horizon < 1:
+                raise ValueError("horizon must be >= 1")
+        return self
+
 
 class ForecastResponse(BaseModel):
     """Forecast output returned by the API.

{simulacrum_sdk-0.2.2.dist-info → simulacrum_sdk-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simulacrum-sdk
-Version: 0.2.2
+Version: 0.2.3
 Summary: Official Python SDK for accessing the Simulacrum API.
 Author-email: "Simulacrum, Inc." <support@smlcrm.com>
 License-Expression: MIT

{simulacrum_sdk-0.2.2.dist-info → simulacrum_sdk-0.2.3.dist-info}/RECORD

@@ -1,12 +1,12 @@
 simulacrum/__init__.py,sha256=RUetyuqgZ35UgPPcKHJAxqyh8aNkuB8AMWIevCc3iew,437
 simulacrum/_errors.py,sha256=lE6I8c4uL7HC6orHBJ5B1kz7x5NKDHd3mP2yjpQjeIg,2803
 simulacrum/api.py,sha256=dj1xF6KfBLHMML0AicnoHElRzaNjPxooQxBARX219c0,1645
-simulacrum/client.py,sha256=fCIGpHXgt89GO9UIcXNvVohJ-trRKqOwHL6B9K4rh3I,4874
+simulacrum/client.py,sha256=uV3OlCCetni-O3-ESYtQcT8SR3MMj5MercatbH6YkrI,5026
 simulacrum/config.py,sha256=n3iN-cVUF3ucINS3iydDgMnFoMtVxDeVBIQwGiMKNk8,157
 simulacrum/exceptions.py,sha256=YrqoQjaPcZI31PmXd5evOl4fQjzxmz2sc8a3dSzkAMI,3408
-simulacrum/models.py,sha256=zmLTgfQNI6N1eruSCvmE8j0_N8mxP4oLpiIkj8yuZ08,2958
-simulacrum_sdk-0.2.2.dist-info/licenses/LICENSE,sha256=A7B9zAs2uCAzJoZPPyJW0G86yM-BTyum90vD4nSsOe0,1084
-simulacrum_sdk-0.2.2.dist-info/METADATA,sha256=vUbfXp3Qy1So7J166GJfgRbvF22Ok5XmvqvNqH8ljN4,6326
-simulacrum_sdk-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-simulacrum_sdk-0.2.2.dist-info/top_level.txt,sha256=CLUzfwEa7vZDf6zBAH8eXC2lZLMtj92MlXHOc3-V16o,11
-simulacrum_sdk-0.2.2.dist-info/RECORD,,
+simulacrum/models.py,sha256=6ssKnWOIKLZZ98N5nrbcZh0S6yqr-qgJ6FKiV6nqELQ,3764
+simulacrum_sdk-0.2.3.dist-info/licenses/LICENSE,sha256=A7B9zAs2uCAzJoZPPyJW0G86yM-BTyum90vD4nSsOe0,1084
+simulacrum_sdk-0.2.3.dist-info/METADATA,sha256=QfKCHhIHeGNkEyzoc5BrldUj4RRlNC4vZdPBcGwC_6U,6326
+simulacrum_sdk-0.2.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+simulacrum_sdk-0.2.3.dist-info/top_level.txt,sha256=CLUzfwEa7vZDf6zBAH8eXC2lZLMtj92MlXHOc3-V16o,11
+simulacrum_sdk-0.2.3.dist-info/RECORD,,