Contact Center AI Insights API: Node.js Client

release level npm version

contactcenterinsights client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Contact Center AI Insights API API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/contact-center-insights

Using the client library

// Imports the Google Cloud client library

const {
  ContactCenterInsightsClient,
} = require('@google-cloud/contact-center-insights');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'

const client = new ContactCenterInsightsClient();

//TODO(library generator): write the actual function you will be testing
async function listConversations() {
  const conversations = await client.listConversations({
    parent: `projects/${projectId}/locations/${location}`,
  });
  console.info(conversations);
}
listConversations();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource CodeTry it
Contact_center_insights.bulk_analyze_conversationssource codeOpen in Cloud Shell
Contact_center_insights.calculate_issue_model_statssource codeOpen in Cloud Shell
Contact_center_insights.calculate_statssource codeOpen in Cloud Shell
Contact_center_insights.create_analysissource codeOpen in Cloud Shell
Contact_center_insights.create_conversationsource codeOpen in Cloud Shell
Contact_center_insights.create_issue_modelsource codeOpen in Cloud Shell
Contact_center_insights.create_phrase_matchersource codeOpen in Cloud Shell
Contact_center_insights.create_viewsource codeOpen in Cloud Shell
Contact_center_insights.delete_analysissource codeOpen in Cloud Shell
Contact_center_insights.delete_conversationsource codeOpen in Cloud Shell
Contact_center_insights.delete_issuesource codeOpen in Cloud Shell
Contact_center_insights.delete_issue_modelsource codeOpen in Cloud Shell
Contact_center_insights.delete_phrase_matchersource codeOpen in Cloud Shell
Contact_center_insights.delete_viewsource codeOpen in Cloud Shell
Contact_center_insights.deploy_issue_modelsource codeOpen in Cloud Shell
Contact_center_insights.export_insights_datasource codeOpen in Cloud Shell
Contact_center_insights.get_analysissource codeOpen in Cloud Shell
Contact_center_insights.get_conversationsource codeOpen in Cloud Shell
Contact_center_insights.get_issuesource codeOpen in Cloud Shell
Contact_center_insights.get_issue_modelsource codeOpen in Cloud Shell
Contact_center_insights.get_phrase_matchersource codeOpen in Cloud Shell
Contact_center_insights.get_settingssource codeOpen in Cloud Shell
Contact_center_insights.get_viewsource codeOpen in Cloud Shell
Contact_center_insights.ingest_conversationssource codeOpen in Cloud Shell
Contact_center_insights.list_analysessource codeOpen in Cloud Shell
Contact_center_insights.list_conversationssource codeOpen in Cloud Shell
Contact_center_insights.list_issue_modelssource codeOpen in Cloud Shell
Contact_center_insights.list_issuessource codeOpen in Cloud Shell
Contact_center_insights.list_phrase_matcherssource codeOpen in Cloud Shell
Contact_center_insights.list_viewssource codeOpen in Cloud Shell
Contact_center_insights.undeploy_issue_modelsource codeOpen in Cloud Shell
Contact_center_insights.update_conversationsource codeOpen in Cloud Shell
Contact_center_insights.update_issuesource codeOpen in Cloud Shell
Contact_center_insights.update_issue_modelsource codeOpen in Cloud Shell
Contact_center_insights.update_phrase_matchersource codeOpen in Cloud Shell
Contact_center_insights.update_settingssource codeOpen in Cloud Shell
Contact_center_insights.update_viewsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Contact Center AI Insights API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/contact-center-insights@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE