Skip to main content

Class: MarkdownTextSplitter

text_splitter.MarkdownTextSplitter

Hierarchy

Implements

Constructors

constructor

new MarkdownTextSplitter(fields?)

Parameters

NameType
fields?Partial<TextSplitterParams>

Overrides

RecursiveCharacterTextSplitter.constructor

Defined in

langchain/src/text_splitter.ts:329

Properties

chunkOverlap

chunkOverlap: number = 200

Implementation of

MarkdownTextSplitterParams.chunkOverlap

Inherited from

RecursiveCharacterTextSplitter.chunkOverlap

Defined in

langchain/src/text_splitter.ts:13


chunkSize

chunkSize: number = 1000

Implementation of

MarkdownTextSplitterParams.chunkSize

Inherited from

RecursiveCharacterTextSplitter.chunkSize

Defined in

langchain/src/text_splitter.ts:11


separators

separators: string[]

Overrides

RecursiveCharacterTextSplitter.separators

Defined in

langchain/src/text_splitter.ts:305

Methods

createDocuments

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

Parameters

NameTypeDefault value
textsstring[]undefined
metadatasRecord<string, any>[][]

Returns

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

Inherited from

RecursiveCharacterTextSplitter.createDocuments

Defined in

langchain/src/text_splitter.ts:25


mergeSplits

mergeSplits(splits, separator): string[]

Parameters

NameType
splitsstring[]
separatorstring

Returns

string[]

Inherited from

RecursiveCharacterTextSplitter.mergeSplits

Defined in

langchain/src/text_splitter.ts:90


splitDocuments

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

Parameters

NameType
documentsDocument<Record<string, any>>[]

Returns

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

Inherited from

RecursiveCharacterTextSplitter.splitDocuments

Defined in

langchain/src/text_splitter.ts:79


splitText

splitText(text): Promise<string[]>

Parameters

NameType
textstring

Returns

Promise<string[]>

Inherited from

RecursiveCharacterTextSplitter.splitText

Defined in

langchain/src/text_splitter.ts:174