Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH]: Implement guardrail service with APIs to effectively manage guardrails in the system. #160

Open
1 task done
vinayakbagal7 opened this issue Dec 18, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@vinayakbagal7
Copy link

vinayakbagal7 commented Dec 18, 2024

Contact Details

[email protected]

Feature Description

Requirements:

  1. Develop APIs to handle all CRUD operations for guardrail connections.
  • Implement encryption support for Guardrail connections to ensure secure communication on the PAIG Cloud platform.
  • Create a unique private-public key pair for each tenant.
  • Use the public key for encrypting sensitive data during guardrail operations.
  • Ensure the private key is securely stored and used for decryption on the server side.
  1. Implement a new API to test connections to external services.
  • API should check connection status.
  • Return success or failure response.
  1. Develop APIs to handle all CRUD operations for guardrails.
  • Develop a flexible and scalable implementation for Bedrock guardrails creation, allowing future integration of various guardrails providers.
  • Implement a guardrail functionality in PAIG to allow users to create, manage, and apply guardrails independently of individual applications. This will improve consistency, reduce redundancy, and expand the scope of protection to include various types of sensitive content.
  • Users can create guardrails independent of applications.
  • Users can associate multiple applications with a single guardrail.
  • Users can configure customized responses for each guardrail configuration types
  1. Provide a way to create different types of configurations listed below in the guardrail.
  • Content Moderation - This can be configured with predefined categories and sensitivity levels (none, low, medium, high) using a sliding scale.
  • Off Topics filters - Implement support in the Guardrail configuration to allow users to define and manage denied topics, enabling more granular control over restricted content.
  • Denied Terms - Provide option to add specific words to guardrails. With this, the user can control the vocabulary used in applications and prevent the use of inappropriate terms.
  • Sensitive Data Filtering - Sensitive information checks can be configured to include PII, sensitive information categories, and regex filters. Users can set the behavior for sensitive data guardrails to allow, mask, or deny.
  • Prompt Safety - Add support for Prompt Safety in Guardrail configurations to mitigate prompt attacks by enforcing restrictions and safeguards on input prompts.
  1. Create a CRUD API to manage response message templates.
  • API allows creation, reading, updating, and deleting templates.
  • Templates are stored and retrieved correctly.
  1. Implement the "Get Guardrail" API specifically for the shield service.
  • Ensure guardrail versioning is taken into account.
  • Note that the shield service requires only the applicationKey as input parameters.
  • APIs should adhere to RESTful standards.
  • Unit tests must be included to validate functionality.

Code of Conduct

  • I agree to follow this project's Code of Conduct
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

No branches or pull requests

1 participant