LanguageServiceClient

LanguageServiceClient

Provides text analysis operations such as sentiment analysis and entity recognition.

Constructor

new LanguageServiceClient(optionsopt)

Construct an instance of LanguageServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
promise function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Source:

(static) port

The port for this API service.

Source:

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

analyzeEntities(request, optionsopt, callbackopt) → {Promise}

Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
document Object

Required. Input document.

This object should have the same structure as Document
encodingType number <optional>

The encoding type used by the API to calculate offsets.

The number should be among the values of EncodingType
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AnalyzeEntitiesResponse.
Source:
Example
const language = require('@google-cloud/language');

const client = new language.v1beta2.LanguageServiceClient({
  // optional auth parameters.
});

const document = {};
client.analyzeEntities({document: document})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

analyzeEntitySentiment(request, optionsopt, callbackopt) → {Promise}

Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
document Object

Required. Input document.

This object should have the same structure as Document
encodingType number <optional>

The encoding type used by the API to calculate offsets.

The number should be among the values of EncodingType
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AnalyzeEntitySentimentResponse.
Source:
Example
const language = require('@google-cloud/language');

const client = new language.v1beta2.LanguageServiceClient({
  // optional auth parameters.
});

const document = {};
client.analyzeEntitySentiment({document: document})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

analyzeSentiment(request, optionsopt, callbackopt) → {Promise}

Analyzes the sentiment of the provided text.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
document Object

Required. Input document.

This object should have the same structure as Document
encodingType number <optional>

The encoding type used by the API to calculate sentence offsets for the sentence sentiment.

The number should be among the values of EncodingType
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AnalyzeSentimentResponse.
Source:
Example
const language = require('@google-cloud/language');

const client = new language.v1beta2.LanguageServiceClient({
  // optional auth parameters.
});

const document = {};
client.analyzeSentiment({document: document})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

analyzeSyntax(request, optionsopt, callbackopt) → {Promise}

Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
document Object

Required. Input document.

This object should have the same structure as Document
encodingType number <optional>

The encoding type used by the API to calculate offsets.

The number should be among the values of EncodingType
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AnalyzeSyntaxResponse.
Source:
Example
const language = require('@google-cloud/language');

const client = new language.v1beta2.LanguageServiceClient({
  // optional auth parameters.
});

const document = {};
client.analyzeSyntax({document: document})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

annotateText(request, optionsopt, callbackopt) → {Promise}

A convenience method that provides all syntax, sentiment, entity, and classification features in one call.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
document Object

Required. Input document.

This object should have the same structure as Document
features Object

Required. The enabled features.

This object should have the same structure as Features
encodingType number <optional>

The encoding type used by the API to calculate offsets.

The number should be among the values of EncodingType
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing AnnotateTextResponse.
Source:
Example
const language = require('@google-cloud/language');

const client = new language.v1beta2.LanguageServiceClient({
  // optional auth parameters.
});

const document = {};
const features = {};
const request = {
  document: document,
  features: features,
};
client.annotateText(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

classifyText(request, optionsopt, callbackopt) → {Promise}

Classifies a document into categories.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
document Object

Required. Input document.

This object should have the same structure as Document
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing ClassifyTextResponse.
Source:
Example
const language = require('@google-cloud/language');

const client = new language.v1beta2.LanguageServiceClient({
  // optional auth parameters.
});

const document = {};
client.classifyText({document: document})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source: