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 v1 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-19 UTC."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003eDocument.Types.Entity\u003c/code\u003e class in the Cloud Document AI v1 API is 3.19.0, with multiple previous versions available for reference, dating back to 1.0.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDocument.Types.Entity\u003c/code\u003e represents a known entity type within a document, which could be a phrase or a property, like a person, an organization, or a location.\u003c/p\u003e\n"],["\u003cp\u003eThis class inherits from \u003ccode\u003eobject\u003c/code\u003e and implements \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e interfaces, providing methods for interacting with and manipulating document entities.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eDocument.Types.Entity\u003c/code\u003e include \u003ccode\u003eConfidence\u003c/code\u003e for the entity's detection accuracy, \u003ccode\u003eId\u003c/code\u003e for a unique identifier, \u003ccode\u003eMentionText\u003c/code\u003e for the entity's text value, \u003ccode\u003eNormalizedValue\u003c/code\u003e for standardized entity values, and \u003ccode\u003eType\u003c/code\u003e for the schema entity type.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocument.Types.Entity\u003c/code\u003e object also contains properties to understand the entity's origins, like \u003ccode\u003ePageAnchor\u003c/code\u003e and \u003ccode\u003eTextAnchor\u003c/code\u003e for location, along with the property \u003ccode\u003eRedacted\u003c/code\u003e to indicate if it should be removed.\u003c/p\u003e\n"]]],[],null,["# Cloud Document AI v1 API - Class Document.Types.Entity (3.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.21.0 (latest)](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/latest/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.20.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.20.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.19.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.19.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.18.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.18.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.17.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.17.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.16.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.16.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.15.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.15.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.14.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.13.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.12.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.11.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.10.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.9.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.8.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.7.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.6.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.5.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.4.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.3.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.2.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.1.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/3.0.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/2.0.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [1.5.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/1.5.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [1.4.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/1.4.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [1.3.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/1.3.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [1.2.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/1.2.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [1.1.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/1.1.0/Google.Cloud.DocumentAI.V1.Document.Types.Entity)\n- [1.0.0](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/1.0.0/Google.Cloud.DocumentAI.V1.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 v1 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.V1/latest/Google.Cloud.DocumentAI.V1.Document)[Types](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/latest/Google.Cloud.DocumentAI.V1.Document.Types)[Entity](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/latest/Google.Cloud.DocumentAI.V1.Document.Types.Entity), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Document](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/latest/Google.Cloud.DocumentAI.V1.Document)[Types](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/latest/Google.Cloud.DocumentAI.V1.Document.Types)[Entity](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/latest/Google.Cloud.DocumentAI.V1.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.V1/latest/Google.Cloud.DocumentAI.V1.Document)[Types](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/latest/Google.Cloud.DocumentAI.V1.Document.Types)[Entity](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/latest/Google.Cloud.DocumentAI.V1.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.V1](/dotnet/docs/reference/Google.Cloud.DocumentAI.V1/latest/Google.Cloud.DocumentAI.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.DocumentAI.V1.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### Method\n\n public Document.Types.Entity.Types.Method Method { get; set; }\n\nOptional. Specifies how the entity's value is obtained.\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.v1.Document.text\\].\n\n### Type\n\n public string Type { get; set; }\n\nRequired. Entity type from a schema e.g. `Address`."]]
