Skip to main content

LangChain integration for Tonic Textual PII redaction

Project description

langchain-textual

PyPI version CI License: MIT Python 3.10+

PII redaction tools for LangChain, powered by Tonic Textual.

Strip names, emails, addresses, and other sensitive data from text, JSON, HTML, and files before they hit your LLM — or on the way back out. Drop them into any LangChain chain or agent as standard tools.

Installation

pip install langchain-textual

Quick start

export TONIC_TEXTUAL_API_KEY="your-api-key"
from langchain_textual import TonicTextualRedactText

tool = TonicTextualRedactText()
tool.invoke("My name is John Smith and my email is john@example.com.")
# "My name is [NAME_GIVEN_xxxx] [NAME_FAMILY_xxxx] and my email is [EMAIL_ADDRESS_xxxx]."

Tools

Tool Input Use for
TonicTextualRedactText Plain text string Raw text, .txt file contents
TonicTextualRedactJson JSON string Raw JSON, .json file contents
TonicTextualRedactHtml HTML string Raw HTML, .html/.htm file contents
TonicTextualRedactFile File path PDFs, images (JPG, PNG), CSVs, TSVs
TonicTextualPiiTypes None List all supported PII entity types

Text

from langchain_textual import TonicTextualRedactText

tool = TonicTextualRedactText()
tool.invoke("My name is John Smith and my email is john@example.com.")
# "My name is [NAME_GIVEN_xxxx] [NAME_FAMILY_xxxx] and my email is [EMAIL_ADDRESS_xxxx]."

JSON

from langchain_textual import TonicTextualRedactJson

tool = TonicTextualRedactJson()
tool.invoke('{"name": "John Smith", "email": "john@example.com"}')
# '{"name": "[NAME_GIVEN_xxxx] [NAME_FAMILY_xxxx]", "email": "[EMAIL_ADDRESS_xxxx]"}'

HTML

from langchain_textual import TonicTextualRedactHtml

tool = TonicTextualRedactHtml()
tool.invoke("<p>Contact John Smith at john@example.com</p>")
# "<p>Contact [NAME_GIVEN_xxxx] [NAME_FAMILY_xxxx] at [EMAIL_ADDRESS_xxxx]</p>"

Files

from langchain_textual import TonicTextualRedactFile

tool = TonicTextualRedactFile()
tool.invoke({"file_path": "/path/to/scan.pdf"})
# "/path/to/scan_redacted.pdf"

tool.invoke({"file_path": "/path/to/photo.jpg", "output_path": "/tmp/redacted.jpg"})
# "/tmp/redacted.jpg"

For .txt, .json, and .html/.htm files, read the file contents and pass them to the corresponding text, JSON, or HTML tool instead.

Configuration

All tools share the same configuration options.

Synthesis mode — replace PII with realistic fake data instead of placeholders:

tool = TonicTextualRedactText(generator_default="Synthesis")
tool.invoke("Contact Jane Doe at jane.doe@example.com.")
# "Contact Maria Chen at maria.chen@gmail.com."

Per-entity control — set handling per PII type with generator_config:

tool = TonicTextualRedactText(
    generator_default="Off",
    generator_config={
        "NAME_GIVEN": "Synthesis",
        "NAME_FAMILY": "Synthesis",
        "EMAIL_ADDRESS": "Redaction",
    },
)
tool.invoke("Contact Jane Doe at jane.doe@example.com.")
# "Contact Maria Chen at chen@[EMAIL_ADDRESS_xxxx]."

Use TonicTextualPiiTypes to list all supported entity type names:

from langchain_textual import TonicTextualPiiTypes

TonicTextualPiiTypes().invoke("")
# "NUMERIC_VALUE, LANGUAGE, MONEY, ..., EMAIL_ADDRESS, NAME_GIVEN, NAME_FAMILY, ..."

Self-hosted deployment:

tool = TonicTextualRedactText(tonic_textual_base_url="https://textual.your-company.com")

Explicit API key (instead of env var):

tool = TonicTextualRedactText(tonic_textual_api_key="your-api-key")

Using with a LangChain agent

Every tool in this package is a standard LangChain tool, so they work anywhere tools do. Give your agent whichever combination it needs:

from langchain_textual import (
    TonicTextualRedactText,
    TonicTextualRedactJson,
    TonicTextualRedactFile,
)
from langchain_openai import ChatOpenAI
from langgraph.prebuilt import create_react_agent

llm = ChatOpenAI(model="gpt-4o-mini")
tools = [TonicTextualRedactText(), TonicTextualRedactJson(), TonicTextualRedactFile()]
agent = create_react_agent(llm, tools)

Development

# install dependencies
uv sync --group dev --group test --group lint --group typing

# install pre-commit hooks (auto-runs ruff on each commit)
uv tool install pre-commit
pre-commit install

# run unit tests
make test

# run integration tests (requires TONIC_TEXTUAL_API_KEY)
make integration_tests

# lint & format (run from the project root)
make lint
make format

Note: All make commands must be run from the project root (langchain-textual/), not from subdirectories like examples/.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

langchain_textual-1.0.0.tar.gz (345.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langchain_textual-1.0.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file langchain_textual-1.0.0.tar.gz.

File metadata

  • Download URL: langchain_textual-1.0.0.tar.gz
  • Upload date:
  • Size: 345.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for langchain_textual-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f44a2f559035dbb616d01599bb7d04cfa2c29d2555f660de35a437910fbe608d
MD5 b318b2275587813d636f286bc2400238
BLAKE2b-256 df90cc0dfba84353468cfef83f754a67bac1d70907c6c8e760ac8ef36906deb0

See more details on using hashes here.

Provenance

The following attestation bundles were made for langchain_textual-1.0.0.tar.gz:

Publisher: publish.yml on TonicAI/langchain-textual

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file langchain_textual-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for langchain_textual-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2dd8fc8b400b76902b5a333b41c333b853bffd19eb3bfbaef32ca9bda85977a6
MD5 e933ba946f6dc877e3fdbe6850252de8
BLAKE2b-256 cbd5028d7960e25c8b7191982e9fd242290b5fde1eea4ff8cb7703cf46f2289a

See more details on using hashes here.

Provenance

The following attestation bundles were made for langchain_textual-1.0.0-py3-none-any.whl:

Publisher: publish.yml on TonicAI/langchain-textual

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page