Class Entity (1.0.0)

Stay organized with collections Save and categorize content based on your preferences.
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

NameDescription
text_anchor google.cloud.documentai_v1.types.Document.TextAnchor
Optional. Provenance of the entity. Text anchor indexing into the Document.text.
type_ str
Entity type from a schema e.g. ``Address``.
mention_text str
Optional. Text value in the document e.g. ``1600 Amphitheatre Pkwy``.
mention_id str
Optional. Deprecated. Use ``id`` field instead.
confidence float
Optional. Confidence of detected Schema entity. Range [0, 1].
page_anchor google.cloud.documentai_v1.types.Document.PageAnchor
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.
normalized_value google.cloud.documentai_v1.types.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[google.cloud.documentai_v1.types.Document.Entity]
Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
provenance google.cloud.documentai_v1.types.Document.Provenance
Optional. The history of this annotation.
redacted bool
Optional. Whether the entity will be redacted for de-identification purposes.

Inheritance

builtins.object > proto.message.Message > Entity

Classes

NormalizedValue

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

Parsed and normalized entity value. .. attribute:: money_value

Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

:type: google.type.money_pb2.Money