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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_guardrails-1.5.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.19

File hashes

Hashes for ragbits_guardrails-1.5.0.tar.gz
Algorithm Hash digest
SHA256 fc166fea2e6b501a8b62cb7772e5cd09faebe884a775413549ac5271820f3c47
MD5 4a6c71cf53e291a72d0271b803504afb
BLAKE2b-256 84a92c5674eac02ff8e577a7e83d4d854eff6b9a807044d9aadd7e3f89624482

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_guardrails-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa3bbbb81c6b70893fb5f717fdb39c23dc166dee557a200682f9326206c8477f
MD5 5fbec607e7e120bc2ca09be5dcae5b09
BLAKE2b-256 a03cee82cf6ad3810605e403c8e4f2eda857abd9dc2baa14ac57585ec8c24e22

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