-
Notifications
You must be signed in to change notification settings - Fork 1.8k
feat(modelarmor): Added code snippet for modelarmor screen pdf file #5286
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
base: main
Are you sure you want to change the base?
feat(modelarmor): Added code snippet for modelarmor screen pdf file #5286
Conversation
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 a new feature related to Model Armor, specifically adding code to screen PDF files for potential security risks. It includes a new create_template.go
file with sample code for creating Model Armor templates, and a screen_pdf_file.go
file containing the logic for scanning PDF content. Additionally, it adds necessary dependencies and a test case to verify the PDF screening functionality.
Highlights
- New Feature: PDF Screening: Adds functionality to screen PDF files using Model Armor templates, enhancing security by identifying potentially malicious content.
- Model Armor Template Creation: Introduces sample code for creating Model Armor templates with customizable filters for different types of threats.
- Dependency Updates: Includes necessary
go.mod
andgo.sum
updates to incorporate thecloud.google.com/go/modelarmor
library and other dependencies. - Testing: Adds a test case (
TestScreenPDFFile
) to verify the PDF screening functionality, ensuring it integrates correctly with the Model Armor service.
Changelog
Click here to see the changelog
- go.work
- Added the
modelarmor
directory to thego.work
file to include it in the workspace.
- Added the
- modelarmor/create_template.go
- Created a new file with sample code for creating Model Armor templates.
- Includes functions to create a Model Armor client and define filter configurations for the template.
- Uses
PiAndJailbreakFilterSettings
andMaliciousUriFilterSettings
for content filtering.
- modelarmor/go.mod
- Added the
cloud.google.com/go/modelarmor
dependency. - Updated other dependencies including
google.golang.org/api
andgoogle.golang.org/grpc
.
- Added the
- modelarmor/go.sum
- Added checksums for the new and updated dependencies.
- modelarmor/modelarmor_test.go
- Created a new test file for Model Armor functionality.
- Includes a test case (
TestScreenPDFFile
) to verify the PDF screening functionality. - Defines helper functions for setting up the test environment, creating clients, and cleaning up resources.
- modelarmor/screen_pdf_file.go
- Created a new file with code to screen PDF files using Model Armor.
- Includes functions to sanitize user prompts with PDF content.
- Uses
SanitizeUserPromptRequest
to send the PDF content to the Model Armor service for screening.
- modelarmor/testdata/env/test.env
- Added
GOLANG_SAMPLES_LOCATION
to specify the location for testing.
- Added
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.
A PDF's scanned,
Armor shields from harm's hand,
Code's watchful eye.
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 for creating Model Armor templates and screening PDF files using the Model Armor API. The code includes sample functions and a test case. Overall, the changes seem well-structured and follow Go best practices. However, there are a few areas that could be improved for clarity and robustness.
Summary of Findings
- Error handling in testCleanupTemplate: The testCleanupTemplate function checks for a NotFound error when deleting a template, but it might be more robust to handle other potential errors during deletion.
- Missing input validation: The functions createModelArmorTemplate and screenPDFFile do not have input validation. It would be good to add validation to ensure that the input parameters are valid.
- Hardcoded location: The location "us-central1" is hardcoded in the TestScreenPDFFile function. It would be better to use the value from the environment variable.
Merge Readiness
The pull request introduces new functionality with a test case, but there are some improvements that should be addressed before merging. Specifically, the error handling in testCleanupTemplate
should be made more robust, input validation should be added to the functions, and the hardcoded location in the test should be replaced with the environment variable. I am unable to approve this pull request, and recommend that it not be merged until the high severity issues are addressed, and that others review and approve this code before merging.
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.
This PR has the same global issues as #5273 .
Furthermore, I suspect that the PDF content inlined in these tests aren't appropriate for publishing to GitHub. Don't inline the base64 encoded file (it makes debugging the test much harder, even if the content weren't objectionable).
27c1cc6
to
5e8a43b
Compare
Description
Added code snippet for modelarmor screen pdf file
Checklist
go test -v ./..
(see Testing)gofmt
(see Formatting)go vet
(see Formatting)