Class Entity (0.3.0)

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

A phrase in the text that is a known entity type, such as a person, an organization, or location.

Attributes
Name	Description
`text_anchor`	`.document.Document.TextAnchor` Provenance of the entity. Text anchor indexing into the Document.text.
`type_`	`str` Entity type from a schema e.g. `Address`.
`mention_text`	`str` Text value in the document e.g. `1600 Amphitheatre Pkwy`.
`mention_id`	`str` Deprecated. Use `id` field instead.
`confidence`	`float` Optional. Confidence of detected Schema entity. Range [0, 1].
`page_anchor`	`.document.Document.PageAnchor` Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
`id`	`str` Canonical id. This will be a unique value in the entity list for this document.
`normalized_value`	`.document.Document.Entity.NormalizedValue` 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[.document.Document.Entity]` Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
`provenance`	`.document.Document.Provenance` Optional. The history of this annotation.
`redacted`	`bool` Optional. Whether the entity will be redacted for de-identification purposes.

Classes

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

Parsed and normalized entity value.