Skip to content

docs: add Vaultak runtime security integration#516

Open
samueloladji-beep wants to merge 1 commit into
deepset-ai:mainfrom
samueloladji-beep:add-vaultak-v2
Open

docs: add Vaultak runtime security integration#516
samueloladji-beep wants to merge 1 commit into
deepset-ai:mainfrom
samueloladji-beep:add-vaultak-v2

Conversation

@samueloladji-beep

Copy link
Copy Markdown

Summary

Adds an integration page for haystack-vaultak, a runtime security package for Haystack pipelines.

The integration ships two @component classes:

  • VaultakSecurityChecker — inserted before the LLM/retriever; risk-scores every query on a 0–10 scale and raises RuntimeError if the score exceeds the configured threshold
  • VaultakPIIMasker — inserted after the LLM; scans replies for PII and masks before they reach users

Includes a full RAG pipeline example demonstrating both components working together.

Checklist

  • Package exists on PyPI: pip install haystack-vaultak
  • Source repo is public
  • No logo file included
  • All code examples use placeholder keys (YOUR_VAULTAK_API_KEY, YOUR_OPENAI_API_KEY)
  • RuntimeError used throughout (no custom exception classes)
  • Correct GitHub handle: samueloladji-beep
  • Correct Twitter handle: VaultakAI

Adds integration page for haystack-vaultak (https://pypi.org/project/haystack-vaultak/).
Ships two @component classes — VaultakSecurityChecker and VaultakPIIMasker — that
can be inserted into any Haystack 2.0 pipeline to risk-score inputs and mask PII
in LLM replies.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@samueloladji-beep samueloladji-beep requested a review from a team as a code owner June 14, 2026 20:44
@vercel

vercel Bot commented Jun 14, 2026

Copy link
Copy Markdown

@samueloladji-beep is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@bilgeyucel bilgeyucel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @samueloladji-beep! Left my comments

Comment thread integrations/vaultak.md
Comment on lines +123 to +124
pipeline.add_component("prompt_builder", PromptBuilder(template=prompt_template))
pipeline.add_component("llm", OpenAIGenerator())

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you replace these components with ChatPromptBuilder and OpenAIChatGenerator compoennts?

Comment thread integrations/vaultak.md
Comment on lines +59 to +68
from haystack_vaultak import VaultakSecurityChecker

checker = VaultakSecurityChecker(
api_key="YOUR_VAULTAK_API_KEY",
threshold=7.0,
verbose=True,
)

pipeline.add_component("security", checker)
pipeline.connect("security.query", "retriever.query")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code doesn't work. It misses the pipeline object. Also, when I initialize the VaultakSecurityChecker, I get "Vaultak.init() got an unexpected keyword argument 'agent_name'" error

Comment thread integrations/vaultak.md
Comment on lines +77 to +82
from haystack_vaultak import VaultakPIIMasker

masker = VaultakPIIMasker(api_key="YOUR_VAULTAK_API_KEY")

pipeline.add_component("pii_masker", masker)
pipeline.connect("llm.replies", "pii_masker.replies")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same error here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants