import os
from phoenix.otel import register
# Add Phoenix API Key for tracing
PHOENIX_API_KEY = "ADD YOUR API KEY"
os.environ["PHOENIX_CLIENT_HEADERS"] = f"api_key={PHOENIX_API_KEY}"
os.environ["PHOENIX_COLLECTOR_ENDPOINT"] = "https://app.phoenix.arize.com"
# configure the Phoenix tracer
tracer_provider = register(
project_name="my-llm-app", # Default is 'default'
)
Your Phoenix API key can be found on the Keys section of your dashboard.
Launch your local Phoenix instance:
pip install arize-phoenix
phoenix serve
For details on customizing a local terminal deployment, see Terminal Setup.
Install packages:
pip install arize-phoenix-otel
Connect your application to your instance using:
from phoenix.otel import register
tracer_provider = register(
project_name="my-llm-app", # Default is 'default'
endpoint="http://localhost:6006/v1/traces",
)
docker run -p 6006:6006 arizephoenix/phoenix:latest
This will expose the Phoenix on localhost:6006
Install packages:
pip install arize-phoenix-otel
Connect your application to your instance using:
from phoenix.otel import register
tracer_provider = register(
project_name="my-llm-app", # Default is 'default'
endpoint="http://localhost:6006/v1/traces",
)
For more info on using Phoenix with Docker, see Docker
Install packages:
pip install arize-phoenix
Launch Phoenix:
import phoenix as px
px.launch_app()
Connect your notebook to Phoenix:
from phoenix.otel import register
tracer_provider = register(
project_name="my-llm-app", # Default is 'default'
)
By default, notebook instances do not have persistent storage, so your traces will disappear after the notebook is closed. See Persistence or use one of the other deployment options to retain traces.
Initialize the GuardrailsAIInstrumentor before your application code.
from openinference.instrumentation.guardrails import GuardrailsInstrumentor
GuardrailsInstrumentor().instrument(tracer_provider=tracer_provider)
Run Guardrails
From here, you can run Guardrails as normal:
from guardrails import Guard
from guardrails.hub import TwoWords
import openai
guard = Guard().use(
TwoWords(),
)
response = guard(
llm_api=openai.chat.completions.create,
prompt="What is another name for America?",
model="gpt-3.5-turbo",
max_tokens=1024,
)
print(response)
Observe
Now that you have tracing setup, all invocations of underlying models used by Guardrails (completions, chat completions, embeddings) will be streamed to your running Phoenix for observability and evaluation. Additionally, Guards will be present as a new span kind in Phoenix.
