Class GoogleCloudDocumentaiV1DocumentEntity

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

GoogleCloudDocumentaiV1DocumentEntity

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Document.v1.Data

Assembly: Google.Apis.Document.v1.dll

Syntax

public class GoogleCloudDocumentaiV1DocumentEntity : IDirectResponseSchema

Properties

Confidence

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

Declaration

[JsonProperty("confidence")]
public virtual float? Confidence { get; set; }

Property Value

Type	Description
float?

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Id

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

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

MentionId

Optional. Deprecated. Use id field instead.

Declaration

[JsonProperty("mentionId")]
public virtual string MentionId { get; set; }

Property Value

Type	Description
string

MentionText

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

Declaration

[JsonProperty("mentionText")]
public virtual string MentionText { get; set; }

Property Value

Type	Description
string

NormalizedValue

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.

Declaration

[JsonProperty("normalizedValue")]
public virtual GoogleCloudDocumentaiV1DocumentEntityNormalizedValue NormalizedValue { get; set; }

Property Value

Type	Description
GoogleCloudDocumentaiV1DocumentEntityNormalizedValue

PageAnchor

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

Declaration

[JsonProperty("pageAnchor")]
public virtual GoogleCloudDocumentaiV1DocumentPageAnchor PageAnchor { get; set; }

Property Value

Type	Description
GoogleCloudDocumentaiV1DocumentPageAnchor

Properties

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

Declaration

[JsonProperty("properties")]
public virtual IList<GoogleCloudDocumentaiV1DocumentEntity> Properties { get; set; }

Property Value

Type	Description
IList<GoogleCloudDocumentaiV1DocumentEntity>

Provenance

Optional. The history of this annotation.

Declaration

[JsonProperty("provenance")]
public virtual GoogleCloudDocumentaiV1DocumentProvenance Provenance { get; set; }

Property Value

Type	Description
GoogleCloudDocumentaiV1DocumentProvenance

Redacted

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

Declaration

[JsonProperty("redacted")]
public virtual bool? Redacted { get; set; }

Property Value

Type	Description
bool?

TextAnchor

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

Declaration

[JsonProperty("textAnchor")]
public virtual GoogleCloudDocumentaiV1DocumentTextAnchor TextAnchor { get; set; }

Property Value

Type	Description
GoogleCloudDocumentaiV1DocumentTextAnchor

Type

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

Declaration

[JsonProperty("type")]
public virtual string Type { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema