-
Notifications
You must be signed in to change notification settings - Fork 2k
feat(modelarmor): Added snippet for quickstart #4052
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
Merged
telpirion
merged 17 commits into
GoogleCloudPlatform:main
from
rudrakhsha-crest:model-armor-snippet-quickstart
May 15, 2025
Merged
Changes from 4 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
874955b
Added CRUD code snippets with codeowners file
rudrakhsha-crest 8270ed7
Solved linting errors
rudrakhsha-crest 3824b65
Added header comment
rudrakhsha-crest c78e8be
Added quickstart code snippet for model armor
rudrakhsha-crest 9a20c63
Removed crud related files
rudrakhsha-crest 2df6b5f
Updated prompts in the quickstart template along with test cases
rudrakhsha-crest 4c623bd
Removed extra functions from quickstart code snippets
rudrakhsha-crest 36329ed
Merge branch 'main' into model-armor-snippet-quickstart
rudrakhsha-crest cb43a3e
Updated according to latest design in the other PRs after addressing …
rudrakhsha-crest dd5b227
Merge branch 'model-armor-snippet-quickstart' of github.com:rudrakhsh…
rudrakhsha-crest 8c74ff5
add-new-line-copyright-fix
harshnasitcrest 49aeffb
Merge branch 'main' into model-armor-snippet-quickstart
harshnasitcrest cbd14b1
fix-lints
harshnasitcrest d66cf6f
Merge branch 'main' into model-armor-snippet-quickstart
harshnasitcrest cdb9bbd
Merge branch 'main' into model-armor-snippet-quickstart
harshnasitcrest b2764c6
Merge branch 'main' into model-armor-snippet-quickstart
telpirion b816ecd
Merge branch 'main' into model-armor-snippet-quickstart
telpirion File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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}`); | ||
} | ||
|
||
createTemplate(); | ||
rudrakhsha-crest marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// [END modelarmor_create_template] | ||
} | ||
|
||
const args = process.argv.slice(2); | ||
main(...args).catch(console.error); |
This file contains hidden or 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 | ||
// | ||
// 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. | ||
*/ | ||
rudrakhsha-crest marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// 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}`); | ||
} | ||
|
||
createTemplateWithAdvancedSdp(); | ||
rudrakhsha-crest marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// [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 hidden or 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 | ||
// | ||
// 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. | ||
*/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
// 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}`); | ||
} | ||
|
||
return createTemplateWithBasicSdp(); | ||
rudrakhsha-crest marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// [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.
Uh oh!
There was an error while loading. Please reload this page.