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.6.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.6.0-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_guardrails-1.6.0.tar.gz
Algorithm Hash digest
SHA256 fa149fc35e7d0fb4f3c4cefb4553f32f35b49a18d7975ae8791dcde7ac9ddeef
MD5 e1e24970f7375ee9f2c218440c605549
BLAKE2b-256 997d0177655d44c00d1bb9a3a2bd1daf8e42ba29012841295c4b879b34dd9272

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_guardrails-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1cb7ebb8509681f4125d016aef2f783df285a27213410aba74a861567e6e396
MD5 2642f53fc0fc2426705c1affb7bfa711
BLAKE2b-256 1b6d6fb40c1dde955f4bfd4aa5e6d7ab428d4c7bc9cce4566580c6b552efc95d

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