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

This version

1.0.0

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.0.0.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.

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_guardrails-1.0.0.tar.gz
Algorithm Hash digest
SHA256 7a8692d5f2e7718e52655a3f65cdb7b5975d512bcc7375fc02251fb24c5929b1
MD5 409419a1aebd1fe860d51f9bdaa3f5dd
BLAKE2b-256 f9aa7cad139559742eef6695ac6bb1d6d3556660e64217e4b161030b03884991

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_guardrails-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f1380c2f66b0ab792ce599a8c42984b4d90569b0135220298c2485cc846b666
MD5 13fff91d350f0db079652828a6fbb5fb
BLAKE2b-256 ffc691d4fd1d6d1013aa230d721ea4fc401a2ca526df5904f198d35724755cab

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