Quickstart

Installation

To install Opaque Gateway, run:

pip install opaqueprompts

Environment setup

Accessing the Opaque Gateway API requires an API key, which you can get by either

Creating an account on the Opaque Gateway website. Once you have an account, you can find your API key on the API Key page.
Contacting us at hello@opaque.co.

Once you have your key, set it as an environment variable:

export OPAQUEPROMPTS_API_KEY="..."

For a custom or private deployment of Opaque Gateway, you can set the OPAQUEPROMPTS_SERVER_HOSTNAME environment variable to the domain (i.e., without the protocol, e.g. https) or IP address of the deployment.

export OPAQUEPROMPTS_SERVER_HOSTNAME="..."

Using Opaque Gateway standalone

Opaque Gateway offers two main functions: sanitize() and desanitize(). The sanitize() function takes a string and returns a sanitized (in other words, encrypted and redacted) version of it, while the desanitize() function takes a sanitized string and returns the original string.

Sanitization

import opaqueprompts

input_text_with_pii = "John Smith called 213-456-7098 (the phone number of his friend Sarah Jane) and asked her to meet him in San Francisco."
sanitized_response = opaqueprompts.sanitize(input_texts = [input_text_with_pii])

As shown below, sanitized_response contains both the sanitized_texts and secure_context fields, which must be passed to the followup call to desanitize().

> print(sanitized_response)
SanitizeResponse(sanitized_texts=['PERSON_2 called PHONE_NUMBER_1 (the phone number of his friend PERSON_1) and asked her to meet him in LOCATION_1.'], secure_context='eyJzZWNyZXRfZW50cm9weSI6IjRocWZxb1VBUmJueWNYeU5JRjROa3VzNjdkSnZtY1ZPVFhYcnlPWDdmNzAxNVR4NVUraTM5c3VGRTJqS3oySjUzMkM4ckF6L0cyME5sWGloZ2hicWhzcFF6N2pVTUZIVVNvMVRGam1UU2tTcG5pR1Bob0s5RUR3N3JQZ2VkMklJNEhRTHh2dVZNUnJlY2h3WVhGbGhZYzhFOEI1VFJkWVl2Sm1QUG5Rbkp3WT0iLCJlbnRpdHlfbWFwIjp7IkxPQ0FUSU9OXzEiOiJibFpDVE1oMTR0OW1FQmZsejk5cWVlWVJSTjdyUzhkUTZRRVZOZHlKNkEwPSIsIlBFUlNPTl8xIjoiZDZiR3VjOEJVNUdPcG56cDJoV1FaUUIyaUtvRzA2U3dCdGlkSXo5WGxaUT0iLCJQRVJTT05fMiI6IkpKSyt6cmhtTENzWGVkTHhoNWxhTWFFSzlUVmw1bU55MkNGR3FZekRmZ3M9IiwiUEhPTkVfTlVNQkVSXzEiOiJhQU9GVmhoT0tqczVzT0Iwczh2dnZwNTBsVk9XcnNyODE3eEVVSnkrTzdRPSJ9fQ==')

As you can see, the sanitized_texts field contains the initial message, but with the PII removed. The secure_context is just an opaque set of bytes, which should get passed to the desanitize call as shown below.

Desanitization

# Assume that sanitized_response.sanitized_text was passed into an LLM of your
# choice, and the final output is saved to 'llm_output" such that
# llm_output = "PERSON_1 and PERSON_2 will be meeting in LOCATION_1"
desanitized_response = opaqueprompts.desanitize(sanitized_text = llm_output, secure_context = sanitized_response.secure_context)

The desanitized_response contains only one field, desanitized_text, which contains the desanitized version of llm_output.

> print(desanitized_response)
DesanitizeResponse(desanitized_text='Sarah Jane and John Smith will be meeting in San Francisco')

Using Opaque Gateway with LangChain

Opaque Gateway offers a LangChain integration, enabling you to easily build privacy-preserving LLM applications. See the OpaquePrompts page in the LangChain documentation for more information.

Troubleshooting

Version mismatch

We may make breaking changes and drop support for old versions of the Python package. If this happens, you should see an error message like this when making a sanitize or desanitize call:

Request sent using package version 0.1.0, but minimum supported version is 0.2.0. Please update the opaqueprompts package to a supported version.

If you see this, simply upgrade opaqueprompts with pip install -U opaqueprompts and then you should be able to continue using the package without issue.

Missing version header

The logic to gracefully handle version mismatch was not added to the opaqueprompts package until version 0.1.0. As such, if you are using an older version of opaqueprompts, you may see the following error:

Client-Version header not set, please ensure this request was sent using opaqueprompts version >= 0.1.0

If you see this, make sure to update your opaqueprompts package to the latest version per the instructions in the previous section.