Bootstrap

RAG (Retrieval Augmented Generation) 检索增强和生成

1 RAG技术简介

1.1 RAG技术概述

RAG(Retrieval Augmented Generation) 是一种结合了检索(Retrieval)和生成(Generation)的技术,旨在通过利用外部知识库来增强大型语言模型(LLMs)的性能。它通过检索与用户输入相关的信息片段,并结合这些信息来生成更准确、更丰富的回答。

在这里插入图片描述

正式介绍检索增强生成(Retrieval Augmented Generation,RAG)技术以前,大家不妨想想为什么会出现这样一个技术。 给模型注入新知识的方式,可以简单分为两种方式,一种是内部的,即更新模型的权重,另一个就是外部的方式,给模型注入格外的上下文或者说外部信息,不改变它的的权重。
第一种方式,改变了模型的权重即进行模型训练,这是一件代价比较大的事情,大语言模型具体的训练过程,可以参考InternLM2技术报告。
第二种方式,并不改变模型的权重,只是给模型引入格外的信息。类比人类编程的过程,第一种方式相当于你记住了某个函数的用法,第二种方式相当于你阅读函数文档然后短暂的记住了某个函数的用法。

在这里插入图片描述
对比两种注入知识方式,第二种更容易实现。RAG正是这种方式。它能够让基础模型实现非参数知识更新,无需训练就可以掌握新领域的知识。本次课程选用了LlamaIndex框架。LlamaIndex 是一个上下文增强的 LLM 框架,旨在通过将其与特定上下文数据集集成,增强大型语言模型(LLMs)的能力。它允许您构建应用程序,既利用 LLMs 的优势,又融入您的私有或领域特定信息。

1.2 向量数据库 Vector-DB

向量数据库 Vector-DB用于将文本及其他数据通过其他预训练的模型转换为固定长度的向量表示,这些向量能够捕捉文本的语义信息。
在这里插入图片描述

1.3 RAG发展进程

RAG的概念最早是由Meta(Facebook)的Lewis等人在2020《Retrieval-Augmented Generation for Knowledge-Intensive NLP Tasks》 中提出的。
在这里插入图片描述

1.4 RAG常见优化方法

  • 索引优化
  • 查询优化
  • 嵌入优化
  • 上下文管理
  • LLM微调
  • 选代检索
  • 递归检索
  • 自适应检索
    在这里插入图片描述

1.5 RAG vs.微调(Fine-tuning )

(1) RAG

  • 非参数记忆,利用外部知识库提供实时更新的信息。
  • 能够处理知识密集型任务,提供准确的事实性回答。
  • 通过检索增强,可以生成更多样化的内容。

适用场景

  • 适用于需要结合最新信息和实时数据的任务:开放域问答、实时新闻摘等。

优势:动态知识更新,处理长尾知识问题。

局限:依赖于外部知识库的质量和覆盖范围(Garbage in, garbage out)。

(2) Fine-tuning

  • 参数记忆,通过在特定任务数据上训练,模型可以更好地适应该任务。
  • 通常需要大量标注数据来进行有效微调。
  • 微调后的模型可能过拟合,导致泛化能力下降。

适用场景
适用于数据可用且需要模型高度专业化的任务,如特定领域的文本分类、情感分析、文本生成等。

优势:模型性能针对特定任务优化。
局限:需要大量的标注数据,且对新任务的适应
性较差。

模型优化方法Prompt Engineering、RAG、Fine-tuning比较:

在这里插入图片描述

1.6 评估框架和基准测试

经典评估指标

  • 准确率(Accuracy)
  • 召回率(Recall)
  • F1分数(F1Score)
  • BLEU分数(用于机器翻译和文本生成)
  • ROUGE分数(用于文本生成的评估)

RAG评测框架

  • 基准测试-RGB、RECALL、CRUD
  • 评测工具-RAGAS、ARES、TruLens

1.7 相关论文

