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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class EntityType (3.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.5.0 (latest)](/python/docs/reference/documentai/latest/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [3.4.0](/python/docs/reference/documentai/3.4.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [3.3.0](/python/docs/reference/documentai/3.3.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [3.2.0](/python/docs/reference/documentai/3.2.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [3.1.0](/python/docs/reference/documentai/3.1.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [3.0.1](/python/docs/reference/documentai/3.0.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.35.0](/python/docs/reference/documentai/2.35.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.34.0](/python/docs/reference/documentai/2.34.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.33.0](/python/docs/reference/documentai/2.33.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.32.0](/python/docs/reference/documentai/2.32.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.30.0](/python/docs/reference/documentai/2.30.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.29.3](/python/docs/reference/documentai/2.29.3/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.28.0](/python/docs/reference/documentai/2.28.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.27.1](/python/docs/reference/documentai/2.27.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.26.0](/python/docs/reference/documentai/2.26.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.25.0](/python/docs/reference/documentai/2.25.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.24.2](/python/docs/reference/documentai/2.24.2/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.23.0](/python/docs/reference/documentai/2.23.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.22.0](/python/docs/reference/documentai/2.22.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.21.1](/python/docs/reference/documentai/2.21.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.20.2](/python/docs/reference/documentai/2.20.2/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.19.0](/python/docs/reference/documentai/2.19.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.18.0](/python/docs/reference/documentai/2.18.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.17.0](/python/docs/reference/documentai/2.17.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.16.1](/python/docs/reference/documentai/2.16.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.15.0](/python/docs/reference/documentai/2.15.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.14.0](/python/docs/reference/documentai/2.14.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.13.0](/python/docs/reference/documentai/2.13.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.12.0](/python/docs/reference/documentai/2.12.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.11.0](/python/docs/reference/documentai/2.11.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.10.0](/python/docs/reference/documentai/2.10.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.9.1](/python/docs/reference/documentai/2.9.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.8.0](/python/docs/reference/documentai/2.8.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.7.0](/python/docs/reference/documentai/2.7.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.6.0](/python/docs/reference/documentai/2.6.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.5.0](/python/docs/reference/documentai/2.5.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.4.1](/python/docs/reference/documentai/2.4.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.3.0](/python/docs/reference/documentai/2.3.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.2.0](/python/docs/reference/documentai/2.2.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.1.0](/python/docs/reference/documentai/2.1.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [2.0.3](/python/docs/reference/documentai/2.0.3/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [1.5.1](/python/docs/reference/documentai/1.5.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [1.4.2](/python/docs/reference/documentai/1.4.2/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [1.3.0](/python/docs/reference/documentai/1.3.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [1.2.1](/python/docs/reference/documentai/1.2.1/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [1.1.0](/python/docs/reference/documentai/1.1.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [1.0.0](/python/docs/reference/documentai/1.0.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [0.5.2](/python/docs/reference/documentai/0.5.2/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [0.4.0](/python/docs/reference/documentai/0.4.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [0.3.0](/python/docs/reference/documentai/0.3.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [0.2.0](/python/docs/reference/documentai/0.2.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType)\n- [0.1.0](/python/docs/reference/documentai/0.1.0/google.cloud.documentai_v1beta3.types.DocumentSchema.EntityType) \n\n EntityType(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nEntityType is the wrapper of a label of the corresponding\nmodel with detailed attributes and limitations for entity-based\nprocessors. Multiple types can also compose a dependency tree to\nrepresent nested types.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### EnumValues\n\n EnumValues(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nDefines the a list of enum values.\n\n### Property\n\n Property(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nDefines properties that can be part of the entity type."]]