Class Document.Types.Entity (1.0.0-beta03)

public sealed class Entity : IMessage<Document.Types.Entity>, IEquatable<Document.Types.Entity>, IDeepCloneable<Document.Types.Entity>, IBufferMessage, IMessage

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

Inheritance

Object > Document.Types.Entity

Implements

IMessage<Document.Types.Entity>, IEquatable<Document.Types.Entity>, IDeepCloneable<Document.Types.Entity>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.DocumentAI.V1Beta2

Assembly

Google.Cloud.DocumentAI.V1Beta2.dll

Constructors

Entity()

public Entity()

Entity(Document.Types.Entity)

public Entity(Document.Types.Entity other)

Parameter
Name	Description
`other`	`Document.Types.Entity`

Properties

BoundingPolyForDemoFrontend

public BoundingPoly BoundingPolyForDemoFrontend { get; set; }

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@.

Property Value
Type	Description
`BoundingPoly`

Confidence

public float Confidence { get; set; }

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

Property Value
Type	Description
`Single`

Id

public string Id { get; set; }

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

Property Value
Type	Description
`String`

MentionId

public string MentionId { get; set; }

Deprecated. Use id field instead.

Property Value
Type	Description
`String`

MentionText

public string MentionText { get; set; }

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

Property Value
Type	Description
`String`

PageAnchor

public Document.Types.PageAnchor PageAnchor { get; set; }

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

Property Value
Type	Description
`Document.Types.PageAnchor`

TextAnchor

public Document.Types.TextAnchor TextAnchor { get; set; }

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

Property Value
Type	Description
`Document.Types.TextAnchor`

Type

public string Type { get; set; }

Entity type from a schema e.g. Address.

Property Value
Type	Description
`String`