Skip to content

Commit a0f6d04

Browse files
Pouyanpimiyoungc
andauthored
docs(config): fix configuration reference for jailbreak, streaming and sample conversation (#1643)
* docs(config): fix configuration reference for jailbreak, streaming, and sample conversation - Fix check jailbreak to jailbreak detection heuristics in input rails table - Add injection detection to output rails table - Fix sample_conversation format to use Colang syntax - Deprecate top-level streaming field with proper admonition - Simplify streaming config to boolean --------- Signed-off-by: Pouyan <13303554+Pouyanpi@users.noreply.github.com> Co-authored-by: Miyoung Choi <miyoungc@nvidia.com>
1 parent ebffb81 commit a0f6d04

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

docs/configure-rails/configuration-reference.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ rails:
250250
| Flow | Description |
251251
|------|-------------|
252252
| `self check input` | LLM-based policy compliance check |
253-
| `check jailbreak` | Jailbreak detection heuristics |
253+
| `jailbreak detection heuristics` | Jailbreak detection heuristics |
254254
| `jailbreak detection model` | NIM-based jailbreak detection |
255255
| `mask sensitive data on input` | Mask PII in user input |
256256
| `detect sensitive data on input` | Detect and block PII |
@@ -301,6 +301,7 @@ rails:
301301
| `mask sensitive data on output` | Mask PII in output |
302302
| `llama guard check output` | LlamaGuard content moderation |
303303
| `content safety check output` | NVIDIA content safety model |
304+
| `injection detection` | Injection detection (SQL, XSS, code, template) |
304305

305306
### Retrieval Rails
306307

@@ -710,8 +711,14 @@ instructions:
710711

711712
```yaml
712713
sample_conversation: |
713-
user: Hello
714-
assistant: Hi! How can I help you?
714+
user "Hello there!"
715+
express greeting
716+
bot express greeting
717+
"Hello! How can I assist you today?"
718+
user "What can you do for me?"
719+
ask about capabilities
720+
bot respond about capabilities
721+
"As an AI assistant, I can help you with a wide range of tasks."
715722
```
716723

717724
### Knowledge Base
@@ -748,15 +755,15 @@ tracing:
748755

749756
### Streaming
750757

758+
```{deprecated} v0.20.0
759+
The top-level `streaming` field is a boolean that is no longer required. Use the `stream_async()` method directly instead. For output rail streaming configuration, see [Output Streaming Configuration](#output-streaming-configuration).
760+
```
761+
751762
```yaml
752-
streaming:
753-
enabled: false
754-
stream_on_start: false
755-
stream_on_end: true
756-
first_chunk_suffix: ""
757-
last_chunk_suffix: ""
763+
streaming: false
758764
```
759765
766+
760767
### Import Paths
761768
762769
```yaml

0 commit comments

Comments
 (0)