Skip to main content

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


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.0a7.tar.gz (17.1 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_types-0.4.0a7-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for guardrails_ai_types-0.4.0a7.tar.gz
Algorithm Hash digest
SHA256 519294fdd2fdbf349615e51aa9c9b76e11345a2438af12af1a0274e31ce31382
MD5 fbc218f044f819d201d7fb570e1c1356
BLAKE2b-256 e7bae2e8a046f5dad28491e60f673b232255ae91511140c36999660c59c4b0a1

See more details on using hashes here.

Provenance

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

Publisher: types_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_types-0.4.0a7-py3-none-any.whl.

File metadata

File hashes

Hashes for guardrails_ai_types-0.4.0a7-py3-none-any.whl
Algorithm Hash digest
SHA256 9968dba16c15317cbe4332ecc0e8477144799ff33222e61e01e5a27cc2dcf08f
MD5 d1c9bcf1dc677784b8ff0e5af643b93f
BLAKE2b-256 e55832c68219ce16a622f8e12a41a40f7d2cc0d5687a39609ab0acd4539d8395

See more details on using hashes here.

Provenance

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

Publisher: types_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