OpenInference guardrails Instrumentation
Python auto-instrumentation library for LLM applications implemented with Guardrails
Guards are fully OpenTelemetry-compatible and can be sent to an OpenTelemetry collector for monitoring, such as Arize Phoenix or Arize AX.
Installation
pip install openinference-instrumentation-guardrails
Quickstart
This quickstart shows you how to instrument your guardrailed LLM application
Install required packages.
pip install openinference-instrumentation-guardrails guardrails-ai arize-phoenix opentelemetry-sdk opentelemetry-exporter-otlp
Start Phoenix in the background as a collector. By default, it listens on http://localhost:6006. You can visit the app via a browser at the same address. (Phoenix does not send data over the internet. It only operates locally on your machine.)
python -m phoenix.server.main serve
Install the TwoWords validator that's used in the Guard.
guardrails hub install hub://guardrails/two_words
Set up GuardrailsInstrumentor to trace your guardrails application and sends the traces to Phoenix at the endpoint defined below.
from openinference.instrumentation.guardrails import GuardrailsInstrumentor
from opentelemetry import trace as trace_api
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk import trace as trace_sdk
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
import os
os.environ["OPENAI_API_KEY"] = "YOUR_KEY_HERE"
endpoint = "http://127.0.0.1:6006/v1/traces"
tracer_provider = trace_sdk.TracerProvider()
tracer_provider.add_span_processor(SimpleSpanProcessor(OTLPSpanExporter(endpoint)))
trace_api.set_tracer_provider(tracer_provider)
GuardrailsInstrumentor().instrument()
Set up a simple example of LLM call using a Guard
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)
More Info
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file openinference_instrumentation_guardrails-0.1.16.tar.gz.
File metadata
- Download URL: openinference_instrumentation_guardrails-0.1.16.tar.gz
- Upload date:
- Size: 9.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
311c302f164862bc6a5825055c516e767e69d4740058a75e5ef9ec49e9919d7f
|
|
| MD5 |
c42f362d401d66fdbb760cdbd9dec908
|
|
| BLAKE2b-256 |
c08c42737e1bbe0e5b606e14dfff9eb184ca62e722cadbf6fb5f44199088e740
|
Provenance
The following attestation bundles were made for openinference_instrumentation_guardrails-0.1.16.tar.gz:
Publisher:
publish.yaml on Arize-ai/openinference
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
openinference_instrumentation_guardrails-0.1.16.tar.gz -
Subject digest:
311c302f164862bc6a5825055c516e767e69d4740058a75e5ef9ec49e9919d7f - Sigstore transparency entry: 2370803390
- Sigstore integration time:
-
Permalink:
Arize-ai/openinference@5b9114cdca81af4250531d4e4d8b8eecf7907192 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Arize-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@5b9114cdca81af4250531d4e4d8b8eecf7907192 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file openinference_instrumentation_guardrails-0.1.16-py3-none-any.whl.
File metadata
- Download URL: openinference_instrumentation_guardrails-0.1.16-py3-none-any.whl
- Upload date:
- Size: 11.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8b2c48fb08513d6a9a3be7a85d6d21d2f7ee7a08e64dea4bf51f2afd0317b18f
|
|
| MD5 |
8469a853433466d9264407695312c1c9
|
|
| BLAKE2b-256 |
9ed3e4b8e9425f8896ebda7d608bd3672ab1e795eb9e0649b3c430fd1fe80fda
|
Provenance
The following attestation bundles were made for openinference_instrumentation_guardrails-0.1.16-py3-none-any.whl:
Publisher:
publish.yaml on Arize-ai/openinference
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
openinference_instrumentation_guardrails-0.1.16-py3-none-any.whl -
Subject digest:
8b2c48fb08513d6a9a3be7a85d6d21d2f7ee7a08e64dea4bf51f2afd0317b18f - Sigstore transparency entry: 2370803478
- Sigstore integration time:
-
Permalink:
Arize-ai/openinference@5b9114cdca81af4250531d4e4d8b8eecf7907192 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Arize-ai
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yaml@5b9114cdca81af4250531d4e4d8b8eecf7907192 -
Trigger Event:
workflow_dispatch
-
Statement type:
