Class DocumentSchema (2.24.2)

Version 2.24.2

• 3.0.1 (latest)
• 3.0.0
• 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

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

The schema defines the output of the processed document by a processor.

Attributes
Name	Description
display_name	str Display name to show to users.
description	str Description of the schema.
entity_types	MutableSequence[google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType] Entity types of the schema.
metadata	google.cloud.documentai_v1beta3.types.DocumentSchema.Metadata Metadata of the schema.

Classes

EntityType

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

EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata

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

Metadata for global schema behavior.