feat(modelarmor): Added samples for creating, listing, updating and deleting model armor templates #4050
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| { | ||
| "name": "nodejs-model-armor-samples", | ||
| "private": true, | ||
| "license": "Apache-2.0", | ||
| "files": [ | ||
| "*.js" | ||
| ], | ||
| "author": "Google LLC", | ||
| "repository": "googleapis/nodejs-model-armor", | ||
| "engines": { | ||
| "node": ">=16.0.0" | ||
| }, | ||
| "scripts": { | ||
| "test": "c8 mocha -p -j 2 --recursive test/ --timeout=60000" | ||
| }, | ||
| "dependencies": { | ||
| "@google-cloud/modelarmor": "^0.1.0" | ||
| }, | ||
| "devDependencies": { | ||
| "c8": "^10.0.0", | ||
| "chai": "^4.5.0", | ||
| "mocha": "^10.0.0", | ||
| "uuid": "^10.0.0" | ||
| } | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| // Copyright 2025 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| 'use strict'; | ||
|
|
||
| /** | ||
| * Creates a Model Armor template with Responsible AI (RAI) filters. | ||
| * | ||
| * This function creates a template that can be used for sanitizing user prompts and model responses. | ||
| * | ||
| * @param {string} projectId - Google Cloud project ID where the template will be created. | ||
| * @param {string} locationId - Google Cloud location (region) for the template, e.g., 'us-central1'. | ||
| * @param {string} templateId - Unique identifier for the new template. | ||
| */ | ||
| async function main(projectId, locationId, templateId) { | ||
| // [START modelarmor_create_template] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const projectId = 'your-project-id'; | ||
| // const locationId = 'us-central1'; | ||
| // const templateId = 'your-template-id'; | ||
|
|
||
| const parent = `projects/${projectId}/locations/${locationId}`; | ||
|
|
||
| // Imports the Model Armor library | ||
| const modelarmor = require('@google-cloud/modelarmor'); | ||
| const {ModelArmorClient} = modelarmor.v1; | ||
| const {protos} = modelarmor; | ||
|
|
||
| // Instantiates a client | ||
| const client = new ModelArmorClient({ | ||
| apiEndpoint: `modelarmor.${locationId}.rep.googleapis.com`, | ||
| }); | ||
|
|
||
| async function createTemplate() { | ||
| /** Build the Model Armor template with your preferred filters. | ||
| For more details on filters, please refer to the following doc: | ||
| https://cloud.google.com/security-command-center/docs/key-concepts-model-armor#ma-filters | ||
| */ | ||
| const templateConfig = { | ||
| filterConfig: { | ||
| raiSettings: { | ||
| raiFilters: [ | ||
| { | ||
| filterType: | ||
| protos.google.cloud.modelarmor.v1.RaiFilterType.HATE_SPEECH, | ||
| confidenceLevel: | ||
| protos.google.cloud.modelarmor.v1.DetectionConfidenceLevel.HIGH, | ||
| }, | ||
| { | ||
| filterType: | ||
| protos.google.cloud.modelarmor.v1.RaiFilterType | ||
| .SEXUALLY_EXPLICIT, | ||
| confidenceLevel: | ||
| protos.google.cloud.modelarmor.v1.DetectionConfidenceLevel | ||
| .MEDIUM_AND_ABOVE, | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| // Construct request | ||
| const request = { | ||
| parent, | ||
| templateId, | ||
| template: templateConfig, | ||
| }; | ||
|
|
||
| // Create the template | ||
| const [response] = await client.createTemplate(request); | ||
| console.log(`Created template: ${response.name}`); | ||
|
Comment on lines
+83
to
+84
There was a problem hiding this comment. Consider adding error handling to the const [response] = await client.createTemplate(request);
console.log(`Created template: ${response.name}`);
} catch (error) {
console.error("Error creating template:", error);
}There was a problem hiding this comment. Not added error handling in snippets to maintain code consisteny across samples for different services. |
||
| } | ||
|
|
||
| createTemplate(); | ||
| // [END modelarmor_create_template] | ||
| } | ||
|
|
||
| const args = process.argv.slice(2); | ||
| main(...args).catch(console.error); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,129 @@ | ||||||
| // Copyright 2025 Google LLC | ||||||
|
There was a problem hiding this comment. The copyright year is set to 2025. Is this intentional? Should it be updated to the current year?
Suggested change
|
||||||
| // | ||||||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| // you may not use this file except in compliance with the License. | ||||||
| // You may obtain a copy of the License at | ||||||
| // | ||||||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||||||
| // | ||||||
| // Unless required by applicable law or agreed to in writing, software | ||||||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| // See the License for the specific language governing permissions and | ||||||
| // limitations under the License. | ||||||
|
|
||||||
| 'use strict'; | ||||||
|
|
||||||
| /** | ||||||
| * Creates a new model armor template with advanced SDP settings enabled. | ||||||
| * | ||||||
| * @param {string} projectId - Google Cloud project ID where the template will be created. | ||||||
| * @param {string} locationId - Google Cloud location where the template will be created. | ||||||
| * @param {string} templateId - ID for the template to create. | ||||||
| * @param {string} inspectTemplate - Optional. Sensitive Data Protection inspect template resource name. | ||||||
| If only inspect template is provided (de-identify template | ||||||
| not provided), then Sensitive Data Protection InspectContent | ||||||
| action is performed during Sanitization. All Sensitive Data | ||||||
| Protection findings identified during inspection will be | ||||||
| returned as SdpFinding in SdpInsepctionResult e.g. | ||||||
| `organizations/{organization}/inspectTemplates/{inspect_template}`, | ||||||
| `projects/{project}/inspectTemplates/{inspect_template}` | ||||||
| `organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}` | ||||||
| `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` | ||||||
| * @param {string} deidentifyTemplate - Optional. Optional Sensitive Data Protection Deidentify template resource name. | ||||||
| If provided then DeidentifyContent action is performed | ||||||
| during Sanitization using this template and inspect | ||||||
| template. The De-identified data will be returned in | ||||||
| SdpDeidentifyResult. Note that all info-types present in the | ||||||
| deidentify template must be present in inspect template. | ||||||
| e.g. | ||||||
| `organizations/{organization}/deidentifyTemplates/{deidentify_template}`, | ||||||
| `projects/{project}/deidentifyTemplates/{deidentify_template}` | ||||||
| `organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}` | ||||||
| `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}` | ||||||
| */ | ||||||
| async function main( | ||||||
| projectId, | ||||||
| locationId, | ||||||
| templateId, | ||||||
| inspectTemplate, | ||||||
| deidentifyTemplate | ||||||
| ) { | ||||||
| // [START modelarmor_create_template_with_advanced_sdp] | ||||||
| /** | ||||||
| * TODO(developer): Uncomment these variables before running the sample. | ||||||
| */ | ||||||
| // const projectId = 'your-project-id'; | ||||||
| // const locationId = 'us-central1'; | ||||||
| // const templateId = 'template-id'; | ||||||
| // const inspectTemplate = `projects/${projectId}/locations/${locationId}/inspectTemplates/inspect-template-id`; | ||||||
| // const deidentifyTemplate = `projects/${projectId}/locations/${locationId}/deidentifyTemplates/deidentify-template-id`; | ||||||
|
|
||||||
| const parent = `projects/${projectId}/locations/${locationId}`; | ||||||
|
|
||||||
| // Imports the Model Armor library | ||||||
| const modelarmor = require('@google-cloud/modelarmor'); | ||||||
| const {ModelArmorClient} = modelarmor.v1; | ||||||
| const {protos} = modelarmor; | ||||||
|
|
||||||
| const RaiFilterType = protos.google.cloud.modelarmor.v1.RaiFilterType; | ||||||
| const DetectionConfidenceLevel = | ||||||
| protos.google.cloud.modelarmor.v1.DetectionConfidenceLevel; | ||||||
|
|
||||||
| // Instantiates a client | ||||||
| const client = new ModelArmorClient({ | ||||||
| apiEndpoint: `modelarmor.${locationId}.rep.googleapis.com`, | ||||||
| }); | ||||||
|
|
||||||
| async function createTemplateWithAdvancedSdp() { | ||||||
| // Configuration for the template with advanced SDP settings | ||||||
| const templateConfig = { | ||||||
| filterConfig: { | ||||||
| raiSettings: { | ||||||
| raiFilters: [ | ||||||
| { | ||||||
| filterType: RaiFilterType.DANGEROUS, | ||||||
| confidenceLevel: DetectionConfidenceLevel.HIGH, | ||||||
| }, | ||||||
| { | ||||||
| filterType: RaiFilterType.HARASSMENT, | ||||||
| confidenceLevel: DetectionConfidenceLevel.MEDIUM_AND_ABOVE, | ||||||
| }, | ||||||
| { | ||||||
| filterType: RaiFilterType.HATE_SPEECH, | ||||||
| confidenceLevel: DetectionConfidenceLevel.HIGH, | ||||||
| }, | ||||||
| { | ||||||
| filterType: RaiFilterType.SEXUALLY_EXPLICIT, | ||||||
| confidenceLevel: DetectionConfidenceLevel.HIGH, | ||||||
| }, | ||||||
| ], | ||||||
| }, | ||||||
| sdpSettings: { | ||||||
| advancedConfig: { | ||||||
| inspectTemplate: inspectTemplate, | ||||||
| deidentifyTemplate: deidentifyTemplate, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }; | ||||||
|
|
||||||
| // Construct request | ||||||
| const request = { | ||||||
| parent, | ||||||
| templateId, | ||||||
| template: templateConfig, | ||||||
| }; | ||||||
|
|
||||||
| // Create the template | ||||||
| const [response] = await client.createTemplate(request); | ||||||
| console.log(`Created template: ${response.name}`); | ||||||
|
Comment on lines
+119
to
+120
There was a problem hiding this comment. Consider adding error handling to the const [response] = await client.createTemplate(request);
console.log(`Created template: ${response.name}`);
} catch (error) {
console.error("Error creating template:", error);
} |
||||||
| } | ||||||
|
|
||||||
| createTemplateWithAdvancedSdp(); | ||||||
| // [END modelarmor_create_template_with_advanced_sdp] | ||||||
| } | ||||||
|
|
||||||
| // Check if this script is being run directly | ||||||
| const args = process.argv.slice(2); | ||||||
| main(...args).catch(console.error); | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,99 @@ | ||||||
| // Copyright 2025 Google LLC | ||||||
|
There was a problem hiding this comment. The copyright year is set to 2025. Is this intentional? Should it be updated to the current year?
Suggested change
|
||||||
| // | ||||||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| // you may not use this file except in compliance with the License. | ||||||
| // You may obtain a copy of the License at | ||||||
| // | ||||||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||||||
| // | ||||||
| // Unless required by applicable law or agreed to in writing, software | ||||||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| // See the License for the specific language governing permissions and | ||||||
| // limitations under the License. | ||||||
|
|
||||||
| 'use strict'; | ||||||
|
|
||||||
| /** | ||||||
| * Creates a new model armor template with basic SDP settings enabled. | ||||||
| * | ||||||
| * @param {string} projectId - Google Cloud project ID where the template will be created. | ||||||
| * @param {string} locationId - Google Cloud location where the template will be created. | ||||||
| * @param {string} templateId - ID for the template to create. | ||||||
| */ | ||||||
| async function main(projectId, locationId, templateId) { | ||||||
| // [START modelarmor_create_template_with_basic_sdp] | ||||||
| /** | ||||||
| * TODO(developer): Uncomment these variables before running the sample. | ||||||
| */ | ||||||
| // const projectId = 'your-project-id'; | ||||||
| // const locationId = 'us-central1'; | ||||||
| // const templateId = 'template-id'; | ||||||
|
|
||||||
| const parent = `projects/${projectId}/locations/${locationId}`; | ||||||
|
|
||||||
| // Imports the Model Armor library | ||||||
| const modelarmor = require('@google-cloud/modelarmor'); | ||||||
| const {ModelArmorClient} = modelarmor.v1; | ||||||
| const {protos} = modelarmor; | ||||||
|
|
||||||
| const RaiFilterType = protos.google.cloud.modelarmor.v1.RaiFilterType; | ||||||
| const DetectionConfidenceLevel = | ||||||
| protos.google.cloud.modelarmor.v1.DetectionConfidenceLevel; | ||||||
| const SdpBasicConfigEnforcement = | ||||||
| protos.google.cloud.modelarmor.v1.SdpBasicConfig.SdpBasicConfigEnforcement; | ||||||
|
|
||||||
| // Instantiates a client | ||||||
| const client = new ModelArmorClient({ | ||||||
| apiEndpoint: `modelarmor.${locationId}.rep.googleapis.com`, | ||||||
| }); | ||||||
|
|
||||||
| async function createTemplateWithBasicSdp() { | ||||||
| // Configuration for the template with basic SDP settings | ||||||
| const templateConfig = { | ||||||
| filterConfig: { | ||||||
| raiSettings: { | ||||||
| raiFilters: [ | ||||||
| { | ||||||
| filterType: RaiFilterType.DANGEROUS, | ||||||
| confidenceLevel: DetectionConfidenceLevel.HIGH, | ||||||
| }, | ||||||
| { | ||||||
| filterType: RaiFilterType.HARASSMENT, | ||||||
| confidenceLevel: DetectionConfidenceLevel.MEDIUM_AND_ABOVE, | ||||||
| }, | ||||||
| { | ||||||
| filterType: RaiFilterType.HATE_SPEECH, | ||||||
| confidenceLevel: DetectionConfidenceLevel.HIGH, | ||||||
| }, | ||||||
| { | ||||||
| filterType: RaiFilterType.SEXUALLY_EXPLICIT, | ||||||
| confidenceLevel: DetectionConfidenceLevel.HIGH, | ||||||
| }, | ||||||
| ], | ||||||
| }, | ||||||
| sdpSettings: { | ||||||
| basicConfig: { | ||||||
| filterEnforcement: SdpBasicConfigEnforcement.ENABLED, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }; | ||||||
|
|
||||||
| // Construct request | ||||||
| const request = { | ||||||
| parent, | ||||||
| templateId, | ||||||
| template: templateConfig, | ||||||
| }; | ||||||
|
|
||||||
| const [response] = await client.createTemplate(request); | ||||||
| console.log(`Created template: ${response.name}`); | ||||||
|
Comment on lines
+90
to
+91
There was a problem hiding this comment. Consider adding error handling to the const [response] = await client.createTemplate(request);
console.log(`Created template: ${response.name}`);
} catch (error) {
console.error("Error creating template:", error);
} |
||||||
| } | ||||||
|
|
||||||
| return createTemplateWithBasicSdp(); | ||||||
| // [END modelarmor_create_template_with_basic_sdp] | ||||||
| } | ||||||
|
|
||||||
| const args = process.argv.slice(2); | ||||||
| main(...args).catch(console.error); | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The copyright year is set to 2025. Is this intentional? Should it be updated to the current year?
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.
not addressing these as the current year is 2025