This release adds three main new features:

1. A new type of input rail that uses a set of jailbreak heuristics. More heuristics will be added in the future.
2. Support for generation options allowing fine-grained control on what types of rails should be triggered, what data should be returned and what logging information should be included in the response.
3. Support for making API calls to the guardrails server using multiple configuration ids.

This release also improves the support for working with embeddings (better async support, batching and caching), adds support for stop tokens per task template, and adds streaming support for HuggingFace pipelines. Last but not least, this release includes the core implementation for Colang 2.0 as a preview for early testing (version 0.9.0 will include documentation and examples).

What's Changed

Added

• #292 Jailbreak heuristics by @erickgalinkin.
• #256 Support generation options.
• #307 Added support for multi-config api calls by @makeshn.
• #293 Adds configurable stop tokens by @zmackie.
• #334 Colang 2.0 - Preview by @schuellc.
• #208 Implement cache embeddings (resolves #200) by @Pouyanpi.
• #331 Huggingface pipeline streaming by @trebedea.

Documentation:

• #311 Update documentation to demonstrate the use of output rails when using a custom RAG by @niels-garve.
• #347 Add detailed logging docs by @erickgalinkin.
• #354 Input and output rails only guide by @trebedea.
• #359 Added user guide for jailbreak detection heuristics by @makeshn.
• #363 Add multi-config API call user guide.
• #297 Example configurations for using only the guardrails, without LLM generation.

Changed

• #309 Change the paper citation from ArXiV to EMNLP 2023 by @manuelciosici
• #319 Enable embeddings model caching.
• #267 Make embeddings computing async and add support for batching.
• #281 Follow symlinks when building knowledge base by @piotrm0.
• #280 Add more information to results of retrieve_relevant_chunks by @piotrm0.
• #332 Update docs for batch embedding computations.
• #244 Docs/edit getting started by @DougAtNvidia.
• #333 Follow-up to PR 244.
• #341 Updated 'fastembed' version to 0.2.2 by @NirantK.

Fixed

• #286 Fixed #285 - using the same evaluation set given a random seed for topical rails by @trebedea.
• #336 Fix #320. Reuse the asyncio loop between sync calls.
• #337 Fix stats gathering in a parallel async setup.
• #342 Fixes OpenAI embeddings support.
• #346 Fix issues with KB embeddings cache, bot intent detection and config ids validator logic.
• #349 Fix multi-config bug, asyncio loop issue and cache folder for embeddings.
• #350 Fix the incorrect logging of an extra dialog rail.
• #358 Fix Openai embeddings async support.
• #362 Fix the issue with the server being pointed to a folder with a single config.
• #352 Fix a few issues related to jailbreak detection heuristics.
• #356 Redo followlinks PR in new code by @piotrm0.

New Contributors

• @manuelciosici made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/309
• @erickgalinkin made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/292
• @trebedea made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/286
• @piotrm0 made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/281
• @Pouyanpi made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/208
• @niels-garve made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/311
• @zmackie made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/293
• @DougAtNvidia made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/244
• @NirantK made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/341
• @makeshn made their first contribution in https://github.com/NVIDIA/NeMo-Guardrails/pull/359

Full Changelog: https://github.com/NVIDIA/NeMo-Guardrails/compare/v0.7.1...v0.8.0