feat(modelarmor): Added samples for creating, listing, updating and deleting model armor templates #4050
Conversation
|
Here is the summary of changes. You are about to add 13 region tags.
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 CRUD (Create, Read, Update, Delete) code snippets for the Model Armor API, along with a corresponding entry in the CODEOWNERS file. The new code snippets demonstrate how to manage Model Armor templates, including creating templates with various configurations (basic, SDP, metadata, labels), retrieving, listing, updating, and deleting them. The pull request also updates the .github/blunderbuss.yml file to include modelarmor to assign the GoogleCloudPlatform/cloud-modelarmor-team to issues and pull requests with the api: modelarmor label.
Highlights
- CRUD Snippets for Model Armor: Adds code snippets demonstrating CRUD operations for Model Armor templates, showcasing different configurations and functionalities.
- CODEOWNERS Update: Updates the CODEOWNERS file to include the appropriate team for the new Model Armor samples.
- Blunderbuss Configuration: Updates the blunderbuss.yml file to automatically assign the cloud-modelarmor-team to issues and pull requests with the 'api: modelarmor' label.
Changelog
Click here to see the changelog
- .github/blunderbuss.yml
- Adds
modelarmorto the list of APIs, assigning the GoogleCloudPlatform/cloud-modelarmor-team to related issues and pull requests.
- Adds
- CODEOWNERS
- Adds an entry for
model-armor, assigning ownership to the nodejs-samples-reviewers, cloud-samples-reviewers, and cloud-modelarmor-team.
- Adds an entry for
- model-armor/package.json
- Creates a
package.jsonfile for the Model Armor samples, defining dependencies, scripts, and metadata.
- Creates a
- model-armor/snippets/createTemplate.js
- Adds a code snippet demonstrating how to create a basic Model Armor template with Responsible AI (RAI) filters.
- model-armor/snippets/createTemplateWithAdvancedSdp.js
- Adds a code snippet demonstrating how to create a Model Armor template with advanced Sensitive Data Protection (SDP) settings.
- model-armor/snippets/createTemplateWithBasicSdp.js
- Adds a code snippet demonstrating how to create a Model Armor template with basic SDP settings enabled.
- model-armor/snippets/createTemplateWithLabels.js
- Adds a code snippet demonstrating how to create a Model Armor template with custom labels.
- model-armor/snippets/createTemplateWithMetadata.js
- Adds a code snippet demonstrating how to create a Model Armor template with template metadata.
- model-armor/snippets/deleteTemplate.js
- Adds a code snippet demonstrating how to delete a Model Armor template.
- model-armor/snippets/getTemplate.js
- Adds a code snippet demonstrating how to retrieve a Model Armor template by its ID.
- model-armor/snippets/listTemplates.js
- Adds a code snippet demonstrating how to list all Model Armor templates in a project and location.
- model-armor/snippets/listTemplatesWithFilter.js
- Adds a code snippet demonstrating how to list Model Armor templates that match a specific filter criteria.
- model-armor/snippets/updateTemplate.js
- Adds a code snippet demonstrating how to update an existing Model Armor template.
- model-armor/snippets/updateTemplateLabels.js
- Adds a code snippet demonstrating how to update the labels of an existing Model Armor template.
- model-armor/snippets/updateTemplateMetadata.js
- Adds a code snippet demonstrating how to update the metadata of an existing Model Armor template.
- model-armor/snippets/updateTemplateWithMaskConfiguration.js
- Adds a code snippet demonstrating how to update an existing Model Armor template with a specific update mask.
- model-armor/test/.eslintrc.yml
- Adds eslint configuration for mocha tests.
- model-armor/test/modelarmor.test.js
- Adds tests for model armor snippets.
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.
In realms of code, where models reside,
Armor we forge, with filters applied.
Templates we craft, with labels so fine,
Protecting the output, making it shine.
CRUD operations, our guiding light,
Ensuring AI's future is secure and bright.
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
This pull request adds CRUD code snippets for Model Armor, including tests and updates to CODEOWNERS and blunderbuss.yml. The code appears well-structured and follows common practices. However, there are a few areas that could be improved for clarity and maintainability.
Summary of Findings
- Copyright Year: The copyright year in the snippets is set to 2025. Please confirm this is the correct year or update it to the current year.
- Missing Error Handling: The code snippets lack explicit error handling for the client.createTemplate calls. Adding error handling would improve the robustness of the samples.
- Inconsistent Template Creation: The test suite creates templates directly using the client, while the snippets use execSync to call the CLI. Consider using a consistent approach for both.
Merge Readiness
The pull request is almost ready for merging. Addressing the copyright year, adding error handling, and ensuring consistent template creation would improve the quality of the code. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging. At a minimum, the copyright year and error handling should be addressed before merging.
| @@ -0,0 +1,92 @@ | |||
| // Copyright 2025 Google LLC | |||
There was a problem hiding this comment.
The copyright year is set to 2025. Is this intentional? Should it be updated to the current year?
| // Copyright 2025 Google LLC | |
| // Copyright 2024 Google LLC |
There was a problem hiding this comment.
not addressing these as the current year is 2025
| @@ -0,0 +1,129 @@ | |||
| // Copyright 2025 Google LLC | |||
There was a problem hiding this comment.
The copyright year is set to 2025. Is this intentional? Should it be updated to the current year?
| // Copyright 2025 Google LLC | |
| // Copyright 2024 Google LLC |
| @@ -0,0 +1,99 @@ | |||
| // Copyright 2025 Google LLC | |||
There was a problem hiding this comment.
The copyright year is set to 2025. Is this intentional? Should it be updated to the current year?
| // Copyright 2025 Google LLC | |
| // Copyright 2024 Google LLC |
| @@ -0,0 +1,92 @@ | |||
| // Copyright 2025 Google LLC | |||
There was a problem hiding this comment.
The copyright year is set to 2025. Is this intentional? Should it be updated to the current year?
| // Copyright 2025 Google LLC | |
| // Copyright 2024 Google LLC |
| @@ -0,0 +1,92 @@ | |||
| // Copyright 2025 Google LLC | |||
There was a problem hiding this comment.
The copyright year is set to 2025. Is this intentional? Should it be updated to the current year?
| // Copyright 2025 Google LLC | |
| // Copyright 2024 Google LLC |
| const [response] = await client.createTemplate(request); | ||
| console.log(`Created template: ${response.name}`); |
There was a problem hiding this comment.
Consider adding error handling to the createTemplate call to handle potential API errors.
const [response] = await client.createTemplate(request);
console.log(`Created template: ${response.name}`);
} catch (error) {
console.error("Error creating template:", error);
}| const [response] = await client.createTemplate(request); | ||
| console.log(`Created template: ${response.name}`); |
There was a problem hiding this comment.
Consider adding error handling to the createTemplate call to handle potential API errors.
const [response] = await client.createTemplate(request);
console.log(`Created template: ${response.name}`);
} catch (error) {
console.error("Error creating template:", error);
}| const [response] = await client.createTemplate(request); | ||
| console.log(`Created template: ${response.name}`); |
There was a problem hiding this comment.
Consider adding error handling to the createTemplate call to handle potential API errors.
const [response] = await client.createTemplate(request);
console.log(`Created template: ${response.name}`);
} catch (error) {
console.error("Error creating template:", error);
}| const [response] = await client.createTemplate(request); | ||
| console.log(`Created Model Armor Template: ${response.name}`); |
There was a problem hiding this comment.
Consider adding error handling to the createTemplate call to handle potential API errors.
const [response] = await client.createTemplate(request);
console.log(`Created Model Armor Template: ${response.name}`);
} catch (error) {
console.error("Error creating template:", error);
}| // Helper function to create a template for sanitization tests | ||
| async function createTemplate(templateId, filterConfig) { | ||
| const parent = `projects/${projectId}/locations/${locationId}`; | ||
|
|
||
| try { | ||
| const [response] = await client.createTemplate({ | ||
| parent: parent, | ||
| templateId: templateId, | ||
| template: { | ||
| filterConfig: filterConfig, | ||
| }, | ||
| }); | ||
|
|
||
| console.log(`Created template: ${response.name}`); | ||
| return response; | ||
| } catch (error) { | ||
| console.error(`Error creating template ${templateId}:`, error); | ||
| throw error; | ||
| } | ||
| } |
There was a problem hiding this comment.
The test suite uses execSync to call the CLI, while the snippets use the client library directly. For consistency, consider using the client library in the tests as well, or vice versa.
async function createTemplate(templateId, filterConfig) {
const parent = `projects/${projectId}/locations/${locationId}`;
try {
const [response] = await client.createTemplate({
parent: parent,
templateId: templateId,
template: {
filterConfig: filterConfig,
},
});
console.log(`Created template: ${response.name}`);
return response;
} catch (error) {
console.error(`Error creating template ${templateId}:`, error);
throw error;
}
}
rudrakhsha-crest
changed the title
rudrakhsha-crest
changed the title
rudrakhsha-crest
changed the title
rudrakhsha-crest
changed the title
rudrakhsha-crest
changed the title
Description
Created samples for creating, updating, reading, deleting model armor templates and added CODEOWNERS file.
Checklist
npm test(see Testing)npm run lint(see Style)GoogleCloudPlatform/nodejs-docs-samples. Not a fork.