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.0a7.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.0a7-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: guardrails_ai_sdk-0.4.0a7.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for guardrails_ai_sdk-0.4.0a7.tar.gz
Algorithm Hash digest
SHA256 8d3cd88e2ee7e44b816cb682153ab0abf31d6b28d0adce9d8316a18ffd8ef92c
MD5 eeca33acedad28484f49c06e97a3d753
BLAKE2b-256 215cd77351fc60e94ae1d6b6ec6d533a11b98c1350161235970d5ec50cb3ff73

See more details on using hashes here.

Provenance

The following attestation bundles were made for guardrails_ai_sdk-0.4.0a7.tar.gz:

Publisher: sdk_py_publish.yml on guardrails-ai/guardrails-ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for guardrails_ai_sdk-0.4.0a7-py3-none-any.whl
Algorithm Hash digest
SHA256 541170183b34f860f6b58bcb22c157d70d710354119039ac3cd953aa456b3706
MD5 d968543aa1d9df48ccb818235e104684
BLAKE2b-256 681e95c2915cea5fabdb8486074d7bb2b63596ddf307656ac78cd6b02a903fea

See more details on using hashes here.

Provenance

The following attestation bundles were made for guardrails_ai_sdk-0.4.0a7-py3-none-any.whl:

Publisher: sdk_py_publish.yml on guardrails-ai/guardrails-ai

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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