hiddenlayer-sdk 1.0.0__tar.gz → 1.1.0__tar.gz

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: hiddenlayer-sdk
-Version: 1.0.0
+Version: 1.1.0
 Summary: Official HiddenLayer Python SDK
 Author-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>
 Maintainer-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer/sdk/constants.py

@@ -12,3 +12,4 @@ class ScanStatus(str, Enum):
 
 class ApiErrors(str, Enum):
     NON_ADHOC_SENSOR_DELETE = "only adhoc sensors may be deleted"
+    SENSOR_EXISTS = "already exists"

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer/sdk/models.py

@@ -9,7 +9,7 @@ from hiddenlayer.sdk.rest.models import (
     ModelInventoryInfo,
     ScanReportV3,
 )
-from hiddenlayer.sdk.rest.models.file_results_inner import FileResultsInner
+from hiddenlayer.sdk.rest.models.file_scan_report_v3 import FileScanReportV3
 from hiddenlayer.sdk.rest.models.sarif210 import Sarif210
 
 
@@ -50,7 +50,7 @@ class EmptyScanResults(ScanResults):
     start_time: datetime = datetime.now()
     end_time: Optional[datetime] = datetime.now()
     severity: Optional[StrictStr] = ""
-    file_results: Optional[List[FileResultsInner]] = []
+    file_results: Optional[List[FileScanReportV3]] = []
 
 
 class Sarif(Sarif210):

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer/sdk/rest/__init__.py

@@ -54,8 +54,8 @@ from hiddenlayer.sdk.rest.models.external_properties import ExternalProperties
 from hiddenlayer.sdk.rest.models.external_property_file_reference import ExternalPropertyFileReference
 from hiddenlayer.sdk.rest.models.external_property_file_references import ExternalPropertyFileReferences
 from hiddenlayer.sdk.rest.models.file_details_v3 import FileDetailsV3
-from hiddenlayer.sdk.rest.models.file_results_inner import FileResultsInner
 from hiddenlayer.sdk.rest.models.file_scan_report_v3 import FileScanReportV3
+from hiddenlayer.sdk.rest.models.file_scan_reports_v3 import FileScanReportsV3
 from hiddenlayer.sdk.rest.models.fix import Fix
 from hiddenlayer.sdk.rest.models.get_multipart_upload_response import GetMultipartUploadResponse
 from hiddenlayer.sdk.rest.models.graph import Graph

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer/sdk/rest/api/sensor_api.py

@@ -17,7 +17,7 @@ from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
 from pydantic import Field, StrictFloat, StrictInt, StrictStr, field_validator
-from typing import Any, Dict, Optional, Union
+from typing import Any, Optional, Union
 from typing_extensions import Annotated
 from hiddenlayer.sdk.rest.models.create_sensor_request import CreateSensorRequest
 from hiddenlayer.sdk.rest.models.get_multipart_upload_response import GetMultipartUploadResponse
@@ -334,7 +334,7 @@ class SensorApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> object:
+    ) -> None:
         """Complete Multipart Upload
 
 
@@ -374,7 +374,7 @@ class SensorApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '200': None,
             '400': None,
         }
         response_data = self.api_client.call_api(
@@ -405,7 +405,7 @@ class SensorApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[object]:
+    ) -> ApiResponse[None]:
         """Complete Multipart Upload
 
 
@@ -445,7 +445,7 @@ class SensorApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '200': None,
             '400': None,
         }
         response_data = self.api_client.call_api(
@@ -516,7 +516,7 @@ class SensorApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '200': None,
             '400': None,
         }
         response_data = self.api_client.call_api(
@@ -559,12 +559,6 @@ class SensorApi:
         # process the body parameter
 
 
-        # set the HTTP header `Accept`
-        _header_params['Accept'] = self.api_client.select_header_accept(
-            [
-                'application/json'
-            ]
-        )
 
 
         # authentication setting
@@ -1998,7 +1992,7 @@ class SensorApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> object:
+    ) -> None:
         """Upload part
 
 
@@ -2044,7 +2038,7 @@ class SensorApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '200': None,
             '400': None,
         }
         response_data = self.api_client.call_api(
@@ -2077,7 +2071,7 @@ class SensorApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[object]:
+    ) -> ApiResponse[None]:
         """Upload part
 
 
