Class TokenTextSplitter

Implementation of splitter which looks at tokens.

Hierarchy

TextSplitter
- TokenTextSplitter

Implements

TokenTextSplitterParams

Index

Constructors

Properties

allowedSpecial chunkOverlap chunkSize disallowedSpecial encodingName keepSeparator lengthFunction

Methods

createDocuments mergeSplits splitDocuments splitText transformDocuments splitOnSeparator

Constructors

constructor

new TokenTextSplitter(fields?): TokenTextSplitter
Parameters
- Optional fields: Partial<TokenTextSplitterParams>
Returns TokenTextSplitter
Overrides TextSplitter.constructor
- Defined in langchain/src/text_splitter.ts:733

Properties

allowedSpecial

allowedSpecial: string[] | "all"

chunkOverlap

chunkOverlap: number = 200

chunkSize

chunkSize: number = 1000

disallowedSpecial

disallowedSpecial: string[] | "all"

encodingName

encodingName: TiktokenEncoding

keepSeparator

keepSeparator: boolean = false

lengthFunction

lengthFunction: ((text) => number) | ((text) => Promise<number>)

Type declaration

- (text): number
- Parameters
  - text: string
  Returns number

Type declaration

- (text): Promise<number>
- Parameters
  - text: string
  Returns Promise<number>

Methods

createDocuments

createDocuments(texts, metadatas?, chunkHeaderOptions?): Promise<Document[]>
Parameters
- texts: string[]
- metadatas: Record<string, any>[] = []
- chunkHeaderOptions: TextSplitterChunkHeaderOptions = {}
Returns Promise<Document[]>
Inherited from TextSplitter.createDocuments
- Defined in langchain/src/text_splitter.ts:75

mergeSplits

mergeSplits(splits, separator): Promise<string[]>
Parameters
- splits: string[]
- separator: string
Returns Promise<string[]>
Inherited from TextSplitter.mergeSplits
- Defined in langchain/src/text_splitter.ts:181

splitDocuments

splitDocuments(documents, chunkHeaderOptions?): Promise<Document[]>
Parameters
- documents: Document[]
- chunkHeaderOptions: TextSplitterChunkHeaderOptions = {}
Returns Promise<Document[]>
Inherited from TextSplitter.splitDocuments
- Defined in langchain/src/text_splitter.ts:164

splitText

splitText(text): Promise<string[]>
Parameters
- text: string
Returns Promise<string[]>
Overrides TextSplitter.splitText
- Defined in langchain/src/text_splitter.ts:741

transformDocuments

transformDocuments(documents, chunkHeaderOptions?): Promise<Document[]>
Parameters
- documents: Document[]
- chunkHeaderOptions: TextSplitterChunkHeaderOptions = {}
Returns Promise<Document[]>
Inherited from TextSplitter.transformDocuments
- Defined in langchain/src/text_splitter.ts:48

`Protected` splitOnSeparator

splitOnSeparator(text, separator): string[]
Parameters
- text: string
- separator: string
Returns string[]
Inherited from TextSplitter.splitOnSeparator
- Defined in langchain/src/text_splitter.ts:57

Generated using TypeDoc