Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta1Document

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



1490
1491
1492
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1490

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) 


1419
1420
1421
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1419

def content
  @content
end

#entities ⇒ Array<Google::Apis::DocumentaiV1beta2::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:



1425
1426
1427
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1425

def entities
  @entities
end

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

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

Returns:



1430
1431
1432
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1430

def entity_relations
  @entity_relations
end

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



1440
1441
1442
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1440

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) 


1447
1448
1449
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1447

def mime_type
  @mime_type
end

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

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

Returns:



1452
1453
1454
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1452

def pages
  @pages
end

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

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

Returns:



1457
1458
1459
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1457

def revisions
  @revisions
end

#shard_info ⇒ Google::Apis::DocumentaiV1beta2::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:



1463
1464
1465
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1463

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) 


1468
1469
1470
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1468

def text
  @text
end

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

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:



1475
1476
1477
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1475

def text_changes
  @text_changes
end

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

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

Returns:



1480
1481
1482
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1480

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) 


1488
1489
1490
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1488

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 1495

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