Interface Document.EntityOrBuilder (2.10.0)

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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for id.

getMentionId()

public abstract String getMentionId()

Deprecated. Use id field instead.

string mention_id = 4;

Returns
TypeDescription
String

The mentionId.

getMentionIdBytes()

public abstract ByteString getMentionIdBytes()

Deprecated. Use id field instead.

string mention_id = 4;

Returns
TypeDescription
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
TypeDescription
String

The mentionText.

getMentionTextBytes()

public abstract ByteString getMentionTextBytes()

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

string mention_text = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the textAnchor field is set.