Package com.google.cloud.documentai.v1

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 Details

    • hasTextAnchor

      boolean hasTextAnchor()
       Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
      .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the textAnchor field is set.

    • getTextAnchor

      Document.TextAnchor getTextAnchor()
       Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
      .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The textAnchor.

    • getTextAnchorOrBuilder

      Document.TextAnchorOrBuilder getTextAnchorOrBuilder()
       Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
      .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

    • getType

      String getType()
       Required. Entity type from a schema, for example, `Address`.
      string type = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The type.

    • getTypeBytes

      com.google.protobuf.ByteString getTypeBytes()
       Required. Entity type from a schema, for example, `Address`.
      string type = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for type.

    • getMentionText

      String getMentionText()
       Optional. Text value of the entity, for example, `1600 Amphitheatre
 Pkwy`.
      string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The mentionText.

    • getMentionTextBytes

      com.google.protobuf.ByteString getMentionTextBytes()
       Optional. Text value of the entity, for example, `1600 Amphitheatre
 Pkwy`.
      string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for mentionText.

    • getMentionId

      String getMentionId()
       Optional. Deprecated.  Use `id` field instead.
      string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The mentionId.

    • getMentionIdBytes

      com.google.protobuf.ByteString getMentionIdBytes()
       Optional. Deprecated.  Use `id` field instead.
      string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];
      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.v1.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.v1.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.v1.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.

    • hasNormalizedValue

      boolean hasNormalizedValue()
       Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (for example, 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:
      Whether the normalizedValue field is set.

    • getNormalizedValue

      Document.Entity.NormalizedValue getNormalizedValue()
       Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (for example, 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:
      The normalizedValue.

    • getNormalizedValueOrBuilder

      Document.Entity.NormalizedValueOrBuilder getNormalizedValueOrBuilder()
       Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (for example, 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];

    • getPropertiesList

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

    • getProperties

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

    • getPropertiesCount

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

    • getPropertiesOrBuilderList

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

    • getPropertiesOrBuilder

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

    • hasProvenance

      boolean hasProvenance()
       Optional. The history of this annotation.
      .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the provenance field is set.

    • getProvenance

      Document.Provenance getProvenance()
       Optional. The history of this annotation.
      .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The provenance.

    • getProvenanceOrBuilder

      Document.ProvenanceOrBuilder getProvenanceOrBuilder()
       Optional. The history of this annotation.
      .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getRedacted

      boolean getRedacted()
       Optional. Whether the entity will be redacted for de-identification
 purposes.
      bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The redacted.

    • getMethodValue

      int getMethodValue()
       Optional. Specifies how the entity's value is obtained.
      .google.cloud.documentai.v1.Document.Entity.Method method = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for method.

    • getMethod

      Document.Entity.Method getMethod()
       Optional. Specifies how the entity's value is obtained.
      .google.cloud.documentai.v1.Document.Entity.Method method = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The method.