Class Entity (0.14.1a0)

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 :noindex:`	`google.cloud.documentai.Document.Entity` Required. The original `google.cloud.documentai.Document.Entity` object.
`page_offset :noindex:`	`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_ :noindex:`	`str` Required. Entity type from a schema e.g. "Address".
`mention_text :noindex:`	`str` Optional. Text value in the document e.g. "1600 Amphitheatre Pkwy". Only populated for Extraction processors.
`normalized_text :noindex:`	`str` Optional. Normalized text value in the document e.g. "1970年01月01日". Only populated for Extraction processors.
`start_page :noindex:`	`int` Optional. `Page` containing the `Entity` for Extraction processors or the first page of the subdocument for Splitter processors.
`end_page :noindex:`	`int` Optional. Last page of the subdocument for Splitter processors.

Methods

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.