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.3.0.tar.gz (19.4 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.3.0-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: guardrails_ai_sdk-0.3.0.tar.gz
  • Upload date:
  • Size: 19.4 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.3.0.tar.gz
Algorithm Hash digest
SHA256 a59c4a741be03e9a3591e04265d5f64f84b647aa3958163f91fa72fc824e0f9b
MD5 17a7c6f40ebd429c5aa8f8cd5b241124
BLAKE2b-256 468e1f54c6f3b47e77aa91f23e1335edc6c8a687c3eaf4077bd32d945ec76d3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for guardrails_ai_sdk-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4b5611a976c7852a9b7483818511b24f20d98f62aca8eeeacc02028fdacc8f6
MD5 a505e7d248539e44f070519e2280cbbc
BLAKE2b-256 f518f79faa056d9afb7ae51dfde5be1fc9d0662621315ae98bd235c4192d1fdb

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