Class Entity (0.8.0a0) 

Entity(
 documentai_entity: google.cloud.documentai_v1.types.document.Document.Entity,
)

Represents a wrapped documentai.Document.Entity.

Attributes
Name Description
documentai_entity google.cloud.documentai.Document.Entity
Required. The original google.cloud.documentai.Document.Entity object.
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.

Methods

crop_image

crop_image(documentai_document: google.cloud.documentai_v1.types.document.Document)

Return image cropped from page image for detected entity.

Parameter
Name Description
documentai_document documentai.Document

Required. The Document containing the Entity.
Returns
Type Description
PIL.Image.Image Image from Document.Entity. Returns None if there is no image.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.