LanguageServiceClient

LanguageServiceClient

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

Constructor

new LanguageServiceClient(optionsopt, fallback)

Construct an instance of LanguageServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

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.

apiEndpoint string <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

client configuration override. TODO(@alexander-fenster): link to gax documentation.

fallback boolean

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

analyzeEntities(request, optionsopt) → {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 Description
document google.cloud.language.v1.Document

Input document.

encodingType google.cloud.language.v1.EncodingType

The encoding type used by the API to calculate offsets.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing AnalyzeEntitiesResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.analyzeEntities(request);

analyzeEntitySentiment(request, optionsopt) → {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 Description
document google.cloud.language.v1.Document

Input document.

encodingType google.cloud.language.v1.EncodingType

The encoding type used by the API to calculate offsets.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
Example
const [response] = await client.analyzeEntitySentiment(request);

analyzeSentiment(request, optionsopt) → {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 Description
document google.cloud.language.v1.Document

Input document.

encodingType google.cloud.language.v1.EncodingType

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

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
Example
const [response] = await client.analyzeSentiment(request);

analyzeSyntax(request, optionsopt) → {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 Description
document google.cloud.language.v1.Document

Input document.

encodingType google.cloud.language.v1.EncodingType

The encoding type used by the API to calculate offsets.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing AnalyzeSyntaxResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.analyzeSyntax(request);

annotateText(request, optionsopt) → {Promise}

A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
document google.cloud.language.v1.Document

Input document.

features google.cloud.language.v1.AnnotateTextRequest.Features

The enabled features.

encodingType google.cloud.language.v1.EncodingType

The encoding type used by the API to calculate offsets.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing AnnotateTextResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.annotateText(request);

classifyText(request, optionsopt) → {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 google.cloud.language.v1.Document

Input document.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing ClassifyTextResponse. Please see the documentation for more details and examples.
Example
const [response] = await client.classifyText(request);

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.