Skip to main content

Guardrails module for Ragbits components

Project description

Ragbits Guardrails

Ragbits Guardrails is a Python package that contains utilities for ensuring the safety and relevance of responses generated by Ragbits components.

Installation

You can install the latest version of Ragbits Guardrails using pip:

pip install ragbits-guardrails

Quickstart

Example of using the OpenAI Moderation Guardrail to verify a message:

import asyncio
from ragbits.guardrails.base import GuardrailManager, GuardrailVerificationResult
from ragbits.guardrails.openai_moderation import OpenAIModerationGuardrail


async def verify_message(message: str) -> list[GuardrailVerificationResult]:
    manager = GuardrailManager([OpenAIModerationGuardrail()])
    return await manager.verify(message)


if __name__ == '__main__':
    print(asyncio.run(verify_message("Test message")))

Documentation

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

ragbits_guardrails-0.20.0.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

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

ragbits_guardrails-0.20.0-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file ragbits_guardrails-0.20.0.tar.gz.

File metadata

  • Download URL: ragbits_guardrails-0.20.0.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for ragbits_guardrails-0.20.0.tar.gz
Algorithm Hash digest
SHA256 d8d872b8ea8f7587b479750bebb16204401b1aa0f1bb659627ee1b8597c4ae40
MD5 a5856e666f7230c0017331e33af29c41
BLAKE2b-256 5b809b5e568c9b7dd6de7e5afd350f4ed40e2f35746d7383365800e9fe05a52e

See more details on using hashes here.

File details

Details for the file ragbits_guardrails-0.20.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_guardrails-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 71cf9a06eab2d132356291620c3c395841c8edf4dae20ccf613a474f2791d0a1
MD5 d08b24dc9fc1fc434ef97c3e852e80b4
BLAKE2b-256 20e89d0445601ac17398ca672cd6e0edb8ffe0e27681a05f3a4b2c332d2c10dd

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