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

hiddenlayer/sdk/models.py

@@ -1,58 +0,0 @@
-from datetime import datetime
-from typing import List, Optional
-
-from pydantic import StrictStr
-from typing_extensions import Self
-
-from hiddenlayer.sdk.constants import ScanStatus
-from hiddenlayer.sdk.rest.models import (
-    ModelInventoryInfo,
-    ScanReportV3,
-)
-from hiddenlayer.sdk.rest.models.file_scan_report_v3 import FileScanReportV3
-from hiddenlayer.sdk.rest.models.sarif210 import Sarif210
-
-
-class ScanResults(ScanReportV3):
-    """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
-
-    @classmethod
-    def from_scanreportv3(
-        cls, *, scan_report_v3: ScanReportV3, model_id: Optional[str] = None
-    ) -> Self:
-        scan_results_dict = scan_report_v3.to_dict()
-        result = cls(**scan_results_dict)
-
-        return result
-
-
-class EmptyScanResults(ScanResults):
-    status: str = ScanStatus.PENDING
-    file_count: int = 0
-    files_with_detections_count: int = 0
-    detection_count: int = 0
-    detection_categories: Optional[List[StrictStr]] = []
-    inventory: ModelInventoryInfo = ModelInventoryInfo(
-        model_name="",
-        model_version="",
-        model_source="",
-        requested_scan_location="",
-        requesting_entity="",
-        model_id="",
-        model_version_id="",
-    )
-    version: str = ""
-    scan_id: str = ""
-    start_time: datetime = datetime.now()
-    end_time: Optional[datetime] = datetime.now()
-    severity: Optional[StrictStr] = ""
-    file_results: Optional[List[FileScanReportV3]] = []
-
-
-class Sarif(Sarif210):
-    """This class exists because the generated code for Sarif210 treats version as a Dictionary which it is not."""
-
-    version: str  # type: ignore

hiddenlayer/sdk/rest/__init__.py

@@ -1,135 +0,0 @@
-# coding: utf-8
-
-# flake8: noqa
-
-"""
-    HiddenLayer-API
-
-    HiddenLayer-API
-
-    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.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_api import ModelApi
-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.address import Address
-from hiddenlayer.sdk.rest.models.artifact import Artifact
-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.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_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
-from hiddenlayer.sdk.rest.models.location_relationship import LocationRelationship
-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_version import ModelVersion
-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.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
-from hiddenlayer.sdk.rest.models.replacement import Replacement
-from hiddenlayer.sdk.rest.models.reporting_configuration import ReportingConfiguration
-from hiddenlayer.sdk.rest.models.reporting_descriptor import ReportingDescriptor
-from hiddenlayer.sdk.rest.models.reporting_descriptor_reference import ReportingDescriptorReference
-from hiddenlayer.sdk.rest.models.reporting_descriptor_relationship import ReportingDescriptorRelationship
-from hiddenlayer.sdk.rest.models.result import Result
-from hiddenlayer.sdk.rest.models.result_provenance import ResultProvenance
-from hiddenlayer.sdk.rest.models.rule_details_inner import RuleDetailsInner
-from hiddenlayer.sdk.rest.models.run import Run
-from hiddenlayer.sdk.rest.models.run_automation_details import RunAutomationDetails
-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_access import ScanJobAccess
-from hiddenlayer.sdk.rest.models.scan_model_details_v3 import ScanModelDetailsV3
-from hiddenlayer.sdk.rest.models.scan_model_details_v31 import ScanModelDetailsV31
-from hiddenlayer.sdk.rest.models.scan_model_ids_v3 import ScanModelIdsV3
-from hiddenlayer.sdk.rest.models.scan_report_v3 import ScanReportV3
-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
-from hiddenlayer.sdk.rest.models.sensor_sor_query_request import SensorSORQueryRequest
-from hiddenlayer.sdk.rest.models.special_locations import SpecialLocations
-from hiddenlayer.sdk.rest.models.stack import Stack
-from hiddenlayer.sdk.rest.models.stack_frame import StackFrame
-from hiddenlayer.sdk.rest.models.submission_response import SubmissionResponse
-from hiddenlayer.sdk.rest.models.submission_v2 import SubmissionV2
-from hiddenlayer.sdk.rest.models.suppression import Suppression
-from hiddenlayer.sdk.rest.models.thread_flow import ThreadFlow
-from hiddenlayer.sdk.rest.models.thread_flow_location import ThreadFlowLocation
-from hiddenlayer.sdk.rest.models.tool import Tool
-from hiddenlayer.sdk.rest.models.tool_component import ToolComponent
-from hiddenlayer.sdk.rest.models.tool_component_reference import ToolComponentReference
-from hiddenlayer.sdk.rest.models.translation_metadata import TranslationMetadata
-from hiddenlayer.sdk.rest.models.validation_error_model import ValidationErrorModel
-from hiddenlayer.sdk.rest.models.version_control_details import VersionControlDetails
-from hiddenlayer.sdk.rest.models.web_request import WebRequest
-from hiddenlayer.sdk.rest.models.web_response import WebResponse

hiddenlayer/sdk/rest/api/__init__.py

@@ -1,10 +0,0 @@
-# flake8: noqa
-
-# import apis into api package
-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_api import ModelApi
-from hiddenlayer.sdk.rest.api.sensor_api import SensorApi
-

hiddenlayer/sdk/rest/api/aidr_predictive_api.py

@@ -1,308 +0,0 @@
-# coding: utf-8
-
-"""
-    HiddenLayer-API
-
-    HiddenLayer-API
-
-    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
-        )
-
-