Class MarkdownTextSplitter

chunkOverlap

chunkSize

keepSeparator

lengthFunction

separators

createDocuments

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

• Parameters

  • texts: string[]
  • metadatas: Record<string, any>[] = []
  • chunkHeaderOptions: TextSplitterChunkHeaderOptions = {}

  Returns Promise<Document[]>

mergeSplits

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

• Parameters

  • splits: string[]
  • separator: string

  Returns Promise<string[]>

splitDocuments

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

• Parameters

  • documents: Document[]
  • chunkHeaderOptions: TextSplitterChunkHeaderOptions = {}

  Returns Promise<Document[]>

splitText

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

• Parameters

  • text: string

  Returns Promise<string[]>

transformDocuments

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

• Parameters

  • documents: Document[]
  • chunkHeaderOptions: TextSplitterChunkHeaderOptions = {}

  Returns Promise<Document[]>

StaticfromLanguage

• fromLanguage(language, options?): RecursiveCharacterTextSplitter

• Parameters

  • language:
        | "html"
        | "cpp"
        | "go"
        | "java"
        | "js"
        | "php"
        | "proto"
        | "python"
        | "rst"
        | "ruby"
        | "rust"
        | "scala"
        | "swift"
        | "markdown"
        | "latex"
        | "sol"
  • Optionaloptions: Partial<RecursiveCharacterTextSplitterParams>

  Returns RecursiveCharacterTextSplitter

StaticgetSeparatorsForLanguage

• getSeparatorsForLanguage(language): string[]

• Parameters

  • language:
        | "html"
        | "cpp"
        | "go"
        | "java"
        | "js"
        | "php"
        | "proto"
        | "python"
        | "rst"
        | "ruby"
        | "rust"
        | "scala"
        | "swift"
        | "markdown"
        | "latex"
        | "sol"

  Returns string[]