Langchain implementation for Guardrails: Nemo
Project description
Nemo Integration with LangChain
This package provides NeMo integration with LangChain, addressing a key limitation in existing NeMo runnables. Specifically, it enables configurable options for NeMo, offering greater control over what is generated. Additionally, it allows flexibility in using different LLMs for NeMo and text generation, enhancing adaptability for various use cases.
Features
- Customizable NeMo options: Control what NeMo generates by utilizing generation options described here
- Flexible LLM integration: Use different LLMs for NeMo and response generation. Utilize tools binding as needed.
- Guardrails integration: Ensure AI-generated responses adhere to predefined constraints.
Installation
Ensure you have the necessary dependencies installed:
pip install langchain_guardrails
Input
Default behaviour is to execute only rails and generation is left for surround to handle i.e default for options is set to {"rails": ["input"]}
Output
Output from guarrail is a dictionary:
{"original": <original message", "stop": True/False}
Utilize stop signal to execute next steps.
Usage
Below is an example demonstrating how to integrate NeMo with LangChain and apply guardrails to control responses. Here we use custom generator function passthrough_or_exit
Inbuilt generator function
This package has inbuilt function for generation - generate_or_exit - which is enabled when generator_llm is passed. You can use that as well to complete your generation.
# Create the guardrail processing chain
guardrail_chain = nemorails.create_guardrail_chain()
res = ChatPromptTemplate.from_messages(test_input)
chain = res | guardrail_chain | nemorails.generate_or_exit
# Invoke the guardrail chain
response = [chain.invoke({})]
Custom generator function
from langchain_openai import ChatOpenAI
from nemoguardrails import RailsConfig
from langchain_guardrails import NemoRails
from langchain.schema import HumanMessage
from langchain_core.prompts import ChatPromptTemplate
from langchain_core.runnables import chain
# Initialize OpenAI model
llm = ChatOpenAI(model="gpt-3.5-turbo", temperature=0.7)
# Load RailsConfig (configure with the actual path to your NeMo guardrails config)
rails_config = RailsConfig.from_path("./tests/config")
# Instantiate NemoRails with configuration and LLM
nemorails = NemoRails(config=rails_config, llm=llm, options={"rails": ["input"]})
# Sample user input
user_input = [HumanMessage(content="Tell me about the Avengers movie")]
# Define a simple passthrough function with an exit condition
@chain
def passthrough_or_exit(message_dict):
if message_dict["stop"]:
return "I'm sorry, I can't respond to that."
return llm.invoke(message_dict["original"])
# Create the guardrail processing chain
guardrail_chain = nemorails.create_guardrail_chain()
response_chain = ChatPromptTemplate.from_messages(user_input) | guardrail_chain | passthrough_or_exit
# Invoke the chain and generate response
response = response_chain.invoke({})
# Print the output
print(response)
Notes
- The
RailsConfigmust be configured with the correct NeMo guardrails path. - Modify
optionsto customize how NeMo processes inputs.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file langchain_guardrails-0.0.3.tar.gz.
File metadata
- Download URL: langchain_guardrails-0.0.3.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5d1f38e688628cb2b914e163f39543c4edd8baccd6efce7ac3dfc0c679f70109
|
|
| MD5 |
97bf63a3b7c68c82d6b7ac8c97fc0ba1
|
|
| BLAKE2b-256 |
b89727efa41d4b9efdd9c2767ba288ad49126b5ad828b9680545821da9325a19
|
File details
Details for the file langchain_guardrails-0.0.3-py3-none-any.whl.
File metadata
- Download URL: langchain_guardrails-0.0.3-py3-none-any.whl
- Upload date:
- Size: 4.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3a2bd789522228feb25a9b442e35b4de27e141296ce8b212658cb3e10c52a52d
|
|
| MD5 |
cfd9152ffdae5e1f8abfc5d8673a9775
|
|
| BLAKE2b-256 |
8b8a55fa1bda370958dedbb8b0d61fad60fc84525fa9b08be3d6ed52169ba3f6
|