-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
feat(modelarmor): modelarmor create and delete code snippets #5271
base: main
Are you sure you want to change the base?
feat(modelarmor): modelarmor create and delete code snippets #5271
Conversation
…eleting model armor templates
…eleting modelarmor templates
…eation and template deletion
…eation and template deletion
…eation and template deletion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @tirthrajsinh-zala-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 code snippets for creating and deleting Model Armor templates in Go. It includes the necessary functions and dependencies to interact with the Model Armor API. The changes add a new directory modelarmor
with the implementation files, updates the go.work
file to include the new module, and adds a go.mod
and go.sum
file to manage dependencies. Additionally, it provides test functions to validate the creation and deletion of Model Armor templates.
Highlights
- New Module: A new
modelarmor
module is added to the repository, containing code snippets for interacting with the Model Armor API. - Create Template Function: The
createModelArmorTemplate
function is implemented to create a new Model Armor template with specified filters. - Delete Template Function: The
deleteModelArmorTemplate
function is implemented to delete an existing Model Armor template. - Dependency Management: The
go.mod
andgo.sum
files are added to manage the module's dependencies, includingcloud.google.com/go/modelarmor
and other Google Cloud libraries. - Testing: Test functions are added to verify the creation and deletion of Model Armor templates, ensuring the code snippets function as expected.
Changelog
Click here to see the changelog
- go.work
- Added the
./modelarmor
directory to thego.work
file to include the new module in the workspace.
- Added the
- modelarmor/create_template.go
- Implemented the
createModelArmorTemplate
function to create a new Model Armor template. - The function takes project ID, location, and template ID as input.
- It sets up filters for PI, jailbreak, and malicious URI detection.
- It prints the name of the created template to the provided io.Writer.
- Implemented the
- modelarmor/delete_template.go
- Implemented the
deleteModelArmorTemplate
function to delete a Model Armor template. - The function takes project ID, location, and template ID as input.
- It prints a success message to the provided io.Writer upon successful deletion.
- Implemented the
- modelarmor/go.mod
- Created the
go.mod
file to manage module dependencies. - Added dependencies such as
cloud.google.com/go/modelarmor
,google.golang.org/api
, andgoogle.golang.org/grpc
.
- Created the
- modelarmor/go.sum
- Created the
go.sum
file to track the dependencies' checksums for verifying the integrity of the dependencies.
- Created the
- modelarmor/modelarmor_test.go
- Added test functions to verify the creation and deletion of Model Armor templates.
- Utilized
testutil.SystemTest
for system testing. - Implemented
testCleanupTemplate
to clean up templates after testing. - Added
TestCreateModelArmorTemplate
to test template creation. - Added
TestDeleteModelArmorTemplate
to test template deletion.
- modelarmor/testdata/env/test.env
- Added test environment file to define the location of the test environment.
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.
Create and delete, the templates we wield,
A digital shield, on the data field.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The pull request introduces code snippets for creating and deleting Model Armor templates. The code includes the necessary functions and tests to manage these templates. Overall, the code is well-structured and includes helpful documentation. However, there are a few areas that could be improved for clarity and robustness.
Summary of Findings
- Error Handling in Tests: The tests use
t.Fatal(err)
which immediately stops the test. Consider usingt.Error(err)
to allow the test to continue and report multiple errors. - Missing Input Validation: The functions
createModelArmorTemplate
anddeleteModelArmorTemplate
do not validate input parameters such asprojectID
,location
, andtemplateID
. Adding validation can prevent unexpected behavior. - Hardcoded Location in Tests: The tests use a hardcoded location (
us-central1
). It's better to use thetestLocation
function to get the location from the environment.
Merge Readiness
The pull request is almost ready for merging. Addressing the error handling in tests, adding input validation, and using the testLocation
function in tests would improve the robustness and maintainability of the code. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging. However, I recommend that the pull request not be merged until the high severity issues are addressed.
Here is the summary of changes. You are about to add 2 region tags.
This comment is generated by snippet-bot.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These variables should be added to the test infra.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See comments in #5273. The global issues are present here, too.
I am going to convert most of these other PRs to draft while the global issues are addressed. |
Description
Added Modelarmor code snippet for simple model armor template creation and deletion
Checklist
go test -v ./..
(see Testing)gofmt
(see Formatting)go vet
(see Formatting)