Installation
You can seamlessly integrate AIShield Vulnerability Assessment and Defense capabilities into your AI development workflows. With AIShield, you can generate assessment reports, sample attack vectors, and a threat-informed defense model with telemetry connection to SIEM/SOAR, such as Splunk and Microsoft Sentinel.
There are two ways to get started with AIShield:
1.) Installing using pypi package 2.) Directly using AIShield APIs
Requirements
Requires Python>=3.6, and pip >= 19.0
Enum for parameters:
- analysis :
- extraction
- evasion
- poisoning
- task:
- image_classification
- image_segmentation
- timeseries_forecasting
- nlp
- tabular_classification
- text_recommendation
- object_detection
- report_type:
- vulnerability
- defense
- defense_artifact
- attack_samples
Here are the installation steps for AIShield using its direct APIs:
- You will get the Org-ID from the welcome email sent to you registered mail id.
- You will also receive instruction and URL in welcome email, which you can use to generate API key (x-api-key).
- Assign the baseurl concatenated with "/api/ais/v1.5" to the url variable.
- Create a headers dictionary with the following key-value pairs:
- 'Cache-Control': 'no-cache'
- 'x-api-key': insert your subscription key / API key here
- 'Org-Id' : insert your Org-ID here
- You can now make requests to the AIShield API using the url and headers variables.
After installation, you can have to register you model using <Post> Model Registration API. To learn more, please refer this Reference implementation and view section 5.
Check out the Quick Start Example here.
More references implementations, tutorials, samples, and documentation of AIShield can be found on our Github Repository.
Pre-requisites:
- AIShield API should be white-listed, or proxy settings must be appropriately configured for the AIShield API to be called.
- Valid AIShield API subscription plan and authentication keys. For details regarding subscription please visit, Subscription Page or reach out to sales at [email protected]
