Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1Document

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 Understanding AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document Understanding AI to iterate and optimize for quality.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta1Document

Returns a new instance of GoogleCloudDocumentaiV1beta1Document.



2782
2783
2784
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2782

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) 


2711
2712
2713
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2711

def content
  @content
end

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

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:



2717
2718
2719
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2717

def entities
  @entities
end

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

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

Returns:



2722
2723
2724
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2722

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:



2732
2733
2734
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2732

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) 


2739
2740
2741
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2739

def mime_type
  @mime_type
end

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

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

Returns:



2744
2745
2746
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2744

def pages
  @pages
end

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

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

Returns:



2749
2750
2751
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2749

def revisions
  @revisions
end

#shard_info ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentShardInfo

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:



2755
2756
2757
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2755

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) 


2760
2761
2762
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2760

def text
  @text
end

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

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:



2767
2768
2769
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2767

def text_changes
  @text_changes
end

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

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

Returns:



2772
2773
2774
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2772

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) 


2780
2781
2782
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2780

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 2787

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