@@ -2123,7 +2117,7 @@ class SensorApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '200': None,
             '400': None,
         }
         response_data = self.api_client.call_api(
@@ -2202,7 +2196,7 @@ class SensorApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "object",
+            '200': None,
             '400': None,
         }
         response_data = self.api_client.call_api(
@@ -2251,12 +2245,6 @@ class SensorApi:
             _body_params = body
 
 
-        # set the HTTP header `Accept`
-        _header_params['Accept'] = self.api_client.select_header_accept(
-            [
-                'application/json'
-            ]
-        )
 
         # set the HTTP header `Content-Type`
         if _content_type:

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer/sdk/rest/models/__init__.py

@@ -32,8 +32,8 @@ from hiddenlayer.sdk.rest.models.external_properties import ExternalProperties
 from hiddenlayer.sdk.rest.models.external_property_file_reference import ExternalPropertyFileReference
 from hiddenlayer.sdk.rest.models.external_property_file_references import ExternalPropertyFileReferences
 from hiddenlayer.sdk.rest.models.file_details_v3 import FileDetailsV3
-from hiddenlayer.sdk.rest.models.file_results_inner import FileResultsInner
 from hiddenlayer.sdk.rest.models.file_scan_report_v3 import FileScanReportV3
+from hiddenlayer.sdk.rest.models.file_scan_reports_v3 import FileScanReportsV3
 from hiddenlayer.sdk.rest.models.fix import Fix
 from hiddenlayer.sdk.rest.models.get_multipart_upload_response import GetMultipartUploadResponse
 from hiddenlayer.sdk.rest.models.graph import Graph

hiddenlayer_sdk-1.0.0/hiddenlayer/sdk/rest/models/file_results_inner.py → hiddenlayer_sdk-1.1.0/hiddenlayer/sdk/rest/models/file_scan_report_v3.py

@@ -25,9 +25,9 @@ from hiddenlayer.sdk.rest.models.scan_detection_v3 import ScanDetectionV3
 from typing import Optional, Set
 from typing_extensions import Self
 
-class FileResultsInner(BaseModel):
+class FileScanReportV3(BaseModel):
     """
-    FileResultsInner
+    FileScanReportV3
     """ # noqa: E501
     file_instance_id: StrictStr = Field(description="unique ID of the file")
     file_location: StrictStr = Field(description="full file path")
@@ -37,7 +37,8 @@ class FileResultsInner(BaseModel):
     status: StrictStr = Field(description="status of the scan")
     seen: datetime = Field(description="time the scan was seen at")
     detections: Optional[List[ScanDetectionV3]] = None
-    __properties: ClassVar[List[str]] = ["file_instance_id", "file_location", "start_time", "end_time", "details", "status", "seen", "detections"]
+    file_results: Optional[List[FileScanReportV3]] = None
+    __properties: ClassVar[List[str]] = ["file_instance_id", "file_location", "start_time", "end_time", "details", "status", "seen", "detections", "file_results"]
 
     @field_validator('status')
     def status_validate_enum(cls, value):
@@ -64,7 +65,7 @@ class FileResultsInner(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of FileResultsInner from a JSON string"""
+        """Create an instance of FileScanReportV3 from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -95,11 +96,18 @@ class FileResultsInner(BaseModel):
                 if _item:
                     _items.append(_item.to_dict())
             _dict['detections'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in file_results (list)
+        _items = []
+        if self.file_results:
+            for _item in self.file_results:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['file_results'] = _items
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of FileResultsInner from a dict"""
+        """Create an instance of FileScanReportV3 from a dict"""
         if obj is None:
             return None
 
@@ -114,8 +122,11 @@ class FileResultsInner(BaseModel):
             "details": FileDetailsV3.from_dict(obj["details"]) if obj.get("details") is not None else None,
             "status": obj.get("status"),
             "seen": obj.get("seen"),
-            "detections": [ScanDetectionV3.from_dict(_item) for _item in obj["detections"]] if obj.get("detections") is not None else None
+            "detections": [ScanDetectionV3.from_dict(_item) for _item in obj["detections"]] if obj.get("detections") is not None else None,
+            "file_results": [FileScanReportV3.from_dict(_item) for _item in obj["file_results"]] if obj.get("file_results") is not None else None
         })
         return _obj
 
+# TODO: Rewrite to not use raise_errors
+FileScanReportV3.model_rebuild(raise_errors=False)
 

hiddenlayer_sdk-1.0.0/hiddenlayer/sdk/rest/models/file_scan_report_v3.py → hiddenlayer_sdk-1.1.0/hiddenlayer/sdk/rest/models/file_scan_reports_v3.py

@@ -19,15 +19,15 @@ import json
 
 from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
-from hiddenlayer.sdk.rest.models.file_results_inner import FileResultsInner
+from hiddenlayer.sdk.rest.models.file_scan_report_v3 import FileScanReportV3
 from typing import Optional, Set
 from typing_extensions import Self
 
-class FileScanReportV3(BaseModel):
+class FileScanReportsV3(BaseModel):
     """
-    FileScanReportV3
+    FileScanReportsV3
     """ # noqa: E501
-    file_results: Optional[List[FileResultsInner]] = None
+    file_results: Optional[List[FileScanReportV3]] = None
     __properties: ClassVar[List[str]] = ["file_results"]
 
     model_config = ConfigDict(
@@ -48,7 +48,7 @@ class FileScanReportV3(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of FileScanReportV3 from a JSON string"""
+        """Create an instance of FileScanReportsV3 from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -80,7 +80,7 @@ class FileScanReportV3(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of FileScanReportV3 from a dict"""
+        """Create an instance of FileScanReportsV3 from a dict"""
         if obj is None:
             return None
 
@@ -88,7 +88,7 @@ class FileScanReportV3(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "file_results": [FileResultsInner.from_dict(_item) for _item in obj["file_results"]] if obj.get("file_results") is not None else None
+            "file_results": [FileScanReportV3.from_dict(_item) for _item in obj["file_results"]] if obj.get("file_results") is not None else None
         })
         return _obj
 

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer/sdk/rest/models/scan_report_v3.py

@@ -20,7 +20,7 @@ import json
 from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
-from hiddenlayer.sdk.rest.models.file_results_inner import FileResultsInner
+from hiddenlayer.sdk.rest.models.file_scan_report_v3 import FileScanReportV3
 from hiddenlayer.sdk.rest.models.model_inventory_info import ModelInventoryInfo
 from typing import Optional, Set
 from typing_extensions import Self
@@ -40,7 +40,7 @@ class ScanReportV3(BaseModel):
     end_time: Optional[datetime] = Field(default=None, description="time the scan ended")
     status: StrictStr = Field(description="status of the scan")
     severity: Optional[StrictStr] = Field(default=None, description="detection severity")
-    file_results: Optional[List[FileResultsInner]] = None
+    file_results: Optional[List[FileScanReportV3]] = None
     __properties: ClassVar[List[str]] = ["file_count", "files_with_detections_count", "detection_count", "detection_categories", "inventory", "version", "scan_id", "start_time", "end_time", "status", "severity", "file_results"]
 
     @field_validator('status')
@@ -132,7 +132,7 @@ class ScanReportV3(BaseModel):
             "end_time": obj.get("end_time"),
             "status": obj.get("status"),
             "severity": obj.get("severity"),
-            "file_results": [FileResultsInner.from_dict(_item) for _item in obj["file_results"]] if obj.get("file_results") is not None else None
+            "file_results": [FileScanReportV3.from_dict(_item) for _item in obj["file_results"]] if obj.get("file_results") is not None else None
         })
         return _obj
 

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer/sdk/rest/models/sensor_sor_model_card_response.py

