hiddenlayer-sdk 2.0.8__py3-none-any.whl → 2.0.10__py3-none-any.whl

hiddenlayer/__init__.py

@@ -1,5 +1,6 @@
 import os
 from typing import Callable, Optional
+from urllib.parse import urljoin
 
 import requests
 from requests.auth import HTTPBasicAuth
@@ -33,8 +34,13 @@ class HiddenlayerServiceClient:
         api_id: Optional[str] = None,
         api_key: Optional[str] = None,
         host: str = "https://api.us.hiddenlayer.ai",
+        auth_url: Optional[str] = None,
     ):
         self.host = host.strip()
+        if auth_url:
+            self.auth_url = auth_url.strip()
+        else:
+            self.auth_url = None
         self.is_saas = is_saas(host)
         refresh_jwt_func: Optional[Callable[[], str]] = None
 
@@ -65,9 +71,12 @@ class HiddenlayerServiceClient:
     def _get_jwt(self, *, api_id: str, api_key: str) -> str:
         "Get the JWT token to auth to the Hiddenlayer API."
 
-        auth_url = os.getenv("HL_AUTH_URL", "https://auth.hiddenlayer.ai")
+        if self.auth_url:
+            auth_url = self.auth_url
+        else:
+            auth_url = os.getenv("HL_AUTH_URL", "https://auth.hiddenlayer.ai")
 
-        token_url = f"{auth_url}/oauth2/token?grant_type=client_credentials"
+        token_url = urljoin(auth_url, "/oauth2/token?grant_type=client_credentials")
 
         resp = requests.post(token_url, auth=HTTPBasicAuth(api_id, api_key))
 

hiddenlayer/sdk/rest/models/inventory_v3.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
@@ -32,7 +32,9 @@ class InventoryV3(BaseModel):
     model_version: Optional[StrictStr] = None
     model_version_id: Optional[StrictStr] = None
     requesting_entity: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["requested_scan_location", "model_name", "model_source", "model_version", "model_version_id", "requesting_entity"]
+    request_source: Optional[StrictStr] = Field(default=None, description="Identifies the system that requested the scan")
+    origin: Optional[StrictStr] = Field(default=None, description="Specifies the platform or service where the model originated before being scanned")
+    __properties: ClassVar[List[str]] = ["requested_scan_location", "model_name", "model_source", "model_version", "model_version_id", "requesting_entity", "request_source", "origin"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -90,7 +92,9 @@ class InventoryV3(BaseModel):
             "model_source": obj.get("model_source"),
             "model_version": obj.get("model_version"),
             "model_version_id": obj.get("model_version_id"),
-            "requesting_entity": obj.get("requesting_entity")
+            "requesting_entity": obj.get("requesting_entity"),
+            "request_source": obj.get("request_source"),
+            "origin": obj.get("origin")
         })
         return _obj
 

hiddenlayer/sdk/rest/models/model_inventory_info.py

@@ -31,9 +31,11 @@ class ModelInventoryInfo(BaseModel):
     model_source: Optional[StrictStr] = Field(default=None, description="source (provider) info")
     requested_scan_location: StrictStr = Field(description="Location to be scanned")
     requesting_entity: Optional[StrictStr] = Field(default=None, description="Entity that requested the scan")
+    request_source: Optional[StrictStr] = Field(default=None, description="Source of the request")
+    origin: Optional[StrictStr] = Field(default=None, description="Origin of the scan")
     model_id: StrictStr = Field(description="Unique identifier for the model")
     model_version_id: StrictStr = Field(description="unique identifier for the model version")
-    __properties: ClassVar[List[str]] = ["model_name", "model_version", "model_source", "requested_scan_location", "requesting_entity", "model_id", "model_version_id"]
+    __properties: ClassVar[List[str]] = ["model_name", "model_version", "model_source", "requested_scan_location", "requesting_entity", "request_source", "origin", "model_id", "model_version_id"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -91,6 +93,8 @@ class ModelInventoryInfo(BaseModel):
             "model_source": obj.get("model_source"),
             "requested_scan_location": obj.get("requested_scan_location"),
             "requesting_entity": obj.get("requesting_entity"),
+            "request_source": obj.get("request_source"),
+            "origin": obj.get("origin"),
             "model_id": obj.get("model_id"),
             "model_version_id": obj.get("model_version_id")
         })

hiddenlayer/sdk/rest/models/multi_file_upload_request_v3.py

@@ -30,7 +30,9 @@ class MultiFileUploadRequestV3(BaseModel):
     model_name: StrictStr = Field(description="Model name")
     requesting_entity: StrictStr = Field(description="Requesting entity")
     location_alias: Optional[StrictStr] = Field(default=None, description="Requested location alias")
