samples: migrate code from googleapis/java-dialogflow-cx

dialogflow-cx/pom.xml

@@ -0,0 +1,68 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.example.dialogflow-cx</groupId>
+  <artifactId>dialogflow-cx-snippets</artifactId>
+  <packaging>jar</packaging>
+  <name>Google Dialogflow CX Snippets</name>
+  <url>https://github.com/GoogleCloudPlatform/java-docs-samples/tree/main/dialogflow-cx</url>
+
+  <!--
+    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>
+    <maven.compiler.target>11</maven.compiler.target>
+    <maven.compiler.source>11</maven.compiler.source>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+  <dependencies>
+    <!-- TODO: switch to libraries-bom after this artifact is included -->
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-dialogflow-cx</artifactId>
+      <version>0.14.7</version>
+    </dependency>
+    <dependency>
+      <groupId>com.google.code.gson</groupId>
+      <artifactId>gson</artifactId>
+      <version>2.9.1</version>
+    </dependency>
+    <dependency>
+      <groupId>com.google.cloud.functions</groupId>
+      <artifactId>functions-framework-api</artifactId>
+      <version>1.0.4</version>
+    </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.13.2</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.cloud.functions</groupId>
+      <artifactId>function-maven-plugin</artifactId>
+      <version>0.10.1</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <version>4.8.0</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.google.truth</groupId>
+      <artifactId>truth</artifactId>
+      <version>1.1.3</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+</project>

dialogflow-cx/src/main/java/dialogflow/cx/ConfigureWebhookToSetFormParametersAsOptionalOrRequired.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright 2022 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 dialogflow.cx;
+
+// The following snippet is used in https://cloud.google.com/dialogflow/cx/docs/concept/webhook
+
+// [START dialogflow_cx_v3_configure_webhooks_to_set_form_parameter_as_optional_or_required]
+
+// TODO: Change class name to Example
+// TODO: Uncomment the line below before running cloud function
+// package com.example;
+
+import com.google.cloud.functions.HttpFunction;
+import com.google.cloud.functions.HttpRequest;
+import com.google.cloud.functions.HttpResponse;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonArray;
+import com.google.gson.JsonObject;
+import java.io.BufferedWriter;
+
+public class ConfigureWebhookToSetFormParametersAsOptionalOrRequired implements HttpFunction {
+  @Override
+  public void service(HttpRequest request, HttpResponse response) throws Exception {
+    JsonObject parameterObject = new JsonObject();
+    parameterObject.addProperty("display_name", "order_number");
+    parameterObject.addProperty("required", "true");
+    parameterObject.addProperty("state", "VALID");
+
+    JsonArray parameterInfoList = new JsonArray();
+    parameterInfoList.add(parameterObject);
+
+    JsonObject parameterInfoObject = new JsonObject();
+    parameterInfoObject.add("parameter_info", parameterInfoList);
+
+    JsonObject formInfo = new JsonObject();
+    formInfo.add("form_info", parameterInfoObject);
+
+    // Constructs the webhook response object
+    JsonObject webhookResponse = new JsonObject();
+    webhookResponse.add("page_info", formInfo);
+
+    Gson gson = new GsonBuilder().setPrettyPrinting().create();
+    String jsonResponseObject = gson.toJson(webhookResponse);
+
+    /* {
+     *   "page_info": {
+     *     "form_info": {
+     *       "parameter_info": [
+     *         {
+     *           "display_name": "order_number",
+     *           "required": "true",
+     *           "state": "VALID"
+     *         }
+     *       ]
+     *     }
+     *   }
+     * }
+     */
+
+    BufferedWriter writer = response.getWriter();
+
+    // Sends the responseObject
+    writer.write(jsonResponseObject.toString());
+  }
+}
+// [END dialogflow_cx_v3_configure_webhooks_to_set_form_parameter_as_optional_or_required]

