Class LanguageServiceClient (2.17.0)

publicclass LanguageServiceClientimplementsBackgroundResource

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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
AnalyzeSentimentResponseresponse=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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
LanguageServiceSettingslanguageServiceSettings=
LanguageServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
LanguageServiceClientlanguageServiceClient=
LanguageServiceClient.create(languageServiceSettings);

To customize the endpoint:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
LanguageServiceSettingslanguageServiceSettings=
LanguageServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
LanguageServiceClientlanguageServiceClient=
LanguageServiceClient.create(languageServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
LanguageServiceSettingslanguageServiceSettings=
LanguageServiceSettings.newHttpJsonBuilder().build();
LanguageServiceClientlanguageServiceClient=
LanguageServiceClient.create(languageServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > LanguageServiceClient

Implements

BackgroundResource

Static Methods

create()

publicstaticfinalLanguageServiceClientcreate()

Constructs an instance of LanguageServiceClient with default settings.

Returns
Type Description
LanguageServiceClient
Exceptions
Type Description
IOException

create(LanguageServiceSettings settings)

publicstaticfinalLanguageServiceClientcreate(LanguageServiceSettingssettings)

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.

Parameter
Name Description
settings LanguageServiceSettings
Returns
Type Description
LanguageServiceClient
Exceptions
Type Description
IOException

create(LanguageServiceStub stub)

publicstaticfinalLanguageServiceClientcreate(LanguageServiceStubstub)

Constructs an instance of LanguageServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(LanguageServiceSettings).

Parameter
Name Description
stub LanguageServiceStub
Returns
Type Description
LanguageServiceClient

Constructors

LanguageServiceClient(LanguageServiceSettings settings)

protectedLanguageServiceClient(LanguageServiceSettingssettings)

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.

Parameter
Name Description
settings LanguageServiceSettings

LanguageServiceClient(LanguageServiceStub stub)

protectedLanguageServiceClient(LanguageServiceStubstub)
Parameter
Name Description
stub LanguageServiceStub

Methods

analyzeEntities(AnalyzeEntitiesRequest request)

publicfinalAnalyzeEntitiesResponseanalyzeEntities(AnalyzeEntitiesRequestrequest)

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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnalyzeEntitiesRequestrequest=
AnalyzeEntitiesRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
AnalyzeEntitiesResponseresponse=languageServiceClient.analyzeEntities(request);
}
Parameter
Name Description
request AnalyzeEntitiesRequest

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

Returns
Type Description
AnalyzeEntitiesResponse

analyzeEntities(Document document)

publicfinalAnalyzeEntitiesResponseanalyzeEntities(Documentdocument)

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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
AnalyzeEntitiesResponseresponse=languageServiceClient.analyzeEntities(document);
}
Parameter
Name Description
document Document

Required. Input document.

Returns
Type Description
AnalyzeEntitiesResponse

analyzeEntities(Document document, EncodingType encodingType)

publicfinalAnalyzeEntitiesResponseanalyzeEntities(Documentdocument,EncodingTypeencodingType)

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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
EncodingTypeencodingType=EncodingType.forNumber(0);
AnalyzeEntitiesResponseresponse=
languageServiceClient.analyzeEntities(document,encodingType);
}
Parameters
Name Description
document Document

Required. Input document.

encodingType EncodingType

The encoding type used by the API to calculate offsets.

Returns
Type Description
AnalyzeEntitiesResponse

analyzeEntitiesCallable()

publicfinalUnaryCallable<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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnalyzeEntitiesRequestrequest=
AnalyzeEntitiesRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
ApiFuture<AnalyzeEntitiesResponse>future=
languageServiceClient.analyzeEntitiesCallable().futureCall(request);
// Do something.
AnalyzeEntitiesResponseresponse=future.get();
}
Returns
Type Description
UnaryCallable<AnalyzeEntitiesRequest,AnalyzeEntitiesResponse>

analyzeEntitySentiment(AnalyzeEntitySentimentRequest request)

publicfinalAnalyzeEntitySentimentResponseanalyzeEntitySentiment(AnalyzeEntitySentimentRequestrequest)

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

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnalyzeEntitySentimentRequestrequest=
AnalyzeEntitySentimentRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
AnalyzeEntitySentimentResponseresponse=
languageServiceClient.analyzeEntitySentiment(request);
}
Parameter
Name Description
request AnalyzeEntitySentimentRequest

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

Returns
Type Description
AnalyzeEntitySentimentResponse

analyzeEntitySentiment(Document document)

publicfinalAnalyzeEntitySentimentResponseanalyzeEntitySentiment(Documentdocument)

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

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
AnalyzeEntitySentimentResponseresponse=
languageServiceClient.analyzeEntitySentiment(document);
}
Parameter
Name Description
document Document

Required. Input document.

Returns
Type Description
AnalyzeEntitySentimentResponse

