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 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.



4468
4469
4470
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4468

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) 


4392
4393
4394
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4392

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:



4398
4399
4400
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4398

def entities
  @entities
end

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

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

Returns:



4403
4404
4405
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4403

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:



4413
4414
4415
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4413

def error
  @error
end

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

Labels for this document. Corresponds to the JSON property labels

Returns:



4418
4419
4420
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4418

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) 


4425
4426
4427
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4425

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:



4430
4431
4432
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4430

def pages
  @pages
end

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

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

Returns:



4435
4436
4437
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4435

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:



4441
4442
4443
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4441

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) 


4446
4447
4448
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4446

def text
  @text
end

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



4453
4454
4455
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4453

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:



4458
4459
4460
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4458

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) 


4466
4467
4468
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4466

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 4473

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