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

hiddenlayer/types/scans/scan_report.py

@@ -0,0 +1,367 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from ..._compat import PYDANTIC_V1, ConfigDict
+from ..._models import BaseModel
+
+__all__ = [
+    "ScanReport",
+    "Inventory",
+    "InventoryScanModelDetailsV3",
+    "InventoryScanModelIDsV3",
+    "InventoryScanModelComboV3",
+    "Compliance",
+    "FileResult",
+    "FileResultDetails",
+    "FileResultDetailsFileTypeDetails",
+    "FileResultDetailsFileTypeDetailsGgufFileAttributes",
+    "FileResultDetailsFileTypeDetailsKerasFileAttributes",
+    "FileResultDetailsFileTypeDetailsNumpyFileAttributes",
+    "FileResultDetailsFileTypeDetailsRdsFileAttributes",
+    "FileResultDetection",
+    "FileResultDetectionMitreAtlas",
+    "FileResultDetectionRuleDetail",
+    "Summary",
+]
+
+
+class InventoryScanModelDetailsV3(BaseModel):
+    model_name: str
+    """name of the model"""
+
+    requested_scan_location: str
+    """Location to be scanned"""
+
+    model_source: Optional[str] = None
+    """source (provider) info"""
+
+    model_version: Optional[str] = None
+    """version of the model"""
+
+    origin: Optional[str] = None
+    """
+    Specifies the platform or service where the model originated before being
+    scanned
+    """
+
+    request_source: Optional[Literal["Hybrid Upload", "API Upload", "Integration", "UI Upload"]] = None
+    """Identifies the system that requested the scan"""
+
+    requesting_entity: Optional[str] = None
+    """Entity that requested the scan"""
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())
+
+
+class InventoryScanModelIDsV3(BaseModel):
+    model_id: str
+    """Unique identifier for the model"""
+
+    model_version_id: str
+    """unique identifier for the model version"""
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())
+
+
+class InventoryScanModelComboV3(BaseModel):
+    model_id: str
+    """Unique identifier for the model"""
+
+    model_name: str
+    """name of the model"""
+
+    model_version_id: str
+    """unique identifier for the model version"""
+
+    requested_scan_location: str
+    """Location to be scanned"""
+
+    model_source: Optional[str] = None
+    """source (provider) info"""
+
+    model_version: Optional[str] = None
+    """version of the model"""
+
+    origin: Optional[str] = None
+    """
+    Specifies the platform or service where the model originated before being
+    scanned
+    """
+
+    request_source: Optional[Literal["Hybrid Upload", "API Upload", "Integration", "UI Upload"]] = None
+    """Identifies the system that requested the scan"""
+
+    requesting_entity: Optional[str] = None
+    """Entity that requested the scan"""
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())
+
+
+Inventory: TypeAlias = Union[InventoryScanModelDetailsV3, InventoryScanModelIDsV3, InventoryScanModelComboV3]
+
+
+class Compliance(BaseModel):
+    evaluated_at: Optional[datetime] = None
+    """The datetime when the rule set was evaluated against the scan result"""
+
+    rule_set_ids: Optional[List[str]] = None
+    """A list of non-default rule sets that were used when evaluating the scan result"""
+
+    status: Optional[Literal["COMPLIANT", "NONCOMPLIANT"]] = None
+
+
+class FileResultDetailsFileTypeDetailsGgufFileAttributes(BaseModel):
+    subtype: List[str]
+
+
+class FileResultDetailsFileTypeDetailsKerasFileAttributes(BaseModel):
+    pickle_modules: List[str]
+
+    subtype: List[str]
+
+    keras_class_name: Optional[str] = None
+
+    keras_date_saved_at: Optional[str] = None
+
+    keras_module: Optional[str] = None
+
+    keras_version: Optional[str] = None
+    """version of the Keras file"""
+
+
+class FileResultDetailsFileTypeDetailsNumpyFileAttributes(BaseModel):
+    numpy_arrays: str
+
+    numpy_shape: List[str]
+
+    subtype: List[str]
+
+
+class FileResultDetailsFileTypeDetailsRdsFileAttributes(BaseModel):
+    rds_encoding: str
+    """encoding of the RDS file"""
+
+    rds_min_reader_version: str
+    """minimum reader version for the RDS file"""
+
+    rds_version: str
+    """version of the RDS file"""
+
+    rds_writer_version: str
+    """version of the RDS writer"""
+
+    subtype: List[str]
+
+
+FileResultDetailsFileTypeDetails: TypeAlias = Union[
+    FileResultDetailsFileTypeDetailsGgufFileAttributes,
+    FileResultDetailsFileTypeDetailsKerasFileAttributes,
+    FileResultDetailsFileTypeDetailsNumpyFileAttributes,
+    FileResultDetailsFileTypeDetailsRdsFileAttributes,
+]
+
+
+class FileResultDetails(BaseModel):
+    estimated_time: str
+    """estimated time to scan the file"""
+
+    file_type: str
+    """type of the file"""
+
+    sha256: str
+    """hexadecimal sha256 hash of file"""
+
+    file_size: Optional[str] = None
+    """size of the file in human readable format"""
+
+    file_size_bytes: Optional[int] = None
+    """size of the file in bytes"""
+
+    file_type_details: Optional[FileResultDetailsFileTypeDetails] = None
+
+    md5: Optional[str] = None
+    """hexadecimal md5 hash of file"""
+
+    tlsh: Optional[str] = None
+    """TLSH hash of file"""
+
+
+class FileResultDetectionMitreAtlas(BaseModel):
+    tactic: Optional[str] = None
+    """MITRE Atlas Tactic"""
+
+    technique: Optional[str] = None
+    """MITRE Atlas Technique"""
+
+
+class FileResultDetectionRuleDetail(BaseModel):
+    description: Optional[str] = None
+    """description of the deprecation"""
+
+    status: Optional[Literal["created", "deprecated", "updated", "superseded"]] = None
+    """status"""
+
+    status_at: Optional[datetime] = None
+    """date-time when the details entry was created"""
+
+
+class FileResultDetection(BaseModel):
+    category: str
+    """Vulnerability category for the detection"""
+
+    cve: List[str]
+
+    cwe: str
+
+    cwe_href: str
+    """CWE URL for the detection"""
+
+    description: str
+    """detection description"""
+
+    detection_id: str
+    """unique identifier for the detection"""
+
+    impact: str
+    """detection impact"""
+
+    likelihood: str
+    """detection likelihood"""
+
+    mitre_atlas: List[FileResultDetectionMitreAtlas]
+
+    owasp: List[str]
+
+    risk: Literal["MALICIOUS", "SUSPICIOUS"]
+    """detection risk"""
+
+    rule_id: str
+    """unique identifier for the rule that sourced the detection"""
+
+    severity: Literal["critical", "high", "medium", "low"]
+    """The severity of the detection."""
+
+    rule_details: Optional[List[FileResultDetectionRuleDetail]] = None
+
+    technical_blog_href: Optional[str] = None
+    """Hiddenlayer Technical Blog URL for the detection"""
+
+    technical_blog_hrefs: Optional[List[str]] = None
+    """Hiddenlayer Technical Blog URLs for the detection"""
+
+
+class FileResult(BaseModel):
+    details: FileResultDetails
+
+    detections: List[FileResultDetection]
+
+    end_time: datetime
+    """time the scan ended"""
+
+    file_instance_id: str
+    """unique ID of the file"""
+
+    file_location: str
+    """full file path"""
+
+    seen: datetime
+    """time the scan was seen at"""
+
+    start_time: datetime
+    """time the scan started"""
+
+    status: Literal["skipped", "pending", "running", "done", "failed", "canceled"]
+    """status of the scan"""
+
+    file_error: Optional[List[str]] = None
+    """Error messages returned by the scanner"""
+
+
+class Summary(BaseModel):
+    detection_categories: Optional[List[str]] = None
+    """list of unique detection categories found"""
+
+    detection_count: Optional[int] = None
+    """total number of detections found"""
+
+    file_count: Optional[int] = None
+    """total number of files scanned"""
+
+    files_failed_to_scan: Optional[int] = None
+    """number of files that failed during scanning"""
+
+    files_with_detections_count: Optional[int] = None
+    """number of files that contain detections"""
+
+    severity: Optional[Literal["critical", "high", "medium", "low", "safe", "unknown"]] = None
+    """The severity of the detection.
+
+    Use ScanDetectionSeverity (without safe) or ScanDetectionSeverityWithNone
+    instead.
+    """
+
+    unknown_files: Optional[int] = None
+    """number of files with unknown file type"""
+
+
+class ScanReport(BaseModel):
+    detection_count: int
+    """number of detections found"""
+
+    file_count: int
+    """number of files scanned"""
+
+    files_with_detections_count: int
+    """number of files with detections found"""
+
+    inventory: Inventory
+    """information about model and version that this scan relates to"""
+
+    scan_id: str
+    """unique identifier for the scan"""
+
+    start_time: datetime
+    """time the scan started"""
+
+    status: Literal["pending", "running", "done", "failed", "canceled"]
+    """status of the scan"""
+
+    version: str
+    """scanner version"""
+
+    schema_version: Optional[str] = FieldInfo(alias="$schema_version", default=None)
+    """version of the scan report schema format"""
+
+    compliance: Optional[Compliance] = None
+
+    detection_categories: Optional[List[str]] = None
+    """list of detection categories found"""
+
+    end_time: Optional[datetime] = None
+    """time the scan ended"""
+
+    file_results: Optional[List[FileResult]] = None
+
+    has_genealogy: Optional[bool] = None
+    """if there is model geneaology info available"""
+
+    severity: Optional[Literal["critical", "high", "medium", "low", "safe", "unknown"]] = None
+    """The severity of the detection.
+
+    Use ScanDetectionSeverity (without safe) or ScanDetectionSeverityWithNone
+    instead.
+    """
+
+    summary: Optional[Summary] = None
+    """aggregated summary statistics for the scan"""

