public final class Document extends GeneratedMessageV3 implements DocumentOrBuilder
Document represents the canonical document resource in Document AI. It is an
interchange format that provides insights into documents and allows for
collaboration between users and Document AI to iterate and optimize for
quality.
Protobuf type google.cloud.documentai.v1.Document
Static Fields
CONTENT_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
Field Value
ENTITIES_FIELD_NUMBER
public static final int ENTITIES_FIELD_NUMBER
Field Value
ENTITY_RELATIONS_FIELD_NUMBER
public static final int ENTITY_RELATIONS_FIELD_NUMBER
Field Value
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
Field Value
MIME_TYPE_FIELD_NUMBER
public static final int MIME_TYPE_FIELD_NUMBER
Field Value
PAGES_FIELD_NUMBER
public static final int PAGES_FIELD_NUMBER
Field Value
REVISIONS_FIELD_NUMBER
public static final int REVISIONS_FIELD_NUMBER
Field Value
SHARD_INFO_FIELD_NUMBER
public static final int SHARD_INFO_FIELD_NUMBER
Field Value
TEXT_CHANGES_FIELD_NUMBER
public static final int TEXT_CHANGES_FIELD_NUMBER
Field Value
TEXT_FIELD_NUMBER
public static final int TEXT_FIELD_NUMBER
Field Value
TEXT_STYLES_FIELD_NUMBER
public static final int TEXT_STYLES_FIELD_NUMBER
Field Value
URI_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Document getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Document.Builder newBuilder()
Returns
newBuilder(Document prototype)
public static Document.Builder newBuilder(Document prototype)
Parameter
Returns
public static Document parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Document parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Document parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Document parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Document parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Document parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Document parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Document parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Document parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Document> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getContent()
public 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];
getDefaultInstanceForType()
public Document getDefaultInstanceForType()
Returns
getEntities(int index)
public Document.Entity getEntities(int index)
A list of entities detected on Document.text. For document shards,
entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
getEntitiesCount()
public int getEntitiesCount()
A list of entities detected on Document.text. For document shards,
entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
getEntitiesList()
public List<Document.Entity> getEntitiesList()
A list of entities detected on Document.text. For document shards,
entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
getEntitiesOrBuilder(int index)
public Document.EntityOrBuilder getEntitiesOrBuilder(int index)
A list of entities detected on Document.text. For document shards,
entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
getEntitiesOrBuilderList()
public List<? extends Document.EntityOrBuilder> getEntitiesOrBuilderList()
A list of entities detected on Document.text. For document shards,
entities in this list may cross shard boundaries.
repeated .google.cloud.documentai.v1.Document.Entity entities = 7;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.EntityOrBuilder> | |
getEntityRelations(int index)
public Document.EntityRelation getEntityRelations(int index)
Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
getEntityRelationsCount()
public int getEntityRelationsCount()
Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
getEntityRelationsList()
public List<Document.EntityRelation> getEntityRelationsList()
Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
getEntityRelationsOrBuilder(int index)
public Document.EntityRelationOrBuilder getEntityRelationsOrBuilder(int index)
Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
getEntityRelationsOrBuilderList()
public List<? extends Document.EntityRelationOrBuilder> getEntityRelationsOrBuilderList()
Placeholder. Relationship among Document.entities.
repeated .google.cloud.documentai.v1.Document.EntityRelation entity_relations = 8;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.EntityRelationOrBuilder> | |
getError()
Any error that occurred while processing this document.
.google.rpc.Status error = 10;
| Type | Description |
| com.google.rpc.Status | The error.
|
getErrorOrBuilder()
public StatusOrBuilder getErrorOrBuilder()
Any error that occurred while processing this document.
.google.rpc.Status error = 10;
| Type | Description |
| com.google.rpc.StatusOrBuilder | |
getMimeType()
public String getMimeType()
Returns
| Type | Description |
| String | The mimeType.
|
getMimeTypeBytes()
public ByteString getMimeTypeBytes()
Returns
getPages(int index)
public Document.Page getPages(int index)
Visual page layout for the Document.
repeated .google.cloud.documentai.v1.Document.Page pages = 6;
getPagesCount()
public int getPagesCount()
Visual page layout for the Document.
repeated .google.cloud.documentai.v1.Document.Page pages = 6;
getPagesList()
public List<Document.Page> getPagesList()
Visual page layout for the Document.
repeated .google.cloud.documentai.v1.Document.Page pages = 6;
getPagesOrBuilder(int index)
public Document.PageOrBuilder getPagesOrBuilder(int index)
Visual page layout for the Document.
repeated .google.cloud.documentai.v1.Document.Page pages = 6;
getPagesOrBuilderList()
public List<? extends Document.PageOrBuilder> getPagesOrBuilderList()
Visual page layout for the Document.
repeated .google.cloud.documentai.v1.Document.Page pages = 6;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.PageOrBuilder> | |
getParserForType()
public Parser<Document> getParserForType()
Returns
Overrides
getRevisions(int index)
public Document.Revision getRevisions(int index)
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
getRevisionsCount()
public int getRevisionsCount()
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
getRevisionsList()
public List<Document.Revision> getRevisionsList()
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
getRevisionsOrBuilder(int index)
public Document.RevisionOrBuilder getRevisionsOrBuilder(int index)
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
getRevisionsOrBuilderList()
public List<? extends Document.RevisionOrBuilder> getRevisionsOrBuilderList()
Placeholder. Revision history of this document.
repeated .google.cloud.documentai.v1.Document.Revision revisions = 13;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.RevisionOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getShardInfo()
public 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;
getShardInfoOrBuilder()
public 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;
getSourceCase()
public Document.SourceCase getSourceCase()
Returns
getText()
Optional. UTF-8 encoded text in reading order from the document.
string text = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The text.
|
getTextBytes()
public ByteString getTextBytes()
Optional. UTF-8 encoded text in reading order from the document.
string text = 4 [(.google.api.field_behavior) = OPTIONAL];
getTextChanges(int index)
public Document.TextChange getTextChanges(int index)
Placeholder. A list of text corrections made to 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()
public int getTextChangesCount()
Placeholder. A list of text corrections made to 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;
getTextChangesList()
public List<Document.TextChange> getTextChangesList()
Placeholder. A list of text corrections made to 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(int index)
public Document.TextChangeOrBuilder getTextChangesOrBuilder(int index)
Placeholder. A list of text corrections made to 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()
public List<? extends Document.TextChangeOrBuilder> getTextChangesOrBuilderList()
Placeholder. A list of text corrections made to 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;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.TextChangeOrBuilder> | |
getTextStyles(int index)
public Document.Style getTextStyles(int index)
Placeholder. Styles for the Document.text.
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5;
getTextStylesCount()
public int getTextStylesCount()
Placeholder. Styles for the Document.text.
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5;
getTextStylesList()
public List<Document.Style> getTextStylesList()
Placeholder. Styles for the Document.text.
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5;
getTextStylesOrBuilder(int index)
public Document.StyleOrBuilder getTextStylesOrBuilder(int index)
Placeholder. Styles for the Document.text.
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5;
getTextStylesOrBuilderList()
public List<? extends Document.StyleOrBuilder> getTextStylesOrBuilderList()
Placeholder. Styles for the Document.text.
repeated .google.cloud.documentai.v1.Document.Style text_styles = 5;
| Type | Description |
| List<? extends com.google.cloud.documentai.v1.Document.StyleOrBuilder> | |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUri()
Optional. Currently supports Google Cloud Storage URI of the form
gs://bucket_name/object_name. Object versioning is not supported.
See Google Cloud Storage Request
URIs for more
info.
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
getUriBytes()
public ByteString getUriBytes()
Optional. Currently supports Google Cloud Storage URI of the form
gs://bucket_name/object_name. Object versioning is not supported.
See Google Cloud Storage Request
URIs for more
info.
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
hasContent()
public 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];
| Type | Description |
| boolean | Whether the content field is set.
|
hasError()
public boolean hasError()
Any error that occurred while processing this document.
.google.rpc.Status error = 10;
| Type | Description |
| boolean | Whether the error field is set.
|
hasShardInfo()
public 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;
| Type | Description |
| boolean | Whether the shardInfo field is set.
|
hasUri()
Optional. Currently supports Google Cloud Storage URI of the form
gs://bucket_name/object_name. Object versioning is not supported.
See Google Cloud Storage Request
URIs for more
info.
string uri = 1 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the uri field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Document.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Document.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
