You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -385,6 +385,10 @@ For intellectual property detection, the matching score has to be following form
385
385
386
386
### Confidential Info detection
387
387
388
+
```{warning}
389
+
Backward incompatible changes are introduced in v0.12.0 due to AutoAlign API changes
390
+
```
391
+
388
392
The goal of the confidential info detection rail is to determine if the text has any kind of confidential information. This rail can be applied at both input and output.
389
393
This guardrail can be added by adding `confidential_info_detection` key in the dictionary under `guardrails_config` section
390
394
which is under `input` or `output` section which should be in `autoalign` section in `config.yml`.
@@ -439,6 +443,10 @@ For tonal detection, the matching score has to be following format:
439
443
440
444
### Toxicity extraction
441
445
446
+
```{warning}
447
+
Backward incompatible changes are introduced in v0.12.0 due to AutoAlign API changes
448
+
```
449
+
442
450
The goal of the toxicity detection rail is to determine if the text has any kind of toxic content. This rail can be applied at both input and output. This guardrail not just detects the toxicity of the text but also extracts toxic phrases from the text.
443
451
This guardrail can be added by adding `toxicity_detection` key in the dictionary under `guardrails_config` section
444
452
which is under `input` or `output` section which should be in `autoalign` section in `config.yml`.
@@ -485,6 +493,10 @@ define bot refuse to respond
485
493
486
494
### PII
487
495
496
+
```{warning}
497
+
Backward incompatible changes are introduced in v0.12.0 due to AutoAlign API changes
498
+
```
499
+
488
500
To use AutoAlign's PII (Personal Identifiable Information) module, you have to list the entities that you wish to redact
489
501
in `enabled_types` in the dictionary of `guardrails_config` under the key of `pii`; if not listed then all PII types will be redacted.
490
502
@@ -558,6 +570,11 @@ Example PII config:
558
570
```
559
571
560
572
### Groundness Check
573
+
574
+
```{warning}
575
+
Backward incompatible changes are introduced in v0.12.0 due to AutoAlign API changes
576
+
```
577
+
561
578
The groundness check needs an input statement (represented as ‘prompt’) as a list of evidence documents.
562
579
To use AutoAlign's groundness check module, you have to modify the `config.yml` in the following format:
563
580
@@ -636,6 +653,11 @@ The supporting documents or the evidence has to be placed within a `kb` folder w
636
653
637
654
638
655
### Fact Check
656
+
657
+
```{warning}
658
+
Backward incompatible changes are introduced in v0.12.0 due to AutoAlign API changes
659
+
```
660
+
639
661
The fact check uses the bot response and user input prompt to check the factual correctness of the bot response based on the user prompt. Unlike groundness check, fact check does not use a pre-existing internal knowledge base.
640
662
To use AutoAlign's fact check module, modify the `config.yml` from example autoalign_factcheck_config.
0 commit comments