Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Document

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1Document

Returns a new instance of GoogleCloudDocumentaiV1Document.



1795
1796
1797
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1795

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#content ⇒ String

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. Corresponds to the JSON property content NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1725
1726
1727
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1725

def content
  @content
end

#entities ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity>

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. Corresponds to the JSON property entities

Returns:



1731
1732
1733
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1731

def entities
  @entities
end

#entity_relations ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityRelation>

Placeholder. Relationship among Document.entities. Corresponds to the JSON property entityRelations

Returns:



1736
1737
1738
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1736

def entity_relations
  @entity_relations
end

#error ⇒ Google::Apis::DocumentaiV1::GoogleRpcStatus

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



1746
1747
1748
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1746

def error
  @error
end

#mime_type ⇒ String

An IANA published media type (MIME type). Corresponds to the JSON property mimeType

Returns:

  • (String) 


1752
1753
1754
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1752

def mime_type
  @mime_type
end

#pages ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPage>

Visual page layout for the Document. Corresponds to the JSON property pages

Returns:



1757
1758
1759
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1757

def pages
  @pages
end

#revisions ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentRevision>

Placeholder. Revision history of this document. Corresponds to the JSON property revisions

Returns:



1762
1763
1764
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1762

def revisions
  @revisions
end

#shard_info ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentShardInfo

For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. Corresponds to the JSON property shardInfo

Returns:



1768
1769
1770
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1768

def shard_info
  @shard_info
end

#text ⇒ String

Optional. UTF-8 encoded text in reading order from the document. Corresponds to the JSON property text

Returns:

  • (String) 


1773
1774
1775
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1773

def text
  @text
end

#text_changes ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentTextChange>

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. Corresponds to the JSON property textChanges

Returns:



1780
1781
1782
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1780

def text_changes
  @text_changes
end

#text_styles ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentStyle>

Styles for the Document.text. Corresponds to the JSON property textStyles

Returns:



1785
1786
1787
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1785

def text_styles
  @text_styles
end

#uri ⇒ String

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. Corresponds to the JSON property uri

Returns:

  • (String) 


1793
1794
1795
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1793

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1800

def update!(**args)
  @content = args[:content] if args.key?(:content)
  @entities = args[:entities] if args.key?(:entities)
  @entity_relations = args[:entity_relations] if args.key?(:entity_relations)
  @error = args[:error] if args.key?(:error)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @pages = args[:pages] if args.key?(:pages)
  @revisions = args[:revisions] if args.key?(:revisions)
  @shard_info = args[:shard_info] if args.key?(:shard_info)
  @text = args[:text] if args.key?(:text)
  @text_changes = args[:text_changes] if args.key?(:text_changes)
  @text_styles = args[:text_styles] if args.key?(:text_styles)
  @uri = args[:uri] if args.key?(:uri)
end