langchain.js
Preparing search index...
@langchain/langgraph-checkpoint-redis
store
RedisStore
Class RedisStore
Index
Constructors
constructor
Methods
batch
close
delete
get
get
Statistics
list
Namespaces
put
search
setup
from
Cluster
from
Conn
String
Constructors
constructor
new
RedisStore
(
client
:
RedisConnection
,
config
?:
StoreConfig
)
:
RedisStore
Parameters
client
:
RedisConnection
Optional
config
:
StoreConfig
Returns
RedisStore
Methods
batch
batch
(
ops
:
Operation
[]
)
:
Promise
<
any
[]
>
Parameters
ops
:
Operation
[]
Returns
Promise
<
any
[]
>
close
close
()
:
Promise
<
void
>
Returns
Promise
<
void
>
delete
delete
(
namespace
:
string
[]
,
key
:
string
)
:
Promise
<
void
>
Parameters
namespace
:
string
[]
key
:
string
Returns
Promise
<
void
>
get
get
(
namespace
:
string
[]
,
key
:
string
,
options
?:
{
refreshTTL
?:
boolean
}
,
)
:
Promise
<
null
|
Item
>
Parameters
namespace
:
string
[]
key
:
string
Optional
options
:
{
refreshTTL
?:
boolean
}
Returns
Promise
<
null
|
Item
>
get
Statistics
getStatistics
()
:
Promise
<
{
indexInfo
?:
Record
<
string
,
any
>
;
namespaceCount
:
number
;
totalDocuments
:
number
;
vectorDocuments
?:
number
;
}
,
>
Get statistics about the store. Returns document counts and other metrics.
Returns
Promise
<
{
indexInfo
?:
Record
<
string
,
any
>
;
namespaceCount
:
number
;
totalDocuments
:
number
;
vectorDocuments
?:
number
;
}
,
>
list
Namespaces
listNamespaces
(
options
?:
{
limit
?:
number
;
maxDepth
?:
number
;
offset
?:
number
;
prefix
?:
string
[]
;
suffix
?:
string
[]
;
}
,
)
:
Promise
<
string
[]
[]
>
Parameters
Optional
options
:
{
limit
?:
number
;
maxDepth
?:
number
;
offset
?:
number
;
prefix
?:
string
[]
;
suffix
?:
string
[]
;
}
Returns
Promise
<
string
[]
[]
>
put
put
(
namespace
:
string
[]
,
key
:
string
,
value
:
any
,
options
?:
{
index
?:
boolean
|
string
[]
;
ttl
?:
number
}
,
)
:
Promise
<
void
>
Parameters
namespace
:
string
[]
key
:
string
value
:
any
Optional
options
:
{
index
?:
boolean
|
string
[]
;
ttl
?:
number
}
Returns
Promise
<
void
>
search
search
(
namespacePrefix
:
string
[]
,
options
?:
{
filter
?:
Filter
;
limit
?:
number
;
offset
?:
number
;
query
?:
string
;
refreshTTL
?:
boolean
;
similarityThreshold
?:
number
;
}
,
)
:
Promise
<
SearchItem
[]
>
Parameters
namespacePrefix
:
string
[]
Optional
options
:
{
filter
?:
Filter
;
limit
?:
number
;
offset
?:
number
;
query
?:
string
;
refreshTTL
?:
boolean
;
similarityThreshold
?:
number
;
}
Returns
Promise
<
SearchItem
[]
>
setup
setup
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Static
from
Cluster
fromCluster
(
rootNodes
:
{
url
:
string
}
[]
,
config
?:
StoreConfig
,
)
:
Promise
<
RedisStore
>
Parameters
rootNodes
:
{
url
:
string
}
[]
Optional
config
:
StoreConfig
Returns
Promise
<
RedisStore
>
Static
from
Conn
String
fromConnString
(
connString
:
string
,
config
?:
StoreConfig
)
:
Promise
<
RedisStore
>
Parameters
connString
:
string
Optional
config
:
StoreConfig
Returns
Promise
<
RedisStore
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
batch
close
delete
get
get
Statistics
list
Namespaces
put
search
setup
from
Cluster
from
Conn
String
langchain.js
Loading...
Get statistics about the store. Returns document counts and other metrics.