-    __properties: ClassVar[List[str]] = ["model_version", "model_name", "requesting_entity", "location_alias"]
+    request_source: Optional[StrictStr] = Field(default=None, description="Identifies the system that requested the scan")
+    origin: Optional[StrictStr] = Field(default=None, description="Specifies the platform or service where the model originated before being scanned")
+    __properties: ClassVar[List[str]] = ["model_version", "model_name", "requesting_entity", "location_alias", "request_source", "origin"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -86,7 +88,9 @@ class MultiFileUploadRequestV3(BaseModel):
             "model_version": obj.get("model_version"),
             "model_name": obj.get("model_name"),
             "requesting_entity": obj.get("requesting_entity"),
-            "location_alias": obj.get("location_alias")
+            "location_alias": obj.get("location_alias"),
+            "request_source": obj.get("request_source"),
+            "origin": obj.get("origin")
         })
         return _obj
 

hiddenlayer/sdk/rest/models/scan_model_details_v3.py

@@ -31,7 +31,9 @@ class ScanModelDetailsV3(BaseModel):
     model_source: Optional[StrictStr] = Field(default=None, description="source (provider) info")
     requested_scan_location: StrictStr = Field(description="Location to be scanned")
     requesting_entity: Optional[StrictStr] = Field(default=None, description="Entity that requested the scan")
-    __properties: ClassVar[List[str]] = ["model_name", "model_version", "model_source", "requested_scan_location", "requesting_entity"]
+    request_source: Optional[StrictStr] = Field(default=None, description="Source of the request")
+    origin: Optional[StrictStr] = Field(default=None, description="Origin of the scan")
+    __properties: ClassVar[List[str]] = ["model_name", "model_version", "model_source", "requested_scan_location", "requesting_entity", "request_source", "origin"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -88,7 +90,9 @@ class ScanModelDetailsV3(BaseModel):
             "model_version": obj.get("model_version"),
             "model_source": obj.get("model_source"),
             "requested_scan_location": obj.get("requested_scan_location"),
-            "requesting_entity": obj.get("requesting_entity")
+            "requesting_entity": obj.get("requesting_entity"),
+            "request_source": obj.get("request_source"),
+            "origin": obj.get("origin")
         })
         return _obj
 

hiddenlayer/sdk/rest/models/scan_model_details_v31.py

@@ -18,7 +18,7 @@ import re  # noqa: F401
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List
+from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -30,7 +30,9 @@ class ScanModelDetailsV31(BaseModel):
     model_version: StrictStr = Field(description="If you do not provide a version, one will be generated for you.")
     requested_scan_location: StrictStr = Field(description="Location to be scanned")
     requesting_entity: StrictStr = Field(description="Entity that requested the scan")
-    __properties: ClassVar[List[str]] = ["model_name", "model_version", "requested_scan_location", "requesting_entity"]
+    request_source: Optional[StrictStr] = Field(default=None, description="Identifies the system that requested the scan")
+    origin: Optional[StrictStr] = Field(default=None, description="Specifies the platform or service where the model originated before being scanned")
+    __properties: ClassVar[List[str]] = ["model_name", "model_version", "requested_scan_location", "requesting_entity", "request_source", "origin"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -86,7 +88,9 @@ class ScanModelDetailsV31(BaseModel):
             "model_name": obj.get("model_name"),
             "model_version": obj.get("model_version"),
             "requested_scan_location": obj.get("requested_scan_location"),
-            "requesting_entity": obj.get("requesting_entity")
+            "requesting_entity": obj.get("requesting_entity"),
+            "request_source": obj.get("request_source"),
+            "origin": obj.get("origin")
         })
         return _obj
 

hiddenlayer/sdk/services/model_scan.py

@@ -48,6 +48,8 @@ class ModelScanAPI:
         model_source: CommunityScanSource,
         model_version: str = "main",
         wait_for_results: bool = True,
+        request_source="API Upload",
+        origin: str = "",
     ) -> ScanResults:
         """
         Scan a model available at a remote location using the HiddenLayer Model Scanner.
@@ -67,6 +69,8 @@ class ModelScanAPI:
                 model_version=model_version,
                 requested_scan_location=model_path,
                 requesting_entity="hiddenlayer-python-sdk",
+                request_source=request_source,
+                origin=origin,
             ),
         )
         result = self._model_supply_chain_api.create_scan_job(scan_job)
@@ -85,6 +89,8 @@ class ModelScanAPI:
         model_path: Union[str, os.PathLike],
         model_version: str = "1",
         wait_for_results: bool = True,
+        request_source="API Upload",
+        origin: str = "",
     ) -> ScanResults:
         """
         Scan a local model file using the HiddenLayer Model Scanner.
