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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_guardrails-0.18.0.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.18.0.tar.gz
Algorithm Hash digest
SHA256 8dacb6dbadb88bfdb71be2fa59b6b730312caf65ef41c478bd2dc51ca84062f9
MD5 2cef4d3208b048fee300fb7303d99adc
BLAKE2b-256 46dc6345b4e87375cf919bcf9dad04e251a9234784adbecc060875a952088311

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_guardrails-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b51655080c9119a94a1feb73c7d8389f5215e7c26722612eb07c4a9241fabad
MD5 6b3c1f3383d348dfd292696ca0d35bac
BLAKE2b-256 4529f44f719be61fdb3353f2b83cf48422b11f20e59f555d48b5ef485ec6b73d

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