Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2Document

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

Returns a new instance of GoogleCloudDocumentaiV1beta2Document.



2468
2469
2470
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2468

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

Instance Attribute Details

#content ⇒ String

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) 


2386
2387
2388
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2386

def content
  @content
end

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



2392
2393
2394
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2392

def entities
  @entities
end

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

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

Returns:



2397
2398
2399
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2397

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:



2407
2408
2409
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2407

def error
  @error
end

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

Labels for this document. Corresponds to the JSON property labels

Returns:



2412
2413
2414
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2412

def labels
  @labels
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) 


2419
2420
2421
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2419

def mime_type
  @mime_type
end

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

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

Returns:



2424
2425
2426
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2424

def pages
  @pages
end

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

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

Returns:



2429
2430
2431
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2429

def revisions
  @revisions
end

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



2435
2436
2437
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2435

def shard_info
  @shard_info
end

#text ⇒ String

UTF-8 encoded text in reading order from the document. Corresponds to the JSON property text

Returns:

  • (String) 


2440
2441
2442
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2440

def text
  @text
end

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

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:



2447
2448
2449
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2447

def text_changes
  @text_changes
end

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

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

Returns:



2452
2453
2454
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2452

def text_styles
  @text_styles
end

#translations ⇒ Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta2DocumentTranslation>

A list of translations on Document.text. For document shards, translations in this list may cross shard boundaries. Corresponds to the JSON property translations

Returns:



2458
2459
2460
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2458

def translations
  @translations
end

#uri ⇒ String

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) 


2466
2467
2468
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2466

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2473

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