feat: Add Cisco AI Defense integration #1433
Conversation
- Add AI Defense action for input/output protection - Add documentation for setup and configuration - Support for environment-based API key configuration Fixes NVIDIA-NeMo#1420
Documentation preview |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull Request Overview
This PR adds Cisco AI Defense integration to NeMo Guardrails, providing security guardrails for input and output protection. The integration enables inspection of user prompts and bot responses through Cisco's AI Defense API to detect and block potentially harmful content.
Key changes:
- Implementation of AI Defense inspection actions and flows for input/output protection
- Configuration support through environment variables (API key and endpoint)
- Comprehensive test coverage including unit, integration, and error handling tests
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
nemoguardrails/library/ai_defense/actions.py |
Core AI Defense inspection action with HTTP client for API calls |
nemoguardrails/library/ai_defense/flows.v1.co |
Colang v1.0 flow definitions for input/output protection |
nemoguardrails/library/ai_defense/flows.co |
Colang v2.0 flow definitions for input/output protection |
tests/test_ai_defense.py |
Comprehensive test suite covering unit, integration, and error scenarios |
docs/user-guides/community/ai-defense.md |
User documentation for setup and usage |
docs/user-guides/guardrails-library.md |
Integration into main guardrails library documentation |
examples/configs/ai_defense/config.yml |
Example configuration file |
examples/configs/ai_defense/README.md |
Example documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
- Remove placeholder comment in test_real_api_call_with_safe_output - Remove debug print statements from test code - Fix incorrect docstring in ai_defense_text_mapping function~
| log = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| def ai_defense_text_mapping(result: dict) -> bool: |
There was a problem hiding this comment.
Could you add a type-annotation here (would dict[str, Any] work with the response?)
nit: Maybe rename to indicate the polarity of the bool returned, i.e. is_ai_defense_text_blocked()? So a True means blocked and False is ok
There was a problem hiding this comment.
Thanks for the review! I've made the suggested changes.
| user_prompt: Optional[str] = None, bot_response: Optional[str] = None, **kwargs | ||
| ): | ||
| api_key = os.environ.get("AI_DEFENSE_API_KEY") | ||
| if api_key is None: |
There was a problem hiding this comment.
nit: Maybe change to if not api_key to catch if the AI_DEFENSE_API_KEY is a falsy value like ""?
| raise ValueError(msg) | ||
|
|
||
| api_endpoint = os.environ.get("AI_DEFENSE_API_ENDPOINT") | ||
| if api_endpoint is None: |
There was a problem hiding this comment.
nit: As above, maybe change to if not api_endpoint to catch an empty string?
| raise ValueError(msg) | ||
|
|
||
| # Compose a consistent return structure for flows | ||
| is_safe = bool(data.get("is_safe", True)) |
There was a problem hiding this comment.
Any concerns with a malformed response dict being treated as safe by default?
There was a problem hiding this comment.
Added configuration for fail_open vs fail closed. And also a timeout config.
| if isinstance(r, dict) | ||
| ] | ||
| if entries: | ||
| log.info("AI Defense matched rules: %s", ", ".join(entries)) |
There was a problem hiding this comment.
nit: Should this be a log.debug() level of info? I could see the logs getting really noisy with a line per API request
Description
Add support for Cisco AI Defense Security, Privacy, and Safety guardrails as a third party API.
Features
Related Issue(s)
Checklist