Class Document.Types.Entity

A phrase in the text that is a known entity type, such as a person, an organization, or location.

Inheritance
System.Object
Document.Types.Entity
Implements
System.IEquatable<Document.Types.Entity>
Google.Protobuf.IBufferMessage
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.DocumentAI.V1Beta2
Assembly: Google.Cloud.DocumentAI.V1Beta2.dll
Syntax
public sealed class Entity : IMessage<Document.Types.Entity>, IEquatable<Document.Types.Entity>, IDeepCloneable<Document.Types.Entity>, IBufferMessage, IMessage

Constructors

Entity()

Declaration
public Entity()

Entity(Document.Types.Entity)

Declaration
public Entity(Document.Types.Entity other)
Parameters
Type Name Description
Document.Types.Entity other

Properties

BoundingPolyForDemoFrontend

Optional. Temporary field to store the bounding poly for short-term POCs. Used by the frontend only. Do not use before you talk to ybo@ and lukasr@.

Declaration
public BoundingPoly BoundingPolyForDemoFrontend { get; set; }
Property Value
Type Description
BoundingPoly

Confidence

Optional. Confidence of detected Schema entity. Range [0, 1].

Declaration
public float Confidence { get; set; }
Property Value
Type Description
System.Single

Id

Optional. Canonical id. This will be a unique value in the entity list for this document.

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String

MentionId

Deprecated. Use id field instead.

Declaration
public string MentionId { get; set; }
Property Value
Type Description
System.String

MentionText

Text value in the document e.g. 1600 Amphitheatre Pkwy.

Declaration
public string MentionText { get; set; }
Property Value
Type Description
System.String

PageAnchor

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

Declaration
public Document.Types.PageAnchor PageAnchor { get; set; }
Property Value
Type Description
Document.Types.PageAnchor

TextAnchor

Provenance of the entity. Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].

Declaration
public Document.Types.TextAnchor TextAnchor { get; set; }
Property Value
Type Description
Document.Types.TextAnchor

Type

Entity type from a schema e.g. Address.

Declaration
public string Type { get; set; }
Property Value
Type Description
System.String