migrate code from googleapis/nodejs-dialogflow-cx

.github/workflows/dialogflow-cx.yaml

@@ -0,0 +1,76 @@
+name: dialogflow-cx
+on:
+  push:
+    branches:
+    - main
+    paths:
+    - 'dialogflow-cx/**'
+  pull_request:
+    paths:
+    - 'dialogflow-cx/**'
+  pull_request_target:
+    types: [labeled]
+  schedule:
+  - cron:  '0 0 * * 0'
+jobs:
+  test:
+    if: ${{ github.event.action != 'labeled' || github.event.label.name == 'actions:force-run' }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    permissions:
+      contents: 'write'
+      pull-requests: 'write'
+      id-token: 'write'
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        ref: ${{github.event.pull_request.head.ref}}
+        repository: ${{github.event.pull_request.head.repo.full_name}}
+    - uses: google-github-actions/[email protected]
+      with:
+        workload_identity_provider: 'projects/1046198160504/locations/global/workloadIdentityPools/github-actions-pool/providers/github-actions-provider'
+        service_account: '[email protected]'
+        create_credentials_file: 'true'
+        access_token_lifetime: 600s
+    - id: secrets
+      uses: 'google-github-actions/get-secretmanager-secrets@v0'
+      with:
+        secrets: |-
+          agent_id:nodejs-docs-samples-tests/nodejs-docs-samples-dialogflow-cx-agent-id
+          test_id:nodejs-docs-samples-tests/nodejs-docs-samples-dialogflow-cx-test-id
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 14
+    - run: npm install
+      working-directory: dialogflow-cx
+    - run: npm test
+      working-directory: dialogflow-cx
+      env:
+        AGENT_ID: ${{ steps.secrets.outputs.agent_id }}
+        TEST_ID: ${{ steps.secrets.outputs.test_id }}
+        AGENT_PROJECT_ID: nodejs-docs-samples-tests
+        MOCHA_REPORTER_SUITENAME: dialogflow-cx
+        MOCHA_REPORTER_OUTPUT: dialogflow_cx_sponge_log.xml
+        MOCHA_REPORTER: xunit
+    - if: ${{ github.event.action == 'labeled' && github.event.label.name == 'actions:force-run' }}
+      uses: actions/github-script@v6
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        script: |
+          try {
+            await github.rest.issues.removeLabel({
+              name: 'actions:force-run',
+              owner: 'GoogleCloudPlatform',
+              repo: 'nodejs-docs-samples',
+              issue_number: context.payload.pull_request.number
+            });
+          } catch (e) {
+            if (!e.message.includes('Label does not exist')) {
+              throw e;
+            }
+          }
+    - if: ${{ github.event_name == 'schedule' && always() }}
+      run: |
+        curl https://github.com/googleapis/repo-automation-bots/releases/download/flakybot-1.1.0/flakybot -o flakybot -s -L
+        chmod +x ./flakybot
+        ./flakybot --repo GoogleCloudPlatform/nodejs-docs-samples --commit_hash ${{github.sha}} --build_url https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}

.github/workflows/workflows.json

@@ -34,6 +34,7 @@
   "datastore/functions",
   "datacatalog/quickstart",
   "dialogflow",
+  "dialogflow-cx",
   "document-ai",
   "endpoints/getting-started",
   "endpoints/getting-started-grpc",

dialogflow-cx/configure-webhook-to-set-form-parameter-as-optional-or-required.js

@@ -0,0 +1,48 @@
+// 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
+//
+//     https://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.
+
+/**
+ * Configures a webhook to set form parameters as optional/required
+ */
+
+// [START dialogflow_cx_v3_configure_webhooks_to_set_form_parameter_as_optional_or_required]
+
+exports.configureOptionalFormParam = (request, response) => {
+  // The value of the parameter that the webhook will set as optional or required.
+  // Note that the webhook cannot add or remove any form parameter
+
+  const jsonResponse = {
+    pageInfo: {
+      formInfo: {
+        parameterInfo: [
+          {
+            displayName: 'order-number',
+            // if required: false, the agent will not reprompt for this parameter, even if the state is 'INVALID'
+            required: true,
+            state: 'VALID',
+          },
+        ],
+      },
+    },
+  };
+
+  // Info about form parameter that is sent in the webhook response:
+  console.log(
+    'Parameter Info: \n',
+    jsonResponse.pageInfo.formInfo.parameterInfo[0]
+  );
+
+  response.send(jsonResponse);
+};
+// [END dialogflow_cx_v3_configure_webhooks_to_set_form_parameter_as_optional_or_required]

dialogflow-cx/create-agent.js

@@ -0,0 +1,56 @@
+// 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
+//
+//     https://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.
+
+'use strict';
+
+process.env.DEBUG = 'dialogflow:debug'; // enables lib debugging statements
+
+async function main(projectId, displayName) {
+  // [START dialogflow_set_agent_sample]
+
+  const parent = 'projects/' + projectId + '/locations/global';
+
+  const api_endpoint = 'global-dialogflow.googleapis.com';
+
+  const agent = {
+    displayName: displayName,
+    defaultLanguageCode: 'en',
+    timeZone: 'America/Los_Angeles',
+  };
+
+  const {AgentsClient} = require('@google-cloud/dialogflow-cx');
+
+  const client = new AgentsClient({apiEndpoint: api_endpoint});
+
+  async function setAgentSample() {
+    const request = {
+      agent,
+      parent,
+    };
+
+    const [response] = await client.createAgent(request);
+    console.log(`response: ${JSON.stringify(response, null, 2)}`);
+
+    // Delete created agent resource
+    client.deleteAgent({name: response.name});
+  }
+  await setAgentSample();
+  // [END dialogflow_set_agent_sample]
+}
+
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});
+main(...process.argv.slice(2));

