feat(modelarmor): Added quickstart sample for model armor #4052
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 a quickstart sample for creating and using Model Armor templates. It includes code snippets for creating templates with Responsible AI (RAI) filters and demonstrates how to sanitize user prompts and model responses using these templates. Additionally, the PR updates the CODEOWNERS file and blunderbuss configuration to include the model-armor directory and assigns the appropriate team for reviews.
Highlights
- Quickstart Sample: Adds a new quickstart sample demonstrating how to create and use Model Armor templates for sanitizing user prompts and model responses.
- Template Creation: Includes code snippets for creating Model Armor templates with Responsible AI (RAI) filters, which can be used to filter hate speech and sexually explicit content.
- Configuration Updates: Updates the CODEOWNERS file and blunderbuss configuration to include the model-armor directory and assign the appropriate team for reviews.
Changelog
Click here to see the changelog
- .github/blunderbuss.yml
- Added labels to assign issues and pull requests related to the 'modelarmor' API to the GoogleCloudPlatform/cloud-modelarmor-team.
- CODEOWNERS
- Added 'model-armor' directory and assigned codeowners including @GoogleCloudPlatform/nodejs-samples-reviewers, @GoogleCloudPlatform/cloud-samples-reviewers, and @GoogleCloudPlatform/cloud-modelarmor-team.
- model-armor/package.json
- Created a new package.json file for the 'nodejs-model-armor-samples' project, including dependencies such as '@google-cloud/modelarmor', 'c8', 'chai', 'mocha', and 'uuid'.
- Added scripts for testing using 'c8 mocha'.
- model-armor/snippets/createTemplate.js
- Created a new snippet for creating a Model Armor template with Responsible AI (RAI) filters.
- Includes code to instantiate a ModelArmorClient and create a template with specified RAI filters for hate speech and sexually explicit content.
- model-armor/snippets/createTemplateWithAdvancedSdp.js
- Created a new snippet for creating a Model Armor template with advanced SDP settings enabled.
- Includes parameters for inspectTemplate and deidentifyTemplate to perform Sanitization using Sensitive Data Protection.
- model-armor/snippets/createTemplateWithBasicSdp.js
- Created a new snippet for creating a Model Armor template with basic SDP settings enabled.
- Includes configuration for raiSettings and sdpSettings with basicConfig enforcement.
- model-armor/snippets/createTemplateWithLabels.js
- Created a new snippet for creating a Model Armor template with Responsible AI (RAI) filters and custom labels.
- Includes parameters for labelKey and labelValue to add custom labels to the template.
- model-armor/snippets/createTemplateWithMetadata.js
- Created a new snippet for creating a Model Armor template with template metadata.
- Includes configuration for templateMetadata such as ignorePartialInvocationFailures and logSanitizeOperations.
- model-armor/snippets/deleteTemplate.js
- Created a new snippet for deleting a Model Armor template.
- Includes code to instantiate a ModelArmorClient and delete a template by its name.
- model-armor/snippets/getTemplate.js
- Created a new snippet for retrieving a Model Armor template by its ID.
- Includes code to instantiate a ModelArmorClient and get a template by its name.
- model-armor/snippets/listTemplates.js
- Created a new snippet for listing all Model Armor templates in a specified project and location.
- Includes code to instantiate a ModelArmorClient and list templates.
- model-armor/snippets/listTemplatesWithFilter.js
- Created a new snippet for listing Model Armor templates that match a specific filter criteria.
- Includes code to instantiate a ModelArmorClient and list templates with a filter.
- model-armor/snippets/quickstart.js
- Created a new quickstart example for using Google Cloud Model Armor to create a template with RAI filters and sanitize content.
- Includes code to create a template and sanitize user prompts and model responses.
- model-armor/snippets/updateTemplate.js
- Created a new snippet for updating an existing Model Armor template.
- Includes code to instantiate a ModelArmorClient and update a template with new filter configurations.
- model-armor/snippets/updateTemplateLabels.js
- Created a new snippet for updating the labels of an existing Model Armor template.
- Includes code to instantiate a ModelArmorClient and update a template's labels.
- model-armor/snippets/updateTemplateMetadata.js
- Created a new snippet for updating the metadata of an existing Model Armor template.
- Includes code to instantiate a ModelArmorClient and update a template's metadata.
- model-armor/snippets/updateTemplateWithMaskConfiguration.js
- Created a new snippet for updating an existing Model Armor template with a specific update mask.
- Includes code to instantiate a ModelArmorClient and update a template with a mask configuration.
- model-armor/test/.eslintrc.yml
- Added eslint configuration file for the test directory.
- model-armor/test/modelarmor.test.js
- Created a new test file for Model Armor snippets.
- Includes tests for creating a template and sanitizing content.
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.
Trivia time!
What is the primary purpose of a 'filter' in the context of AI model security, such as in Model Armor?
Click here for the answer
In the context of AI model security, a 'filter' is primarily used to detect and mitigate harmful or inappropriate content in user inputs (prompts) and model outputs (responses), ensuring safer and more responsible AI interactions.
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. ↩
There was a problem hiding this comment.
Code Review
The pull request introduces several new code snippets for creating and managing Model Armor templates. The code is generally well-structured and follows a consistent pattern. However, there are a few areas where improvements can be made, particularly in error handling and addressing TODO comments.
Summary of Findings
- Missing Error Handling: The code lacks proper error handling for the client.createTemplate method calls. If the API call fails, the program might crash or behave unexpectedly. Error handling should be implemented to ensure the application gracefully handles failures.
- TODO comments: The code contains TODO comments that should be addressed. These comments indicate areas where the code is incomplete or requires further attention. Addressing these TODOs will improve the overall quality and maintainability of the code.
- Inconsistent use of async/await: In some snippets, the async function is called without awaiting the result, which might lead to unexpected behavior. Ensure that all async functions are properly awaited to guarantee the correct execution order and error handling.
Merge Readiness
The pull request is not yet ready for merging. There are several medium and high severity issues that need to be addressed. Specifically, the missing error handling and the presence of TODO comments should be resolved before merging. I am unable to approve this pull request, and recommend that others review and approve this code before merging. At a minimum, the high severity issues should be addressed before merging.
| console.log(`Created template: ${response.name}`); | ||
| } | ||
|
|
||
| createTemplate(); |
There was a problem hiding this comment.
Consider adding error handling to the createTemplate() function to catch any potential exceptions during template creation. This will prevent the application from crashing if the API call fails.
try {
createTemplate();
} catch (error) {
console.error('Failed to create template:', error);
}There was a problem hiding this comment.
Not added error handling in snippets to maintain code consisteny across samples for different services.
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or removing the comments if they are no longer relevant.
| * TODO(developer): Uncomment these variables before running the sample. | |
| */ | |
| // const projectId = 'your-project-id' || 'default-project-id'; | |
| // const locationId = 'us-central1' || 'us-east1'; |
There was a problem hiding this comment.
These files have been shifted to a different PR, hence have outdated.
| console.log(`Created template: ${response.name}`); | ||
| } | ||
|
|
||
| createTemplateWithAdvancedSdp(); |
There was a problem hiding this comment.
Consider adding error handling to the createTemplateWithAdvancedSdp() function to catch any potential exceptions during template creation. This will prevent the application from crashing if the API call fails.
try {
createTemplateWithAdvancedSdp();
} catch (error) {
console.error('Failed to create template:', error);
}| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or removing the comments if they are no longer relevant.
// const projectId = 'your-project-id' || 'default-project-id';
// const locationId = 'us-central1' || 'us-east1';| console.log(`Created template: ${response.name}`); | ||
| } | ||
|
|
||
| return createTemplateWithBasicSdp(); |
There was a problem hiding this comment.
Consider adding error handling to the createTemplateWithBasicSdp() function to catch any potential exceptions during template creation. This will prevent the application from crashing if the API call fails.
try {
return createTemplateWithBasicSdp();
} catch (error) {
console.error('Failed to create template:', error);
}| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or removing the comments if they are no longer relevant.
// const projectId = 'your-project-id' || 'default-project-id';
// const locationId = 'us-central1' || 'us-east1';| const [response] = await client.updateTemplate(request); | ||
| console.log(`Updated Model Armor Template: ${response.name}`); | ||
| } | ||
|
|
There was a problem hiding this comment.
Consider adding error handling to the updateTemplateMetadata() function to catch any potential exceptions during template creation. This will prevent the application from crashing if the API call fails.
try {
updateTemplateMetadata();
} catch (error) {
console.error('Failed to update template:', error);
}| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or removing the comments if they are no longer relevant.
// const projectId = 'your-project-id' || 'default-project-id';
// const locationId = 'us-central1' || 'us-east1';| console.log(`Updated Model Armor Template: ${response.name}`); | ||
| } | ||
|
|
||
| updateTemplateWithMaskConfiguration(); |
There was a problem hiding this comment.
Consider adding error handling to the updateTemplateWithMaskConfiguration() function to catch any potential exceptions during template creation. This will prevent the application from crashing if the API call fails.
try {
updateTemplateWithMaskConfiguration();
} catch (error) {
console.error('Failed to update template:', error);
}| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ |
There was a problem hiding this comment.
These TODO comments should be addressed. Consider providing default values or removing the comments if they are no longer relevant.
// const projectId = 'your-project-id' || 'default-project-id';
// const locationId = 'us-central1' || 'us-east1';
Description
Added quickstart code snippet for creating and using a model armor template.
Checklist
npm test(see Testing)npm run lint(see Style)GoogleCloudPlatform/nodejs-docs-samples. Not a fork.