Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1Document

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

Returns a new instance of GoogleCloudDocumentaiV1beta1Document.



461
462
463
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 461

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) 


384
385
386
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 384

def content
  @content
end

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



390
391
392
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 390

def entities
  @entities
end

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

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

Returns:



395
396
397
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 395

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:



405
406
407
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 405

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) 


412
413
414
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 412

def mime_type
  @mime_type
end

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

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

Returns:



417
418
419
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 417

def pages
  @pages
end

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

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

Returns:



422
423
424
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 422

def revisions
  @revisions
end

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



428
429
430
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 428

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) 


433
434
435
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 433

def text
  @text
end

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



440
441
442
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 440

def text_changes
  @text_changes
end

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

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

Returns:



445
446
447
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 445

def text_styles
  @text_styles
end

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

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:



451
452
453
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 451

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) 


459
460
461
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 459

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 466

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