文档#
文档分为以下几个部分
入门指南#
本节将帮助您快速开始使用 NeMo Guardrails。
示例#
examples 文件夹包含多个示例，展示了使用 NeMo Guardrails 的特定方面。
机器人: 本节包含两个示例配置。
HelloWorldBot: 这个基本配置指示机器人使用 “Hello World!” 向用户问好，并且不要谈论政治或股市。
ABCBot: 这个更复杂的配置包括主题轨道、输入和输出审核以及检索增强生成。
配置: 这些示例配置展示了 NeMo Guardrails 的特定功能，例如，如何使用各种 LLM 提供商、检索增强生成、流式传输、红队演练、身份验证等。
脚本: 这些简短的脚本展示了主 Python API 的各个方面。
注意
这些示例旨在展示构建 rails 的过程，而不是作为开箱即用的安全功能。强烈建议自定义和加强 rails。
用户指南#
用户指南涵盖了 NeMo Guardrails 工具包的核心细节，以及如何配置和使用不同的功能来制作您自己的 rails。
Guardrails 配置指南: config.yml 文件中所有可用配置选项的完整指南。
Guardrails 库: NeMo Guardrails 提供的入门级内置 rails 的概述。
Guardrails 流程: guardrails 流程的详细描述，即 rails 的类别以及如何调用它们。
Colang 语言指南: 学习 Colang 的语法和核心概念。
Guardrails 的 LLM 支持: 当前 LLM 支持的易于理解的摘要。
Python API: 了解 Python API，例如 RailsConfig 和 LLMRails 类。
CLI: 了解 NeMo Guardrails CLI，它可以帮助您使用 Chat CLI 或启动服务器。
服务器指南: 学习如何使用 NeMo Guardrails 服务器。
与 LangChain 集成: 在您现有的 LangChain 驱动的应用程序中集成 guardrails。
详细日志记录: 学习如何获取详细的日志记录信息。
安全#
评估工具#
NeMo Guardrails 提供了一组 CLI 评估工具以及针对主题和执行 rails 的实验结果。还有详细的指南，介绍如何重现结果并创建数据集以评估每种类型的 rail。
评估工具和结果: CLI 评估工具和实验结果的一般说明。
主题 Rail 评估 - 数据集工具: 数据集工具和详细信息，用于运行主题 rails 的实验。
事实核查 Rail 评估 - 数据集工具: 数据集工具和详细信息，用于运行事实核查执行 rail 的实验。
审核 Rail 评估 - 数据集工具: 数据集工具和详细信息，用于运行审核执行 rail 的实验。
高级指南#
以下指南更详细地解释了各种特定主题
生成选项: 学习如何使用高级生成选项。
提示定制: 学习如何为新型（或现有类型）的 LLM 定制提示。
嵌入搜索提供程序: 了解 NeMo guardrails 用于某些核心功能的嵌入搜索核心界面。
使用 Docker: 学习如何使用 Docker 部署 NeMo Guardrails。
流式传输: 了解 NeMo Guardrails 中的流式传输支持。
AlignScore 部署: 学习如何直接或使用 Docker 部署 AlignScore 服务器。
提取用户提供的值: 学习如何提取用户提供的值，如姓名、日期或查询。
机器人消息指令: 学习如何在运行时通过特定指令进一步调整机器人消息。
基于事件的 API: 了解通用的基于事件的界面，您可以使用它在您的 guardrails 配置中处理额外的信息。
越狱检测启发式方法部署: 学习如何部署越狱检测启发式方法服务器。
Llama Guard 部署: 学习如何使用 vLLM 部署 Llama Guard。
嵌套 AsyncIO 循环: 了解关于 asyncio 的一些底层问题以及它们在 NeMo Guardrails 中是如何处理的。
Vertex AI 设置: 学习如何设置 Vertex AI 帐户。