Package com.google.cloud.documentai.v1

Interface DocumentOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Document, Document.Builder
@Generated public interface DocumentOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasUri

      boolean hasUri()
       Optional. Currently supports Google Cloud Storage URI of the form
 `gs://bucket_name/object_name`. Object versioning is not supported.
 For more information, refer to [Google Cloud Storage Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).
      string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the uri field is set.

    • getUri

      String getUri()
       Optional. Currently supports Google Cloud Storage URI of the form
 `gs://bucket_name/object_name`. Object versioning is not supported.
 For more information, refer to [Google Cloud Storage Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).
      string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The uri.

    • getUriBytes

      com.google.protobuf.ByteString getUriBytes()
       Optional. Currently supports Google Cloud Storage URI of the form
 `gs://bucket_name/object_name`. Object versioning is not supported.
 For more information, refer to [Google Cloud Storage Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).
      string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for uri.

    • hasContent

      boolean hasContent()
       Optional. Inline document content, represented as a stream of bytes.
 Note: As with all `bytes` fields, protobuffers use a pure binary
 representation, whereas JSON representations use base64.
      bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the content field is set.

    • getContent

      com.google.protobuf.ByteString getContent()
       Optional. Inline document content, represented as a stream of bytes.
 Note: As with all `bytes` fields, protobuffers use a pure binary
 representation, whereas JSON representations use base64.
      bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The content.

    • getDocid

      String getDocid()
       Optional. An internal identifier for document. Should be loggable (no PII).
      string docid = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The docid.

    • getDocidBytes

      com.google.protobuf.ByteString getDocidBytes()
       Optional. An internal identifier for document. Should be loggable (no PII).
      string docid = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for docid.

    • getMimeType

      String getMimeType()
       An IANA published [media type (MIME
 type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
      string mime_type = 3;
      Returns:
      The mimeType.

    • getMimeTypeBytes

      com.google.protobuf.ByteString getMimeTypeBytes()
       An IANA published [media type (MIME
 type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
      string mime_type = 3;
      Returns:
      The bytes for mimeType.

    • getText

      String getText()
       Optional. UTF-8 encoded text in reading order from the document.
      string text = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The text.

    • getTextBytes

      com.google.protobuf.ByteString getTextBytes()
       Optional. UTF-8 encoded text in reading order from the document.
      string text = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for text.

    • getTextStylesList

      @Deprecated List<Document.Style> getTextStylesList()
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];

    • getTextStyles

      @Deprecated Document.Style getTextStyles(int index)
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];

    • getTextStylesCount

      @Deprecated int getTextStylesCount()
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];

    • getTextStylesOrBuilderList

      @Deprecated List<? extends Document.StyleOrBuilder> getTextStylesOrBuilderList()
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];

    • getTextStylesOrBuilder

      @Deprecated Document.StyleOrBuilder getTextStylesOrBuilder(int index)
      Deprecated.
       Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
      repeated .google.cloud.documentai.v1.Document.Style text_styles = 5 [deprecated = true];

    • getPagesList

      List<Document.Page> getPagesList()
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;

    • getPages

      Document.Page getPages(int index)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;

    • getPagesCount

      int getPagesCount()
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;

    • getPagesOrBuilderList

      List<? extends Document.PageOrBuilder> getPagesOrBuilderList()
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;

    • getPagesOrBuilder

      Document.PageOrBuilder getPagesOrBuilder(int index)
       Visual page layout for the [Document][google.cloud.documentai.v1.Document].
      repeated .google.cloud.documentai.v1.Document.Page pages = 6;

    • getEntitiesList

      List<Document.Entity> getEntitiesList()
       A list of entities detected on
 [Document.text][google.cloud.documentai.v1.Document.text]. For document
 shards, entities in this list may cross shard boundaries.
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;

    • getEntities

      Document.Entity getEntities(int index)
       A list of entities detected on
 [Document.text][google.cloud.documentai.v1.Document.text]. For document
 shards, entities in this list may cross shard boundaries.
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;

    • getEntitiesCount

      int getEntitiesCount()
       A list of entities detected on
 [Document.text][google.cloud.documentai.v1.Document.text]. For document
 shards, entities in this list may cross shard boundaries.
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;

    • getEntitiesOrBuilderList

      List<? extends Document.EntityOrBuilder> getEntitiesOrBuilderList()
       A list of entities detected on
 [Document.text][google.cloud.documentai.v1.Document.text]. For document
 shards, entities in this list may cross shard boundaries.
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;

    • getEntitiesOrBuilder

      Document.EntityOrBuilder getEntitiesOrBuilder(int index)
       A list of entities detected on
 [Document.text][google.cloud.documentai.v1.Document.text]. For document
 shards, entities in this list may cross shard boundaries.
      repeated .google.cloud.documentai.v1.Document.Entity entities = 7;

    • getEntityRelationsList

      List<Document.EntityRelation> getEntityRelationsList()
       Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1.Document.entities].
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;

    • getEntityRelations

      Document.EntityRelation getEntityRelations(int index)
       Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1.Document.entities].
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;

    • getEntityRelationsCount

      int getEntityRelationsCount()
       Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1.Document.entities].
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;

    • getEntityRelationsOrBuilderList

      List<? extends Document.EntityRelationOrBuilder> getEntityRelationsOrBuilderList()
       Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1.Document.entities].
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;

    • getEntityRelationsOrBuilder

      Document.EntityRelationOrBuilder getEntityRelationsOrBuilder(int index)
       Placeholder.  Relationship among
 [Document.entities][google.cloud.documentai.v1.Document.entities].
      repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;

    • getTextChangesList

      List<Document.TextChange> getTextChangesList()
       Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
 used for annotating corrections to OCR mistakes.  Text changes for a given
 revision may not overlap with each other.
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;

    • getTextChanges

      Document.TextChange getTextChanges(int index)
       Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
 used for annotating corrections to OCR mistakes.  Text changes for a given
 revision may not overlap with each other.
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;

    • getTextChangesCount

      int getTextChangesCount()
       Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
 used for annotating corrections to OCR mistakes.  Text changes for a given
 revision may not overlap with each other.
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;

    • getTextChangesOrBuilderList

      List<? extends Document.TextChangeOrBuilder> getTextChangesOrBuilderList()
       Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
 used for annotating corrections to OCR mistakes.  Text changes for a given
 revision may not overlap with each other.
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;

    • getTextChangesOrBuilder

      Document.TextChangeOrBuilder getTextChangesOrBuilder(int index)
       Placeholder.  A list of text corrections made to
 [Document.text][google.cloud.documentai.v1.Document.text].  This is usually
 used for annotating corrections to OCR mistakes.  Text changes for a given
 revision may not overlap with each other.
      repeated .google.cloud.documentai.v1.Document.TextChange text_changes = 14;

    • hasShardInfo

      boolean hasShardInfo()
       Information about the sharding if this document is sharded part of a larger
 document. If the document is not sharded, this message is not specified.
      .google.cloud.documentai.v1.Document.ShardInfo shard_info = 9;
      Returns:
      Whether the shardInfo field is set.

    • getShardInfo

      Document.ShardInfo getShardInfo()
       Information about the sharding if this document is sharded part of a larger
 document. If the document is not sharded, this message is not specified.
      .google.cloud.documentai.v1.Document.ShardInfo shard_info = 9;
      Returns:
      The shardInfo.

    • getShardInfoOrBuilder

      Document.ShardInfoOrBuilder getShardInfoOrBuilder()
       Information about the sharding if this document is sharded part of a larger
 document. If the document is not sharded, this message is not specified.
      .google.cloud.documentai.v1.Document.ShardInfo shard_info = 9;

    • hasError

      boolean hasError()
       Any error that occurred while processing this document.
      .google.rpc.Status error = 10;
      Returns:
      Whether the error field is set.

    • getError

      Status getError()
       Any error that occurred while processing this document.
      .google.rpc.Status error = 10;
      Returns:
      The error.

    • getErrorOrBuilder

      StatusOrBuilder getErrorOrBuilder()
       Any error that occurred while processing this document.
      .google.rpc.Status error = 10;

    • getRevisionsList

      List<Document.Revision> getRevisionsList()
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;

    • getRevisions

      Document.Revision getRevisions(int index)
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;

    • getRevisionsCount

      int getRevisionsCount()
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;

    • getRevisionsOrBuilderList

      List<? extends Document.RevisionOrBuilder> getRevisionsOrBuilderList()
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;

    • getRevisionsOrBuilder

      Document.RevisionOrBuilder getRevisionsOrBuilder(int index)
       Placeholder. Revision history of this document.
      repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;

    • hasDocumentLayout

      boolean hasDocumentLayout()
       Parsed layout of the document.
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
      Returns:
      Whether the documentLayout field is set.

    • getDocumentLayout

      Document.DocumentLayout getDocumentLayout()
       Parsed layout of the document.
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;
      Returns:
      The documentLayout.

    • getDocumentLayoutOrBuilder

      Document.DocumentLayoutOrBuilder getDocumentLayoutOrBuilder()
       Parsed layout of the document.
      .google.cloud.documentai.v1.Document.DocumentLayout document_layout = 17;

    • hasChunkedDocument

      boolean hasChunkedDocument()
       Document chunked based on chunking config.
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
      Returns:
      Whether the chunkedDocument field is set.

    • getChunkedDocument

      Document.ChunkedDocument getChunkedDocument()
       Document chunked based on chunking config.
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;
      Returns:
      The chunkedDocument.

    • getChunkedDocumentOrBuilder

      Document.ChunkedDocumentOrBuilder getChunkedDocumentOrBuilder()
       Document chunked based on chunking config.
      .google.cloud.documentai.v1.Document.ChunkedDocument chunked_document = 18;

    • getBlobAssetsList

      List<Document.BlobAsset> getBlobAssetsList()
       Optional. The blob assets in this document. This is used to store the
 content of the inline blobs in this document, for example, image bytes,
 such that it can be referenced by other fields in the document via asset
 id.
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];

    • getBlobAssets

      Document.BlobAsset getBlobAssets(int index)
       Optional. The blob assets in this document. This is used to store the
 content of the inline blobs in this document, for example, image bytes,
 such that it can be referenced by other fields in the document via asset
 id.
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];

    • getBlobAssetsCount

      int getBlobAssetsCount()
       Optional. The blob assets in this document. This is used to store the
 content of the inline blobs in this document, for example, image bytes,
 such that it can be referenced by other fields in the document via asset
 id.
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];

    • getBlobAssetsOrBuilderList

      List<? extends Document.BlobAssetOrBuilder> getBlobAssetsOrBuilderList()
       Optional. The blob assets in this document. This is used to store the
 content of the inline blobs in this document, for example, image bytes,
 such that it can be referenced by other fields in the document via asset
 id.
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];

    • getBlobAssetsOrBuilder

      Document.BlobAssetOrBuilder getBlobAssetsOrBuilder(int index)
       Optional. The blob assets in this document. This is used to store the
 content of the inline blobs in this document, for example, image bytes,
 such that it can be referenced by other fields in the document via asset
 id.
      repeated .google.cloud.documentai.v1.Document.BlobAsset blob_assets = 19 [(.google.api.field_behavior) = OPTIONAL];

    • hasEntityValidationOutput

      boolean hasEntityValidationOutput()
       The entity validation output for the document. This is the validation
 output for `document.entities` field.
      .google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;
      Returns:
      Whether the entityValidationOutput field is set.

    • getEntityValidationOutput

      Document.EntityValidationOutput getEntityValidationOutput()
       The entity validation output for the document. This is the validation
 output for `document.entities` field.
      .google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;
      Returns:
      The entityValidationOutput.

    • getEntityValidationOutputOrBuilder

      Document.EntityValidationOutputOrBuilder getEntityValidationOutputOrBuilder()
       The entity validation output for the document. This is the validation
 output for `document.entities` field.
      .google.cloud.documentai.v1.Document.EntityValidationOutput entity_validation_output = 21;

    • getEntitiesRevisionsList

      List<Document.EntitiesRevision> getEntitiesRevisionsList()
       A list of entity revisions. The entity revisions are appended to the
 document in the processing order. This field can be used for comparing the
 entity extraction results at different stages of the processing.
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;

    • getEntitiesRevisions

      Document.EntitiesRevision getEntitiesRevisions(int index)
       A list of entity revisions. The entity revisions are appended to the
 document in the processing order. This field can be used for comparing the
 entity extraction results at different stages of the processing.
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;

    • getEntitiesRevisionsCount

      int getEntitiesRevisionsCount()
       A list of entity revisions. The entity revisions are appended to the
 document in the processing order. This field can be used for comparing the
 entity extraction results at different stages of the processing.
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;

    • getEntitiesRevisionsOrBuilderList

      List<? extends Document.EntitiesRevisionOrBuilder> getEntitiesRevisionsOrBuilderList()
       A list of entity revisions. The entity revisions are appended to the
 document in the processing order. This field can be used for comparing the
 entity extraction results at different stages of the processing.
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;

    • getEntitiesRevisionsOrBuilder

      Document.EntitiesRevisionOrBuilder getEntitiesRevisionsOrBuilder(int index)
       A list of entity revisions. The entity revisions are appended to the
 document in the processing order. This field can be used for comparing the
 entity extraction results at different stages of the processing.
      repeated .google.cloud.documentai.v1.Document.EntitiesRevision entities_revisions = 22;

    • getEntitiesRevisionId

      String getEntitiesRevisionId()
       The entity revision ID that `document.entities` field is based on.
 If this field is set and `entities_revisions` is not empty, the entities in
 `document.entities` field are the entities in the entity revision with this
 id and `document.entity_validation_output` field is the
 `entity_validation_output` field in this entity revision.
      string entities_revision_id = 23;
      Returns:
      The entitiesRevisionId.

    • getEntitiesRevisionIdBytes

      com.google.protobuf.ByteString getEntitiesRevisionIdBytes()
       The entity revision ID that `document.entities` field is based on.
 If this field is set and `entities_revisions` is not empty, the entities in
 `document.entities` field are the entities in the entity revision with this
 id and `document.entity_validation_output` field is the
 `entity_validation_output` field in this entity revision.
      string entities_revision_id = 23;
      Returns:
      The bytes for entitiesRevisionId.

    • getSourceCase

      Document.SourceCase getSourceCase()