com.google.cloud.language.v1beta2

Class LanguageServiceClient

java.lang.Object

com.google.cloud.language.v1beta2.LanguageServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class LanguageServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Provides text analysis operations such as sentiment analysis and entity recognition.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeSentimentResponse response = languageServiceClient.analyzeSentiment(document);
 }
 
 

Note: close() needs to be called on the languageServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of LanguageServiceSettings to create(). For example:

To customize credentials:

 
 LanguageServiceSettings languageServiceSettings =
     LanguageServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LanguageServiceClient languageServiceClient =
     LanguageServiceClient.create(languageServiceSettings);
 
 

To customize the endpoint:

 
 LanguageServiceSettings languageServiceSettings =
     LanguageServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LanguageServiceClient languageServiceClient =
     LanguageServiceClient.create(languageServiceSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LanguageServiceClient(LanguageServiceSettings settings) Constructs an instance of LanguageServiceClient, using the given settings.
protected	LanguageServiceClient(LanguageServiceStub stub)

Method Summary

Modifier and Type	Method and Description
AnalyzeEntitiesResponse	analyzeEntities(AnalyzeEntitiesRequest request) Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.
AnalyzeEntitiesResponse	analyzeEntities(Document document, EncodingType encodingType) Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.
com.google.api.gax.rpc.UnaryCallable<AnalyzeEntitiesRequest,AnalyzeEntitiesResponse>	analyzeEntitiesCallable() Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.
AnalyzeEntitySentimentResponse	analyzeEntitySentiment(AnalyzeEntitySentimentRequest request) Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.
AnalyzeEntitySentimentResponse	analyzeEntitySentiment(Document document, EncodingType encodingType) Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.
com.google.api.gax.rpc.UnaryCallable<AnalyzeEntitySentimentRequest,AnalyzeEntitySentimentResponse>	analyzeEntitySentimentCallable() Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.
AnalyzeSentimentResponse	analyzeSentiment(AnalyzeSentimentRequest request) Analyzes the sentiment of the provided text.
AnalyzeSentimentResponse	analyzeSentiment(Document document) Analyzes the sentiment of the provided text.
com.google.api.gax.rpc.UnaryCallable<AnalyzeSentimentRequest,AnalyzeSentimentResponse>	analyzeSentimentCallable() Analyzes the sentiment of the provided text.
AnalyzeSyntaxResponse	analyzeSyntax(AnalyzeSyntaxRequest request) Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.
AnalyzeSyntaxResponse	analyzeSyntax(Document document, EncodingType encodingType) Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.
com.google.api.gax.rpc.UnaryCallable<AnalyzeSyntaxRequest,AnalyzeSyntaxResponse>	analyzeSyntaxCallable() Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.
AnnotateTextResponse	annotateText(AnnotateTextRequest request) A convenience method that provides all syntax, sentiment, entity, and classification features in one call.
AnnotateTextResponse	annotateText(Document document, AnnotateTextRequest.Features features, EncodingType encodingType) A convenience method that provides all syntax, sentiment, entity, and classification features in one call.
com.google.api.gax.rpc.UnaryCallable<AnnotateTextRequest,AnnotateTextResponse>	annotateTextCallable() A convenience method that provides all syntax, sentiment, entity, and classification features in one call.
boolean	awaitTermination(long duration, TimeUnit unit)
ClassifyTextResponse	classifyText(ClassifyTextRequest request) Classifies a document into categories.
ClassifyTextResponse	classifyText(Document document) Classifies a document into categories.
com.google.api.gax.rpc.UnaryCallable<ClassifyTextRequest,ClassifyTextResponse>	classifyTextCallable() Classifies a document into categories.
void	close()
static LanguageServiceClient	create() Constructs an instance of LanguageServiceClient with default settings.
static LanguageServiceClient	create(LanguageServiceSettings settings) Constructs an instance of LanguageServiceClient, using the given settings.
static LanguageServiceClient	create(LanguageServiceStub stub) Constructs an instance of LanguageServiceClient, using the given stub for making calls.
LanguageServiceSettings	getSettings()
LanguageServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LanguageServiceClient

protected LanguageServiceClient(LanguageServiceSettings settings)
                         throws IOException

Constructs an instance of LanguageServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

LanguageServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected LanguageServiceClient(LanguageServiceStub stub)

Method Detail

create

public static final LanguageServiceClient create()
                                          throws IOException

Constructs an instance of LanguageServiceClient with default settings.

Throws:

IOException

create

public static final LanguageServiceClient create(LanguageServiceSettings settings)
                                          throws IOException

Constructs an instance of LanguageServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final LanguageServiceClient create(LanguageServiceStub stub)

Constructs an instance of LanguageServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use LanguageServiceSettings}.

