Skip to main content

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 RailsConfig must be configured with the correct NeMo guardrails path.
  • Modify options to customize how NeMo processes inputs.
  • Tools messages are not checked

Credits

This package uses code from nemoguardrails, licensed under [ Apache-2.0].

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

langchain_guardrails-0.0.5.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

langchain_guardrails-0.0.5-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file langchain_guardrails-0.0.5.tar.gz.

File metadata

  • Download URL: langchain_guardrails-0.0.5.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for langchain_guardrails-0.0.5.tar.gz
Algorithm Hash digest
SHA256 d06f809ee812e20e198cfe111eba380ada465255a948b997b9fa3c5855b9ceda
MD5 1f7d50d8b268708e0830a40d64ab3c7b
BLAKE2b-256 a5239ee0b1b10858a85de1cf6246447b0bc959071ed30dbee89ed10fb2f758e8

See more details on using hashes here.

File details

Details for the file langchain_guardrails-0.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for langchain_guardrails-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f0b345468729e111908501ae590aa44aa8e5f2a4beacf11c67b0c09ae36ad8a0
MD5 f9f32e4bb691db480fc33c2cebc2040c
BLAKE2b-256 5ed58939c8f7f88c39a8667f649accf76dd5734b93bf416f2c34759718974890

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page