Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::Document (v0.39.0)

Version latest

• 0.39.0 (latest)
• 0.38.0
• 0.37.0
• 0.36.1
• 0.35.0
• 0.34.0
• 0.33.1
• 0.32.0
• 0.31.0
• 0.30.2
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.4

Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::Document.

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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#chunked_document

def chunked_document() -> ::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument) — Document chunked based on chunking config.

#chunked_document=

def chunked_document=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument) — Document chunked based on chunking config.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument) — Document chunked based on chunking config.

#content

def content() -> ::String

Returns

• (::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.

  Note: The following fields are mutually exclusive: content, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#content=

def content=(value) -> ::String

Parameter

• value (::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.

  Note: The following fields are mutually exclusive: content, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::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.

  Note: The following fields are mutually exclusive: content, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#document_layout

def document_layout() -> ::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout) — Parsed layout of the document.

#document_layout=

def document_layout=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout) — Parsed layout of the document.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Document::DocumentLayout) — Parsed layout of the document.

#entities

def entities() -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>) — A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

#entities=

def entities=(value) -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>) — A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>) — A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

#entity_relations

def entity_relations() -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::EntityRelation>

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::EntityRelation>) — Placeholder. Relationship among Document.entities.

#entity_relations=

def entity_relations=(value) -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::EntityRelation>

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::EntityRelation>) — Placeholder. Relationship among Document.entities.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::EntityRelation>) — Placeholder. Relationship among Document.entities.

#error

def error() -> ::Google::Rpc::Status

Returns

• (::Google::Rpc::Status) — Any error that occurred while processing this document.

#error=

def error=(value) -> ::Google::Rpc::Status

Parameter

• value (::Google::Rpc::Status) — Any error that occurred while processing this document.

Returns

• (::Google::Rpc::Status) — Any error that occurred while processing this document.

#mime_type

def mime_type() -> ::String

Returns

• (::String) — An IANA published media type (MIME type).

#mime_type=

def mime_type=(value) -> ::String

Parameter

• value (::String) — An IANA published media type (MIME type).

Returns

• (::String) — An IANA published media type (MIME type).

#pages

def pages() -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page>

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page>) — Visual page layout for the Document.

#pages=

def pages=(value) -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page>

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page>) — Visual page layout for the Document.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page>) — Visual page layout for the Document.

#revisions

def revisions() -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Revision>

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Revision>) — Placeholder. Revision history of this document.

#revisions=

def revisions=(value) -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Revision>

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Revision>) — Placeholder. Revision history of this document.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Revision>) — Placeholder. Revision history of this document.

#shard_info

def shard_info() -> ::Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo) — Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.

#shard_info=

def shard_info=(value) -> ::Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo) — Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::Document::ShardInfo) — Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.

#text

def text() -> ::String

Returns

• (::String) — Optional. UTF-8 encoded text in reading order from the document.

#text=

def text=(value) -> ::String

Parameter

• value (::String) — Optional. UTF-8 encoded text in reading order from the document.

Returns

• (::String) — Optional. UTF-8 encoded text in reading order from the document.

#text_changes

def text_changes() -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextChange>

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextChange>) — 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.

#text_changes=

def text_changes=(value) -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextChange>

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextChange>) — 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.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::TextChange>) — 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.

#text_styles

def text_styles() -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Style>

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Style>) — Styles for the Document.text.

#text_styles=

def text_styles=(value) -> ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Style>

Parameter

• value (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Style>) — Styles for the Document.text.

Returns

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Style>) — Styles for the Document.text.

#uri

def uri() -> ::String

Returns

• (::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.

  Note: The following fields are mutually exclusive: uri, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

#uri=

def uri=(value) -> ::String

Parameter

• value (::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.

  Note: The following fields are mutually exclusive: uri, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::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.

  Note: The following fields are mutually exclusive: uri, content. If a field in that set is populated, all other fields in the set will automatically be cleared.