hiddenlayer-sdk 2.0.7__tar.gz → 2.0.9__tar.gz

{hiddenlayer_sdk-2.0.7 → hiddenlayer_sdk-2.0.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hiddenlayer-sdk
-Version: 2.0.7
+Version: 2.0.9
 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.7 → hiddenlayer_sdk-2.0.9}/hiddenlayer/sdk/rest/api/model_supply_chain_api.py

@@ -2392,7 +2392,7 @@ class ModelSupplyChainApi:
     @validate_call
     def get_scan_results1(
         self,
-        scan_id: Optional[StrictStr] = None,
+        scan_id: StrictStr,
         cursor: Optional[StrictStr] = None,
         page_size: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
         _request_timeout: Union[
@@ -2411,7 +2411,7 @@ class ModelSupplyChainApi:
         """Retrieve Model Scan Results
 
 
-        :param scan_id:
+        :param scan_id: (required)
         :type scan_id: str
         :param cursor:
         :type cursor: str
@@ -2469,7 +2469,7 @@ class ModelSupplyChainApi:
     @validate_call
     def get_scan_results1_with_http_info(
         self,
-        scan_id: Optional[StrictStr] = None,
+        scan_id: StrictStr,
         cursor: Optional[StrictStr] = None,
         page_size: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
         _request_timeout: Union[
@@ -2488,7 +2488,7 @@ class ModelSupplyChainApi:
         """Retrieve Model Scan Results
 
 
-        :param scan_id:
+        :param scan_id: (required)
         :type scan_id: str
         :param cursor:
         :type cursor: str
@@ -2546,7 +2546,7 @@ class ModelSupplyChainApi:
     @validate_call
     def get_scan_results1_without_preload_content(
         self,
-        scan_id: Optional[StrictStr] = None,
+        scan_id: StrictStr,
         cursor: Optional[StrictStr] = None,
         page_size: Optional[Annotated[int, Field(strict=True, ge=1)]] = None,
         _request_timeout: Union[
@@ -2565,7 +2565,7 @@ class ModelSupplyChainApi:
         """Retrieve Model Scan Results
 
 
-        :param scan_id:
+        :param scan_id: (required)
         :type scan_id: str
         :param cursor:
         :type cursor: str

{hiddenlayer_sdk-2.0.7 → hiddenlayer_sdk-2.0.9}/hiddenlayer/sdk/rest/models/file_details_v3.py

@@ -50,8 +50,8 @@ class FileDetailsV3(BaseModel):
     @field_validator('sha256')
     def sha256_validate_regular_expression(cls, value):
         """Validates the regular expression"""
-        if not re.match(r"^[a-fA-F0-9]{64}$", value):
-            raise ValueError(r"must validate the regular expression /^[a-fA-F0-9]{64}$/")
+        if not re.match(r"^$|^[a-fA-F0-9]{64}$", value):
+            raise ValueError(r"must validate the regular expression /^$|^[a-fA-F0-9]{64}$/")
         return value
 
     @field_validator('tlsh')

{hiddenlayer_sdk-2.0.7 → hiddenlayer_sdk-2.0.9}/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-2.0.7 → hiddenlayer_sdk-2.0.9}/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-2.0.7 → hiddenlayer_sdk-2.0.9}/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-2.0.7 → hiddenlayer_sdk-2.0.9}/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-2.0.7 → hiddenlayer_sdk-2.0.9}/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-2.0.7 → hiddenlayer_sdk-2.0.9}/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-2.0.9/hiddenlayer/sdk/version.py

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

{hiddenlayer_sdk-2.0.7 → hiddenlayer_sdk-2.0.9}/hiddenlayer_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hiddenlayer-sdk
-Version: 2.0.7
+Version: 2.0.9
 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.7/hiddenlayer/sdk/version.py

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