Class Entity (0.11.1a0)

Version 0.11.1-a0

• 0.14.0-a0 (latest)
• 0.13.5-a0
• 0.12.2-a0
• 0.11.2-a0
• 0.10.3-a0
• 0.9.1-a0
• 0.8.0-a0
• 0.7.0-a0
• 0.6.0-a0
• 0.5.0-a0
• 0.4.1-a0
• 0.3.0-a0
• 0.2.1-a0
• 0.1.1-a0

Entity(
    documentai_object: google.cloud.documentai_v1.types.document.Document.Entity,
    page_offset: dataclasses.InitVar[typing.Optional[int]] = 0,
)

Represents a wrapped documentai.Document.Entity.

Attributes
Name	Description
documentai_object	google.cloud.documentai.Document.Entity Required. The original google.cloud.documentai.Document.Entity object.
page_offset	InitVar[int] Optional. The start page of the shard containing the documentai.Document.Entity in the context of the full documentai.Document. page_refs.page is relative to the shard, not the full documentai.Document.
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.
normalized_text	str Optional. Normalized text value in the document e.g. "1970-01-01". If the entity is not present in the document, this field will be empty.
start_page	int Required. Page containing the Entity or the first page of the classification (for Splitter/Classifier processors).
end_page	int Required. Last page of the classification

Methods

crop_image

crop_image(
    documentai_page: google.cloud.documentai_v1.types.document.Document.Page,
) -> typing.Optional[PIL.Image.Image]

Return image cropped from page image for detected entity.

Parameter
Name	Description
documentai_page	documentai.Document Required. The Document.Page containing the Entity.

Returns
Type	Description
PIL.Image.Image	Image from Document.Entity. Returns None if there is no image.