Class: Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument

Inherits:

Object

• Object
• Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/documentai/v1beta3/document.rb

Overview

Represents the chunks that the document is divided into.

Defined Under Namespace

Classes: Chunk

Instance Attribute Summary

• #chunks ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk>

  List of chunks.

Instance Attribute Details

#chunks ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk>

Returns List of chunks.

Returns:

• (::Array<::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk>) —

  List of chunks.

# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 1275

class ChunkedDocument
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Represents a chunk.
  # @!attribute [rw] chunk_id
  #   @return [::String]
  #     ID of the chunk.
  # @!attribute [rw] source_block_ids
  #   @return [::Array<::String>]
  #     Unused.
  # @!attribute [rw] content
  #   @return [::String]
  #     Text content of the chunk.
  # @!attribute [rw] page_span
  #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ChunkPageSpan]
  #     Page span of the chunk.
  # @!attribute [rw] page_headers
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ChunkPageHeader>]
  #     Page headers associated with the chunk.
  # @!attribute [rw] page_footers
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ChunkPageFooter>]
  #     Page footers associated with the chunk.
  # @!attribute [rw] chunk_fields
  #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ChunkField>]
  #     Chunk fields inside this chunk.
  class Chunk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents where the chunk starts and ends in the document.
    # @!attribute [rw] page_start
    #   @return [::Integer]
    #     Page where chunk starts in the document.
    # @!attribute [rw] page_end
    #   @return [::Integer]
    #     Page where chunk ends in the document.
    class ChunkPageSpan
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the page header associated with the chunk.
    # @!attribute [rw] text
    #   @return [::String]
    #     Header in text format.
    # @!attribute [rw] page_span
    #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ChunkPageSpan]
    #     Page span of the header.
    class ChunkPageHeader
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Represents the page footer associated with the chunk.
    # @!attribute [rw] text
    #   @return [::String]
    #     Footer in text format.
    # @!attribute [rw] page_span
    #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ChunkPageSpan]
    #     Page span of the footer.
    class ChunkPageFooter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The image chunk field in the chunk.
    # @!attribute [rw] blob_asset_id
    #   @return [::String]
    #     Optional. Asset id of the inline image. If set, find the image
    #     content in the blob_assets field.
    #
    #     Note: The following fields are mutually exclusive: `blob_asset_id`, `gcs_uri`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] gcs_uri
    #   @return [::String]
    #     Optional. Google Cloud Storage uri of the image.
    #
    #     Note: The following fields are mutually exclusive: `gcs_uri`, `blob_asset_id`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] data_uri
    #   @return [::String]
    #     Optional. Data uri of the image.
    #     It is composed of four parts: a prefix (data:), a MIME type
    #     indicating the type of data, an optional base64 token if
    #     non-textual, and the data itself:
    #     data:[<mediatype>][;base64],<data>
    #
    #     Note: The following fields are mutually exclusive: `data_uri`, `blob_asset_id`, `gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] annotations
    #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Annotations]
    #     Annotation of the image chunk field.
    class ImageChunkField
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The table chunk field in the chunk.
    # @!attribute [rw] annotations
    #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Annotations]
    #     Annotation of the table chunk field.
    class TableChunkField
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The chunk field in the chunk. A chunk field could be one of the various
    # types (e.g. image, table) supported.
    # @!attribute [rw] image_chunk_field
    #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ImageChunkField]
    #     The image chunk field in the chunk.
    #
    #     Note: The following fields are mutually exclusive: `image_chunk_field`, `table_chunk_field`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] table_chunk_field
    #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::TableChunkField]
    #     The table chunk field in the chunk.
    #
    #     Note: The following fields are mutually exclusive: `table_chunk_field`, `image_chunk_field`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class ChunkField
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end