@@ -104,6 +110,8 @@ class ModelScanAPI:
             model_name=model_name,
             model_version=model_version,
             requesting_entity="hiddenlayer-python-sdk",
+            request_source=request_source,
+            origin=origin,
         )
         response = self._model_supply_chain_api.begin_multi_file_upload(
             multi_file_upload_request_v3=request
@@ -130,6 +138,7 @@ class ModelScanAPI:
         model_version: str = "1",
         s3_client: Optional[object] = None,
         wait_for_results: bool = True,
+        request_source="API Upload",
     ) -> ScanResults:
         """
         Scan a model file on S3.
@@ -174,6 +183,8 @@ class ModelScanAPI:
             model_name=model_name,
             model_version=model_version,
             wait_for_results=wait_for_results,
+            request_source=request_source,
+            origin="S3",
         )
 
     def scan_azure_blob_model(
@@ -187,6 +198,7 @@ class ModelScanAPI:
         blob_service_client: Optional[object] = None,
         credential: Optional[object] = None,
         wait_for_results: bool = True,
+        request_source="API Upload",
     ) -> ScanResults:
         """
         Scan a model file on Azure Blob Storage.
@@ -252,6 +264,8 @@ class ModelScanAPI:
             model_name=model_name,
             model_version=model_version,
             wait_for_results=wait_for_results,
+            request_source=request_source,
+            origin="Azure Blob Storage",
         )
 
     def scan_huggingface_model(
@@ -268,6 +282,7 @@ class ModelScanAPI:
         force_download: bool = False,
         hf_token: Optional[Union[str, bool]] = None,
         wait_for_results: bool = True,
+        request_source="API Upload",
     ) -> ScanResults:
         """
         Scans a model on HuggingFace.
@@ -322,6 +337,8 @@ class ModelScanAPI:
             allow_file_patterns=allow_file_patterns,
             ignore_file_patterns=ignore_file_patterns,
             wait_for_results=wait_for_results,
+            request_source=request_source,
+            origin="Hugging Face",
         )
 
     def get_scan_results(self, *, scan_id: str) -> ScanResults:
@@ -390,6 +407,8 @@ class ModelScanAPI:
         allow_file_patterns: Optional[List[str]] = None,
         ignore_file_patterns: Optional[List[str]] = None,
         wait_for_results: bool = True,
+        request_source="API Upload",
+        origin: str = "",
     ) -> ScanResults:
         """
         Submits all files in a directory and its sub directories to be scanned.
@@ -411,6 +430,8 @@ class ModelScanAPI:
             model_name=model_name,
             model_version=model_version,
             requesting_entity="hiddenlayer-python-sdk",