@@ -28,7 +28,7 @@ class SensorSORModelCardResponse(BaseModel):
     SensorSORModelCardResponse
     """ # noqa: E501
     model_id: StrictStr
-    created_at: StrictInt = Field(description="Unix timestamp")
+    created_at: StrictInt = Field(description="Unix Nano Epoch")
     plaintext_name: StrictStr
     active_versions: List[StrictInt]
     source: StrictStr

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer/sdk/services/model.py

@@ -1,4 +1,6 @@
 import json
+import random
+import time
 from typing import Optional
 
 from hiddenlayer.sdk.constants import ApiErrors
@@ -37,6 +39,49 @@ class ModelAPI:
             )
         )
 
+    def create_or_get(self, *, model_name: str, model_version: Optional[int]) -> Model:
+        """
+        Creates a model in the HiddenLayer Platform if it does not exist.
+        If the model and version already exists, returns the existing model.
+
+        :params model_name: Name of the model
+        :params model_version: Version of the model
+
+        :returns: HiddenLayer ModelID
+        """
+        try:
+            return self.create(model_name=model_name, model_version=model_version)
+        except ApiException as e:
+            if e.status == 400 and str(e.body).find(ApiErrors.SENSOR_EXISTS) != -1:
+                return self.get_with_retry(
+                    model_name=model_name, version=model_version, retry=3
+                )
+            else:
+                raise e
+
+    def get_with_retry(
+        self, *, model_name: str, version: Optional[int], retry: int
+    ) -> Model:
+        """
+        Gets a HiddenLayer model object. If not version is supplied, the latest model is returned.
+        Retries if the model is not found.
+
+        :param model_name: Name of the model.
+        :param version: Version of the model to get.
+        :param retry: Number of retries
+
+        :returns: HiddenLayer Model object
+        """
+
+        base_delay = 0.1  # seconds
+        for retryCount in range(retry):
+            try:
+                return self.get(model_name=model_name, version=version)
+            except ModelDoesNotExistError:
+                time.sleep(base_delay * 2**retryCount + random.uniform(0, 1))
+                pass
+        raise ModelDoesNotExistError(f"Model {model_name} does not exist")
+
     def get(self, *, model_name: str, version: Optional[int] = None) -> Model:
         """
         Gets a HiddenLayer model object. If not version is supplied, the latest model is returned.