更多详细信息可见2024一篇RAG综述 《Retrieval-Augmented Generation for Large Language Models: A Survey》。

2 LlamaIndex框架

LlamaIndex是一个开源的索引和搜索库,提供高效、可扩展的文本索引和检索功能。

在这里插入图片描述

2.1 LlamaIndex 特点

数据索引和检索

  • 对大规模数据进行索引,支持多种数据源(文件、数据库、网络等)
  • 提供高效的检索机制,快速找到相关信息

支持多种生成模型

  • 除Llama系列外,还支持GPT系列、OpenAIAPI、和InternLM系列等多种大模型
    在这里插入图片描述

2.2 LlamaIndex RAG 应用

Llamalndex提供了RAG一般应用的全过程模块化,拓展方便

  • 数据加载(Loading)
    从多种数据源加载数据:无论是文本文件、PDF、网站、数据库还是API,Llamalndex通过LlamaHub提供了数百个连接器(connectors or Reader),使数据加载过程高效且多样化。
  • 数据索引(Indexing)
    创建数据结构:LlamaIndex通过创建向量嵌入vectorembeddings(数据含义的数值表示)和其他元数据策略来索引数据。这些结构使得查询数据变得简单且精确,能够快速找到上下文相关的信息。
  • 数据存储(Storing)
    索引和元数据存储:一旦数据被索引,LlamaIndex会将索引和其他元数据存储起来,避免重复索引过程。这种方法提高了系统的效率和响应速度。
  • 数据查询(Querying)
    多样化的查询策略:对于任何给定的索引策略,LamaIndex提供了多种查询方式,包括子查询、多步骤查询和混合策略。这些方法利用LLM和LlamaIndex数据结构,确保能够准确且有效地获取所需信息。
  • 效果评估(Evaluating)
    评估和优化:在任何管道中,评估是关键步骤。LlamaIndex提供客观的评估方法,衡量查询响应的准确性、忠实性和速度。通过评估,用户可以比较不同策略的效果,并在进行更改时确保系统性能的稳定和优化。

在这里插入图片描述

3 Llamaindex RAG 实践

基于Llamalndex构建自己的RAG知识库,寻找一个问题 A 在使用Llamalndex之前InternLM2-Chat-1.8B模型不会回答,借助Llamalndex后InternLM2-Chat-1.8B模型具备回答A的能力。

示例:如图所示,由于xtuner是一款比较新的框架, 浦语 API 训练数据库中并没有收录到它的相关信息。左图中问答均未给出准确的答案。右图未对 浦语 API 进行任何增训的情况下,通过 RAG 技术实现的新增知识问答。

在这里插入图片描述

3.1 环境、模型准备

3.1.1 配置基础环境

创建新的conda环境,命名为 llamaindex,在命令行模式下运行:

 conda create -n llamaindex python=3.10

创建完成后,在本地查看环境。

conda env list

结果如下所示。

# conda environments:
#
base                  *  /root/.conda
llamaindex               /root/.conda/envs/llamaindex

运行 conda 命令,激活 llamaindex 然后安装相关基础依赖 python 虚拟环境:

conda activate llamaindex

安装python 依赖包

pip install einops==0.7.0 protobuf==5.26.1

3.1.2 安装 Llamaindex

以下安装根据需要取其一。

  1. 浦语 API+LlamaIndex,安装 Llamaindex和相关的包,需要安装较长的时间。
conda activate llamaindex
pip install llama-index==0.11.20
pip install llama-index-llms-replicate==0.3.0
pip install llama-index-llms-openai-like==0.2.0
pip install llama-index-embeddings-huggingface==0.3.1
pip install llama-index-embeddings-instructor==0.2.1
pip install torch==2.5.0 torchvision==0.20.0 torchaudio==2.5.0 --index-url https://download.pytorch.org/whl/cu121
  1. 如果使用 LlamaIndex+本地部署InternLM,则安装下列相关包,不需要安装上述包。
  • 安装 Llamaindex 和相关的包:
