Skip to main content

langchain-obscate

Keep personal data away from your LLM provider. You add one wrapper. User input, prompt variables and tool results are redacted before they reach the model, and the model's answer (including tool-call arguments) comes back with the real values restored.

It is a thin wrapper over the Obscate HTTP API. Detection runs in the API, not in this package. Full docs: obscate.com/docs/langchain.

your input ──redact──▶ LLM sees "seab.yomog@tziwxuo.com", "[PERSON:…]" ──restore──▶ your user sees "ravi.kumar@example.com", "Ravi Kumar"

Known limitation: partial values come back wrong

If the model quotes only part of a redacted value ("your card ending in 7588", "the email starting with…"), restore can't fix it: it matches whole tokens, and a fragment isn't one. With fpe this fails silently and plausibly. The fake card looks like a real card, so its last four digits look like real digits, and your user sees a confident, wrong statement about their own data. Assistants paraphrase values like this all the time, so expect it in normal use.

What we measured with real Claude (claude-haiku-5-5, a support-reply prompt, 3 runs each; a small test, not a guarantee):

setup replies stating wrong card digits
fpe, plain prompt 2 of 3
fpe + the instruction below in the system prompt 0 of 3
tokenize, plain prompt 0 of 3

For user-facing output where the model may paraphrase values:

  • Add to your system prompt: "When you mention a card number, email or phone number, repeat it exactly and in full as given. Never abbreviate, mask or quote part of it."
  • Or use strategy="tokenize": models treat [CREDIT_CARD_1] as a unit and don't split it, and restore only touches tokens in its map.

Partial references are a boundary of any reversible-redaction approach, not only ours: once the model only sees a stand-in, a fragment of the stand-in can never map back to a fragment of the original.

Quickstart (under 5 minutes)

pip install "langchain-obscate[examples]"
export OBSCATE_API_KEY=ob_...          # free: 1,000 requests/month at https://obscate.com, no card
export ANTHROPIC_API_KEY=sk-ant-...    # optional: without it the example uses a local stand-in LLM
python examples/quickstart.py

Output (real run with the stand-in LLM; the redacted values differ per key):

1) Your input:
   Customer Ravi Kumar (email ravi.kumar@example.com phone +91 98765 43210) says card 4242 4242 4242 4242 was charged twice. ...
2) What the LLM receives:
  [human] [PERSON:rug3juf…] (email seab.yomog@tziwxuo.com phone +91 45671 58378) says card 7982 1772 2838 5004 was charged twice. ...
3) Restored answer for your user:
   ... will confirm by email to ravi.kumar@example.com.

Use it

Any chat model, LLM or chain: wrap it with with_obscate.

from langchain_obscate import with_obscate

safe_llm = with_obscate(ChatAnthropic(model="claude-haiku-5-5"))
safe_llm.invoke("Draft a reply to ravi@example.com about order 1182")   # -> AIMessage, restored

chain = with_obscate(prompt | llm | StrOutputParser())                # prompt variables redacted
chain.invoke({"name": "Ravi Kumar", "email": "ravi@example.com"})     # -> str, restored

Agents (create_agent): add the middleware. It redacts every model call, covering user messages, tool results, earlier turns and the system prompt. It restores the model's reply before your tools run, so your tools receive real values and the provider never does.

pip install "langchain-obscate[agents]"

from langchain.agents import create_agent
from langchain_obscate import ObscateMiddleware

agent = create_agent("anthropic:claude-haiku-5-5", tools=[send_email],
                     middleware=[ObscateMiddleware()])

Explicit tools: use ObscateRedactTool (fpe-redacts a text) and ObscateDetectTool (labels and counts only). Use them when the agent itself should scrub a record before passing it downstream. The agent's own LLM still sees the tool input, so use the middleware to protect against the provider.

Why middleware rather than a callback

LangChain callbacks are observers. They are told what is sent to the model but cannot change it. Redaction has to rewrite the request, so it lives in a Runnable wrapper (chains) and in agent middleware (agents). The quickstart uses a callback only to show you what the provider receives.

