feat(modelarmor): Added code samples for screening user prompt, model response and a PDF file

modelarmor/pom.xml

@@ -0,0 +1,84 @@
+<!--
+ 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
+
+       http://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.
+-->
+
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.example.modelarmor</groupId>
+    <artifactId>modelarmor-samples</artifactId>
+    <packaging>jar</packaging>
+
+    <!--
+      The parent pom defines common style checks and testing strategies for our samples.
+      Removing or replacing it should not affect the execution of the samples in anyway.
+    -->
+    <parent>
+        <groupId>com.google.cloud.samples</groupId>
+        <artifactId>shared-configuration</artifactId>
+        <version>1.2.0</version>
+    </parent>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.target>11</maven.compiler.target>
+        <maven.compiler.source>11</maven.compiler.source>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>com.google.cloud</groupId>
+                <artifactId>libraries-bom</artifactId>
+                <version>26.59.0</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.google.cloud</groupId>
+            <artifactId>google-cloud-modelarmor</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.google.cloud</groupId>
+            <artifactId>google-cloud-dlp</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.google.protobuf</groupId>
+            <artifactId>protobuf-java-util</artifactId>
+        </dependency>
+
+        <!-- test dependencies -->
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.13.2</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.google.truth</groupId>
+            <artifactId>truth</artifactId>
+            <version>1.4.0</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+</project>

modelarmor/src/main/java/modelarmor/CreateTemplate.java

@@ -0,0 +1,110 @@
+/*
+ * 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
+ *
+ * http://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.
+*/
+
+package modelarmor;
+
+// [START modelarmor_create_template]
+
+import com.google.cloud.modelarmor.v1.CreateTemplateRequest;
+import com.google.cloud.modelarmor.v1.DetectionConfidenceLevel;
+import com.google.cloud.modelarmor.v1.FilterConfig;
+import com.google.cloud.modelarmor.v1.LocationName;
+import com.google.cloud.modelarmor.v1.ModelArmorClient;
+import com.google.cloud.modelarmor.v1.ModelArmorSettings;
+import com.google.cloud.modelarmor.v1.RaiFilterSettings;
+import com.google.cloud.modelarmor.v1.RaiFilterSettings.RaiFilter;
+import com.google.cloud.modelarmor.v1.RaiFilterType;
+import com.google.cloud.modelarmor.v1.Template;
+import java.io.IOException;
+import java.util.List;
+
+public class CreateTemplate {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+
+    // Specify the Google Project ID.
+    String projectId = "your-project-id";
+    // Specify the location ID. For example, us-central1. 
+    String locationId = "your-location-id";
+    // Specify the template ID.
+    String templateId = "your-template-id";
+
+    createTemplate(projectId, locationId, templateId);
+  }
+
+  public static Template createTemplate(String projectId, String locationId, String templateId)
+      throws IOException {
+    // Construct the API endpoint URL.
+    String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+    ModelArmorSettings modelArmorSettings = ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint)
+        .build();
+
+    // Initialize the client that will be used to send requests. This client
+    // only needs to be created once, and can be reused for multiple requests.
+    try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      String parent = LocationName.of(projectId, locationId).toString();
+
+      // 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
+
+      // Configure Responsible AI filter with multiple categories and their confidence
+      // levels.
+      RaiFilterSettings raiFilterSettings =
+          RaiFilterSettings.newBuilder()
+              .addAllRaiFilters(
+                  List.of(
+                      RaiFilter.newBuilder()
+                          .setFilterType(RaiFilterType.DANGEROUS)
+                          .setConfidenceLevel(DetectionConfidenceLevel.HIGH)
+                          .build(),
+                      RaiFilter.newBuilder()
+                          .setFilterType(RaiFilterType.HATE_SPEECH)
+                          .setConfidenceLevel(DetectionConfidenceLevel.HIGH)
+                          .build(),
+                      RaiFilter.newBuilder()
+                          .setFilterType(RaiFilterType.SEXUALLY_EXPLICIT)
+                          .setConfidenceLevel(DetectionConfidenceLevel.LOW_AND_ABOVE)
+                          .build(),
+                      RaiFilter.newBuilder()
+                          .setFilterType(RaiFilterType.HARASSMENT)
+                          .setConfidenceLevel(DetectionConfidenceLevel.MEDIUM_AND_ABOVE)
+                          .build()))
+              .build();
+
+      FilterConfig modelArmorFilter = FilterConfig.newBuilder()
+          .setRaiSettings(raiFilterSettings)
+          .build();
+
+      Template template = Template.newBuilder()
+          .setFilterConfig(modelArmorFilter)
+          .build();
+
+      CreateTemplateRequest request = CreateTemplateRequest.newBuilder()
+          .setParent(parent)
+          .setTemplateId(templateId)
+          .setTemplate(template)
+          .build();
+
+      Template createdTemplate = client.createTemplate(request);
+      System.out.println("Created template: " + createdTemplate.getName());
+
+      return createdTemplate;
+    }
+  }
+}
+// [END modelarmor_create_template]