conda activate llamaindex
pip install llama-index==0.10.38 llama-index-llms-huggingface==0.2.0 "transformers[torch]==4.41.1" "huggingface_hub[inference]==0.23.1" huggingface_hub==0.23.1 sentence-transformers==2.7.0 sentencepiece==0.2.0
  • 安装 LlamaIndex 词嵌入向量依赖:
conda activate llamaindex
pip install llama-index-embeddings-huggingface==0.2.0 llama-index-embeddings-instructor==0.1.3

安装 pytorch

pip install torch==2.5.0 torchvision==0.20.0 torchaudio==2.5.0 --index-url https://download.pytorch.org/whl/cu121

3.1.3 下载 Sentence Transformer 模型

源词向量模型 Sentence Transformer:(我们也可以选用别的开源词向量模型来进行 Embedding,目前选用这个模型是相对轻量、支持中文且效果较好的,同学们可以自由尝试别的开源词向量模型) 运行以下指令,新建一个python文件。

cd ~
mkdir llamaindex_demo
mkdir model
cd ~/llamaindex_demo
touch download_hf.py

打开download_hf.py 贴入以下代码:

import os

# 设置环境变量
os.environ['HF_ENDPOINT'] = 'https://hf-mirror.com'

# 下载模型
os.system('huggingface-cli download --resume-download sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2 --local-dir /root/model/sentence-transformer')

然后,在…/llamaindex_demo 目录下执行该脚本即可自动开始下载:

conda activate llamaindex
python download_hf.py

3.1.4 下载 NLTK 相关资源

我们在使用开源词向量模型构建开源词向量的时候,需要用到第三方库 nltk 的一些资源。正常情况下,其会自动从互联网上下载,但可能由于网络原因会导致下载中断,此处我们可以从国内仓库镜像地址下载相关资源,保存到服务器上。 我们用以下命令下载 nltk 资源并解压到服务器上:

