Class: CharacterTextSplitter

text_splitter.CharacterTextSplitter

Hierarchy

• TextSplitter

  ↳ CharacterTextSplitter

Implements

• CharacterTextSplitterParams

Constructors

constructor

• new CharacterTextSplitter(fields?)

Parameters

Name	Type
fields?	Partial<CharacterTextSplitterParams>

Overrides

TextSplitter.constructor

Defined in

langchain/src/text_splitter.ts:141

Properties

chunkOverlap

• chunkOverlap: number = 200

Implementation of

CharacterTextSplitterParams.chunkOverlap

Inherited from

TextSplitter.chunkOverlap

Defined in

langchain/src/text_splitter.ts:13

---

chunkSize

• chunkSize: number = 1000

Implementation of

CharacterTextSplitterParams.chunkSize

Inherited from

TextSplitter.chunkSize

Defined in

langchain/src/text_splitter.ts:11

---

separator

• separator: string = "\n\n"

Implementation of

CharacterTextSplitterParams.separator

Defined in

langchain/src/text_splitter.ts:139

Methods

createDocuments

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

Parameters

Name	Type	Default value
texts	string[]	undefined
metadatas	Record<string, any>[]	[]

Returns

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

Inherited from

TextSplitter.createDocuments

Defined in

langchain/src/text_splitter.ts:25

---

mergeSplits

▸ mergeSplits(splits, separator): string[]

Parameters

Name	Type
splits	string[]
separator	string

Returns

string[]

Inherited from

TextSplitter.mergeSplits

Defined in

langchain/src/text_splitter.ts:90

---

splitDocuments

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

Parameters

Name	Type
documents	Document<Record<string, any>>[]

Returns

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

Inherited from

TextSplitter.splitDocuments

Defined in

langchain/src/text_splitter.ts:79

---

splitText

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

Parameters

Name	Type
text	string

Returns

Promise<string[]>

Overrides

TextSplitter.splitText

Defined in

langchain/src/text_splitter.ts:146