Class Entity (1.5.0)

Version 1.5.0

• 3.1.0 (latest)
• 3.0.1
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.3
• 2.28.0
• 2.27.1
• 2.26.0
• 2.25.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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.

Attributes

Name	Description
text_anchor	google.cloud.documentai_v1beta3.types.Document.TextAnchor 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].
page_anchor	google.cloud.documentai_v1beta3.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_v1beta3.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_v1beta3.types.Document.Entity] Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
provenance	google.cloud.documentai_v1beta3.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.

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