Class Document

Document represents the canonical document resource in Document Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.

Inheritance

System.Object

Document

Implements

IMessage<Document>

System.IEquatable<Document>

IDeepCloneable<Document>

Google.Protobuf.IBufferMessage

IMessage

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.DocumentAI.V1Beta2

Assembly: Google.Cloud.DocumentAI.V1Beta2.dll

Syntax

public sealed class Document : IMessage<Document>, IEquatable<Document>, IDeepCloneable<Document>, IBufferMessage, IMessage

Constructors

Document()

Declaration

public Document()

Document(Document)

Declaration

public Document(Document other)

Parameters

Type	Name	Description
Document	other

Properties

Content

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.

Declaration

public ByteString Content { get; set; }

Property Value

Type	Description
ByteString

Entities

A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text]. For document shards, entities in this list may cross shard boundaries.

Declaration

public RepeatedField<Document.Types.Entity> Entities { get; }

Property Value

Type	Description
RepeatedField<Document.Types.Entity>

EntityRelations

Relationship among [Document.entities][google.cloud.documentai.v1beta2.Document.entities].

Declaration

public RepeatedField<Document.Types.EntityRelation> EntityRelations { get; }

Property Value

Type	Description
RepeatedField<Document.Types.EntityRelation>

Error

Any error that occurred while processing this document.

Declaration

public Status Error { get; set; }

Property Value

Type	Description
Status

Labels

[Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.

Declaration

public RepeatedField<Document.Types.Label> Labels { get; }

Property Value

Type	Description
RepeatedField<Document.Types.Label>

MimeType

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.

Declaration

public string MimeType { get; set; }

Property Value

Type	Description
System.String

Pages

Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].

Declaration

public RepeatedField<Document.Types.Page> Pages { get; }

Property Value

Type	Description
RepeatedField<Document.Types.Page>

ShardInfo

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.

Declaration

public Document.Types.ShardInfo ShardInfo { get; set; }

Property Value

Type	Description
Document.Types.ShardInfo

SourceCase

Declaration

public Document.SourceOneofCase SourceCase { get; }

Property Value

Type	Description
Document.SourceOneofCase

Text

UTF-8 encoded text in reading order from the document.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String

TextStyles

Styles for the [Document.text][google.cloud.documentai.v1beta2.Document.text].

Declaration

public RepeatedField<Document.Types.Style> TextStyles { get; }

Property Value

Type	Description
RepeatedField<Document.Types.Style>

Uri

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.

Declaration

public string Uri { get; set; }

Property Value

Type	Description
System.String