public sealed class Document : IMessage<Document>, IEquatable<Document>, IDeepCloneable<Document>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Document AI v1beta3 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
GoogleCloudGoogle.Cloud.DocumentAIV1Beta3Assembly
Google.Cloud.DocumentAI.V1Beta3.dll
Constructors
Document()
public Document()
Document(Document)
public Document(Document other)
Name | Description |
other | Document |
Properties
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.
Type | Description |
ByteString |
Entities
public RepeatedField<Document.Types.Entity> Entities { get; }
A list of entities detected on [Document.text][google.cloud.documentai.v1beta3.Document.text]. For document shards, entities in this list may cross shard boundaries.
Type | Description |
RepeatedFieldDocumentTypesEntity |
EntityRelations
public RepeatedField<Document.Types.EntityRelation> EntityRelations { get; }
Placeholder. Relationship among [Document.entities][google.cloud.documentai.v1beta3.Document.entities].
Type | Description |
RepeatedFieldDocumentTypesEntityRelation |
Error
public Status Error { get; set; }
Any error that occurred while processing this document.
Type | Description |
Status |
MimeType
public string MimeType { get; set; }
An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.
Type | Description |
string |
Pages
public RepeatedField<Document.Types.Page> Pages { get; }
Visual page layout for the [Document][google.cloud.documentai.v1beta3.Document].
Type | Description |
RepeatedFieldDocumentTypesPage |
Revisions
public RepeatedField<Document.Types.Revision> Revisions { get; }
Placeholder. Revision history of this document.
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.
Type | Description |
DocumentTypesShardInfo |
SourceCase
public Document.SourceOneofCase SourceCase { get; }
Type | Description |
DocumentSourceOneofCase |
Text
public string Text { get; set; }
Optional. UTF-8 encoded text in reading order from the document.
Type | Description |
string |
TextChanges
public RepeatedField<Document.Types.TextChange> TextChanges { get; }
Placeholder. A list of text corrections made to [Document.text][google.cloud.documentai.v1beta3.Document.text]. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
Type | Description |
RepeatedFieldDocumentTypesTextChange |
TextStyles
[Obsolete]
public RepeatedField<Document.Types.Style> TextStyles { get; }
Styles for the [Document.text][google.cloud.documentai.v1beta3.Document.text].
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.
See Google Cloud Storage Request
URIs for more
info.
Type | Description |
string |