자세한 지침은 [설치 가이드](https://docs.nvidia.com/nemo/guardrails/get-started/installation-guide)를 참조하세요.

## 개요

<!-- start-documentation-reuse -->

NeMo Guardrails 라이브러리는 LLM 기반 애플리케이션을 개발하는 개발자가 애플리케이션 코드와 LLM 사이에 **프로그래밍 가능한 가드레일(programmable guardrails)**을 추가할 수 있게 해줍니다.

<div align="center">
  <img src="https://raw.githubusercontent.com/NVIDIA-NeMo/Guardrails/develop/docs/_static/images/programmable_guardrails.png"  width="75%" alt="Programmable Guardrails">
</div>

*프로그래밍 가능한 가드레일*을 추가함으로써 얻을 수 있는 주요 이점은 다음과 같습니다:

- **신뢰할 수 있고 안전하며 보안성이 높은 LLM 기반 애플리케이션 구축:** 대화를 안내하고 보호하는 레일을 정의할 수 있습니다. 특정 주제에 대한 LLM 기반 애플리케이션의 동작을 정의하고 원치 않는 주제에 대한 논의를 방지하도록 선택할 수 있습니다.

- **모델, 체인 및 기타 서비스를 안전하게 연결:** LLM을 다른 서비스(일명 도구)에 원활하고 안전하게 연결할 수 있습니다.

- **제어 가능한 대화:** LLM이 사전 정의된 대화 경로를 따르도록 유도하여 대화 설계 모범 사례에 따라 상호작용을 설계하고 표준 운영 절차(예: 인증, 지원)를 적용할 수 있습니다.

<!-- end-documentation-reuse -->

### LLM 취약점으로부터 보호

NeMo Guardrails 라이브러리는 LLM 기반 채팅 애플리케이션을 탈옥(jailbreak) 및 프롬프트 인젝션과 같은 일반적인 LLM 취약점으로부터 보호하는 여러 메커니즘을 제공합니다. 아래는 이 저장소에 포함된 예제 [ABC Bot](https://github.com/nvidia-nemo/guardrails/blob/develop/examples/bots/abc)에 대한 다양한 가드레일 구성이 제공하는 보호 기능의 샘플 개요입니다. 자세한 내용은 [LLM 취약점 스캐닝](https://docs.nvidia.com/nemo/guardrails/evaluation/llm-vulnerability-scanning.html) 페이지를 참조하세요.

<div align="center">
<img src="https://raw.githubusercontent.com/NVIDIA-NeMo/Guardrails/develop/docs/_static/images/abc-llm-vulnerability-scan-results.png" width="500">
</div>

### 사용 사례

프로그래밍 가능한 가드레일은 다양한 유형의 사용 사례에서 사용할 수 있습니다:

1. **문서 집합에 대한 질의응답**(일명 검색 증강 생성): 사실 확인과 출력 검열을 적용합니다.
2. **도메인 특화 어시스턴트**(일명 챗봇): 어시스턴트가 주제를 벗어나지 않고 설계된 대화 흐름을 따르도록 보장합니다.
3. **LLM 엔드포인트**: 더 안전한 고객 상호작용을 위해 맞춤형 LLM에 가드레일을 추가합니다.
4. **LangChain 체인**(선택 사항): 어떤 사용 사례에서든 LangChain을 사용한다면 체인 주변에 가드레일 계층을 추가할 수 있습니다. 이 통합을 활성화하려면 `NEMOGUARDRAILS_LLM_FRAMEWORK=langchain` 환경 변수를 설정하거나 `set_default_framework("langchain")`을 호출하세요.

### 사용 방법

애플리케이션에 프로그래밍 가능한 가드레일을 추가하려면 Python API 또는 가드레일 서버를 사용할 수 있습니다(자세한 내용은 [서버 가이드](https://docs.nvidia.com/nemo/guardrails/get-started/integrate-into-application) 참조). Python API를 사용하는 것은 LLM을 직접 사용하는 것과 유사합니다. LLM 대신 가드레일 계층을 호출하는 것은 코드 베이스에 최소한의 변경만 필요하며, 두 가지 간단한 단계로 이루어집니다:

1. 가드레일 구성을 로드하고 `LLMRails` 인스턴스를 생성합니다.
2. `generate`/`generate_async` 메서드를 사용하여 LLM을 호출합니다.```python
from nemoguardrails import LLMRails, RailsConfig

# Load a guardrails configuration from the specified path.
config = RailsConfig.from_path("PATH/TO/CONFIG")
rails = LLMRails(config)

completion = rails.generate(
    messages=[{"role": "user", "content": "Hello world!"}]
)

The input and output format for the `generate` method is similar to the [Chat Completions API](https://platform.openai.com/docs/guides/gpt/chat-completions-api) from OpenAI.

#### Async API

The NeMo Guardrails library is an async-first toolkit as the core mechanics are implemented using the Python async model. The public methods have both a sync and an async version. For example: `LLMRails.generate` and `LLMRails.generate_async`.

### Supported LLMs

You can use NeMo Guardrails with multiple LLMs like OpenAI GPT-3.5, GPT-4, LLaMa-2, Falcon, Vicuna, or Mosaic. For more details, check out the [Supported LLM Models](https://docs.nvidia.com/nemo/guardrails/about-nemo-guardrails-library/supported-llms) section in the Configuration Guide.

### Types of Guardrails

The NeMo Guardrails library supports five main types of guardrails:

<div align="center">
  <img src="https://raw.githubusercontent.com/NVIDIA-NeMo/Guardrails/develop/docs/_static/images/programmable_guardrails_flow.png"  width="75%" alt="Programmable Guardrails Flow">
</div>

1. **Input rails**: applied to the input from the user; an input rail can reject the input, stopping any additional processing, or alter the input (e.g., to mask potentially sensitive data, to rephrase).

2. **Dialog rails**: influence how the LLM is prompted; dialog rails operate on canonical form messages for details see [Colang Guide](https://docs.nvidia.com/nemo/guardrails/configure-guardrails/colang)) and determine if an action should be executed, if the LLM should be invoked to generate the next step or a response, if a predefined response should be used instead, etc.

3. **Retrieval rails**: applied to the retrieved chunks in the case of a RAG (Retrieval Augmented Generation) scenario; a retrieval rail can reject a chunk, preventing it from being used to prompt the LLM, or alter the relevant chunks (e.g., to mask potentially sensitive data).

4. **Execution rails**: applied to input/output of the custom actions (a.k.a. tools), that need to be called by the LLM.

5. **Output rails**: applied to the output generated by the LLM; an output rail can reject the output, preventing it from being returned to the user, or alter it (e.g., removing sensitive data).

### Guardrails Configuration

A guardrails configuration defines the **LLM(s)** to be used and **one or more guardrails**. A guardrails configuration can include any number of input/dialog/output/retrieval/execution rails. A configuration without any configured rails will essentially forward the requests to the LLM.

The standard structure for a guardrails configuration folder looks like this:```
.
├── config
│   ├── actions.py
│   ├── config.py
│   ├── config.yml
│   ├── rails.co
│   ├── ...

guardrails 구성에 포함된 `.co` 파일에는 다양한 유형의 rails를 정의하는 Colang 정의(Colang이 무엇인지에 대한 간략한 개요는 다음 섹션을 참조하세요)가 포함되어 있습니다. 아래는 사용자에게 인사하는 dialog rails를 정의하는 `greeting.co` 파일의 예입니다.```colang
define user express greeting
  "Hello!"
  "Good afternoon!"

define flow
  user express greeting
  bot express greeting
  bot offer to help

define bot express greeting
  "Hello there!"

define bot offer to help
  "How can I help you today?"

### Colang

다양한 유형의 가드레일을 구성하고 구현하기 위해, 이 툴킷은 **Colang**을 도입합니다. Colang은 유연하면서도 제어 가능한 대화 흐름을 설계하기 위해 특별히 만들어진 모델링 언어입니다. Colang은 파이썬과 유사한 문법을 가지며, 특히 개발자에게 간단하고 직관적이도록 설계되었습니다.```{note}
Two versions of Colang, 1.0 and 2.0, are supported and Colang 1.0 is the default.

라이브러리에는 LLM 자체 점검(입력/출력 모더레이션, 사실 확인, 환각 탐지)을 위한 가드레일, NVIDIA 안전 모델(콘텐츠 안전, 주제 안전), 탈옥 및 주입 탐지, 커뮤니티 모델 및 타사 API와의 통합이 포함됩니다. 전체 목록은 [Guardrails Library 문서](https://docs.nvidia.com/nemo/guardrails/user-guides/guardrails-library.html)를 참조하세요.

## CLI

NeMo Guardrails 라이브러리에는 내장 CLI도 함께 제공됩니다.```bash
$ nemoguardrails --help

Usage: nemoguardrails [OPTIONS] COMMAND [ARGS]...

actions-server    Start a NeMo Guardrails actions server.
chat              Start an interactive chat session.
evaluate          Run an evaluation task.
server            Start a NeMo Guardrails server.

예를 들어, `sample` config에 대한 chat completion을 가져오려면 `/v1/chat/completions` 엔드포인트를 사용할 수 있습니다:```
POST /v1/chat/completions

샘플 출력:```json
{"role": "assistant", "content": "Hi! How can I help you?"}

NVIDIA NeMo Guardrails 라이브러리가 시작되기 전에 옵트아웃을 설정하세요. 텔레메트리가 시작된 후 환경 변수를 변경하거나 `do_not_track`을 생성해도 이미 실행 중인 하트비트 스레드는 중지되지 않습니다.

전체 스키마와 필드별 설명은 [docs/telemetry.md](https://docs.nvidia.com/nemo/guardrails/latest/telemetry.html)를 참조하세요.

언제든지 텔레메트리 수집을 옵트아웃할 수 있습니다. 옵트아웃은 NVIDIA NeMo Guardrails 라이브러리 자체의 데이터 수집에만 적용됩니다.

타사 엔드포인트에는 별도의 이용 약관과 개인정보 처리 방침이 적용됩니다. NVIDIA NeMo Guardrails 라이브러리는 NVIDIA Build(`build.nvidia.com`)와 같은 추론 엔드포인트를 사용할 수 있습니다. NVIDIA Build 또는 다른 타사 엔드포인트를 사용하는 경우, 해당 엔드포인트의 서비스 약관과 개인정보 처리 방침이 라이브러리와 별개로 적용됩니다. NVIDIA NeMo Guardrails 라이브러리의 텔레메트리 옵트아웃은 사용자가 선택한 엔드포인트에는 적용되지 않습니다. NVIDIA Build는 평가 및 테스트 전용으로 제공되며 프로덕션 환경에서 사용해서는 안 됩니다. NVIDIA Build 사용 시 기밀 정보나 개인 데이터를 제출하지 마십시오.

## 커뮤니티 기여 초대

저장소에 있는 예제 레일은 훌륭한 시작점입니다. 신뢰할 수 있고, 안전하며, 보안이 강화된 LLM의 힘을 모든 사람이 이용할 수 있도록 하는 데 커뮤니티의 기여를 진심으로 초대합니다. 개발 환경 설정 및 NeMo Guardrails 라이브러리에 기여하는 방법에 대한 지침은 [기여 지침](https://github.com/nvidia-nemo/guardrails/blob/develop/CONTRIBUTING.md)을 참조하세요.

## 라이선스

NeMo Guardrails 라이브러리는 [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)에 따라 라이선스가 부여됩니다.

## 인용 방법

NeMo Guardrails 라이브러리를 사용하는 경우, 해당 라이브러리를 소개한 [EMNLP 2023 논문](https://aclanthology.org/2023.emnlp-demo.40)을 인용하세요.```bibtex
@inproceedings{rebedea-etal-2023-nemo,
    title = "{N}e{M}o Guardrails: A Toolkit for Controllable and Safe {LLM} Applications with Programmable Rails",
    author = "Rebedea, Traian  and
      Dinu, Razvan  and
      Sreedhar, Makesh Narsimhan  and
      Parisien, Christopher  and
      Cohen, Jonathan",
    editor = "Feng, Yansong  and
      Lefever, Els",
    booktitle = "Proceedings of the 2023 Conference on Empirical Methods in Natural Language Processing: System Demonstrations",
    month = dec,
    year = "2023",
    address = "Singapore",
    publisher = "Association for Computational Linguistics",
    url = "https://aclanthology.org/2023.emnlp-demo.40",
    doi = "10.18653/v1/2023.emnlp-demo.40",
    pages = "431--445",
}