Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to demonstrate the use of output rails when using a custom RAG #311

Merged
merged 1 commit into from
Feb 15, 2024

Conversation

niels-garve
Copy link
Contributor

@niels-garve niels-garve commented Feb 7, 2024

Hi @drazvan,

First, thanks for NeMo Guardrails.

With this pull request, I add an example that demonstrates the use of output rails when using a custom RAG.

Please refer to the README files that come with this pull request.

Fixes #227

  • Documentation The example is documented and linked from the Guardrails Library docs.
  • Tests Passing
  • Changelog Updated I decided not to reflect the documentation changes in the changelog
  • Code Style and Quality
  • Commit Guidelines
  • No Merge Conflicts
  • Self Review

How to test

$ export OPENAI_API_KEY='your API key'
$ nemoguardrails chat --config <your_root>/NeMo-Guardrails/examples/configs/rag/custom_rag_output_rails --verbose

You may be prompted to install: pip install langchain-openai because this example uses it.

@drazvan
Copy link
Collaborator

drazvan commented Feb 15, 2024

Looks good @niels-garve! Thanks a lot for this great example.

@drazvan drazvan merged commit db42b3e into NVIDIA:develop Feb 15, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Hallucination rail not working properly
2 participants