Package types (2.2.2)

API documentation for language_v1beta2.types package.

Classes

AnalyzeEntitiesRequest

The entity analysis request message. .. attribute:: document

Required. Input document.

:type: google.cloud.language_v1beta2.types.Document

AnalyzeEntitiesResponse

The entity analysis response message. .. attribute:: entities

The recognized entities in the input document.

:type: Sequence[google.cloud.language_v1beta2.types.Entity]

AnalyzeEntitySentimentRequest

The entity-level sentiment analysis request message. .. attribute:: document

Required. Input document.

:type: google.cloud.language_v1beta2.types.Document

AnalyzeEntitySentimentResponse

The entity-level sentiment analysis response message. .. attribute:: entities

The recognized entities in the input document with associated sentiments.

:type: Sequence[google.cloud.language_v1beta2.types.Entity]

AnalyzeSentimentRequest

The sentiment analysis request message. .. attribute:: document

Required. Input document.

:type: google.cloud.language_v1beta2.types.Document

AnalyzeSentimentResponse

The sentiment analysis response message. .. attribute:: document_sentiment

The overall sentiment of the input document.

:type: google.cloud.language_v1beta2.types.Sentiment

AnalyzeSyntaxRequest

The syntax analysis request message. .. attribute:: document

Required. Input document.

:type: google.cloud.language_v1beta2.types.Document

AnalyzeSyntaxResponse

The syntax analysis response message. .. attribute:: sentences

Sentences in the input document.

:type: Sequence[google.cloud.language_v1beta2.types.Sentence]

AnnotateTextRequest

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

AnnotateTextResponse

The text annotations response message. .. attribute:: sentences

Sentences in the input document. Populated if the user enables AnnotateTextRequest.Features.extract_syntax.

:type: Sequence[google.cloud.language_v1beta2.types.Sentence]

ClassificationCategory

Represents a category returned from the text classifier. .. attribute:: name

The name of the category representing the document, from the predefined taxonomy <https://cloud.google.com/natural-language/docs/categories>__.

:type: str

ClassifyTextRequest

The document classification request message. .. attribute:: document

Required. Input document.

:type: google.cloud.language_v1beta2.types.Document

ClassifyTextResponse

The document classification response message. .. attribute:: categories

Categories representing the input document.

:type: Sequence[google.cloud.language_v1beta2.types.ClassificationCategory]

DependencyEdge

Represents dependency parse tree information for a token. .. attribute:: head_token_index

Represents the head of this token in the dependency tree. This is the index of the token which has an arc going to this token. The index is the position of the token in the array of tokens returned by the API method. If this token is a root token, then the head_token_index is its own index.

:type: int

Document

Represents the input to API methods.

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.

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

EntityMention

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

PartOfSpeech

Represents part of speech information for a token. .. attribute:: tag

The part of speech tag.

:type: google.cloud.language_v1beta2.types.PartOfSpeech.Tag

Sentence

Represents a sentence in the input document. .. attribute:: text

The sentence text.

:type: google.cloud.language_v1beta2.types.TextSpan

Sentiment

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

TextSpan

Represents an output piece of text. .. attribute:: content

The content of the output text.

:type: str

Token

Represents the smallest syntactic building block of the text. .. attribute:: text

The token text.

:type: google.cloud.language_v1beta2.types.TextSpan