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.0.30.dev29302392.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file ragbits_guardrails-0.0.30.dev29302392.tar.gz.

File metadata

File hashes

Hashes for ragbits_guardrails-0.0.30.dev29302392.tar.gz
Algorithm Hash digest
SHA256 746bcf35683340112a77e53c873f7a1b2a792f2b79fb5abcbde43b6232a8270a
MD5 2d7500ce26934cbf96bfe04c9008f5e5
BLAKE2b-256 7d6282d4e1f6108b9fcc550d64dba5f8bd7b60718806ebd61b1b6eb979ffd517

See more details on using hashes here.

File details

Details for the file ragbits_guardrails-0.0.30.dev29302392-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_guardrails-0.0.30.dev29302392-py3-none-any.whl
Algorithm Hash digest
SHA256 adb46d538f3bd9fb1ca104ec6512a7c55067852609efb651189f10eb48bd8477
MD5 5aadff131a8b5127e3a7acc2c35006b8
BLAKE2b-256 8395d65afa61621433c870c7026a8fe34b304b0e1c4da7a4f4869bb5801e2404

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