Prompt Chain

Evaluate LLM Apps with TruLens

TruLens-Eval Llama-Pack provides three observability packs for LlamaIndex apps: RAG Triad (hallucination detection), Harmless (safety), and Helpful (quality).

Works with githubslacktrulens

91
Spark score
out of 100
Updated 3 months ago
Version 1.0.0
Models

Add to Favorites

Why it matters

Enhance your LlamaIndex applications by integrating TruLens for comprehensive LLM observability. This pack provides robust evaluation and tracking capabilities to ensure your RAG systems are relevant, grounded, and helpful.

Outcomes

What it gets done

01

Evaluate RAG triad: context relevance, groundedness, and answer relevance.

02

Perform safety and moderation evaluations for harmful content.

03

Assess helpfulness metrics like conciseness and language match.

04

Track and leaderboard LLM app performance over time.

Install

Add it to your toolbox

Run in your project directory:

curl -fsSL https://spark.entire.vc/get/li-pack-packs-trulens-eval-packs | bash

Steps

Steps in the chain

01
Download TruLens LlamaPack

Download the TruLensRAGTriadPack using llamaindex-cli with the command: llamaindex-cli download-llamapack TruLensRAGTriadPack --download-dir ./trulens_pack. Inspect the files at ./trulens_pack and use them as a template for your own project.

02
Set up environment and load data

Set OPENAI_API_KEY environment variable. Load documents using SimpleWebPageReader from a web source. Split documents into nodes using SentenceSplitter.

03
Initialize TruLensRAGTriadPack

Create a TruLensRAGTriadPack instance with the nodes and an app_id identifier: trulens_ragtriad_pack = TruLensRAGTriadPack(nodes=nodes, app_id='Query Engine v1: RAG Triad Evals')

04
Run queries and evaluate

Execute queries using the pack's run method in a loop. For each query, call response = trulens_ragtriad_pack.run(query) and print the response to see evaluation results.

05
Access pack internals and view results

Use get_modules() method to access TruLens session, index, query engine, and tru_query_engine. Call tru.get_leaderboard(app_ids=['Query Engine v1: RAG Triad Evals']) to view evaluation results.

Overview

TruLens-Eval Llama-Pack

What it does

Three LlamaPacks for LLM app observability: TruLensRAGTriadPack for hallucination detection through context relevance, groundedness, and answer relevance; TruLensHarmlessPack for safety evaluations including criminality and violence; and TruLensHelpfulPack for quality evaluations like conciseness and language match.

How it connects

Use when you need evaluation and tracking for your LlamaIndex app, particularly when detecting hallucinations in RAG systems or ensuring safety and quality of LLM responses.

Source README

TruLens-Eval Llama-Pack

TruLens

The best way to support TruLens is to give us a ⭐ on GitHub and join our slack community!

TruLens provides three Llamma Packs for LLM app observability:

  • The first is the TruLensRAGTriadPack (context relevance, groundedness, answer relevance). This triad holds the key to detecting hallucination.

  • Second, is the TruLensHarmlessPack including moderation and safety evaluations like criminality, violence and more.

  • Last is the TruLensHelpfulPack, including evaluations like conciseness and language match.

No matter which TruLens LlamaPack you choose, all three provide evaluation and tracking for your LlamaIndex app with TruLens, an open-source LLM observability library from TruEra.

CLI Usage

You can download llamapacks directly using llamaindex-cli, which comes installed with the llama-index python package:

llamaindex-cli download-llamapack TruLensRAGTriadPack --download-dir ./trulens_pack

You can then inspect the files at ./trulens_pack and use them as a template for your own project.

Code Usage

You can download each pack to a ./trulens_pack directory:

from llama_index.core.llama_pack import download_llama_pack

### download and install dependencies
TruLensRAGTriadPack = download_llama_pack(
    "TruLensRAGTriadPack", "./trulens_pack"
)

From here, you can use the pack, or inspect and modify the pack in ./trulens_pack.

Then, you can set up the pack like so:

import os

os.environ["OPENAI_API_KEY"] = "sk-..."

from tqdm.auto import tqdm
from llama_index.core.node_parser import SentenceSplitter
from llama_index.readers.web import SimpleWebPageReader

documents = SimpleWebPageReader(html_to_text=True).load_data(
    ["http://paulgraham.com/worked.html"]
)

splitter = SentenceSplitter()
nodes = splitter.get_nodes_from_documents(documents)

trulens_ragtriad_pack = TruLensRAGTriadPack(
    nodes=nodes, app_id="Query Engine v1: RAG Triad Evals"
)

Then run your queries and evaluate!

queries = [
    "What did Paul Graham do growing up?",
    "When and how did Paul Graham's mother die?",
    "What, in Paul Graham's opinion, is the most distinctive thing about YC?",
    "When and how did Paul Graham meet Jessica Livingston?",
    "What is Bel, and when and where was it written?",
]
for query in tqdm(queries):
    print("Query")
    print("=====")
    print(query)
    print()
    response = trulens_ragtriad_pack.run(query)
    print("Response")
    print("========")
    print(response)

You can access the internals of the LlamaPack, including your TruLens session and your query engine, via the get_modules method.

modules = trulens_ragtriad_pack.get_modules()
tru = modules["session"]
index = modules["index"]
query_engine = modules["query_engine"]
tru_query_engine = modules["tru_query_engine"]
tru.get_leaderboard(app_ids=["Query Engine v1: RAG Triad Evals"])

Resources

There is a more complete notebook demo available in the llama-hub repo.

Check out the TruLens documentation for more information!

Step 1: Download TruLens LlamaPack

Download the TruLensRAGTriadPack using llamaindex-cli with the command: llamaindex-cli download-llamapack TruLensRAGTriadPack --download-dir ./trulens_pack. Inspect the files at ./trulens_pack and use them as a template for your own project.

Step 2: Set up environment and load data

Set OPENAI_API_KEY environment variable. Load documents using SimpleWebPageReader from a web source. Split documents into nodes using SentenceSplitter.

Step 3: Initialize TruLensRAGTriadPack

Create a TruLensRAGTriadPack instance with the nodes and an app_id identifier: trulens_ragtriad_pack = TruLensRAGTriadPack(nodes=nodes, app_id='Query Engine v1: RAG Triad Evals')

Step 4: Run queries and evaluate

Execute queries using the pack's run method in a loop. For each query, call response = trulens_ragtriad_pack.run(query) and print the response to see evaluation results.

Step 5: Access pack internals and view results

Use get_modules() method to access TruLens session, index, query engine, and tru_query_engine. Call tru.get_leaderboard(app_ids=['Query Engine v1: RAG Triad Evals']) to view evaluation results.

Discussion

Questions & comments · 0

Sign In Sign in to leave a comment.