From 2a7aa91db7611cbe69c31a66d3ee357d7160aa08 Mon Sep 17 00:00:00 2001 From: zlareb1 Date: Sat, 21 Nov 2026 13:53:45 +0000 Subject: [PATCH] Add Loom memory and document search tools Signed-off-by: zlareb1 --- clickhouse/loom/.difyignore | 12 ++ clickhouse/loom/LICENSE | 201 ++++++++++++++++++++ clickhouse/loom/PRIVACY.md | 22 +++ clickhouse/loom/README.md | 52 +++++ clickhouse/loom/_assets/icon.svg | 19 ++ clickhouse/loom/client.py | 75 ++++++++ clickhouse/loom/loom-0.1.0.difypkg | Bin 0 -> 13330 bytes clickhouse/loom/main.py | 4 + clickhouse/loom/manifest.yaml | 33 ++++ clickhouse/loom/provider/__init__.py | 0 clickhouse/loom/provider/loom.py | 16 ++ clickhouse/loom/provider/loom.yaml | 51 +++++ clickhouse/loom/requirements.txt | 2 + clickhouse/loom/tools/__init__.py | 0 clickhouse/loom/tools/recall.py | 31 +++ clickhouse/loom/tools/recall.yaml | 42 ++++ clickhouse/loom/tools/remember.py | 27 +++ clickhouse/loom/tools/remember.yaml | 40 ++++ clickhouse/loom/tools/search_knowledge.py | 28 +++ clickhouse/loom/tools/search_knowledge.yaml | 42 ++++ 20 files changed, 697 insertions(+) create mode 100644 clickhouse/loom/.difyignore create mode 100644 clickhouse/loom/LICENSE create mode 100644 clickhouse/loom/PRIVACY.md create mode 100644 clickhouse/loom/README.md create mode 100644 clickhouse/loom/_assets/icon.svg create mode 100644 clickhouse/loom/client.py create mode 100644 clickhouse/loom/loom-0.1.0.difypkg create mode 100644 clickhouse/loom/main.py create mode 100644 clickhouse/loom/manifest.yaml create mode 100644 clickhouse/loom/provider/__init__.py create mode 100644 clickhouse/loom/provider/loom.py create mode 100644 clickhouse/loom/provider/loom.yaml create mode 100644 clickhouse/loom/requirements.txt create mode 100644 clickhouse/loom/tools/__init__.py create mode 100644 clickhouse/loom/tools/recall.py create mode 100644 clickhouse/loom/tools/recall.yaml create mode 100644 clickhouse/loom/tools/remember.py create mode 100644 clickhouse/loom/tools/remember.yaml create mode 100644 clickhouse/loom/tools/search_knowledge.py create mode 100644 clickhouse/loom/tools/search_knowledge.yaml diff --git a/clickhouse/loom/.difyignore b/clickhouse/loom/.difyignore new file mode 100644 index 000000000..0344255ab --- /dev/null +++ b/clickhouse/loom/.difyignore @@ -0,0 +1,12 @@ +tests/ +__pycache__/ +*.pyc +.pytest_cache/ +.ruff_cache/ +.venv/ +.env* +.git/ +.github/ +.gitignore +*.difypkg +pyproject.toml diff --git a/clickhouse/loom/LICENSE b/clickhouse/loom/LICENSE new file mode 100644 index 000000000..ebd8172dc --- /dev/null +++ b/clickhouse/loom/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for describing the origin of the Work and + reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or directory name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2026 ClickHouse, Inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/clickhouse/loom/PRIVACY.md b/clickhouse/loom/PRIVACY.md new file mode 100644 index 000000000..e634fbf1f --- /dev/null +++ b/clickhouse/loom/PRIVACY.md @@ -0,0 +1,22 @@ +# Privacy + +The plugin sends the configured organization, namespace, agent, end-user identifier, +memory keys, fact text and search queries to the Loom endpoint configured by the +Dify administrator. The token is sent in the HTTP Authorization header. + +Dify stores provider credentials and may retain workflow inputs, outputs and execution +logs under its own deployment settings. The plugin adds no telemetry, log files or +local data store. It does not send data to the plugin maintainers. + +Loom stores memories and documents in the user's Loom deployment. Its configured +providers may process the text for embeddings or memory extraction; the deployment +operator controls those providers and retention. Remember writes persist after the +workflow ends. Use Loom's deletion and erasure operations to remove stored data, and +configure Dify separately to remove workflow traces. + +This plugin makes authenticated requests to an administrator-configured URL. Treat +that destination and the Dify plugin runner as trusted; use network policy and scoped +tokens to constrain access. + +For privacy questions, use the source repository's security policy: +[ClickHouse/loom security](https://github.com/ClickHouse/loom/security/policy). diff --git a/clickhouse/loom/README.md b/clickhouse/loom/README.md new file mode 100644 index 000000000..a0d937ce0 --- /dev/null +++ b/clickhouse/loom/README.md @@ -0,0 +1,52 @@ +# Loom tools for Dify + +Remember facts, recall a user's memories and search documents in your Loom deployment. +The plugin calls the Loom Python SDK over HTTP. It adds no database, cache or local store. + +## Install and connect + +Use Dify's Plugins page to install the `.difypkg` from a local package file. +The plugin runs on Python 3.12 with `dify-plugin` 0.11 and `clickhouse-loom` 1.2 or later 1.x. + +Configure the Loom URL, a scoped writer token, organization, namespace and agent name +in the provider credentials. Prefer HTTPS and restrict the token to this namespace. +The plugin can reach the URL you configure from the Dify plugin runner; allow only +trusted Loom destinations using your deployment's network policy. Credentials belong +in Dify's credential fields, never model prompts, workflow text or committed files. + +Bind each tool's User ID form field to an application-controlled end-user identifier. +It must be non-empty and cannot be `-` or `*`. The model cannot supply this field. +Recall reads that user's memories across agents in the configured namespace. +Search knowledge reads app documents shared by the namespace, rather than private +user memories. Give mutually untrusted apps separate namespaces and token grants. + +- Remember takes a stable memory key and a text value. Loom resolves duplicates and conflicts. +- Recall takes a query and returns full memory results with their scores and abstention fields. +- Search knowledge takes a query and returns matching document chunks and source URIs. + +Searches stay in the configured namespace. A request failure fails the tool; the plugin +does not replace it with an empty result. Requests use 15-second HTTP timeouts and +one attempt, with a 30-second SDK call wait. Native pool admission and client setup +and close have separate waits; this is not a whole-invocation deadline. Credential validation +reads at most one memory row and discards it. The plugin makes no model calls. + +## Build and check + +```sh +uv venv --python 3.12 .venv +uv pip install --python .venv/bin/python -r requirements.txt pytest +.venv/bin/python -m pytest tests -q +dify plugin package . -o loom-0.1.0.difypkg +``` + +Tests use the actual SDK against a fake HTTP transport, concurrent native tool calls +against a loopback HTTP server, and a local Loom server when configured. +The hosted application check pins Dify Community Edition 1.20.0 and uses a Loom +server and SDK wheel built from the same commit. It exercises ordinary setup, +remote plugin registration, native tool workflows, user isolation, persisted identity +and owned resource cleanup. Its result and retained evidence report the outcome. +Dify Cloud and the full supported version and architecture matrix remain untested. + +Source: [ClickHouse/loom](https://github.com/ClickHouse/loom/tree/main/integrations/dify). +See [privacy](PRIVACY.md). +Contact: [source repository issues](https://github.com/ClickHouse/loom/issues). diff --git a/clickhouse/loom/_assets/icon.svg b/clickhouse/loom/_assets/icon.svg new file mode 100644 index 000000000..cbeb5995b --- /dev/null +++ b/clickhouse/loom/_assets/icon.svg @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + diff --git a/clickhouse/loom/client.py b/clickhouse/loom/client.py new file mode 100644 index 000000000..79b00315a --- /dev/null +++ b/clickhouse/loom/client.py @@ -0,0 +1,75 @@ +"""Scoped SDK requests run in native threads; credentials stay in provider settings.""" + +from typing import Any +from urllib.parse import urlsplit + +from gevent import get_hub +from loom import SyncAgent + + +def request( + credentials: dict[str, Any], op: str, body: dict[str, Any], **identity: Any +) -> dict[str, Any]: + fields = {} + for name in ("base_url", "api_key", "org", "namespace", "agent"): + value = credentials.get(name) + if not isinstance(value, str) or not value.strip() or value.strip() in ("-", "*"): + raise ValueError(f"Configure {name} in the Loom provider") + fields[name] = value.strip() + url = urlsplit(fields["base_url"]) + if ( + url.scheme not in ("http", "https") + or not url.hostname + or url.username + or url.password + or url.query + or url.fragment + ): + raise ValueError( + "Loom URL must be an HTTP(S) endpoint without embedded credentials or query" + ) + + def call() -> dict[str, Any] | Exception: + try: + with SyncAgent( + **fields, + timeout_s=15, + call_timeout_s=30, + retry={"max_attempts": 1}, + pacing=False, + consumer="dify-plugin", + ) as agent: + return agent.call(op, body, **identity) + except Exception as error: # noqa: BLE001 — Return failures without hub credential logging. + return error + + result = get_hub().threadpool.apply(call) + if isinstance(result, Exception): + raise result + return result + + +def user(parameters: dict[str, Any]) -> str: + value = parameters.get("user_id") + if not isinstance(value, str) or not value.strip() or value.strip() in ("-", "*"): + raise ValueError("Bind User ID to an application-controlled end-user identifier") + return value.strip() + + +def text(parameters: dict[str, Any], name: str) -> str: + value = parameters.get(name) + if not isinstance(value, str) or not value.strip(): + raise ValueError(f"{name} must not be empty") + return value + + +def limit(parameters: dict[str, Any], maximum: int = 500) -> int: + value = parameters.get("top_k", 5) + if ( + isinstance(value, bool) + or not isinstance(value, (int, float)) + or not 1 <= value <= maximum + or int(value) != value + ): + raise ValueError(f"top_k must be an integer from 1 to {maximum}") + return int(value) diff --git a/clickhouse/loom/loom-0.1.0.difypkg b/clickhouse/loom/loom-0.1.0.difypkg new file mode 100644 index 0000000000000000000000000000000000000000..7e5a4b33c7be350ed5e3689099be0884e3a0d2a9 GIT binary patch literal 13330 zcmbt*WmsLw7A5ZPPJrO@>t5627(&%RLrW0^QM53a>Qhcy3jZb9j!(Wjz38KO)>7K|YQ*Df z?NYzOdzV_Io8rn!_KcKtH@CGrFaUtpSDBCC5L=#IrrK}4I=)>p|2Qu2x2F6jg_wbO$SALo~*|oW?yx(DT?*e+M3{W?Zm*rR8p09{uF0s!+y^}JA z<%R;z7KGS$f$w5^S7x%MKA{Gl+Yf~UH^!2i7g_Q?B*P*OUTT)e9j;4IkfO@_0V0wt zH;R{UKMnU5_X*S-I$ItOi?Sb2lC5sIiLpBmH$v*98Q?}|!rQ@%3eZUyU^?E7o z;Mc1U`$7Oax@UfnL&x{o-vYY;R-j>>s2)awCMN(FT|fv_#p~b3P%EWpzE6kwWkO_j zDrKXzoR4j!-I%2*XL_PA*JQ%G*4;`nCJxWf7fLe@8MS=V*TKA>uBp@Isz$lcYY(F= zCJq(9w>!QmqGAcS2?}dR28=-<`OXfs(+4G2#DzvI*i#RlZQmc!HE$zYi+6|yQ>ims zkjKM4Yz{g>(`7e{EVa~^GQV8^vs)op%uF#0jxHam*wt+2+RHO@Nex`=c1;%j-8%_E z`tx+_{Td+$SY|Bqcm)C4e00Y#g4fju%EsylPur3shQqE(=?q227%FfBkN1FgK2j9Y z0WkY6JKUsPd#Y4GaKoy_+)I;U8nVvUg~=>z=9BE^TiWV3cgRKi7P)G~pvsDHl?-x` z$005-I_3anF2YN`pjOM)Sy$gn5%Mf5Q%oa4iRmxADds&(ZgRKV1xuLF&TX_`(TA)p zo9O!Qk_CB9%OmF&@m%84>BK`c-gQE5ABaUGhwx4w%%gz_-Bvc5I(NL^{+2X#V7-wP!NfsMP zkIHAS$)QAx1#&?ZhgLUst-T>9Y%C5*CM-@&zbWv6Ro^#;tyBF9g(WXlhZy9L`Z(L% z0?CFLW+QYTJp5{F`Y*)5?HDw0?Hfm|EttJWG+o0o}|thG@HGWovfFGX+_usx}HZwKW5>Q@V&D2VcR$Ep8LQ7i9@b3~-1xEVuQeCyM5 zUox_|uJ1w-dCRvG%jpP*Z5!1RiX<lQb6$3Hk3p@pA~ej1!LK6*?x zXfjdKs(Y*)px+bGniLG8R8j`}E~|9*`mn`M`tI8PSi^fgpDQ0268{l7e*zMoIR`Kh z33KphTVPzn5AT&F2Qp zHxzC}g?gZhw=G;|+530AN4q93ME=f8T_O7$e9mqG_Ka!p`epGmBH}arq59083|XON zbC;ySDsgt|Vwa>;hShEb7Xq9{=D~mu{e*m(Al|31zWW-Rp*;jL-uF?V(XdxG@0tP# zGU|e~XfrB(q_~J`TFeo~C+jVO_f*fnIK;mwKkH})c_&-HL)__s!ZiFoH~>ojLA3+} zOme$``2nLRH^WY$n?1=SO!C#-YPWEx;mNDPPK0w)#7ohOpasOnlqiuIhbkn;C;G!S`^ z>p%FB-;<4C|rV`W4kWtS{veOse>Z{I5bu!_?{2IOjY`?jcl$ttJ2Ua@4{CQ) z_{>5)v7X3gN=}|FFJCM{0kwf1Q-^2{-VJH)lb4iuc|ph9?y5#86Hr8E0O5oL7>%$W zoad-R#`!U*H1T?45eafZ;AcM|wxj9MxZdSxvo8t(gm+D|DOw&(Q`*(Rr37qbRwolK zvpu@pOc0hlv0B`H1-TTCiFat#;PW;$O3P08n#sBG)$OR*jy81UI)qv|1(xP>5qA*^ z3BvfkUZp^x#$^hebDExh>5+*JiJo^?neKcqdD!{U%BXNlGFOkRi`sWcO_+)vnS|ZE zCB2>yqog2xOY9tzeIt=espM$?ICGcp6Ojr6sI6y;HKMo~g?g-``$Ev1nl8=o!|{e1lL?BYn& z!NUpXnsmORW4IyN-4Bt4ke`N_yLP6S(xfH?_HHYGh_>ZqjYk?LnicDr@~T-b7Dmrd zX{dG2n~D>uuqCTXQ;;I@7Up~D>6U7O45~RC0eZ&b!46-un>aU^5U0TMRMoTLkGYz< zmsa^yH9|3`qOGY(%zqutoIzttI9oD&a`|e=^pPoalnRL?Bxt5?up#o|xeWGd%HFm6 zIltb9EVp{~^0SDApXBAX*Ogx9x_!8$O zG^ANgG(?BSM9U}`IENdmDBe~CHRo?jtYcj=jnzSWj+sLA5bL8v}+fs8J+@ev>_AnS2S*+N8C$Y0h9^+I*m>}F11NEUs`Jl(u zgD{^4`5ckvw1ACT;F4x(^z9=gR576K_TpHDQDs#hsj?ExTWlxB}N(% z65G9y>A!LB_7skq8@e13EMI5_uQgQ=2`OrXVc?oPIMVQ*F=sqAix75dEYXl~_Jdo2 zPvrGjn+fSU(?X8P7IymVsQ+xEH8+tg$#^XKo-JN_s#W)tp~~mTh#^vHv69PHYsnLV zJCm(y>PZUaJA1;TKtgP2HMT`0!8GC{vKn{Ak+^~uULN zOzJ)8ZYQhtXUsJ-;!KY^u6)a|u<^WO;}BirWLCv{N$JKM@B&(Styc-c?^*m12#-oj zp++9%5-GHp$b||ijgs_Z%PI3ZdR3vrm{bB|muK#YSKGVKt2Y;?*Ui`J9y=mm?&n2C z9vBu&Y@Zv?m06_kdx5oc*Iq@|(lJ?^PY`W%1;#9Q8Ovg_{1+qjA}brl_mj30Bp65e z8D($x_SD)RGT$)tpO_o>ew2+D9sq!a>fbOo)DJ{1C#J+Ns7hn;Nh6NmYUKlr|Jfxa z#MK6xOzrJAg<3MXcY*H~(n9e17~_PFjlV?UEFV_Tvc;TOSb-&MJ>IQhzk+D{XXq^n zHqt<-n=mTMl&W^3`Sm#De1$aBN!HKz%t4$7G}Vx8NV4`~)2{=p+=Z8v^f4Ast}t|DcvLT4C9j}tnhBBP7!krM_aR@vR3lWr5v389t; zHBQw~bj~QVnsNZJGV;1_cjr@d|045Q$#^y~n*7|(KTLho-GN4!vA70rq;Q$u$bU#j z#acMl-K&dHLP5rx7)7dzF9HpI4e^C(AnYajx--$|pl1M%qed2x9 zym!75k^?vLhx&I%Z;A9KIdv=lN-G1|^R*?(;^D$Jc`)IIjYNy~6}znkPCLS(J#2IR zFSkvM?K1HM0s!a%`8T(PeEYndFu#zb@SE3$DXm9he}(nPZ1>^Avn4;iu!M6L%Q%h6 zX)u!4z4{Z}i@pNAoIYf2S%iv4)?Z{wsyL$Y3 zlwq7>B7%9dub>n)s0-mGx z$h+NNSDaSCBV0YnlFQTYAFfP5A-32i0rrkZ)$T=YK-1tcp4(-(`%#6`M3Fd(FV6X7 zk5u>c9TFKbpZG8}3cPb%V5YkD3!bOW$FFrsCXdtSSec`)#YJf6Aw0bp1W4@l-7l^W zVzaFPsPbn#mf}0Dr`tsDxpg4iz#?={nb2jiXlfC!tCUD&din*oXX2$QKnV|$FApGOPVc_v4`Qa931dDekoTMcilC9~gvR}w_5>@l6 z@+s!MTskcq{h#cn@9Dp@PgrO5QWx0gx?@geoa`R%?_5JM92$?{(hCf|_=#&;bP~to zy&Ot|$WQtZjL2;HBP7Lm$#jLeY}ZI;_Du-(eE}QA(lSiknl$G_aq?D6!;F|o34vWl z4iIqP)*#umCiKo`nn^&Ii`YoNXT7bRGfwiY z<*qmVOXs+aZr=TC_V6qBl;7b8`M&(;jXtEvVTIk8^udeHrKy$}6~^6HNX93i}kGP7D0XxitOtG#P1LZBOATCR7T#nB}6;2pZ(3Fk(k)XwJ+38;(Az^Oop zGWLgv?Fi3OKeZOE>&7g9N{K)ifZBajj=)QoRYxC2$|)9|te%PRj=jq9qyxS*uIetrAAYLKWl zr+K>r>PQ5~G40fg2yeUy)P)yWD?^|k*Q2WZL0Z|?(yX-0{K`!8u-ppRZYi6y{#M{# z$hl6m<>Z{=)DdtmdJFbqnGpM)!HA~2sSY>B9sO|Wp<`MhXCCu~;m*`%y}kA5%ruKo zF&nK=eQTp@_EHo@N7-%Sh!7>sSe5cRR&YEnos~2V9G`wXyrG0CR!3?W_8-M4VA zQy5oz#;Hu$`{Q=$>MXr6WpGU|k1ARylLd-1aUqKa$;@#k!L%RG(gf-7><1;uV_dgK z9sI)e!yySzZ0SyTZ2yi{#E(O@S))B1^2%TkDB1-)KE|W z0NuBJhJPme5#BPmwyvF>fxR8AiN2L3jh&-WSj?zp8Xb!N?IlVfYpP?XG#3Op>R8T^ z<18s%pBJhx(K6`n38gPGv)lnn6kXtW<{2}S2WF+D;Z0f}f>t|PZ&Ufb%V-%klv0Ah zW}p*%>Je`yoML|*50iHkV`sOAEmi9E(&b3ONmfI`{t&fxi$HH(pMEudA>gWq6 z1;&#&A)}VGp&eQI(Gpa`4BzOm31BB8_t9@Yh7cHhj9AIyRzUyA7}?Dl$tVa-VEOT= z(r4MJ-K+mG$Q$U+m=BXKW(FAOglmYx4LZLc3YNSG7$gQ)Kdk}2SO6X{IL@R?4uU>) zcCDT-UA_Qtmg5L=Er}*IcV5jRQR>0V)#!?Yt?Y~T;s!9*5+`=vD2-*!NA=}X+=g`W zbtYqDmQ+QRGh{MD06N2FAMyAr@+fV(@Mchz2A`|1b&9MGndwEf2~CPy+<}*8+FnW~ zv1-}nK&6`p?4IiIAL<9DQ1mE)Epz7e00lVe?!$1~)z;79w|!!XNmvUBcG)R-;pIg9 zuGzv3d=<`%?*a2o=@R%r4S>Yt^`hsf*}k&VVSZ$vVTe*L7wyv*%yAieKh_6wcOeJr zw~pa)(t0gS?NM2vBzXlPEwPiFI1RTMFm9j?tEZEM`p~n$se*5n&NpeMf)ACof8p!s zgjrxp2FIT}KP+=v*_*~=R7qr;2J#w!=&c2!RbAtqG_cTrgE5g=&57BCepHfp^BC0T zYEs&2u2wEwA8wy!{5h{uw8`Dg6W9UtH4$X(}y<1kp)Soxwp9M z@C#~LppYmI(74e-yn0TY8an9^x<}wqKN2pv8CdzZ=53&j@IV&Mg0b;MRi2989>HQ^ zY!l?UL}hu}=_QybE1Cj?$ZyTpvBo>wACPp9$bwKcc%-wX5{8(L@blq5>(QDCm`_#+ z=O3P~94wF#McCLy0m{LbOCbiYeL7<}Fww-r+2*H5!6DHEcV=h$K3DWWid@QO=U#-C4c{Zggf91PVuq2dCM! z97kcZj~yG+tg-#Kx=`=?ybwk`mZheKZ}-FQ3Ty`kp?)3=j`Emb-`Nj6I$-aZ)~HQl@g=B7qsr%hVjlZwHlSWswKc|NloJ)%t`wL&e`L$G zSIy-Yc@@GHYHwF+YxpWqv`KPzM%bDoK>g5}0ftnuLTG*KK+15;I9;q*Q8+gwGTY|} z$~87;?O+patMC}`SZMn0h$XWZs9b6VXxgn|?r`v1W*3x!F<@PN%r5dBvD>`1{L|DW zo^M<>jxn6}^}sg|&6&7?&jXZ#3t53z6}vIRCq?VW_bU6k?ThPgvHd6Ri??uxu6c{{ z%C}(t=k)tyuhl}=#PTi9#VLoz6-5UnO2TLd$R)=|13J0E9N~#vhRJ zC243Rn?PM$I0t_%y10O6QRWh=6i%U&p)sF~1zxyC$3{L8!8zciQLF~l zg!6a46JZakCYFoR&@@L-8OBoec2wdmt1?6aIDyFlfUW-g#z9I*oz+M+@Oz+*Uuk*Y_tp#CMwW={d zmG3hI^ZsQqC)`Xnr?+<>-@w^FTMXsRV%D}+jwYWBY-zQ%O)O39wYA@z?5}3to&&rs z4*rmTZsy18;IC%Pt*k8Gnh1;L|Jcok;D2_HDkufn<1-KC6U2%LpN}40eJr(<-OOm? zBnPwQnJAgER1Cfs=gfG9{k=XMi7znXGc*cEFq9J)O79nS=>d)-#B~=5j&Pj1?t;tb zgwGijLQi&a!0ch|31}F(J+(53uZf#HIf6QDYC7w+2j*81`aF))T>R<%fg1ygBJ%f=iXk3vN8 z-5a6vXC4^Smq4R@n|8&2wHMO=O!SX1tBvclT&6=1I(rCt_GWWh3(=ZJGmfs|i$xBm z>orImet$fVo@dr^Qx!lHKu-j_PW1&APt2Ev5pl7YGL!(_m$OU*nk45FD@Mr3vJlD% zVim8rA5;4a!<8)yS4eCWvvpHdyRN>;r&!YQa!XNhP^A@d0@-Z}B5y9+Z*wQzLMS+- zj2`ei?#XF7GD|AEtO@MU?cneSq_`HH8aw!L^)P}V((X{?%D6cjPOv~$qWOBF%G{PI z6G!8T+2uj^W3NL8)KrRm2_VA6Z2r9MHw63yd2Rw&2EGX;QufKVv_^JG(#G>0pi<}U z1KSg=*{TWsq)&oqsa^QXR)cFD&r1pBxOn|99>Ghgi!`DSY-fphj9`_tl??q;v6;qC z?r7!<5mACQ>MfJ$;TKxm72fx8cSK#ZY>#&eRoqOhnzX}t)~MiuiSVyqD{=)br+?BL z$EpA+N^e$a`&WA7hx^+a*f^Nj8d$t7#_VY9KiiAHrQ;duKQeSp4f6ye(+uNG75&@q zDaH-)u|bKku>o3YsoBxN@$tGE<{8E*#)&HWEugo4{`3cI_`n6Ow{}_Hu73_Z#J8vR zR#xVA{~y8oMmqkd4O;_!U32rd*tM6JjGU%JXx&o|vlW*afQO(!0_PL$04!@PRf?W> zHj%WDp35l3B6#7novJnOe%N4PJR9A!!(WItG|TR-jI48+`Lxo(zt70!g9Nu27Gpx^ z(aynpN3MRng!NhVWR8sp6_hJHNG^KgJ!&}O9$ET9p=0It+FiVDzd7p|mR1->k6O}6 z`vmPva^zhA#w;H6I72h)_xMG37;nJ@gQa4O1Mu2v7THkyc*ze!Guef6BUK>~%gS*` zb-qwT{0Mr2>65nj#0o{rfiY`s?PK3O6+#tqowy$r5vRt3%=3I zgfVaU@)4Yj|Bbl=~fH6y!&%+4$bwi4*k=u{^JrqvP@|#uhj}2 zOz-U@iq+AS25mPrRwxx{2#{pTeU^&7gb)&L2+-JiTa+7Y8p<F4zBlVW%Uu$@H}+efb1Zm$HMqbvo@jQ@yM^xL8aC?MRfxZ0p%!J#X<$Cm!midFOa^B$t zKXC&55&YN8#MRrk5dG7Bl#?`y-f#9R`&VH2tNkntEc6U){|IXS&}FVSfT#?^zPK^Y z`wpM{N=7{UB%7+0Ds*y)R+TxX4>!C!W$IPyQ~w}|r9;$-^I7-@t3KCFzJ%65#eRC` z-NhJa?$9X_p&;1=J-vg4=Fch}w>DI}jn{CpiH#e3UU|&qT6F~kn^b2j9_FsRI2sy_ z@FO0eEJ24e1k6Ln>vFuk$oLna=|*tSJB)UB@4Dnr{I5xf9|FA2VFtGttY+)q z5gt|+&Pgr~fwWhU z1)~;aOp=y(@gLpn&sSIEDd|FPM79AZl7*p~g{-^5^e|8Ojc+jf6Vjbu#mI%iwt!m)t9n&*-23^bLfA4>moqgY zO+$tO3ZB+_?}>^n|1@v$Y!;5JQwUn-y8sghpM{{krtM?fG zL})ZXoa3Zij7XF~CU!!OD0C7d$@Q&X^YX6vsyQa(z}k5O)mK)vPv~0>^+2(to>y2`eDCQeA5zKBSU152EDp3G9?JC0 zdRq4FVTUz7y#qFYyPvj9Pdxo;kng-9r7~{@iTKxW!~Dx2b_Tk(`o`L3mR3&Y2A_-! z{##4=VBTt}3Olh}P=c9kG}}AByT;0`YBk~R9t%msKGnz?CV?j>Cb8+Mfb{O#s?5yv zy~OlN@Zqs+#VrK0%Wk0i4B<^+FqB-XMZc-4!bKG|gq_2NFLW1nwByvfO5g}L4M~ClOl-knrHFS-`YiXajWRTlU67aM?66mF=*FxI~8_sm)r^^=eJZ zqHoVYCFv$LOW!8SHZy`(;m=)o3d6zTZLUf>kvH^wv;3c_7YwhXxcAK$j{embu>aW? z{tVLbh-EIAo-^kVXD_Qu;y^7osvEg1vI)yub27A6B*I{|5P|Im+V_R(tk02JFv%M* zd!$Qia&i^JmB2B{}Qz4ycWK5WRCT?yR=M(XF z#kC3~7pmNabNi-D2O?0z^5Jo{S!_g~Y}B&G&|3^5xRnMCbKFz0w$_KM5s}5j#8W+- zK+F6;UDfYR60_Q)W@fnX?|*e6;N;7fqqXqT2Ec=cTwA%->&LcAVr{K(ua*hm03vps z-_>t@U5wR1i%@BVk{EMc`6E`9h3Zl0*mnh#wL6a5GK~`0uJ!`XzQ$0!3f;c+ZaSIc z(2cTp5~_{ zz5V&06Y{?+{km`ZV^ja9z`UV}pIiLD>;1~s|Db<=O7|N!{A-W(ceP*n8BL`q4W#8^tJS^?!wY zfA2kq=zjs`@7h0l`|r2^vHtrhIPd=p@c!ki{|XF#Ai|%b^OyQx`0)3>e_fUSy>B~` z|MvY0lK5Ty*JaP&)fvfts{gf+{ayXnBK>1+^ivQi{zv`)Hu1k^_8+zUr{qxnw}Jml pW&eE~zh;*oW#FfjQ~zT#e~t(A?SF3o0Fd8ap>M# None: + try: + request(credentials, "memory.list", {"limit": 1}) + except (LoomError, TimeoutError, ValueError): + raise ToolProviderCredentialValidationError( + "Loom connection failed; check the endpoint, identity and token grants" + ) from None diff --git a/clickhouse/loom/provider/loom.yaml b/clickhouse/loom/provider/loom.yaml new file mode 100644 index 000000000..d0ab4dab4 --- /dev/null +++ b/clickhouse/loom/provider/loom.yaml @@ -0,0 +1,51 @@ +identity: + author: clickhouse + name: loom + label: + en_US: Loom + description: + en_US: Memory and document search in your Loom deployment. + icon: icon.svg +credentials_for_provider: + base_url: + type: text-input + required: true + label: + en_US: Loom URL + help: + en_US: Configure a restricted Loom writer token and its deployment identity. + api_key: + type: secret-input + required: true + label: + en_US: Loom token + help: + en_US: Configure a restricted Loom writer token and its deployment identity. + org: + type: text-input + required: true + label: + en_US: Organization + help: + en_US: Configure a restricted Loom writer token and its deployment identity. + namespace: + type: text-input + required: true + label: + en_US: Namespace + help: + en_US: Configure a restricted Loom writer token and its deployment identity. + agent: + type: text-input + required: true + label: + en_US: Agent name + help: + en_US: Configure a restricted Loom writer token and its deployment identity. +tools: + - tools/remember.yaml + - tools/recall.yaml + - tools/search_knowledge.yaml +extra: + python: + source: provider/loom.py diff --git a/clickhouse/loom/requirements.txt b/clickhouse/loom/requirements.txt new file mode 100644 index 000000000..4ffb13092 --- /dev/null +++ b/clickhouse/loom/requirements.txt @@ -0,0 +1,2 @@ +dify-plugin>=0.11.1,<0.12.0 +clickhouse-loom>=1.2.0,<2 diff --git a/clickhouse/loom/tools/__init__.py b/clickhouse/loom/tools/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/clickhouse/loom/tools/recall.py b/clickhouse/loom/tools/recall.py new file mode 100644 index 000000000..07034e6db --- /dev/null +++ b/clickhouse/loom/tools/recall.py @@ -0,0 +1,31 @@ +from collections.abc import Generator +from typing import Any + +from client import limit, request, text, user +from dify_plugin import Tool +from dify_plugin.entities.tool import ToolInvokeMessage +from loom import LoomError + + +class RecallTool(Tool): + def _invoke(self, tool_parameters: dict[str, Any]) -> Generator[ToolInvokeMessage, None, None]: + user_id = user(tool_parameters) + try: + result = request( + self.runtime.credentials, + "memory.search", + { + "query": text(tool_parameters, "query"), + "top_k": limit(tool_parameters), + "namespace_scope": "this", + "bodies": "full", + "explain": False, + }, + user_id=user_id, + agent_id="*", + ) + except (LoomError, TimeoutError): + raise ValueError( + "Loom request failed; check the provider connection and token grants" + ) from None + yield self.create_json_message(result) diff --git a/clickhouse/loom/tools/recall.yaml b/clickhouse/loom/tools/recall.yaml new file mode 100644 index 000000000..7f0110b5b --- /dev/null +++ b/clickhouse/loom/tools/recall.yaml @@ -0,0 +1,42 @@ +identity: + name: recall + author: clickhouse + label: + en_US: Recall +description: + human: + en_US: Search the configured end user's memories in this Loom namespace. + llm: Search the configured end user's memories in this Loom namespace. +parameters: + - name: user_id + type: string + required: true + label: + en_US: User ID + human_description: + en_US: Bind to the end-user identifier from your app. Do not let the model choose + it. + form: form + - name: query + type: string + required: true + label: + en_US: Query + human_description: + en_US: The text to search for. + llm_description: The text to search for. + form: llm + - name: top_k + type: number + required: false + default: 5 + min: 1 + max: 500 + label: + en_US: Result limit + human_description: + en_US: Number of results, from 1 to 500. + form: form +extra: + python: + source: tools/recall.py diff --git a/clickhouse/loom/tools/remember.py b/clickhouse/loom/tools/remember.py new file mode 100644 index 000000000..d5c887449 --- /dev/null +++ b/clickhouse/loom/tools/remember.py @@ -0,0 +1,27 @@ +from collections.abc import Generator +from typing import Any + +from client import request, text, user +from dify_plugin import Tool +from dify_plugin.entities.tool import ToolInvokeMessage +from loom import LoomError + + +class RememberTool(Tool): + def _invoke(self, tool_parameters: dict[str, Any]) -> Generator[ToolInvokeMessage, None, None]: + user_id = user(tool_parameters) + try: + result = request( + self.runtime.credentials, + "memory.set", + { + "memory_key": text(tool_parameters, "memory_key"), + "value": text(tool_parameters, "value"), + }, + user_id=user_id, + ) + except (LoomError, TimeoutError): + raise ValueError( + "Loom request failed; check the provider connection and token grants" + ) from None + yield self.create_json_message(result) diff --git a/clickhouse/loom/tools/remember.yaml b/clickhouse/loom/tools/remember.yaml new file mode 100644 index 000000000..bf8fcd7fb --- /dev/null +++ b/clickhouse/loom/tools/remember.yaml @@ -0,0 +1,40 @@ +identity: + name: remember + author: clickhouse + label: + en_US: Remember +description: + human: + en_US: Save a fact for the configured end user in Loom. + llm: Save a fact for the configured end user in Loom. +parameters: + - name: user_id + type: string + required: true + label: + en_US: User ID + human_description: + en_US: Bind to the end-user identifier from your app. Do not let the model choose + it. + form: form + - name: memory_key + type: string + required: true + label: + en_US: Memory key + human_description: + en_US: Stable key for this fact. + llm_description: Stable key for this fact. + form: llm + - name: value + type: string + required: true + label: + en_US: Value + human_description: + en_US: The fact to remember. + llm_description: The fact to remember. + form: llm +extra: + python: + source: tools/remember.py diff --git a/clickhouse/loom/tools/search_knowledge.py b/clickhouse/loom/tools/search_knowledge.py new file mode 100644 index 000000000..cace8f484 --- /dev/null +++ b/clickhouse/loom/tools/search_knowledge.py @@ -0,0 +1,28 @@ +from collections.abc import Generator +from typing import Any + +from client import limit, request, text, user +from dify_plugin import Tool +from dify_plugin.entities.tool import ToolInvokeMessage +from loom import LoomError + + +class SearchKnowledgeTool(Tool): + def _invoke(self, tool_parameters: dict[str, Any]) -> Generator[ToolInvokeMessage, None, None]: + user_id = user(tool_parameters) + try: + result = request( + self.runtime.credentials, + "knowledge.search", + { + "query": text(tool_parameters, "query"), + "top_k": limit(tool_parameters, maximum=100), + "namespace_scope": "this", + }, + user_id=user_id, + ) + except (LoomError, TimeoutError): + raise ValueError( + "Loom request failed; check the provider connection and token grants" + ) from None + yield self.create_json_message(result) diff --git a/clickhouse/loom/tools/search_knowledge.yaml b/clickhouse/loom/tools/search_knowledge.yaml new file mode 100644 index 000000000..5666240d5 --- /dev/null +++ b/clickhouse/loom/tools/search_knowledge.yaml @@ -0,0 +1,42 @@ +identity: + name: search_knowledge + author: clickhouse + label: + en_US: Search knowledge +description: + human: + en_US: Search documents shared by this Loom namespace. + llm: Search documents shared by this Loom namespace. +parameters: + - name: user_id + type: string + required: true + label: + en_US: User ID + human_description: + en_US: Bind to the end-user identifier from your app. Do not let the model choose + it. + form: form + - name: query + type: string + required: true + label: + en_US: Query + human_description: + en_US: The text to search for. + llm_description: The text to search for. + form: llm + - name: top_k + type: number + required: false + default: 5 + min: 1 + max: 100 + label: + en_US: Result limit + human_description: + en_US: Number of results, from 1 to 100. + form: form +extra: + python: + source: tools/search_knowledge.py