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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_guardrails-0.17.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.17.0.tar.gz
Algorithm Hash digest
SHA256 0b79320c244de279ec4b351a5ff25f8eeaca28f5c10d968c16b595bca16692ba
MD5 06523484b3c8b08d3c1bc8f93f083b26
BLAKE2b-256 bb2d58d5a0bd9a3a19140ee843412ad7cbe92f8539bae0a2d9357f5d01cfe623

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_guardrails-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 437abd85b20a77de473d30a502958e11521be663f38b57990aa8077530530719
MD5 fcf6c8f1286b017712c5a9d929fba137
BLAKE2b-256 6b9bda3e9567ec2729b1aac515b1363ff5712a1bac1751bee9445451cea2b3b1

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