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.



7938
7939
7940
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7938

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

Instance Attribute Details

#chunked_document ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentChunkedDocument

Represents the chunks that the document is divided into. Corresponds to the JSON property chunkedDocument

Returns:



7854
7855
7856
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7854

def chunked_document
  @chunked_document
end

#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) 


7862
7863
7864
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7862

def content
  @content
end

#document_layout ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentDocumentLayout

Represents the parsed layout of a document as a collection of blocks that the document is divided into. Corresponds to the JSON property documentLayout

Returns:



7868
7869
7870
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7868

def document_layout
  @document_layout
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:



7874
7875
7876
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7874

def entities
  @entities
end

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

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

Returns:



7879
7880
7881
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7879

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:



7889
7890
7891
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7889

def error
  @error
end

#mime_type ⇒ String

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

Returns:

  • (String) 


7895
7896
7897
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7895

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:



7900
7901
7902
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7900

def pages
  @pages
end

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

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

Returns:



7905
7906
7907
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7905

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:



7911
7912
7913
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7911

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) 


7916
7917
7918
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7916

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:



7923
7924
7925
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7923

def text_changes
  @text_changes
end

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

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

Returns:



7928
7929
7930
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7928

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) 


7936
7937
7938
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7936

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 7943

def update!(**args)
  @chunked_document = args[:chunked_document] if args.key?(:chunked_document)
  @content = args[:content] if args.key?(:content)
  @document_layout = args[:document_layout] if args.key?(:document_layout)
  @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