Interface Document.EntityOrBuilder (2.23.0)

Version 2.23.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public static interface Document.EntityOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConfidence()

public abstract float getConfidence()

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

float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
float	The confidence.

getId()

public abstract String getId()

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

string id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The id.

getIdBytes()

public abstract ByteString getIdBytes()

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

string id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for id.

getMentionId()

public abstract String getMentionId()

Deprecated. Use id field instead.

string mention_id = 4;

Returns
Type	Description
String	The mentionId.

getMentionIdBytes()

public abstract ByteString getMentionIdBytes()

Deprecated. Use id field instead.

string mention_id = 4;

Returns
Type	Description
ByteString	The bytes for mentionId.

getMentionText()

public abstract String getMentionText()

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

string mention_text = 3;

Returns
Type	Description
String	The mentionText.

getMentionTextBytes()

public abstract ByteString getMentionTextBytes()

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

string mention_text = 3;

Returns
Type	Description
ByteString	The bytes for mentionText.

getPageAnchor()

public abstract Document.PageAnchor getPageAnchor()

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

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.PageAnchor	The pageAnchor.

getPageAnchorOrBuilder()

public abstract Document.PageAnchorOrBuilder getPageAnchorOrBuilder()

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

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.PageAnchorOrBuilder

getTextAnchor()

public abstract Document.TextAnchor getTextAnchor()

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

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;

Returns
Type	Description
Document.TextAnchor	The textAnchor.

getTextAnchorOrBuilder()

public abstract Document.TextAnchorOrBuilder getTextAnchorOrBuilder()

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

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;

Returns
Type	Description
Document.TextAnchorOrBuilder

getType()

public abstract String getType()

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

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The type.

getTypeBytes()

public abstract ByteString getTypeBytes()

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

string type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for type.

hasPageAnchor()

public abstract boolean hasPageAnchor()

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

.google.cloud.documentai.v1beta2.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the pageAnchor field is set.

hasTextAnchor()

public abstract boolean hasTextAnchor()

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

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;

Returns
Type	Description
boolean	Whether the textAnchor field is set.