purra-mem0 0.5.1 → 1.0.1
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/MEM0-LICENSE +201 -0
- package/README.md +57 -5
- package/README.zh-CN.md +45 -5
- package/THIRD_PARTY_NOTICES.md +9 -0
- package/dist/context.d.ts +3 -1
- package/dist/context.js +27 -9
- package/dist/direct-providers.d.ts +8 -0
- package/dist/direct-providers.js +43 -0
- package/dist/index.d.ts +5 -3
- package/dist/index.js +2 -1
- package/dist/journal.d.ts +17 -0
- package/dist/journal.js +68 -0
- package/dist/memory.d.ts +48 -2
- package/dist/memory.js +179 -18
- package/dist/providers.js +10 -22
- package/dist/relations.d.ts +28 -0
- package/dist/relations.js +70 -0
- package/dist/sdk-memory.d.ts +14 -0
- package/dist/sdk-memory.js +18514 -0
- package/dist/workflow.d.ts +2 -0
- package/dist/workflow.js +30 -3
- package/package.json +154 -11
package/MEM0-LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [2023] [Taranjeet Singh]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -11,11 +11,7 @@ Follow [source installation](../../README.md#source-installation), selecting
|
|
|
11
11
|
`integrations/mem0/typescript`. Mem0's local store needs the `better-sqlite3`
|
|
12
12
|
native installation scripts.
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
```sh
|
|
17
|
-
npm install @langchain/core@1.1.47
|
|
18
|
-
```
|
|
14
|
+
Managed callbacks use the native PurrA adapters included in this package; no LangChain installation is required.
|
|
19
15
|
|
|
20
16
|
Before importing Mem0, set `MEM0_TELEMETRY=false` and an application-owned
|
|
21
17
|
`MEM0_DIR`. Explicitly configure the LLM, embedder, `vectorStore.config.dbPath`,
|
|
@@ -137,8 +133,64 @@ pass `policy(candidate, review)` and a stable `policyRevision` to `MemoryWorkflo
|
|
|
137
133
|
Return an authorized `MemoryResolution` that retains the review key, or `undefined`
|
|
138
134
|
to leave the candidate pending. The policy may be async.
|
|
139
135
|
|
|
136
|
+
To require authorization before messages can reach Mem0 or its providers, bind a
|
|
137
|
+
host-issued grant to the exact capture intent:
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
import { MemoryWorkflow, memoryCaptureIntent } from "purra-mem0";
|
|
141
|
+
|
|
142
|
+
const capturePolicyId = "project-memory";
|
|
143
|
+
const capturePolicyRevision = "2026-09-09";
|
|
144
|
+
const authorization = {
|
|
145
|
+
intentDigest: memoryCaptureIntent(messages, { source, metadata }),
|
|
146
|
+
policyId: capturePolicyId,
|
|
147
|
+
policyRevision: capturePolicyRevision,
|
|
148
|
+
principalId: authenticatedUserId,
|
|
149
|
+
decisionId: hostDecisionId,
|
|
150
|
+
};
|
|
151
|
+
const workflow = new MemoryWorkflow(memory, { capturePolicyId, capturePolicyRevision });
|
|
152
|
+
await memory.recordCaptureAuthorization(authorization, {
|
|
153
|
+
key: `capture-authorization:${hostDecisionId}`,
|
|
154
|
+
expiresAt: captureAuthorizationExpiresAt,
|
|
155
|
+
});
|
|
156
|
+
const result = await workflow.capture(messages, {
|
|
157
|
+
source, key: operationKey, metadata, authorization,
|
|
158
|
+
});
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
The host owns authentication, eligibility and audit of the decision. Keep the
|
|
162
|
+
authorization unchanged on retry. Missing or mismatched grants fail before the
|
|
163
|
+
operation journal and Provider calls; changing a bound grant under the same key
|
|
164
|
+
causes an idempotency conflict.
|
|
165
|
+
|
|
166
|
+
Call `revokeCaptureAuthorization(policyId, decisionId, { key })` to persist a
|
|
167
|
+
revocation. It prevents new extraction, review and activation under the decision
|
|
168
|
+
and hides records produced by it. Expiry only stops new processing. Neither path
|
|
169
|
+
physically deletes Mem0 content or history.
|
|
170
|
+
|
|
140
171
|
## Lifecycle
|
|
141
172
|
|
|
142
173
|
Before shutdown, call `await memory.drain()` and `memory.close()`, then close SDK
|
|
143
174
|
and provider resources. For paging, withdrawal, evidence validation, and uncertain
|
|
144
175
|
writes, see the [memory lifecycle guide](../README.md).
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
## Native managed providers
|
|
179
|
+
|
|
180
|
+
`createManagedClient` inject native LLM and Embedding adapters into a version-pinned, package-private Mem0 module. Calls retain the existing PurrA budget, cancellation and result validation. Explicit vector dimensions must agree; the managed path rejects LangChain vector stores. It neither patches the installed SDK nor starts a proxy server. See [third-party notices](THIRD_PARTY_NOTICES.md). Raw SDK clients remain host-owned and do not acquire managed accounting automatically.
|
|
181
|
+
|
|
182
|
+
## Host-controlled selection and relation proposals
|
|
183
|
+
|
|
184
|
+
`new MemoryContext({ memory, selectIds: hostSelect })` accepts an async
|
|
185
|
+
`hostSelect(request, signal)` returning ordered memory IDs. Supply either
|
|
186
|
+
`selectIds` or the existing `query`, never both. The component rereads authorized
|
|
187
|
+
records, validates evidence, and fits complete records into the context budget.
|
|
188
|
+
The host owns retrieval combination, ordering, callback timeout and model costs.
|
|
189
|
+
|
|
190
|
+
`proposeMemoryRelations(memory, refs, { relations: allowedNames, extract: hostExtract })`
|
|
191
|
+
is exported from `purra-mem0`. Its async extractor receives `(input, signal)` and
|
|
192
|
+
returns objects with exactly `from`, `to`, `relation`, `fromQuote`, `toQuote` string
|
|
193
|
+
fields. IDs must match supplied `MemoryRef` revisions and quotes must occur in
|
|
194
|
+
those records. Returned immutable proposals do not write links or prove that a
|
|
195
|
+
relation is true. The host reviews proposals and explicitly calls `memory.link`.
|
|
196
|
+
No automatic model invocation, retry or adoption policy is installed.
|
package/README.zh-CN.md
CHANGED
|
@@ -10,11 +10,7 @@
|
|
|
10
10
|
按照[源码安装说明](../../README.zh-CN.md#从源码安装)操作,选择
|
|
11
11
|
`integrations/mem0/typescript`。Mem0 的本地存储需要执行 `better-sqlite3` 的原生安装脚本。
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
```sh
|
|
16
|
-
npm install @langchain/core@1.1.47
|
|
17
|
-
```
|
|
13
|
+
原生受控模型和向量回调已包含在本包内,无需安装 LangChain。
|
|
18
14
|
|
|
19
15
|
导入 Mem0 前,设置 `MEM0_TELEMETRY=false`,并将 `MEM0_DIR` 指向应用管理的数据目录。
|
|
20
16
|
显式配置 LLM、embedder、`vectorStore.config.dbPath` 和 `historyDbPath`。
|
|
@@ -127,7 +123,51 @@ async function capture(
|
|
|
127
123
|
`policy(candidate, review)` 和稳定的 `policyRevision`。
|
|
128
124
|
策略返回已授权且保留审查键的 `MemoryResolution`,或返回 `undefined` 保持待处理;策略可以是异步函数。
|
|
129
125
|
|
|
126
|
+
需要在消息到达 Mem0 或 Provider 前强制授权时,绑定宿主签发的准确捕获意图:
|
|
127
|
+
|
|
128
|
+
```ts
|
|
129
|
+
import { MemoryWorkflow, memoryCaptureIntent } from "purra-mem0";
|
|
130
|
+
|
|
131
|
+
const authorization = {
|
|
132
|
+
intentDigest: memoryCaptureIntent(messages, { source, metadata }),
|
|
133
|
+
policyId: capturePolicyId,
|
|
134
|
+
policyRevision: capturePolicyRevision,
|
|
135
|
+
principalId: authenticatedUserId,
|
|
136
|
+
decisionId: hostDecisionId,
|
|
137
|
+
};
|
|
138
|
+
const workflow = new MemoryWorkflow(memory, { capturePolicyId, capturePolicyRevision });
|
|
139
|
+
await memory.recordCaptureAuthorization(authorization, {
|
|
140
|
+
key: `capture-authorization:${hostDecisionId}`,
|
|
141
|
+
expiresAt: captureAuthorizationExpiresAt,
|
|
142
|
+
});
|
|
143
|
+
const result = await workflow.capture(messages, {
|
|
144
|
+
source, key: operationKey, metadata, authorization,
|
|
145
|
+
});
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
宿主负责认证、内容适用性和决定审计。重试必须沿用相同授权;缺失或不匹配的授权会在
|
|
149
|
+
操作日志及 Provider 调用前失败,同一 key 更换已绑定授权会触发幂等冲突。
|
|
150
|
+
调用 `revokeCaptureAuthorization(policyId, decisionId, { key })` 可持久撤销决定,阻止
|
|
151
|
+
新的提取、审查和激活,并隐藏由其产生的记录。到期只阻止新处理;两者均不物理删除
|
|
152
|
+
Mem0 内容或历史。
|
|
153
|
+
|
|
130
154
|
## 生命周期
|
|
131
155
|
|
|
132
156
|
关闭前调用 `await memory.drain()` 和 `memory.close()`,再关闭 SDK 与模型服务资源。
|
|
133
157
|
分页、来源撤回、证据校验和不确定写入的处理见[记忆生命周期指南](../README.zh-CN.md)。
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
## 原生受控适配
|
|
161
|
+
|
|
162
|
+
`createManagedClient` 把 PurrA 的原生模型和向量适配器注入包内、版本固定的 Mem0 私有模块,沿用现有预算、取消与结果校验。向量维度必须一致,受控路径拒绝 LangChain 向量库。不修改宿主安装的官方 SDK,也不启动代理服务。来源、许可证与修改说明见[第三方声明](THIRD_PARTY_NOTICES.md)。直接传入的原始 SDK 客户端仍由宿主管理,不自动获得受控回调的计费。
|
|
163
|
+
|
|
164
|
+
## 宿主选择与关系候选
|
|
165
|
+
|
|
166
|
+
`MemoryContext` 支持异步 `selectIds(request, signal)`,与原有 `query` 二选一。
|
|
167
|
+
宿主返回有序记忆 ID;组件重新读取并验证来源、版本和预算,不接受替换文本。
|
|
168
|
+
|
|
169
|
+
`purra-mem0` 导出的 `proposeMemoryRelations` 接受记忆引用、宿主关系词表和异步 `extract`。
|
|
170
|
+
抽取回调返回仅含 `from`、`to`、`relation`、`fromQuote`、`toQuote` 字符串的对象数组。
|
|
171
|
+
组件校验原文引用与当前记忆版本,只返回候选,不自动写入关系。
|
|
172
|
+
关系是否成立、是否采纳和显式调用 `memory.link` 均由宿主决定。
|
|
173
|
+
模型调用的授权、超时和费用预算也由宿主负责。
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Mem0 attribution and local modifications
|
|
2
|
+
|
|
3
|
+
This package includes a private module derived from Mem0 (https://github.com/mem0ai/mem0), copyright Mem0 contributors, licensed under Apache-2.0 (MEM0-LICENSE).
|
|
4
|
+
|
|
5
|
+
Python uses mem0ai 2.0.19 memory/main.py; TypeScript uses mem0ai 3.1.7 dist/oss/index.mjs. PurrA modifies constructor provider injection and, in TypeScript, preserves injected providers across reset. The extension also identifies injected providers and releases SDK-owned local handles on failed initialization; the TypeScript managed factory awaits initialization before returning. These are PurrA-owned private copies, not replacements for or modifications to the installed official mem0ai package. The SDK algorithms remain upstream-owned.
|
|
6
|
+
|
|
7
|
+
The repository integrations/mem0/sdk/upstream.json records input hashes. Python scripts/sync_sdk.py verifies/regenerates the checked-in private module; TypeScript scripts/build-sdk.mjs generates dist/sdk-memory.js during the package build. No patching or source generation happens when a consumer imports the package.
|
|
8
|
+
|
|
9
|
+
Generated source is reviewed by verifying the pinned input and the small transformation, then exercising SDK contract and installed-package tests. SDK upgrades require an explicit hash/contract review. Native provider clients are not constructed on the managed path. The private SDK is not part of the public API.
|
package/dist/context.d.ts
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import type { ContextBlock, ContextEvidenceReceipt, ContextBudget, ContextBudgetClaim, ContextBundle, ContextProvider, ContextRequest } from "purra";
|
|
2
2
|
import { Mem0Memory } from "./memory.js";
|
|
3
|
+
export type MemorySelectionPolicy = (request: ContextRequest, signal?: AbortSignal) => Promise<readonly string[]>;
|
|
3
4
|
export declare class MemoryContext implements ContextProvider {
|
|
4
5
|
#private;
|
|
5
6
|
constructor(options: {
|
|
6
7
|
memory: Mem0Memory;
|
|
7
|
-
query
|
|
8
|
+
query?: (request: ContextRequest) => string;
|
|
9
|
+
selectIds?: MemorySelectionPolicy;
|
|
8
10
|
countTokens?: (content: string) => number;
|
|
9
11
|
name?: string;
|
|
10
12
|
desiredTokens?: number;
|
package/dist/context.js
CHANGED
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
import { estimateJsonTokens } from "purra";
|
|
2
2
|
import { Mem0Memory, positiveInteger, requiredText } from "./memory.js";
|
|
3
|
+
import { MemoryError } from "./journal.js";
|
|
4
|
+
function validateContextAllowance(value) {
|
|
5
|
+
if (typeof value !== "number" || !Number.isSafeInteger(value) || value < 0 || value > 1_000_000)
|
|
6
|
+
throw new TypeError("invalid context allowance");
|
|
7
|
+
}
|
|
3
8
|
export class MemoryContext {
|
|
4
9
|
#memory;
|
|
5
10
|
#query;
|
|
11
|
+
#selectIds;
|
|
6
12
|
#countTokens;
|
|
7
13
|
#name;
|
|
8
14
|
#desiredTokens;
|
|
@@ -10,32 +16,44 @@ export class MemoryContext {
|
|
|
10
16
|
constructor(options) {
|
|
11
17
|
this.#memory = options.memory;
|
|
12
18
|
this.#query = options.query;
|
|
19
|
+
this.#selectIds = options.selectIds;
|
|
13
20
|
this.#countTokens = options.countTokens ?? estimateJsonTokens;
|
|
14
21
|
this.#name = requiredText(options.name ?? "memory", "context name", 128);
|
|
15
22
|
this.#desiredTokens = positiveInteger(options.desiredTokens ?? 1024, "desiredTokens", 1_000_000);
|
|
16
23
|
this.#limit = positiveInteger(options.limit ?? 8, "limit");
|
|
17
|
-
if (
|
|
18
|
-
throw new TypeError("
|
|
24
|
+
if ((this.#query === undefined) === (this.#selectIds === undefined))
|
|
25
|
+
throw new TypeError("Provide exactly one of query or selectIds");
|
|
26
|
+
if (typeof (this.#selectIds ?? this.#query) !== "function" || typeof this.#countTokens !== "function")
|
|
27
|
+
throw new TypeError("Selection and countTokens must be host functions");
|
|
19
28
|
}
|
|
20
29
|
describeContextDemands() {
|
|
21
30
|
return [{ name: this.#name, desiredTokens: this.#desiredTokens }];
|
|
22
31
|
}
|
|
23
32
|
async buildContext(request, budget, signal) {
|
|
24
|
-
const allowance = budget.contextAllocations[this.#name]
|
|
25
|
-
|
|
33
|
+
const allowance = Object.hasOwn(budget.contextAllocations, this.#name) ? budget.contextAllocations[this.#name] : 0;
|
|
34
|
+
validateContextAllowance(allowance);
|
|
35
|
+
if (allowance === 0)
|
|
26
36
|
return { blocks: [] };
|
|
27
37
|
const epoch = this.#memory.epoch;
|
|
28
|
-
|
|
29
|
-
|
|
38
|
+
if (signal?.aborted)
|
|
39
|
+
throw new MemoryError("memory_cancelled");
|
|
40
|
+
const ids = this.#selectIds === undefined
|
|
41
|
+
? (await this.#memory.retrieve({ query: this.#query(request), limit: this.#limit, scope: {} }, signal)).map(hit => hit.id)
|
|
42
|
+
: await this.#selectIds(request, signal);
|
|
43
|
+
const result = await assembleMemoryContext(this.#memory, ids, allowance, { name: this.#name, countTokens: this.#countTokens, expectedEpoch: epoch, ...(signal ? { signal } : {}) });
|
|
30
44
|
return { blocks: result.block ? [result.block] : [] };
|
|
31
45
|
}
|
|
32
46
|
}
|
|
33
47
|
/** Fresh authorized records; shared by Agent and non-Run consumers. */
|
|
34
48
|
export async function assembleMemoryContext(memory, ids, allowance, options = {}) {
|
|
35
|
-
|
|
36
|
-
|
|
49
|
+
validateContextAllowance(allowance);
|
|
50
|
+
const countTokens = options.countTokens === undefined ? estimateJsonTokens : options.countTokens;
|
|
51
|
+
if (typeof countTokens !== "function")
|
|
52
|
+
throw new TypeError("countTokens must be callable");
|
|
37
53
|
const name = requiredText(options.name ?? "memory", "context name", 128);
|
|
38
|
-
|
|
54
|
+
if (!Array.isArray(ids))
|
|
55
|
+
throw new TypeError("ids must be an array");
|
|
56
|
+
ids = Object.freeze([...ids]);
|
|
39
57
|
const epoch = options.expectedEpoch ?? memory.epoch;
|
|
40
58
|
memory.assertEpoch(epoch);
|
|
41
59
|
const hits = await memory.select(ids, options.signal ? { signal: options.signal } : {});
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export declare class DirectLlm {
|
|
2
|
+
generateResponse(messages: unknown, format?: unknown, tools?: unknown, ...extra: unknown[]): Promise<string>;
|
|
3
|
+
generateChat(): Promise<never>;
|
|
4
|
+
}
|
|
5
|
+
export declare class DirectEmbedder {
|
|
6
|
+
embed(text: unknown, action?: unknown): Promise<number[]>;
|
|
7
|
+
embedBatch(texts: unknown, action?: unknown): Promise<number[][]>;
|
|
8
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { currentExecution } from "./providers.js";
|
|
2
|
+
import { MemoryError } from "./journal.js";
|
|
3
|
+
function execution() {
|
|
4
|
+
const value = currentExecution();
|
|
5
|
+
if (!value)
|
|
6
|
+
throw new MemoryError("memory_provider_unbound");
|
|
7
|
+
value.check();
|
|
8
|
+
return value;
|
|
9
|
+
}
|
|
10
|
+
function reject(value) {
|
|
11
|
+
value.stop("memory_provider_contract");
|
|
12
|
+
throw new MemoryError(value.error);
|
|
13
|
+
}
|
|
14
|
+
export class DirectLlm {
|
|
15
|
+
async generateResponse(messages, format, tools, ...extra) {
|
|
16
|
+
const value = execution();
|
|
17
|
+
if (extra.length || (tools !== undefined && (!Array.isArray(tools) || tools.length))
|
|
18
|
+
|| (format !== undefined && (format === null || typeof format !== "object"
|
|
19
|
+
|| Object.keys(format).length !== 1 || format.type !== "json_object"))
|
|
20
|
+
|| !Array.isArray(messages) || !messages.length)
|
|
21
|
+
reject(value);
|
|
22
|
+
const converted = Array.from(messages, (message) => {
|
|
23
|
+
if (!message || typeof message !== "object" || Object.keys(message).sort().join() !== "content,role")
|
|
24
|
+
reject(value);
|
|
25
|
+
const m = message;
|
|
26
|
+
if (!["system", "user", "assistant"].includes(m.role) || typeof m.content !== "string")
|
|
27
|
+
reject(value);
|
|
28
|
+
return { role: m.role, content: m.content };
|
|
29
|
+
});
|
|
30
|
+
return value.invoke("llm", converted);
|
|
31
|
+
}
|
|
32
|
+
async generateChat() { return reject(execution()); }
|
|
33
|
+
}
|
|
34
|
+
export class DirectEmbedder {
|
|
35
|
+
async embed(text, action) { return (await this.embedBatch([text], action))[0]; }
|
|
36
|
+
async embedBatch(texts, action) {
|
|
37
|
+
const value = execution();
|
|
38
|
+
if ((action !== undefined && !["add", "search", "update"].includes(action))
|
|
39
|
+
|| !Array.isArray(texts) || Array.from(texts).some(text => typeof text !== "string"))
|
|
40
|
+
reject(value);
|
|
41
|
+
return texts.length ? value.invoke("embedding", [...texts]) : [];
|
|
42
|
+
}
|
|
43
|
+
}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
/** Optional Node.js integration; not imported by PurrA Core. */
|
|
2
2
|
export { MemoryError } from "./journal.js";
|
|
3
|
-
export { Mem0Memory } from "./memory.js";
|
|
4
|
-
export type { Mem0Client, MemoryScope, MemorySource, MemoryRecord, MemoryMetadata, MemoryFilters, MemoryPage, MemoryOperation, MemoryRef, MemoryLink, MemoryLinkPage, MemoryResolution, MemoryReview, MemoryMatch } from "./memory.js";
|
|
5
|
-
export type { MemoryContextResult } from "./context.js";
|
|
3
|
+
export { Mem0Memory, memoryCaptureIntent } from "./memory.js";
|
|
4
|
+
export type { Mem0Client, MemoryScope, MemorySource, MemoryCaptureAuthorization, MemoryRecord, MemoryMetadata, MemoryFilters, MemoryPage, MemoryOperation, MemoryRef, MemoryLink, MemoryLinkPage, MemoryRelationEvidence, MemoryResolution, MemoryReview, MemoryMatch } from "./memory.js";
|
|
5
|
+
export type { MemoryContextResult, MemorySelectionPolicy } from "./context.js";
|
|
6
6
|
export { MemoryContext, assembleMemoryContext } from "./context.js";
|
|
7
7
|
export { createManagedClient, runModel } from "./providers.js";
|
|
8
8
|
export type { MemoryBudget, MemoryProviders, MemoryUsage, EmbeddingResult, ManagedMem0Config } from "./providers.js";
|
|
9
9
|
export { MemoryWorkflow } from "./workflow.js";
|
|
10
10
|
export type { MemoryWorkflowResult, MemoryDecisionPolicy } from "./workflow.js";
|
|
11
|
+
export { proposeMemoryRelations } from './relations.js';
|
|
12
|
+
export type { MemoryRelationProposal, MemoryRelationExtractionInput, MemoryRelationExtractor } from './relations.js';
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/** Optional Node.js integration; not imported by PurrA Core. */
|
|
2
2
|
export { MemoryError } from "./journal.js";
|
|
3
|
-
export { Mem0Memory } from "./memory.js";
|
|
3
|
+
export { Mem0Memory, memoryCaptureIntent } from "./memory.js";
|
|
4
4
|
export { MemoryContext, assembleMemoryContext } from "./context.js";
|
|
5
5
|
export { createManagedClient, runModel } from "./providers.js";
|
|
6
6
|
export { MemoryWorkflow } from "./workflow.js";
|
|
7
|
+
export { proposeMemoryRelations } from './relations.js';
|
package/dist/journal.d.ts
CHANGED
|
@@ -18,6 +18,8 @@ export interface Metadata {
|
|
|
18
18
|
purra_reason: string | null;
|
|
19
19
|
purra_created: string;
|
|
20
20
|
purra_updated: string;
|
|
21
|
+
purra_capture_policy?: string;
|
|
22
|
+
purra_capture_decision?: string;
|
|
21
23
|
}
|
|
22
24
|
export interface ItemView {
|
|
23
25
|
version: number;
|
|
@@ -53,6 +55,17 @@ export interface Plan {
|
|
|
53
55
|
policy_hash?: string;
|
|
54
56
|
changes?: Partial<ItemView>;
|
|
55
57
|
link?: Omit<MemoryLink, "key" | "valid">;
|
|
58
|
+
capture_authorization?: {
|
|
59
|
+
intent_digest: string;
|
|
60
|
+
policy_id: string;
|
|
61
|
+
policy_revision: string;
|
|
62
|
+
principal_id: string;
|
|
63
|
+
decision_id: string;
|
|
64
|
+
};
|
|
65
|
+
valid_from?: string | null;
|
|
66
|
+
expires?: string | null;
|
|
67
|
+
policy_id?: string;
|
|
68
|
+
decision_id?: string;
|
|
56
69
|
}
|
|
57
70
|
export interface OperationRow {
|
|
58
71
|
key: string;
|
|
@@ -83,6 +96,10 @@ export declare class Journal {
|
|
|
83
96
|
revoked(source: string, revision: string): boolean;
|
|
84
97
|
assertSource(meta: Pick<Metadata, "purra_source" | "purra_revision">): void;
|
|
85
98
|
revokeSource(key: string, fingerprint: string, source: string, revision: string | null): void;
|
|
99
|
+
captureRevoked(policy: string, decision: string): boolean;
|
|
100
|
+
assertCaptureAuthorization(authorization: NonNullable<Plan["capture_authorization"]>): void;
|
|
101
|
+
recordCaptureAuthorization(key: string, fingerprint: string, authorization: NonNullable<Plan["capture_authorization"]>, validFrom: string | null, expires: string | null): void;
|
|
102
|
+
revokeCaptureAuthorization(key: string, fingerprint: string, policy: string, decision: string): void;
|
|
86
103
|
item(id: string): Item | undefined;
|
|
87
104
|
resolve(key: string, fingerprint: string, plan: Plan, epoch: number): void;
|
|
88
105
|
control(key: string, fingerprint: string, plan: Plan, epoch: number, refs: readonly MemoryRef[], changes: readonly Partial<ItemView>[]): void;
|