Offical Guardrails AI Types
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_types-0.4.0.tar.gz
(17.1 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_types-0.4.0.tar.gz.
File metadata
- Download URL: guardrails_ai_types-0.4.0.tar.gz
- Upload date:
- Size: 17.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
82bb9802c29c8a5cd85130abec3104cdf3f35c9b5d5d4b98bfaa9329b8080711
|
|
| MD5 |
cef2bacf40758ee517121c77e5fddba7
|
|
| BLAKE2b-256 |
d2c9f29c6dcf8f0c98618173ff9be834869b68190e7980915b3d76a369ef5f80
|
File details
Details for the file guardrails_ai_types-0.4.0-py3-none-any.whl.
File metadata
- Download URL: guardrails_ai_types-0.4.0-py3-none-any.whl
- Upload date:
- Size: 15.0 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 |
f9d218a01e23823d986837a91c38713fbd969d56a4eb2994fc732332e5a0fe3b
|
|
| MD5 |
14de842dd97222a863ad2374881b9b1c
|
|
| BLAKE2b-256 |
aa287efe998779eb353846835e4b56ffc96f8f2bb6ea968a16336d14fe9ef4b4
|