hiddenlayer-sdk 1.2.1__tar.gz → 2.0.1__tar.gz

{hiddenlayer_sdk-1.2.1 → hiddenlayer_sdk-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: hiddenlayer-sdk
-Version: 1.2.1
+Version: 2.0.1
 Summary: Official HiddenLayer Python SDK
 Author-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>
 Maintainer-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>
@@ -277,6 +277,16 @@ hl_client = HiddenlayerServiceClient(
 )
 ```
 
+If you are using the on-prem Enterprise version of the model scanner, you can instantiate the `HiddenlayerServiceClient` as follows:
+
+```python
+from hiddenlayer import HiddenlayerServiceClient
+
+hl_client = HiddenlayerServiceClient(
+  host="https://your.hiddenlayer.enterprise.example",
+)
+```
+
 ### Scanning Models
 
 ```python
@@ -320,7 +330,7 @@ hl_client.model_scanner.scan_folder(
 > Note: This is only supported using the SaaS version of the platform.
 
 ```python
-model = hl_client.model.create_model(model_name="example_model")
+sensor = hl_client.aidr_predicive.create_sensor(sensor_name="example_model")
 
 hl_client.aidr_predictive.submit_vectors(
   model_id=model.sensor_id,

{hiddenlayer_sdk-1.2.1 → hiddenlayer_sdk-2.0.1}/README.md

@@ -38,6 +38,16 @@ hl_client = HiddenlayerServiceClient(
 )
 ```
 
+If you are using the on-prem Enterprise version of the model scanner, you can instantiate the `HiddenlayerServiceClient` as follows:
+
+```python
+from hiddenlayer import HiddenlayerServiceClient
+
+hl_client = HiddenlayerServiceClient(
+  host="https://your.hiddenlayer.enterprise.example",
+)
+```
+
 ### Scanning Models
 
 ```python
@@ -81,7 +91,7 @@ hl_client.model_scanner.scan_folder(
 > Note: This is only supported using the SaaS version of the platform.
 
 ```python
-model = hl_client.model.create_model(model_name="example_model")
+sensor = hl_client.aidr_predicive.create_sensor(sensor_name="example_model")
 
 hl_client.aidr_predictive.submit_vectors(
   model_id=model.sensor_id,

{hiddenlayer_sdk-1.2.1 → hiddenlayer_sdk-2.0.1}/hiddenlayer/__init__.py

@@ -7,7 +7,6 @@ from requests.auth import HTTPBasicAuth
 from hiddenlayer.sdk.rest.api_client import ApiClient
 from hiddenlayer.sdk.rest.configuration import Configuration
 from hiddenlayer.sdk.services.aidr_predictive import AIDRPredictive
-from hiddenlayer.sdk.services.model import ModelAPI
 from hiddenlayer.sdk.services.model_scan import ModelScanAPI
 from hiddenlayer.sdk.utils import is_saas
 from hiddenlayer.sdk.version import VERSION
@@ -57,7 +56,6 @@ class HiddenlayerServiceClient:
 
         self._api_client = ApiClient(configuration=self._config)
         self._aidr_predictive = AIDRPredictive(self._api_client)
-        self._model = ModelAPI(self._api_client)
         self._model_scan = ModelScanAPI(self._api_client)
 
     def _get_jwt(self, *, api_id: str, api_key: str) -> str:
@@ -101,11 +99,3 @@ class HiddenlayerServiceClient:
                 "AIDR for Predictive Models is currently only supported with the SaaS version of the platform."
             )
         return self._aidr_predictive
-
-    @property
-    def model(self) -> ModelAPI:
-        if not self.is_saas:
-            raise HiddenlayerUnsupportedPlatformError(
-                "Model management is currently only supported with the SaaS version of the platform."
-            )
-        return self._model

{hiddenlayer_sdk-1.2.1 → hiddenlayer_sdk-2.0.1}/hiddenlayer/sdk/exceptions.py

@@ -4,7 +4,7 @@ class HiddenlayerConflictError(Exception):
     pass
 
 
-class ModelDoesNotExistError(Exception):
+class SensorDoesNotExistError(Exception):
     pass
 
 

{hiddenlayer_sdk-1.2.1 → hiddenlayer_sdk-2.0.1}/hiddenlayer/sdk/models.py

@@ -18,16 +18,15 @@ class ScanResults(ScanReportV3):
 
     file_name: Optional[str] = None
     file_path: Optional[str] = None
-    model_id: Optional[str] = None
 
     @classmethod
     def from_scanreportv3(
         cls, *, scan_report_v3: ScanReportV3, model_id: Optional[str] = None
     ) -> Self:
         scan_results_dict = scan_report_v3.to_dict()
-        scan_results_dict["model_id"] = model_id
+        result = cls(**scan_results_dict)
 
-        return cls(**scan_results_dict)
+        return result
 
 
 class EmptyScanResults(ScanResults):

{hiddenlayer_sdk-1.2.1 → hiddenlayer_sdk-2.0.1}/hiddenlayer/sdk/rest/__init__.py

@@ -21,7 +21,6 @@ from hiddenlayer.sdk.rest.api.health_api import HealthApi
 from hiddenlayer.sdk.rest.api.model_supply_chain_api import ModelSupplyChainApi
 from hiddenlayer.sdk.rest.api.readiness_api import ReadinessApi
 from hiddenlayer.sdk.rest.api.aidr_predictive_api import AidrPredictiveApi
-from hiddenlayer.sdk.rest.api.model_scan_api import ModelScanApi
 from hiddenlayer.sdk.rest.api.sensor_api import SensorApi
 
 # import ApiClient
@@ -42,24 +41,29 @@ from hiddenlayer.sdk.rest.models.artifact_change import ArtifactChange
 from hiddenlayer.sdk.rest.models.artifact_content import ArtifactContent
 from hiddenlayer.sdk.rest.models.artifact_location import ArtifactLocation
 from hiddenlayer.sdk.rest.models.attachment import Attachment
+from hiddenlayer.sdk.rest.models.begin_multi_file_upload200_response import BeginMultiFileUpload200Response
+from hiddenlayer.sdk.rest.models.begin_multipart_file_upload200_response import BeginMultipartFileUpload200Response
+from hiddenlayer.sdk.rest.models.begin_multipart_file_upload200_response_parts_inner import BeginMultipartFileUpload200ResponsePartsInner
 from hiddenlayer.sdk.rest.models.code_flow import CodeFlow
 from hiddenlayer.sdk.rest.models.configuration_override import ConfigurationOverride
 from hiddenlayer.sdk.rest.models.conversion import Conversion
 from hiddenlayer.sdk.rest.models.create_sensor_request import CreateSensorRequest
-from hiddenlayer.sdk.rest.models.detections import Detections
 from hiddenlayer.sdk.rest.models.edge import Edge
 from hiddenlayer.sdk.rest.models.edge_traversal import EdgeTraversal
+from hiddenlayer.sdk.rest.models.errors_inner import ErrorsInner
 from hiddenlayer.sdk.rest.models.exception import Exception
 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_result_v3 import FileResultV3
 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.get_condensed_model_scan_reports200_response import GetCondensedModelScanReports200Response
 from hiddenlayer.sdk.rest.models.graph import Graph
 from hiddenlayer.sdk.rest.models.graph_traversal import GraphTraversal
+from hiddenlayer.sdk.rest.models.inventory_v3 import InventoryV3
 from hiddenlayer.sdk.rest.models.invocation import Invocation
 from hiddenlayer.sdk.rest.models.location import Location
 from hiddenlayer.sdk.rest.models.location_inner import LocationInner
@@ -67,17 +71,16 @@ from hiddenlayer.sdk.rest.models.location_relationship import LocationRelationsh
 from hiddenlayer.sdk.rest.models.logical_location import LogicalLocation
 from hiddenlayer.sdk.rest.models.mitre_atlas_inner import MITREAtlasInner
 from hiddenlayer.sdk.rest.models.message import Message
-from hiddenlayer.sdk.rest.models.model import Model
 from hiddenlayer.sdk.rest.models.model_inventory_info import ModelInventoryInfo
-from hiddenlayer.sdk.rest.models.model_query_response import ModelQueryResponse
-from hiddenlayer.sdk.rest.models.model_scan_api_v3_scan_model_version_id_patch200_response import ModelScanApiV3ScanModelVersionIdPatch200Response
-from hiddenlayer.sdk.rest.models.model_scan_api_v3_scan_query200_response import ModelScanApiV3ScanQuery200Response
+from hiddenlayer.sdk.rest.models.multi_file_upload_request_v3 import MultiFileUploadRequestV3
 from hiddenlayer.sdk.rest.models.multiformat_message_string import MultiformatMessageString
-from hiddenlayer.sdk.rest.models.multipart_upload_part import MultipartUploadPart
 from hiddenlayer.sdk.rest.models.node import Node
 from hiddenlayer.sdk.rest.models.notification import Notification
+from hiddenlayer.sdk.rest.models.notify_model_scan_completed200_response import NotifyModelScanCompleted200Response
 from hiddenlayer.sdk.rest.models.paged_response_with_total import PagedResponseWithTotal
+from hiddenlayer.sdk.rest.models.pagination_v3 import PaginationV3
 from hiddenlayer.sdk.rest.models.physical_location import PhysicalLocation
+from hiddenlayer.sdk.rest.models.problem_details import ProblemDetails
 from hiddenlayer.sdk.rest.models.property_bag import PropertyBag
 from hiddenlayer.sdk.rest.models.rectangle import Rectangle
 from hiddenlayer.sdk.rest.models.region import Region
@@ -94,16 +97,18 @@ from hiddenlayer.sdk.rest.models.run_automation_details import RunAutomationDeta
 from hiddenlayer.sdk.rest.models.sarif210 import Sarif210
 from hiddenlayer.sdk.rest.models.scan_create_request import ScanCreateRequest
 from hiddenlayer.sdk.rest.models.scan_detection_v3 import ScanDetectionV3
+from hiddenlayer.sdk.rest.models.scan_detection_v31 import ScanDetectionV31
 from hiddenlayer.sdk.rest.models.scan_header_v3 import ScanHeaderV3
 from hiddenlayer.sdk.rest.models.scan_job import ScanJob
 from hiddenlayer.sdk.rest.models.scan_job_inventory import ScanJobInventory
 from hiddenlayer.sdk.rest.models.scan_model_details_v3 import ScanModelDetailsV3
 from hiddenlayer.sdk.rest.models.scan_model_ids_v3 import ScanModelIdsV3
-from hiddenlayer.sdk.rest.models.scan_model_request import ScanModelRequest
 from hiddenlayer.sdk.rest.models.scan_report_v3 import ScanReportV3
-from hiddenlayer.sdk.rest.models.scan_results import ScanResults
-from hiddenlayer.sdk.rest.models.scan_results_v2 import ScanResultsV2
+from hiddenlayer.sdk.rest.models.scan_results_map_v3 import ScanResultsMapV3
+from hiddenlayer.sdk.rest.models.scan_results_v3 import ScanResultsV3
 from hiddenlayer.sdk.rest.models.security_posture import SecurityPosture
+from hiddenlayer.sdk.rest.models.sensor import Sensor
+from hiddenlayer.sdk.rest.models.sensor_query_response import SensorQueryResponse
 from hiddenlayer.sdk.rest.models.sensor_sor_model_card_query_response import SensorSORModelCardQueryResponse
 from hiddenlayer.sdk.rest.models.sensor_sor_model_card_response import SensorSORModelCardResponse
 from hiddenlayer.sdk.rest.models.sensor_sor_query_filter import SensorSORQueryFilter

{hiddenlayer_sdk-1.2.1 → hiddenlayer_sdk-2.0.1}/hiddenlayer/sdk/rest/api/__init__.py

@@ -5,6 +5,5 @@ from hiddenlayer.sdk.rest.api.health_api import HealthApi
 from hiddenlayer.sdk.rest.api.model_supply_chain_api import ModelSupplyChainApi
 from hiddenlayer.sdk.rest.api.readiness_api import ReadinessApi
 from hiddenlayer.sdk.rest.api.aidr_predictive_api import AidrPredictiveApi
-from hiddenlayer.sdk.rest.api.model_scan_api import ModelScanApi
 from hiddenlayer.sdk.rest.api.sensor_api import SensorApi