root-signals 1.3.3

The Python SDK for API of Root Signals

Control and Measurement for LLM automations

Documentation | Join Discord | Login | Get a temporary API key

Root Signals SDK streamlines the evaluation of your LLM pipelines, to yield insights about their effectiveness. While many tools exist for building the pipelines themselves, quantifying their performance can be challenging.

Root Signals addresses this gap with carefully crafted universal evaluators based on cutting edge LLM research, as well as a framework for systematically adding your own.

Easily integrate with your CI/CD process for continuous monitoring to ensure the performance stays within acceptable limits.

Install

pip install root-signals

Quickstart

Before you begin, you'll need to set up your API key. You can either:

1. Set it as an environment variable ROOTSIGNALS_API_KEY
2. Add it to a local .env file

Get your API key from:

• Sign up at Root Signals app and create a key in settings
• Or create a temporary key

Example setup:

# Option 1: Environment variable
export ROOTSIGNALS_API_KEY=your-Root-API-key

# Option 2: .env file
echo ROOTSIGNALS_API_KEY=your-Root-API-key >> .env

Run a Root evaluator

from root import RootSignals

# Connect to the Root Signals API
client = RootSignals()

# Run a politeness evaluator
response = client.evaluators.Politeness(
    response="You can find the instructions from our Careers page."
)
print(response)
# {score=0.7, justification='The response is st...', execution_log_id=...}

Check the full list of Root evaluators from the Root evaluators documentation. You can also add your own evaluators.

Documentation

For more details, please see the main SDK documentation.

Community

Check out our discord server. It's a good place to ask questions, get help, and discuss ideas.