Skip to main content

Caching and replaying man-in-the-middle proxy for OpenAI APIs

Project description

Rechat

Rechat is a caching and replaying man-in-the-middle proxy for OpenAI's APIs, it provides inspection and debugging layer, particularly useful for quick inspection of interactions of existing clients, developing multi-request workflows, and benchmarks.

Rechat is for you, if you ever wanted to:

  • speed up your code that makes repeated calls to OpenAI APIs
  • quickly inspect what is being sent to OpenAI APIs
  • emulate an endpoint with pre-recorded (or pre-defined) responses

Quickstart

  1. pip install rechat (dev: pip install git+https://gitlab-master.nvidia.com/dchichkov/rechat.git)
  2. Run rechat, it will listen on eight-nine-ten port (http://localhost:8910/v1) and use OpenAI's endpoint by default as upstream.
  3. Configure your OpenAI client to use it export OPENAI_BASE_URL=http://localhost:8910/v1 and run your requests as usual.

You can specify a different upstream endpoint by providing it as an argument, e.g. rechat https://api.openai.com/v1.

By default, rechat outputs intercepted chat content onto the console:

Rechat Console

And it records the session to flows_<timestamp>.dump file in the current directory. During subsequent runs, if a -f/--flow [dump_file] argument is provided, rechat would attempt to load flows_[timestamp].dump files, or the specified dump file. It always tries to use cached responses for any matching requests.

Inspection and Debugging

Rechat provides http://localhost:8910 web UI for inspecting the current session, with search and filtering capabilities.

By default, rechat will output chat content to the console. Use --quiet flag to reduce verbosity. Use --verbose flag to include cache hits. Any markdown editor, for example VSCode or GitHub/GitLab web UI, can be used to view and edit the logs, and these modified logs can be loaded into rechat, to emulate model's responses.

Example

Example markdown snippet, in markdown format. Note <blockquote> tags. See more details in sample.md.

### user
<blockquote>
What is the capital of France?
</blockquote>

### assistant
<blockquote>
Paris.
</blockquote>

Intercepting traffic to existing OpenAI endpoints

Rechat can intercept traffic to existing endpoints, without changing the client code or configuring OPENAI_BASE_URL, by using mitmproxy as a transparent proxy. For example, to use mitmproxy local proxy mode and intercept traffic from a python script (for example python scripts/query.py), use the following command to intercept the traffic from python:

rechat --mode local:python

And run the python script as follows, specifying mitmproxy's CA certificate for SSL interception:

SSL_CERT_FILE=~/.mitmproxy/mitmproxy-ca-cert.pem python scripts/query.py

Note: SSL_CERT_FILE environment variable is required for Python clients to trust mitmproxy's root CA certificate. Please refer to mitmproxy's documentation for more details on installing and trusting mitmproxy's root CA certificate on your system.

Routing and Load Balancing

TODO: Rechat supports multiple endpoints, using <endpoint>:[local_port]:[model_name] arguments, e.g. https://api.openai.com/v1:8910:gpt-5. It would route the requests to the appropriate endpoint based on the model name in the request, and it'd balance the load between endpoints for the same model.

Miscellaneous

  • Replaying queries against an endpoint
  • Multiple responses for the same request

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

rechat-0.1.5.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

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

rechat-0.1.5-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file rechat-0.1.5.tar.gz.

File metadata

  • Download URL: rechat-0.1.5.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for rechat-0.1.5.tar.gz
Algorithm Hash digest
SHA256 383771247f18cea2361d76b1e792e0b131ecb0bc19ded7901bb38fbd4980edbb
MD5 dc5169610d78211ee2cb153485b65be7
BLAKE2b-256 23ef9a82f70c23696e17a861fb51009af5b8a7ddda17ecd340e7b30e22036a6c

See more details on using hashes here.

File details

Details for the file rechat-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: rechat-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for rechat-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 79296cdeb9e061074eeb8bd31ff858b3d44b018483befc764fa238ad8f4d4920
MD5 66feb6a8daab793acb8ce33d6ed58524
BLAKE2b-256 ffdf36b9b11c978d9a27f0f8c77f8fa757a27cc08adbbafc73160f0bf099782d

See more details on using hashes here.

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