radlab-llm-router-plugins 0.1.0__tar.gz

radlab_llm_router_plugins-0.1.0/.version

@@ -0,0 +1 @@
+0.1.0

radlab_llm_router_plugins-0.1.0/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 reasonable and customary use in 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 class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

radlab_llm_router_plugins-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+recursive-include llm_router_plugins/resources *.json
+
+include .version
+include requirements.txt

radlab_llm_router_plugins-0.1.0/PKG-INFO

@@ -0,0 +1,420 @@
+Metadata-Version: 2.4
+Name: radlab-llm-router-plugins
+Version: 0.1.0
+Summary: Plugins for the LLM Router (guardrails, maskers, etc.)
+Home-page: https://github.com/radlab-dev-group/llm-router-plugins
+Author: RadLab.dev Team
+Author-email: hello@radlab.dev
+License: Apache-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: radlab-pii-classification>=0.1.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+## Overview
+
+The **LLM‑Router** project ships with a modular plugin system that lets you plug‑in **anonymizers** (also called
+*maskers*) and **guardrails** into request‑processing pipelines.  
+Each plugin implements a tiny, well‑defined interface (`apply`) and can be composed in an ordered list to form a *
+*pipeline**. Pipelines are instantiated by the `MaskerPipeline` and `GuardrailPipeline` classes and are driven
+automatically by the endpoint logic in `endpoint_i.py`.
+
+---
+
+## 1. Anonymizers (Maskers)
+
+### 1.1 What they do
+
+* **Goal** – Remove or replace personally‑identifiable information (PII) from a payload before it reaches the LLM or an
+  external service.
+* **Typical strategy** – Run a pipeline of maskers that locate spans corresponding to IDs, emails, IPs, etc., and
+  replace each span with a placeholder such as `{{MASKED_ITEM}}`.
+
+### 1.2 Built‑in anonymizer plugins
+
+| Plugin                                         | Description                                                                                                                                       | Technical notes                                                                                                                                                            |
+|------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **FastMaskerPlugin** (`fast_masker_plugin.py`) | Thin wrapper around the `FastMasker` utility class. Receives a JSON‑compatible payload and returns the same payload with all detected PII masked. | Implements `PluginInterface`. The heavy lifting is delegated to `FastMasker.mask_payload(payload)`. No extra I/O; the `FastMasker` instance is created once in `__init__`. |
+
+### 1.3 How a masker is used
+
+1. The endpoint (e.g. `EndpointI._do_masking_if_needed`) checks the global flag `FORCE_MASKING`.
+2. If enabled, it creates a `MaskerPipeline` with the list of masker plugin identifiers (e.g. `["fast_masker"]`).
+3. The pipeline calls each plugin’s `apply` method sequentially, feeding the output of one as the input of the next.
+4. The final payload – now stripped of PII – proceeds to the rest of the request flow (guardrails, model dispatch,
+   etc.).
+
+---
+
+## 2. Guardrails
+
+### 2.1 What they do
+
+* **Goal** – Verify that a request (or its response) complies with policy rules (e.g. no hateful, illegal, or unsafe
+  content).
+* **Typical strategy** – Split the payload into manageable text chunks, run a pipeline of guardrails, aggregate
+  per‑chunk scores, and decide whether the overall request is safe.
+
+### 2.2 Built‑in guardrail plugins
+
+| Plugin                                             | Description                                                                                                                                                                                                                  | Technical notes                                                                                                                                                                                                                       |
+|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **NASKGuardPlugin** (`nask_guard_plugin.py`)       | HTTP‑based guardrail that forwards the payload to the external NASK guardrail service (`/nask_guard` endpoint) and returns a boolean *safe* flag together with the raw response.                                             | Inherits from `HttpPluginInterface`. The `apply` method calls `_request(payload)` (provided by the base class) and extracts `results["safe"]`. Errors are caught and logged; on failure the plugin returns `(False, {})`.             |
+| **SojkaGuardPlugin** (`sojka_guard_plugin.py`)     | HTTP‑based guardrail that forwards the payload to the **Sójka** guardrail service (`/sojka_guard` endpoint) and returns a safety flag.                                                                                       | Mirrors the design of `NASKGuardPlugin`. The `endpoint_url` is built from the `LLM_ROUTER_GUARDRAIL_SOJKA_GUARD_HOST` environment variable. On success it returns `(True, response)`, otherwise `(False, {})`.                        |
+| **(Implicit) GuardrailProcessor** (`processor.py`) | Core logic used by the internal NASK guardrail Flask route (`nask_guardrail`). Tokenises the payload, creates overlapping chunks, runs a Hugging‑Face `text‑classification` pipeline, and produces a detailed safety report. | Handles model loading (`AutoTokenizer`, `pipeline("text‑classification")`), chunking (`_chunk_text`), and scoring thresholds (`MIN_SCORE_FOR_SAFE`, `MIN_SCORE_FOR_NOT_SAFE`). Returns a dict: `{"safe": <bool>, "detailed": [...]}`. |
+
+### 2.3 How a guardrail is used
+
+1. The endpoint calls `_is_request_guardrail_safe(payload)` (or the analogous response guardrail).
+2. If `FORCE_GUARDRAIL_REQUEST` is true, a `GuardrailPipeline` is built from the configured plugin IDs (e.g.
+   `["nask_guard", "sojka_guard"]`).
+3. The pipeline iterates over each guardrail plugin; each `apply` returns `(is_safe, message)`.
+4. The first plugin that reports `is_safe=False` short‑circuits the pipeline and the request is rejected with a 400/500
+   error payload.
+
+---
+
+## 2.5 ML-Based PII Classification
+
+For cases where regex patterns alone are insufficient (e.g. context-dependent PII detection), the project integrates
+with the **anonymizer-model** repository:
+
+**Repository**: [radlab-dev-group/anonymizer-model](https://github.com/radlab-dev-group/anonymizer-model)
+
+| Feature               | Description                                                                                     |
+|-----------------------|-------------------------------------------------------------------------------------------------|
+| **Approach**          | NER (Named Entity Recognition) model based on Hugging Face `AutoModelForTokenClassification`    |
+| **What it does**      | Identifies PII entities in Polish text with context-aware detection (not just pattern matching) |
+| **Training pipeline** | Configurable via JSON, logs to W&B, exports best model (F1 macro) to `final_model/`             |
+| **REST API**          | Flask service supporting multiple model versions with optional dynamic quantization             |
+| **CLI**               | `pii-classifier convert` / `generalise` / `report` for data prep and analysis                   |
+| **Inference**         | Sub-token merging, punctuation cleaning, gap preservation for human-readable entity spans       |
+| **Web tester**        | HTML/JS interface for real-time PII detection testing                                           |
+
+### How it complements regex maskers
+
+| Approach                              | Strength                                                           | Best for                                                    |
+|---------------------------------------|--------------------------------------------------------------------|-------------------------------------------------------------|
+| **Regex maskers** (FastMasker)        | Deterministic, zero false negatives for known formats, fast        | Structured IDs (KRS, NIP, PESEL, NRB, REGON, VIN, etc.)     |
+| **PII classifier** (anonymizer-model) | Context-aware, handles unknown formats, generalizes across domains | Free-text entities, names, addresses, context-dependent PII |
+
+### Quick start
+
+```bash
+# Clone and install
+git clone https://github.com/radlab-dev-group/anonymizer-model.git
+cd anonymizer-model
+pip install .
+
+# Run the API (serves multiple model versions)
+python3 -m pii_classification.api.app
+
+# API endpoints
+#   GET  /models   — list available models + default
+#   POST /predict   — { "text": "...", "model": "optional_name" }
+```
+
+---
+
+## 2.6 Polish Identification Regex Patterns
+
+The **FastMaskerPlugin** ships with a comprehensive set of rules for detecting Polish business and personal identifiers.
+These rules use regex matching + checksum/form validation to minimize false positives.
+
+### Available Polish rules
+
+| Rule                | Placeholder        | Format                                            | Validation                                           |
+|---------------------|--------------------|---------------------------------------------------|------------------------------------------------------|
+| **KrsRule**         | `{{KRS}}`          | `1234567890` or `123-456-78-90` / `123 456 78 90` | 10 digits (format-only)                              |
+| **NrbRule**         | `{{NRB}}`          | `PL58105012981000009062923173` (26 digits)        | 26 digits                                            |
+| **NipRule**         | `{{NIP}}`          | `1234567890` or `123-456-78-90`                   | Checksum with weights `[6,5,7,2,3,4,5,6,7]` mod 11   |
+| **PeselRule**       | `{{PESEL}}`        | 11 digits                                         | Checksum with weights `[1,3,7,9,1,3,7,9,1,3]` mod 10 |
+| **RegonRule**       | `{{REGON}}`        | 9 or 14 digits                                    | Checksum (different weights per form)                |
+| **BankAccountRule** | `{{BANK_ACCOUNT}}` | `PL58 1050 1298 1000 0090 6292 3173`              | Polish IBAN (28 chars), supports masked `XX` groups  |
+
+### How they work
+
+Each rule follows the same pattern:
+
+1. **Regex match** — detects candidate strings (e.g. 10-digit sequences for KRS)
+2. **Checksum validation** — validates the candidate against the official algorithm
+3. **Placeholder replacement** — valid matches are replaced with `{{PLACEHOLDER}}`; invalid ones are left untouched
+4. **Optional anonymizer** — if an `anonymizer_fn` is provided, it's called with `(original, tag_type)` and its result (
+   wrapped in `{}`) is used instead
+
+### Adding rules to the pipeline
+
+To enable Polish rules in your masking pipeline, add their plugin IDs to `MASKING_STRATEGY_PIPELINE`:
+
+```python
+MASKING_STRATEGY_PIPELINE = ["fast_masker"]
+```
+
+All Polish rules are included in the FastMasker plugin by default. For a full list of available rules, see
+the [fast_masker README](llm_router_plugins/maskers/fast_masker/README.md).
+
+---
+
+## 2.7 Semantic Routing (Model Selection)
+
+Two routing plugins are available for model selection. Both activate when
+`payload["model"] == "auto"`.
+
+### 2.7.1 Simple Semantic Routing (Heuristic)
+
+The **Simple Semantic Routing plugin** (`simple_semantic_routing`) performs
+two-stage heuristic model selection: it classifies the user's intent
+(code, math, creative, general) via weighted keywords, multi-word phrases, and
+regex patterns, then estimates input complexity (token count) to pick the most
+appropriate model from a configured pool.
+
+No embedding model is required — routing is a fast, pure-text classification.
+
+**1. Intent scoring — each intent accumulates a score from three sources:**
+
+| Source       | How it works                                                                                                                                             |
+|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Keywords** | Each keyword from the JSON has an optional weight. If the keyword is found in the lower-cased input text the score increases by that weight (default 1). |
+| **Phrases**  | Multi-word expressions like `"write code:5"` or `"debug:2"`. If the phrase is found the score increases by the specified weight (default 2.0).           |
+| **Patterns** | Regex patterns — if a pattern matches the input each match adds **3.0** to the score.                                                                    |
+
+The intent with the **highest total score** wins. If no intent score exceeds zero, the intent is classified as `"none"`.
+
+**2. Complexity estimation — token count:**
+
+The plugin estimates the number of tokens using a simple word-count heuristic:
+
+```
+token_estimate = len(input_text.split()) × 1.25
+```
+
+This is compared against two thresholds from the config (`simple`, `medium`):
+
+| Tokens               | Complexity |
+|----------------------|------------|
+| ≤ `simple` threshold | `simple`   |
+| ≤ `medium` threshold | `medium`   |
+| > `medium` threshold | `complex`  |
+
+**3. Model selection:**
+
+The pool of models is a list defined in `default_models` (e.g. `["gpt-oss:120b", "qwen3.6:35b"]`). The complexity and
+intent together determine the index into this pool:
+
+- Complexity maps to a base index: `simple → 0` (first / smallest model), `medium → n // 2` (middle), `complex → n-1` (
+  last / largest).
+- Intent-adjustment from the config (e.g.
+  `{"code": "medium", "math": "medium", "creative": "simple", "general": "simple"}`) can **increase** the base index but
+  never decrease it.
+- The final index is clamped to `[0, n-1]` and the model at that index is selected.
+- If no text is found or the intent is `"none"` the `default_models["simple"]` model is used as fallback.
+
+Configuration is entirely JSON-driven in
+[simple_semantic.json](llm_router_plugins/resources/routing/simple_semantic.json)
+with intent definitions (keywords, phrases, patterns, weights) and two
+complexity thresholds (`simple` / `medium`).
+
+**Environment variable overrides:**
+
+| Env variable                               | Purpose                                        |
+|--------------------------------------------|------------------------------------------------|
+| `LLM_ROUTER_ROUTING_COMPLEXITY_THRESHOLDS` | Pipe-separated `simple                         |medium` token thresholds |
+| `LLM_ROUTER_ROUTING_MODELS`                | Pipe-separated model names for the pool        |
+| `LLM_ROUTER_ROUTING_DEFAULT_MODEL`         | Fallback model when no text or no intent match |
+| `LLM_ROUTER_ROUTING_INTENT_<name>`         | Override intent keywords (pipe-separated)      |
+
+### 2.7.2 Bi-Encoder Semantic Routing (Model Selection)
+
+The **Bi-Encoder routing plugin** (`semantic_biencoder_routing`) uses a neural embedding model
+(**radlab/semantic-euro-bert-encoder-v1**) to compute semantic embeddings for a set of pre-configured routing targets.
+Each target has a `name`, a `model_name` (the model to route to), a `description`, and a list of `examples`.
+At query time the user message is embedded and matched against all stored target embeddings using FAISS
+(`IndexFlatIP` on L2-normalised vectors = cosine similarity). The best-matching target determines the selected model.
+
+**1. Index building (on first load or when the persist directory is missing):**
+
+- For each target, its `description` and `examples` are combined into text.
+- The text is split into overlapping **token chunks** using a sliding window (`chunk_size` tokens, `chunk_overlap`
+  tokens overlap).
+- Each chunk is embedded via the BiEncoder model (e.g. `radlab/semantic-euro-bert-encoder-v1`).
+- All embedding vectors are **L2-normalised** to unit length.
+- Vectors are inserted into a `faiss.IndexFlatIP` index (inner product).
+- A docstore maps each FAISS doc ID to its target name (for reverse lookup).
+
+**2. Routing (query):**
+
+- The user message is embedded and L2-normalised.
+- FAISS performs a nearest-neighbor search returning the `top_k` closest chunks.
+- Scores are **aggregated per target**: the mean cosine similarity of all chunks belonging to the same target is
+  computed.
+- The target with the **highest mean similarity** wins and its `model_name` is returned.
+
+**3. Persistence:**
+
+The FAISS index and docstore are saved to disk (files `index.faiss` and `docstore.pkl`) under the configured persist
+directory.
+On subsequent starts the index is loaded from disk — embeddings are **not recomputed**.
+If the embedding model changes (different output dimension) the index is automatically rebuilt.
+
+Configuration is loaded from
+[semantic_biencoder.json](llm_router_plugins/resources/routing/semantic_biencoder.json). The embedding model, chunk
+size, overlap, and persist directory can all be overridden via environment variables:
+
+| Env variable                                          | Purpose                               |
+|-------------------------------------------------------|---------------------------------------|
+| `LLM_ROUTER_ROUTING_SEMANTIC_BIENCODER_MODEL`         | Override the embedding model name     |
+| `LLM_ROUTER_ROUTING_SEMANTIC_BIENCODER_TARGETS`       | Pipe-separated list of target names   |
+| `LLM_ROUTER_ROUTING_SEMANTIC_BIENCODER_CHUNK_SIZE`    | Override chunk size                   |
+| `LLM_ROUTER_ROUTING_SEMANTIC_BIENCODER_CHUNK_OVERLAP` | Override chunk overlap                |
+| `LLM_ROUTER_ROUTING_SEMANTIC_BIENCODER_PERSIST_DIR`   | Directory for FAISS index persistence |
+
+---
+
+## 3. Pipelines
+
+Both masker and guardrail pipelines share the same design pattern:
+
+| Class                                                     | Purpose                                                                            |
+|-----------------------------------------------------------|------------------------------------------------------------------------------------|
+| **MaskerPipeline** (`pipeline.py` – masker version)       | Executes a list of masker plugins in order, transforming the payload step‑by‑step. |
+| **GuardrailPipeline** (`pipeline.py` – guardrail version) | Executes guardrail plugins sequentially, stopping on the first failure.            |
+
+### 3.1 Registration
+
+* Plugins are registered lazily via `MaskerRegistry.register(name, logger)` or
+  `GuardrailRegistry.register(name, logger)`.
+* The registry maps a string identifier (e.g. `"fast_masker"`) to a concrete plugin class, allowing pipelines to resolve
+  the classes at runtime.
+
+### 3.2 Configuration
+
+All plugin identifiers are stored in environment variables or constants such as:
+
+```python
+MASKING_STRATEGY_PIPELINE = ["fast_masker"]
+GUARDRAIL_STRATEGY_PIPELINE_REQUEST = ["nask_guard", "sojka_guard"]
+```
+
+These lists are consumed by the endpoint initialization (`EndpointI._prepare_masker_pipeline`,
+`EndpointI._prepare_guardrails_pipeline`).
+
+---
+
+## 4. Adding a New Plugin
+
+1. **Create a subclass** of either `PluginInterface` (for maskers) or `HttpPluginInterface` / a custom guardrail base.
+2. **Define a `name` class attribute** – this is the identifier used in pipeline configuration.
+3. **Implement `apply(self, payload: Dict) -> Dict`** (masker) **or `apply(self, payload: Dict) -> Tuple[bool, Dict]`
+   ** (guardrail).
+4. **Register the plugin** – either automatically via the registry’s `register` call in the pipeline constructor, or
+   manually by calling `MaskerRegistry.register(name=MyPlugin.name, logger=logger)`.
+
+*Example stub for a new masker:*
+
+```python
+# my_custom_masker.py
+from llm_router_plugins.maskers.plugin_interface import PluginInterface
+import logging
+from typing import Dict, Optional
+
+
+class MyCustomMasker(PluginInterface):
+    name = "my_custom_masker"
+
+    def __init__(self, logger: Optional[logging.Logger] = None):
+        super().__init__(logger=logger)
+        # Load any heavy resources here (e.g., a spaCy model)
+
+    def apply(self, payload: Dict) -> Dict:
+        # Perform your masking logic and return the modified payload
+        return payload
+```
+
+After placing the file in `llm_router_plugins/maskers/plugins/`, enable it by adding `"my_custom_masker"` to
+`MASKING_STRATEGY_PIPELINE`.
+
+---
+
+## 5. Retrieval‑Augmented Generation (RAG) Support
+
+The project now includes a **LangChain‑based RAG plugin** that enables semantic search over user‑provided documents. The
+implementation lives in `llm_router_plugins/utils/rag/langchain_plugin.py` and is driven by the helper CLI scripts
+located in `scripts/`.
+
+### 5.1 What the plugin does
+
+| Feature           | Description                                                                                                                                                                                                                             |
+|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Indexing**      | Reads a directory of text‑like files (`.txt`, `.md`, `.html`, `.js`, …), splits them into token‑based windows, embeds each chunk with a configurable transformer model, and stores the vectors in a FAISS (or compatible) vector store. |
+| **Searching**     | Given a user query, retrieves the most similar chunks and injects them into the payload (e.g., appends to the last user message) so that downstream LLM calls can use the retrieved context.                                            |
+| **Configuration** | All parameters (collection name, embedder model, device, chunk size, overlap, persistence directory) are driven by environment variables prefixed with `LLM_ROUTER_`. See the table below for the full list.                            |
+| **CLI helpers**   | Two ready‑to‑use scripts: `scripts/llm-router-rag-langchain-index.sh` (indexes a repository) and `scripts/llm-router-rag-langchain-search.sh` (runs a search or starts an interactive REPL).                                            |
+
+### 5.2 Environment variables
+
+| Variable                                 | Default                                                                        | Meaning                                                     |
+|------------------------------------------|--------------------------------------------------------------------------------|-------------------------------------------------------------|
+| `LLM_ROUTER_LANGCHAIN_RAG_COLLECTION`    | *must be set*                                                                  | Name of the FAISS collection (e.g. `sample_collection`).    |
+| `LLM_ROUTER_LANGCHAIN_RAG_EMBEDDER`      | `/mnt/data2/llms/models/community/google/embeddinggemma-300m`                  | Path or Hugging‑Face identifier of the embedding model.     |
+| `LLM_ROUTER_LANGCHAIN_RAG_DEVICE`        | `cuda:2`                                                                       | Torch device (`cpu`, `cuda:0`, …).                          |
+| `LLM_ROUTER_LANGCHAIN_RAG_CHUNK_SIZE`    | `1024`                                                                         | Number of tokens per chunk.                                 |
+| `LLM_ROUTER_LANGCHAIN_RAG_CHUNK_OVERLAP` | `100`                                                                          | Number of overlapping tokens between consecutive chunks.    |
+| `LLM_ROUTER_LANGCHAIN_RAG_PERSIST_DIR`   | `./workdir/plugins/utils/rag/langchain/${LLM_ROUTER_LANGCHAIN_RAG_COLLECTION}` | Directory where the FAISS index and docstore are persisted. |
+
+#### Example export block (add to your shell profile or a `.env` file)
+
+```shell script
+export LLM_ROUTER_LANGCHAIN_RAG_COLLECTION="${LLM_ROUTER_LANGCHAIN_RAG_COLLECTION:-sample_collection}"
+export LLM_ROUTER_LANGCHAIN_RAG_EMBEDDER="${LLM_ROUTER_LANGCHAIN_RAG_EMBEDDER:-/mnt/data2/llms/models/community/google/embeddinggemma-300m}"
+export LLM_ROUTER_LANGCHAIN_RAG_DEVICE="${LLM_ROUTER_LANGCHAIN_RAG_DEVICE:-cuda:2}"
+export LLM_ROUTER_LANGCHAIN_RAG_CHUNK_SIZE="${LLM_ROUTER_LANGCHAIN_RAG_CHUNK_SIZE:-1024}"
+export LLM_ROUTER_LANGCHAIN_RAG_CHUNK_OVERLAP="${LLM_ROUTER_LANGCHAIN_RAG_CHUNK_OVERLAP:-100}"
+export LLM_ROUTER_LANGCHAIN_RAG_PERSIST_DIR="${LLM_ROUTER_LANGCHAIN_RAG_PERSIST_DIR:-./workdir/plugins/utils/rag/langchain/${LLM_ROUTER_LANGCHAIN_RAG_COLLECTION}}"
+```
+
+### 5.3 Using the CLI scripts
+
+**Index a repository** (example for the documentation site):
+
+```shell script
+scripts/llm-router-rag-langchain-index.sh
+# Internally runs:
+# llm-router-rag-langchain index --path "../.github/pages/llmrouter.cloud/" --ext .html .js .md
+```
+
+**Search** (interactive REPL):
+
+```shell script
+scripts/llm-router-rag-langchain-search.sh
+# Internally runs:
+# llm-router-rag-langchain search
+# (you will be prompted for a query, type “exit” to quit)
+```
+
+**One‑shot search**:
+
+```shell script
+llm-router-rag-langchain search --query "What is Retrieval‑Augmented Generation?" --top_n 5
+```
+
+The CLI returns the raw matching chunks together with similarity scores. The `LangchainRAGPlugin` automatically formats
+the retrieved text and appends it to the user’s last message, prefixed with:
+
+```
+If the context below will help answer the above question, use it.
+Context separated with double enter
+```