Package types (2.12.0rc0)

API documentation for language_v2.types package.

Classes

AnalyzeEntitiesRequest

The entity analysis request message.

AnalyzeEntitiesResponse

The entity analysis response message.

AnalyzeSentimentRequest

The sentiment analysis request message.

AnalyzeSentimentResponse

The sentiment analysis response message.

AnnotateTextRequest

The request message for the text annotation API, which can perform multiple analysis types in one call.

AnnotateTextResponse

The text annotations response message.

ClassificationCategory

Represents a category returned from the text classifier.

ClassifyTextRequest

The document classification request message.

ClassifyTextResponse

The document classification response message.

Document

Represents the input to API methods.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EncodingType

Represents the text encoding that the caller uses to process the output. Providing an EncodingType is recommended because the API provides the beginning offsets for various outputs, such as tokens and mentions, and languages that natively use different text encodings may access offsets differently.

Values: NONE (0): If EncodingType is not specified, encoding-dependent information (such as begin_offset) will be set at -1. UTF8 (1): Encoding-dependent information (such as begin_offset) is calculated based on the UTF-8 encoding of the input. C++ and Go are examples of languages that use this encoding natively. UTF16 (2): Encoding-dependent information (such as begin_offset) is calculated based on the UTF-16 encoding of the input. Java and JavaScript are examples of languages that use this encoding natively. UTF32 (3): Encoding-dependent information (such as begin_offset) is calculated based on the UTF-32 encoding of the input. Python is an example of a language that uses this encoding natively.

Entity

Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as probability and mentions, with entities.

EntityMention

Represents a mention for an entity in the text. Currently, proper noun mentions are supported.

ModerateTextRequest

The document moderation request message.

ModerateTextResponse

The document moderation response message.

Sentence

Represents a sentence in the input document.

Sentiment

Represents the feeling associated with the entire text or entities in the text.

TextSpan

Represents a text span in the input document.