Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Document

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta3/classes.rb,
lib/google/apis/documentai_v1beta3/representations.rb,
lib/google/apis/documentai_v1beta3/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) ⇒ GoogleCloudDocumentaiV1beta3Document

Returns a new instance of GoogleCloudDocumentaiV1beta3Document.



5775
5776
5777
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5775

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) 


5704
5705
5706
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5704

def content
  @content
end

#entities ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentEntity>

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:



5710
5711
5712
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5710

def entities
  @entities
end

#entity_relations ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentEntityRelation>

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

Returns:



5715
5716
5717
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5715

def entity_relations
  @entity_relations
end

#error ⇒ Google::Apis::DocumentaiV1beta3::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:



5725
5726
5727
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5725

def error
  @error
end

#mime_type ⇒ String

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

Returns:

  • (String) 


5732
5733
5734
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5732

def mime_type
  @mime_type
end

#pages ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentPage>

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

Returns:



5737
5738
5739
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5737

def pages
  @pages
end

#revisions ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentRevision>

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

Returns:



5742
5743
5744
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5742

def revisions
  @revisions
end

#shard_info ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentShardInfo

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:



5748
5749
5750
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5748

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) 


5753
5754
5755
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5753

def text
  @text
end

#text_changes ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentTextChange>

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:



5760
5761
5762
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5760

def text_changes
  @text_changes
end

#text_styles ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentStyle>

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

Returns:



5765
5766
5767
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5765

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. See Google Cloud Storage Request URIs for more info. Corresponds to the JSON property uri

Returns:

  • (String) 


5773
5774
5775
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5773

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 5780

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