hiddenlayer/types/scans/upload/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .file_add_response import FileAddResponse as FileAddResponse
+from .file_complete_response import FileCompleteResponse as FileCompleteResponse

hiddenlayer/types/scans/upload/file_add_response.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ...._models import BaseModel
+
+__all__ = ["FileAddResponse", "Part"]
+
+
+class Part(BaseModel):
+    end_offset: Optional[int] = None
+
+    part_number: Optional[int] = None
+
+    start_offset: Optional[int] = None
+
+    upload_url: Optional[str] = None
+
+
+class FileAddResponse(BaseModel):
+    parts: List[Part]
+
+    upload_id: str
+    """UploadId for the current file"""

hiddenlayer/types/scans/upload/file_complete_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ...._models import BaseModel
+
+__all__ = ["FileCompleteResponse"]
+
+
+class FileCompleteResponse(BaseModel):
+    scan_id: Optional[str] = None
+    """Request to resource is successful"""

hiddenlayer/types/scans/upload_complete_all_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["UploadCompleteAllResponse"]
+
+
+class UploadCompleteAllResponse(BaseModel):
+    scan_id: Optional[str] = None
+    """Request to resource is successful"""

hiddenlayer/types/scans/upload_start_params.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["UploadStartParams"]
+
+
+class UploadStartParams(TypedDict, total=False):
+    model_name: Required[str]
+    """Model name"""
+
+    model_version: Required[str]
+    """Model version"""
+
+    requesting_entity: Required[str]
+    """Requesting entity"""
+
+    location_alias: str
+    """Requested location alias"""
+
+    origin: str
+    """
+    Specifies the platform or service where the model originated before being
+    scanned
+    """
+
+    request_source: Literal["Hybrid Upload", "API Upload", "Integration", "UI Upload"]
+    """Identifies the system that requested the scan"""
+
+    x_correlation_id: Annotated[str, PropertyInfo(alias="X-Correlation-Id")]

