langchain.js
Preparing search index...
@langchain/textsplitters
TextSplitter
Class TextSplitter
Abstract
Hierarchy (
View Summary
)
BaseDynamicToolInput
TextSplitter
CharacterTextSplitter
RecursiveCharacterTextSplitter
TokenTextSplitter
Implements
TextSplitterParams
Index
Constructors
constructor
Properties
chunk
Overlap
chunk
Size
keep
Separator
lc_
namespace
length
Function
Methods
create
Documents
merge
Splits
split
Documents
split
On
Separator
split
Text
transform
Documents
Constructors
constructor
new
TextSplitter
(
fields
?:
Partial
<
TextSplitterParams
>
)
:
TextSplitter
Parameters
Optional
fields
:
Partial
<
TextSplitterParams
>
Returns
TextSplitter
Properties
chunk
Overlap
chunkOverlap
:
number
= 200
chunk
Size
chunkSize
:
number
= 1000
keep
Separator
keepSeparator
:
boolean
= false
lc_
namespace
lc_namespace
:
string
[]
= ...
length
Function
lengthFunction
:
(
(
text
:
string
)
=>
number
)
|
(
(
text
:
string
)
=>
Promise
<
number
>
)
Methods
create
Documents
createDocuments
(
texts
:
string
[]
,
metadatas
?:
Record
<
string
,
any
>
[]
,
chunkHeaderOptions
?:
TextSplitterChunkHeaderOptions
,
)
:
Promise
<
Document
[]
>
Parameters
texts
:
string
[]
metadatas
:
Record
<
string
,
any
>
[]
= []
chunkHeaderOptions
:
TextSplitterChunkHeaderOptions
= {}
Returns
Promise
<
Document
[]
>
merge
Splits
mergeSplits
(
splits
:
string
[]
,
separator
:
string
)
:
Promise
<
string
[]
>
Parameters
splits
:
string
[]
separator
:
string
Returns
Promise
<
string
[]
>
split
Documents
splitDocuments
(
documents
:
Document
[]
,
chunkHeaderOptions
?:
TextSplitterChunkHeaderOptions
,
)
:
Promise
<
Document
[]
>
Parameters
documents
:
Document
[]
chunkHeaderOptions
:
TextSplitterChunkHeaderOptions
= {}
Returns
Promise
<
Document
[]
>
Protected
split
On
Separator
splitOnSeparator
(
text
:
string
,
separator
:
string
)
:
string
[]
Parameters
text
:
string
separator
:
string
Returns
string
[]
Abstract
split
Text
splitText
(
text
:
string
)
:
Promise
<
string
[]
>
Parameters
text
:
string
Returns
Promise
<
string
[]
>
transform
Documents
transformDocuments
(
documents
:
Document
[]
,
chunkHeaderOptions
?:
TextSplitterChunkHeaderOptions
,
)
:
Promise
<
Document
[]
>
Parameters
documents
:
Document
[]
chunkHeaderOptions
:
TextSplitterChunkHeaderOptions
= {}
Returns
Promise
<
Document
[]
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
chunk
Overlap
chunk
Size
keep
Separator
lc_
namespace
length
Function
Methods
create
Documents
merge
Splits
split
Documents
split
On
Separator
split
Text
transform
Documents
langchain.js
Loading...