Strategies

strategy LLM sees restore needs notes
fpe (default) seab.yomog@tziwxuo.com, 7982 1772 2838 5004, [PERSON:…] your API key only formats kept (valid-looking card numbers, emails). Values that can't keep their format fall back to bracketed [LABEL:…] tokens
tokenize [EMAIL_1], [PERSON_1] the token map (held in memory for one call) clearest for the model; consistent across all messages of one call
synthetic realistic fake names/emails the token map most natural prompts
mask / hash / partial ****, hashes, ****1234 not restorable output stays redacted

More: strategies.

with_obscate(llm, strategy="tokenize", labels=["EMAIL", "PHONE"], min_confidence=0.5)

What to expect

  • Detection quality. Structured IDs (email, phone, credit card, Aadhaar, PAN, GSTIN, IBAN, SSN, IP, AWS keys) are near-perfect because they use patterns and checksums. Names and places use an NER model and are best-effort, so some will get through. Use labels and test on your data. (Detectors, benchmark.)
  • fpe caveat. If the model invents a new email, phone or ID that was never redacted, fpe restore cannot tell it from a token and turns it into a different value. Use tokenize if your model makes up contact details.
  • Key versions are handled for you. Each redaction records the key_version of your account's key, and the wrapper sends it back on restore. A round trip keeps working even if Obscate rotates keys mid-call. If you keep a RestoreContext (or fpe output) to restore later, keep its key_version too.
  • Cost. One Obscate request per model call (the whole conversation goes in one request, 1 unit per 100 KB). Restores are free. A 5-step agent run uses 5 units, so the free tier covers about 200 such runs a month. (Pricing.)
  • Streaming is buffered. stream() on the wrapper yields one restored chunk at the end. With the agent middleware, stream_mode="messages" shows the raw, still-redacted tokens; the messages in agent state are restored.
  • Fails closed. If Obscate errors (network, quota, 503), the LLM is not called and ObscateError is raised.
  • Self-hosted. Set OBSCATE_BASE_URL to your instance. The self-hosted edition is in pilot; ask contact@obscate.com.

Privacy

This package never logs, prints or writes the text, the detected values or the token map. Token maps live in memory for one call and are hidden from repr(). Errors carry the HTTP status and the API's fixed message only. This is enforced by tests/test_langchain_obscate.py::test_privacy_*.

Develop

pip install -e '.[test]' && pytest -q    # unit tests against an in-process fake API (no network)

License: MIT.

Metadata

Release files for langchain-obscate 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for langchain-obscate 0.1.0
File Size Uploaded Provenance Actions
langchain_obscate-0.1.0.tar.gz 19.7 kB Without provenance Details for langchain_obscate-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for langchain-obscate 0.1.0
File Interpreter ABI Platform Actions
langchain_obscate-0.1.0-py3-none-any.whl Python 3 none any Details for langchain_obscate-0.1.0-py3-none-any.whl

Total release size: 36.6 kB

Release files / langchain_obscate-0.1.0.tar.gz

Download URL langchain_obscate-0.1.0.tar.gz
Size 19.7 kB
Tags Source
SHA-256 checksum
How to use checksums
3037a770b1eb0367be9f2c03aa2c8be22f45374e19e4fbc294cb391116840633
BLAKE2b-256 checksum
How to use checksums
bf4272de391800c86fcb1bafc4a8f1e6ecfbf9c5b4de595b680d7bc69197bb94
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Release files / langchain_obscate-0.1.0-py3-none-any.whl

Download URL langchain_obscate-0.1.0-py3-none-any.whl
Size 16.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2b55b9f53ed5389bf42fb02fe30ac93c9f1a806f5afa9abe6ee0c74d7931969e
BLAKE2b-256 checksum
How to use checksums
8dcb913aac3c206e764db74622a2d29efae53f7e569c616338d60e487248e237
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.15

Security for langchain-obscate 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page