samples: create custom highlights (#82)

contact-center-insights/snippets/src/main/java/com/example/contactcenterinsights/CreatePhraseMatcherAllOf.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2021 Google Inc.
+ *
+ * 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 com.example.contactcenterinsights;
+
+// [START contactcenterinsights_create_phrase_matcher_all_of]
+
+import com.google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient;
+import com.google.cloud.contactcenterinsights.v1.ExactMatchConfig;
+import com.google.cloud.contactcenterinsights.v1.LocationName;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatchRule;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatchRuleConfig;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroup;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatcher;
+import java.io.IOException;
+
+public class CreatePhraseMatcherAllOf {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace this variable before running the sample.
+    String projectId = "my_project_id";
+
+    createPhraseMatcherAllOf(projectId);
+  }
+
+  public static PhraseMatcher createPhraseMatcherAllOf(String projectId) throws IOException {
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests. After completing all of your requests, call
+    // the "close" method on the client to safely clean up any remaining background resources.
+    try (ContactCenterInsightsClient client = ContactCenterInsightsClient.create()) {
+      // Construct a phrase matcher that matches all of its rule groups.
+      PhraseMatcher.Builder phraseMatcher =
+          PhraseMatcher.newBuilder()
+              .setDisplayName("NON_SHIPPING_PHONE_SERVICE")
+              .setTypeValue(1)
+              .setActive(true);
+
+      // Construct a rule group to match the word "PHONE" or "CELLPHONE", ignoring case sensitivity.
+      PhraseMatchRuleGroup.Builder ruleGroup1 = PhraseMatchRuleGroup.newBuilder().setTypeValue(2);
+
+      String[] words1 = {"PHONE", "CELLPHONE"};
+      for (String w : words1) {
+        PhraseMatchRule.Builder rule =
+            PhraseMatchRule.newBuilder()
+                .setQuery(w)
+                .setConfig(
+                    PhraseMatchRuleConfig.newBuilder()
+                        .setExactMatchConfig(ExactMatchConfig.newBuilder().build())
+                        .build());
+        ruleGroup1.addPhraseMatchRules(rule.build());
+      }
+      phraseMatcher.addPhraseMatchRuleGroups(ruleGroup1.build());
+
+      // Construct another rule group to not match the word "SHIPPING" or "DELIVERY",
+      // ignoring case sensitivity.
+      PhraseMatchRuleGroup.Builder ruleGroup2 = PhraseMatchRuleGroup.newBuilder().setTypeValue(1);
+
+      String[] words2 = {"SHIPPING", "DELIVERY"};
+      for (String w : words2) {
+        PhraseMatchRule.Builder rule =
+            PhraseMatchRule.newBuilder()
+                .setQuery(w)
+                .setNegated(true)
+                .setConfig(
+                    PhraseMatchRuleConfig.newBuilder()
+                        .setExactMatchConfig(ExactMatchConfig.newBuilder().build())
+                        .build());
+        ruleGroup2.addPhraseMatchRules(rule.build());
+      }
+      phraseMatcher.addPhraseMatchRuleGroups(ruleGroup2.build());
+
+      // Construct a parent resource.
+      LocationName parent = LocationName.of(projectId, "us-central1");
+
+      // Call the Insights client to create a phrase matcher.
+      PhraseMatcher response = client.createPhraseMatcher(parent, phraseMatcher.build());
+      System.out.printf("Created %s%n", response.getName());
+      return response;
+    }
+  }
+}
+
+// [END contactcenterinsights_create_phrase_matcher_all_of]

contact-center-insights/snippets/src/main/java/com/example/contactcenterinsights/CreatePhraseMatcherAnyOf.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2021 Google Inc.
+ *
+ * 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 com.example.contactcenterinsights;
+
+// [START contactcenterinsights_create_phrase_matcher_any_of]
+
+import com.google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient;
+import com.google.cloud.contactcenterinsights.v1.ExactMatchConfig;
+import com.google.cloud.contactcenterinsights.v1.LocationName;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatchRule;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatchRuleConfig;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatchRuleGroup;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatcher;
+import java.io.IOException;
+
+public class CreatePhraseMatcherAnyOf {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace this variable before running the sample.
+    String projectId = "my_project_id";
+
+    createPhraseMatcherAnyOf(projectId);
+  }
+
+  public static PhraseMatcher createPhraseMatcherAnyOf(String projectId) throws IOException {
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests. After completing all of your requests, call
+    // the "close" method on the client to safely clean up any remaining background resources.
+    try (ContactCenterInsightsClient client = ContactCenterInsightsClient.create()) {
+      // Construct a phrase matcher that matches any of its rule groups.
+      PhraseMatcher.Builder phraseMatcher =
+          PhraseMatcher.newBuilder()
+              .setDisplayName("PHONE_SERVICE")
+              .setTypeValue(2)
+              .setActive(true);
+
+      // Construct a rule group to match the word "PHONE" or "CELLPHONE", ignoring case sensitivity.
+      PhraseMatchRuleGroup.Builder ruleGroup = PhraseMatchRuleGroup.newBuilder().setTypeValue(2);
+
+      String[] words = {"PHONE", "CELLPHONE"};
+      for (String w : words) {
+        PhraseMatchRule.Builder rule =
+            PhraseMatchRule.newBuilder()
+                .setQuery(w)
+                .setConfig(
+                    PhraseMatchRuleConfig.newBuilder()
+                        .setExactMatchConfig(ExactMatchConfig.newBuilder().build())
+                        .build());
+        ruleGroup.addPhraseMatchRules(rule.build());
+      }
+      phraseMatcher.addPhraseMatchRuleGroups(ruleGroup.build());
+
+      // Construct a parent resource.
+      LocationName parent = LocationName.of(projectId, "us-central1");
+
+      // Call the Insights client to create a phrase matcher.
+      PhraseMatcher response = client.createPhraseMatcher(parent, phraseMatcher.build());
+      System.out.printf("Created %s%n", response.getName());
+      return response;
+    }
+  }
+}
+
+// [END contactcenterinsights_create_phrase_matcher_any_of]

contact-center-insights/snippets/src/test/java/com/example/contactcenterinsights/CreatePhraseMatcherAllOfIT.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2021 Google Inc.
+ *
+ * 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 com.example.contactcenterinsights;
+
+import static com.google.common.truth.Truth.assertThat;
+import static junit.framework.TestCase.assertNotNull;
+
+import com.google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatcher;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.PrintStream;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class CreatePhraseMatcherAllOfIT {
+
+  private static final String PROJECT_ID = System.getenv("GOOGLE_CLOUD_PROJECT");
+  private ByteArrayOutputStream bout;
+  private PrintStream out;
+  private String phraseMatcherName;
+
+  private static void requireEnvVar(String varName) {
+    assertNotNull(String.format(varName), String.format(varName));
+  }
+
+  @BeforeClass
+  public static void checkRequirements() {
+    requireEnvVar("GOOGLE_APPLICATION_CREDENTIALS");
+    requireEnvVar("GOOGLE_CLOUD_PROJECT");
+  }
+
+  @Before
+  public void setUp() {
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    System.setOut(out);
+  }
+
+  @After
+  public void tearDown() throws IOException {
+    try (ContactCenterInsightsClient client = ContactCenterInsightsClient.create()) {
+      client.deletePhraseMatcher(phraseMatcherName);
+    }
+    System.setOut(null);
+  }
+
+  @Test
+  public void testCreatePhraseMatcherAllOf() throws IOException {
+    PhraseMatcher phraseMatcher = CreatePhraseMatcherAllOf.createPhraseMatcherAllOf(PROJECT_ID);
+    phraseMatcherName = phraseMatcher.getName();
+    assertThat(bout.toString()).contains(phraseMatcherName);
+  }
+}

contact-center-insights/snippets/src/test/java/com/example/contactcenterinsights/CreatePhraseMatcherAnyOfIT.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2021 Google Inc.
+ *
+ * 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 com.example.contactcenterinsights;
+
+import static com.google.common.truth.Truth.assertThat;
+import static junit.framework.TestCase.assertNotNull;
+
+import com.google.cloud.contactcenterinsights.v1.ContactCenterInsightsClient;
+import com.google.cloud.contactcenterinsights.v1.PhraseMatcher;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.PrintStream;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+@RunWith(JUnit4.class)
+public class CreatePhraseMatcherAnyOfIT {
+
+  private static final String PROJECT_ID = System.getenv("GOOGLE_CLOUD_PROJECT");
+  private ByteArrayOutputStream bout;
+  private PrintStream out;
+  private String phraseMatcherName;
+
+  private static void requireEnvVar(String varName) {
+    assertNotNull(String.format(varName), String.format(varName));
+  }
+
+  @BeforeClass
+  public static void checkRequirements() {
+    requireEnvVar("GOOGLE_APPLICATION_CREDENTIALS");
+    requireEnvVar("GOOGLE_CLOUD_PROJECT");
+  }
+
+  @Before
+  public void setUp() {
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    System.setOut(out);
+  }
+
+  @After
+  public void tearDown() throws IOException {
+    try (ContactCenterInsightsClient client = ContactCenterInsightsClient.create()) {
+      client.deletePhraseMatcher(phraseMatcherName);
+    }
+    System.setOut(null);
+  }
+
+  @Test
+  public void testCreatePhraseMatcherAnyOf() throws IOException {
+    PhraseMatcher phraseMatcher = CreatePhraseMatcherAnyOf.createPhraseMatcherAnyOf(PROJECT_ID);
+    phraseMatcherName = phraseMatcher.getName();
+    assertThat(bout.toString()).contains(phraseMatcherName);
+  }
+}