Class Document.Types.Entity (2.0.0)

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

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.

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

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

Entity()

public Entity()

Entity(Document.Types.Entity)

public Entity(Document.Types.Entity other)

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

Properties

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; }

Optional. Deprecated. Use id field instead.

Property Value
Type	Description
`String`

MentionText

public string MentionText { get; set; }

Optional. Text value in the document e.g. 1600 Amphitheatre Pkwy. If the entity is not present in the document, this field will be empty.

Property Value
Type	Description
`String`

NormalizedValue

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.

Property Value
Type	Description
`Document.Types.Entity.Types.NormalizedValue`

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`

Properties

public RepeatedField<Document.Types.Entity> Properties { get; }

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

Property Value
Type	Description
`RepeatedField<Document.Types.Entity>`

Provenance

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

Optional. The history of this annotation.

Property Value
Type	Description
`Document.Types.Provenance`

Redacted

public bool Redacted { get; set; }

Optional. Whether the entity will be redacted for de-identification purposes.

Property Value
Type	Description
`Boolean`

TextAnchor

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

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

Property Value
Type	Description
`Document.Types.TextAnchor`

Type

public string Type { get; set; }

Required. Entity type from a schema e.g. Address.

Property Value
Type	Description
`String`