Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Document

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

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

Returns a new instance of GoogleCloudDocumentaiV1Document.

[View source]

1902
1903
1904
# File 'lib/google/apis/documentai_v1/classes.rb', line 1902

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

Instance Attribute Details

#contentString

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)

1832
1833
1834
# File 'lib/google/apis/documentai_v1/classes.rb', line 1832

def content
  @content
end

#entitiesArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntity>

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


1838
1839
1840
# File 'lib/google/apis/documentai_v1/classes.rb', line 1838

def entities
  @entities
end

#entity_relationsArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentEntityRelation>

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


1843
1844
1845
# File 'lib/google/apis/documentai_v1/classes.rb', line 1843

def entity_relations
  @entity_relations
end

#errorGoogle::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


1853
1854
1855
# File 'lib/google/apis/documentai_v1/classes.rb', line 1853

def error
  @error
end

#mime_typeString

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

Returns:

  • (String)

1859
1860
1861
# File 'lib/google/apis/documentai_v1/classes.rb', line 1859

def mime_type
  @mime_type
end

#pagesArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentPage>

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


1864
1865
1866
# File 'lib/google/apis/documentai_v1/classes.rb', line 1864

def pages
  @pages
end

#revisionsArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentRevision>

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


1869
1870
1871
# File 'lib/google/apis/documentai_v1/classes.rb', line 1869

def revisions
  @revisions
end

#shard_infoGoogle::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentShardInfo

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


1875
1876
1877
# File 'lib/google/apis/documentai_v1/classes.rb', line 1875

def shard_info
  @shard_info
end

#textString

Optional. UTF-8 encoded text in reading order from the document. Corresponds to the JSON property text

Returns:

  • (String)

1880
1881
1882
# File 'lib/google/apis/documentai_v1/classes.rb', line 1880

def text
  @text
end

#text_changesArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentTextChange>

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


1887
1888
1889
# File 'lib/google/apis/documentai_v1/classes.rb', line 1887

def text_changes
  @text_changes
end

#text_stylesArray<Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentStyle>

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


1892
1893
1894
# File 'lib/google/apis/documentai_v1/classes.rb', line 1892

def text_styles
  @text_styles
end

#uriString

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)

1900
1901
1902
# File 'lib/google/apis/documentai_v1/classes.rb', line 1900

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
# File 'lib/google/apis/documentai_v1/classes.rb', line 1907

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