Package Classes (2.16.0)

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

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

The entity analysis request message.

The entity analysis response message.

The entity-level sentiment analysis request message.

The entity-level sentiment analysis response message.

The sentiment analysis request message.

The sentiment analysis response message.

The syntax analysis request message.

The syntax analysis response message.

The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.

All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input.

The text annotations response message.

Represents a category returned from the text classifier.

Model options available for classification requests.

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

Options for the V1 model.

Options for the V2 model.

The content categories used for classification.

The document classification request message.

The document classification response message.

Represents dependency parse tree information for a token. (For more information on dependency labels, see http://www.aclweb.org/anthology/P13-2017

The parse label enum for the token.

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

The document types enum.

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.

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 salience and mentions, with entities.

The abstract base class for a message.

The type of the entity. For most entity types, the associated metadata is a Wikipedia URL (wikipedia_url) and Knowledge Graph MID (mid). The table below lists the associated fields for entities that have different metadata.

    The metadata lists the phone number, formatted according to
    local convention, plus whichever additional elements appear
    in the text:

    -  `number` - the actual number, broken down into sections
       as per local convention
    -  `national_prefix` - country code, if detected
    -  `area_code` - region or area code, if detected
    -  `extension` - phone extension (to be dialed after
       connection), if detected
ADDRESS (10):
    Address

    The metadata identifies the street number and locality plus
    whichever additional elements appear in the text:

    -  `street_number` - street number
    -  `locality` - city or town
    -  `street_name` - street/route name, if detected
    -  `postal_code` - postal code, if detected
    -  `country` - country, if detected<
    -  `broad_region` - administrative area, such as the
       state, if detected
    -  `narrow_region` - smaller administrative area, such as
       county, if detected
    -  `sublocality` - used in Asian addresses to demark a
       district within a city, if detected
DATE (11):
    Date

    The metadata identifies the components of the date:

    -  `year` - four digit year, if detected
    -  `month` - two digit month number, if detected
    -  `day` - two digit day number, if detected
NUMBER (12):
    Number

    The metadata is the number itself.
PRICE (13):
    Price

    The metadata identifies the `value` and `currency`.

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

The supported types of mentions.

The document moderation request message.

The document moderation response message.

Represents part of speech information for a token. Parts of speech are as defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf

The characteristic of a verb that expresses time flow during an event.

The grammatical function performed by a noun or pronoun in a phrase, clause, or sentence. In some languages, other parts of speech, such as adjective and determiner, take case inflection in agreement with the noun.

Depending on the language, Form can be categorizing different forms of verbs, adjectives, adverbs, etc. For example, categorizing inflected endings of verbs and adjectives or distinguishing between short and long forms of adjectives and participles

Gender classes of nouns reflected in the behaviour of associated words.

The grammatical feature of verbs, used for showing modality and attitude.

Count distinctions.

The distinction between the speaker, second person, third person, etc.

This category shows if the token is part of a proper name.

Reciprocal features of a pronoun.

The part of speech tags enum.

Time reference.

The relationship between the action that a verb expresses and the participants identified by its arguments.

Represents a sentence in the input document.

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

Represents an output piece of text.

Represents the smallest syntactic building block of the text.

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

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

The entity analysis request message.

The entity analysis response message.

The entity-level sentiment analysis request message.

The entity-level sentiment analysis response message.

The sentiment analysis request message.

The sentiment analysis response message.

The syntax analysis request message.

The syntax analysis response message.

The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.

All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 12

The text annotations response message.

Represents a category returned from the text classifier.

Model options available for classification requests.

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

Options for the V1 model.

Options for the V2 model.

The content categories used for classification.

The document classification request message.

The document classification response message.

Represents dependency parse tree information for a token.

The parse label enum for the token.

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

Ways of handling boilerplate detected in the document

The document types enum.

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.

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 salience and mentions, with entities.

The abstract base class for a message.

The type of the entity. For most entity types, the associated metadata is a Wikipedia URL (wikipedia_url) and Knowledge Graph MID (mid). The table below lists the associated fields for entities that have different metadata.

    The metadata lists the phone number, formatted according to
    local convention, plus whichever additional elements appear
    in the text:

    -  `number` - the actual number, broken down into sections
       as per local convention
    -  `national_prefix` - country code, if detected
    -  `area_code` - region or area code, if detected
    -  `extension` - phone extension (to be dialed after
       connection), if detected
ADDRESS (10):
    Address

    The metadata identifies the street number and locality plus
    whichever additional elements appear in the text:

    -  `street_number` - street number
    -  `locality` - city or town
    -  `street_name` - street/route name, if detected
    -  `postal_code` - postal code, if detected
    -  `country` - country, if detected<
    -  `broad_region` - administrative area, such as the
       state, if detected
    -  `narrow_region` - smaller administrative area, such as
       county, if detected
    -  `sublocality` - used in Asian addresses to demark a
       district within a city, if detected
DATE (11):
    Date

    The metadata identifies the components of the date:

    -  `year` - four digit year, if detected
    -  `month` - two digit month number, if detected
    -  `day` - two digit day number, if detected
NUMBER (12):
    Number

    The metadata is the number itself.
PRICE (13):
    Price

    The metadata identifies the `value` and `currency`.

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

The supported types of mentions.

The document moderation request message.

The document moderation response message.

Represents part of speech information for a token.

The characteristic of a verb that expresses time flow during an event.

The grammatical function performed by a noun or pronoun in a phrase, clause, or sentence. In some languages, other parts of speech, such as adjective and determiner, take case inflection in agreement with the noun.

Depending on the language, Form can be categorizing different forms of verbs, adjectives, adverbs, etc. For example, categorizing inflected endings of verbs and adjectives or distinguishing between short and long forms of adjectives and participles

Gender classes of nouns reflected in the behaviour of associated words.

The grammatical feature of verbs, used for showing modality and attitude.

Count distinctions.

The distinction between the speaker, second person, third person, etc.

This category shows if the token is part of a proper name.

Reciprocal features of a pronoun.

The part of speech tags enum.

Time reference.

The relationship between the action that a verb expresses and the participants identified by its arguments.

Represents a sentence in the input document.

Represents the feeling associated with the entire text or entities in the text. Next ID: 6

Represents an output piece of text.

Represents the smallest syntactic building block of the text.

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

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

The entity analysis request message.

The entity analysis response message.

The sentiment analysis request message.

The sentiment analysis response message.

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

All available features. Setting each one to true will enable that specific analysis for the input.

The text annotations response message.

Represents a category returned from the text classifier.

The document classification request message.

The document classification response message.

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

The document types enum.

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.

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.

The abstract base class for a message.

The type of the entity. The table below lists the associated fields for entities that have different metadata.

    The metadata lists the phone number, formatted according to
    local convention, plus whichever additional elements appear
    in the text:

    -  `number` - the actual number, broken down into sections
       as per local convention
    -  `national_prefix` - country code, if detected
    -  `area_code` - region or area code, if detected
    -  `extension` - phone extension (to be dialed after
       connection), if detected
ADDRESS (10):
    Address

    The metadata identifies the street number and locality plus
    whichever additional elements appear in the text:

    -  `street_number` - street number
    -  `locality` - city or town
    -  `street_name` - street/route name, if detected
    -  `postal_code` - postal code, if detected
    -  `country` - country, if detected
    -  `broad_region` - administrative area, such as the
       state, if detected
    -  `narrow_region` - smaller administrative area, such as
       county, if detected
    -  `sublocality` - used in Asian addresses to demark a
       district within a city, if detected
DATE (11):
    Date

    The metadata identifies the components of the date:

    -  `year` - four digit year, if detected
    -  `month` - two digit month number, if detected
    -  `day` - two digit day number, if detected
NUMBER (12):
    Number

    The metadata is the number itself.
PRICE (13):
    Price

    The metadata identifies the `value` and `currency`.

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

The supported types of mentions.

The document moderation request message.

The model version to use for ModerateText.

The document moderation response message.

Represents a sentence in the input document.

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

Represents a text span in the input document.