guardrails-ai

📚 Documentation   •   🖥️ Application   •   🏠 Home

Getting started

• Sign up for an Autoblocks account at https://app.autoblocks.ai
• Grab your Autoblocks ingestion key from https://app.autoblocks.ai/settings/api-keys
• Grab your OpenAI API key from https://platform.openai.com/account/api-keys
• Create a file named .env in this folder and include the following environment variables:

OPENAI_API_KEY=<your-openai-api-key>
AUTOBLOCKS_INGESTION_KEY=<your-autoblocks-ingestion-key>

Setup

Install poetry

curl -sSL https://install.python-poetry.org | python3 -

Install Autoblocks CLI

See Autoblocks CLI documentation

Install dependencies

poetry install
poetry run guardrails hub install hub://guardrails/profanity_free

Run the script

poetry run start

View logs in Autoblocks

After you run the script, you will see a link to view the trace in your console. You can also navigate directly to the explore page to see the trace.

Run Autoblocks tests

Set your Autoblocks API key

Retrieve your local testing API key from the settings page and set it as an environment variable:

export AUTOBLOCKS_API_KEY=...

Run the test

npx autoblocks testing exec -m "My first run" -- poetry run test

View test in Autoblocks

After you run the tests, you will see a link to view the test in your console. You can also find all of your tests on the testing homepage in the Autoblocks application.

Futher Reading

• Autoblocks Testing documentation
• Autoblocks Evaluation documentation