Class EntityType (3.1.0) 

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

Attributes
Name Description
enum_values google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.EnumValues
If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the EntityType.value_ontology field and specify a list of all possible values in a value ontology file. This field is a member of oneof_ value_source.
display_name str
User defined name for the type.
name str
Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use snake_casing. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters [a-z0-9_-]. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The / is sometimes used to denote a property of a type. For example line_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
description str
The description of the entity type. Could be used to provide more information about the entity type for model calls.
base_types MutableSequence[str]
The entity type that this type is derived from. For now, one and only one should be set.
properties MutableSequence[google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType.Property]
Description the nested structure, or composition of an entity.
entity_type_metadata google.cloud.documentai_v1beta3.types.EntityTypeMetadata
Metadata for the entity type.

Classes

EnumValues

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

Defines the a list of enum values.

Property

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

Defines properties that can be part of the entity type.