@objectstack/knowledge-ragflow 6.4.0
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/.turbo/turbo-build.log +22 -0
- package/CHANGELOG.md +28 -0
- package/LICENSE +202 -0
- package/README.md +50 -0
- package/dist/index.d.mts +68 -0
- package/dist/index.d.ts +68 -0
- package/dist/index.js +213 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +187 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +36 -0
- package/src/__tests__/ragflow-adapter.test.ts +160 -0
- package/src/index.ts +307 -0
- package/tsconfig.json +20 -0
- package/vitest.config.ts +23 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
|
|
2
|
+
> @objectstack/knowledge-ragflow@6.4.0 build /home/runner/work/framework/framework/packages/plugins/knowledge-ragflow
|
|
3
|
+
> tsup --config ../../../tsup.config.ts
|
|
4
|
+
|
|
5
|
+
[34mCLI[39m Building entry: src/index.ts
|
|
6
|
+
[34mCLI[39m Using tsconfig: tsconfig.json
|
|
7
|
+
[34mCLI[39m tsup v8.5.1
|
|
8
|
+
[34mCLI[39m Using tsup config: /home/runner/work/framework/framework/tsup.config.ts
|
|
9
|
+
[34mCLI[39m Target: es2020
|
|
10
|
+
[34mCLI[39m Cleaning output folder
|
|
11
|
+
[34mESM[39m Build start
|
|
12
|
+
[34mCJS[39m Build start
|
|
13
|
+
[32mESM[39m [1mdist/index.mjs [22m[32m6.41 KB[39m
|
|
14
|
+
[32mESM[39m [1mdist/index.mjs.map [22m[32m15.10 KB[39m
|
|
15
|
+
[32mESM[39m ⚡️ Build success in 58ms
|
|
16
|
+
[32mCJS[39m [1mdist/index.js [22m[32m7.49 KB[39m
|
|
17
|
+
[32mCJS[39m [1mdist/index.js.map [22m[32m15.14 KB[39m
|
|
18
|
+
[32mCJS[39m ⚡️ Build success in 59ms
|
|
19
|
+
[34mDTS[39m Build start
|
|
20
|
+
[32mDTS[39m ⚡️ Build success in 10730ms
|
|
21
|
+
[32mDTS[39m [1mdist/index.d.mts [22m[32m2.39 KB[39m
|
|
22
|
+
[32mDTS[39m [1mdist/index.d.ts [22m[32m2.39 KB[39m
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# @objectstack/knowledge-ragflow
|
|
2
|
+
|
|
3
|
+
## 6.4.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- f8651cc: Knowledge Protocol MVP — protocol-first RAG via adapter plugins.
|
|
8
|
+
|
|
9
|
+
**What's new:**
|
|
10
|
+
|
|
11
|
+
- `@objectstack/spec` — new `KnowledgeSource` / `KnowledgeDocument` / `KnowledgeChunk` / `KnowledgeHit` schemas (under `@objectstack/spec/ai`) and `IKnowledgeService` / `IKnowledgeAdapter` contracts (under `@objectstack/spec/contracts`).
|
|
12
|
+
- `@objectstack/service-knowledge` — `KnowledgeService` orchestrator + `KnowledgeServicePlugin`. Routes search/index calls to the appropriate adapter, runs **permission-aware retrieval** by re-checking every hit's `sourceRecordId` against the caller's `ExecutionContext` via `IDataEngine` (same RLS that gates plain ObjectQL), and subscribes to `IRealtimeService` for inline record→adapter sync.
|
|
13
|
+
- `@objectstack/knowledge-memory` — deterministic, dependency-free in-memory adapter for dev/tests/reference. Hash-token embedder + brute-force cosine + paragraph chunking.
|
|
14
|
+
- `@objectstack/knowledge-ragflow` — production-grade adapter against the Apache-2.0 [RAGFlow](https://github.com/infiniflow/ragflow) REST API. Plug in your dataset id; ObjectStack handles permission filtering after retrieval.
|
|
15
|
+
- `@objectstack/service-ai` — new `search_knowledge` tool wired through the registry. Threads the LLM caller's actor into `KnowledgeService.search` so retrieval honours RLS automatically.
|
|
16
|
+
|
|
17
|
+
**Why this design:** ObjectStack does NOT own chunking / embedding / vector storage / rerank — those are commodity capabilities best handled by mature OSS (RAGFlow, LlamaIndex, Dify, …). What ObjectStack uniquely owns is the protocol + permission-aware orchestration on top.
|
|
18
|
+
|
|
19
|
+
See `content/docs/protocol/knowledge.mdx` for the full design.
|
|
20
|
+
|
|
21
|
+
### Patch Changes
|
|
22
|
+
|
|
23
|
+
- Updated dependencies [f8651cc]
|
|
24
|
+
- Updated dependencies [f8651cc]
|
|
25
|
+
- Updated dependencies [0bf6f9a]
|
|
26
|
+
- @objectstack/spec@6.4.0
|
|
27
|
+
- @objectstack/service-knowledge@6.4.0
|
|
28
|
+
- @objectstack/core@6.4.0
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
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
|
|
108
|
+
must include a readable copy of the attribution notices
|
|
109
|
+
contained within such NOTICE file, excluding those notices
|
|
110
|
+
that do not pertain to any part of the Derivative Works,
|
|
111
|
+
in at least one of the following places: within a NOTICE
|
|
112
|
+
text file distributed as part of the Derivative Works; within
|
|
113
|
+
the Source form or documentation, if provided along with
|
|
114
|
+
the Derivative Works; or, within a display generated by the
|
|
115
|
+
Derivative Works, if and wherever such third-party notices
|
|
116
|
+
normally appear. The contents of the NOTICE file are for
|
|
117
|
+
informational purposes only and do not modify the License.
|
|
118
|
+
You may add Your own attribution notices within Derivative
|
|
119
|
+
Works that You distribute, alongside or as an addendum to
|
|
120
|
+
the NOTICE text from the Work, provided that such additional
|
|
121
|
+
attribution notices cannot be construed as modifying the
|
|
122
|
+
License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 ObjectStack
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# @objectstack/knowledge-ragflow
|
|
2
|
+
|
|
3
|
+
[RAGFlow](https://github.com/infiniflow/ragflow) `IKnowledgeAdapter` for ObjectStack.
|
|
4
|
+
|
|
5
|
+
Bridges the [Knowledge Protocol](../../../content/docs/protocol/knowledge.mdx) to a RAGFlow deployment via its HTTP API. RAGFlow handles chunking (DeepDoc), embedding, hybrid retrieval, and reranking; ObjectStack handles metadata-native sources and permission-aware filtering on top of the returned hits.
|
|
6
|
+
|
|
7
|
+
## Why RAGFlow?
|
|
8
|
+
|
|
9
|
+
- **Apache 2.0** — no vendor lock-in.
|
|
10
|
+
- **Language-agnostic HTTP API** — we don't have to track a Python or Node SDK release cadence.
|
|
11
|
+
- **Best-in-class default accuracy** on mixed PDF / table / scanned content (DeepDoc OCR + layout).
|
|
12
|
+
- **Doesn't overlap our stack** — no built-in agent/flow runner competing with ours.
|
|
13
|
+
|
|
14
|
+
## Setup
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
import { ObjectKernel } from '@objectstack/core';
|
|
18
|
+
import { KnowledgeServicePlugin } from '@objectstack/service-knowledge';
|
|
19
|
+
import { KnowledgeRagflowPlugin } from '@objectstack/knowledge-ragflow';
|
|
20
|
+
|
|
21
|
+
const kernel = new ObjectKernel();
|
|
22
|
+
kernel.use(new KnowledgeServicePlugin({
|
|
23
|
+
sources: [{
|
|
24
|
+
id: 'product_docs',
|
|
25
|
+
label: 'Product documentation',
|
|
26
|
+
adapter: 'ragflow',
|
|
27
|
+
source: { kind: 'http', urls: ['https://docs.example.com/sitemap.xml'] },
|
|
28
|
+
options: { datasetId: 'rgf_doc_dataset_id' }, // RAGFlow dataset to bind
|
|
29
|
+
}],
|
|
30
|
+
}));
|
|
31
|
+
kernel.use(new KnowledgeRagflowPlugin({
|
|
32
|
+
endpoint: process.env.RAGFLOW_ENDPOINT!, // e.g. http://localhost:9380
|
|
33
|
+
apiKey: process.env.RAGFLOW_API_KEY!,
|
|
34
|
+
}));
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Source binding
|
|
38
|
+
|
|
39
|
+
Each `KnowledgeSource` must include `options.datasetId` pointing to a pre-created RAGFlow dataset. The adapter doesn't create datasets — operators do that once in the RAGFlow UI, where they pick the chunking method, embedding model, and rerank policy.
|
|
40
|
+
|
|
41
|
+
## What the adapter does
|
|
42
|
+
|
|
43
|
+
| Call | RAGFlow endpoint |
|
|
44
|
+
|------|------------------|
|
|
45
|
+
| `upsert(docs)` | `POST /api/v1/datasets/:id/chunks` (one chunk-set per doc, keyed by doc id) |
|
|
46
|
+
| `search(query)` | `POST /api/v1/retrieval` (cross-dataset) |
|
|
47
|
+
| `delete(ids)` | `DELETE /api/v1/datasets/:id/chunks` |
|
|
48
|
+
| `healthCheck()` | `GET /api/v1/datasets` (auth probe) |
|
|
49
|
+
|
|
50
|
+
Permission filtering happens in `KnowledgeService` after `search()` returns — it re-checks each hit's `sourceRecordId` via ObjectQL.
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { Plugin, PluginContext } from '@objectstack/core';
|
|
2
|
+
import { IKnowledgeAdapter, AdapterContext, AdapterSearchOptions } from '@objectstack/spec/contracts';
|
|
3
|
+
import { KnowledgeDocument, KnowledgeHit } from '@objectstack/spec/ai';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Subset of `fetch` used by the adapter. Inject in tests; defaults to
|
|
7
|
+
* the global `fetch`.
|
|
8
|
+
*/
|
|
9
|
+
type FetchLike = (input: string, init?: {
|
|
10
|
+
method?: string;
|
|
11
|
+
headers?: Record<string, string>;
|
|
12
|
+
body?: string;
|
|
13
|
+
signal?: AbortSignal;
|
|
14
|
+
}) => Promise<{
|
|
15
|
+
ok: boolean;
|
|
16
|
+
status: number;
|
|
17
|
+
statusText: string;
|
|
18
|
+
text(): Promise<string>;
|
|
19
|
+
json(): Promise<unknown>;
|
|
20
|
+
}>;
|
|
21
|
+
interface KnowledgeRagflowAdapterOptions {
|
|
22
|
+
/** RAGFlow endpoint, e.g. `http://localhost:9380`. */
|
|
23
|
+
endpoint: string;
|
|
24
|
+
/** RAGFlow API key (Bearer token). */
|
|
25
|
+
apiKey: string;
|
|
26
|
+
/** Adapter id. @default 'ragflow' */
|
|
27
|
+
id?: string;
|
|
28
|
+
/** Override `fetch` for tests. */
|
|
29
|
+
fetch?: FetchLike;
|
|
30
|
+
/** Request timeout in milliseconds. @default 30000 */
|
|
31
|
+
timeoutMs?: number;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* RAGFlow adapter. Maps {@link KnowledgeDocument} upserts to the
|
|
35
|
+
* dataset's chunk API, delegates retrieval to `/api/v1/retrieval`, and
|
|
36
|
+
* returns {@link KnowledgeHit}s with `sourceRecordId` preserved so the
|
|
37
|
+
* orchestrator can run a permission re-check.
|
|
38
|
+
*/
|
|
39
|
+
declare class KnowledgeRagflowAdapter implements IKnowledgeAdapter {
|
|
40
|
+
readonly id: string;
|
|
41
|
+
private readonly endpoint;
|
|
42
|
+
private readonly apiKey;
|
|
43
|
+
private readonly fetchImpl;
|
|
44
|
+
private readonly timeoutMs;
|
|
45
|
+
constructor(opts: KnowledgeRagflowAdapterOptions);
|
|
46
|
+
upsert(docs: KnowledgeDocument[], ctx: AdapterContext): Promise<void>;
|
|
47
|
+
delete(documentIds: string[], ctx: AdapterContext): Promise<void>;
|
|
48
|
+
search(query: string, opts: AdapterSearchOptions): Promise<KnowledgeHit[]>;
|
|
49
|
+
healthCheck(): Promise<{
|
|
50
|
+
ok: boolean;
|
|
51
|
+
message?: string;
|
|
52
|
+
}>;
|
|
53
|
+
private deleteChunksByDocumentId;
|
|
54
|
+
private request;
|
|
55
|
+
}
|
|
56
|
+
interface KnowledgeRagflowPluginOptions extends KnowledgeRagflowAdapterOptions {
|
|
57
|
+
}
|
|
58
|
+
declare class KnowledgeRagflowPlugin implements Plugin {
|
|
59
|
+
name: string;
|
|
60
|
+
version: string;
|
|
61
|
+
type: string;
|
|
62
|
+
private readonly adapter;
|
|
63
|
+
constructor(opts: KnowledgeRagflowPluginOptions);
|
|
64
|
+
init(_ctx: PluginContext): Promise<void>;
|
|
65
|
+
start(ctx: PluginContext): Promise<void>;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export { type FetchLike, KnowledgeRagflowAdapter, type KnowledgeRagflowAdapterOptions, KnowledgeRagflowPlugin, type KnowledgeRagflowPluginOptions };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { Plugin, PluginContext } from '@objectstack/core';
|
|
2
|
+
import { IKnowledgeAdapter, AdapterContext, AdapterSearchOptions } from '@objectstack/spec/contracts';
|
|
3
|
+
import { KnowledgeDocument, KnowledgeHit } from '@objectstack/spec/ai';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Subset of `fetch` used by the adapter. Inject in tests; defaults to
|
|
7
|
+
* the global `fetch`.
|
|
8
|
+
*/
|
|
9
|
+
type FetchLike = (input: string, init?: {
|
|
10
|
+
method?: string;
|
|
11
|
+
headers?: Record<string, string>;
|
|
12
|
+
body?: string;
|
|
13
|
+
signal?: AbortSignal;
|
|
14
|
+
}) => Promise<{
|
|
15
|
+
ok: boolean;
|
|
16
|
+
status: number;
|
|
17
|
+
statusText: string;
|
|
18
|
+
text(): Promise<string>;
|
|
19
|
+
json(): Promise<unknown>;
|
|
20
|
+
}>;
|
|
21
|
+
interface KnowledgeRagflowAdapterOptions {
|
|
22
|
+
/** RAGFlow endpoint, e.g. `http://localhost:9380`. */
|
|
23
|
+
endpoint: string;
|
|
24
|
+
/** RAGFlow API key (Bearer token). */
|
|
25
|
+
apiKey: string;
|
|
26
|
+
/** Adapter id. @default 'ragflow' */
|
|
27
|
+
id?: string;
|
|
28
|
+
/** Override `fetch` for tests. */
|
|
29
|
+
fetch?: FetchLike;
|
|
30
|
+
/** Request timeout in milliseconds. @default 30000 */
|
|
31
|
+
timeoutMs?: number;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* RAGFlow adapter. Maps {@link KnowledgeDocument} upserts to the
|
|
35
|
+
* dataset's chunk API, delegates retrieval to `/api/v1/retrieval`, and
|
|
36
|
+
* returns {@link KnowledgeHit}s with `sourceRecordId` preserved so the
|
|
37
|
+
* orchestrator can run a permission re-check.
|
|
38
|
+
*/
|
|
39
|
+
declare class KnowledgeRagflowAdapter implements IKnowledgeAdapter {
|
|
40
|
+
readonly id: string;
|
|
41
|
+
private readonly endpoint;
|
|
42
|
+
private readonly apiKey;
|
|
43
|
+
private readonly fetchImpl;
|
|
44
|
+
private readonly timeoutMs;
|
|
45
|
+
constructor(opts: KnowledgeRagflowAdapterOptions);
|
|
46
|
+
upsert(docs: KnowledgeDocument[], ctx: AdapterContext): Promise<void>;
|
|
47
|
+
delete(documentIds: string[], ctx: AdapterContext): Promise<void>;
|
|
48
|
+
search(query: string, opts: AdapterSearchOptions): Promise<KnowledgeHit[]>;
|
|
49
|
+
healthCheck(): Promise<{
|
|
50
|
+
ok: boolean;
|
|
51
|
+
message?: string;
|
|
52
|
+
}>;
|
|
53
|
+
private deleteChunksByDocumentId;
|
|
54
|
+
private request;
|
|
55
|
+
}
|
|
56
|
+
interface KnowledgeRagflowPluginOptions extends KnowledgeRagflowAdapterOptions {
|
|
57
|
+
}
|
|
58
|
+
declare class KnowledgeRagflowPlugin implements Plugin {
|
|
59
|
+
name: string;
|
|
60
|
+
version: string;
|
|
61
|
+
type: string;
|
|
62
|
+
private readonly adapter;
|
|
63
|
+
constructor(opts: KnowledgeRagflowPluginOptions);
|
|
64
|
+
init(_ctx: PluginContext): Promise<void>;
|
|
65
|
+
start(ctx: PluginContext): Promise<void>;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export { type FetchLike, KnowledgeRagflowAdapter, type KnowledgeRagflowAdapterOptions, KnowledgeRagflowPlugin, type KnowledgeRagflowPluginOptions };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/index.ts
|
|
21
|
+
var index_exports = {};
|
|
22
|
+
__export(index_exports, {
|
|
23
|
+
KnowledgeRagflowAdapter: () => KnowledgeRagflowAdapter,
|
|
24
|
+
KnowledgeRagflowPlugin: () => KnowledgeRagflowPlugin
|
|
25
|
+
});
|
|
26
|
+
module.exports = __toCommonJS(index_exports);
|
|
27
|
+
var import_contracts = require("@objectstack/spec/contracts");
|
|
28
|
+
function extractRagflowOptions(source) {
|
|
29
|
+
const opts = source.options ?? {};
|
|
30
|
+
const datasetId = opts.datasetId;
|
|
31
|
+
if (typeof datasetId !== "string" || !datasetId) {
|
|
32
|
+
throw new Error(
|
|
33
|
+
`RAGFlow adapter requires source.options.datasetId on source '${source.id}'`
|
|
34
|
+
);
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
datasetId,
|
|
38
|
+
rerankModel: typeof opts.rerankModel === "string" ? opts.rerankModel : void 0,
|
|
39
|
+
similarityThreshold: typeof opts.similarityThreshold === "number" ? opts.similarityThreshold : void 0,
|
|
40
|
+
vectorSimilarityWeight: typeof opts.vectorSimilarityWeight === "number" ? opts.vectorSimilarityWeight : void 0
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
var KnowledgeRagflowAdapter = class {
|
|
44
|
+
constructor(opts) {
|
|
45
|
+
if (!opts.endpoint) throw new Error("RAGFlow adapter: endpoint required");
|
|
46
|
+
if (!opts.apiKey) throw new Error("RAGFlow adapter: apiKey required");
|
|
47
|
+
this.id = opts.id ?? "ragflow";
|
|
48
|
+
this.endpoint = opts.endpoint.replace(/\/+$/, "");
|
|
49
|
+
this.apiKey = opts.apiKey;
|
|
50
|
+
this.fetchImpl = opts.fetch ?? globalThis.fetch;
|
|
51
|
+
this.timeoutMs = opts.timeoutMs ?? 3e4;
|
|
52
|
+
if (!this.fetchImpl) {
|
|
53
|
+
throw new Error("RAGFlow adapter: no fetch available; pass options.fetch");
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
async upsert(docs, ctx) {
|
|
57
|
+
const { datasetId } = extractRagflowOptions(ctx.source);
|
|
58
|
+
for (const doc of docs) {
|
|
59
|
+
await this.deleteChunksByDocumentId(datasetId, doc.id);
|
|
60
|
+
await this.request(`/api/v1/datasets/${datasetId}/chunks`, {
|
|
61
|
+
method: "POST",
|
|
62
|
+
body: JSON.stringify({
|
|
63
|
+
content: doc.content,
|
|
64
|
+
// RAGFlow accepts arbitrary metadata used for filtering at
|
|
65
|
+
// retrieval time. We always stamp `objectstack_doc_id` so
|
|
66
|
+
// delete() can find these chunks again.
|
|
67
|
+
important_keywords: doc.title ? [doc.title] : void 0,
|
|
68
|
+
metadata: {
|
|
69
|
+
...doc.metadata ?? {},
|
|
70
|
+
objectstack_doc_id: doc.id,
|
|
71
|
+
objectstack_source_id: doc.sourceId,
|
|
72
|
+
objectstack_record_id: doc.sourceRecordId,
|
|
73
|
+
title: doc.title
|
|
74
|
+
}
|
|
75
|
+
})
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
async delete(documentIds, ctx) {
|
|
80
|
+
const { datasetId } = extractRagflowOptions(ctx.source);
|
|
81
|
+
for (const id of documentIds) {
|
|
82
|
+
await this.deleteChunksByDocumentId(datasetId, id);
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
async search(query, opts) {
|
|
86
|
+
const { datasetId, rerankModel, similarityThreshold, vectorSimilarityWeight } = extractRagflowOptions(opts.source);
|
|
87
|
+
const body = {
|
|
88
|
+
question: query,
|
|
89
|
+
dataset_ids: [datasetId],
|
|
90
|
+
top_k: opts.topK,
|
|
91
|
+
keyword: true
|
|
92
|
+
};
|
|
93
|
+
if (rerankModel) body.rerank_id = rerankModel;
|
|
94
|
+
if (typeof similarityThreshold === "number") body.similarity_threshold = similarityThreshold;
|
|
95
|
+
if (typeof vectorSimilarityWeight === "number")
|
|
96
|
+
body.vector_similarity_weight = vectorSimilarityWeight;
|
|
97
|
+
if (opts.filter) body.metadata_condition = { ...opts.filter };
|
|
98
|
+
const res = await this.request("/api/v1/retrieval", {
|
|
99
|
+
method: "POST",
|
|
100
|
+
body: JSON.stringify(body)
|
|
101
|
+
});
|
|
102
|
+
const data = res?.data ?? {};
|
|
103
|
+
const chunks = data.chunks ?? [];
|
|
104
|
+
return chunks.slice(0, opts.topK).map((c) => {
|
|
105
|
+
const md = c.metadata ?? {};
|
|
106
|
+
const docId = md.objectstack_doc_id ?? c.document_id ?? c.doc_id ?? c.id;
|
|
107
|
+
const recordId = md.objectstack_record_id;
|
|
108
|
+
return {
|
|
109
|
+
chunkId: c.id ?? `${docId}#${c.position ?? 0}`,
|
|
110
|
+
documentId: docId ?? c.id ?? "unknown",
|
|
111
|
+
sourceId: opts.source.id,
|
|
112
|
+
sourceRecordId: recordId,
|
|
113
|
+
score: c.similarity ?? c.score ?? 0,
|
|
114
|
+
snippet: c.content ?? c.content_with_weight ?? "",
|
|
115
|
+
title: md.title ?? c.document_name,
|
|
116
|
+
metadata: md
|
|
117
|
+
};
|
|
118
|
+
});
|
|
119
|
+
}
|
|
120
|
+
async healthCheck() {
|
|
121
|
+
try {
|
|
122
|
+
await this.request("/api/v1/datasets?page=1&page_size=1", { method: "GET" });
|
|
123
|
+
return { ok: true };
|
|
124
|
+
} catch (err) {
|
|
125
|
+
return { ok: false, message: err instanceof Error ? err.message : String(err) };
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
async deleteChunksByDocumentId(datasetId, docId) {
|
|
129
|
+
const found = await this.request(`/api/v1/retrieval`, {
|
|
130
|
+
method: "POST",
|
|
131
|
+
body: JSON.stringify({
|
|
132
|
+
question: docId,
|
|
133
|
+
dataset_ids: [datasetId],
|
|
134
|
+
top_k: 256,
|
|
135
|
+
keyword: false,
|
|
136
|
+
metadata_condition: { objectstack_doc_id: docId }
|
|
137
|
+
})
|
|
138
|
+
});
|
|
139
|
+
const ids = (found.data?.chunks ?? []).map((c) => c.id).filter((x) => typeof x === "string");
|
|
140
|
+
if (ids.length === 0) return;
|
|
141
|
+
await this.request(`/api/v1/datasets/${datasetId}/chunks`, {
|
|
142
|
+
method: "DELETE",
|
|
143
|
+
body: JSON.stringify({ chunk_ids: ids })
|
|
144
|
+
});
|
|
145
|
+
}
|
|
146
|
+
async request(path, init) {
|
|
147
|
+
const controller = new AbortController();
|
|
148
|
+
const t = setTimeout(() => controller.abort(), this.timeoutMs);
|
|
149
|
+
try {
|
|
150
|
+
const res = await this.fetchImpl(`${this.endpoint}${path}`, {
|
|
151
|
+
method: init.method,
|
|
152
|
+
headers: {
|
|
153
|
+
"content-type": "application/json",
|
|
154
|
+
authorization: `Bearer ${this.apiKey}`
|
|
155
|
+
},
|
|
156
|
+
body: init.body,
|
|
157
|
+
signal: controller.signal
|
|
158
|
+
});
|
|
159
|
+
const raw = await res.text();
|
|
160
|
+
let parsed = {};
|
|
161
|
+
if (raw) {
|
|
162
|
+
try {
|
|
163
|
+
parsed = JSON.parse(raw);
|
|
164
|
+
} catch {
|
|
165
|
+
if (!res.ok) {
|
|
166
|
+
throw new Error(
|
|
167
|
+
`RAGFlow ${init.method} ${path} \u2192 ${res.status} ${res.statusText}: ${raw.slice(0, 200)}`
|
|
168
|
+
);
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
if (!res.ok || typeof parsed.code === "number" && parsed.code !== 0 && parsed.code !== 200) {
|
|
173
|
+
throw new Error(
|
|
174
|
+
`RAGFlow ${init.method} ${path} \u2192 ${res.status} ${res.statusText}${parsed.message ? ` (${parsed.message})` : ""}`
|
|
175
|
+
);
|
|
176
|
+
}
|
|
177
|
+
return parsed;
|
|
178
|
+
} finally {
|
|
179
|
+
clearTimeout(t);
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
};
|
|
183
|
+
var KnowledgeRagflowPlugin = class {
|
|
184
|
+
constructor(opts) {
|
|
185
|
+
this.name = "com.objectstack.plugin.knowledge-ragflow";
|
|
186
|
+
this.version = "0.1.0";
|
|
187
|
+
this.type = "standard";
|
|
188
|
+
this.adapter = new KnowledgeRagflowAdapter(opts);
|
|
189
|
+
}
|
|
190
|
+
async init(_ctx) {
|
|
191
|
+
}
|
|
192
|
+
async start(ctx) {
|
|
193
|
+
let svc;
|
|
194
|
+
try {
|
|
195
|
+
svc = ctx.getService(import_contracts.KNOWLEDGE_SERVICE);
|
|
196
|
+
} catch {
|
|
197
|
+
ctx.logger.warn?.(
|
|
198
|
+
"KnowledgeRagflowPlugin: IKnowledgeService not registered \u2014 install KnowledgeServicePlugin first."
|
|
199
|
+
);
|
|
200
|
+
return;
|
|
201
|
+
}
|
|
202
|
+
svc.registerAdapter(this.adapter.id, this.adapter);
|
|
203
|
+
ctx.logger.info?.(
|
|
204
|
+
`KnowledgeRagflowPlugin: adapter '${this.adapter.id}' registered (endpoint=${this.adapter.endpoint}).`
|
|
205
|
+
);
|
|
206
|
+
}
|
|
207
|
+
};
|
|
208
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
209
|
+
0 && (module.exports = {
|
|
210
|
+
KnowledgeRagflowAdapter,
|
|
211
|
+
KnowledgeRagflowPlugin
|
|
212
|
+
});
|
|
213
|
+
//# sourceMappingURL=index.js.map
|