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 000000000..7e5a4b33c Binary files /dev/null and b/clickhouse/loom/loom-0.1.0.difypkg differ diff --git a/clickhouse/loom/main.py b/clickhouse/loom/main.py new file mode 100644 index 000000000..35b5299da --- /dev/null +++ b/clickhouse/loom/main.py @@ -0,0 +1,4 @@ +from dify_plugin import DifyPluginEnv, Plugin + +if __name__ == "__main__": + Plugin(DifyPluginEnv(MAX_REQUEST_TIMEOUT=60)).run() diff --git a/clickhouse/loom/manifest.yaml b/clickhouse/loom/manifest.yaml new file mode 100644 index 000000000..ffe805c52 --- /dev/null +++ b/clickhouse/loom/manifest.yaml @@ -0,0 +1,33 @@ +version: 0.1.0 +type: plugin +author: clickhouse +name: loom +repo: https://github.com/ClickHouse/loom +contact: feedback@clickhouse.com +tags: + - agent + - search +label: + en_US: Loom +description: + en_US: Memory and document search in your Loom deployment. +icon: icon.svg +resource: + memory: 268435456 + permission: {} +plugins: + tools: + - provider/loom.yaml +meta: + version: 0.0.1 + arch: + - amd64 + - arm64 + runner: + language: python + version: "3.12" + entrypoint: main + minimum_dify_version: 1.0.0 +created_at: "2026-11-16T20:57:26Z" +privacy: PRIVACY.md +verified: false diff --git a/clickhouse/loom/provider/__init__.py b/clickhouse/loom/provider/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/clickhouse/loom/provider/loom.py b/clickhouse/loom/provider/loom.py new file mode 100644 index 000000000..c57400dd1 --- /dev/null +++ b/clickhouse/loom/provider/loom.py @@ -0,0 +1,16 @@ +from typing import Any + +from client import request +from dify_plugin import ToolProvider +from dify_plugin.errors.tool import ToolProviderCredentialValidationError +from loom import LoomError + + +class LoomProvider(ToolProvider): + def _validate_credentials(self, credentials: dict[str, Any]) -> 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