@@ -90,7 +135,7 @@ class ModelAPI:
             )
         )
 
-        if not models.results:
+        if not models.results or len(models.results) == 0:
             msg = f"Model {model_name} does not exist"
 
             if version:

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer/sdk/services/model_scan.py

@@ -70,7 +70,7 @@ class ModelScanAPI:
         file_path = Path(model_path)
 
         filesize = file_path.stat().st_size
-        sensor = self._model_api.create(
+        sensor = self._model_api.create_or_get(
             model_name=model_name, model_version=model_version
         )
         upload = self._sensor_api.begin_multipart_upload(sensor.sensor_id, filesize)

hiddenlayer_sdk-1.1.0/hiddenlayer/sdk/version.py

@@ -0,0 +1 @@
+VERSION = "1.1.0"

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: hiddenlayer-sdk
-Version: 1.0.0
+Version: 1.1.0
 Summary: Official HiddenLayer Python SDK
 Author-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>
 Maintainer-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>

{hiddenlayer_sdk-1.0.0 → hiddenlayer_sdk-1.1.0}/hiddenlayer_sdk.egg-info/SOURCES.txt

@@ -40,8 +40,8 @@ hiddenlayer/sdk/rest/models/external_properties.py
 hiddenlayer/sdk/rest/models/external_property_file_reference.py
 hiddenlayer/sdk/rest/models/external_property_file_references.py
 hiddenlayer/sdk/rest/models/file_details_v3.py
-hiddenlayer/sdk/rest/models/file_results_inner.py
 hiddenlayer/sdk/rest/models/file_scan_report_v3.py
+hiddenlayer/sdk/rest/models/file_scan_reports_v3.py
 hiddenlayer/sdk/rest/models/fix.py
 hiddenlayer/sdk/rest/models/get_multipart_upload_response.py
 hiddenlayer/sdk/rest/models/graph.py

hiddenlayer_sdk-1.0.0/hiddenlayer/sdk/version.py

@@ -1 +0,0 @@
-VERSION = "1.0.0"