analyzeEntitySentiment(Document document, EncodingType encodingType)

publicfinalAnalyzeEntitySentimentResponseanalyzeEntitySentiment(Documentdocument,EncodingTypeencodingType)

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

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
EncodingTypeencodingType=EncodingType.forNumber(0);
AnalyzeEntitySentimentResponseresponse=
languageServiceClient.analyzeEntitySentiment(document,encodingType);
}
Parameters
Name Description
document Document

Required. Input document.

encodingType EncodingType

The encoding type used by the API to calculate offsets.

Returns
Type Description
AnalyzeEntitySentimentResponse

analyzeEntitySentimentCallable()

publicfinalUnaryCallable<AnalyzeEntitySentimentRequest,AnalyzeEntitySentimentResponse>analyzeEntitySentimentCallable()

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

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnalyzeEntitySentimentRequestrequest=
AnalyzeEntitySentimentRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
ApiFuture<AnalyzeEntitySentimentResponse>future=
languageServiceClient.analyzeEntitySentimentCallable().futureCall(request);
// Do something.
AnalyzeEntitySentimentResponseresponse=future.get();
}
Returns
Type Description
UnaryCallable<AnalyzeEntitySentimentRequest,AnalyzeEntitySentimentResponse>

analyzeSentiment(AnalyzeSentimentRequest request)

publicfinalAnalyzeSentimentResponseanalyzeSentiment(AnalyzeSentimentRequestrequest)

Analyzes the sentiment of the provided text.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnalyzeSentimentRequestrequest=
AnalyzeSentimentRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
AnalyzeSentimentResponseresponse=languageServiceClient.analyzeSentiment(request);
}
Parameter
Name Description
request AnalyzeSentimentRequest

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

Returns
Type Description
AnalyzeSentimentResponse

analyzeSentiment(Document document)

publicfinalAnalyzeSentimentResponseanalyzeSentiment(Documentdocument)

Analyzes the sentiment of the provided text.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
AnalyzeSentimentResponseresponse=languageServiceClient.analyzeSentiment(document);
}
Parameter
Name Description
document Document

Required. Input document.

Returns
Type Description
AnalyzeSentimentResponse

analyzeSentiment(Document document, EncodingType encodingType)

publicfinalAnalyzeSentimentResponseanalyzeSentiment(Documentdocument,EncodingTypeencodingType)

Analyzes the sentiment of the provided text.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
EncodingTypeencodingType=EncodingType.forNumber(0);
AnalyzeSentimentResponseresponse=
languageServiceClient.analyzeSentiment(document,encodingType);
}
Parameters
Name Description
document Document

Required. Input document.

encodingType EncodingType

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

Returns
Type Description
AnalyzeSentimentResponse

analyzeSentimentCallable()

publicfinalUnaryCallable<AnalyzeSentimentRequest,AnalyzeSentimentResponse>analyzeSentimentCallable()

Analyzes the sentiment of the provided text.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnalyzeSentimentRequestrequest=
AnalyzeSentimentRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
ApiFuture<AnalyzeSentimentResponse>future=
languageServiceClient.analyzeSentimentCallable().futureCall(request);
// Do something.
AnalyzeSentimentResponseresponse=future.get();
}
Returns
Type Description
UnaryCallable<AnalyzeSentimentRequest,AnalyzeSentimentResponse>

analyzeSyntax(AnalyzeSyntaxRequest request)

publicfinalAnalyzeSyntaxResponseanalyzeSyntax(AnalyzeSyntaxRequestrequest)

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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnalyzeSyntaxRequestrequest=
AnalyzeSyntaxRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
AnalyzeSyntaxResponseresponse=languageServiceClient.analyzeSyntax(request);
}
Parameter
Name Description
request AnalyzeSyntaxRequest

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

Returns
Type Description
AnalyzeSyntaxResponse

analyzeSyntax(Document document)

publicfinalAnalyzeSyntaxResponseanalyzeSyntax(Documentdocument)

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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
AnalyzeSyntaxResponseresponse=languageServiceClient.analyzeSyntax(document);
}
Parameter
Name Description
document Document

Required. Input document.

Returns
Type Description
AnalyzeSyntaxResponse

analyzeSyntax(Document document, EncodingType encodingType)

publicfinalAnalyzeSyntaxResponseanalyzeSyntax(Documentdocument,EncodingTypeencodingType)

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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
EncodingTypeencodingType=EncodingType.forNumber(0);
AnalyzeSyntaxResponseresponse=languageServiceClient.analyzeSyntax(document,encodingType);
}
Parameters
Name Description
document Document

Required. Input document.

encodingType EncodingType

The encoding type used by the API to calculate offsets.

Returns
Type Description
AnalyzeSyntaxResponse

analyzeSyntaxCallable()

