Send feedback
Class Document.Entity (2.18.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.18.0keyboard_arrow_down
public static final class Document . Entity extends GeneratedMessageV3 implements Document . EntityOrBuilder
A phrase in the text that is a known entity type, such as a person, an
organization, or location.
Protobuf type google.cloud.documentai.v1beta2.Document.Entity
Static Fields
CONFIDENCE_FIELD_NUMBER
public static final int CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
Type Description
int
MENTION_ID_FIELD_NUMBER
public static final int MENTION_ID_FIELD_NUMBER
Field Value
Type Description
int
MENTION_TEXT_FIELD_NUMBER
public static final int MENTION_TEXT_FIELD_NUMBER
Field Value
Type Description
int
PAGE_ANCHOR_FIELD_NUMBER
public static final int PAGE_ANCHOR_FIELD_NUMBER
Field Value
Type Description
int
TEXT_ANCHOR_FIELD_NUMBER
public static final int TEXT_ANCHOR_FIELD_NUMBER
Field Value
Type Description
int
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Document . Entity getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Document . Entity . Builder newBuilder ()
newBuilder(Document.Entity prototype)
public static Document . Entity . Builder newBuilder ( Document . Entity prototype )
public static Document . Entity parseDelimitedFrom ( InputStream input )
public static Document . Entity parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Document . Entity parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document . Entity parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Document . Entity parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document . Entity parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Document . Entity parseFrom ( CodedInputStream input )
public static Document . Entity parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Document . Entity parseFrom ( InputStream input )
public static Document . Entity parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Document . Entity parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document . Entity parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Document . Entity > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getConfidence()
public 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.
getDefaultInstanceForType()
public Document . Entity getDefaultInstanceForType ()
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 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 String getMentionId ()
Deprecated. Use id field instead.
string mention_id = 4;
Returns
Type Description
String The mentionId.
getMentionIdBytes()
public ByteString getMentionIdBytes ()
Deprecated. Use id field instead.
string mention_id = 4;
Returns
Type Description
ByteString The bytes for mentionId.
getMentionText()
public String getMentionText ()
Text value in the document e.g. 1600 Amphitheatre Pkwy.
string mention_text = 3;
Returns
Type Description
String The mentionText.
getMentionTextBytes()
public 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 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];
getPageAnchorOrBuilder()
public 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];
getParserForType()
public Parser<Document . Entity > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getTextAnchor()
public Document . TextAnchor getTextAnchor ()
Provenance of the entity.
Text anchor indexing into the Document.text .
.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;
getTextAnchorOrBuilder()
public Document . TextAnchorOrBuilder getTextAnchorOrBuilder ()
Provenance of the entity.
Text anchor indexing into the Document.text .
.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;
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 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.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hasPageAnchor()
public 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 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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Document . Entity . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document . Entity . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Document . Entity . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-26 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-26 UTC."],[],[]]
