Google APIs

1. Dialogflow's APIs & references -- the root of all things.

   1. All SDK NodeJS Client References (beautiful version)
   2. Node.js client library NodeJS reference -- wanna use in a backend with NodeJS?
      1. Dialogflow SDK Client Reference This one is more beautiful.
      2. googleapis/nodejs-dialogflow -- Github repo.
         1. Samples -- wanna run these? Step to this section.
   3. REST APIs -- wanna use GET, POST,...?

2. Service endpoint.

   

   us-dialogflow.googleapis.com and dialogflow.googleapis.com are the same, so you can use <location>-dialogflow.googleapis.com in your codes.

3. Available regions (used in locations).

   

   <region>-dialogflow.googleapis.com = endpoint.

4. google/google-api-javascript-client -- aka gapi. Github repo.

5. Google APIs Explorer. (REST)

6. Google API Node.js Client (SDK)

7. OAuth 2.0 Playground.

8. Understand roles -- If you decide to create a service account, you will need to assign a role to some users/emails. Each role has different rights to use your data.

1. Create a folder, eg. /home/thi/df-samples/

2. If you come from Dialogflow Console > choose an agent > click on the gear next to the its name > Click on "Project ID" to open Google Cloud Platform Console.

3. If you come from GCP Console, it's the same.

4. Follow these steps to generate a JSON key (you'll download a JSON file). Store your JSON file in df-samples/credential.json. Note down the project_id, we will use it later, eg. project_abc.

5. Run each time you wanna test export GOOGLE_APPLICATION_CREDENTIALS="/home/thi/df-samples/credential.json" OR save this line to /home/thi/.bashrc or /home/thi/.zshrc (if you use ZSH) and then refresh the current terminal (with this method, you don't need to run again previous line).

   

   Alternative: You don't have to use system variable GOOGLE_APPLICATION_CREDENTIALS if you don't want. In credential.json, copy private_key and client_email and then use them as,

   const client = new AgentsClient({
       credentials: { private_key, client_email }
   });

6. Go to /df-samples/ and run npm i @google-cloud/dialogflow.

7. Try this quickstart.js.

8. On terminal, run

   node quickstart.js project_abc

9. Read carefully the content of each file in samples, you have to put the corresponding inputs for the sample to work!

In case you wanna try something outside the files given in samples. Check this SDK. Suppose we wanna try this one -- AgentsClient.searchAgents()

1. Make the same things in "Step by step". At step 7, create search-agents.js with the same content as samples/set-agent.js. We are going to change this file.
2. Read the reference, change the input. Here is an example,

The example in "Try something outside..." gives us an example of using different regions. Below are some remarks:

1. On DF console, you can create some agents in a different regions, default is global (or us).

2. On the Google's documentations, they don't mention about the usage of location. If they say parent = "projects/-", we shoud use parent = "projects/-" + "/locations/" + location where location can be one of "Region ID".

3. Change also the endpoint, option apiEndpoint in AgentsClient's constructor, for example.

   const client = new AgentsClient({
       apiEndpoint: location + "-dialogflow.googleapis.com",
   });

1. For setting up, follow these steps.
2. After that, you should obtain an API_KEY and an CLIENT_ID.
3. First, try this sample.
4. Using something like Live Server and open authSample.html.
5. Make a test.

• Make sure you create the "OAuth consent screen" before you create "OAuth 2.0 Client IDs". The "consent screen" is the popup window that contains all the information about the scopes your app will ask users for permission.
• Make sure you add http://localhost:5500 (which is created in step 4) to "Authorized JavaScript origins" and "Authorized redirect URIs". You may have to wait a few "ten minutes" for everything to work. Without this step, you may encounter the error mismatch_uri.

projects.agent.search

• GET https://{endpoint}/v2/{parent=projects/*}/agent:search
• REST: .../v2/projects.agent/search
• SDK: .../v2.AgentsClient.html#searchAgents

projects.agent.sessions.detectIntent

• POST https://{endpoint}/v2/{session=projects/*/locations/*/agent/sessions/*}:detectIntent
• REST: .../v2/projects.agent.sessions/detectIntent
• SDK: .../v2.SessionsClient.html#detectIntent

• Create a collection and add the Authorization for this collection. All of its request will use the same auth method.
• Create variables (on tab "Variables") to store "CLIENT ID" (client_id) and "CLIENT SECRET" (as client_secret), then use them in the form by {{client_id}} and {{client_secret}}.

• Create a new project: Project Creator (Note: Owner doesn't have this role)
• Delete a project: Project Deleter (Note: Owner doesn't have this role)
• Create a new folder: Folder Creator (Note: Organization Administrator doesn't have this role, just list the folders and others)
• List all projects / folders: Organization Administrator
• All Dialogflow tasks: Dialogflow API Admin (it has dialogflow.*)
• Enable/Disable/List services in a project: Service Usage Admin

1. You have to have a domain and full access to DNS.

2. Try 1 month free Google Workspace (from this, you will have an organization in GCP). 💡 TIP: After 1 month, you deactivate the subsription but the things on GCP witll work!

3. (You may need to activate again the subscription on GCP with a free 300$). Don't worry, just a test, you lose nothing from this amount.

4. Go to IAM, choose your organization > ADD > paste the admin email of your organization + set roles for it (Organization Administrator, Owner, Folder Creator). Without this step, you cannot create any folder/project.

5. Go to Cloud Resource Manager > Create a new folder inside your organization.

6. Go to APIs & Services / Credentials > Choose a project > Create Credentials > Service Account > Filling the information > Create and continue > Done. Don't forget to copy the email of this service account > Click on the link of that SA > Keys > Add key > Create a new key > JSON > Download a JSON file to your computer.

7. Go to IAM again, this time, choose the fodler / organization you want above service account have the right to manage things > Add > Paste the email of the SA you created above > Set roles to it like Owner, Organization Administrator, Dialogflow API Admin, Project Creator, Project Deleter, Service Usage Admin (you can check the list of all roles here). You can even create your own custom roles.

8. In order to created SA can use Resource Manager API, you have to activate it, otherwise, there will be an error like,

   7 PERMISSION_DENIED: Cloud Resource Manager API has not been used in project 1023630190150 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/cloudresourcemanager.googleapis.com/overview?project=1023630190150 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.

   You either use the link given in the error or using,

   node -r dotenv/config service-usage/enableService.js 1023630190150 cloudresourcemanager.googleapis.com

   to activate the api.

9. One more thing, if you are going to use this SA to manage other APIs on other projects to which it's not belongs, you have to enable that service on the project it belongs to first. (For example, you created this SA on project-A and then you wanna use it to enable some Dialogflow APIs on project-B. You have to enable Dialogflow service on project-A first!)

10. Now, your SA has the full access you want.

11. On your computer, create a file .env withe the keys like in env.example.txt.

12. You're good!

{
  "displayName": "testing system with examples",
  "priority": 500000,
  "trainingPhrases": [
    {
      "type": "EXAMPLE",
      "parts": [
        {
          "text": "I want to go "
        },
        {
          "text": "there",
          "entityType": "@sys.color",
          "alias": "color",
          "userDefined": true
        },
        {
          "text": " this thursday"
        }
      ]
    },
    {
      "type": "EXAMPLE",
      "parts": [
        {
          "text": "toi tên là "
        },
        {
          "text": "đinh anh thi",
          "entityType": "@thi",
          "alias": "thi",
          "userDefined": true
        }
      ]
    },
    {
      "type": "EXAMPLE",
      "parts": [
        {
          "text": "anh "
        },
        {
          "text": "thi dinh",
          "entityType": "@thi",
          "alias": "thi",
          "userDefined": true
        },
        {
          "text": ", it's me"
        }
      ]
    }
  ],
  "parameters": [
    {
      "name": "aa07d940-bcc7-464d-af4d-d38120737b9c",
      "displayName": "thi",
      "value": "$thi",
      "entityTypeDisplayName": "@thi"
    },
    {
      "name": "bde49cda-37d8-43c3-9461-83c2fbc90996",
      "displayName": "color",
      "value": "$color",
      "entityTypeDisplayName": "@sys.color"
    }
  ]
}