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.



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1202

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.



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1202

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:



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1202

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:



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1202

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:



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1202

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.



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1202

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