feat(modelarmor): Added snippets for create template with labels and metadata #5273

tirthrajsinh-zala-crest · 2025-04-11T09:24:08Z

Description

Added snippets for create template with labels and 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 (let us know which ones)
These samples need a new/updated env vars in testing projects set to pass (let us know which ones)
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

…eleting model armor templates

…eleting modelarmor templates

… and metadata

gemini-code-assist

Hello @tirthrajsinh-zala-crest, I'm Gemini Code Assist¹! 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 new snippets for creating Model Armor templates with labels and metadata. It adds three new files: create_template.go, create_template_with_labels.go, and create_template_with_metadata.go, along with delete_template.go, get_template.go, go.mod, go.sum, modelarmor_test.go, and testdata/env/test.env. The changes include adding the modelarmor module to go.work and implementing functions to create, delete, and retrieve Model Armor templates, including those with labels and metadata.

Highlights

New Snippets: Adds snippets for creating Model Armor templates with labels and metadata.
File Additions: Introduces new files for creating, deleting, and retrieving Model Armor templates.
Module Inclusion: Includes the modelarmor module in the go.work file.

Changelog

Click here to see the changelog

go.work
- Added the modelarmor module to the go.work file.
modelarmor/create_template.go
- Added a new file with a function to create a Model Armor template with basic filters.
modelarmor/create_template_with_labels.go
- Added a new file with a function to create a Model Armor template with custom labels and RAI filters.
modelarmor/create_template_with_metadata.go
- Added a new file with a function to create a Model Armor template with template metadata and RAI filters.
modelarmor/delete_template.go
- Added a new file with a function to delete a Model Armor template.
modelarmor/get_template.go
- Added a new file with a function to get a Model Armor template.
modelarmor/go.mod
- Added a new go module for modelarmor with dependencies.
modelarmor/go.sum
- Added a go sum file for modelarmor module.
modelarmor/modelarmor_test.go
- Added tests for creating Model Armor templates with and without labels and metadata.
modelarmor/testdata/env/test.env
- Added test environment file.

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,
With labels bright and bold,
Armor for the cloud.

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

gemini-code-assist

Code Review

This pull request introduces new snippets for creating Model Armor templates with labels and metadata. The code includes examples for creating, getting, and deleting templates, along with corresponding tests. Overall, the code is well-structured and easy to follow.

Merge Readiness

The code appears to be in good shape for merging. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging. There are no critical or high severity issues, and the medium severity issues are relatively minor and can be addressed in future iterations if necessary.

snippet-bot · 2025-04-11T13:24:31Z

Here is the summary of changes.

You are about to add 5 region tags.

modelarmor/create_template.go:19, tag modelarmor_create_template
modelarmor/create_template_with_labels.go:19, tag modelarmor_create_template_with_labels
modelarmor/create_template_with_metadata.go:19, tag modelarmor_create_template_with_metadata
modelarmor/delete_template.go:19, tag modelarmor_delete_template
modelarmor/get_template.go:19, tag modelarmor_get_template

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

telpirion · 2025-04-11T17:43:14Z

modelarmor/testdata/env/test.env

Remove this file.

telpirion

There are several global issues in these samples that must be addressed.

telpirion · 2025-04-11T17:46:12Z

modelarmor/create_template.go

+//	locationID string: The ID of the Google Cloud location.
+//	templateID string: The ID of the template to create.
+//
+// Returns:


issue: remove the returns and example blocks. The description and arguments are sufficient.

Here and below.

telpirion · 2025-04-11T17:46:59Z

modelarmor/create_template.go

+//	    log.Fatal(err)
+//	}
+//	fmt.Println(template)
+func createModelArmorTemplate(w io.Writer, projectID, location, templateID string) (*modelarmorpb.Template, error) {


issue: do not return anything besides an error object from samples.

See: https://googlecloudplatform.github.io/samples-style-guide/#result

Here and below.

telpirion · 2025-04-11T17:48:11Z

modelarmor/create_template.go

+		option.WithEndpoint(fmt.Sprintf("modelarmor.%s.rep.googleapis.com:443", location)),
+	)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create client for project %s, location %s: %v", projectID, location, err)


issue: use the %w format verb instead of %v.

Here and below.

telpirion · 2025-04-11T17:49:07Z

modelarmor/create_template.go

