Guardrails - Future AGI Documentation

1. Installation

First install the traceAI package to access the observability framework

pip install traceAI-guardrails

2. Set Environment Variables

Set up your environment variables to authenticate with both FutureAGI and OpenAI.

import os

os.environ["OPENAI_API_KEY"] = "your-openai-api-key"
os.environ["FI_API_KEY"] = "your-futureagi-api-key"
os.environ["FI_SECRET_KEY"] = "your-futureagi-secret-key"

3. Initialize Trace Provider

Set up the trace provider to create a new project in FutureAGI, establish telemetry data pipelines .

from fi_instrumentation import register
from fi_instrumentation.fi_types import ProjectType

trace_provider = register(
    project_type=ProjectType.EXPERIMENT,
    project_name="openai_project",
)

4. Instrument your Project

Instrument your Project with OpenAI Agents Instrumentor. This step ensures that all interactions with the OpenAI are tracked and monitored.

from traceai_guardrails import GuardrailsInstrumentor

GuardrailsInstrumentor().instrument(tracer_provider=trace_provider)

5. Interact with OpenAI Agents

Interact with the OpenAI Agents as you normally would. Our Instrumentor will automatically trace and send the telemetry data to our platform.

from guardrails import Guard

guard = Guard()

result = guard(
    messages=[
            {
                "role": "user",
                "content": "Tell me about OpenAI",
            },
        ],
    model="gpt-4o"
)

print(f"{result}")