Hand on RAG

什么是RAG？

LLM会产生误导性的 “幻觉”，依赖的信息可能过时，处理特定知识时效率不高，缺乏专业领域的深度洞察，同时在推理能力上也有所欠缺。

正是在这样的背景下，检索增强生成技术（Retrieval-Augmented Generation，RAG）应时而生，成为 AI 时代的一大趋势。

RAG 通过在语言模型生成答案之前，先从广泛的文档数据库中检索相关信息，然后利用这些信息来引导生成过程，极大地提升了内容的准确性和相关性。RAG 有效地缓解了幻觉问题，提高了知识更新的速度，并增强了内容生成的可追溯性，使得大型语言模型在实际应用中变得更加实用和可信。

此仓库用于学习大模型RAG的相关内容，目前为手搓实现，主要是llama-index和langchain不太好魔改。此仓库可以方便看论文的时候，实现一些小的实验。以下为本仓库的RAG整体框架图。

以下为笔者所构思的RAG实现过程，这里面主要包括包括三个基本步骤：

索引 — 将文档库分割成较短的 Chunk，并通过编码器构建向量索引。
检索 — 根据问题和 chunks 的相似度检索相关文档片段。
生成 — 以检索到的上下文为条件，生成问题的回答。

QuickStrat

安装依赖，需要 Python 3.10 以上版本。

pip install -r requirements.txt

导入所使用的包

from RAG.VectorBase import VectorStore
from RAG.utils import ReadFiles
from RAG.LLM import OpenAIChat

如果没有数据库那就按照如下代码：

可以使用VectorStore.persist()保存到向量数据库。

# 没有保存数据库
docs = ReadFiles('./data').get_content(max_token_len=600, cover_content=150) # 获得data目录下的所有文件内容并分割
embedding = JinaEmbedding("your model path") # 创建EmbeddingModel
vector = VectorStore(docs)
vector.get_vector(EmbeddingModel=embedding)
vector.persist(path='storage') # 将向量和文档内容保存到storage目录下，下次再用就可以直接加载本地的数据库

question = 'git的分支原理？'

content = vector.query(question, EmbeddingModel=embedding, k=1)[0]
chat = OpenAIChat(model='gpt-3.5-turbo-1106')
print(chat.chat(question, [], content))

如果有数据库那就按照如下代码：

vector = VectorStore()

vector.load_vector('./storage') # 加载本地的数据库

embedding = JinaEmbedding("your model path")

question = 'git的分支原理？'

content = vector.query(question, EmbeddingModel=embedding, k=1)[0]

chat = OpenAIChat(model='gpt-3.5-turbo-1106')
print(chat.chat(question, [], content))

如果大家的文档有中文的话，不建议使用openai的向量接口，可以使用智谱AI或者Jina的向量模型或接口

实现细节

向量化

在这一部分共使用了三种向量化的方法，分别是zhipu、jina和openai。大家可以在Embedding文中找到实现的方式。

如果你有兴趣想使用其他的向量模型可以继承BaseEmbeddings类，然后实现get_embedding方法。

class BaseEmbeddings:
    """
    Base class for embeddings
    """
    def __init__(self, path: str, is_api: bool) -> None:
        self.path = path
        self.is_api = is_api
    
    def get_embedding(self, text: str, model: str) -> List[float]:
        raise NotImplementedError
    
    @classmethod
    def cosine_similarity(cls, vector1: List[float], vector2: List[float]) -> float:
        """
        calculate cosine similarity between two vectors
        """
        dot_product = np.dot(vector1, vector2)
        magnitude = np.linalg.norm(vector1) * np.linalg.norm(vector2)
        if not magnitude:
            return 0
        return dot_product / magnitude

向量检索

这里未使用任何成熟的数据库，只是简单的使用Json保存了文档分割后的片段和对应的向量。大家可以在VectorBase中找到实现的方式。

在向量检索的时候仅使用Numpy进行加速，代码非常容易理解和修改。

def query(self, query: str, EmbeddingModel: BaseEmbeddings, k: int = 1) -> List[str]:
    query_vector = EmbeddingModel.get_embedding(query)
    result = np.array([self.get_similarity(query_vector, vector)
                        for vector in self.vectors])
    return np.array(self.document)[result.argsort()[-k:][::-1]]

没有考虑生产环境使用，仅供学习使用

LLM 模型

这里支持了openai模型和InternLM2模型，如果想要用其他的模型，大家可以在LLM中找到实现的方式。继承以下基类，然后在此基础上进行修改即可。

class BaseModel:
    def __init__(self, path: str = '') -> None:
        self.path = path

    def chat(self, prompt: str, history: List[dict], content: str) -> str:
        pass

    def load_model(self):
        pass

参考文献

Name	Paper Link
When Large Language Models Meet Vector Databases: A Survey	paper
Retrieval-Augmented Generation for Large Language Models: A Survey	paper
Learning to Filter Context for Retrieval-Augmented Generation	paper
In-Context Retrieval-Augmented Language Models	paper

Hongru0306/Hand-on-RAG