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

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

Defined Under Namespace

Classes: ChunkPageFooter, ChunkPageHeader, ChunkPageSpan

Instance Attribute Summary collapse

Instance Attribute Details

#chunk_id ⇒ ::String

Returns ID of the chunk.

Returns:

  • (::String) —

    ID of the chunk.



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
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1272

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

#content ⇒ ::String

Returns Text content of the chunk.

Returns:

  • (::String) —

    Text content of the chunk.



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
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1272

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

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

Returns Page footers associated with the chunk.

Returns:



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
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1272

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

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

Returns Page headers associated with the chunk.

Returns:



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
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1272

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

#page_span ⇒ ::Google::Cloud::DocumentAI::V1::Document::ChunkedDocument::Chunk::ChunkPageSpan

Returns Page span of the chunk.

Returns:



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
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1272

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

#source_block_ids ⇒ ::Array<::String>

Returns Unused.

Returns:

  • (::Array<::String>) —

    Unused.



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
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1272

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