public sealed class Document.Types.Entity : IMessage<Document.Types.Entity>, IEquatable<Document.Types.Entity>, IDeepCloneable<Document.Types.Entity>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Document AI v1beta3 API class Document.Types.Entity.
An entity that could be a phrase in the text or a property that belongs to
the document. It is a known entity type, such as a person, an organization,
or location.
public Document.Types.Entity.Types.NormalizedValue NormalizedValue { get; set; }
Optional. Normalized entity value. Absent if the extracted value could
not be converted or the type (e.g. address) is not supported for certain
parsers. This field is also only populated for certain supported document
types.
[[["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\u003eThis documentation details the \u003ccode\u003eDocument.Types.Entity\u003c/code\u003e class within the Google Cloud Document AI v1beta3 API, which represents an identified entity in a document, such as a person, organization, or location.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocument.Types.Entity\u003c/code\u003e class inherits from \u003ccode\u003eobject\u003c/code\u003e and implements interfaces like \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\u003eKey properties of an entity include its \u003ccode\u003eConfidence\u003c/code\u003e score, unique \u003ccode\u003eId\u003c/code\u003e, \u003ccode\u003eMentionText\u003c/code\u003e, \u003ccode\u003eNormalizedValue\u003c/code\u003e, \u003ccode\u003ePageAnchor\u003c/code\u003e for location, nested \u003ccode\u003eProperties\u003c/code\u003e, \u003ccode\u003eProvenance\u003c/code\u003e for annotation history, \u003ccode\u003eRedacted\u003c/code\u003e status, \u003ccode\u003eTextAnchor\u003c/code\u003e for text indexing, and the required \u003ccode\u003eType\u003c/code\u003e which specifies the entity category.\u003c/p\u003e\n"],["\u003cp\u003eThe class provides constructors for creating new entities, either empty or by copying another entity's properties, allowing for flexible initialization.\u003c/p\u003e\n"],["\u003cp\u003eThe available versions for this Class include 2.0.0-beta23 (latest), 2.0.0-beta22, and 1.0.0-beta04, within the namespace Google.Cloud.DocumentAI.V1Beta3.\u003c/p\u003e\n"]]],[],null,["# Cloud Document AI v1beta3 API - Class Document.Types.Entity (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.Document.Types.Entity)\n- [2.0.0-beta25](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/2.0.0-beta25/Google.Cloud.DocumentAI.V1Beta3.Document.Types.Entity)\n- [1.0.0-beta04](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/1.0.0-beta04/Google.Cloud.DocumentAI.V1Beta3.Document.Types.Entity) \n\n public sealed class Document.Types.Entity : IMessage\u003cDocument.Types.Entity\u003e, IEquatable\u003cDocument.Types.Entity\u003e, IDeepCloneable\u003cDocument.Types.Entity\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Cloud Document AI v1beta3 API class Document.Types.Entity.\n\nAn entity that could be a phrase in the text or a property that belongs to\nthe document. It is a known entity type, such as a person, an organization,\nor location. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Document.Types.Entity \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Document](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Document)[Types](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Document.Types)[Entity](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Document.Types.Entity), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Document](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Document)[Types](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Document.Types)[Entity](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Document.Types.Entity), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Document](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Document)[Types](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Document.Types)[Entity](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1Beta3/latest/Google.Cloud.DocumentAI.V1Beta3.Document.Types.Entity), [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### Entity()\n\n public Entity()\n\n### Entity(Entity)\n\n public Entity(Document.Types.Entity other)\n\nProperties\n----------\n\n### Confidence\n\n public float Confidence { get; set; }\n\nOptional. Confidence of detected Schema entity. Range `[0, 1]`.\n\n### Id\n\n public string Id { get; set; }\n\nOptional. Canonical id. This will be a unique value in the entity list\nfor this document.\n\n### MentionId\n\n public string MentionId { get; set; }\n\nOptional. Deprecated. Use `id` field instead.\n\n### MentionText\n\n public string MentionText { get; set; }\n\nOptional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.\n\n### NormalizedValue\n\n public Document.Types.Entity.Types.NormalizedValue NormalizedValue { get; set; }\n\nOptional. Normalized entity value. Absent if the extracted value could\nnot be converted or the type (e.g. address) is not supported for certain\nparsers. This field is also only populated for certain supported document\ntypes.\n\n### PageAnchor\n\n public Document.Types.PageAnchor PageAnchor { get; set; }\n\nOptional. Represents the provenance of this entity wrt. the location on\nthe page where it was found.\n\n### Properties\n\n public RepeatedField\u003cDocument.Types.Entity\u003e Properties { get; }\n\nOptional. Entities can be nested to form a hierarchical data structure\nrepresenting the content in the document.\n\n### Provenance\n\n public Document.Types.Provenance Provenance { get; set; }\n\nOptional. The history of this annotation.\n\n### Redacted\n\n public bool Redacted { get; set; }\n\nOptional. Whether the entity will be redacted for de-identification\npurposes.\n\n### TextAnchor\n\n public Document.Types.TextAnchor TextAnchor { get; set; }\n\nOptional. Provenance of the entity.\nText anchor indexing into the\n\\[Document.text\\]\\[google.cloud.documentai.v1beta3.Document.text\\].\n\n### Type\n\n public string Type { get; set; }\n\nRequired. Entity type from a schema e.g. `Address`."]]