modelarmor/src/main/java/modelarmor/SanitizeModelResponse.java

@@ -0,0 +1,76 @@
+/*
+ * 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
+ *
+ * http://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.
+*/
+
+package modelarmor;
+
+// [START modelarmor_sanitize_model_response]
+
+import com.google.cloud.modelarmor.v1.DataItem;
+import com.google.cloud.modelarmor.v1.ModelArmorClient;
+import com.google.cloud.modelarmor.v1.ModelArmorSettings;
+import com.google.cloud.modelarmor.v1.SanitizeModelResponseRequest;
+import com.google.cloud.modelarmor.v1.SanitizeModelResponseResponse;
+import com.google.cloud.modelarmor.v1.TemplateName;
+import com.google.protobuf.util.JsonFormat;
+import java.io.IOException;
+
+public class SanitizeModelResponse {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+
+    // Specify the Google Project ID.
+    String projectId = "your-project-id";
+    // Specify the location ID. For example, us-central1. 
+    String locationId = "your-location-id";
+    // Specify the template ID.
+    String templateId = "your-template-id";
+    // Specify the model response.
+    String modelResponse = "Unsanitized model output";
+
+    sanitizeModelResponse(projectId, locationId, templateId, modelResponse);
+  }
+
+  public static SanitizeModelResponseResponse sanitizeModelResponse(String projectId,
+      String locationId, String templateId, String modelResponse) throws IOException {
+
+    // Endpoint to call the Model Armor server.
+    String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+    ModelArmorSettings modelArmorSettings = ModelArmorSettings.newBuilder().setEndpoint(apiEndpoint)
+        .build();
+
+    try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      // Build the resource name of the template.
+      String name = TemplateName.of(projectId, locationId, templateId).toString();
+
+      // Prepare the request.
+      SanitizeModelResponseRequest request = 
+          SanitizeModelResponseRequest.newBuilder()
+            .setName(name)
+            .setModelResponseData(
+              DataItem.newBuilder().setText(modelResponse)
+              .build())
+            .build();
+
+      SanitizeModelResponseResponse response = client.sanitizeModelResponse(request);
+      System.out.println("Result for the provided model response: "
+          + JsonFormat.printer().print(response.getSanitizationResult()));
+
+      return response;
+    }
+  }
+}
+// [END modelarmor_sanitize_model_response]

modelarmor/src/main/java/modelarmor/SanitizeUserPrompt.java

@@ -0,0 +1,74 @@
+/*
+ * 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
+ *
+ * http://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.
+*/
+
+package modelarmor;
+
+// [START modelarmor_sanitize_user_prompt]
+
+import com.google.cloud.modelarmor.v1.DataItem;
+import com.google.cloud.modelarmor.v1.ModelArmorClient;
+import com.google.cloud.modelarmor.v1.ModelArmorSettings;
+import com.google.cloud.modelarmor.v1.SanitizeUserPromptRequest;
+import com.google.cloud.modelarmor.v1.SanitizeUserPromptResponse;
+import com.google.cloud.modelarmor.v1.TemplateName;
+import com.google.protobuf.util.JsonFormat;
+import java.io.IOException;
+
+public class SanitizeUserPrompt {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+
+    // Specify the Google Project ID.
+    String projectId = "your-project-id";
+    // Specify the location ID. For example, us-central1.
+    String locationId = "your-location-id";
+    // Specify the template ID.
+    String templateId = "your-template-id";
+    // Specify the user prompt.
+    String userPrompt = "Unsafe user prompt";
+
+    sanitizeUserPrompt(projectId, locationId, templateId, userPrompt);
+  }
+
+  public static SanitizeUserPromptResponse sanitizeUserPrompt(String projectId, String locationId,
+      String templateId, String userPrompt) throws IOException {
+
+    // Endpoint to call the Model Armor server.
+    String apiEndpoint = String.format("modelarmor.%s.rep.googleapis.com:443", locationId);
+    ModelArmorSettings modelArmorSettings = ModelArmorSettings.newBuilder()
+        .setEndpoint(apiEndpoint)
+        .build();
+
+    try (ModelArmorClient client = ModelArmorClient.create(modelArmorSettings)) {
+      // Build the resource name of the template.
+      String templateName = TemplateName.of(projectId, locationId, templateId).toString();
+
+      // Prepare the request.
+      SanitizeUserPromptRequest request = SanitizeUserPromptRequest.newBuilder()
+          .setName(templateName)
+          .setUserPromptData(DataItem.newBuilder().setText(userPrompt).build())
+          .build();
+
+      SanitizeUserPromptResponse response = client.sanitizeUserPrompt(request);
+      System.out.println("Result for the provided user prompt: "
+          + JsonFormat.printer().print(response.getSanitizationResult()));
+
+      return response;
+    }
+  }
+}
+// [END modelarmor_sanitize_user_prompt]