cd /root
git clone https://gitee.com/yzy0612/nltk_data.git  --branch gh-pages
cd nltk_data
mv packages/*  ./
cd tokenizers
unzip punkt.zip
cd ../taggers
unzip averaged_perceptron_tagger.zip

之后使用时服务器即会自动使用已有资源,无需再次下载。

3.2 是否使用 LlamaIndex 前后对比

3.2.1 不使用 LlamaIndex RAG(仅API)

浦语官网和硅基流动都提供了InternLM的类OpenAI接口格式的免费的 API,可以访问以下两个了解两个 API 的使用方法和 Key。

浦语官方 API:https://internlm.intern-ai.org.cn/api/document
硅基流动:https://cloud.siliconflow.cn/models?mfs=internlm

方法1:运行以下指令,新建一个python文件

cd ~/llamaindex_demo
touch test_internlm.py

打开test_internlm.py 输入以下代码:

from openai import OpenAI

base_url = "https://internlm-chat.intern-ai.org.cn/puyu/api/v1/"
api_key = "填写自己的token!"
model="internlm2.5-latest"

# base_url = "https://api.siliconflow.cn/v1"
# api_key = "sk-请填写准确的 token!"
# model="internlm/internlm2_5-7b-chat"

client = OpenAI(
    api_key=api_key , 
    base_url=base_url,
)

chat_rsp = client.chat.completions.create(
    model=model,
    messages=[{"role": "user", "content": "xtuner是什么?"}],
)

for choice in chat_rsp.choices:
    print(choice.message.content)

运行:

python test_internlm.py

结果为:
在这里插入图片描述

方法2 LlamaIndex+本地部署InternLM

如果本地已下载了InternLM2 1.8B,只需设计一个软链接:

cd ~/model
ln -s /root/share/new_models/Shanghai_AI_Laboratory/internlm2-chat-1_8b/ ./

然后新建文件:

cd ~/llamaindex_demo
touch llamaindex_internlm.py

代码:

from llama_index.llms.huggingface import HuggingFaceLLM
from llama_index.core.llms import ChatMessage
llm = HuggingFaceLLM(
    model_name="/root/model/internlm2-chat-1_8b",
    tokenizer_name="/root/model/internlm2-chat-1_8b",
    model_kwargs={"trust_remote_code":True},
    tokenizer_kwargs={"trust_remote_code":True}
)

rsp = llm.chat(messages=[ChatMessage(content="xtuner是什么?")])
print(rsp)

运行:

python llamaindex_internlm.py

结果为:
在这里插入图片描述

回答的效果并不好,并不是我们想要的xtuner。

3.2.2 使用 API+LlamaIndex

运行以下命令,获取知识库

cd ~/llamaindex_demo
mkdir data
cd data
git clone https://github.com/InternLM/xtuner.git
mv xtuner/README_zh-CN.md ./

运行以下指令,新建一个python文件

cd ~/llamaindex_demo
touch llamaindex_RAG.py

打开llamaindex_RAG.py贴入以下代码

import os 
os.environ['NLTK_DATA'] = '/root/nltk_data'

from llama_index.core import VectorStoreIndex, SimpleDirectoryReader
from llama_index.core.settings import Settings
from llama_index.embeddings.huggingface import HuggingFaceEmbedding
from llama_index.legacy.callbacks import CallbackManager
from llama_index.llms.openai_like import OpenAILike


# Create an instance of CallbackManager
callback_manager = CallbackManager()

api_base_url =  "https://internlm-chat.intern-ai.org.cn/puyu/api/v1/"
model = "internlm2.5-latest"
api_key = "请填写 API Key"

# api_base_url =  "https://api.siliconflow.cn/v1"
# model = "internlm/internlm2_5-7b-chat"
# api_key = "请填写 API Key"



llm =OpenAILike(model=model, api_base=api_base_url, api_key=api_key, is_chat_model=True,callback_manager=callback_manager)


#初始化一个HuggingFaceEmbedding对象,用于将文本转换为向量表示
embed_model = HuggingFaceEmbedding(
#指定了一个预训练的sentence-transformer模型的路径
    model_name="/root/model/sentence-transformer"
)
#将创建的嵌入模型赋值给全局设置的embed_model属性,
#这样在后续的索引构建过程中就会使用这个模型。
Settings.embed_model = embed_model

#初始化llm
Settings.llm = llm

#从指定目录读取所有文档,并加载数据到内存中
documents = SimpleDirectoryReader("/root/llamaindex_demo/data").load_data()
#创建一个VectorStoreIndex,并使用之前加载的文档来构建索引。
# 此索引将文档转换为向量,并存储这些向量以便于快速检索。
index = VectorStoreIndex.from_documents(documents)
# 创建一个查询引擎,这个引擎可以接收查询并返回相关文档的响应。
query_engine = index.as_query_engine()
response = query_engine.query("xtuner是什么?")

print(response)

运行:

python llamaindex_RAG.py

注意:第一次运行会下载相关数据需要一段时间,请耐心等待,如中断可能导致第二次运行因为文件损坏报错!!!

结果为:
在这里插入图片描述
很明显,借助RAG技术后,我们得到了想要的答案。

方法2 LlamaIndex+本地部署InternLM:
如果本地有模型文件,代码如下:


from llama_index.core import VectorStoreIndex, SimpleDirectoryReader, Settings

from llama_index.embeddings.huggingface import HuggingFaceEmbedding
from llama_index.llms.huggingface import HuggingFaceLLM

#初始化一个HuggingFaceEmbedding对象,用于将文本转换为向量表示
embed_model = HuggingFaceEmbedding(
#指定了一个预训练的sentence-transformer模型的路径
    model_name="/root/model/sentence-transformer"
)
#将创建的嵌入模型赋值给全局设置的embed_model属性,
#这样在后续的索引构建过程中就会使用这个模型。
Settings.embed_model = embed_model

llm = HuggingFaceLLM(
    model_name="/root/model/internlm2-chat-1_8b",
    tokenizer_name="/root/model/internlm2-chat-1_8b",
    model_kwargs={"trust_remote_code":True},
    tokenizer_kwargs={"trust_remote_code":True}
)
#设置全局的llm属性,这样在索引查询时会使用这个模型。
Settings.llm = llm

#从指定目录读取所有文档,并加载数据到内存中
documents = SimpleDirectoryReader("/root/llamaindex_demo/data").load_data()
#创建一个VectorStoreIndex,并使用之前加载的文档来构建索引。
# 此索引将文档转换为向量,并存储这些向量以便于快速检索。
index = VectorStoreIndex.from_documents(documents)
# 创建一个查询引擎,这个引擎可以接收查询并返回相关文档的响应。
query_engine = index.as_query_engine()
response = query_engine.query("xtuner是什么?")

print(response)

运行:

python llamaindex_RAG.py

结果为:在这里插入图片描述

3.3 LlamaIndex web

运行之前首先安装依赖

pip install streamlit==1.36.0

运行以下指令,新建一个 python 文件

cd ~/llamaindex_demo
touch app.py

打开app.py写入以下代码

import streamlit as st
from llama_index.core import VectorStoreIndex, SimpleDirectoryReader, Settings
from llama_index.embeddings.huggingface import HuggingFaceEmbedding
from llama_index.llms.huggingface import HuggingFaceLLM

st.set_page_config(page_title="llama_index_demo", page_icon="🦜🔗")
st.title("llama_index_demo")

# 初始化模型
@st.cache_resource
def init_models():
    embed_model = HuggingFaceEmbedding(
        model_name="/root/model/sentence-transformer"
    )
    Settings.embed_model = embed_model

    llm = HuggingFaceLLM(
        model_name="/root/model/internlm2-chat-1_8b",
        tokenizer_name="/root/model/internlm2-chat-1_8b",
        model_kwargs={"trust_remote_code": True},
        tokenizer_kwargs={"trust_remote_code": True}
    )
    Settings.llm = llm

    documents = SimpleDirectoryReader("/root/llamaindex_demo/data").load_data()
    index = VectorStoreIndex.from_documents(documents)
    query_engine = index.as_query_engine()

    return query_engine

# 检查是否需要初始化模型
if 'query_engine' not in st.session_state:
    st.session_state['query_engine'] = init_models()

def greet2(question):
    response = st.session_state['query_engine'].query(question)
    return response


# Store LLM generated responses
if "messages" not in st.session_state.keys():
    st.session_state.messages = [{"role": "assistant", "content": "你好,我是你的助手,有什么我可以帮助你的吗?"}]

    # Display or clear chat messages
for message in st.session_state.messages:
    with st.chat_message(message["role"]):
        st.write(message["content"])

def clear_chat_history():
    st.session_state.messages = [{"role": "assistant", "content": "你好,我是你的助手,有什么我可以帮助你的吗?"}]

st.sidebar.button('Clear Chat History', on_click=clear_chat_history)

# Function for generating LLaMA2 response
def generate_llama_index_response(prompt_input):
    return greet2(prompt_input)

# User-provided prompt
if prompt := st.chat_input():
    st.session_state.messages.append({"role": "user", "content": prompt})
    with st.chat_message("user"):
        st.write(prompt)

# Gegenerate_llama_index_response last message is not from assistant
if st.session_state.messages[-1]["role"] != "assistant":
    with st.chat_message("assistant"):
        with st.spinner("Thinking..."):
            response = generate_llama_index_response(prompt)
            placeholder = st.empty()
            placeholder.markdown(response)
    message = {"role": "assistant", "content": response}
    st.session_state.messages.append(message)

之后运行

streamlit run app.py

打开的 url
在这里插入图片描述

即可进入以下网页,然后就可以开始尝试问问题了
在这里插入图片描述

询问结果为:

在这里插入图片描述

;