Class LanguageServiceClient (2.17.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.79.0 (latest)
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.71.0
- 2.69.0
- 2.68.0
- 2.65.0
- 2.64.0
- 2.63.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.1
- 2.3.4
- 2.2.0
- 2.1.10
publicclass LanguageServiceClientimplementsBackgroundResourceService 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:
- 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.
- 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.
- 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.
Implements
BackgroundResourceInherited Members
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()