publicfinalUnaryCallable<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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnalyzeSyntaxRequestrequest=
AnalyzeSyntaxRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
ApiFuture<AnalyzeSyntaxResponse>future=
languageServiceClient.analyzeSyntaxCallable().futureCall(request);
// Do something.
AnalyzeSyntaxResponseresponse=future.get();
}
Returns
Type Description
UnaryCallable<AnalyzeSyntaxRequest,AnalyzeSyntaxResponse>

annotateText(AnnotateTextRequest request)

publicfinalAnnotateTextResponseannotateText(AnnotateTextRequestrequest)

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

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnnotateTextRequestrequest=
AnnotateTextRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setFeatures(AnnotateTextRequest.Features.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
AnnotateTextResponseresponse=languageServiceClient.annotateText(request);
}
Parameter
Name Description
request AnnotateTextRequest

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

Returns
Type Description
AnnotateTextResponse

annotateText(Document document, AnnotateTextRequest.Features features)

publicfinalAnnotateTextResponseannotateText(Documentdocument,AnnotateTextRequest.Featuresfeatures)

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

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
AnnotateTextRequest.Featuresfeatures=AnnotateTextRequest.Features.newBuilder().build();
AnnotateTextResponseresponse=languageServiceClient.annotateText(document,features);
}
Parameters
Name Description
document Document

Required. Input document.

features AnnotateTextRequest.Features

Required. The enabled features.

Returns
Type Description
AnnotateTextResponse

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

publicfinalAnnotateTextResponseannotateText(Documentdocument,AnnotateTextRequest.Featuresfeatures,EncodingTypeencodingType)

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

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
AnnotateTextRequest.Featuresfeatures=AnnotateTextRequest.Features.newBuilder().build();
EncodingTypeencodingType=EncodingType.forNumber(0);
AnnotateTextResponseresponse=
languageServiceClient.annotateText(document,features,encodingType);
}
Parameters
Name Description
document Document

Required. Input document.

features AnnotateTextRequest.Features

Required. The enabled features.

encodingType EncodingType

The encoding type used by the API to calculate offsets.

Returns
Type Description
AnnotateTextResponse

annotateTextCallable()

publicfinalUnaryCallable<AnnotateTextRequest,AnnotateTextResponse>annotateTextCallable()

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

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
AnnotateTextRequestrequest=
AnnotateTextRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setFeatures(AnnotateTextRequest.Features.newBuilder().build())
.setEncodingType(EncodingType.forNumber(0))
.build();
ApiFuture<AnnotateTextResponse>future=
languageServiceClient.annotateTextCallable().futureCall(request);
// Do something.
AnnotateTextResponseresponse=future.get();
}
Returns
Type Description
UnaryCallable<AnnotateTextRequest,AnnotateTextResponse>

awaitTermination(long duration, TimeUnit unit)

publicbooleanawaitTermination(longduration,TimeUnitunit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

classifyText(ClassifyTextRequest request)

publicfinalClassifyTextResponseclassifyText(ClassifyTextRequestrequest)

Classifies a document into categories.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
ClassifyTextRequestrequest=
ClassifyTextRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setClassificationModelOptions(ClassificationModelOptions.newBuilder().build())
.build();
ClassifyTextResponseresponse=languageServiceClient.classifyText(request);
}
Parameter
Name Description
request ClassifyTextRequest

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

Returns
Type Description
ClassifyTextResponse

classifyText(Document document)

publicfinalClassifyTextResponseclassifyText(Documentdocument)

Classifies a document into categories.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
Documentdocument=Document.newBuilder().build();
ClassifyTextResponseresponse=languageServiceClient.classifyText(document);
}
Parameter
Name Description
document Document

Required. Input document.

Returns
Type Description
ClassifyTextResponse

classifyTextCallable()

publicfinalUnaryCallable<ClassifyTextRequest,ClassifyTextResponse>classifyTextCallable()

Classifies a document into categories.

Sample code:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try(LanguageServiceClientlanguageServiceClient=LanguageServiceClient.create()){
ClassifyTextRequestrequest=
ClassifyTextRequest.newBuilder()
.setDocument(Document.newBuilder().build())
.setClassificationModelOptions(ClassificationModelOptions.newBuilder().build())
.build();
ApiFuture<ClassifyTextResponse>future=
languageServiceClient.classifyTextCallable().futureCall(request);
// Do something.
ClassifyTextResponseresponse=future.get();
}
Returns
Type Description
UnaryCallable<ClassifyTextRequest,ClassifyTextResponse>

close()

publicfinalvoidclose()

getSettings()

publicfinalLanguageServiceSettingsgetSettings()
Returns
Type Description
LanguageServiceSettings

getStub()

publicLanguageServiceStubgetStub()
Returns
Type Description
LanguageServiceStub

isShutdown()

publicbooleanisShutdown()
Returns
Type Description
boolean

isTerminated()

publicbooleanisTerminated()
Returns
Type Description
boolean

shutdown()

publicvoidshutdown()

shutdownNow()

publicvoidshutdownNow()

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.