Skip to content

feat(modelarmor): #14 Added snippets for update template with mask config #5280

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

Open
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

tirthrajsinh-zala-crest
Copy link
Contributor

@tirthrajsinh-zala-crest tirthrajsinh-zala-crest commented Apr 11, 2025

Description

Added sample for update template with mask config

Checklist

  • I have followed Contributing Guidelines from CONTRIBUTING.MD
  • Tests pass: go test -v ./.. (see Testing)
  • Code formatted: gofmt (see Formatting)
  • Vetting pass: go vet (see Formatting)
  • These samples need a new API enabled in testing projects to pass (Model Armor API)
  • These samples need a new/updated env vars in testing projects set to pass (GOLANG_SAMPLES_LOCATION)
  • This sample adds a new sample directory, and I updated the CODEOWNERS file with the codeowners for this sample
  • This sample adds a new Product API, and I updated the Blunderbuss issue/PR auto-assigner with the codeowners for this sample
  • Please merge this PR for me once it is approved

Copy link

@gemini-code-assist gemini-code-assist bot left a 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 sample for updating a Model Armor template with a mask configuration. It includes the addition of new files related to Model Armor, such as create_template.go, go.mod, go.sum, modelarmor_test.go, testdata/env/test.env, and update_template_with_mask_configuration.go. The changes demonstrate how to create and update Model Armor templates with specific filter configurations using the cloud.google.com/go/modelarmor library.

Highlights

  • New Model Armor Sample: Adds a complete sample for creating and updating Model Armor templates, showcasing the usage of mask configurations for targeted updates.
  • Template Creation: Introduces create_template.go, which provides a function to create a new Model Armor template with specified filters for PI, jailbreak attempts, and malicious URIs.
  • Template Update with Mask: Implements update_template_with_mask_configuration.go, demonstrating how to update a template's filter configuration using a field mask to avoid overwriting other settings.
  • Dependencies: Adds necessary dependencies in go.mod and go.sum for the Model Armor API and related utilities.
  • Testing: Includes a test case in modelarmor_test.go to verify the update template with mask configuration functionality.

Changelog

Click here to see the changelog
  • go.work
    • Added the ./modelarmor directory to the go workspace.
  • modelarmor/create_template.go
    • Created a new file with a sample function createModelArmorTemplate to create a Model Armor template.
    • The function sets up filters for PI, jailbreak attempts, and malicious URIs.
    • It uses the cloud.google.com/go/modelarmor library to interact with the Model Armor API.
  • modelarmor/go.mod
    • Created a new go module for the Model Armor sample.
    • Added dependencies for cloud.google.com/go/modelarmor, google.golang.org/api, google.golang.org/grpc, and other utility libraries.
  • modelarmor/go.sum
    • Generated the go sum file to lock the dependencies.
  • modelarmor/modelarmor_test.go
    • Created a new test file for the Model Armor sample.
    • Added a test case TestUpdateTemplateWithMaskConfiguration to verify the update template with mask configuration functionality.
    • Includes helper functions for setting up the test environment and cleaning up resources.
  • modelarmor/testdata/env/test.env
    • Created a test environment file to store environment variables for testing.
  • modelarmor/update_template_with_mask_configuration.go
    • Created a new file with a sample function updateModelArmorTemplateWithMaskConfiguration to update a Model Armor template using a mask configuration.
    • The function updates the template's filter configuration, specifically the RAI and SDP settings.
    • It uses a field mask to specify which fields to update.
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 template's form,
Filters masked, a focused storm,
RAI and SDP.

Footnotes

  1. 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.

@product-auto-label product-auto-label bot added the samples Issues that are directly related to samples. label Apr 11, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a 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 new samples for creating and updating Model Armor templates. The code appears well-structured and includes necessary error handling and documentation. However, there are a few areas that could be improved for clarity and efficiency.

Summary of Findings

  • Error message formatting: The error messages could be improved by including the template ID for easier debugging.
  • Redundant client creation: The test suite creates the client multiple times, which can be optimized by creating it once and reusing it.

Merge Readiness

The pull request is almost ready for merging. Addressing the error message formatting and client creation redundancy would improve the code quality. I am unable to directly approve the pull request, and users should have others review and approve this code before merging. I recommend addressing the comments before merging.

@tirthrajsinh-zala-crest tirthrajsinh-zala-crest marked this pull request as ready for review April 11, 2025 13:25
@tirthrajsinh-zala-crest tirthrajsinh-zala-crest requested review from a team as code owners April 11, 2025 13:25
Copy link

snippet-bot bot commented Apr 11, 2025

Here is the summary of changes.

You are about to add 1 region tag.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

Copy link
Collaborator

@telpirion telpirion left a 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 . Please re-open once all issues have been addressed.

@telpirion telpirion self-assigned this Apr 11, 2025
@telpirion telpirion marked this pull request as draft April 11, 2025 18:40
@tirthrajsinh-zala-crest tirthrajsinh-zala-crest marked this pull request as ready for review April 14, 2025 17:33
@utsav1810 utsav1810 added kokoro:force-run Add this label to force Kokoro to re-run the tests. kokoro:run Add this label to force Kokoro to re-run the tests. labels Apr 17, 2025
@kokoro-team kokoro-team removed kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Apr 17, 2025
@tirthrajsinh-zala-crest tirthrajsinh-zala-crest changed the title feat(modelarmor): Added sample for update template with mask config feat(modelarmor): Added snippet for update template with mask config Apr 17, 2025
@tirthrajsinh-zala-crest tirthrajsinh-zala-crest changed the title feat(modelarmor): Added snippet for update template with mask config feat(modelarmor): Added snippets for update template with mask config Apr 17, 2025
@tirthrajsinh-zala-crest tirthrajsinh-zala-crest requested a review from a team as a code owner April 18, 2025 09:57
@product-auto-label product-auto-label bot added the api: modelarmor Issues related to the Model Armor API. label May 2, 2025
@tirthrajsinh-zala-crest tirthrajsinh-zala-crest changed the title feat(modelarmor): Added snippets for update template with mask config feat(modelarmor): #14 Added snippets for update template with mask config May 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: modelarmor Issues related to the Model Armor API. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants