Google's Dialogflow APIs

1. APIs & references -- the root of all things.

   1. Node.js client library -- wanna use in a backend?
      1. Dialogflow SDK Client Reference
      2. googleapis/nodejs-dialogflow -- Github repo.
         1. Samples -- wanna run these? Step to this section.
   2. REST APIs -- wanna use GET, POST,...?

2. Service endpoint.

   💡 Tip: 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).

   💡 Tip: <region>-dialogflow.googleapis.com = endpoint.

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

5. Google APIs Explorer.

6. OAuth 2.0 Playground.

7. 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,

    "use strict";
    async function main() {
    const location = "global";
    const { AgentsClient } = require("@google-cloud/dialogflow");
    const parent = (location) => "projects/-" + "/locations/" + location;
    const client = new AgentsClient({
        credentials: { private_key, client_email },
        apiEndpoint: location + "-dialogflow.googleapis.com",
    });
    async function searchAgents() {
        const request = { parent: parent(location) };
        const [response] = await client.searchAgents(request);
        console.log(`response: ${JSON.stringify(response, null, 2)}`);
    }
    await searchAgents();
    }
    process.on("unhandledRejection", (err) => {
    console.error(err.message);
    process.exitCode = 1;
    });
    main();

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.

projects.agent.search

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

• 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 and .