getSettings

public final LanguageServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public LanguageServiceStub getStub()

analyzeSentiment

public final AnalyzeSentimentResponse analyzeSentiment(Document document)

Analyzes the sentiment of the provided text.

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeSentimentResponse response = languageServiceClient.analyzeSentiment(document);
 }
 

Parameters:

document - Required. Input document.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeSentiment

public final AnalyzeSentimentResponse analyzeSentiment(AnalyzeSentimentRequest request)

Analyzes the sentiment of the provided text.

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeSentimentRequest request = AnalyzeSentimentRequest.newBuilder()
     .setDocument(document)
     .build();
   AnalyzeSentimentResponse response = languageServiceClient.analyzeSentiment(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeSentimentCallable

public final com.google.api.gax.rpc.UnaryCallable<AnalyzeSentimentRequest,AnalyzeSentimentResponse> analyzeSentimentCallable()

Analyzes the sentiment of the provided text.

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeSentimentRequest request = AnalyzeSentimentRequest.newBuilder()
     .setDocument(document)
     .build();
   ApiFuture<AnalyzeSentimentResponse> future = languageServiceClient.analyzeSentimentCallable().futureCall(request);
   // Do something
   AnalyzeSentimentResponse response = future.get();
 }
 

analyzeEntities

public final AnalyzeEntitiesResponse analyzeEntities(Document document,
                                                     EncodingType encodingType)

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

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   EncodingType encodingType = EncodingType.NONE;
   AnalyzeEntitiesResponse response = languageServiceClient.analyzeEntities(document, encodingType);
 }
 

Parameters:

document - Required. Input document.

encodingType - The encoding type used by the API to calculate offsets.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeEntities

public final AnalyzeEntitiesResponse analyzeEntities(AnalyzeEntitiesRequest request)

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

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeEntitiesRequest request = AnalyzeEntitiesRequest.newBuilder()
     .setDocument(document)
     .build();
   AnalyzeEntitiesResponse response = languageServiceClient.analyzeEntities(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeEntitiesCallable

public final com.google.api.gax.rpc.UnaryCallable<AnalyzeEntitiesRequest,AnalyzeEntitiesResponse> analyzeEntitiesCallable()

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

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeEntitiesRequest request = AnalyzeEntitiesRequest.newBuilder()
     .setDocument(document)
     .build();
   ApiFuture<AnalyzeEntitiesResponse> future = languageServiceClient.analyzeEntitiesCallable().futureCall(request);
   // Do something
   AnalyzeEntitiesResponse response = future.get();
 }
 

analyzeEntitySentiment

public final AnalyzeEntitySentimentResponse analyzeEntitySentiment(Document document,
                                                                   EncodingType encodingType)

Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   EncodingType encodingType = EncodingType.NONE;
   AnalyzeEntitySentimentResponse response = languageServiceClient.analyzeEntitySentiment(document, encodingType);
 }
 

Parameters:

document - Required. Input document.

encodingType - The encoding type used by the API to calculate offsets.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeEntitySentiment

public final AnalyzeEntitySentimentResponse analyzeEntitySentiment(AnalyzeEntitySentimentRequest request)

Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeEntitySentimentRequest request = AnalyzeEntitySentimentRequest.newBuilder()
     .setDocument(document)
     .build();
   AnalyzeEntitySentimentResponse response = languageServiceClient.analyzeEntitySentiment(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeEntitySentimentCallable

public final com.google.api.gax.rpc.UnaryCallable<AnalyzeEntitySentimentRequest,AnalyzeEntitySentimentResponse> analyzeEntitySentimentCallable()

Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeEntitySentimentRequest request = AnalyzeEntitySentimentRequest.newBuilder()
     .setDocument(document)
     .build();
   ApiFuture<AnalyzeEntitySentimentResponse> future = languageServiceClient.analyzeEntitySentimentCallable().futureCall(request);
   // Do something
   AnalyzeEntitySentimentResponse response = future.get();
 }
 

