Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1Document

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

Returns a new instance of GoogleCloudDocumentaiV1beta1Document.



6260
6261
6262
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6260

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

Instance Attribute Details

#chunked_document ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentChunkedDocument

Represents the chunks that the document is divided into. Corresponds to the JSON property chunkedDocument

Returns:



6176
6177
6178
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6176

def chunked_document
  @chunked_document
end

#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) 


6184
6185
6186
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6184

def content
  @content
end

#document_layout ⇒ Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1beta1DocumentDocumentLayout

Represents the parsed layout of a document as a collection of blocks that the document is divided into. Corresponds to the JSON property documentLayout

Returns:



6190
6191
6192
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6190

def document_layout
  @document_layout
end

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



6196
6197
6198
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6196

def entities
  @entities
end

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

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

Returns:



6201
6202
6203
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6201

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:



6211
6212
6213
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6211

def error
  @error
end

#mime_type ⇒ String

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

Returns:

  • (String) 


6217
6218
6219
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6217

def mime_type
  @mime_type
end

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

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

Returns:



6222
6223
6224
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6222

def pages
  @pages
end

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

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

Returns:



6227
6228
6229
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6227

def revisions
  @revisions
end

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



6233
6234
6235
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6233

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) 


6238
6239
6240
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6238

def text
  @text
end

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



6245
6246
6247
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6245

def text_changes
  @text_changes
end

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

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

Returns:



6250
6251
6252
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6250

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) 


6258
6259
6260
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6258

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 6265

def update!(**args)
  @chunked_document = args[:chunked_document] if args.key?(:chunked_document)
  @content = args[:content] if args.key?(:content)
  @document_layout = args[:document_layout] if args.key?(:document_layout)
  @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