Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2Document

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



4295
4296
4297
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4295

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) 


4220
4221
4222
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4220

def content
  @content
end

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



4226
4227
4228
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4226

def entities
  @entities
end

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

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

Returns:



4231
4232
4233
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4231

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:



4241
4242
4243
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4241

def error
  @error
end

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

Labels for this document. Corresponds to the JSON property labels

Returns:



4246
4247
4248
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4246

def labels
  @labels
end

#mime_type ⇒ String

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

Returns:

  • (String) 


4252
4253
4254
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4252

def mime_type
  @mime_type
end

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

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

Returns:



4257
4258
4259
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4257

def pages
  @pages
end

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

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

Returns:



4262
4263
4264
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4262

def revisions
  @revisions
end

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



4268
4269
4270
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4268

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) 


4273
4274
4275
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4273

def text
  @text
end

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



4280
4281
4282
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4280

def text_changes
  @text_changes
end

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

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

Returns:



4285
4286
4287
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4285

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) 


4293
4294
4295
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4293

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
 
# File 'lib/google/apis/documentai_v1beta2/classes.rb', line 4300

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