Class EntityType (2.4.0)

Stay organized with collections Save and categorize content based on your preferences.
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:


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'. Besides that we use the following naming conventions: - *use snake_casing* - name matching is case-insensitive - 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.
base_types MutableSequence[str]
The entity type that this type is derived from. For now, one and only one should be set.
properties MutableSequence[]
Describing the nested structure, or composition of an entity.



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

Defines the a list of enum values.


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

Defines properties that can be part of the entity type.