@ferricstore/ferricstore 0.12.0 → 0.12.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -0
- package/dist/langgraph.cjs +395 -125
- package/dist/langgraph.cjs.map +1 -1
- package/dist/langgraph.d.cts +17 -7
- package/dist/langgraph.d.ts +17 -7
- package/dist/langgraph.js +396 -126
- package/dist/langgraph.js.map +1 -1
- package/dist/openai-agents.cjs +161 -24
- package/dist/openai-agents.cjs.map +1 -1
- package/dist/openai-agents.d.cts +10 -4
- package/dist/openai-agents.d.ts +10 -4
- package/dist/openai-agents.js +161 -24
- package/dist/openai-agents.js.map +1 -1
- package/docs/agent-api/assets/hierarchy.js +1 -0
- package/docs/agent-api/assets/highlight.css +92 -0
- package/docs/agent-api/assets/icons.js +18 -0
- package/docs/agent-api/assets/icons.svg +1 -0
- package/docs/agent-api/assets/main.js +60 -0
- package/docs/agent-api/assets/navigation.js +1 -0
- package/docs/agent-api/assets/search.js +1 -0
- package/docs/agent-api/assets/style.css +1648 -0
- package/docs/agent-api/classes/langgraph.FerricStoreSaver.html +297 -0
- package/docs/agent-api/classes/langgraph.FerricStoreStore.html +298 -0
- package/docs/agent-api/classes/langgraph.LangGraphFlow.html +190 -0
- package/docs/agent-api/classes/langgraph.LangGraphFlowContext.html +158 -0
- package/docs/agent-api/classes/langgraph.LangGraphFlowRun.html +133 -0
- package/docs/agent-api/classes/openai-agents.FerricStoreSession.html +241 -0
- package/docs/agent-api/hierarchy.html +44 -0
- package/docs/agent-api/index.html +142 -0
- package/docs/agent-api/interfaces/langgraph.FerricFlowHandlerContext.html +94 -0
- package/docs/agent-api/interfaces/langgraph.FerricStoreCommandClient.html +77 -0
- package/docs/agent-api/interfaces/langgraph.FerricStoreLockOptions.html +81 -0
- package/docs/agent-api/interfaces/langgraph.FerricStoreSaverOptions.html +106 -0
- package/docs/agent-api/interfaces/langgraph.FerricStoreStoreOptions.html +98 -0
- package/docs/agent-api/interfaces/langgraph.InvokableLangGraph.html +83 -0
- package/docs/agent-api/interfaces/langgraph.LangGraphFlowOptions.html +116 -0
- package/docs/agent-api/interfaces/openai-agents.FerricStoreSessionOptions.html +114 -0
- package/docs/agent-api/interfaces/openai-agents.Session.html +208 -0
- package/docs/agent-api/interfaces/openai-agents.SessionHistoryRewriteAwareSession.html +230 -0
- package/docs/agent-api/interfaces/openai-agents.SessionHistoryTransactionAwareSession.html +237 -0
- package/docs/agent-api/modules/langgraph.html +44 -0
- package/docs/agent-api/modules/openai-agents.html +44 -0
- package/docs/agent-api/modules.html +35 -0
- package/docs/agent-api/types/langgraph.LangGraphChannelVersions.html +33 -0
- package/docs/agent-api/types/langgraph.LangGraphInvocationConfig.html +33 -0
- package/docs/agent-api/types/langgraph.LangGraphOutcomeMapper.html +50 -0
- package/docs/agent-api/types/langgraph.LangGraphPendingWrite.html +33 -0
- package/docs/agent-api/types/openai-agents.AgentInputItem.html +35 -0
- package/docs/agent-frameworks.md +25 -8
- package/docs/api/index.html +4 -1
- package/docs/api/media/agent-frameworks.md +25 -8
- package/package.json +5 -5
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FerricStoreStore | @ferricstore/ferricstore</title><meta name="description" content="Documentation for @ferricstore/ferricstore"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@ferricstore/ferricstore</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="../modules/langgraph.html">langgraph</a></li>
|
|
12
|
+
<li><a href="" aria-current="page">FerricStoreStore</a></li></ul>
|
|
13
|
+
<h1>Class FerricStoreStore</h1></div>
|
|
14
|
+
<section class="tsd-panel tsd-comment">
|
|
15
|
+
<div class="tsd-comment tsd-typography"><p>LangGraph.js long-term memory store backed by FerricStore.</p>
|
|
16
|
+
<p>It implements hierarchical namespaces, exact/comparison filters, ordered
|
|
17
|
+
pagination, batching, CAS-protected item commits, and append-only discovery
|
|
18
|
+
indexes. Vector search is deliberately rejected until a semantic index is
|
|
19
|
+
configured rather than silently returning an unranked result.</p>
|
|
20
|
+
</div></section>
|
|
21
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="216">
|
|
22
|
+
<h4>Hierarchy</h4>
|
|
23
|
+
<ul class="tsd-hierarchy">
|
|
24
|
+
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">BaseStore</span>
|
|
25
|
+
<ul class="tsd-hierarchy">
|
|
26
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">FerricStoreStore</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
27
|
+
<ul>
|
|
28
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/store.ts#L55">langgraph/store.ts:55</a></li></ul></aside>
|
|
29
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
30
|
+
<section class="tsd-panel tsd-index-panel">
|
|
31
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
32
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
33
|
+
<div class="tsd-accordion-details">
|
|
34
|
+
<section class="tsd-index-section">
|
|
35
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
36
|
+
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
37
|
+
</div></section>
|
|
38
|
+
<section class="tsd-index-section">
|
|
39
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
40
|
+
<div class="tsd-index-list"><a href="#client" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client</span></a>
|
|
41
|
+
<a href="#keyprefix" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key<wbr/>Prefix</span></a>
|
|
42
|
+
<a href="#scancount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scan<wbr/>Count</span></a>
|
|
43
|
+
</div></section>
|
|
44
|
+
<section class="tsd-index-section">
|
|
45
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
46
|
+
<div class="tsd-index-list"><a href="#batch" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch</span></a>
|
|
47
|
+
<a href="#delete" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a>
|
|
48
|
+
<a href="#get" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a>
|
|
49
|
+
<a href="#listnamespaces" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Namespaces</span></a>
|
|
50
|
+
<a href="#put" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put</span></a>
|
|
51
|
+
<a href="#search" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search</span></a>
|
|
52
|
+
<a href="#start" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a>
|
|
53
|
+
<a href="#stop" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a>
|
|
54
|
+
</div></section></div></details></section></section>
|
|
55
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
56
|
+
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
57
|
+
<section>
|
|
58
|
+
<section class="tsd-panel tsd-member">
|
|
59
|
+
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
60
|
+
<ul class="tsd-signatures">
|
|
61
|
+
<li class="">
|
|
62
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorferricstorestore"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">FerricStoreStore</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">client</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/langgraph.FerricStoreCommandClient.html" class="tsd-signature-type tsd-kind-interface">FerricStoreCommandClient</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/langgraph.FerricStoreStoreOptions.html" class="tsd-signature-type tsd-kind-interface">FerricStoreStoreOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">FerricStoreStore</a><a href="#constructorferricstorestore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
63
|
+
<div class="tsd-description">
|
|
64
|
+
<div class="tsd-parameters">
|
|
65
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
66
|
+
<ul class="tsd-parameter-list">
|
|
67
|
+
<li><span><span class="tsd-kind-parameter">client</span>: <a href="../interfaces/langgraph.FerricStoreCommandClient.html" class="tsd-signature-type tsd-kind-interface">FerricStoreCommandClient</a></span></li>
|
|
68
|
+
<li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/langgraph.FerricStoreStoreOptions.html" class="tsd-signature-type tsd-kind-interface">FerricStoreStoreOptions</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div>
|
|
69
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">FerricStoreStore</a></h4><aside class="tsd-sources">
|
|
70
|
+
<p>Overrides BaseStore.constructor</p>
|
|
71
|
+
<ul>
|
|
72
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/store.ts#L61">langgraph/store.ts:61</a></li></ul></aside></div></li></ul></section></section></details>
|
|
73
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
74
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
75
|
+
<section>
|
|
76
|
+
<section class="tsd-panel tsd-member">
|
|
77
|
+
<h3 class="tsd-anchor-link" id="client"><code class="tsd-tag">Readonly</code><span>client</span><a href="#client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
78
|
+
<div class="tsd-signature"><span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/langgraph.FerricStoreCommandClient.html" class="tsd-signature-type tsd-kind-interface">FerricStoreCommandClient</a></div><aside class="tsd-sources">
|
|
79
|
+
<ul>
|
|
80
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/store.ts#L56">langgraph/store.ts:56</a></li></ul></aside></section>
|
|
81
|
+
<section class="tsd-panel tsd-member">
|
|
82
|
+
<h3 class="tsd-anchor-link" id="keyprefix"><code class="tsd-tag">Readonly</code><span>key<wbr/>Prefix</span><a href="#keyprefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
|
+
<div class="tsd-signature"><span class="tsd-kind-property">keyPrefix</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
|
|
84
|
+
<ul>
|
|
85
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/store.ts#L57">langgraph/store.ts:57</a></li></ul></aside></section>
|
|
86
|
+
<section class="tsd-panel tsd-member">
|
|
87
|
+
<h3 class="tsd-anchor-link" id="scancount"><code class="tsd-tag">Readonly</code><span>scan<wbr/>Count</span><a href="#scancount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
88
|
+
<div class="tsd-signature"><span class="tsd-kind-property">scanCount</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
|
89
|
+
<ul>
|
|
90
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/store.ts#L58">langgraph/store.ts:58</a></li></ul></aside></section></section></details>
|
|
91
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
92
|
+
<h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
93
|
+
<section>
|
|
94
|
+
<section class="tsd-panel tsd-member">
|
|
95
|
+
<h3 class="tsd-anchor-link" id="batch"><span>batch</span><a href="#batch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
96
|
+
<ul class="tsd-signatures">
|
|
97
|
+
<li class="">
|
|
98
|
+
<div class="tsd-signature tsd-anchor-link" id="batch-1"><span class="tsd-kind-call-signature">batch</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#batchop">Op</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Operation</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">operations</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#batchop">Op</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OperationResults</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#batchop">Op</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#batch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
99
|
+
<div class="tsd-description">
|
|
100
|
+
<div class="tsd-comment tsd-typography"><p>Execute multiple operations in a single batch.
|
|
101
|
+
This is more efficient than executing operations individually.</p>
|
|
102
|
+
</div>
|
|
103
|
+
<section class="tsd-panel">
|
|
104
|
+
<h4>Type Parameters</h4>
|
|
105
|
+
<ul class="tsd-type-parameter-list">
|
|
106
|
+
<li><span id="batchop"><span class="tsd-kind-type-parameter">Op</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Operation</span><span class="tsd-signature-symbol">[]</span></span></li></ul></section>
|
|
107
|
+
<div class="tsd-parameters">
|
|
108
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
109
|
+
<ul class="tsd-parameter-list">
|
|
110
|
+
<li><span><span class="tsd-kind-parameter">operations</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#batchop">Op</a></span>
|
|
111
|
+
<div class="tsd-comment tsd-typography"><p>Array of operations to execute</p>
|
|
112
|
+
</div></li></ul></div>
|
|
113
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">OperationResults</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#batchop">Op</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to results matching the operations</p>
|
|
114
|
+
<aside class="tsd-sources">
|
|
115
|
+
<p>Overrides BaseStore.batch</p>
|
|
116
|
+
<ul>
|
|
117
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/langgraph/store.ts#L73">langgraph/store.ts:73</a></li></ul></aside></div></li></ul></section>
|
|
118
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
119
|
+
<h3 class="tsd-anchor-link" id="delete"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
120
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
121
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
122
|
+
<div class="tsd-signature tsd-anchor-link" id="delete-1"><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">namespace</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
123
|
+
<div class="tsd-description">
|
|
124
|
+
<div class="tsd-comment tsd-typography"><p>Delete an item from the store.</p>
|
|
125
|
+
</div>
|
|
126
|
+
<div class="tsd-parameters">
|
|
127
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
128
|
+
<ul class="tsd-parameter-list">
|
|
129
|
+
<li><span><span class="tsd-kind-parameter">namespace</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
130
|
+
<div class="tsd-comment tsd-typography"><p>Hierarchical path for the item</p>
|
|
131
|
+
</div></li>
|
|
132
|
+
<li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span>
|
|
133
|
+
<div class="tsd-comment tsd-typography"><p>Unique identifier within the namespace</p>
|
|
134
|
+
</div></li></ul></div>
|
|
135
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
136
|
+
<p>Inherited from BaseStore.delete</p>
|
|
137
|
+
<ul>
|
|
138
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts#L352">../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts:352</a></li></ul></aside></div></li></ul></section>
|
|
139
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
140
|
+
<h3 class="tsd-anchor-link" id="get"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
141
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
142
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
143
|
+
<div class="tsd-signature tsd-anchor-link" id="get-1"><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">namespace</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Item</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><a href="#get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
144
|
+
<div class="tsd-description">
|
|
145
|
+
<div class="tsd-comment tsd-typography"><p>Retrieve a single item by its namespace and key.</p>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="tsd-parameters">
|
|
148
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
149
|
+
<ul class="tsd-parameter-list">
|
|
150
|
+
<li><span><span class="tsd-kind-parameter">namespace</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
151
|
+
<div class="tsd-comment tsd-typography"><p>Hierarchical path for the item</p>
|
|
152
|
+
</div></li>
|
|
153
|
+
<li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span>
|
|
154
|
+
<div class="tsd-comment tsd-typography"><p>Unique identifier within the namespace</p>
|
|
155
|
+
</div></li></ul></div>
|
|
156
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Item</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to the item or null if not found</p>
|
|
157
|
+
<aside class="tsd-sources">
|
|
158
|
+
<p>Inherited from BaseStore.get</p>
|
|
159
|
+
<ul>
|
|
160
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts#L293">../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts:293</a></li></ul></aside></div></li></ul></section>
|
|
161
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
162
|
+
<h3 class="tsd-anchor-link" id="listnamespaces"><span>list<wbr/>Namespaces</span><a href="#listnamespaces" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
163
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
164
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
165
|
+
<div class="tsd-signature tsd-anchor-link" id="listnamespaces-1"><span class="tsd-kind-call-signature">listNamespaces</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">maxDepth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suffix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#listnamespaces-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
166
|
+
<div class="tsd-description">
|
|
167
|
+
<div class="tsd-comment tsd-typography"><p>List and filter namespaces in the store.
|
|
168
|
+
Used to explore data organization and navigate the namespace hierarchy.</p>
|
|
169
|
+
</div>
|
|
170
|
+
<div class="tsd-parameters">
|
|
171
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
172
|
+
<ul class="tsd-parameter-list">
|
|
173
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">maxDepth</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">suffix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span>
|
|
174
|
+
<div class="tsd-comment tsd-typography"><p>Options for listing namespaces</p>
|
|
175
|
+
</div></li></ul></div>
|
|
176
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to list of namespace paths</p>
|
|
177
|
+
|
|
178
|
+
<div class="tsd-comment tsd-typography">
|
|
179
|
+
<div class="tsd-tag-example">
|
|
180
|
+
<h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">// List all namespaces under "documents"</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">listNamespaces</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">prefix:</span><span class="hl-1"> [</span><span class="hl-2">"documents"</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-4">maxDepth:</span><span class="hl-1"> </span><span class="hl-8">2</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-9">// List namespaces ending with "v1"</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">listNamespaces</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">suffix:</span><span class="hl-1"> [</span><span class="hl-2">"v1"</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-4">limit:</span><span class="hl-1"> </span><span class="hl-8">50</span><br/><span class="hl-1">});</span>
|
|
181
|
+
</code><button type="button">Copy</button></pre>
|
|
182
|
+
|
|
183
|
+
</div></div><aside class="tsd-sources">
|
|
184
|
+
<p>Inherited from BaseStore.listNamespaces</p>
|
|
185
|
+
<ul>
|
|
186
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts#L373">../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts:373</a></li></ul></aside></div></li></ul></section>
|
|
187
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
188
|
+
<h3 class="tsd-anchor-link" id="put"><span>put</span><a href="#put" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
189
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
190
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
191
|
+
<div class="tsd-signature tsd-anchor-link" id="put-1"><span class="tsd-kind-call-signature">put</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">namespace</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">false</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#put-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
192
|
+
<div class="tsd-description">
|
|
193
|
+
<div class="tsd-comment tsd-typography"><p>Store or update an item.</p>
|
|
194
|
+
</div>
|
|
195
|
+
<div class="tsd-parameters">
|
|
196
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
197
|
+
<ul class="tsd-parameter-list">
|
|
198
|
+
<li><span><span class="tsd-kind-parameter">namespace</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
199
|
+
<div class="tsd-comment tsd-typography"><p>Hierarchical path for the item</p>
|
|
200
|
+
</div></li>
|
|
201
|
+
<li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span>
|
|
202
|
+
<div class="tsd-comment tsd-typography"><p>Unique identifier within the namespace</p>
|
|
203
|
+
</div></li>
|
|
204
|
+
<li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span>
|
|
205
|
+
<div class="tsd-comment tsd-typography"><p>Object containing the item's data</p>
|
|
206
|
+
</div></li>
|
|
207
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">false</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
208
|
+
<div class="tsd-comment tsd-typography"><p>Optional indexing configuration</p>
|
|
209
|
+
</div></li></ul></div>
|
|
210
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
211
|
+
<div class="tsd-comment tsd-typography">
|
|
212
|
+
<div class="tsd-tag-example">
|
|
213
|
+
<h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">// Simple storage</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">put</span><span class="hl-1">([</span><span class="hl-2">"docs"</span><span class="hl-1">], </span><span class="hl-2">"report"</span><span class="hl-1">, { </span><span class="hl-4">title:</span><span class="hl-1"> </span><span class="hl-2">"Annual Report"</span><span class="hl-1"> });</span><br/><br/><span class="hl-9">// With specific field indexing</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">put</span><span class="hl-1">(</span><br/><span class="hl-1"> [</span><span class="hl-2">"docs"</span><span class="hl-1">],</span><br/><span class="hl-1"> </span><span class="hl-2">"report"</span><span class="hl-1">,</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-4">title:</span><span class="hl-1"> </span><span class="hl-2">"Q4 Report"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">chapters:</span><span class="hl-1"> [{ </span><span class="hl-4">content:</span><span class="hl-1"> </span><span class="hl-2">"..."</span><span class="hl-1"> }, { </span><span class="hl-4">content:</span><span class="hl-1"> </span><span class="hl-2">"..."</span><span class="hl-1"> }]</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> [</span><span class="hl-2">"title"</span><span class="hl-1">, </span><span class="hl-2">"chapters[*].content"</span><span class="hl-1">]</span><br/><span class="hl-1">);</span>
|
|
214
|
+
</code><button type="button">Copy</button></pre>
|
|
215
|
+
|
|
216
|
+
</div></div><aside class="tsd-sources">
|
|
217
|
+
<p>Inherited from BaseStore.put</p>
|
|
218
|
+
<ul>
|
|
219
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts#L345">../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts:345</a></li></ul></aside></div></li></ul></section>
|
|
220
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
221
|
+
<h3 class="tsd-anchor-link" id="search"><span>search</span><a href="#search" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
222
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
223
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
224
|
+
<div class="tsd-signature tsd-anchor-link" id="search-1"><span class="tsd-kind-call-signature">search</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">namespacePrefix</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SearchItem</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#search-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
225
|
+
<div class="tsd-description">
|
|
226
|
+
<div class="tsd-comment tsd-typography"><p>Search for items within a namespace prefix.
|
|
227
|
+
Supports both metadata filtering and vector similarity search.</p>
|
|
228
|
+
</div>
|
|
229
|
+
<div class="tsd-parameters">
|
|
230
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
231
|
+
<ul class="tsd-parameter-list">
|
|
232
|
+
<li><span><span class="tsd-kind-parameter">namespacePrefix</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span>
|
|
233
|
+
<div class="tsd-comment tsd-typography"><p>Hierarchical path prefix to search within</p>
|
|
234
|
+
</div></li>
|
|
235
|
+
<li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">offset</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span>
|
|
236
|
+
<div class="tsd-comment tsd-typography"><p>Search options for filtering and pagination</p>
|
|
237
|
+
</div></li></ul></div>
|
|
238
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SearchItem</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to list of matching items with relevance scores</p>
|
|
239
|
+
|
|
240
|
+
<div class="tsd-comment tsd-typography">
|
|
241
|
+
<div class="tsd-tag-example">
|
|
242
|
+
<h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-9">// Search with filters</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">search</span><span class="hl-1">([</span><span class="hl-2">"documents"</span><span class="hl-1">], {</span><br/><span class="hl-1"> </span><span class="hl-4">filter:</span><span class="hl-1"> { </span><span class="hl-4">type:</span><span class="hl-1"> </span><span class="hl-2">"report"</span><span class="hl-1">, </span><span class="hl-4">status:</span><span class="hl-1"> </span><span class="hl-2">"active"</span><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-4">limit:</span><span class="hl-1"> </span><span class="hl-8">5</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">offset:</span><span class="hl-1"> </span><span class="hl-8">10</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-9">// Vector similarity search</span><br/><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">store</span><span class="hl-1">.</span><span class="hl-0">search</span><span class="hl-1">([</span><span class="hl-2">"users"</span><span class="hl-1">, </span><span class="hl-2">"content"</span><span class="hl-1">], {</span><br/><span class="hl-1"> </span><span class="hl-4">query:</span><span class="hl-1"> </span><span class="hl-2">"technical documentation about APIs"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">limit:</span><span class="hl-1"> </span><span class="hl-8">20</span><br/><span class="hl-1">});</span>
|
|
243
|
+
</code><button type="button">Copy</button></pre>
|
|
244
|
+
|
|
245
|
+
</div></div><aside class="tsd-sources">
|
|
246
|
+
<p>Inherited from BaseStore.search</p>
|
|
247
|
+
<ul>
|
|
248
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts#L316">../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts:316</a></li></ul></aside></div></li></ul></section>
|
|
249
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
250
|
+
<h3 class="tsd-anchor-link" id="start"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
251
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
252
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
253
|
+
<div class="tsd-signature tsd-anchor-link" id="start-1"><span class="tsd-kind-call-signature">start</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
254
|
+
<div class="tsd-description">
|
|
255
|
+
<div class="tsd-comment tsd-typography"><p>Start the store. Override if initialization is needed.</p>
|
|
256
|
+
</div>
|
|
257
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
258
|
+
<p>Inherited from BaseStore.start</p>
|
|
259
|
+
<ul>
|
|
260
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts#L383">../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts:383</a></li></ul></aside></div></li></ul></section>
|
|
261
|
+
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
|
|
262
|
+
<h3 class="tsd-anchor-link" id="stop"><span>stop</span><a href="#stop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
263
|
+
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
|
264
|
+
<li class="tsd-is-inherited tsd-is-external">
|
|
265
|
+
<div class="tsd-signature tsd-anchor-link" id="stop-1"><span class="tsd-kind-call-signature">stop</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#stop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
|
|
266
|
+
<div class="tsd-description">
|
|
267
|
+
<div class="tsd-comment tsd-typography"><p>Stop the store. Override if cleanup is needed.</p>
|
|
268
|
+
</div>
|
|
269
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
270
|
+
<p>Inherited from BaseStore.stop</p>
|
|
271
|
+
<ul>
|
|
272
|
+
<li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/src/../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts#L387">../node_modules/@langchain/langgraph-checkpoint/dist/store/base.d.ts:387</a></li></ul></aside></div></li></ul></section></section></details></div>
|
|
273
|
+
<div class="col-sidebar">
|
|
274
|
+
<div class="page-menu">
|
|
275
|
+
<div class="tsd-navigation settings">
|
|
276
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
277
|
+
<h3>Settings</h3></summary>
|
|
278
|
+
<div class="tsd-accordion-details">
|
|
279
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
280
|
+
<ul id="tsd-filter-options">
|
|
281
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
282
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
283
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
284
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
285
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
286
|
+
<h3>On This Page</h3></summary>
|
|
287
|
+
<div class="tsd-accordion-details">
|
|
288
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
289
|
+
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
290
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
291
|
+
<div><a href="#client"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client</span></a><a href="#keyprefix"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>key<wbr/>Prefix</span></a><a href="#scancount"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scan<wbr/>Count</span></a></div></details>
|
|
292
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
|
|
293
|
+
<div><a href="#batch"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch</span></a><a href="#delete" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#get" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#listnamespaces" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>list<wbr/>Namespaces</span></a><a href="#put" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put</span></a><a href="#search" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search</span></a><a href="#start" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a><a href="#stop" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a></div></details></div></details></div>
|
|
294
|
+
<div class="site-menu">
|
|
295
|
+
<nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
|
|
296
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
297
|
+
<li>Loading...</li></ul></nav></div></div></div><footer></footer>
|
|
298
|
+
<div class="overlay"></div></body></html>
|