Send feedback
Class Document.Entity (2.9.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.9.0 keyboard_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.v1beta1.Document.Entity
Static Fields
MENTION_ID_FIELD_NUMBER
public static final int MENTION_ID_FIELD_NUMBER
Field Value
MENTION_TEXT_FIELD_NUMBER
public static final int MENTION_TEXT_FIELD_NUMBER
Field Value
TEXT_ANCHOR_FIELD_NUMBER
public static final int TEXT_ANCHOR_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Document . Entity getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Document . Entity . Builder newBuilder ()
Returns
newBuilder(Document.Entity prototype)
public static Document . Entity . Builder newBuilder ( Document . Entity prototype )
Parameter
Returns
public static Document . Entity parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Document . Entity parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Document . Entity parseFrom ( byte [] data )
Parameter
Name Description data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document . Entity parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Document . Entity parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document . Entity parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Document . Entity parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Document . Entity parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Document . Entity parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Document . Entity parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Document . Entity parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document . Entity parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Document . Entity > parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Document . Entity getDefaultInstanceForType ()
Returns
getMentionId()
public String getMentionId ()
Canonical mention name. This will be a unique value in the entity list
for this document.
string mention_id = 4;
Returns
Type Description String The mentionId.
getMentionIdBytes()
public ByteString getMentionIdBytes ()
Canonical mention name. This will be a unique value in the entity list
for this document.
string mention_id = 4;
Returns
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.
getParserForType()
public Parser<Document . Entity > getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getTextAnchor()
public Document . TextAnchor getTextAnchor ()
Provenance of the entity.
Text anchor indexing into the
Document.text .
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
Returns
getTextAnchorOrBuilder()
public Document . TextAnchorOrBuilder getTextAnchorOrBuilder ()
Provenance of the entity.
Text anchor indexing into the
Document.text .
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
Returns
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hasTextAnchor()
public boolean hasTextAnchor ()
Provenance of the entity.
Text anchor indexing into the
Document.text .
.google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
Returns
Type Description boolean Whether the textAnchor field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Document . Entity . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document . Entity . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Document . Entity . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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-02-14 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-02-14 UTC."],[],[]]
