hiddenlayer-sdk 0.1.0__py3-none-any.whl

hiddenlayer/__init__.py

@@ -0,0 +1,109 @@
+from typing import Optional
+
+import requests
+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
+
+__version__ = VERSION
+
+
+class HiddenlayerServiceAuthError(Exception):
+    pass
+
+
+class HiddenlayerUnsupportedPlatformError(Exception):
+    pass
+
+
+class HiddenlayerServiceClient:
+    """
+    The Hiddenlayer Service Client is a client for the Hiddenlayer services REST API.
+    """
+
+    def __init__(
+        self,
+        *,
+        api_id: Optional[str] = None,
+        api_key: Optional[str] = None,
+        host: str = "https://api.us.hiddenlayer.ai",
+    ):
+        self.is_saas = is_saas(host)
+
+        if self.is_saas:
+            if not api_id:
+                raise EnvironmentError(
+                    "`api_id` cannot be None when using the SaaS version of HiddenLayer."
+                )
+
+            if not api_key:
+                raise EnvironmentError(
+                    "`api_key` cannot be None when using the SaaS version of HiddenLayer."
+                )
+
+            jwt_token = self._get_jwt(api_id=api_id, api_key=api_key)
+            self._config = Configuration(host=host, access_token=jwt_token)
+
+        else:
+            self._config = Configuration(host=host)
+
+        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:
+        "Get the JWT token to auth to the Hiddenlayer API."
+
+        token_url = (
+            "https://auth.hiddenlayer.ai/oauth2/token?grant_type=client_credentials"
+        )
+
+        resp = requests.post(token_url, auth=HTTPBasicAuth(api_id, api_key))
+
+        if not resp.ok:
+            raise HiddenlayerServiceAuthError(
+                f"Unable to get authentication credentials for the HiddenLayer API: {resp.status_code}: {resp.text}"
+            )
+
+        if "access_token" not in resp.json():
+            raise HiddenlayerServiceAuthError(
+                f"Unable to get authentication credentials for the HiddenLayer API - invalid response: {resp.json()}"
+            )
+
+        return resp.json()["access_token"]
+
+    @property
+    def config(self) -> Configuration:
+        return self._config
+
+    @property
+    def api_client(self) -> ApiClient:
+        return self._api_client
+
+    @property
+    def model_scanner(self) -> ModelScanAPI:
+        return self._model_scan
+
+    @property
+    def aidr_predictive(self) -> AIDRPredictive:
+        # If the platform is not SaaS, it's not supported
+        if not self.is_saas:
+            raise HiddenlayerUnsupportedPlatformError(
+                "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/constants.py

@@ -0,0 +1,14 @@
+from enum import Enum
+
+
+class ScanStatus(str, Enum):
+    DONE = "done"
+    ACCEPTED = "accepted"
+    FAILED = "failed"
+    PENDING = "pending"
+    CREATED = "created"
+    RETRY = "retry"
+
+
+class ApiErrors(str, Enum):
+    NON_ADHOC_SENSOR_DELETE = "only adhoc sensors may be deleted"

hiddenlayer/sdk/enterprise/enterprise_model_scan_api.py

@@ -0,0 +1,55 @@
+"""
+This file is created because the Enterprise and SaaS APIs are not in sync.
+
+When they are in sync, this file and related references can be deleted.  
+"""
+from typing import Dict, Optional
+
+from hiddenlayer.sdk.rest.api_client import ApiClient
+from hiddenlayer.sdk.rest.models.scan_results_v2 import ScanResultsV2
+
+
+class EnterpriseModelScanApi:
+    def __init__(self, api_client: ApiClient):
+        self.api_client = api_client
+
+    def scan_model(self, sensor_id: str, data: Optional[bytes] = None, post_params: Optional[dict] = None):
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "ScanResultsV2",
+            '400': None,
+            '422': "ValidationErrorModel",
+        }
+        resource_path = f"/api/v2/create/{sensor_id}"
+
+        response_data = self.api_client.call_api(
+           "POST",
+           self.api_client.configuration.host + resource_path,
+           body=data,
+           post_params=post_params,
+           header_params={"Content-Type": "octet-binary"}
+        )
+        response_data.read()
+       
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map
+        ).data
+
+    def scan_status(self, sensor_id: str) -> ScanResultsV2:
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ScanResultsV2",
+            '400': None,
+            '404': None,
+        }
+        resource_path = f"/api/v2/status/{sensor_id}"
+
+        response_data = self.api_client.call_api(
+            "GET",
+            self.api_client.configuration.host + resource_path,
+        )
+        response_data.read()
+
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map
+        ).data

hiddenlayer/sdk/exceptions.py

@@ -0,0 +1,12 @@
+class HiddenlayerConflictError(Exception):
+    """Generic error class for API errors from a 409 error code."""
+
+    pass
+
+
+class ModelDoesNotExistError(Exception):
+    pass
+
+
+class IncompatibleModelError(Exception):
+    pass

hiddenlayer/sdk/models.py

