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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_guardrails-0.20.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.20.1.tar.gz
Algorithm Hash digest
SHA256 a58e980106a6f5ad14fe0095c6a3297f10ca1bf087fb3990d14f65dee2cf4d64
MD5 fe7f7f693195885439c304dfb1e2add6
BLAKE2b-256 f46b2db9a0afbe499dfb898fe0dc02b2006379615b58e2ffe17c7b4554ba78af

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_guardrails-0.20.1-py3-none-any.whl
Algorithm Hash digest
SHA256 465b338a6bb01cbc5f0584bbc24f3ddb21d81f5e6bb2db76ea6461e8e4e2c314
MD5 53bb1b6ff0c9bd6d611a76b3de7ffb12
BLAKE2b-256 c350bfdefdc7493c133f452099e1aafdba4e5eb9ed0f7b783620f1e2e020edab

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