feat(modelarmor): Added samples for user prompt and model response sanitization in model armor #4051
Conversation
|
Here is the summary of changes. You are about to add 1 region tag.
This comment is generated by snippet-bot.
|
product-auto-label
bot
added
the
samples
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @rudrakhsha-crest, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request introduces snippets for sanitizing user prompts and model responses using the Model Armor API. It includes code for creating templates with various configurations, such as RAI filters, SDP settings, labels, and metadata. The snippets demonstrate how to sanitize user prompts and model responses, including PDF content, and how to manage templates (create, delete, get, list, update). The changes also include updates to the .github/blunderbuss.yml and CODEOWNERS files to include the model-armor API.
Highlights
- New snippets: Adds new snippets for creating Model Armor templates with RAI filters, SDP settings, labels, and metadata.
- Sanitization: Introduces snippets for sanitizing user prompts and model responses, including PDF content, using Model Armor templates.
- Template management: Provides snippets for managing Model Armor templates (create, delete, get, list, update).
- Configuration: Updates
.github/blunderbuss.ymlandCODEOWNERSto include themodel-armorAPI.
Changelog
Click here to see the changelog
- .github/blunderbuss.yml
- Adds
api: modelarmorto the issue and PR auto-assigner, associating it with theGoogleCloudPlatform/cloud-modelarmor-team.
- Adds
- CODEOWNERS
- Adds
model-armorto the CODEOWNERS file, assigning ownership to@GoogleCloudPlatform/nodejs-samples-reviewers,@GoogleCloudPlatform/cloud-samples-reviewers, and@GoogleCloudPlatform/cloud-modelarmor-team.
- Adds
- model-armor/package.json
- Creates a
package.jsonfile for themodel-armorsamples, defining dependencies, scripts, and metadata.
- Creates a
- model-armor/snippets/createTemplate.js
- Adds a snippet for creating a Model Armor template with Responsible AI (RAI) filters.
- model-armor/snippets/createTemplateWithAdvancedSdp.js
- Adds a snippet for creating a Model Armor template with advanced SDP settings enabled.
- model-armor/snippets/createTemplateWithBasicSdp.js
- Adds a snippet for creating a Model Armor template with basic SDP settings enabled.
- model-armor/snippets/createTemplateWithLabels.js
- Adds a snippet for creating a Model Armor template with Responsible AI (RAI) filters and custom labels.
- model-armor/snippets/createTemplateWithMetadata.js
- Adds a snippet for creating a Model Armor template with template metadata.
- model-armor/snippets/deleteTemplate.js
- Adds a snippet for deleting a Model Armor template.
- model-armor/snippets/getTemplate.js
- Adds a snippet for retrieving a Model Armor template by its ID.
- model-armor/snippets/listTemplates.js
- Adds a snippet for listing all Model Armor templates in a specified project and location.
- model-armor/snippets/listTemplatesWithFilter.js
- Adds a snippet for listing Model Armor templates that match a specific filter criteria.
- model-armor/snippets/sanitizeModelResponse.js
- Adds a snippet for sanitizing a model response using Model Armor filters.
- model-armor/snippets/sanitizeModelResponseWithUserPrompt.js
- Adds a snippet for sanitizing a model response with context from the original user prompt.
- model-armor/snippets/sanitizeUserPrompt.js
- Adds a snippet for sanitizing a user prompt using Model Armor filters.
- model-armor/snippets/screenPdfFile.js
- Adds a snippet for sanitizing/screening PDF content using the Model Armor API.
- model-armor/snippets/updateTemplate.js
- Adds a snippet for updating an existing Model Armor template.
- model-armor/snippets/updateTemplateLabels.js
- Adds a snippet for updating the labels of an existing Model Armor template.
- model-armor/snippets/updateTemplateMetadata.js
- Adds a snippet for updating the metadata of an existing Model Armor template.
- model-armor/snippets/updateTemplateWithMaskConfiguration.js
- Adds a snippet for updating an existing Model Armor template with a specific update mask.
- model-armor/test/.eslintrc.yml
- Adds an
.eslintrc.ymlfile for themodel-armortests, configuring the environment for Mocha.
- Adds an
- model-armor/test/modelarmor.test.js
- Adds a test suite for the Model Armor snippets, covering user prompt sanitization, model response sanitization, and PDF sanitization.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Did you know?
The concept of using filters to sanitize content dates back to ancient libraries, where librarians would curate and restrict access to certain texts based on their content.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
rudrakhsha-crest
changed the title
There was a problem hiding this comment.
Code Review
This pull request introduces snippets for user prompt and model response sanitization using the Model Armor API. The changes include adding new files for various sanitization scenarios and updating the blunderbuss configuration and CODEOWNERS file. Overall, the code seems well-structured and addresses the intended functionality. However, there are a few areas that could be improved for clarity and maintainability.
Summary of Findings
- Missing Error Handling: The code lacks explicit error handling for API calls and other operations, which could lead to unhandled exceptions and unexpected behavior. It's important to add error handling to ensure the application is robust and provides informative error messages.
- Copyright Year: The copyright year is set to 2025 in all the new files. Please confirm if this is the correct year, or if it should be updated to the current year.
- TODO comments: The code contains TODO comments that should be addressed before merging. These comments indicate areas where the code needs further implementation or clarification.
Merge Readiness
The pull request is not quite ready for merging. There are a few issues that need to be addressed before merging, including adding error handling, confirming the copyright year, and addressing the TODO comments. I am unable to approve this pull request, and recommend that another reviewer also take a look at this code before merging.
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'your-template-id'; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
// const projectId = process.env.PROJECT_ID || 'your-project-id';
// const locationId = process.env.LOCATION_ID || 'us-central1';
// const templateId = process.env.TEMPLATE_ID || 'your-template-id';There was a problem hiding this comment.
These files have been shifted to a different PR, hence the outdated comments.
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'template-id'; | ||
| // const inspectTemplate = `projects/${projectId}/locations/${locationId}/inspectTemplates/inspect-template-id`; | ||
| // const deidentifyTemplate = `projects/${projectId}/locations/${locationId}/deidentifyTemplates/deidentify-template-id`; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
// const projectId = process.env.PROJECT_ID || 'your-project-id';
// const locationId = process.env.LOCATION_ID || 'us-central1';
// const templateId = process.env.TEMPLATE_ID || 'template-id';
// const inspectTemplate = process.env.INSPECT_TEMPLATE || `projects/${projectId}/locations/${locationId}/inspectTemplates/inspect-template-id`;
// const deidentifyTemplate = process.env.DEIDENTIFY_TEMPLATE || `projects/${projectId}/locations/${locationId}/deidentifyTemplates/deidentify-template-id`;| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'template-id'; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
// const projectId = process.env.PROJECT_ID || 'your-project-id';
// const locationId = process.env.LOCATION_ID || 'us-central1';
// const templateId = process.env.TEMPLATE_ID || 'template-id';| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'your-template-id'; | ||
| // const labelKey = 'environment'; | ||
| // const labelValue = 'production'; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
// const projectId = process.env.PROJECT_ID || 'your-project-id';
// const locationId = process.env.LOCATION_ID || 'us-central1';
// const templateId = process.env.TEMPLATE_ID || 'your-template-id';
// const labelKey = process.env.LABEL_KEY || 'environment';
// const labelValue = process.env.LABEL_VALUE || 'production';| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'template-id'; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
// const projectId = process.env.PROJECT_ID || 'your-project-id';
// const locationId = process.env.LOCATION_ID || 'us-central1';
// const templateId = process.env.TEMPLATE_ID || 'template-id';| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'template-id'; | ||
| // const pdfContentBase64 = 'BASE64_ENCODED_PDF_CONTENT'; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
| /** | |
| * TODO(developer): Uncomment these variables before running the sample. | |
| */ | |
| // const projectId = 'your-project-id'; | |
| // const locationId = 'us-central1'; | |
| // const templateId = 'template-id'; | |
| // const pdfContentBase64 = 'BASE64_ENCODED_PDF_CONTENT'; | |
| // const projectId = process.env.PROJECT_ID || 'your-project-id'; | |
| // const locationId = process.env.LOCATION_ID || 'us-central1'; | |
| // const templateId = process.env.TEMPLATE_ID || 'template-id'; | |
| // const pdfContentBase64 = process.env.PDF_CONTENT_BASE64 || 'BASE64_ENCODED_PDF_CONTENT'; |
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'template-id'; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
| /** | |
| * TODO(developer): Uncomment these variables before running the sample. | |
| */ | |
| // const projectId = 'your-project-id'; | |
| // const locationId = 'us-central1'; | |
| // const templateId = 'template-id'; | |
| // const projectId = process.env.PROJECT_ID || 'your-project-id'; | |
| // const locationId = process.env.LOCATION_ID || 'us-central1'; | |
| // const templateId = process.env.TEMPLATE_ID || 'template-id'; |
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'template-id'; | ||
| // const labelKey = 'env'; | ||
| // const labelValue = 'prod'; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
| /** | |
| * TODO(developer): Uncomment these variables before running the sample. | |
| */ | |
| // const projectId = 'your-project-id'; | |
| // const locationId = 'us-central1'; | |
| // const templateId = 'template-id'; | |
| // const labelKey = 'env'; | |
| // const labelValue = 'prod'; | |
| // const projectId = process.env.PROJECT_ID || 'your-project-id'; | |
| // const locationId = process.env.LOCATION_ID || 'us-central1'; | |
| // const templateId = process.env.TEMPLATE_ID || 'template-id'; | |
| // const labelKey = process.env.LABEL_KEY || 'env'; | |
| // const labelValue = process.env.LABEL_VALUE || 'prod'; |
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'template-id'; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
| /** | |
| * TODO(developer): Uncomment these variables before running the sample. | |
| */ | |
| // const projectId = 'your-project-id'; | |
| // const locationId = 'us-central1'; | |
| // const templateId = 'template-id'; | |
| // const projectId = process.env.PROJECT_ID || 'your-project-id'; | |
| // const locationId = process.env.LOCATION_ID || 'us-central1'; | |
| // const templateId = process.env.TEMPLATE_ID || 'template-id'; |
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'template-id'; |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or a configuration option to avoid requiring users to uncomment these lines.
| /** | |
| * TODO(developer): Uncomment these variables before running the sample. | |
| */ | |
| // const projectId = 'your-project-id'; | |
| // const locationId = 'us-central1'; | |
| // const templateId = 'template-id'; | |
| // const projectId = process.env.PROJECT_ID || 'your-project-id'; | |
| // const locationId = process.env.LOCATION_ID || 'us-central1'; | |
| // const templateId = process.env.TEMPLATE_ID || 'template-id'; |
rudrakhsha-crest
changed the title
…hsha-crest/nodejs-docs-samples into model-armor-sanitization-snippets
Description
Created samples for user prompt and model response sanitation using model armor APIs.
Checklist
npm test(see Testing)npm run lint(see Style)GoogleCloudPlatform/nodejs-docs-samples. Not a fork.