langchain/docs/docs/guides/privacy/presidio_data_anonymization/reversible.ipynb

{
   "cells": [
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "# Reversible data anonymization with Microsoft Presidio\n",
            "\n",
            "[![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/langchain-ai/langchain/blob/master/docs/docs/guides/privacy/presidio_data_anonymization/reversible.ipynb)\n",
            "\n",
            "\n",
            "## Use case\n",
            "\n",
            "We have already written about the importance of anonymizing sensitive data in the previous section. **Reversible Anonymization** is an equally essential technology while sharing information with language models, as it balances data protection with data usability. This technique involves masking sensitive personally identifiable information (PII), yet it can be reversed and original data can be restored when authorized users need it. Its main advantage lies in the fact that while it conceals individual identities to prevent misuse, it also allows the concealed data to be accurately unmasked should it be necessary for legal or compliance purposes. \n",
            "\n",
            "## Overview\n",
            "\n",
            "We implemented the `PresidioReversibleAnonymizer`, which consists of two parts:\n",
            "\n",
            "1. anonymization - it works the same way as `PresidioAnonymizer`, plus the object itself stores a mapping of made-up values to original ones, for example:\n",
            "```\n",
            "    {\n",
            "        \"PERSON\": {\n",
            "            \"<anonymized>\": \"<original>\",\n",
            "            \"John Doe\": \"Slim Shady\"\n",
            "        },\n",
            "        \"PHONE_NUMBER\": {\n",
            "            \"111-111-1111\": \"555-555-5555\"\n",
            "        }\n",
            "        ...\n",
            "    }\n",
            "```\n",
            "\n",
            "2. deanonymization - using the mapping described above, it matches fake data with original data and then substitutes it.\n",
            "\n",
            "Between anonymization and deanonymization user can perform different operations, for example, passing the output to LLM.\n",
            "\n",
            "## Quickstart\n",
            "\n"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 1,
         "metadata": {},
         "outputs": [],
         "source": [
            "# Install necessary packages\n",
            "# ! pip install langchain langchain-experimental openai presidio-analyzer presidio-anonymizer spacy Faker\n",
            "# ! python -m spacy download en_core_web_lg"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "`PresidioReversibleAnonymizer` is not significantly different from its predecessor (`PresidioAnonymizer`) in terms of anonymization:"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 2,
         "metadata": {},
         "outputs": [
            {
               "data": {
                  "text/plain": [
                     "'My name is Maria Lynch, call me at 7344131647 or email me at jamesmichael@example.com. By the way, my card number is: 4838637940262'"
                  ]
               },
               "execution_count": 2,
               "metadata": {},
               "output_type": "execute_result"
            }
         ],
         "source": [
            "from langchain_experimental.data_anonymizer import PresidioReversibleAnonymizer\n",
            "\n",
            "anonymizer = PresidioReversibleAnonymizer(\n",
            "    analyzed_fields=[\"PERSON\", \"PHONE_NUMBER\", \"EMAIL_ADDRESS\", \"CREDIT_CARD\"],\n",
            "    # Faker seed is used here to make sure the same fake data is generated for the test purposes\n",
            "    # In production, it is recommended to remove the faker_seed parameter (it will default to None)\n",
            "    faker_seed=42,\n",
            ")\n",
            "\n",
            "anonymizer.anonymize(\n",
            "    \"My name is Slim Shady, call me at 313-666-7440 or email me at real.slim.shady@gmail.com. \"\n",
            "    \"By the way, my card number is: 4916 0387 9536 0861\"\n",
            ")"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "This is what the full string we want to deanonymize looks like:"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 3,
         "metadata": {},
         "outputs": [
            {
               "name": "stdout",
               "output_type": "stream",
               "text": [
                  "Maria Lynch recently lost his wallet. \n",
                  "Inside is some cash and his credit card with the number 4838637940262. \n",
                  "If you would find it, please call at 7344131647 or write an email here: jamesmichael@example.com.\n",
                  "Maria Lynch would be very grateful!\n"
               ]
            }
         ],
         "source": [
            "# We know this data, as we set the faker_seed parameter\n",
            "fake_name = \"Maria Lynch\"\n",
            "fake_phone = \"7344131647\"\n",
            "fake_email = \"jamesmichael@example.com\"\n",
            "fake_credit_card = \"4838637940262\"\n",
            "\n",
            "anonymized_text = f\"\"\"{fake_name} recently lost his wallet. \n",
            "Inside is some cash and his credit card with the number {fake_credit_card}. \n",
            "If you would find it, please call at {fake_phone} or write an email here: {fake_email}.\n",
            "{fake_name} would be very grateful!\"\"\"\n",
            "\n",
            "print(anonymized_text)"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "And now, using the `deanonymize` method, we can reverse the process:"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 4,
         "metadata": {},
         "outputs": [
            {
               "name": "stdout",
               "output_type": "stream",
               "text": [
                  "Slim Shady recently lost his wallet. \n",
                  "Inside is some cash and his credit card with the number 4916 0387 9536 0861. \n",
                  "If you would find it, please call at 313-666-7440 or write an email here: real.slim.shady@gmail.com.\n",
                  "Slim Shady would be very grateful!\n"
               ]
            }
         ],
         "source": [
            "print(anonymizer.deanonymize(anonymized_text))"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "### Using with LangChain Expression Language\n",
            "\n",
            "With LCEL we can easily chain together anonymization and deanonymization with the rest of our application. This is an example of using the anonymization mechanism with a query to LLM (without deanonymization for now):"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 5,
         "metadata": {},
         "outputs": [],
         "source": [
            "text = f\"\"\"Slim Shady recently lost his wallet. \n",
            "Inside is some cash and his credit card with the number 4916 0387 9536 0861. \n",
            "If you would find it, please call at 313-666-7440 or write an email here: real.slim.shady@gmail.com.\"\"\""
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 6,
         "metadata": {},
         "outputs": [
            {
               "name": "stdout",
               "output_type": "stream",
               "text": [
                  "Dear Sir/Madam,\n",
                  "\n",
                  "We regret to inform you that Monique Turner has recently misplaced his wallet, which contains a sum of cash and his credit card with the number 213152056829866. \n",
                  "\n",
                  "If you happen to come across this wallet, kindly contact us at (770)908-7734x2835 or send an email to barbara25@example.net.\n",
                  "\n",
                  "Thank you for your cooperation.\n",
                  "\n",
                  "Sincerely,\n",
                  "[Your Name]\n"
               ]
            }
         ],
         "source": [
            "from langchain.prompts.prompt import PromptTemplate\n",
            "from langchain.chat_models import ChatOpenAI\n",
            "\n",
            "anonymizer = PresidioReversibleAnonymizer()\n",
            "\n",
            "template = \"\"\"Rewrite this text into an official, short email:\n",
            "\n",
            "{anonymized_text}\"\"\"\n",
            "prompt = PromptTemplate.from_template(template)\n",
            "llm = ChatOpenAI(temperature=0)\n",
            "\n",
            "chain = {\"anonymized_text\": anonymizer.anonymize} | prompt | llm\n",
            "response = chain.invoke(text)\n",
            "print(response.content)"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "Now, let's add **deanonymization step** to our sequence:"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 7,
         "metadata": {},
         "outputs": [
            {
               "name": "stdout",
               "output_type": "stream",
               "text": [
                  "Dear Sir/Madam,\n",
                  "\n",
                  "We regret to inform you that Slim Shady has recently misplaced his wallet, which contains a sum of cash and his credit card with the number 4916 0387 9536 0861. \n",
                  "\n",
                  "If you happen to come across this wallet, kindly contact us at 313-666-7440 or send an email to real.slim.shady@gmail.com.\n",
                  "\n",
                  "Thank you for your cooperation.\n",
                  "\n",
                  "Sincerely,\n",
                  "[Your Name]\n"
               ]
            }
         ],
         "source": [
            "chain = chain | (lambda ai_message: anonymizer.deanonymize(ai_message.content))\n",
            "response = chain.invoke(text)\n",
            "print(response)"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "Anonymized data was given to the model itself, and therefore it was protected from being leaked to the outside world. Then, the model's response was processed, and the factual value was replaced with the real one."
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "## Extra knowledge"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "`PresidioReversibleAnonymizer` stores the mapping of the fake values to the original values in the `deanonymizer_mapping` parameter, where key is fake PII and value is the original one: "
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 1,
         "metadata": {},
         "outputs": [
            {
               "data": {
                  "text/plain": [
                     "{'PERSON': {'Maria Lynch': 'Slim Shady'},\n",
                     " 'PHONE_NUMBER': {'7344131647': '313-666-7440'},\n",
                     " 'EMAIL_ADDRESS': {'jamesmichael@example.com': 'real.slim.shady@gmail.com'},\n",
                     " 'CREDIT_CARD': {'4838637940262': '4916 0387 9536 0861'}}"
                  ]
               },
               "execution_count": 1,
               "metadata": {},
               "output_type": "execute_result"
            }
         ],
         "source": [
            "from langchain_experimental.data_anonymizer import PresidioReversibleAnonymizer\n",
            "\n",
            "anonymizer = PresidioReversibleAnonymizer(\n",
            "    analyzed_fields=[\"PERSON\", \"PHONE_NUMBER\", \"EMAIL_ADDRESS\", \"CREDIT_CARD\"],\n",
            "    # Faker seed is used here to make sure the same fake data is generated for the test purposes\n",
            "    # In production, it is recommended to remove the faker_seed parameter (it will default to None)\n",
            "    faker_seed=42,\n",
            ")\n",
            "\n",
            "anonymizer.anonymize(\n",
            "    \"My name is Slim Shady, call me at 313-666-7440 or email me at real.slim.shady@gmail.com. \"\n",
            "    \"By the way, my card number is: 4916 0387 9536 0861\"\n",
            ")\n",
            "\n",
            "anonymizer.deanonymizer_mapping"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "Anonymizing more texts will result in new mapping entries:"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 2,
         "metadata": {},
         "outputs": [
            {
               "name": "stdout",
               "output_type": "stream",
               "text": [
                  "Do you have his VISA card number? Yep, it's 3537672423884966. I'm William Bowman by the way.\n"
               ]
            },
            {
               "data": {
                  "text/plain": [
                     "{'PERSON': {'Maria Lynch': 'Slim Shady', 'William Bowman': 'John Doe'},\n",
                     " 'PHONE_NUMBER': {'7344131647': '313-666-7440'},\n",
                     " 'EMAIL_ADDRESS': {'jamesmichael@example.com': 'real.slim.shady@gmail.com'},\n",
                     " 'CREDIT_CARD': {'4838637940262': '4916 0387 9536 0861',\n",
                     "  '3537672423884966': '4001 9192 5753 7193'}}"
                  ]
               },
               "execution_count": 2,
               "metadata": {},
               "output_type": "execute_result"
            }
         ],
         "source": [
            "print(\n",
            "    anonymizer.anonymize(\n",
            "        \"Do you have his VISA card number? Yep, it's 4001 9192 5753 7193. I'm John Doe by the way.\"\n",
            "    )\n",
            ")\n",
            "\n",
            "anonymizer.deanonymizer_mapping"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "Thanks to the built-in memory, entities that have already been detected and anonymised will take the same form in subsequent processed texts, so no duplicates will exist in the mapping:"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 3,
         "metadata": {},
         "outputs": [
            {
               "name": "stdout",
               "output_type": "stream",
               "text": [
                  "My VISA card number is 3537672423884966 and my name is William Bowman.\n"
               ]
            },
            {
               "data": {
                  "text/plain": [
                     "{'PERSON': {'Maria Lynch': 'Slim Shady', 'William Bowman': 'John Doe'},\n",
                     " 'PHONE_NUMBER': {'7344131647': '313-666-7440'},\n",
                     " 'EMAIL_ADDRESS': {'jamesmichael@example.com': 'real.slim.shady@gmail.com'},\n",
                     " 'CREDIT_CARD': {'4838637940262': '4916 0387 9536 0861',\n",
                     "  '3537672423884966': '4001 9192 5753 7193'}}"
                  ]
               },
               "execution_count": 10,
               "metadata": {},
               "output_type": "execute_result"
            }
         ],
         "source": [
            "print(\n",
            "    anonymizer.anonymize(\n",
            "        \"My VISA card number is 4001 9192 5753 7193 and my name is John Doe.\"\n",
            "    )\n",
            ")\n",
            "\n",
            "anonymizer.deanonymizer_mapping"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "We can save the mapping itself to a file for future use: "
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 11,
         "metadata": {},
         "outputs": [],
         "source": [
            "# We can save the deanonymizer mapping as a JSON or YAML file\n",
            "\n",
            "anonymizer.save_deanonymizer_mapping(\"deanonymizer_mapping.json\")\n",
            "# anonymizer.save_deanonymizer_mapping(\"deanonymizer_mapping.yaml\")"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "And then, load it in another `PresidioReversibleAnonymizer` instance:"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 4,
         "metadata": {},
         "outputs": [
            {
               "data": {
                  "text/plain": [
                     "{}"
                  ]
               },
               "execution_count": 4,
               "metadata": {},
               "output_type": "execute_result"
            }
         ],
         "source": [
            "anonymizer = PresidioReversibleAnonymizer()\n",
            "\n",
            "anonymizer.deanonymizer_mapping"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 5,
         "metadata": {},
         "outputs": [
            {
               "data": {
                  "text/plain": [
                     "{'PERSON': {'Maria Lynch': 'Slim Shady', 'William Bowman': 'John Doe'},\n",
                     " 'PHONE_NUMBER': {'7344131647': '313-666-7440'},\n",
                     " 'EMAIL_ADDRESS': {'jamesmichael@example.com': 'real.slim.shady@gmail.com'},\n",
                     " 'CREDIT_CARD': {'4838637940262': '4916 0387 9536 0861',\n",
                     "  '3537672423884966': '4001 9192 5753 7193'}}"
                  ]
               },
               "execution_count": 5,
               "metadata": {},
               "output_type": "execute_result"
            }
         ],
         "source": [
            "anonymizer.load_deanonymizer_mapping(\"deanonymizer_mapping.json\")\n",
            "\n",
            "anonymizer.deanonymizer_mapping"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "### Custom deanonymization strategy\n",
            "\n",
            "The default deanonymization strategy is to exactly match the substring in the text with the mapping entry. Due to the indeterminism of LLMs, it may be that the model will change the format of the private data slightly or make a typo, for example:\n",
            "- *Keanu Reeves* -> *Kaenu Reeves*\n",
            "- *John F. Kennedy* -> *John Kennedy*\n",
            "- *Main St, New York* -> *New York*\n",
            "\n",
            "It is therefore worth considering appropriate prompt engineering (have the model return PII in unchanged format) or trying to implement your replacing strategy. For example, you can use fuzzy matching - this will solve problems with typos and minor changes in the text. Some implementations of the swapping strategy can be found in the file `deanonymizer_matching_strategies.py`."
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 6,
         "metadata": {},
         "outputs": [
            {
               "name": "stdout",
               "output_type": "stream",
               "text": [
                  "maria lynch\n",
                  "Slim Shady\n"
               ]
            }
         ],
         "source": [
            "from langchain_experimental.data_anonymizer.deanonymizer_matching_strategies import (\n",
            "    case_insensitive_matching_strategy,\n",
            ")\n",
            "\n",
            "# Original name: Maria Lynch\n",
            "print(anonymizer.deanonymize(\"maria lynch\"))\n",
            "print(\n",
            "    anonymizer.deanonymize(\n",
            "        \"maria lynch\", deanonymizer_matching_strategy=case_insensitive_matching_strategy\n",
            "    )\n",
            ")"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 7,
         "metadata": {},
         "outputs": [
            {
               "name": "stdout",
               "output_type": "stream",
               "text": [
                  "Call Maria K. Lynch at 734-413-1647\n",
                  "Call Slim Shady at 313-666-7440\n"
               ]
            }
         ],
         "source": [
            "from langchain_experimental.data_anonymizer.deanonymizer_matching_strategies import (\n",
            "    fuzzy_matching_strategy,\n",
            ")\n",
            "\n",
            "# Original name: Maria Lynch\n",
            "# Original phone number: 7344131647 (without dashes)\n",
            "print(anonymizer.deanonymize(\"Call Maria K. Lynch at 734-413-1647\"))\n",
            "print(\n",
            "    anonymizer.deanonymize(\n",
            "        \"Call Maria K. Lynch at 734-413-1647\",\n",
            "        deanonymizer_matching_strategy=fuzzy_matching_strategy,\n",
            "    )\n",
            ")"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "It seems that the combined method works best:\n",
            "- first apply the exact match strategy\n",
            "- then match the rest using the fuzzy strategy"
         ]
      },
      {
         "cell_type": "code",
         "execution_count": 20,
         "metadata": {},
         "outputs": [
            {
               "name": "stdout",
               "output_type": "stream",
               "text": [
                  "Are you Slim Shady? I found your card with number 4916 0387 9536 0861.\n",
                  "Is this your phone number: 313-666-7440?\n",
                  "Is this your email address: wdavis@example.net\n"
               ]
            }
         ],
         "source": [
            "from langchain_experimental.data_anonymizer.deanonymizer_matching_strategies import (\n",
            "    combined_exact_fuzzy_matching_strategy,\n",
            ")\n",
            "\n",
            "# Changed some values for fuzzy match showcase:\n",
            "# - \"Maria Lynch\" -> \"Maria K. Lynch\"\n",
            "# - \"7344131647\" -> \"734-413-1647\"\n",
            "# - \"213186379402654\" -> \"2131 8637 9402 654\"\n",
            "print(\n",
            "    anonymizer.deanonymize(\n",
            "        (\n",
            "            \"Are you Maria F. Lynch? I found your card with number 4838 6379 40262.\\n\"\n",
            "            \"Is this your phone number: 734-413-1647?\\n\"\n",
            "            \"Is this your email address: wdavis@example.net\"\n",
            "        ),\n",
            "        deanonymizer_matching_strategy=combined_exact_fuzzy_matching_strategy,\n",
            "    )\n",
            ")"
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "Of course, there is no perfect method and it is worth experimenting and finding the one best suited to your use case."
         ]
      },
      {
         "cell_type": "markdown",
         "metadata": {},
         "source": [
            "## Future works\n",
            "\n",
            "- **better matching and substitution of fake values for real ones** - currently the strategy is based on matching full strings and then substituting them. Due to the indeterminism of language models, it may happen that the value in the answer is slightly changed (e.g. *John Doe* -> *John* or *Main St, New York* -> *New York*) and such a substitution is then no longer possible. Therefore, it is worth adjusting the matching for your needs."
         ]
      }
   ],
   "metadata": {
      "kernelspec": {
         "display_name": "Python 3 (ipykernel)",
         "language": "python",
         "name": "python3"
      },
      "language_info": {
         "codemirror_mode": {
            "name": "ipython",
            "version": 3
         },
         "file_extension": ".py",
         "mimetype": "text/x-python",
         "name": "python",
         "nbconvert_exporter": "python",
         "pygments_lexer": "ipython3",
         "version": "3.11.4"
      }
   },
   "nbformat": 4,
   "nbformat_minor": 4
}