analyzeSyntax

public final AnalyzeSyntaxResponse analyzeSyntax(Document document,
                                                 EncodingType encodingType)

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

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   EncodingType encodingType = EncodingType.NONE;
   AnalyzeSyntaxResponse response = languageServiceClient.analyzeSyntax(document, encodingType);
 }
 

Parameters:

document - Required. Input document.

encodingType - The encoding type used by the API to calculate offsets.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeSyntax

public final AnalyzeSyntaxResponse analyzeSyntax(AnalyzeSyntaxRequest request)

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

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeSyntaxRequest request = AnalyzeSyntaxRequest.newBuilder()
     .setDocument(document)
     .build();
   AnalyzeSyntaxResponse response = languageServiceClient.analyzeSyntax(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

analyzeSyntaxCallable

public final com.google.api.gax.rpc.UnaryCallable<AnalyzeSyntaxRequest,AnalyzeSyntaxResponse> analyzeSyntaxCallable()

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

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnalyzeSyntaxRequest request = AnalyzeSyntaxRequest.newBuilder()
     .setDocument(document)
     .build();
   ApiFuture<AnalyzeSyntaxResponse> future = languageServiceClient.analyzeSyntaxCallable().futureCall(request);
   // Do something
   AnalyzeSyntaxResponse response = future.get();
 }
 

classifyText

public final ClassifyTextResponse classifyText(Document document)

Classifies a document into categories.

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   ClassifyTextResponse response = languageServiceClient.classifyText(document);
 }
 

Parameters:

document - Required. Input document.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

classifyText

public final ClassifyTextResponse classifyText(ClassifyTextRequest request)

Classifies a document into categories.

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   ClassifyTextRequest request = ClassifyTextRequest.newBuilder()
     .setDocument(document)
     .build();
   ClassifyTextResponse response = languageServiceClient.classifyText(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

classifyTextCallable

public final com.google.api.gax.rpc.UnaryCallable<ClassifyTextRequest,ClassifyTextResponse> classifyTextCallable()

Classifies a document into categories.

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   ClassifyTextRequest request = ClassifyTextRequest.newBuilder()
     .setDocument(document)
     .build();
   ApiFuture<ClassifyTextResponse> future = languageServiceClient.classifyTextCallable().futureCall(request);
   // Do something
   ClassifyTextResponse response = future.get();
 }
 

annotateText

public final AnnotateTextResponse annotateText(Document document,
                                               AnnotateTextRequest.Features features,
                                               EncodingType encodingType)

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

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnnotateTextRequest.Features features = AnnotateTextRequest.Features.newBuilder().build();
   EncodingType encodingType = EncodingType.NONE;
   AnnotateTextResponse response = languageServiceClient.annotateText(document, features, encodingType);
 }
 

Parameters:

document - Required. Input document.

features - Required. The enabled features.

encodingType - The encoding type used by the API to calculate offsets.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

annotateText

public final AnnotateTextResponse annotateText(AnnotateTextRequest request)

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

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnnotateTextRequest.Features features = AnnotateTextRequest.Features.newBuilder().build();
   AnnotateTextRequest request = AnnotateTextRequest.newBuilder()
     .setDocument(document)
     .setFeatures(features)
     .build();
   AnnotateTextResponse response = languageServiceClient.annotateText(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

annotateTextCallable

public final com.google.api.gax.rpc.UnaryCallable<AnnotateTextRequest,AnnotateTextResponse> annotateTextCallable()

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

Sample code:

 try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
   Document document = Document.newBuilder().build();
   AnnotateTextRequest.Features features = AnnotateTextRequest.Features.newBuilder().build();
   AnnotateTextRequest request = AnnotateTextRequest.newBuilder()
     .setDocument(document)
     .setFeatures(features)
     .build();
   ApiFuture<AnnotateTextResponse> future = languageServiceClient.annotateTextCallable().futureCall(request);
   // Do something
   AnnotateTextResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException