Guardrails 项目常见问题解决方案

Guardrails 项目常见问题解决方案

guardrails Adding guardrails to large language models. 项目地址: https://gitcode.com/gh_mirrors/gu/guardrails

项目基础介绍

Guardrails 是一个 Python 框架，旨在通过执行两个关键功能来构建可靠的 AI 应用：

1. 输入/输出防护：在应用中运行输入/输出防护，检测、量化并缓解特定类型的风险。
2. 生成结构化数据：帮助从大型语言模型（LLMs）生成结构化数据。

该项目的主要编程语言是 Python。

新手使用注意事项及解决方案

1. 安装依赖问题

问题描述：新手在安装 Guardrails 时可能会遇到依赖项安装失败的问题，尤其是在使用 pip install guardrails-ai 时。

解决步骤：

1. 检查 Python 版本：确保你使用的是 Python 3.7 或更高版本。
2. 使用虚拟环境：建议在虚拟环境中安装 Guardrails，以避免与其他项目的依赖冲突。

   python3 -m venv guardrails_env
   source guardrails_env/bin/activate
   pip install guardrails-ai
   

3. 手动安装依赖：如果 pip install 失败，可以尝试手动安装依赖项。

   pip install -r requirements.txt
   

2. 配置 Guardrails Hub CLI 问题

问题描述：在配置 Guardrails Hub CLI 时，可能会遇到命令行工具无法正常工作的问题。

解决步骤：

1. 安装 Guardrails Hub CLI：确保你已经正确安装了 Guardrails Hub CLI。

   pip install guardrails-ai
   guardrails configure
   

2. 检查配置文件：确保配置文件 .guardrailsrc 存在于用户主目录下，并且配置正确。
3. 重新配置：如果配置文件有问题，可以尝试重新配置。

   guardrails configure --reset
   

3. 使用 Guardrails 进行验证时的问题

问题描述：在使用 Guardrails 进行输入/输出验证时，可能会遇到验证失败的情况，尤其是在使用自定义正则表达式时。

解决步骤：

1. 检查正则表达式：确保正则表达式正确无误。

   from guardrails import Guard, OnFailAction
   from guardrails.hub import RegexMatch
   
   guard = Guard()
   guard.use(RegexMatch(regex=r"\(\d{3}\)-\d{3}-\d{4}", on_fail=OnFailAction.EXCEPTION))
   

2. 测试验证：在测试验证时，确保输入符合预期格式。

   try:
       guard.validate("123-456-7890")  # 通过
       guard.validate("1234-789-0000")  # 失败
   except Exception as e:
       print(e)
   

3. 查看错误信息：如果验证失败，查看错误信息以了解具体问题。

通过以上步骤，新手可以更好地理解和使用 Guardrails 项目，解决常见问题。

guardrails Adding guardrails to large language models. 项目地址: https://gitcode.com/gh_mirrors/gu/guardrails