class TextSplitter extends AnyRef
Splits texts recursively to match given length
- Alphabetic
- By Inheritance
- TextSplitter
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new TextSplitter(chunkSize: Int, chunkOverlap: Int, keepSeparators: Boolean, patternsAreRegex: Boolean, trimWhitespace: Boolean, lengthFunction: (String) => Int = _.length)
- chunkSize
Length of the text chunks, measured by
lengthFunction- chunkOverlap
Overlap of the text chunks
- keepSeparators
Whether to keep separators in the final chunks
- patternsAreRegex
Whether to interpret split patterns as regex
- trimWhitespace
Whether to trim the whitespace from the final chunks
- lengthFunction
Function to measure chunk length
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def escapeRegexIfNeeded(text: String): String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def joinDocs(currentDoc: Seq[String], separator: String): String
- def mergeSplits(splits: Seq[String], separator: String): Seq[String]
Combines smaller text chunks into one that has about the size of chunk size.
Combines smaller text chunks into one that has about the size of chunk size.
- splits
Splits from the previous separator
- separator
The current separator
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def splitText(text: String, separators: Seq[String]): Seq[String]
Splits a text into chunks of roughly given chunk size.
Splits a text into chunks of roughly given chunk size. The separators are given in a list and will be used in order.
Inspired by LangChain's RecursiveCharacterTextSplitter.
- text
Text to split
- separators
List of separators in decreasing priority
- def splitTextWithRegex(text: String, separator: String): Seq[String]
Splits the given text with the separator.
Splits the given text with the separator.
The separator is assumed to be regex (which was optionally escaped).
- text
Text to split
- separator
Regex as String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)