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.v1beta3.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 | |
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()
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 |
data | byte[]
|
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 |
obj | Object
|
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];
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.v1beta3.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta3.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta3.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.v1beta3.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<Document.Entity> getParserForType()
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.v1beta3.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1beta3.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.v1beta3.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];
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.v1beta3.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
|
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.v1beta3.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.documentai.v1beta3.Document.EntityOrBuilder> | |
getProvenance()
public Document.Provenance getProvenance()
Optional. The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];
getProvenanceOrBuilder()
public Document.ProvenanceOrBuilder getProvenanceOrBuilder()
Optional. The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];
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
getTextAnchor()
public Document.TextAnchor getTextAnchor()
Optional. Provenance of the entity.
Text anchor indexing into the
Document.text.
.google.cloud.documentai.v1beta3.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
getTextAnchorOrBuilder()
public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()
Optional. Provenance of the entity.
Text anchor indexing into the
Document.text.
.google.cloud.documentai.v1beta3.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
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
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.v1beta3.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.v1beta3.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.v1beta3.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.v1beta3.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
| 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)
Overrides
toBuilder()
public Document.Entity.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
