Skip to content

Commit 63aba28

Browse files
committed
update docs with correct naming
1 parent 48d1daf commit 63aba28

File tree

3 files changed

+5
-117
lines changed

3 files changed

+5
-117
lines changed

docs/integrations/nemo_guardrails/guardrails_rails.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ guard = Guard().use(
2626
Then, we have the guard validate the completions generated by the Rails application.
2727

2828
```python
29-
from guardrails import RailsGuard
30-
railsguard = RailsGuard(rails, guard)
29+
from guardrails.integrations.nemoguardrails.nemoguardrails_guard import (
30+
NemoguardrailsGuard
31+
)
32+
railsguard = NemoguardrailsGuards(rails, guard)
3133

3234
result = railsguard(
3335
messages: [{
@@ -37,7 +39,7 @@ result = railsguard(
3739
)
3840
```
3941

40-
The `RailsGuard` class is a wrapper around the Guard class. Just like a Guard, it can [called](https://www.guardrailsai.com/docs/api_reference_markdown/guards#__call__) with similar parameters to the OpenAI completions API. It also returns a `ValidationOutcome` object (or iterable, in streaming cases). That object can be destructured to get the raw output, the validated output, and other metadata.
42+
The `NemoguardrailsGuard` class is a wrapper around the Guard class. Just like a Guard, it can [called](https://www.guardrailsai.com/docs/api_reference_markdown/guards#__call__) with similar parameters to the OpenAI completions API. It also returns a `ValidationOutcome` object (or iterable, in streaming cases). That object can be destructured to get the raw output, the validated output, and other metadata.
4143

4244
Here, `raw_llm_output` is the output returned by the NeMo Guardrails Rails.
4345

docs/integrations/nemo_guardrails/nemoguardrails_in_guardrails.ipynb

Lines changed: 0 additions & 111 deletions
This file was deleted.

docs/integrations/nemo_guardrails/using_rails_as_a_validator.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)