public sealed class Document : IMessage<Document>, IEquatable<Document>, IDeepCloneable<Document>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Document AI v1 API class Document.
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.
Namespace
Google.Cloud.DocumentAI.V1Assembly
Google.Cloud.DocumentAI.V1.dll
Constructors
Document()
public Document()Document(Document)
public Document(Document other)| Parameter | |
|---|---|
| Name | Description |
other |
Document |
Properties
ChunkedDocument
public Document.Types.ChunkedDocument ChunkedDocument { get; set; }Document chunked based on chunking config.
| Property Value | |
|---|---|
| Type | Description |
DocumentTypesChunkedDocument |
|
Content
public ByteString Content { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
ByteString |
|
DocumentLayout
public Document.Types.DocumentLayout DocumentLayout { get; set; }Parsed layout of the document.
| Property Value | |
|---|---|
| Type | Description |
DocumentTypesDocumentLayout |
|
Entities
public RepeatedField<Document.Types.Entity> Entities { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDocumentTypesEntity |
|
EntityRelations
public RepeatedField<Document.Types.EntityRelation> EntityRelations { get; }Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1.Document.entities].
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDocumentTypesEntityRelation |
|
Error
public Status Error { get; set; }Any error that occurred while processing this document.
| Property Value | |
|---|---|
| Type | Description |
Status |
|
HasContent
public bool HasContent { get; }Gets whether the "content" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasUri
public bool HasUri { get; }Gets whether the "uri" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
MimeType
public string MimeType { get; set; }An IANA published media type (MIME type).
| Property Value | |
|---|---|
| Type | Description |
string |
|
Pages
public RepeatedField<Document.Types.Page> Pages { get; }Visual page layout for the [Document][google.cloud.documentai.v1.Document].
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDocumentTypesPage |
|
Revisions
public RepeatedField<Document.Types.Revision> Revisions { get; }Placeholder. Revision history of this document.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDocumentTypesRevision |
|
ShardInfo
public Document.Types.ShardInfo ShardInfo { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
DocumentTypesShardInfo |
|
SourceCase
public Document.SourceOneofCase SourceCase { get; }| Property Value | |
|---|---|
| Type | Description |
DocumentSourceOneofCase |
|
Text
public string Text { get; set; }Optional. UTF-8 encoded text in reading order from the document.
| Property Value | |
|---|---|
| Type | Description |
string |
|
TextChanges
public RepeatedField<Document.Types.TextChange> TextChanges { get; }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.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDocumentTypesTextChange |
|
TextStyles
[Obsolete]
public RepeatedField<Document.Types.Style> TextStyles { get; }Styles for the [Document.text][google.cloud.documentai.v1.Document.text].
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldDocumentTypesStyle |
|
Uri
public string Uri { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|