Offical Guardrails AI SDK
Project description
guardrails-client
A thin REST client for the guardrails-api.
Quickstart
pip install guardrails-ai-sdk
from guardrails_ai.sdk import GuardrailsAI, Guard, ValidationOutcome
# Init the GuardrailsAI client
client = GuardrailsAI(api_key="xxx")
# Fetch a Guard from the server
guard: Guard = await client.guards.retrieve(name="my-guard")
print(guard)
# Run a Guard to validate content
validation_outcome: ValidationOutcome = await client.guards.validate(name="my-guard", llm_output="Hello, world.")
if not validation_outcome.validation_passed:
print(validation_outcome.validation_summaries)
# Create Guarded Chat Completions
chat_completion = await client.guards.chat.completions.create(guard_name="my-guard", model="gpt-5-nano", messages=[{ "role": "user", "content": "Hello, world." }])
print(chat_completion.choices[0].message.content)
print(chat_completion.guardrails)
# Stream Guarded Chat Completions
completion_stream = await client.guards.chat.completions.create(
guard_name="my-first-guard",
model="gpt-5-nano",
messages=[
{"role": "user", "content": "Give yourself a realistic name and introduce yourself."}
],
stream=True
)
full_text = ""
validation_summaries = []
async for chunk in completion_stream:
full_text += chunk.choices[0].delta.content
validation_summaries.extend(chunk.guardrails.get("validation_summaries", []))
print("\n ==> Validation Summaries: ", validation_summaries)
print("\n ==> Final Content: ", full_text)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
guardrails_ai_sdk-0.4.0a0.tar.gz
(14.4 kB
view details)
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 guardrails_ai_sdk-0.4.0a0.tar.gz.
File metadata
- Download URL: guardrails_ai_sdk-0.4.0a0.tar.gz
- Upload date:
- Size: 14.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3b8bb47d355a5f9c2e18b3139155ab88b1ab4b36e141e85b6e97047bdfe8178c
|
|
| MD5 |
edf6685c775f115fa0ddad5ff2d8ac0a
|
|
| BLAKE2b-256 |
8db26ead42c1d0ce5c2de363ea2b662d2f18b1ea17c95c4888d31626a1768ffd
|
File details
Details for the file guardrails_ai_sdk-0.4.0a0-py3-none-any.whl.
File metadata
- Download URL: guardrails_ai_sdk-0.4.0a0-py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6fcc77ab995991d477bc6aa8454692a32a96103ed6d483e006dad0de3d1352fc
|
|
| MD5 |
0a4f8f2f1c570378ee6685705fc15401
|
|
| BLAKE2b-256 |
1673603df5e467fc8548d7ba5d52556c189e751b6d7a1986b00a9762298e12fa
|