hiddenlayer/types/scans/upload_start_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["UploadStartResponse"]
+
+
+class UploadStartResponse(BaseModel):
+    scan_id: Optional[str] = None
+    """Request to resource is successful"""

hiddenlayer/types/sensor_create_params.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SensorCreateParams"]
+
+
+class SensorCreateParams(TypedDict, total=False):
+    plaintext_name: Required[str]
+
+    active: bool
+
+    adhoc: bool
+
+    tags: Dict[str, object]
+
+    version: int
+
+    x_correlation_id: Annotated[str, PropertyInfo(alias="X-Correlation-Id")]

hiddenlayer/types/sensor_create_response.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+
+from .._compat import PYDANTIC_V1, ConfigDict
+from .._models import BaseModel
+
+__all__ = ["SensorCreateResponse"]
+
+
+class SensorCreateResponse(BaseModel):
+    active: bool
+
+    created_at: datetime
+
+    model_id: str
+
+    plaintext_name: str
+
+    sensor_id: str
+
+    tags: Dict[str, object]
+
+    tenant_id: str
+
+    adhoc: Optional[bool] = None
+
+    version: Optional[int] = None
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())

hiddenlayer/types/sensor_query_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import datetime
+from typing_extensions import Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SensorQueryParams", "Filter"]
+
+
+class SensorQueryParams(TypedDict, total=False):
+    filter: Filter
+
+    order_by: str
+
+    order_dir: Literal["asc", "desc"]
+
+    page_number: int
+
+    page_size: int
+
+    x_correlation_id: Annotated[str, PropertyInfo(alias="X-Correlation-Id")]
+
+
+class Filter(TypedDict, total=False):
+    active: bool
+
+    created_at_start: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+
+    created_at_stop: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+
+    plaintext_name: str
+
+    source: Literal["adhoc"]
+
+    version: int

