v0.2
v0.1
Preparing search index...
The search index is not available
LangChain.js - v0.2.8
LangChain.js
langchain-textsplitters
MarkdownTextSplitter
Class MarkdownTextSplitter
Hierarchy (
view full
)
RecursiveCharacterTextSplitter
MarkdownTextSplitter
Implements
MarkdownTextSplitterParams
Index
Constructors
constructor
Properties
chunk
Overlap
chunk
Size
keep
Separator
length
Function
separators
Methods
create
Documents
merge
Splits
split
Documents
split
Text
transform
Documents
from
Language
get
Separators
For
Language
split
On
Separator
Constructors
constructor
new
Markdown
Text
Splitter
(
fields
?
)
:
MarkdownTextSplitter
Parameters
Optional
fields
:
Partial
<
TextSplitterParams
>
Returns
MarkdownTextSplitter
Properties
chunk
Overlap
chunk
Overlap
:
number
= 200
chunk
Size
chunk
Size
:
number
= 1000
keep
Separator
keep
Separator
:
boolean
= false
length
Function
length
Function
:
(
(
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
>
separators
separators
:
string
[]
= ...
Methods
create
Documents
create
Documents
(
texts
,
metadatas
?
,
chunkHeaderOptions
?
)
:
Promise
<
Document
[]
>
Parameters
texts
:
string
[]
metadatas
:
Record
<
string
,
any
>
[]
= []
chunkHeaderOptions
:
TextSplitterChunkHeaderOptions
= {}
Returns
Promise
<
Document
[]
>
merge
Splits
merge
Splits
(
splits
,
separator
)
:
Promise
<
string
[]
>
Parameters
splits
:
string
[]
separator
:
string
Returns
Promise
<
string
[]
>
split
Documents
split
Documents
(
documents
,
chunkHeaderOptions
?
)
:
Promise
<
Document
[]
>
Parameters
documents
:
Document
[]
chunkHeaderOptions
:
TextSplitterChunkHeaderOptions
= {}
Returns
Promise
<
Document
[]
>
split
Text
split
Text
(
text
)
:
Promise
<
string
[]
>
Parameters
text
:
string
Returns
Promise
<
string
[]
>
transform
Documents
transform
Documents
(
documents
,
chunkHeaderOptions
?
)
:
Promise
<
Document
[]
>
Parameters
documents
:
Document
[]
chunkHeaderOptions
:
TextSplitterChunkHeaderOptions
= {}
Returns
Promise
<
Document
[]
>
Static
from
Language
from
Language
(
language
,
options
?
)
:
RecursiveCharacterTextSplitter
Parameters
language
:
"html"
|
"cpp"
|
"go"
|
"java"
|
"js"
|
"php"
|
"proto"
|
"python"
|
"rst"
|
"ruby"
|
"rust"
|
"scala"
|
"swift"
|
"markdown"
|
"latex"
|
"sol"
Optional
options
:
Partial
<
RecursiveCharacterTextSplitterParams
>
Returns
RecursiveCharacterTextSplitter
Static
get
Separators
For
Language
get
Separators
For
Language
(
language
)
:
string
[]
Parameters
language
:
"html"
|
"cpp"
|
"go"
|
"java"
|
"js"
|
"php"
|
"proto"
|
"python"
|
"rst"
|
"ruby"
|
"rust"
|
"scala"
|
"swift"
|
"markdown"
|
"latex"
|
"sol"
Returns
string
[]
Protected
split
On
Separator
split
On
Separator
(
text
,
separator
)
:
string
[]
Parameters
text
:
string
separator
:
string
Returns
string
[]
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
constructor
chunk
Overlap
chunk
Size
keep
Separator
length
Function
separators
create
Documents
merge
Splits
split
Documents
split
Text
transform
Documents
from
Language
get
Separators
For
Language
split
On
Separator
LangChain.js - v0.2.8
langchain-anthropic
langchain-aws
langchain-azure-dynamic-sessions
langchain-azure-openai
langchain-cloudflare
langchain-cohere
langchain-community
agents/toolkits
aws_sfn
base
connery
caches
cloudflare_kv
ioredis
momento
upstash_redis
callbacks/handlers
llmonitor
lunary
upstash_ratelimit
chains/graph_qa/cypher
Loading...
Generated using
TypeDoc