Class GoogleCloudDocumentaiV1beta3Document

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.

Inheritance
object
GoogleCloudDocumentaiV1beta3Document
Implements
Inherited Members
Namespace: Google.Apis.Document.v1beta3.Data
Assembly: Google.Apis.Document.v1beta3.dll
Syntax
public class GoogleCloudDocumentaiV1beta3Document : IDirectResponseSchema

Properties

BlobAssets

Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.

Declaration
[JsonProperty("blobAssets")]
public virtual IList<GoogleCloudDocumentaiV1beta3DocumentBlobAsset> BlobAssets { get; set; }
Property Value
Type Description
IList<GoogleCloudDocumentaiV1beta3DocumentBlobAsset>

ChunkedDocument

Document chunked based on chunking config.

Declaration
[JsonProperty("chunkedDocument")]
public virtual GoogleCloudDocumentaiV1beta3DocumentChunkedDocument ChunkedDocument { get; set; }
Property Value
Type Description
GoogleCloudDocumentaiV1beta3DocumentChunkedDocument

Content

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.

Declaration
[JsonProperty("content")]
public virtual string Content { get; set; }
Property Value
Type Description
string

Docid

Optional. An internal identifier for document. Should be loggable (no PII).

Declaration
[JsonProperty("docid")]
public virtual string Docid { get; set; }
Property Value
Type Description
string

DocumentLayout

Parsed layout of the document.

Declaration
[JsonProperty("documentLayout")]
public virtual GoogleCloudDocumentaiV1beta3DocumentDocumentLayout DocumentLayout { get; set; }
Property Value
Type Description
GoogleCloudDocumentaiV1beta3DocumentDocumentLayout

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Entities

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

Declaration
[JsonProperty("entities")]
public virtual IList<GoogleCloudDocumentaiV1beta3DocumentEntity> Entities { get; set; }
Property Value
Type Description
IList<GoogleCloudDocumentaiV1beta3DocumentEntity>

EntityRelations

Placeholder. Relationship among Document.entities.

Declaration
[JsonProperty("entityRelations")]
public virtual IList<GoogleCloudDocumentaiV1beta3DocumentEntityRelation> EntityRelations { get; set; }
Property Value
Type Description
IList<GoogleCloudDocumentaiV1beta3DocumentEntityRelation>

Error

Any error that occurred while processing this document.

Declaration
[JsonProperty("error")]
public virtual GoogleRpcStatus Error { get; set; }
Property Value
Type Description
GoogleRpcStatus

MimeType

An IANA published media type (MIME type).

Declaration
[JsonProperty("mimeType")]
public virtual string MimeType { get; set; }
Property Value
Type Description
string

Pages

Visual page layout for the Document.

Declaration
[JsonProperty("pages")]
public virtual IList<GoogleCloudDocumentaiV1beta3DocumentPage> Pages { get; set; }
Property Value
Type Description
IList<GoogleCloudDocumentaiV1beta3DocumentPage>

Revisions

Placeholder. Revision history of this document.

Declaration
[JsonProperty("revisions")]
public virtual IList<GoogleCloudDocumentaiV1beta3DocumentRevision> Revisions { get; set; }
Property Value
Type Description
IList<GoogleCloudDocumentaiV1beta3DocumentRevision>

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
[JsonProperty("shardInfo")]
public virtual GoogleCloudDocumentaiV1beta3DocumentShardInfo ShardInfo { get; set; }
Property Value
Type Description
GoogleCloudDocumentaiV1beta3DocumentShardInfo

Text

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

Declaration
[JsonProperty("text")]
public virtual string Text { get; set; }
Property Value
Type Description
string

TextChanges

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.

Declaration
[JsonProperty("textChanges")]
public virtual IList<GoogleCloudDocumentaiV1beta3DocumentTextChange> TextChanges { get; set; }
Property Value
Type Description
IList<GoogleCloudDocumentaiV1beta3DocumentTextChange>

TextStyles

Styles for the Document.text.

Declaration
[JsonProperty("textStyles")]
public virtual IList<GoogleCloudDocumentaiV1beta3DocumentStyle> TextStyles { get; set; }
Property Value
Type Description
IList<GoogleCloudDocumentaiV1beta3DocumentStyle>

Uri

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.

Declaration
[JsonProperty("uri")]
public virtual string Uri { get; set; }
Property Value
Type Description
string

Implements