|
| 1 | +// Copyright 2025 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +'use strict'; |
| 16 | + |
| 17 | +/** |
| 18 | + * Creates a new model armor template with advanced SDP settings enabled. |
| 19 | + * |
| 20 | + * @param {string} projectId - Google Cloud project ID where the template will be created. |
| 21 | + * @param {string} locationId - Google Cloud location where the template will be created. |
| 22 | + * @param {string} templateId - ID for the template to create. |
| 23 | + * @param {string} inspectTemplate - Optional. Sensitive Data Protection inspect template resource name. |
| 24 | + If only inspect template is provided (de-identify template |
| 25 | + not provided), then Sensitive Data Protection InspectContent |
| 26 | + action is performed during Sanitization. All Sensitive Data |
| 27 | + Protection findings identified during inspection will be |
| 28 | + returned as SdpFinding in SdpInsepctionResult e.g. |
| 29 | + `organizations/{organization}/inspectTemplates/{inspect_template}`, |
| 30 | + `projects/{project}/inspectTemplates/{inspect_template}` |
| 31 | + `organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}` |
| 32 | + `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` |
| 33 | + * @param {string} deidentifyTemplate - Optional. Optional Sensitive Data Protection Deidentify template resource name. |
| 34 | + If provided then DeidentifyContent action is performed |
| 35 | + during Sanitization using this template and inspect |
| 36 | + template. The De-identified data will be returned in |
| 37 | + SdpDeidentifyResult. Note that all info-types present in the |
| 38 | + deidentify template must be present in inspect template. |
| 39 | + e.g. |
| 40 | + `organizations/{organization}/deidentifyTemplates/{deidentify_template}`, |
| 41 | + `projects/{project}/deidentifyTemplates/{deidentify_template}` |
| 42 | + `organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}` |
| 43 | + `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}` |
| 44 | + */ |
| 45 | +async function main( |
| 46 | + projectId, |
| 47 | + locationId, |
| 48 | + templateId, |
| 49 | + inspectTemplate, |
| 50 | + deidentifyTemplate |
| 51 | +) { |
| 52 | + // [START modelarmor_create_template_with_advanced_sdp] |
| 53 | + /** |
| 54 | + * TODO(developer): Uncomment these variables before running the sample. |
| 55 | + */ |
| 56 | + // const projectId = 'your-project-id'; |
| 57 | + // const locationId = 'us-central1'; |
| 58 | + // const templateId = 'template-id'; |
| 59 | + // const inspectTemplate = `projects/${projectId}/locations/${locationId}/inspectTemplates/inspect-template-id`; |
| 60 | + // const deidentifyTemplate = `projects/${projectId}/locations/${locationId}/deidentifyTemplates/deidentify-template-id`; |
| 61 | + |
| 62 | + const parent = `projects/${projectId}/locations/${locationId}`; |
| 63 | + |
| 64 | + // Imports the Model Armor library |
| 65 | + const modelarmor = require('@google-cloud/modelarmor'); |
| 66 | + const {ModelArmorClient} = modelarmor.v1; |
| 67 | + const {protos} = modelarmor; |
| 68 | + |
| 69 | + const RaiFilterType = protos.google.cloud.modelarmor.v1.RaiFilterType; |
| 70 | + const DetectionConfidenceLevel = |
| 71 | + protos.google.cloud.modelarmor.v1.DetectionConfidenceLevel; |
| 72 | + |
| 73 | + // Instantiates a client |
| 74 | + const client = new ModelArmorClient({ |
| 75 | + apiEndpoint: `modelarmor.${locationId}.rep.googleapis.com`, |
| 76 | + }); |
| 77 | + |
| 78 | + async function createTemplateWithAdvancedSdp() { |
| 79 | + // Configuration for the template with advanced SDP settings |
| 80 | + const templateConfig = { |
| 81 | + filterConfig: { |
| 82 | + raiSettings: { |
| 83 | + raiFilters: [ |
| 84 | + { |
| 85 | + filterType: RaiFilterType.DANGEROUS, |
| 86 | + confidenceLevel: DetectionConfidenceLevel.HIGH, |
| 87 | + }, |
| 88 | + { |
| 89 | + filterType: RaiFilterType.HARASSMENT, |
| 90 | + confidenceLevel: DetectionConfidenceLevel.MEDIUM_AND_ABOVE, |
| 91 | + }, |
| 92 | + { |
| 93 | + filterType: RaiFilterType.HATE_SPEECH, |
| 94 | + confidenceLevel: DetectionConfidenceLevel.HIGH, |
| 95 | + }, |
| 96 | + { |
| 97 | + filterType: RaiFilterType.SEXUALLY_EXPLICIT, |
| 98 | + confidenceLevel: DetectionConfidenceLevel.HIGH, |
| 99 | + }, |
| 100 | + ], |
| 101 | + }, |
| 102 | + sdpSettings: { |
| 103 | + advancedConfig: { |
| 104 | + inspectTemplate: inspectTemplate, |
| 105 | + deidentifyTemplate: deidentifyTemplate, |
| 106 | + }, |
| 107 | + }, |
| 108 | + }, |
| 109 | + }; |
| 110 | + |
| 111 | + // Construct request |
| 112 | + const request = { |
| 113 | + parent, |
| 114 | + templateId, |
| 115 | + template: templateConfig, |
| 116 | + }; |
| 117 | + |
| 118 | + // Create the template |
| 119 | + const [response] = await client.createTemplate(request); |
| 120 | + console.log(`Created template: ${response.name}`); |
| 121 | + } |
| 122 | + |
| 123 | + createTemplateWithAdvancedSdp(); |
| 124 | + // [END modelarmor_create_template_with_advanced_sdp] |
| 125 | +} |
| 126 | + |
| 127 | +// Check if this script is being run directly |
| 128 | +const args = process.argv.slice(2); |
| 129 | +main(...args).catch(console.error); |
0 commit comments