Class: Kreuzberg::Result::ElementMetadataStruct

Inherits:

Struct

• Object
• Struct
• Kreuzberg::Result::ElementMetadataStruct

Defined in:

lib/kreuzberg/result.rb

Instance Attribute Summary

• #additional ⇒ Hash<String, String> readonly

  Additional custom metadata.

• #coordinates ⇒ ElementBoundingBox^? readonly

  Bounding box coordinates if available.

• #element_index ⇒ Integer^? readonly

  Position index in the element sequence.

• #filename ⇒ String^? readonly

  Source filename or document name.

• #page_number ⇒ Integer^? readonly

  Page number (1-indexed).

Instance Method Summary

• #to_h ⇒ Object

Instance Attribute Details

#additional ⇒ Hash<String, String> (readonly)

Returns Additional custom metadata.

Returns:

• (Hash<String, String>) —

  Additional custom metadata

# File 'lib/kreuzberg/result.rb', line 205

ElementMetadataStruct = Struct.new(
  :page_number,
  :filename,
  :coordinates,
  :element_index,
  :additional
) do
  def to_h
    {
      page_number: page_number,
      filename: filename,
      coordinates: coordinates&.to_h,
      element_index: element_index,
      additional: additional
    }
  end
end

#coordinates ⇒ ElementBoundingBox^? (readonly)

Returns Bounding box coordinates if available.

Returns:

• (ElementBoundingBox, nil) —

  Bounding box coordinates if available

# File 'lib/kreuzberg/result.rb', line 205

ElementMetadataStruct = Struct.new(
  :page_number,
  :filename,
  :coordinates,
  :element_index,
  :additional
) do
  def to_h
    {
      page_number: page_number,
      filename: filename,
      coordinates: coordinates&.to_h,
      element_index: element_index,
      additional: additional
    }
  end
end

#element_index ⇒ Integer^? (readonly)

Returns Position index in the element sequence.

Returns:

• (Integer, nil) —

  Position index in the element sequence

# File 'lib/kreuzberg/result.rb', line 205

ElementMetadataStruct = Struct.new(
  :page_number,
  :filename,
  :coordinates,
  :element_index,
  :additional
) do
  def to_h
    {
      page_number: page_number,
      filename: filename,
      coordinates: coordinates&.to_h,
      element_index: element_index,
      additional: additional
    }
  end
end

#filename ⇒ String^? (readonly)

Returns Source filename or document name.

Returns:

• (String, nil) —

  Source filename or document name

# File 'lib/kreuzberg/result.rb', line 205

ElementMetadataStruct = Struct.new(
  :page_number,
  :filename,
  :coordinates,
  :element_index,
  :additional
) do
  def to_h
    {
      page_number: page_number,
      filename: filename,
      coordinates: coordinates&.to_h,
      element_index: element_index,
      additional: additional
    }
  end
end

#page_number ⇒ Integer^? (readonly)

Returns Page number (1-indexed).

Returns:

• (Integer, nil) —

  Page number (1-indexed)

# File 'lib/kreuzberg/result.rb', line 205

ElementMetadataStruct = Struct.new(
  :page_number,
  :filename,
  :coordinates,
  :element_index,
  :additional
) do
  def to_h
    {
      page_number: page_number,
      filename: filename,
      coordinates: coordinates&.to_h,
      element_index: element_index,
      additional: additional
    }
  end
end

Instance Method Details

#to_h ⇒ Object

# File 'lib/kreuzberg/result.rb', line 212

def to_h
  {
    page_number: page_number,
    filename: filename,
    coordinates: coordinates&.to_h,
    element_index: element_index,
    additional: additional
  }
end