Adding initial Playbook support for Dialogflow CX (#14446) (#1083)

[upstream:5556dbed76a17ce82cf6bb0fb1682240daaf116c]

Signed-off-by: Modular Magician <[email protected]>

Author: modular-magician

dialogflowcx_playbook_basic/backing_file.tf

@@ -0,0 +1,15 @@
+# This file has some scaffolding to make sure that names are unique and that
+# a region and zone are selected when you try to create your Terraform resources.
+
+locals {
+  name_suffix = "${random_pet.suffix.id}"
+}
+
+resource "random_pet" "suffix" {
+  length = 2
+}
+
+provider "google" {
+  region = "us-central1"
+  zone   = "us-central1-c"
+}

dialogflowcx_playbook_basic/main.tf

@@ -0,0 +1,44 @@
+resource "google_dialogflow_cx_agent" "agent" {
+  display_name          = "dialogflowcx-agent-basic-${local.name_suffix}"
+  location              = "global"
+  default_language_code = "en"
+  time_zone             = "America/New_York"
+  description           = "Example description."
+}
+
+resource "google_dialogflow_cx_playbook" "my-playbook" {
+  parent        = google_dialogflow_cx_agent.agent.id
+  display_name  = "Example Display Name"
+  goal          = "Example Goal"
+  playbook_type = "ROUTINE"
+  instruction {
+    steps {
+      text = "step 1"
+      steps = jsonencode([
+        {
+          "text": "step 1 1"
+        },
+        {
+          "text": "step 1 2",
+          "steps": [
+            {
+              "text": "step 1 2 1"
+            },
+            {
+              "text": "step 1 2 2"
+            }
+          ]
+        },
+        {
+          "text": "step 1 3"
+        }
+      ])
+    }
+    steps {
+      text = "step 2"
+    }
+    steps {
+      text = "step 3"
+    }
+  }
+}

dialogflowcx_playbook_basic/motd

@@ -0,0 +1,7 @@
+===
+
+These examples use real resources that will be billed to the
+Google Cloud Platform project you use - so make sure that you
+run "terraform destroy" before quitting!
+
+===

dialogflowcx_playbook_basic/tutorial.md

@@ -0,0 +1,79 @@
+# Dialogflowcx Playbook Basic - Terraform
+
+## Setup
+
+<walkthrough-author name="[email protected]" analyticsId="UA-125550242-1" tutorialName="dialogflowcx_playbook_basic" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>
+
+Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.
+
+<walkthrough-project-billing-setup></walkthrough-project-billing-setup>
+
+Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.
+
+## Terraforming!
+
+Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
+to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
+the project name from the environment variable.
+
+```bash
+export GOOGLE_CLOUD_PROJECT={{project-id}}
+```
+
+After that, let's get Terraform started. Run the following to pull in the providers.
+
+```bash
+terraform init
+```
+
+With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!
+
+```bash
+terraform apply
+```
+
+Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.
+
+```bash
+yes
+```
+
+
+## Post-Apply
+
+### Editing your config
+
+Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.
+
+```bash
+terraform plan
+```
+
+So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
+run a 'plan' again.
+
+```bash
+terraform plan
+```
+
+Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
+at the 'yes' prompt.
+
+```bash
+terraform apply
+```
+
+```bash
+yes
+```
+
+## Cleanup
+
+Run the following to remove the resources Terraform provisioned:
+
+```bash
+terraform destroy
+```
+```bash
+yes
+```

dialogflowcx_playbook_fulfillment/backing_file.tf

@@ -0,0 +1,15 @@
+# This file has some scaffolding to make sure that names are unique and that
+# a region and zone are selected when you try to create your Terraform resources.
+
+locals {
+  name_suffix = "${random_pet.suffix.id}"
+}
+
+resource "random_pet" "suffix" {
+  length = 2
+}
+
+provider "google" {
+  region = "us-central1"
+  zone   = "us-central1-c"
+}

dialogflowcx_playbook_fulfillment/main.tf

@@ -0,0 +1,86 @@
+resource "google_dialogflow_cx_agent" "agent" {
+  display_name          = "dialogflowcx-agent-${local.name_suffix}"
+  location              = "global"
+  default_language_code = "en"
+  time_zone             = "America/New_York"
+  description           = "Example description."
+}
+
+resource "google_storage_bucket" "bucket" {
+  name                        = "dialogflowcx-bucket-${local.name_suffix}"
+  location                    = "US"
+  uniform_bucket_level_access = true
+}
+
+resource "google_dialogflow_cx_webhook" "my_webhook" {
+  parent       = google_dialogflow_cx_agent.agent.id
+  display_name = "MyWebhook"
+  generic_web_service {
+    uri = "https://example.com"
+  }
+}
+
+resource "google_dialogflow_cx_tool" "my_tool" {
+  parent       = google_dialogflow_cx_agent.agent.id
+  display_name = "Example Tool"
+  description  = "Example Description"
+}
+
+resource "google_dialogflow_cx_generator" "my_generator" {
+  parent = google_dialogflow_cx_agent.agent.id
+  display_name = "TF Prompt generator"
+  llm_model_settings {
+    model = "gemini-2.0-flash-001"
+    prompt_text = "Return me some great results"
+  }
+  prompt_text {
+    text = "Send me great results in french"
+  }
+  model_parameter {
+    temperature = 0.55
+  }
+}
+
+resource "google_dialogflow_cx_playbook" "my-playbook" {
+  parent       = google_dialogflow_cx_agent.agent.id
+  display_name = "Playbook Example with Fulfillment"
+  goal         = "Example Goal"
+  instruction {
+    guidelines = "Example Guidelines"
+    steps {
+      text = "step 1"
+      steps = jsonencode([
+        {
+          "text": "step 1 1"
+        },
+        {
+          "text": "step 1 2",
+          "steps": [
+            {
+              "text": "step 1 2 1"
+            },
+            {
+              "text": "step 1 2 2"
+            }
+          ]
+        },
+        {
+          "text": "step 1 3"
+        }
+      ])
+    }
+    steps {
+      text = "step 2"
+    }
+    steps {
+      text = "step 3"
+    }
+  }
+
+  llm_model_settings {
+    model = "gemini-2.0-flash-001"
+    prompt_text = "Return me some great results"
+  }
+
+  referenced_tools = [google_dialogflow_cx_tool.my_tool.id]
+}

dialogflowcx_playbook_fulfillment/motd

@@ -0,0 +1,7 @@
+===
+
+These examples use real resources that will be billed to the
+Google Cloud Platform project you use - so make sure that you
+run "terraform destroy" before quitting!
+
+===

dialogflowcx_playbook_fulfillment/tutorial.md

@@ -0,0 +1,79 @@
+# Dialogflowcx Playbook Fulfillment - Terraform
+
+## Setup
+
+<walkthrough-author name="[email protected]" analyticsId="UA-125550242-1" tutorialName="dialogflowcx_playbook_fulfillment" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>
+
+Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.
+
+<walkthrough-project-billing-setup></walkthrough-project-billing-setup>
+
+Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.
+
+## Terraforming!
+
+Let's use {{project-id}} with Terraform! Click the Cloud Shell icon below to copy the command
+to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
+the project name from the environment variable.
+
+```bash
+export GOOGLE_CLOUD_PROJECT={{project-id}}
+```
+
+After that, let's get Terraform started. Run the following to pull in the providers.
+
+```bash
+terraform init
+```
+
+With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!
+
+```bash
+terraform apply
+```
+
+Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.
+
+```bash
+yes
+```
+
+
+## Post-Apply
+
+### Editing your config
+
+Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.
+
+```bash
+terraform plan
+```
+
+So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
+run a 'plan' again.
+
+```bash
+terraform plan
+```
+
+Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
+at the 'yes' prompt.
+
+```bash
+terraform apply
+```
+
+```bash
+yes
+```
+
+## Cleanup
+
+Run the following to remove the resources Terraform provisioned:
+
+```bash
+terraform destroy
+```
+```bash
+yes
+```