Acuvity
Acuvity is model agnostic GenAI security solution. It is built to secure existing and future GenAI models, apps, services, tools, plugins and more.
Acuvity provides AI Guard service for scanning LLM inputs and outputs to avoid manipulation of the model, addition of malicious content, and other undesirable data transfers.
To get started with Acuvity, visit their website:
Here’s your updated table with just the parameter names:
For more, refer to the Config documentation.
Your requests are now guarded by Acuvity AI’s Guardrail and you can see the Verdict and any action you take directly on Portkey logs!
Get Started with Acuvity AI
Using Acuvity with Portkey
1. Add Acuvity Credentials to Portkey
- Navigate to the
Integrationpage underSidebar - Click on the edit button for the Acuvity integration
- Add your Acuvity API Key
2. Add Acuvity’s Guardrail Check
- Navigate to the
Guardrailspage and click theCreatebutton - Search for Acuvity Scan and click
Add - Configure your guardrail settings: toxicity, jail break, biased etc.
- Set any
actionsyou want on your check, and create the Guardrail!
Guardrail Actions allow you to orchestrate your guardrails logic. You can learn them here
| Check Name | Description | Parameters | Supported Hooks |
|---|---|---|---|
| Acuvity Scan | Comprehensive content safety and security checks | Prompt Injection, Toxicity, Jail Break, Malicious Url, Biased, Harmful, Language, PII, Secrets, Timeout | beforeRequestHook, afterRequestHook |
3. Add Guardrail ID to a Config and Make Your Request
- When you save a Guardrail, you’ll get an associated Guardrail ID - add this ID to the
input_guardrailsoroutput_guardrailsparams in your Portkey Config - Create these Configs in Portkey UI, save them, and get an associated Config ID to attach to your requests. More here.
Using Raw Guardrails with Acuvity
You can define Acuvity guardrails directly in your code for more programmatic control without using the Portkey UI. This “raw guardrails” approach lets you dynamically configure guardrails based on your application’s needs.We recommend that you create guardrails using the Portkey UI whenever possible. Raw guardrails are more complex and require you to manage credentials and configurations directly in your code.
Key Configuration Properties
Key Configuration Properties
Available Acuvity Guardrails
| Guardrail Name | ID | Description | Parameters |
|---|---|---|---|
| Acuvity Scan | acuvity.scan | Comprehensive content safety and security checks | Prompt Injection, Toxicity, Jail Break, Malicious Url, Biased, Harmful, Language, PII, Secrets, Timeout |
Implementation Examples
Key Configuration Properties
Key Configuration Properties
type: Always set to"guardrail"for guardrail checksid: A unique identifier for your guardrailcredentials: Authentication details for Acuvityapi_key: Your Acuvity API key
checks: Array of guardrail checks to runid: The specific guardrail ID from the table aboveparameters: Configuration options specific to each guardrail
deny: Whether to block the request if guardrail fails (true/false)async: Whether to run guardrail asynchronously (true/false)on_success/on_fail: Optional callbacks for success/failure scenariosfeedback: Data for logging and analyticsweight: Importance of this feedback (0-1)value: Feedback score (-10 to 10)
When using raw guardrails, you must provide valid credentials for the Acuvity service directly in your config. Make sure to handle these credentials securely and consider using environment variables or secrets management.