feat(modelarmor): Added floor settings samples for model armor #4053
Conversation
|
Here is the summary of changes. You are about to add 6 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 samples for floor setting operations in the Model Armor API, along with corresponding test cases. The changes include adding new files for creating, getting, and updating floor settings at the organization, folder, and project levels. Additionally, the pull request updates the CODEOWNERS file and blunderbuss.yml to include the model-armor API.
Highlights
- Floor Setting Samples: Adds samples for getting and updating floor settings for organizations, folders, and projects.
- Test Cases: Includes test cases to validate the functionality of the new floor setting samples.
- Configuration Updates: Updates the CODEOWNERS file and blunderbuss.yml to include the model-armor API.
Changelog
Click here to see the changelog
- .github/blunderbuss.yml
- Adds modelarmor API to assign_issues_by and assign_prs_by sections, routing to the GoogleCloudPlatform/cloud-modelarmor-team.
- CODEOWNERS
- Adds model-armor codeowners, assigning responsibility to @GoogleCloudPlatform/nodejs-samples-reviewers, @GoogleCloudPlatform/cloud-samples-reviewers, and @GoogleCloudPlatform/cloud-modelarmor-team.
- model-armor/package.json
- Creates a package.json file for the model-armor samples, defining dependencies, scripts, and metadata.
- 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 new model armor template with template metadata.
- model-armor/snippets/deleteTemplate.js
- Adds a snippet for deleting a Model Armor template.
- model-armor/snippets/getFolderFloorSettings.js
- Adds a snippet for retrieving the floor settings for a Google Cloud folder.
- model-armor/snippets/getOrganizationFloorSettings.js
- Adds a snippet for retrieving the floor settings for a Google Cloud organization.
- model-armor/snippets/getProjectFloorSettings.js
- Adds a snippet for retrieving the floor settings for a Google Cloud project.
- 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/updateFolderFloorSettings.js
- Adds a snippet for updating the floor settings of a folder in Model Armor.
- model-armor/snippets/updateOrganizationFloorSettings.js
- Adds a snippet for updating the floor settings of an organization in Model Armor.
- model-armor/snippets/updateProjectFloorSettings.js
- Adds a snippet for updating the floor settings of a project in Model Armor.
- 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.yml file for the test directory, configuring the environment for Mocha tests.
- model-armor/test/modelarmor.test.js
- Adds a test suite for Model Armor, including tests for getting and updating floor settings at the organization, folder, and project levels.
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.
Floor settings we tweak, with utmost care,
Ensuring the safety, beyond compare.
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 introduces samples for floor setting operations in Model Armor, along with corresponding test cases. The addition of these samples enhances the usability and understanding of the Model Armor API. The code appears well-structured and follows general best practices. However, there are a few areas that could benefit from improvement, particularly in terms of error handling and documentation clarity.
Summary of Findings
- Missing Error Handling: The code lacks explicit error handling for the
getFloorSettingmethod calls in the get floor settings samples. If the API call fails, the application might crash or behave unexpectedly. Adding error handling would make the samples more robust. - Inconsistent use of
ModelArmorClient: IngetFolderFloorSettings.js, the ModelArmorClient is imported from@google-cloud/modelarmor.v1, but ingetOrganizationFloorSettings.jsandgetProjectFloorSettings.js, it's imported from@google-cloud/modelarmor. This inconsistency should be addressed for better maintainability. - Copyright Year: The copyright year is set to 2025 in all the new files. Please confirm that this is correct, or update it to the current year.
Merge Readiness
The pull request is almost ready for merging. However, the missing error handling in the get floor settings samples should be addressed before merging. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging. I recommend that the pull request not be merged until the high severity issues are addressed.
| const response = await modelarmorClient.getFloorSetting(request); | ||
| console.log(response); |
There was a problem hiding this comment.
Consider adding error handling to the getFloorSetting method call. If the API call fails, the application might crash or behave unexpectedly. A try-catch block would be appropriate here.
try {
const response = await modelarmorClient.getFloorSetting(request);
console.log(response);
} catch (err) {
console.error('Failed to get floor setting:', err);
}| const response = await modelarmorClient.getFloorSetting(request); | ||
| console.log(response); |
There was a problem hiding this comment.
Consider adding error handling to the getFloorSetting method call. If the API call fails, the application might crash or behave unexpectedly. A try-catch block would be appropriate here.
try {
// Run request
const response = await modelarmorClient.getFloorSetting(request);
console.log(response);
} catch (err) {
console.error('Failed to get floor setting:', err);
}| const response = await modelarmorClient.getFloorSetting(request); | ||
| console.log(response); |
There was a problem hiding this comment.
Consider adding error handling to the getFloorSetting method call. If the API call fails, the application might crash or behave unexpectedly. A try-catch block would be appropriate here.
try {
// Run request
const response = await modelarmorClient.getFloorSetting(request);
console.log(response);
} catch (err) {
console.error('Failed to get floor setting:', err);
}| const name = `organizations/${organizationId}/locations/global/floorSetting`; | ||
|
|
||
| // Imports the Modelarmor library | ||
| const {ModelArmorClient} = require('@google-cloud/modelarmor').v1; |
There was a problem hiding this comment.
The ModelArmorClient is imported directly from @google-cloud/modelarmor. For consistency, consider importing from @google-cloud/modelarmor.v1 as done in getFolderFloorSettings.js.
const {ModelArmorClient} = require('@google-cloud/modelarmor').v1;| const name = `projects/${projectId}/locations/global/floorSetting`; | ||
|
|
||
| // Imports the Modelarmor library | ||
| const {ModelArmorClient} = require('@google-cloud/modelarmor').v1; |
There was a problem hiding this comment.
The ModelArmorClient is imported directly from @google-cloud/modelarmor. For consistency, consider importing from @google-cloud/modelarmor.v1 as done in getFolderFloorSettings.js.
const {ModelArmorClient} = require('@google-cloud/modelarmor').v1;There was a problem hiding this comment.
Its been imported in the same way as in getFolderFloorSettings.js
Description
Added samples for floor setting operations along with test cases.
Checklist
npm test(see Testing)npm run lint(see Style)GoogleCloudPlatform/nodejs-docs-samples. Not a fork.