Class Entity (2.0.3)

Entity(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.


Optional. Provenance of the entity. Text anchor indexing into the Document.text.
type_ str
Required. Entity type from a schema e.g. Address.
mention_text str
Optional. Text value in the document e.g. 1600 Amphitheatre Pkwy. If the entity is not present in the document, this field will be empty.
mention_id str
Optional. Deprecated. Use id field instead.
confidence float
Optional. Confidence of detected Schema entity. Range [0, 1].
Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
id str
Optional. Canonical id. This will be a unique value in the entity list for this document.
Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
properties Sequence[]
Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
Optional. The history of this annotation.
redacted bool
Optional. Whether the entity will be redacted for de-identification purposes.



NormalizedValue(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Parsed and normalized entity value.

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: