Class LanguageServiceClient (2.22.0-rc)

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

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

LanguageServiceClient(LanguageServiceClient const &)

Copy and move support

Parameter
NameDescription
LanguageServiceClient const &

LanguageServiceClient(LanguageServiceClient &&)

Copy and move support

Parameter
NameDescription
LanguageServiceClient &&

LanguageServiceClient(std::shared_ptr< LanguageServiceConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< LanguageServiceConnection >
opts Options

Operators

operator=(LanguageServiceClient const &)

Copy and move support

Parameter
NameDescription
LanguageServiceClient const &
Returns
TypeDescription
LanguageServiceClient &

operator=(LanguageServiceClient &&)

Copy and move support

Parameter
NameDescription
LanguageServiceClient &&
Returns
TypeDescription
LanguageServiceClient &

Functions

AnalyzeSentiment(google::cloud::language::v2::Document const &, google::cloud::language::v2::EncodingType, Options)

Analyzes the sentiment of the provided text.

Parameters
NameDescription
document google::cloud::language::v2::Document const &

Required. Input document.

encoding_type google::cloud::language::v2::EncodingType

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

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::AnalyzeSentimentResponse >

the result of the RPC. The response message type (google.cloud.language.v2.AnalyzeSentimentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AnalyzeSentiment(google::cloud::language::v2::Document const &, Options)

Analyzes the sentiment of the provided text.

Parameters
NameDescription
document google::cloud::language::v2::Document const &

Required. Input document.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::AnalyzeSentimentResponse >

the result of the RPC. The response message type (google.cloud.language.v2.AnalyzeSentimentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AnalyzeSentiment(google::cloud::language::v2::AnalyzeSentimentRequest const &, Options)

Analyzes the sentiment of the provided text.

Parameters
NameDescription
request google::cloud::language::v2::AnalyzeSentimentRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.language.v2.AnalyzeSentimentRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::AnalyzeSentimentResponse >

the result of the RPC. The response message type (google.cloud.language.v2.AnalyzeSentimentResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AnalyzeEntities(google::cloud::language::v2::Document const &, google::cloud::language::v2::EncodingType, Options)

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

Parameters
NameDescription
document google::cloud::language::v2::Document const &

Required. Input document.

encoding_type google::cloud::language::v2::EncodingType

The encoding type used by the API to calculate offsets.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::AnalyzeEntitiesResponse >

the result of the RPC. The response message type (google.cloud.language.v2.AnalyzeEntitiesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AnalyzeEntities(google::cloud::language::v2::Document const &, Options)

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

Parameters
NameDescription
document google::cloud::language::v2::Document const &

Required. Input document.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::AnalyzeEntitiesResponse >

the result of the RPC. The response message type (google.cloud.language.v2.AnalyzeEntitiesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AnalyzeEntities(google::cloud::language::v2::AnalyzeEntitiesRequest const &, Options)

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

Parameters
NameDescription
request google::cloud::language::v2::AnalyzeEntitiesRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.language.v2.AnalyzeEntitiesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::AnalyzeEntitiesResponse >

the result of the RPC. The response message type (google.cloud.language.v2.AnalyzeEntitiesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ClassifyText(google::cloud::language::v2::Document const &, Options)

Classifies a document into categories.

Parameters
NameDescription
document google::cloud::language::v2::Document const &

Required. Input document.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::ClassifyTextResponse >

the result of the RPC. The response message type (google.cloud.language.v2.ClassifyTextResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ClassifyText(google::cloud::language::v2::ClassifyTextRequest const &, Options)

Classifies a document into categories.

Parameters
NameDescription
request google::cloud::language::v2::ClassifyTextRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.language.v2.ClassifyTextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::ClassifyTextResponse >

the result of the RPC. The response message type (google.cloud.language.v2.ClassifyTextResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ModerateText(google::cloud::language::v2::Document const &, Options)

Moderates a document for harmful and sensitive categories.

Parameters
NameDescription
document google::cloud::language::v2::Document const &

Required. Input document.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::ModerateTextResponse >

the result of the RPC. The response message type (google.cloud.language.v2.ModerateTextResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ModerateText(google::cloud::language::v2::ModerateTextRequest const &, Options)

Moderates a document for harmful and sensitive categories.

Parameters
NameDescription
request google::cloud::language::v2::ModerateTextRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.language.v2.ModerateTextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::ModerateTextResponse >

the result of the RPC. The response message type (google.cloud.language.v2.ModerateTextResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AnnotateText(google::cloud::language::v2::Document const &, google::cloud::language::v2::AnnotateTextRequest::Features const &, google::cloud::language::v2::EncodingType, Options)

A convenience method that provides all features in one call.

Parameters
NameDescription
document google::cloud::language::v2::Document const &

Required. Input document.

features google::cloud::language::v2::AnnotateTextRequest::Features const &

Required. The enabled features.

encoding_type google::cloud::language::v2::EncodingType

The encoding type used by the API to calculate offsets.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::AnnotateTextResponse >

the result of the RPC. The response message type (google.cloud.language.v2.AnnotateTextResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AnnotateText(google::cloud::language::v2::Document const &, google::cloud::language::v2::AnnotateTextRequest::Features const &, Options)

A convenience method that provides all features in one call.

Parameters
NameDescription
document google::cloud::language::v2::Document const &

Required. Input document.

features google::cloud::language::v2::AnnotateTextRequest::Features const &

Required. The enabled features.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::AnnotateTextResponse >

the result of the RPC. The response message type (google.cloud.language.v2.AnnotateTextResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AnnotateText(google::cloud::language::v2::AnnotateTextRequest const &, Options)

A convenience method that provides all features in one call.

Parameters
NameDescription
request google::cloud::language::v2::AnnotateTextRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.language.v2.AnnotateTextRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
StatusOr< google::cloud::language::v2::AnnotateTextResponse >

the result of the RPC. The response message type (google.cloud.language.v2.AnnotateTextResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.