Class Document.Entity (2.37.0)

Version 2.37.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 final class Document.Entity extends GeneratedMessageV3 implements Document.EntityOrBuilder

An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.

Protobuf type google.cloud.documentai.v1.Document.Entity

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.Entity

Implements

Document.EntityOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

NORMALIZED_VALUE_FIELD_NUMBER

public static final int NORMALIZED_VALUE_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_ANCHOR_FIELD_NUMBER

public static final int PAGE_ANCHOR_FIELD_NUMBER

Field Value
Type	Description
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER

Field Value
Type	Description
int

PROVENANCE_FIELD_NUMBER

public static final int PROVENANCE_FIELD_NUMBER

Field Value
Type	Description
int

REDACTED_FIELD_NUMBER

public static final int REDACTED_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()

Returns
Type	Description
Document.Entity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Document.Entity.Builder newBuilder()

Returns
Type	Description
Document.Entity.Builder

newBuilder(Document.Entity prototype)

public static Document.Entity.Builder newBuilder(Document.Entity prototype)

Parameter
Name	Description
prototype	Document.Entity

Returns
Type	Description
Document.Entity.Builder

parseDelimitedFrom(InputStream input)

public static Document.Entity parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Document.Entity parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Entity parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Entity parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Document.Entity parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Document.Entity parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document.Entity

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Document.Entity> parser()

Returns
Type	Description
Parser<Entity>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

Returns
Type	Description
Document.Entity

getId()

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

Optional. Deprecated. Use id field instead.

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

Returns
Type	Description
String	The mentionId.

getMentionIdBytes()

public 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 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 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 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 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 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 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

getParserForType()

public Parser<Document.Entity> getParserForType()

Returns
Type	Description
Parser<Entity>

Overrides

GeneratedMessageV3.getParserForType()

getProperties(int index)

public 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 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 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 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 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 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 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 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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTextAnchor()

public 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Document.Entity.Builder newBuilderForType()

Returns
Type	Description
Document.Entity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Document.Entity.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Document.Entity.Builder toBuilder()

Returns
Type	Description
Document.Entity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException