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.8.dev23005.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.

ragbits_guardrails-0.0.8.dev23005-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file ragbits_guardrails-0.0.8.dev23005.tar.gz.

File metadata

File hashes

Hashes for ragbits_guardrails-0.0.8.dev23005.tar.gz
Algorithm Hash digest
SHA256 103d20a4e217ef751be739ccb0a964ed539db429922d507a1a2476144093cff9
MD5 6ea1c4d4fa8ecefa44a179d377f6853b
BLAKE2b-256 f869fa5eb2ed5c1956a6341da3298e33f17e2d02164f0ff4eecfa961ad29aefd

See more details on using hashes here.

File details

Details for the file ragbits_guardrails-0.0.8.dev23005-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_guardrails-0.0.8.dev23005-py3-none-any.whl
Algorithm Hash digest
SHA256 e06b85f9fef2d71277028cc0b3ecf662c2b7e0d926dfacf549eda71b829972be
MD5 f948e4459d5924c7533b8ce93271a74f
BLAKE2b-256 4b223e6a33e2ae90cc1fa67d287b70ddf9fbf83a6c7a9e6663c24bbd8b417b18

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