Cloud Document AI v1beta3 API - Class Document.Types.Entity (2.0.0-beta23)

Version latest

• 2.0.0-beta23 (latest)
• 2.0.0-beta22
• 1.0.0-beta04

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.

Inheritance

object > Document.Types.Entity

Implements

IMessageDocumentTypesEntity, IEquatableDocumentTypesEntity, IDeepCloneableDocumentTypesEntity, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

Entity()

public Entity()

Entity(Entity)

public Entity(Document.Types.Entity other)

Parameter
Name	Description
other	DocumentTypesEntity

Properties

Confidence

public float Confidence { get; set; }

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

Property Value
Type	Description
float

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 of the entity e.g. 1600 Amphitheatre Pkwy.

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
DocumentTypesEntityTypesNormalizedValue

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
DocumentTypesPageAnchor

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
RepeatedFieldDocumentTypesEntity

Provenance

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

Optional. The history of this annotation.

Property Value
Type	Description
DocumentTypesProvenance

Redacted

public bool Redacted { get; set; }

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

Property Value
Type	Description
bool

TextAnchor

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

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

Property Value
Type	Description
DocumentTypesTextAnchor

Type

public string Type { get; set; }

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

Property Value
Type	Description
string