GoodocDocument

GoogleApi.ContentWarehouse.V1.Model.GoodocDocument


Table of Contents ▼

Jump to a specific part of the page:

Description

Top-level representation of OCRed document

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. EditingHistory (type: list(String.t), default: nil)
    - Debug info, recording the history of any editing done through the interface in goodoc-editing.h. The strings look like "MoveParagraph(page_index = 0, source_block_index = 3, ...);
  2. LogicalEntity (type: list(String.t), default: nil)
    - Logical entities are stored as blobs. Depending on the kind of thing this is a goodoc of, a separate .proto file is expected to define the logical entity structure. Hence we can still parse this as a goodoc for people who dont care about this, and people who care about this can parse it specifically. ocr/goodoc/logical-entity-utils.h has methods to read and write these. See Goodoc++ doc
  3. LogicalEntityMessageName (type: list(String.t), default: nil)
    - The names of the proto messages serialized in LogicalEntity, one for each LogicalEntity. The repetitions should number 0 to leave this unspecified, or they should equal the number of LogicalEntity strings.
  4. SubDocuments (type: list(GoogleApi.ContentWarehouse.V1.Model.GoodocDocument), default: nil)
    - For multi-goodoc documents
  5. header (type: GoogleApi.ContentWarehouse.V1.Model.GoodocDocumentHeader, default: nil)
    -
  6. page (type: list(GoogleApi.ContentWarehouse.V1.Model.GoodocDocumentPage), default: nil)
    -

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.GoodocDocument{
EditingHistory: [String.t()] | nil,
LogicalEntity: [String.t()] | nil,
LogicalEntityMessageName: [String.t()] | nil,
SubDocuments: [#t:t/0()] | nil,
header: GoogleApi.ContentWarehouse.V1.Model.GoodocDocumentHeader.t() | nil,
page: [GoogleApi.ContentWarehouse.V1.Model.GoodocDocumentPage.t()] | nil
}

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.GoodocDocument