Skip to content

feat(modelarmor): #10 Added snippets for get template and list templates #5276

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 25 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 modelarmor get and list template code snippets

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 code snippets for interacting with the Model Armor service in Go. Specifically, it adds functionality to create, get, and list Model Armor templates. The changes include new files with sample code demonstrating these operations, as well as modifications to the go.mod and go.work files to include the new module.

Highlights

  • New Functionality: Adds code snippets for creating Model Armor templates, including setting filter configurations for PI and jailbreak attempts, and malicious URIs.
  • Template Retrieval: Implements code to retrieve existing Model Armor templates by their ID.
  • Template Listing: Provides code to list all Model Armor templates within a specified project and location, with and without filtering.
  • Module Configuration: Updates go.mod and go.work to include the new modelarmor module and its dependencies.
  • Testing: Adds tests for the get, list, and list with filter functions.

Changelog

Click here to see the changelog
  • go.work
    • Added the modelarmor module to the workspace.
  • modelarmor/create_template.go
    • Created a new file with sample code for creating Model Armor templates.
    • Includes setting filter configurations for PI and jailbreak attempts, and malicious URIs.
    • Uses the modelarmor.NewClient to create a client.
    • Uses client.CreateTemplate to create the template.
  • modelarmor/get_template.go
    • Created a new file with sample code for retrieving Model Armor templates.
    • Uses the modelarmor.NewClient to create a client.
    • Uses client.GetTemplate to retrieve the template.
  • modelarmor/go.mod
    • Created a new go.mod file for the modelarmor module.
    • Includes dependencies such as cloud.google.com/go/modelarmor, google.golang.org/api, and google.golang.org/grpc.
  • modelarmor/go.sum
    • Created a new go.sum file for the modelarmor module.
    • Includes checksums for all dependencies.
  • modelarmor/list_templates.go
    • Created a new file with sample code for listing Model Armor templates.
    • Uses the modelarmor.NewClient to create a client.
    • Uses client.ListTemplates to list the templates.
  • modelarmor/list_templates_with_filter.go
    • Created a new file with sample code for listing Model Armor templates with filtering.
    • Uses the modelarmor.NewClient to create a client.
    • Uses client.ListTemplates to list the templates with a filter.
  • modelarmor/modelarmor_test.go
    • Created a new file with tests for the get, list, and list with filter functions.
    • Uses testutil.SystemTest for system testing.
    • Uses createModelArmorTemplate to create a template for testing.
    • Uses getModelArmorTemplate, listModelArmorTemplates, and listModelArmorTemplatesWithFilter to test the functions.
  • modelarmor/testdata/env/test.env
    • Created a new file with environment variables for testing.
    • Includes GOLANG_SAMPLES_ORGANIZATION_ID and GOLANG_SAMPLES_FOLDER_ID.
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 born,
Armor it well, code so strong,
Models now secure.

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

This pull request introduces new functionalities for managing Model Armor templates, including creating, retrieving, and listing templates, with and without filters. The code is well-structured and includes comprehensive documentation. However, there are a few areas that could be improved for clarity and efficiency.

Summary of Findings

  • Error message consistency: The error messages could be more consistent in their formatting and verbosity. Standardizing the error messages will improve debugging and maintainability.
  • Redundant locationID parameter: The locationID parameter is used in conjunction with fmt.Sprintf to construct the endpoint. This parameter is redundant and can be removed by directly embedding the location in the endpoint string.
  • Test environment setup: The test environment setup relies on loading a .env file. It would be more robust to use environment variables directly or provide a default value if the environment variable is not set.

Merge Readiness

The pull request is almost ready for merging. Addressing the error message consistency and redundant parameter issues will improve the code quality. Additionally, enhancing the test environment setup will make the tests more reliable. 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 3 region tags.

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 . I will change this to draft; re-open when the global issues are resolved.

@telpirion telpirion self-assigned this Apr 11, 2025
@telpirion telpirion marked this pull request as draft April 11, 2025 18:07
@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 the kokoro:run Add this label to force Kokoro to re-run the tests. label Apr 17, 2025
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Apr 17, 2025
@tirthrajsinh-zala-crest tirthrajsinh-zala-crest changed the title feat(modelarmor): modelarmor get and list template code snippets feat(modelarmor): Added snippets for get template and list templates Apr 17, 2025
@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 get template and list templates feat(modelarmor): #10 Added snippets for get template and list templates 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