dialogflow-cx/src/main/java/dialogflow/cx/CreateAgent.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2021 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 dialogflow.cx;
+
+// [START dialogflow_cx_create_agent]
+
+import com.google.cloud.dialogflow.cx.v3.Agent;
+import com.google.cloud.dialogflow.cx.v3.Agent.Builder;
+import com.google.cloud.dialogflow.cx.v3.AgentsClient;
+import com.google.cloud.dialogflow.cx.v3.AgentsSettings;
+import java.io.IOException;
+
+public class CreateAgent {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "my-project-id";
+    String displayName = "my-display-name";
+
+    createAgent(projectId, displayName);
+  }
+
+  public static Agent createAgent(String parent, String displayName) throws IOException {
+
+    String apiEndpoint = "global-dialogflow.googleapis.com:443";
+
+    AgentsSettings agentsSettings = AgentsSettings.newBuilder().setEndpoint(apiEndpoint).build();
+    // Note: close() needs to be called on the AgentsClient object to clean up resources
+    // such as threads. In the example below, try-with-resources is used,
+    // which automatically calls close().
+    try (AgentsClient client = AgentsClient.create(agentsSettings)) {
+      // Set the details of the Agent to create
+      Builder build = Agent.newBuilder();
+
+      build.setDefaultLanguageCode("en");
+      build.setDisplayName(displayName);
+      // Correct format for timezone is location/city
+      // For example America/Los_Angeles, Europe/Madrid, Asia/Tokyo
+      build.setTimeZone("America/Los_Angeles");
+
+      Agent agent = build.build();
+      String parentPath = String.format("projects/%s/locations/%s", parent, "global");
+
+      // Calls the create agent api and returns the created Agent
+      Agent response = client.createAgent(parentPath, agent);
+      System.out.println(response);
+      return response;
+    }
+  }
+}
+// [END dialogflow_cx_create_agent]

dialogflow-cx/src/main/java/dialogflow/cx/CreateFlow.java

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2020 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 dialogflow.cx;
+
+// [START dialogflow_cx_create_flow]
+
+import com.google.api.gax.rpc.ApiException;
+import com.google.cloud.dialogflow.cx.v3beta1.AgentName;
+import com.google.cloud.dialogflow.cx.v3beta1.EventHandler;
+import com.google.cloud.dialogflow.cx.v3beta1.Flow;
+import com.google.cloud.dialogflow.cx.v3beta1.FlowsClient;
+import com.google.cloud.dialogflow.cx.v3beta1.FlowsSettings;
+import com.google.cloud.dialogflow.cx.v3beta1.Fulfillment;
+import com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage;
+import com.google.cloud.dialogflow.cx.v3beta1.ResponseMessage.Text;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+public class CreateFlow {
+
+  // Create a flow in the specified agent.
+  public static Flow createFlow(
+      String displayName,
+      String projectId,
+      String locationId,
+      String agentId,
+      Map<String, String> eventsToFulfillmentMessages)
+      throws IOException, ApiException {
+    FlowsSettings.Builder flowsSettingsBuilder = FlowsSettings.newBuilder();
+    if (locationId.equals("global")) {
+      flowsSettingsBuilder.setEndpoint("dialogflow.googleapis.com:443");
+    } else {
+      flowsSettingsBuilder.setEndpoint(locationId + "-dialogflow.googleapis.com:443");
+    }
+    FlowsSettings flowsSettings = flowsSettingsBuilder.build();
+
+    // Instantiates a client.
+    // Note: close() needs to be called on the FlowsClient object to clean up resources
+    // such as threads. In the example below, try-with-resources is used,
+    // which automatically calls close().
+    try (FlowsClient flowsClient = FlowsClient.create(flowsSettings)) {
+      // Set the project agent name using the projectID (my-project-id), locationID (global), and
+      // agentID (UUID).
+      AgentName parent = AgentName.of(projectId, locationId, agentId);
+
+      // Build the EventHandlers for the flow using the mapping from events to fulfillment messages.
+      List<EventHandler> eventHandlers = new ArrayList<>();
+      for (Map.Entry<String, String> item : eventsToFulfillmentMessages.entrySet()) {
+        eventHandlers.add(
+            EventHandler.newBuilder()
+                .setEvent(item.getKey()) // Event (sys.no-match-default)
+                .setTriggerFulfillment(
+                    Fulfillment.newBuilder()
+                        // Text ("Sorry, could you say that again?")
+                        .addMessages(
+                            ResponseMessage.newBuilder()
+                                .setText(Text.newBuilder().addText(item.getValue()).build())
+                                .build())
+                        .build())
+                .build());
+      }
+
+      // Build the flow.
+      Flow flow =
+          Flow.newBuilder().setDisplayName(displayName).addAllEventHandlers(eventHandlers).build();
+
+      // Performs the create flow request.
+      Flow response = flowsClient.createFlow(parent, flow);
+
+      // TODO : Uncomment if you want to print response
+      // System.out.format("Flow created: %s\n", response.toString());
+      flowsClient.shutdown();
+      return response;
+    }
+  }
+}
+// [END dialogflow_cx_create_flow]