+	// Print the new template name using fmt.Fprintf with the io.Writer.
+	fmt.Fprintf(w, "Created template: %s\n", response.Name)
+
+	// [END modelarmor_create_template]


issue: move the ending region tag after the closing curly brace for the sample (after line 105).

Here and below.

telpirion · 2025-04-11T17:52:26Z

modelarmor/create_template.go

+
+	// Create the Model Armor client.
+	client, err := modelarmor.NewClient(ctx,
+		option.WithEndpoint(fmt.Sprintf("modelarmor.%s.rep.googleapis.com:443", location)),


issue: instantiate the CallOptions object outside of the NewClient() call.

Suggestion:

opts := option.WithEndpoint( /* etc */ ) client, err := modelarmor.NewClient(ctx, opts) // etc

Here and below.

telpirion · 2025-04-11T18:00:17Z

Here are the global issues that need to be resolved in this PR (and the other Model Armor PRs).

Cut the "Returns" and "Example" blocks in the Godoc.
Return only an error from the samples.
Instantiate the CallOption object outside of the call to NewClient().
Use the %w formatting verb in calls to fmt.Errorf().
Ensure that END region tags are outside of the final curly brace for the sample.
Do not provide a testenv file with environment variables

tirthrajsinh-zala-crest added 7 commits April 8, 2025 15:17

feat(modelarmor): Added samples for creating, listing, updating and d…

d0b6026

…eleting model armor templates

feat(modelarmor): Added samples for creating, listing, updating and d…

78110c9

…eleting modelarmor templates

Merge branch 'main' into modelarmor-curd-snippets

a7b4cff

feat(modelarmor): resolve review comments

4095b9a

Merge branch 'main' into modelarmor-curd-snippets

caf8c7e

Merge branch 'main' into modelarmor-curd-snippets

1e5a58d

feat(modelarmor): added samples for to create ma template with labels…

cb7c703

… and metadata

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

gemini-code-assist bot reviewed Apr 11, 2025

View reviewed changes

Merge branch 'main' into modelarmor-create-template-with-labels-metadata

2f95b55

gemini-code-assist bot reviewed Apr 11, 2025

View reviewed changes

tirthrajsinh-zala-crest mentioned this pull request Apr 11, 2025

feat(modelarmor): Added samples for creating, listing, updating and deleting modelarmor templates #5265

Closed

9 tasks

tirthrajsinh-zala-crest marked this pull request as ready for review April 11, 2025 13:23

tirthrajsinh-zala-crest requested review from a team as code owners April 11, 2025 13:23

telpirion requested changes Apr 11, 2025

View reviewed changes

modelarmor/testdata/env/test.env

Copy link

Collaborator

telpirion Apr 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this file.

telpirion self-assigned this Apr 11, 2025

telpirion requested changes Apr 11, 2025

View reviewed changes

telpirion mentioned this pull request Apr 11, 2025

feat(modelarmor): modelarmor create and delete code snippets #5271

Draft

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(modelarmor): Added snippets for create template with labels and metadata #5273

feat(modelarmor): Added snippets for create template with labels and metadata #5273

tirthrajsinh-zala-crest commented Apr 11, 2025 •

edited

Loading

gemini-code-assist bot left a comment

gemini-code-assist bot left a comment

snippet-bot bot commented Apr 11, 2025

telpirion Apr 11, 2025

telpirion left a comment

telpirion Apr 11, 2025

telpirion Apr 11, 2025

telpirion Apr 11, 2025

telpirion Apr 11, 2025

telpirion Apr 11, 2025

telpirion Apr 11, 2025

telpirion Apr 11, 2025

telpirion Apr 11, 2025

telpirion Apr 11, 2025

telpirion Apr 11, 2025

telpirion commented Apr 11, 2025

feat(modelarmor): Added snippets for create template with labels and metadata #5273

Are you sure you want to change the base?

feat(modelarmor): Added snippets for create template with labels and metadata #5273

Conversation

tirthrajsinh-zala-crest commented Apr 11, 2025 • edited Loading

Description

Checklist

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Changelog

Footnotes

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Merge Readiness

snippet-bot bot commented Apr 11, 2025

Choose a reason for hiding this comment

telpirion left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

telpirion commented Apr 11, 2025

tirthrajsinh-zala-crest commented Apr 11, 2025 •

edited

Loading