Nemoguardrails

🚀 Features

- Support Output Rails Streaming ([966](https://github.com/NVIDIA/NeMo-Guardrails/issues/966), [#1003](https://github.com/NVIDIA/NeMo-Guardrails/issues/1003))
- Add unified output mapping for actions ([965](https://github.com/NVIDIA/NeMo-Guardrails/issues/965))
- Add output rails support to activefence integration ([940](https://github.com/NVIDIA/NeMo-Guardrails/issues/940))
- Add Prompt Security integration ([920](https://github.com/NVIDIA/NeMo-Guardrails/issues/920))
- Add pii masking capability to PrivateAI integration ([901](https://github.com/NVIDIA/NeMo-Guardrails/issues/901))
- Add embedding_params to BasicEmbeddingsIndex ([898](https://github.com/NVIDIA/NeMo-Guardrails/issues/898))
- Add score threshold to AnalyzerEngine ([845](https://github.com/NVIDIA/NeMo-Guardrails/issues/845))

🐛 Bug Fixes

- Fix dependency resolution issues in AlignScore Dockerfile([1002](https://github.com/NVIDIA/NeMo-Guardrails/issues/1002), [#982](https://github.com/NVIDIA/NeMo-Guardrails/issues/982))
- Fix JailbreakDetect docker files([981](https://github.com/NVIDIA/NeMo-Guardrails/issues/981), [#1001](https://github.com/NVIDIA/NeMo-Guardrails/pull/1001))
- Fix TypeError from attempting to unpack already-unpacked dictionary. ([959](https://github.com/NVIDIA/NeMo-Guardrails/issues/959))
- Fix token stats usage in LLM call info. ([953](https://github.com/NVIDIA/NeMo-Guardrails/issues/953))
- Handle unescaped quotes in generate_value using safe_eval ([946](https://github.com/NVIDIA/NeMo-Guardrails/issues/946))
- Handle non-relative file paths ([897](https://github.co/NVIDIA/NeMo-Guardrails/issues/897))
- Set workdir to models and specify entrypoint explicitly ([1001](https://github.com/NVIDIA/NeMo-Guardrails/pull/1001)).

📚 Documentation

- Output streaming ([976](https://github.com/NVIDIA/NeMo-Guardrails/issues/976))
- Fix typos with oauthtoken ([957](https://github.com/NVIDIA/NeMo-Guardrails/issues/957))
- Fix broken link in prompt security ([978](https://github.com/NVIDIA/NeMo-Guardrails/issues/978))
- Update advanced user guides per v0.11.1 doc release ([937](https://github.com/NVIDIA/NeMo-Guardrails/issues/937))

⚙️ Miscellaneous Tasks

- Tolerate prompt in code blocks ([1004](https://github.com/NVIDIA/NeMo-Guardrails/issues/1004))
- Update YAML indent to use two spaces ([1009](https://github.com/NVIDIA/NeMo-Guardrails/issues/1009))

Added

- **ContentSafety**: Add ContentSafety NIM connector ([930](https://github.com/NVIDIA/NeMo-Guardrails/pull/930)) by prasoonvarshney
- **TopicControl**: Add TopicControl NIM connector ([930](https://github.com/NVIDIA/NeMo-Guardrails/pull/930)) by makeshn
- **JailbreakDetect**: Add jailbreak detection NIM connector ([930](https://github.com/NVIDIA/NeMo-Guardrails/pull/930)) by erickgalinkin

Changed

- **AutoAlign Integration**: Add further enhancements and refactoring to AutoAlign integration ([867](https://github.com/NVIDIA/NeMo-Guardrails/pull/867)) by KimiJL

Fixed

- **PrivateAI Integration**: Fix Incomplete URL substring sanitization Error ([883](https://github.com/NVIDIA/NeMo-Guardrails/pull/883)) by NJ-186

Documentation

- **NVIDIA Blueprint**: Add Safeguarding AI Virtual Assistant NIM Blueprint NemoGuard NIMs ([932](https://github.com/NVIDIA/NeMo-Guardrails/pull/932)) by abodhankar

- **ActiveFence Integration**: Fix flow definition in community docs ([890](https://github.com/NVIDIA/NeMo-Guardrails/pull/890)) by noamlevy81

Added

- **Observability**: Add observability support with support for different backends ([844](https://github.com/NVIDIA/NeMo-Guardrails/pull/844)) by Pouyanpi
- **Private AI Integration**: Add Private AI Integration ([815](https://github.com/NVIDIA/NeMo-Guardrails/pull/815)) by letmerecall
- **Patronus Evaluate API Integration**: Patronus Evaluate API Integration ([834](https://github.com/NVIDIA/NeMo-Guardrails/pull/834)) by varjoshi
- **railsignore**: Add support for .railsignore file ([790](https://github.com/NVIDIA/NeMo-Guardrails/pull/790)) by ajanitshimanga

Changed

- **Sandboxed Environment in Jinja2**: Add sandboxed environment in Jinja2 ([799](https://github.com/NVIDIA/NeMo-Guardrails/pull/799)) by Pouyanpi
- **Langchain 3 support**: Upgrade LangChain to Version 0.3 ([784](https://github.com/NVIDIA/NeMo-Guardrails/pull/784)) by Pouyanpi
- **Python 3.8**: Drop support for Python 3.8 ([803](https://github.com/NVIDIA/NeMo-Guardrails/pull/803)) by Pouyanpi
- **vllm**: Bump vllm from 0.2.7 to 0.5.5 for llama_guard and patronusai([836](https://github.com/NVIDIA/NeMo-Guardrails/pull/836))

Fixed

- **Guardrails Library documentation**": Fix a typo in guardrails library documentation ([793](https://github.com/NVIDIA/NeMo-Guardrails/pull/793)) by vedantnaik19
- **Contributing Guide**: Fix incorrect folder name & pre-commit setup in CONTRIBUTING.md ([800](https://github.com/NVIDIA/NeMo-Guardrails/pull/800))
- **Contributing Guide**: Added correct Python command version in documentation([801](https://github.com/NVIDIA/NeMo-Guardrails/pull/801)) by ravinder-tw
- **retrieve chunk action**: Fix presence of new line in retrieve chunk action ([809](https://github.com/NVIDIA/NeMo-Guardrails/pull/809)) by Pouyanpi
- **Standard Library import**: Fix guardrails standard library import path in Colang 2.0 ([835](https://github.com/NVIDIA/NeMo-Guardrails/pull/835)) by Pouyanpi
- **AlignScore Dockerfile**: Add nltk's punkt_tab in align_score Dockerfile ([841](https://github.com/NVIDIA/NeMo-Guardrails/pull/841)) by yonromai
- **Eval dependencies**: Make pandas version constraint explicit for eval optional dependency ([847](https://github.com/NVIDIA/NeMo-Guardrails/pull/847)) by Pouyanpi
- **tests**: Mock PromptSession to prevent console error ([851](https://github.com/NVIDIA/NeMo-Guardrails/pull/851)) by Pouyanpi
- **Streaming*: Handle multiple output parsers in generation ([854](https://github.com/NVIDIA/NeMo-Guardrails/pull/854)) by Pouyanpi

Documentation

- **User Guide**: Update role from bot to assistant ([852](https://github.com/NVIDIA/NeMo-Guardrails/pull/852)) by Pouyanpi
- **Installation Guide**: Update optional dependencies install ([853](https://github.com/NVIDIA/NeMo-Guardrails/pull/853)) by Pouyanpi
- **Documentation Restructuring**: Restructure the docs and several style enhancements ([855](https://github.com/NVIDIA/NeMo-Guardrails/pull/855)) by Pouyanpi
- **Got It AI deprecation**: Add deprecation notice for Got It AI integration ([857](https://github.com/NVIDIA/NeMo-Guardrails/pull/857)) by mlmonk

- Colang 2.0-beta.4 patch

Added

- **content safety**: Implement content safety module ([674](https://github.com/NVIDIA/NeMo-Guardrails/pull/674)) by Pouyanpi
- **migration tool**: Enhance migration tool capabilities ([624](https://github.com/NVIDIA/NeMo-Guardrails/pull/624)) by Pouyanpi
- **Cleanlab Integration**: Add Cleanlab's Trustworthiness Score ([572](https://github.com/NVIDIA/NeMo-Guardrails/pull/572)) by AshishSardana
- **Colang 2**: LLM chat interface development ([709](https://github.com/NVIDIA/NeMo-Guardrails/pull/709)) by schuellc-nvidia
- **embeddings**: Add relevant chunk support to Colang 2 ([708](https://github.com/NVIDIA/NeMo-Guardrails/pull/708)) by Pouyanpi
- **library**: Migrate Cleanlab to Colang 2 and add exception handling ([714](https://github.com/NVIDIA/NeMo-Guardrails/pull/714)) by Pouyanpi
- **Colang debug library**: Develop debugging tools for Colang ([560](https://github.com/NVIDIA/NeMo-Guardrails/pull/560)) by schuellc-nvidia
- **debug CLI**: Extend debugging command-line interface ([717](https://github.com/NVIDIA/NeMo-Guardrails/pull/717)) by schuellc-nvidia
- **embeddings**: Add support for embeddings only with search threshold ([733](https://github.com/NVIDIA/NeMo-Guardrails/pull/733)) by Pouyanpi
- **embeddings**: Add embedding-only support to Colang 2 ([737](https://github.com/NVIDIA/NeMo-Guardrails/pull/737)) by Pouyanpi
- **embeddings**: Add relevant chunks prompts ([745](https://github.com/NVIDIA/NeMo-Guardrails/pull/745)) by Pouyanpi
- **gcp moderation**: Implement GCP-based moderation tools ([727](https://github.com/NVIDIA/NeMo-Guardrails/pull/727)) by kauabh
- **migration tool**: Sample conversation syntax conversion ([764](https://github.com/NVIDIA/NeMo-Guardrails/pull/764)) by Pouyanpi
- **llmrails**: Add serialization support for LLMRails ([627](https://github.com/NVIDIA/NeMo-Guardrails/pull/627)) by Pouyanpi
- **exceptions**: Initial support for exception handling ([384](https://github.com/NVIDIA/NeMo-Guardrails/pull/384)) by drazvan
- **evaluation tooling**: Develop new evaluation tools ([677](https://github.com/NVIDIA/NeMo-Guardrails/pull/677)) by drazvan
- **Eval UI**: Add support for tags in the Evaluation UI ([731](https://github.com/NVIDIA/NeMo-Guardrails/pull/731)) by drazvan
- **guardrails library**: Launch Colang 2.0 Guardrails Library ([689](https://github.com/NVIDIA/NeMo-Guardrails/pull/689)) by drazvan
- **configuration**: Revert abc bot to Colang v1 and separate v2 configuration ([698](https://github.com/NVIDIA/NeMo-Guardrails/pull/698)) by drazvan

Changed

- **api**: Update Pydantic validators ([688](https://github.com/NVIDIA/NeMo-Guardrails/pull/688)) by Pouyanpi
- **standard library**: Refactor and migrate standard library components ([625](https://github.com/NVIDIA/NeMo-Guardrails/pull/625)) by Pouyanpi

- Upgrade langchain-core and jinja2 dependencies ([766](https://github.com/NVIDIA/NeMo-Guardrails/pull/766)) by Pouyanpi

Fixed

- **documentation**: Fix broken links ([670](https://github.com/NVIDIA/NeMo-Guardrails/pull/670)) by buvnswrn
- **hallucination-check**: Correct hallucination-check functionality ([679](https://github.com/NVIDIA/NeMo-Guardrails/pull/679)) by Pouyanpi
- **streaming**: Fix NVIDIA AI endpoints streaming issues ([654](https://github.com/NVIDIA/NeMo-Guardrails/pull/654)) by Pouyanpi
- **hallucination-check**: Resolve non-OpenAI hallucination check issue ([681](https://github.com/NVIDIA/NeMo-Guardrails/pull/681)) by Pouyanpi
- **import error**: Fix Streamlit import error ([686](https://github.com/NVIDIA/NeMo-Guardrails/pull/686)) by Pouyanpi
- **prompt override**: Fix override prompt self-check facts ([621](https://github.com/NVIDIA/NeMo-Guardrails/pull/621)) by Pouyanpi
- **output parser**: Resolve deprecation warning in output parser ([691](https://github.com/NVIDIA/NeMo-Guardrails/pull/691)) by Pouyanpi
- **patch**: Fix langchain_nvidia_ai_endpoints patch ([697](https://github.com/NVIDIA/NeMo-Guardrails/pull/697)) by Pouyanpi
- **runtime issues**: Address Colang 2 runtime issues ([699](https://github.com/NVIDIA/NeMo-Guardrails/pull/699)) by schuellc-nvidia
- **send event**: Change 'send event' to 'send' ([701](https://github.com/NVIDIA/NeMo-Guardrails/pull/701)) by Pouyanpi
- **output parser**: Fix output parser validation ([704](https://github.com/NVIDIA/NeMo-Guardrails/pull/704)) by Pouyanpi
- **passthrough_fn**: Pass config and kwargs to passthrough_fn runnable ([695](https://github.com/NVIDIA/NeMo-Guardrails/pull/695)) by vpr1995
- **rails exception**: Fix rails exception migration ([705](https://github.com/NVIDIA/NeMo-Guardrails/pull/705)) by Pouyanpi
- **migration**: Replace hyphens and apostrophes in migration ([725](https://github.com/NVIDIA/NeMo-Guardrails/pull/725)) by Pouyanpi
- **flow generation**: Fix LLM flow continuation generation ([724](https://github.com/NVIDIA/NeMo-Guardrails/pull/724)) by schuellc-nvidia
- **server command**: Fix CLI server command ([723](https://github.com/NVIDIA/NeMo-Guardrails/pull/723)) by Pouyanpi
- **embeddings filesystem**: Fix cache embeddings filesystem ([722](https://github.com/NVIDIA/NeMo-Guardrails/pull/722)) by Pouyanpi
- **outgoing events**: Process all outgoing events ([732](https://github.com/NVIDIA/NeMo-Guardrails/pull/732)) by sklinglernv
- **generate_flow**: Fix a small bug in the generate_flow action for Colang 2 ([710](https://github.com/NVIDIA/NeMo-Guardrails/pull/710)) by drazvan
- **triggering flow id**: Fix the detection of the triggering flow id ([728](https://github.com/NVIDIA/NeMo-Guardrails/pull/728)) by drazvan
- **LLM output**: Fix multiline LLM output syntax error for dynamic flow generation ([748](https://github.com/NVIDIA/NeMo-Guardrails/pull/748)) by radinshayanfar
- **scene form**: Fix the scene form and choice flows in the Colang 2 standard library ([741](https://github.com/NVIDIA/NeMo-Guardrails/pull/741)) by sklinglernv

Documentation

- **Cleanlab**: Update community documentation for Cleanlab integration ([713](https://github.com/NVIDIA/NeMo-Guardrails/pull/713)) by Pouyanpi
- **rails exception handling**: Add notes for Rails exception handling in Colang 2.x ([744](https://github.com/NVIDIA/NeMo-Guardrails/pull/744)) by Pouyanpi
- **LLM per task**: Document LLM per task functionality ([676](https://github.com/NVIDIA/NeMo-Guardrails/pull/676)) by Pouyanpi

Others

- **relevant_chunks**: Add the `relevant_chunks` to the GPT-3.5 general prompt template ([678](https://github.com/NVIDIA/NeMo-Guardrails/pull/678)) by drazvan
- **flow names**: Ensure flow names don't start with keywords ([637](https://github.com/NVIDIA/NeMo-Guardrails/pull/637)) by schuellc-nvidia

Fixed

- [650](https://github.com/NVIDIA/NeMo-Guardrails/pull/650) Fix gpt-3.5-turbo-instruct prompts #651.