@@ -0,0 +1,22 @@
+from typing import Optional
+
+from typing_extensions import Self
+
+from hiddenlayer.sdk.rest.models import ScanResultsV2
+
+
+class ScanResults(ScanResultsV2):
+    """This class exists because the ScanResults API doesn't return anything about the file name or path that was scanned."""
+
+    file_name: Optional[str] = None
+    file_path: Optional[str] = None
+    sensor_id: Optional[str] = None
+
+    @classmethod
+    def from_scanresultsv2(
+        cls, *, scan_results_v2: ScanResultsV2, sensor_id: Optional[str] = None
+    ) -> Self:
+        scan_results_dict = scan_results_v2.to_dict()
+        scan_results_dict["sensor_id"] = sensor_id
+
+        return cls(**scan_results_dict)

hiddenlayer/sdk/rest/__init__.py

@@ -0,0 +1,49 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    HiddenLayer ModelScan
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# import apis into sdk package
+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
+from hiddenlayer.sdk.rest.api_response import ApiResponse
+from hiddenlayer.sdk.rest.api_client import ApiClient
+from hiddenlayer.sdk.rest.configuration import Configuration
+from hiddenlayer.sdk.rest.exceptions import OpenApiException
+from hiddenlayer.sdk.rest.exceptions import ApiTypeError
+from hiddenlayer.sdk.rest.exceptions import ApiValueError
+from hiddenlayer.sdk.rest.exceptions import ApiKeyError
+from hiddenlayer.sdk.rest.exceptions import ApiAttributeError
+from hiddenlayer.sdk.rest.exceptions import ApiException
+
+# import models into sdk package
+from hiddenlayer.sdk.rest.models.create_sensor_request import CreateSensorRequest
+from hiddenlayer.sdk.rest.models.file_info import FileInfo
+from hiddenlayer.sdk.rest.models.get_multipart_upload_response import GetMultipartUploadResponse
+from hiddenlayer.sdk.rest.models.model import Model
+from hiddenlayer.sdk.rest.models.model_query_response import ModelQueryResponse
+from hiddenlayer.sdk.rest.models.multipart_upload_part import MultipartUploadPart
+from hiddenlayer.sdk.rest.models.scan_model_request import ScanModelRequest
+from hiddenlayer.sdk.rest.models.scan_results_v2 import ScanResultsV2
+from hiddenlayer.sdk.rest.models.sensor_sor_query_filter import SensorSORQueryFilter
+from hiddenlayer.sdk.rest.models.sensor_sor_query_request import SensorSORQueryRequest
+from hiddenlayer.sdk.rest.models.submission_response import SubmissionResponse
+from hiddenlayer.sdk.rest.models.submission_v2 import SubmissionV2
+from hiddenlayer.sdk.rest.models.validation_error_model import ValidationErrorModel
+from hiddenlayer.sdk.rest.models.validation_error_model_loc_inner import ValidationErrorModelLocInner

hiddenlayer/sdk/rest/api/__init__.py

@@ -0,0 +1,7 @@
+# flake8: noqa
+
+# import apis into api package
+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
+

hiddenlayer/sdk/rest/api/aidr_predictive_api.py

@@ -0,0 +1,308 @@
+# coding: utf-8
+
+"""
+    HiddenLayer ModelScan
+
+    HiddenLayer ModelScan API for scanning of models
+
+    The version of the OpenAPI document: 1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from hiddenlayer.sdk.rest.models.submission_response import SubmissionResponse
+from hiddenlayer.sdk.rest.models.submission_v2 import SubmissionV2
+
+from hiddenlayer.sdk.rest.api_client import ApiClient, RequestSerialized
+from hiddenlayer.sdk.rest.api_response import ApiResponse
+from hiddenlayer.sdk.rest.rest import RESTResponseType
+
+
+class AidrPredictiveApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def submit_vectors(
+        self,
+        submission_v2: SubmissionV2,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> SubmissionResponse:
+        """Submit vectors
+
+
+        :param submission_v2: (required)
+        :type submission_v2: SubmissionV2
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._submit_vectors_serialize(
+            submission_v2=submission_v2,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SubmissionResponse",
+            '422': "ValidationErrorModel",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def submit_vectors_with_http_info(
+        self,
+        submission_v2: SubmissionV2,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[SubmissionResponse]:
+        """Submit vectors
+
+
+        :param submission_v2: (required)
+        :type submission_v2: SubmissionV2
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._submit_vectors_serialize(
+            submission_v2=submission_v2,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SubmissionResponse",
+            '422': "ValidationErrorModel",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def submit_vectors_without_preload_content(
+        self,
+        submission_v2: SubmissionV2,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Submit vectors
+
+
+        :param submission_v2: (required)
+        :type submission_v2: SubmissionV2
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._submit_vectors_serialize(
+            submission_v2=submission_v2,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SubmissionResponse",
+            '422': "ValidationErrorModel",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _submit_vectors_serialize(
+        self,
+        submission_v2,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _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]] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if submission_v2 is not None:
+            _body_params = submission_v2
+
+
+        # 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:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'BearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/api/v2/submit',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+