dialogflow-cx/src/main/java/dialogflow/cx/CreateIntent.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright 2020 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 dialogflow.cx;
+
+// [START dialogflow_cx_create_intent]
+
+import com.google.api.gax.rpc.ApiException;
+import com.google.cloud.dialogflow.cx.v3beta1.AgentName;
+import com.google.cloud.dialogflow.cx.v3beta1.Intent;
+import com.google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase;
+import com.google.cloud.dialogflow.cx.v3beta1.Intent.TrainingPhrase.Part;
+import com.google.cloud.dialogflow.cx.v3beta1.IntentsClient;
+import com.google.cloud.dialogflow.cx.v3beta1.IntentsSettings;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+public class CreateIntent {
+
+  // Create an intent of the given intent type.
+  public static Intent createIntent(
+      String displayName,
+      String projectId,
+      String locationId,
+      String agentId,
+      List<String> trainingPhrasesParts)
+      throws IOException, ApiException {
+    IntentsSettings.Builder intentsSettingsBuilder = IntentsSettings.newBuilder();
+    if (locationId.equals("global")) {
+      intentsSettingsBuilder.setEndpoint("dialogflow.googleapis.com:443");
+    } else {
+      intentsSettingsBuilder.setEndpoint(locationId + "-dialogflow.googleapis.com:443");
+    }
+    IntentsSettings intentsSettings = intentsSettingsBuilder.build();
+
+    // Instantiates a client
+    // Note: close() needs to be called on the IntentsClient object to clean up resources
+    // such as threads. In the example below, try-with-resources is used,
+    // which automatically calls close().
+    try (IntentsClient intentsClient = IntentsClient.create(intentsSettings)) {
+      // Set the project agent name using the projectID (my-project-id), locationID (global), and
+      // agentID (UUID).
+      AgentName parent = AgentName.of(projectId, locationId, agentId);
+
+      // Build the trainingPhrases from the trainingPhrasesParts.
+      List<TrainingPhrase> trainingPhrases = new ArrayList<>();
+      for (String trainingPhrase : trainingPhrasesParts) {
+        trainingPhrases.add(
+            TrainingPhrase.newBuilder()
+                .addParts(Part.newBuilder().setText(trainingPhrase).build())
+                .setRepeatCount(1)
+                .build());
+      }
+
+      // Build the intent.
+      Intent intent =
+          Intent.newBuilder()
+              .setDisplayName(displayName)
+              .addAllTrainingPhrases(trainingPhrases)
+              .build();
+
+      // Performs the create intent request.
+      Intent response = intentsClient.createIntent(parent, intent);
+
+      // TODO : Uncomment if you want to print response
+      // System.out.format("Intent created: %s\n", response);
+
+      return response;
+    }
+  }
+}
+// [END dialogflow_cx_create_intent]