Interface Document.EntityOrBuilder (2.57.0)

Version latest

• 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()

Optional. Deprecated. Use id field instead.

string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The mentionId.

getMentionIdBytes()

public abstract ByteString getMentionIdBytes()

Optional. Deprecated. Use id field instead.

string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for mentionId.

getMentionText()

public abstract String getMentionText()

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

string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The mentionText.

getMentionTextBytes()

public abstract ByteString getMentionTextBytes()

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

string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for mentionText.

getNormalizedValue()

public abstract Document.Entity.NormalizedValue getNormalizedValue()

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.

.google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.Entity.NormalizedValue	The normalizedValue.

getNormalizedValueOrBuilder()

public abstract Document.Entity.NormalizedValueOrBuilder getNormalizedValueOrBuilder()

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.

.google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.Entity.NormalizedValueOrBuilder

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.v1.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.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.PageAnchorOrBuilder

getProperties(int index)

public abstract Document.Entity getProperties(int index)

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

repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Entity

getPropertiesCount()

public abstract int getPropertiesCount()

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

repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getPropertiesList()

public abstract List<Document.Entity> getPropertiesList()

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

repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Entity>

getPropertiesOrBuilder(int index)

public abstract Document.EntityOrBuilder getPropertiesOrBuilder(int index)

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

repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
Document.EntityOrBuilder

getPropertiesOrBuilderList()

public abstract List<? extends Document.EntityOrBuilder> getPropertiesOrBuilderList()

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

repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1.Document.EntityOrBuilder>

getProvenance()

public abstract Document.Provenance getProvenance()

Optional. The history of this annotation.

.google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.Provenance	The provenance.

getProvenanceOrBuilder()

public abstract Document.ProvenanceOrBuilder getProvenanceOrBuilder()

Optional. The history of this annotation.

.google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.ProvenanceOrBuilder

getRedacted()

public abstract boolean getRedacted()

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

bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The redacted.

getTextAnchor()

public abstract Document.TextAnchor getTextAnchor()

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

.google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Document.TextAnchor	The textAnchor.

getTextAnchorOrBuilder()

public abstract Document.TextAnchorOrBuilder getTextAnchorOrBuilder()

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

.google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

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.

hasNormalizedValue()

public abstract boolean hasNormalizedValue()

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.

.google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the normalizedValue field is set.

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.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the pageAnchor field is set.

hasProvenance()

public abstract boolean hasProvenance()

Optional. The history of this annotation.

.google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the provenance field is set.

hasTextAnchor()

public abstract boolean hasTextAnchor()

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

.google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the textAnchor field is set.