Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2Document

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) ⇒ GoogleCloudDocumentaiV1beta2Document

Returns a new instance of GoogleCloudDocumentaiV1beta2Document.



7715
7716
7717
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7715

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) 


7640
7641
7642
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7640

def content
  @content
end

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

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:



7646
7647
7648
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7646

def entities
  @entities
end

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

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

Returns:



7651
7652
7653
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7651

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:



7661
7662
7663
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7661

def error
  @error
end

#labels ⇒ Array<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentLabel>

Labels for this document. Corresponds to the JSON property labels

Returns:



7666
7667
7668
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7666

def labels
  @labels
end

#mime_type ⇒ String

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

Returns:

  • (String) 


7672
7673
7674
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7672

def mime_type
  @mime_type
end

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

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

Returns:



7677
7678
7679
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7677

def pages
  @pages
end

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

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

Returns:



7682
7683
7684
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7682

def revisions
  @revisions
end

#shard_info ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta2DocumentShardInfo

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:



7688
7689
7690
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7688

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) 


7693
7694
7695
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7693

def text
  @text
end

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

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:



7700
7701
7702
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7700

def text_changes
  @text_changes
end

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

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

Returns:



7705
7706
7707
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7705

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) 


7713
7714
7715
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7713

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 7720

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)
  @labels = args[:labels] if args.key?(:labels)
  @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