ProxDash Connection

ProxDash(proxai.co/dashboard) is a platform for AI developers to manage their API keys and monitor their usage. Check the advantages of using ProxDash in the Overview, Pricing, and Resources page.

Connecting to ProxDash

Generate an API key at proxai.co/dashboard/api-keys and add it to your environment variables.

~/.zshrc, ~/.bashrc etc. files:

export PROXDASH_API_KEY="<your-api-key>";

After adding the API key, you need to restart your terminal or run:

source ~/.zshrc;

This will enable ProxDash to monitor your API calls.

For Google Colab, check the Google Colab Example page.

Tracking ProxDash Connection

By default, ProxDash will monitor all your API calls after adding the API key. You can track ProxDash connection health in two different ways.

Verbose Connection Info (Recommended)

You can get verbose ProxDash connection info by adding following option to your px.connect() call:

px.connect(
    proxdash_options=px.ProxdashOptions(stdout=True))

This will print ProxDash connection info to the console.

ProxDash Logs

You can also track ProxDash connection health in the ProxDash logs.

px.connect(logging_path='~/proxai-logs')

This generates a ~/proxai-logs/proxdash.log file with all relevant logs. Check the Logs Management page for more details.

px.connect(
    proxdash_options=px.ProxdashOptions(
        hide_sensitive_content=True))

This will block the system, messages, prompt, and response fields from being sent to ProxDash.

ProxDash Options

ProxDash options are available in px.ProxdashOptions().

px.connect(
    proxdash_options=px.ProxdashOptions(
        stdout=True,
        hide_sensitive_content=True))

px.connect(
    proxdash_options=px.ProxdashOptions(
        disable_proxdash=True))

Proxdash Options Parameters

px.types.ProxdashOptions() or px.ProxdashOptions() for simplicity:

Option	Type	Default Value	Description
`stdout`	`Optional[bool]`	`False`	If `True`, ProxDash connection logs are printed to the stdout.
`hide_sensitive_content`	`Optional[bool]`	`False`	If `True`, sensitive content are not sent to ProxDash. Following fields are removed from logging record before sending to ProxDash: • `system` • `messages` • `prompt` • `response`
`disable_proxdash`	`Optional[bool]`	`False`	If `True`, ProxDash connection is disabled regardless of whether `PROXDASH_API_KEY` exists in the environment variables.
`api_key`	`Optional[str]`	`None`	If provided, this API key is used to send logs to ProxDash. Otherwise, `PROXDASH_API_KEY` environment variable is used.
`base_url`	`Optional[str]`	`None`	This option is used for changing/testing with different servers instead of the default ProxDash server.

Privacy

ProxDash offers different levels of privacy on the API key generation page. Check details on the ProxDash API Keys page.

Normally, ProxDash respects the privacy level you set on the API key generation page. However, you still have control over the fields you want to send to ProxDash in case:

API key has the permission but you don’t want to send some fields to ProxDash anyway.
API key doesn’t have the permission and you want to ensure to block the fields rather relying on the ProxDash permission level.

To do this, you can use the hide_sensitive_content option in the proxdash_options parameter.

Cache System Strict Feature Test