public sealed class DocumentSchema.Types.EntityType : IMessage<DocumentSchema.Types.EntityType>, IEquatable<DocumentSchema.Types.EntityType>, IDeepCloneable<DocumentSchema.Types.EntityType>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Document AI v1beta3 API class DocumentSchema.Types.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.
public DocumentSchema.Types.EntityType.Types.EnumValues EnumValues { get; set; }
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003e\u003ccode\u003eDocumentSchema.Types.EntityType\u003c/code\u003e is a class within the Cloud Document AI v1beta3 API used to define labels for entity-based processors, allowing for detailed attributes and limitations.\u003c/p\u003e\n"],["\u003cp\u003eThis class implements multiple interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, providing functionalities for message handling, equality checks, deep cloning, and buffer management.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEntityType\u003c/code\u003e class can be composed of nested types, enabling the representation of complex, hierarchical entity structures through properties like \u003ccode\u003eProperties\u003c/code\u003e and \u003ccode\u003eBaseTypes\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIt also allows for the specification of possible entity values through the \u003ccode\u003eEnumValues\u003c/code\u003e property or an external ontology file when there are a large number of values.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEntityType\u003c/code\u003e class contains properties like \u003ccode\u003eName\u003c/code\u003e, \u003ccode\u003eDisplayName\u003c/code\u003e, and \u003ccode\u003eDescription\u003c/code\u003e to provide detailed, user-friendly information and identification for each entity type within a document schema.\u003c/p\u003e\n"]]],[],null,["# Cloud Document AI v1beta3 API - Class DocumentSchema.Types.EntityType (2.0.0-beta26)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0-beta26 (latest)](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema.Types.EntityType)\n- [2.0.0-beta25](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/2.0.0-beta25/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema.Types.EntityType)\n- [1.0.0-beta04](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/1.0.0-beta04/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema.Types.EntityType) \n\n public sealed class DocumentSchema.Types.EntityType : IMessage\u003cDocumentSchema.Types.EntityType\u003e, IEquatable\u003cDocumentSchema.Types.EntityType\u003e, IDeepCloneable\u003cDocumentSchema.Types.EntityType\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Cloud Document AI v1beta3 API class DocumentSchema.Types.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\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e DocumentSchema.Types.EntityType \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[DocumentSchema](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema)[Types](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema.Types)[EntityType](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema.Types.EntityType), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[DocumentSchema](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema)[Types](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema.Types)[EntityType](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema.Types.EntityType), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[DocumentSchema](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema)[Types](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema.Types)[EntityType](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.DocumentSchema.Types.EntityType), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DocumentAI.V1Beta3](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3)\n\nAssembly\n--------\n\nGoogle.Cloud.DocumentAI.V1Beta3.dll\n\nConstructors\n------------\n\n### EntityType()\n\n public EntityType()\n\n### EntityType(EntityType)\n\n public EntityType(DocumentSchema.Types.EntityType other)\n\nProperties\n----------\n\n### BaseTypes\n\n public RepeatedField\u003cstring\u003e BaseTypes { get; }\n\nThe entity type that this type is derived from. For now, one and only\none should be set.\n\n### Description\n\n public string Description { get; set; }\n\nThe description of the entity type. Could be used to provide more\ninformation about the entity type for model calls.\n\n### DisplayName\n\n public string DisplayName { get; set; }\n\nUser defined name for the type.\n\n### EntityTypeMetadata\n\n public EntityTypeMetadata EntityTypeMetadata { get; set; }\n\nMetadata for the entity type.\n\n### EnumValues\n\n public DocumentSchema.Types.EntityType.Types.EnumValues EnumValues { get; set; }\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### Name\n\n public string Name { get; set; }\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- Name matching is case-sensitive.\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### Properties\n\n public RepeatedField\u003cDocumentSchema.Types.EntityType.Types.Property\u003e Properties { get; }\n\nDescription the nested structure, or composition of an entity.\n\n### ValueSourceCase\n\n public DocumentSchema.Types.EntityType.ValueSourceOneofCase ValueSourceCase { get; }"]]
