Reference documentation and code samples for the Google Cloud Document Ai V1 Client class EntityType.
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.
Generated from protobuf messagegoogle.cloud.documentai.v1.DocumentSchema.EntityType
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 theEntityType.value_ontologyfield and specify a list of all possible values in a value ontology file.
↳ display_name
string
User defined name for the type.
↳ name
string
Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Usesnake_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 exampleline_item/amount. This convention is deprecated, but will still be honored for backward compatibility.
↳ base_types
array
The entity type that this type is derived from. For now, one and only one should be set.
Description the nested structure, or composition of an entity.
getEnumValues
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 theEntityType.value_ontologyfield and specify a list of all possible values in a value ontology
file.
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 theEntityType.value_ontologyfield and specify a list of all possible values in a value ontology
file.
Name of the type. It must be unique within the schema file and
cannot be a "Common Type". The following naming conventions are used:
Usesnake_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 exampleline_item/amount. This convention is deprecated, but will still be
honored for backward compatibility.
Returns
Type
Description
string
setName
Name of the type. It must be unique within the schema file and
cannot be a "Common Type". The following naming conventions are used:
Usesnake_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 exampleline_item/amount. This convention is deprecated, but will still be
honored for backward compatibility.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getBaseTypes
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-09-04 UTC."],[],[],null,["# Google Cloud Document Ai V1 Client - Class EntityType (2.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.0 (latest)](/php/docs/reference/cloud-document-ai/latest/V1.DocumentSchema.EntityType)\n- [2.2.2](/php/docs/reference/cloud-document-ai/2.2.2/V1.DocumentSchema.EntityType)\n- [2.1.3](/php/docs/reference/cloud-document-ai/2.1.3/V1.DocumentSchema.EntityType)\n- [2.0.0](/php/docs/reference/cloud-document-ai/2.0.0/V1.DocumentSchema.EntityType)\n- [1.14.0](/php/docs/reference/cloud-document-ai/1.14.0/V1.DocumentSchema.EntityType)\n- [1.13.1](/php/docs/reference/cloud-document-ai/1.13.1/V1.DocumentSchema.EntityType)\n- [1.12.2](/php/docs/reference/cloud-document-ai/1.12.2/V1.DocumentSchema.EntityType)\n- [1.9.0](/php/docs/reference/cloud-document-ai/1.9.0/V1.DocumentSchema.EntityType)\n- [1.8.2](/php/docs/reference/cloud-document-ai/1.8.2/V1.DocumentSchema.EntityType)\n- [1.7.0](/php/docs/reference/cloud-document-ai/1.7.0/V1.DocumentSchema.EntityType)\n- [1.6.0](/php/docs/reference/cloud-document-ai/1.6.0/V1.DocumentSchema.EntityType)\n- [1.5.0](/php/docs/reference/cloud-document-ai/1.5.0/V1.DocumentSchema.EntityType)\n- [1.4.0](/php/docs/reference/cloud-document-ai/1.4.0/V1.DocumentSchema.EntityType)\n- [1.3.0](/php/docs/reference/cloud-document-ai/1.3.0/V1.DocumentSchema.EntityType)\n- [1.2.2](/php/docs/reference/cloud-document-ai/1.2.2/V1.DocumentSchema.EntityType)\n- [1.1.1](/php/docs/reference/cloud-document-ai/1.1.1/V1.DocumentSchema.EntityType)\n- [1.0.1](/php/docs/reference/cloud-document-ai/1.0.1/V1.DocumentSchema.EntityType) \nReference documentation and code samples for the Google Cloud Document Ai V1 Client class EntityType.\n\nEntityType is the wrapper of a label of the corresponding model with\ndetailed attributes and limitations for entity-based processors. Multiple\ntypes can also compose a dependency tree to represent nested types.\n\nGenerated from protobuf message `google.cloud.documentai.v1.DocumentSchema.EntityType`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DocumentAI \\\\ V1 \\\\ DocumentSchema\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEnumValues\n\nIf specified, lists all the possible values for this entity. This\nshould not be more than a handful of values. If the number of values\nis \\\u003e10 or could change frequently use the `EntityType.value_ontology`\nfield and specify a list of all possible values in a value ontology\nfile.\n\n### hasEnumValues\n\n### setEnumValues\n\nIf specified, lists all the possible values for this entity. This\nshould not be more than a handful of values. If the number of values\nis \\\u003e10 or could change frequently use the `EntityType.value_ontology`\nfield and specify a list of all possible values in a value ontology\nfile.\n\n### getDisplayName\n\nUser defined name for the type.\n\n### setDisplayName\n\nUser defined name for the type.\n\n### getName\n\nName of the type. It must be unique within the schema file and\ncannot be a \"Common Type\". The following naming conventions are used:\n\n- Use `snake_casing`.\n\n- Name matching is case-sensitive.\n\n- Maximum 64 characters.\n- Must start with a letter.\n- Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.)\n- 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.\n\n### setName\n\nName of the type. It must be unique within the schema file and\ncannot be a \"Common Type\". The following naming conventions are used:\n\n- Use `snake_casing`.\n\n- Name matching is case-sensitive.\n\n- Maximum 64 characters.\n- Must start with a letter.\n- Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.)\n- 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.\n\n### getBaseTypes\n\nThe entity type that this type is derived from. For now, one and only\none should be set.\n\n### setBaseTypes\n\nThe entity type that this type is derived from. For now, one and only\none should be set.\n\n### getProperties\n\nDescription the nested structure, or composition of an entity.\n\n### setProperties\n\nDescription the nested structure, or composition of an entity.\n\n### getValueSource"]]
