Skip to main content

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


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.0.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

guardrails_ai_sdk-0.4.0-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file guardrails_ai_sdk-0.4.0.tar.gz.

File metadata

  • Download URL: guardrails_ai_sdk-0.4.0.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for guardrails_ai_sdk-0.4.0.tar.gz
Algorithm Hash digest
SHA256 edfdf709edbc3239dd269ee36da3b374f2546c83a3fd5ab9dc022be9f72a71c5
MD5 5017fbdfe6c43306e92adc70cac70a3a
BLAKE2b-256 3baa22a36909598ce085b01f7c4b7689b9722a99269fa8b7c2eb42487f45eba9

See more details on using hashes here.

File details

Details for the file guardrails_ai_sdk-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for guardrails_ai_sdk-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 33b0b0edf6f0a099f9cdbecc9b1ec31a6f7a083277a90aa73c27f4a0c791960d
MD5 7d8f56fbed793f91bbdb27ceddb796b2
BLAKE2b-256 28bb68920f1df0e1087802cb98dcd88d796a7f8781b6ecdf5ccbe273002e549b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page