docs: add Vaultak runtime security integration for Haystack#487
Closed
samueloladji-beep wants to merge 1 commit into
Closed
docs: add Vaultak runtime security integration for Haystack#487samueloladji-beep wants to merge 1 commit into
samueloladji-beep wants to merge 1 commit into
Conversation
Adds integrations/vaultak.md with two Haystack @component classes: - VaultakSecurityChecker: inserted before the retriever/LLM to risk-score queries (0–10) and check policy; raises RuntimeError to halt the pipeline if the score exceeds the threshold - VaultakPIIMasker: inserted after the LLM generator to scan and redact PII from replies before they reach users Includes a full RAG pipeline example wiring both components around InMemoryBM25Retriever + PromptBuilder + OpenAIGenerator. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Author
|
@TuanaCelik @bilgeyucel @anakin87 — ready for review. This adds a Vaultak runtime security integration page with |
Contributor
There was a problem hiding this comment.
Pull request overview
- Adds a new Haystack integrations documentation page for Vaultak, describing two
@componentclasses for runtime query screening and PII masking, plus a full RAG pipeline example.
Changes:
- Introduces
integrations/vaultak.mdwith installation + usage docs forVaultakSecurityCheckerandVaultakPIIMasker. - Includes code examples for both components and a full pipeline wiring example.
- Adds a License section and includes it in the page ToC.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| | Component | Position in pipeline | What it does | | ||
| |---|---|---| | ||
| | `VaultakSecurityChecker` | Before the LLM / retriever | Risk-scores the input; raises `BlockedByVaultak` if above threshold; checks against policy rules | |
|
|
||
| Insert `VaultakSecurityChecker` before your retriever or LLM to intercept and score every user | ||
| query before it enters your pipeline. Queries whose risk score exceeds your threshold raise a | ||
| `BlockedByVaultak` exception so the pipeline halts cleanly. |
Comment on lines
+137
to
+138
| os.environ["OPENAI_API_KEY"] = "sk-..." | ||
| VAULTAK_API_KEY = "vtk_..." |
Member
kacperlukawski
left a comment
kacperlukawski
left a comment
There was a problem hiding this comment.
All the links in the frontmatter do not exist. I'm closing the PR, as the integration does seem to be hallucinated. @samueloladji-beep, feel free to open another one once it's all fixed.
| github: vaultak | ||
| twitter: vaultak_ai | ||
| linkedin: https://www.linkedin.com/company/vaultak/ | ||
| pypi: https://pypi.org/project/haystack-vaultak/ |
| twitter: vaultak_ai | ||
| linkedin: https://www.linkedin.com/company/vaultak/ | ||
| pypi: https://pypi.org/project/haystack-vaultak/ | ||
| repo: https://github.com/vaultak/haystack-vaultak |
Member
There was a problem hiding this comment.
Repository does not exist
| repo: https://github.com/vaultak/haystack-vaultak | ||
| type: Monitoring Tool | ||
| report_issue: https://github.com/vaultak/haystack-vaultak/issues | ||
| logo: /logos/vaultak.png |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new integration page for Vaultak — a runtime security platform that wraps Haystack pipelines with real-time input screening and PII masking via two custom
@componentclasses.Install:
pip install haystack-vaultakChanges
integrations/vaultak.md(new) — covers:VaultakSecurityChecker: a@componentinserted before the retriever/LLM that risk-scores every query (0–10) via the Vaultak SDK and raisesRuntimeErrorto halt the pipeline if the score exceeds the configured threshold; also runs a policy check on the inputVaultakPIIMasker: a@componentinserted after the LLM generator that scans all replies for PII (names, emails, phone numbers, etc.) and masks them before they reach usersInMemoryBM25Retriever→PromptBuilder→OpenAIGeneratorTest plan
@componentcontract (output_types,runmethod)🤖 Generated with Claude Code