Class Document.Entity (2.39.0)

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.v1beta2.Document.Entity

Static Fields

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

MENTION_ID_FIELD_NUMBER

public static final int MENTION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

MENTION_TEXT_FIELD_NUMBER

public static final int MENTION_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

NORMALIZED_VALUE_FIELD_NUMBER

public static final int NORMALIZED_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_ANCHOR_FIELD_NUMBER

public static final int PAGE_ANCHOR_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER
Field Value
TypeDescription
int

PROVENANCE_FIELD_NUMBER

public static final int PROVENANCE_FIELD_NUMBER
Field Value
TypeDescription
int

REDACTED_FIELD_NUMBER

public static final int REDACTED_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_ANCHOR_FIELD_NUMBER

public static final int TEXT_ANCHOR_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Document.Entity getDefaultInstance()
Returns
TypeDescription
Document.Entity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Document.Entity.Builder newBuilder()
Returns
TypeDescription
Document.Entity.Builder

newBuilder(Document.Entity prototype)

public static Document.Entity.Builder newBuilder(Document.Entity prototype)
Parameter
NameDescription
prototypeDocument.Entity
Returns
TypeDescription
Document.Entity.Builder

parseDelimitedFrom(InputStream input)

public static Document.Entity parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Document.Entity parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Entity parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Entity parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Document.Entity parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Document.Entity parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Entity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Entity
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Document.Entity> parser()
Returns
TypeDescription
Parser<Entity>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getConfidence()

public float getConfidence()

Optional. Confidence of detected Schema entity. Range [0, 1].

float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public Document.Entity getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
String

The mentionId.

getMentionIdBytes()

public ByteString getMentionIdBytes()

Optional. Deprecated. Use id field instead.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

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

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

Returns
TypeDescription
Document.PageAnchorOrBuilder

getParserForType()

public Parser<Document.Entity> getParserForType()
Returns
TypeDescription
Parser<Entity>
Overrides

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.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
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.v1beta2.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta2.Document.EntityOrBuilder>

getProvenance()

public Document.Provenance getProvenance()

Optional. The history of this annotation.

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

Returns
TypeDescription
Document.Provenance

The provenance.

getProvenanceOrBuilder()

public Document.ProvenanceOrBuilder getProvenanceOrBuilder()

Optional. The history of this annotation.

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

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

The redacted.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTextAnchor()

public Document.TextAnchor getTextAnchor()

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

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

Returns
TypeDescription
Document.TextAnchor

The textAnchor.

getTextAnchorOrBuilder()

public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()

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

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

Returns
TypeDescription
Document.TextAnchorOrBuilder

getType()

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

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.v1beta2.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
TypeDescription
boolean

Whether the pageAnchor field is set.

hasProvenance()

public boolean hasProvenance()

Optional. The history of this annotation.

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

Returns
TypeDescription
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.v1beta2.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the textAnchor field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Document.Entity.Builder newBuilderForType()
Returns
TypeDescription
Document.Entity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Entity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Document.Entity.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Document.Entity.Builder toBuilder()
Returns
TypeDescription
Document.Entity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException