Class: Google::Cloud::DocumentAI::V1::Document::ChunkedDocument

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1/document.rb

Overview

Represents the chunks that the document is divided into.

Defined Under Namespace

Classes: Chunk

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns List of chunks.

Returns:



1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1249

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::V1::Document::ChunkedDocument::Chunk::ChunkPageSpan]
  #     Page span of the chunk.
  # @!attribute [rw] page_headers
  #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::ChunkedDocument::Chunk::ChunkPageHeader>]
  #     Page headers associated with the chunk.
  # @!attribute [rw] page_footers
  #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::ChunkedDocument::Chunk::ChunkPageFooter>]
  #     Page footers associated with the 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::V1::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::V1::Document::ChunkedDocument::Chunk::ChunkPageSpan]
    #     Page span of the footer.
    class ChunkPageFooter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end