dialogflow-cx/create-page.js

@@ -0,0 +1,51 @@
+// 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
+//
+//     https://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.
+
+'use strict';
+
+const {PagesClient} = require('@google-cloud/dialogflow-cx');
+
+async function main(projectId, agentId, flowId, location, displayName) {
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'my-project';
+  // const agentId = 'my-agent';
+  // const flowId = 'my-flow';
+  // const displayName = 'my-display-name';
+  // const location = 'global';
+
+  // [START dialogflow_cx_create_page_sample]
+  async function createPage(projectId, agentId, flowId, location, displayName) {
+    const pagesClient = new PagesClient();
+
+    const createPageRequest = {
+      parent: `projects/${projectId}/locations/${location}/agents/${agentId}/flows/${flowId}`,
+      page: {
+        displayName: displayName,
+      },
+    };
+
+    const response = await pagesClient.createPage(createPageRequest);
+    console.log(response);
+  }
+  // [END dialogflow_cx_create_page_sample]
+
+  await createPage(projectId, agentId, flowId, location, displayName);
+}
+
+main(...process.argv.slice(2)).catch(err => {
+  console.error(err);
+  process.exitCode = 1;
+});

dialogflow-cx/delete-page.js

@@ -0,0 +1,48 @@
+// 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
+//
+//     https://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.
+
+'use strict';
+
+const {PagesClient} = require('@google-cloud/dialogflow-cx');
+
+async function main(projectId, agentId, flowId, pageId, location) {
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'my-project';
+  // const agentId = 'my-agent';
+  // const flowId = 'my-flow';
+  // const pageId = 'my-page';
+  // const location = 'global';
+
+  // [START dialogflow_cx_delete_page_sample]
+  async function deletePage(projectId, agentId, flowId, pageId, location) {
+    const pagesClient = new PagesClient();
+
+    const req = {
+      name: `projects/${projectId}/locations/${location}/agents/${agentId}/flows/${flowId}/pages/${pageId}`,
+    };
+
+    const response = await pagesClient.deletePage(req);
+    console.log(response);
+  }
+  // [END dialogflow_cx_delete_page_sample]
+
+  await deletePage(projectId, agentId, flowId, pageId, location);
+}
+
+main(...process.argv.slice(2)).catch(err => {
+  console.error(err);
+  process.exitCode = 1;
+});

dialogflow-cx/detect-intent-audio.js

@@ -0,0 +1,102 @@
+// 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.
+
+'use strict';
+
+async function main(
+  projectId,
+  location,
+  agentId,
+  audioFileName,
+  encoding,
+  sampleRateHertz,
+  languageCode
+) {
+  // [START dialogflow_cx_detect_intent_audio]
+  /**
+   * TODO(developer): Uncomment these variables before running the sample.
+   */
+  // const projectId = 'my-project';
+  // const location = 'global';
+  // const agentId = 'my-agent';
+  // const audioFileName = '/path/to/audio.raw';
+  // const encoding = 'AUDIO_ENCODING_LINEAR_16';
+  // const sampleRateHertz = 16000;
+  // const languageCode = 'en'
+
+  // Imports the Google Cloud Some API library
+  const {SessionsClient} = require('@google-cloud/dialogflow-cx');
+  /**
+   * Example for regional endpoint:
+   *   const location = 'us-central1'
+   *   const client = new SessionsClient({apiEndpoint: 'us-central1-dialogflow.googleapis.com'})
+   */
+  const client = new SessionsClient();
+
+  const fs = require('fs');
+  const util = require('util');
+
+  async function detectIntentAudio() {
+    const sessionId = Math.random().toString(36).substring(7);
+    const sessionPath = client.projectLocationAgentSessionPath(
+      projectId,
+      location,
+      agentId,
+      sessionId
+    );
+    console.info(sessionPath);
+
+    // Read the content of the audio file and send it as part of the request.
+    const readFile = util.promisify(fs.readFile);
+    const inputAudio = await readFile(audioFileName);
+
+    const request = {
+      session: sessionPath,
+      queryInput: {
+        audio: {
+          config: {
+            audioEncoding: encoding,
+            sampleRateHertz: sampleRateHertz,
+          },
+          audio: inputAudio,
+        },
+        languageCode,
+      },
+    };
+    const [response] = await client.detectIntent(request);
+    console.log(`User Query: ${response.queryResult.transcript}`);
+    for (const message of response.queryResult.responseMessages) {
+      if (message.text) {
+        console.log(`Agent Response: ${message.text.text}`);
+      }
+    }
+    if (response.queryResult.match.intent) {
+      console.log(
+        `Matched Intent: ${response.queryResult.match.intent.displayName}`
+      );
+    }
+    console.log(
+      `Current Page: ${response.queryResult.currentPage.displayName}`
+    );
+  }
+
+  detectIntentAudio();
+  // [END dialogflow_cx_detect_intent_audio]
+}
+
+main(...process.argv.slice(2));
+process.on('unhandledRejection', err => {
+  console.error(err.message);
+  process.exitCode = 1;
+});