public static final class Document.Entity extends com.google.protobuf.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| Modifier and Type | Class and Description |
|---|---|
static class |
Document.Entity.Builder
An entity that could be a phrase in the text or a property that belongs to
the document.
|
static class |
Document.Entity.NormalizedValue
Parsed and normalized entity value.
|
static interface |
Document.Entity.NormalizedValueOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CONFIDENCE_FIELD_NUMBER |
static int |
ID_FIELD_NUMBER |
static int |
MENTION_ID_FIELD_NUMBER |
static int |
MENTION_TEXT_FIELD_NUMBER |
static int |
NORMALIZED_VALUE_FIELD_NUMBER |
static int |
PAGE_ANCHOR_FIELD_NUMBER |
static int |
PROPERTIES_FIELD_NUMBER |
static int |
PROVENANCE_FIELD_NUMBER |
static int |
REDACTED_FIELD_NUMBER |
static int |
TEXT_ANCHOR_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
float |
getConfidence()
Optional.
|
static Document.Entity |
getDefaultInstance() |
Document.Entity |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getId()
Optional.
|
com.google.protobuf.ByteString |
getIdBytes()
Optional.
|
String |
getMentionId()
Optional.
|
com.google.protobuf.ByteString |
getMentionIdBytes()
Optional.
|
String |
getMentionText()
Optional.
|
com.google.protobuf.ByteString |
getMentionTextBytes()
Optional.
|
Document.Entity.NormalizedValue |
getNormalizedValue()
Optional.
|
Document.Entity.NormalizedValueOrBuilder |
getNormalizedValueOrBuilder()
Optional.
|
Document.PageAnchor |
getPageAnchor()
Optional.
|
Document.PageAnchorOrBuilder |
getPageAnchorOrBuilder()
Optional.
|
com.google.protobuf.Parser<Document.Entity> |
getParserForType() |
Document.Entity |
getProperties(int index)
Optional.
|
int |
getPropertiesCount()
Optional.
|
List<Document.Entity> |
getPropertiesList()
Optional.
|
Document.EntityOrBuilder |
getPropertiesOrBuilder(int index)
Optional.
|
List<? extends Document.EntityOrBuilder> |
getPropertiesOrBuilderList()
Optional.
|
Document.Provenance |
getProvenance()
Optional.
|
Document.ProvenanceOrBuilder |
getProvenanceOrBuilder()
Optional.
|
boolean |
getRedacted()
Optional.
|
int |
getSerializedSize() |
Document.TextAnchor |
getTextAnchor()
Optional.
|
Document.TextAnchorOrBuilder |
getTextAnchorOrBuilder()
Optional.
|
String |
getType()
Required.
|
com.google.protobuf.ByteString |
getTypeBytes()
Required.
|
int |
hashCode() |
boolean |
hasNormalizedValue()
Optional.
|
boolean |
hasPageAnchor()
Optional.
|
boolean |
hasProvenance()
Optional.
|
boolean |
hasTextAnchor()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Document.Entity.Builder |
newBuilder() |
static Document.Entity.Builder |
newBuilder(Document.Entity prototype) |
Document.Entity.Builder |
newBuilderForType() |
protected Document.Entity.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Document.Entity |
parseDelimitedFrom(InputStream input) |
static Document.Entity |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Entity |
parseFrom(byte[] data) |
static Document.Entity |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Entity |
parseFrom(ByteBuffer data) |
static Document.Entity |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Entity |
parseFrom(com.google.protobuf.ByteString data) |
static Document.Entity |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Entity |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Document.Entity |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Document.Entity |
parseFrom(InputStream input) |
static Document.Entity |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Document.Entity> |
parser() |
Document.Entity.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int TEXT_ANCHOR_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
public static final int MENTION_TEXT_FIELD_NUMBER
public static final int MENTION_ID_FIELD_NUMBER
public static final int CONFIDENCE_FIELD_NUMBER
public static final int PAGE_ANCHOR_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
public static final int NORMALIZED_VALUE_FIELD_NUMBER
public static final int PROPERTIES_FIELD_NUMBER
public static final int PROVENANCE_FIELD_NUMBER
public static final int REDACTED_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean hasTextAnchor()
Optional. Provenance of the entity. Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text].
.google.cloud.documentai.v1beta3.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
hasTextAnchor in interface Document.EntityOrBuilderpublic Document.TextAnchor getTextAnchor()
Optional. Provenance of the entity. Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text].
.google.cloud.documentai.v1beta3.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
getTextAnchor in interface Document.EntityOrBuilderpublic Document.TextAnchorOrBuilder getTextAnchorOrBuilder()
Optional. Provenance of the entity. Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta3.Document.text].
.google.cloud.documentai.v1beta3.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
getTextAnchorOrBuilder in interface Document.EntityOrBuilderpublic String getType()
Required. Entity type from a schema e.g. `Address`.
string type = 2 [(.google.api.field_behavior) = REQUIRED];getType in interface Document.EntityOrBuilderpublic com.google.protobuf.ByteString getTypeBytes()
Required. Entity type from a schema e.g. `Address`.
string type = 2 [(.google.api.field_behavior) = REQUIRED];getTypeBytes in interface Document.EntityOrBuilderpublic String getMentionText()
Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];getMentionText in interface Document.EntityOrBuilderpublic com.google.protobuf.ByteString getMentionTextBytes()
Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];getMentionTextBytes in interface Document.EntityOrBuilderpublic String getMentionId()
Optional. Deprecated. Use `id` field instead.
string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];getMentionId in interface Document.EntityOrBuilderpublic com.google.protobuf.ByteString getMentionIdBytes()
Optional. Deprecated. Use `id` field instead.
string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];getMentionIdBytes in interface Document.EntityOrBuilderpublic float getConfidence()
Optional. Confidence of detected Schema entity. Range `[0, 1]`.
float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];getConfidence in interface Document.EntityOrBuilderpublic 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];
hasPageAnchor in interface Document.EntityOrBuilderpublic 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];
getPageAnchor in interface Document.EntityOrBuilderpublic 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];
getPageAnchorOrBuilder in interface Document.EntityOrBuilderpublic 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];getId in interface Document.EntityOrBuilderpublic com.google.protobuf.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];getIdBytes in interface Document.EntityOrBuilderpublic 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];
hasNormalizedValue in interface Document.EntityOrBuilderpublic 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];
getNormalizedValue in interface Document.EntityOrBuilderpublic 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];
getNormalizedValueOrBuilder in interface Document.EntityOrBuilderpublic 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];
getPropertiesList in interface Document.EntityOrBuilderpublic 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];
getPropertiesOrBuilderList in interface Document.EntityOrBuilderpublic 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];
getPropertiesCount in interface Document.EntityOrBuilderpublic 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];
getProperties in interface Document.EntityOrBuilderpublic 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];
getPropertiesOrBuilder in interface Document.EntityOrBuilderpublic boolean hasProvenance()
Optional. The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];
hasProvenance in interface Document.EntityOrBuilderpublic Document.Provenance getProvenance()
Optional. The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];
getProvenance in interface Document.EntityOrBuilderpublic Document.ProvenanceOrBuilder getProvenanceOrBuilder()
Optional. The history of this annotation.
.google.cloud.documentai.v1beta3.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];
getProvenanceOrBuilder in interface Document.EntityOrBuilderpublic boolean getRedacted()
Optional. Whether the entity will be redacted for de-identification purposes.
bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL];getRedacted in interface Document.EntityOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Document.Entity parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Entity parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Entity parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Entity parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Entity parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Entity parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document.Entity parseFrom(InputStream input) throws IOException
IOExceptionpublic static Document.Entity parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Document.Entity parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Document.Entity parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Document.Entity parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Document.Entity parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Document.Entity.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Document.Entity.Builder newBuilder()
public static Document.Entity.Builder newBuilder(Document.Entity prototype)
public Document.Entity.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Document.Entity.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Document.Entity getDefaultInstance()
public static com.google.protobuf.Parser<Document.Entity> parser()
public com.google.protobuf.Parser<Document.Entity> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Document.Entity getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.