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-1.4.0.dev202602100304.tar.gz (4.0 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-1.4.0.dev202602100304.tar.gz.

File metadata

File hashes

Hashes for ragbits_guardrails-1.4.0.dev202602100304.tar.gz
Algorithm Hash digest
SHA256 0e3dd6e5ac495e1cc8d0c7a851bb45db726b0cdff387b6e1d00c74253b267952
MD5 a9d685fdaa0ba61286eb63918524af7d
BLAKE2b-256 898b8a1c390ba753290b996923a9e3ad218bde7295ab7f8b385d73a6182210b4

See more details on using hashes here.

File details

Details for the file ragbits_guardrails-1.4.0.dev202602100304-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_guardrails-1.4.0.dev202602100304-py3-none-any.whl
Algorithm Hash digest
SHA256 9d77ab2df8ff96a345ea623bdcafab2fa5f6b8c32d51770dbcd4113c554b50e9
MD5 8950b1c5433ec4fe710c4a4c00c01f8f
BLAKE2b-256 c6d094ab660a627754c2a3c56a1fb09a8fa0cd3f7317e63fbf4260b52508ac0f

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