+            request_source=request_source,
+            origin=origin,
         )
         response = self._model_supply_chain_api.begin_multi_file_upload(
             multi_file_upload_request_v3=request

hiddenlayer/sdk/version.py

@@ -1 +1 @@
-VERSION = "2.0.8"
+VERSION = "2.0.10"

{hiddenlayer_sdk-2.0.8.dist-info → hiddenlayer_sdk-2.0.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hiddenlayer-sdk
-Version: 2.0.8
+Version: 2.0.10
 Summary: Official HiddenLayer Python SDK
 Author-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>
 Maintainer-email: HiddenLayer Integrations Team <integrations@hiddenlayer.com>

{hiddenlayer_sdk-2.0.8.dist-info → hiddenlayer_sdk-2.0.10.dist-info}/RECORD

@@ -1,10 +1,10 @@
-hiddenlayer/__init__.py,sha256=TJLQ2sXIrJTzv04Cl7N1iHSEF5hycMaM1PsU4WnNocU,3421
+hiddenlayer/__init__.py,sha256=YGc00rA_UkheVMkpn5MsYuHvmUzE1Sl9OZoqLtQ1nBU,3696
 hiddenlayer/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hiddenlayer/sdk/constants.py,sha256=BytOHlVWk6lhWB4bpT7kDj3ctozZA9ftaB2D6lSGtGI,628
 hiddenlayer/sdk/exceptions.py,sha256=_Lelwk32LWxWuUPglfw8R8RuiX_Uxm_N7TP3BLhDLz0,226
 hiddenlayer/sdk/models.py,sha256=t92fK7xxuPm1XzazNsRg5AOAD17qnvNZiGaN1gM6lHk,1776
 hiddenlayer/sdk/utils.py,sha256=Ntao8hfsYuB7obZOanayIlrgJ98IWcPhs3sRi39IDkg,2997
-hiddenlayer/sdk/version.py,sha256=PbzztH5WoUucxFyD8jfiRiC_F3owJobc9EBacPwjpGo,18
+hiddenlayer/sdk/version.py,sha256=cvebPKJg8pP9aW2gMv6ZYLVFFp-UJVx7GaaCBql0ReY,19
 hiddenlayer/sdk/rest/__init__.py,sha256=fL2dURfsADiHHxdxxbUyjrqQi5BPRVdd9p51XPrJhks,8499
 hiddenlayer/sdk/rest/api_client.py,sha256=Yd71Up1SHj5pPp4jB_gIsm5Y77jHph7T4iU9NiIhUak,26291
 hiddenlayer/sdk/rest/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
@@ -47,7 +47,7 @@ hiddenlayer/sdk/rest/models/fix.py,sha256=YaigBB7v8YSRp4_1TKs45f96sIs2XsUHQXdjRp
 hiddenlayer/sdk/rest/models/get_condensed_model_scan_reports200_response.py,sha256=XKTEAiv21q1ah5ec6VRx_-2J8NyfbGOpSgCrjlDiN94,3610
 hiddenlayer/sdk/rest/models/graph.py,sha256=CS3NGVxqaZl-n7f1PMt6VGzEubAY5qKSMGa4ipJwzCk,4764
 hiddenlayer/sdk/rest/models/graph_traversal.py,sha256=XQmy0us7wSaOxeUc5dYeH2f02wjkWgr54mwMo20fL80,3835
-hiddenlayer/sdk/rest/models/inventory_v3.py,sha256=CM5-1-mucmxdhXnvxj5igqzBk_XP3fmc04GZKUjtojk,3078
+hiddenlayer/sdk/rest/models/inventory_v3.py,sha256=4jGZSyK6K_jXND4aBC2PksgUC9W8gKPs940ckNJ-diU,3485
 hiddenlayer/sdk/rest/models/invocation.py,sha256=NTzgSAW05TsUKQMhlCNLl8OZiU1lWpoxKDf-LGoh8J4,13160
 hiddenlayer/sdk/rest/models/location.py,sha256=KcPalokp6VzRZvT1FZMrObx6eC08GGgG1qoHACFAnjs,6686
 hiddenlayer/sdk/rest/models/location_inner.py,sha256=k7he8hKddcvyjJHrC513c18JVV1dOWRMCZ7WpDhAr8I,4738
@@ -56,9 +56,9 @@ hiddenlayer/sdk/rest/models/logical_location.py,sha256=F-vZ6Ya8cvurh1pHF_DGIkvix
 hiddenlayer/sdk/rest/models/message.py,sha256=my3CLkfFwJV5gUgU_hw1mVuqAo7_5i61q-g75L64zhE,2975
 hiddenlayer/sdk/rest/models/mitre_atlas_inner.py,sha256=8jFDqr88ZgzuU8Je0OUCFL6YO5g1rEdaLEDAxV-Q-Vk,3476
 hiddenlayer/sdk/rest/models/model.py,sha256=ozRK8O9lijrPVs0Ahy8aFPzN4V5dFSYic3Yacx_cggs,3201
-hiddenlayer/sdk/rest/models/model_inventory_info.py,sha256=k9Fqt-coa50b5JAlYprGRU8Me-XixLo83ZXqmblsQTg,3532
+hiddenlayer/sdk/rest/models/model_inventory_info.py,sha256=_x60bE1CMRUJPLhC614yFrnOS3pGTxxXYMBrr9YktHI,3845
 hiddenlayer/sdk/rest/models/model_version.py,sha256=siicFB14ozdgtkDooa_UkqhzcIPtFTwHwiu_reAyhR4,2953
-hiddenlayer/sdk/rest/models/multi_file_upload_request_v3.py,sha256=qybJ27-wfP0crD5p5r-LiMsKEdQj0iKUnB-pERBa4vk,2973
+hiddenlayer/sdk/rest/models/multi_file_upload_request_v3.py,sha256=Wb_igq5Tp7l7J8OdcOG-E5pdCi6VpF_SZEFjFzuHzQA,3373
 hiddenlayer/sdk/rest/models/multiformat_message_string.py,sha256=eJS6TTQSbLg1S_xuL1R-ZXrLcK0Kny9odyH55-nczBU,3146
 hiddenlayer/sdk/rest/models/node.py,sha256=k2wEbU5018DJDLZ48xvzqxuPcdgtpkLRT5ZB3J-vc24,4510
 hiddenlayer/sdk/rest/models/notification.py,sha256=MPZRQSFMDprGdAL-BbWE1LFv4MpqWGrMEjmDtEUGqKI,7035
@@ -87,8 +87,8 @@ hiddenlayer/sdk/rest/models/scan_detection_v31.py,sha256=tTNRlggUmL-cY4ZRiC-2au6
 hiddenlayer/sdk/rest/models/scan_header_v3.py,sha256=sgpiAE6NflJtLJhfUA4NmveUCHTPQN2JSsk7cEBMjVQ,5035
 hiddenlayer/sdk/rest/models/scan_job.py,sha256=IADBv0WCXCZ8m2rUJ8Do7IPSc3aczICCdkLnz2g8FXs,3970
 hiddenlayer/sdk/rest/models/scan_job_access.py,sha256=Q9SWDj7u9ec5H03zlzPUeO_si1rxS_c7iL_YPc-FDxo,2956
-hiddenlayer/sdk/rest/models/scan_model_details_v3.py,sha256=KItM8K8oZASWFh1b8_5zWKuqmbX1UHdELCY7_MjrcTU,3177
-hiddenlayer/sdk/rest/models/scan_model_details_v31.py,sha256=7ykIhQz8OsgdIRmUkVs5RlgpBOuy_3Ztzs3Vi-puN0M,3023
+hiddenlayer/sdk/rest/models/scan_model_details_v3.py,sha256=FD0-CkMv--IU8lzXZMbjqUV3u6smTIZ4wNyT6h5mFt8,3490
+hiddenlayer/sdk/rest/models/scan_model_details_v31.py,sha256=QJMMKs3LRote3ufX2DBjo2OGqLpPiHH7UGZ1o0eO3hM,3433
 hiddenlayer/sdk/rest/models/scan_model_ids_v3.py,sha256=MzU_KNr5CXylDbakDOLv7qGz4naAJ2_56cuW9MATJpw,2639
 hiddenlayer/sdk/rest/models/scan_report_v3.py,sha256=n9oi5wXwdBNIKdPzg1-2wEOSilDARHalTMjTF6THtfg,5658
 hiddenlayer/sdk/rest/models/scan_results_map_v3.py,sha256=BQowU2WqGi0wlNqr9Oi3n_F-NEbfA4aPA-2QfdENwGQ,3363
@@ -118,9 +118,9 @@ hiddenlayer/sdk/rest/models/web_request.py,sha256=u9pmXP-NPDBKcW3ivNDa1I0i0vxQki
 hiddenlayer/sdk/rest/models/web_response.py,sha256=gSKHygOE25yvLKMk__Aga90cHfpFxWvmib1SwWGFTik,4704
 hiddenlayer/sdk/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hiddenlayer/sdk/services/aidr_predictive.py,sha256=S2MvN5qPyYhYXbYM3lvDmylhY71p4d07L36m-a1ZMyM,4773
-hiddenlayer/sdk/services/model_scan.py,sha256=tFqtMKaDl-oq2nSaqqOicK5sh3TqCk6hYP2-Zd5yNNY,18240
-hiddenlayer_sdk-2.0.8.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-hiddenlayer_sdk-2.0.8.dist-info/METADATA,sha256=ZK2iKml4P3ZweCa5oX8JzfPNYxl6yaXmrLCdHgKKfHo,18153
-hiddenlayer_sdk-2.0.8.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-hiddenlayer_sdk-2.0.8.dist-info/top_level.txt,sha256=8BxcmGvEN1RqsMvTWg9Q0vDmtBGcTmatnme6nzyPj2U,12
-hiddenlayer_sdk-2.0.8.dist-info/RECORD,,
+hiddenlayer/sdk/services/model_scan.py,sha256=hJzvt8EjpJ4EKPnde_Mql-X8T32itIE2qUITSma6d3o,18988
+hiddenlayer_sdk-2.0.10.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+hiddenlayer_sdk-2.0.10.dist-info/METADATA,sha256=I-0WsMT3esstIudfXcC6KSd7KDpBOtteLCmb-KSxLyE,18154
+hiddenlayer_sdk-2.0.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+hiddenlayer_sdk-2.0.10.dist-info/top_level.txt,sha256=8BxcmGvEN1RqsMvTWg9Q0vDmtBGcTmatnme6nzyPj2U,12
+hiddenlayer_sdk-2.0.10.dist-info/RECORD,,

{hiddenlayer_sdk-2.0.8.dist-info → hiddenlayer_sdk-2.0.10.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any