Class DocumentSchema (3.10.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 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.
document_prompt str
Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.

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.