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.19.1.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.19.1-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_guardrails-0.19.1.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.19.1.tar.gz
Algorithm Hash digest
SHA256 e5a7983f39c372676d78c27a26d715ff8a89c523a8cf446d785105dfa335166d
MD5 beedd6ab407aff5ee052127b331895e6
BLAKE2b-256 aea6c92dfb899931dea70913dd871498a5d5e1aa2cb2f41fb43eae0b4a3066aa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_guardrails-0.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cc22372260d629e2bec350dee57b87a077297122130749acddf6a9eba6323d88
MD5 34c2c9735aec531e9e4cbe9b3ff42123
BLAKE2b-256 974113de41edf497c33f25097a073aef28192f3899c3fb7dfc8f3ec30850f5c6

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