hiddenlayer/types/sensor_query_response.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+
+from .._compat import PYDANTIC_V1, ConfigDict
+from .._models import BaseModel
+
+__all__ = ["SensorQueryResponse", "Result"]
+
+
+class Result(BaseModel):
+    active: bool
+
+    created_at: datetime
+
+    model_id: str
+
+    plaintext_name: str
+
+    sensor_id: str
+
+    tags: Dict[str, object]
+
+    tenant_id: str
+
+    adhoc: Optional[bool] = None
+
+    version: Optional[int] = None
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())
+
+
+class SensorQueryResponse(BaseModel):
+    page_number: int
+
+    page_size: int
+
+    results: List[Result]
+
+    total_count: int

hiddenlayer/types/sensor_retrieve_response.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+
+from .._compat import PYDANTIC_V1, ConfigDict
+from .._models import BaseModel
+
+__all__ = ["SensorRetrieveResponse"]
+
+
+class SensorRetrieveResponse(BaseModel):
+    active: bool
+
+    created_at: datetime
+
+    model_id: str
+
+    plaintext_name: str
+
+    sensor_id: str
+
+    tags: Dict[str, object]
+
+    tenant_id: str
+
+    adhoc: Optional[bool] = None
+
+    version: Optional[int] = None
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())

hiddenlayer/types/sensor_update_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SensorUpdateParams"]
+
+
+class SensorUpdateParams(TypedDict, total=False):
+    active: bool
+
+    plaintext_name: str
+
+    tags: Dict[str, object]
+
+    x_correlation_id: Annotated[str, PropertyInfo(alias="X-Correlation-Id")]

hiddenlayer/types/sensor_update_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["SensorUpdateResponse"]
+
+
+class SensorUpdateResponse(BaseModel):
+    detail: str