Contact Center AI Insights API: Node.js Client

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
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Contact Center AI Insights API API.
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.

Sample	Source Code	Try it
Contact_center_insights.bulk_analyze_conversations	source code
Contact_center_insights.calculate_issue_model_stats	source code
Contact_center_insights.calculate_stats	source code
Contact_center_insights.create_analysis	source code
Contact_center_insights.create_conversation	source code
Contact_center_insights.create_issue_model	source code
Contact_center_insights.create_phrase_matcher	source code
Contact_center_insights.create_view	source code
Contact_center_insights.delete_analysis	source code
Contact_center_insights.delete_conversation	source code
Contact_center_insights.delete_issue	source code
Contact_center_insights.delete_issue_model	source code
Contact_center_insights.delete_phrase_matcher	source code
Contact_center_insights.delete_view	source code
Contact_center_insights.deploy_issue_model	source code
Contact_center_insights.export_insights_data	source code
Contact_center_insights.get_analysis	source code
Contact_center_insights.get_conversation	source code
Contact_center_insights.get_issue	source code
Contact_center_insights.get_issue_model	source code
Contact_center_insights.get_phrase_matcher	source code
Contact_center_insights.get_settings	source code
Contact_center_insights.get_view	source code
Contact_center_insights.ingest_conversations	source code
Contact_center_insights.list_analyses	source code
Contact_center_insights.list_conversations	source code
Contact_center_insights.list_issue_models	source code
Contact_center_insights.list_issues	source code
Contact_center_insights.list_phrase_matchers	source code
Contact_center_insights.list_views	source code
Contact_center_insights.undeploy_issue_model	source code
Contact_center_insights.update_conversation	source code
Contact_center_insights.update_issue	source code
Contact_center_insights.update_issue_model	source code
Contact_center_insights.update_phrase_matcher	source code
Contact_center_insights.update_settings	source code
Contact_center_insights.update_view	source code
Contact_center_insights.upload_conversation	source code
Quickstart	source code
Quickstart	source code

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