com.google.cloud.documentai.v1beta2

Interface Document.EntityOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Document.Entity, Document.Entity.Builder

Enclosing class:

Document

public static interface Document.EntityOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
BoundingPoly	getBoundingPolyForDemoFrontend() Optional.
BoundingPolyOrBuilder	getBoundingPolyForDemoFrontendOrBuilder() Optional.
float	getConfidence() Optional.
String	getId() Optional.
com.google.protobuf.ByteString	getIdBytes() Optional.
String	getMentionId() Deprecated.
com.google.protobuf.ByteString	getMentionIdBytes() Deprecated.
String	getMentionText() Text value in the document e.g.
com.google.protobuf.ByteString	getMentionTextBytes() Text value in the document e.g.
Document.PageAnchor	getPageAnchor() Optional.
Document.PageAnchorOrBuilder	getPageAnchorOrBuilder() Optional.
Document.TextAnchor	getTextAnchor() Provenance of the entity.
Document.TextAnchorOrBuilder	getTextAnchorOrBuilder() Provenance of the entity.
String	getType() Entity type from a schema e.g.
com.google.protobuf.ByteString	getTypeBytes() Entity type from a schema e.g.
boolean	hasBoundingPolyForDemoFrontend() Optional.
boolean	hasPageAnchor() Optional.
boolean	hasTextAnchor() Provenance of the entity.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasTextAnchor

boolean hasTextAnchor()

 Provenance of the entity.
 Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;

Returns:

Whether the textAnchor field is set.

getTextAnchor

Document.TextAnchor getTextAnchor()

 Provenance of the entity.
 Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;

Returns:

The textAnchor.

getTextAnchorOrBuilder

Document.TextAnchorOrBuilder getTextAnchorOrBuilder()

 Provenance of the entity.
 Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
 

.google.cloud.documentai.v1beta2.Document.TextAnchor text_anchor = 1;

getType

String getType()

 Entity type from a schema e.g. `Address`.
 

string type = 2;

Returns:

The type.

getTypeBytes

com.google.protobuf.ByteString getTypeBytes()

 Entity type from a schema e.g. `Address`.
 

string type = 2;

Returns:

The bytes for type.

getMentionText

String getMentionText()

 Text value in the document e.g. `1600 Amphitheatre Pkwy`.
 

string mention_text = 3;

Returns:

The mentionText.

getMentionTextBytes

com.google.protobuf.ByteString getMentionTextBytes()

 Text value in the document e.g. `1600 Amphitheatre Pkwy`.
 

string mention_text = 3;

Returns:

The bytes for mentionText.

getMentionId

String getMentionId()

 Deprecated.  Use `id` field instead.
 

string mention_id = 4;

Returns:

The mentionId.

getMentionIdBytes

com.google.protobuf.ByteString getMentionIdBytes()

 Deprecated.  Use `id` field instead.
 

string mention_id = 4;

Returns:

The bytes for mentionId.

getConfidence

float getConfidence()

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

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

Returns:

The confidence.

hasPageAnchor

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:

Whether the pageAnchor field is set.

getPageAnchor

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:

The pageAnchor.

getPageAnchorOrBuilder

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];

getId

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:

The id.

getIdBytes

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];

Returns:

The bytes for id.

hasBoundingPolyForDemoFrontend

boolean hasBoundingPolyForDemoFrontend()

 Optional. Temporary field to store the bounding poly for short-term POCs. Used by
 the frontend only. Do not use before you talk to ybo@ and lukasr@.
 

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the boundingPolyForDemoFrontend field is set.

getBoundingPolyForDemoFrontend

BoundingPoly getBoundingPolyForDemoFrontend()

 Optional. Temporary field to store the bounding poly for short-term POCs. Used by
 the frontend only. Do not use before you talk to ybo@ and lukasr@.
 

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The boundingPolyForDemoFrontend.

getBoundingPolyForDemoFrontendOrBuilder

BoundingPolyOrBuilder getBoundingPolyForDemoFrontendOrBuilder()

 Optional. Temporary field to store the bounding poly for short-term POCs. Used by
 the frontend only. Do not use before you talk to ybo@ and lukasr@.
 

.google.cloud.documentai.v1beta2.BoundingPoly bounding_poly_for_demo_frontend = 8 [(.google.api.field_behavior) = OPTIONAL];