Package dev.langchain4j.data.segment

Interface TextSegmentTransformer

public interface TextSegmentTransformer
Defines the interface for transforming a TextSegment. Implementations can perform a variety of tasks such as transforming, filtering, enriching, etc.

  • Method Details

    • transform

      TextSegment transform(TextSegment segment)
      Transforms a provided segment.
      Parameters:
      segment - The segment to be transformed.
      Returns:
      The transformed segment, or null if the segment should be filtered out.

    • transformAll

      default List<TextSegment> transformAll(List<TextSegment> segments)
      Transforms all the provided segments.
      Parameters:
      segments - A list of segments to be transformed.
      Returns:
      A list of transformed segments. The length of this list may be shorter or longer than the original list. Returns an empty list if all segments were filtered out.

    • transformAll

      default List<TextSegment> transformAll(TextSegment... textSegments)
      Transforms all the provided TextSegments using varargs input.

      This is a convenience method that allows calling code to pass an arbitrary number of TextSegment instances without needing to explicitly construct a List. Internally, this method delegates to the transformAll(List) method to perform the actual transformation logic, ensuring consistent behavior.

      Parameters:
      textSegments - Varargs array of TextSegments to be transformed. May be null or empty.
      Returns:
      A list of transformed segments. Returns an empty list if all segments were filtered out, or if the input is null or empty.