GitHunt
AV

AVaksman/nodejs-language

Node.js client for Google Cloud Natural Language: Derive insights from unstructured text using Google machine learning.

Google Cloud Platform logo

Natural Language: Node.js Client

release level
npm version
codecov

Cloud Natural Language API provides natural
language understanding technologies to developers, including sentiment analysis, entity
analysis, and syntax analysis. This API is part of the larger Cloud Machine Learning API family.

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 Natural Language 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/language

Using the client library

async function quickstart() {
  // Imports the Google Cloud client library
  const language = require('@google-cloud/language');

  // Instantiates a client
  const client = new language.LanguageServiceClient();

  // The text to analyze
  const text = 'Hello, world!';

  const document = {
    content: text,
    type: 'PLAIN_TEXT',
  };

  // Detects the sentiment of the text
  const [result] = await client.analyzeSentiment({document: document});
  const sentiment = result.documentSentiment;

  console.log(`Text: ${text}`);
  console.log(`Sentiment score: ${sentiment.score}`);
  console.log(`Sentiment magnitude: ${sentiment.magnitude}`);
}

Samples

Samples are in the samples/ directory. The samples' README.md
has instructions for running the samples.

Sample Source Code Try it
Analyze v1 source code Open in Cloud Shell
Automl Natural Language Dataset source code Open in Cloud Shell
Automl Natural Language Model source code Open in Cloud Shell
Automl Natural Language Predict source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell
Set Endpoint source code Open in Cloud Shell

The Natural Language 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.

Client libraries targetting some end-of-life versions of Node.js are available, and
can be installed via npm dist-tags.
The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versions
    compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it
is 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 GA 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 template in this
directory.

License

Apache Version 2.0

See LICENSE