Class TextSplitterAbstract

constructor

• new TextSplitter(fields?): TextSplitter

• Parameters

  • Optional fields: Partial<TextSplitterParams>

  Returns TextSplitter

chunkOverlap

chunkSize

keepSeparator

lengthFunction

createDocuments

• createDocuments(texts, metadatas?, chunkHeaderOptions?): Promise<Document<Record<string, any>>[]>

• Parameters

  • texts: string[]

  • metadatas: Record<string, any>[] = []

  • chunkHeaderOptions: TextSplitterChunkHeaderOptions = {}

  Returns Promise<Document<Record<string, any>>[]>

mergeSplits

• mergeSplits(splits, separator): Promise<string[]>

• Parameters

  • splits: string[]

  • separator: string

  Returns Promise<string[]>

splitDocuments

• splitDocuments(documents, chunkHeaderOptions?): Promise<Document<Record<string, any>>[]>

• Parameters

  • documents: Document<Record<string, any>>[]

  • chunkHeaderOptions: TextSplitterChunkHeaderOptions = {}

  Returns Promise<Document<Record<string, any>>[]>

Abstract splitText

• splitText(text): Promise<string[]>

• Parameters

  • text: string

  Returns Promise<string[]>

transformDocuments

• transformDocuments(documents, chunkHeaderOptions?): Promise<Document<Record<string, any>>[]>

• Parameters

  • documents: Document<Record<string, any>>[]

  • chunkHeaderOptions: TextSplitterChunkHeaderOptions = {}

  Returns Promise<Document<Record<string, any>>[]>