View Source GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1Document (google_api_content_warehouse v0.6.0)

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.

Attributes

chunkedDocument (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentChunkedDocument.t, default: nil) - Document chunked based on chunking config.
content (type: String.t, default: nil) - 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.
documentLayout (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentDocumentLayout.t, default: nil) - Parsed layout of the document.
entities (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentEntity.t), default: nil) - A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
entityRelations (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentEntityRelation.t), default: nil) - Placeholder. Relationship among Document.entities.
error (type: GoogleApi.ContentWarehouse.V1.Model.GoogleRpcStatus.t, default: nil) - Any error that occurred while processing this document.
mimeType (type: String.t, default: nil) - An IANA published media type (MIME type).
pages (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentPage.t), default: nil) - Visual page layout for the Document.
revisions (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentRevision.t), default: nil) - Placeholder. Revision history of this document.
shardInfo (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentShardInfo.t, default: nil) - 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.
text (type: String.t, default: nil) - Optional. UTF-8 encoded text in reading order from the document.
textChanges (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentTextChange.t), default: nil) - 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.
textStyles (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentStyle.t), default: nil) - Styles for the Document.text.
uri (type: String.t, default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1Document{
  chunkedDocument:
    GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentChunkedDocument.t()
    | nil,
  content: String.t() | nil,
  documentLayout:
    GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentDocumentLayout.t()
    | nil,
  entities:
    [
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentEntity.t()
    ]
    | nil,
  entityRelations:
    [
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentEntityRelation.t()
    ]
    | nil,
  error: GoogleApi.ContentWarehouse.V1.Model.GoogleRpcStatus.t() | nil,
  mimeType: String.t() | nil,
  pages:
    [
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentPage.t()
    ]
    | nil,
  revisions:
    [
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentRevision.t()
    ]
    | nil,
  shardInfo:
    GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentShardInfo.t()
    | nil,
  text: String.t() | nil,
  textChanges:
    [
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentTextChange.t()
    ]
    | nil,
  textStyles:
    [
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudDocumentaiV1DocumentStyle.t()
    ]
    | nil,
  uri: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.