Skip to content

feat(modelarmor): #13 Added snippets for update template with metadata #5279

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 19 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 modelarmor template with metadata

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

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

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 metadata. It includes the addition of new files related to Model Armor functionality, and modifies the go.work file to include the new modelarmor module. Specifically, it adds sample code for creating and updating Model Armor templates, including setting filters and metadata.

Highlights

  • New Module: A new modelarmor module is added to the go.work file.
  • Create Template Sample: The pull request introduces create_template.go, which provides sample code for creating a new Model Armor template with specified filters.
  • Update Template Metadata Sample: The pull request introduces update_template_metadata.go, which provides sample code for updating the metadata of a Model Armor template, including RAI and SDP settings.
  • Test Cases: The pull request introduces modelarmor_test.go, which includes a test case for updating template metadata.
  • Environment Configuration: The pull request introduces test.env file for configuring the test environment.

Changelog

Click here to see the changelog
  • go.work
    • Added the ./modelarmor module to the go.work file to include it in the workspace.
  • modelarmor/create_template.go
    • Created a new file create_template.go with sample code for creating a Model Armor template.
    • Implemented the createModelArmorTemplate function to create a new template with specified filters.
    • Added error handling and logging for template creation.
  • modelarmor/go.mod
    • Created a new go.mod file for the modelarmor module.
    • Added dependencies for cloud.google.com/go/dlp, cloud.google.com/go/modelarmor, github.com/GoogleCloudPlatform/golang-samples, github.com/google/uuid, github.com/joho/godotenv, google.golang.org/api, google.golang.org/grpc, and google.golang.org/protobuf.
  • modelarmor/go.sum
    • Created a new go.sum file for the modelarmor module to track dependencies.
  • modelarmor/modelarmor_test.go
    • Created a new file modelarmor_test.go with test cases for Model Armor functionality.
    • Implemented the TestUpdateTemplateMetadata test case to verify the update template metadata functionality.
    • Added helper functions for setting up the test environment and cleaning up resources.
  • modelarmor/testdata/env/test.env
    • Created a new test.env file for configuring the test environment.
    • Added GOLANG_SAMPLES_ORGANIZATION_ID and GOLANG_SAMPLES_FOLDER_ID variables.
  • modelarmor/update_template_metadata.go
    • Created a new file update_template_metadata.go with sample code for updating Model Armor template metadata.
    • Implemented the updateModelArmorTemplateMetadata function to update the metadata of a template, including RAI and SDP settings.
    • Added error handling and logging for template metadata updates.
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.
Metadata's touch, a guiding light,
Templates updated, shining bright.

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.

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 a new Model Armor template feature with metadata update functionality. The code includes samples for creating and updating Model Armor templates. Overall, the code is 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 in create_template.go and update_template_metadata.go could be improved by including the project ID and location in the error message for better debugging.
  • Redundant client creation in tests: The testClient function in modelarmor_test.go creates a new client for each test. This can be optimized by creating the client once and reusing it across tests.
  • Missing error check in test cleanup: The testCleanupTemplate function in modelarmor_test.go does not check for errors when creating the client, which could lead to unexpected behavior.

Merge Readiness

The pull request is almost ready for merging. I recommend addressing the error message formatting and the redundant client creation in tests. I am unable to approve this pull request, and recommend that others review and approve this code before merging.

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 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:43
@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): modelarmor update template with metadata feat(modelarmor): Added snippet for update template with metadata Apr 17, 2025
@tirthrajsinh-zala-crest tirthrajsinh-zala-crest changed the title feat(modelarmor): Added snippet for update template with metadata feat(modelarmor): Added snippets for update template with metadata Apr 17, 2025
@tirthrajsinh-zala-crest tirthrajsinh-zala-crest requested a review from a team as a code owner April 18, 2025 09:52
@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 metadata feat(modelarmor): #13 Added snippets for update template with metadata 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.

4 participants