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

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



2155
2156
2157
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2155

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

Instance Attribute Details

#chunked_document ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentChunkedDocument

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

Returns:



2071
2072
2073
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2071

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) 


2079
2080
2081
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2079

def content
  @content
end

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



2085
2086
2087
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2085

def document_layout
  @document_layout
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:



2091
2092
2093
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2091

def entities
  @entities
end

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

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

Returns:



2096
2097
2098
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2096

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:



2106
2107
2108
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2106

def error
  @error
end

#mime_type ⇒ String

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

Returns:

  • (String) 


2112
2113
2114
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2112

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:



2117
2118
2119
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2117

def pages
  @pages
end

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

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

Returns:



2122
2123
2124
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2122

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:



2128
2129
2130
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2128

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) 


2133
2134
2135
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2133

def text
  @text
end

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



2140
2141
2142
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2140

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:



2145
2146
2147
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2145

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) 


2153
2154
2155
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2153

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 2160

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