构建LangChain应用程序的示例代码：35、如何使用假设性文档嵌入（HyDE）技术来改善文档索引教程

使用假设性文档嵌入（HyDE）改善文档索引

摘要

本文介绍了如何使用假设性文档嵌入（Hypothetical Document Embeddings，简称HyDE），这是根据一篇论文中描述的技术。HyDE 是一种嵌入技术，它接收查询，生成一个假设性的答案，然后嵌入该生成的文档，并将其作为最终示例使用。

代码及注释

from langchain.chains import HypotheticalDocumentEmbedder, LLMChain
from langchain.prompts import PromptTemplate
from langchain_openai import OpenAI, OpenAIEmbeddings

# 初始化基础嵌入模型
base_embeddings = OpenAIEmbeddings()
# 初始化语言模型
llm = OpenAI()

# 使用web_search提示加载HyDE
embeddings = HypotheticalDocumentEmbedder.from_llm(llm, base_embeddings, "web_search")

# 现在我们可以像使用任何嵌入类一样使用它
result = embeddings.embed_query("泰姬陵在哪里？")

多生成文档

我们也可以生成多个文档，然后组合这些文档的嵌入。默认情况下，我们通过取平均值来组合它们。我们可以通过改变生成文档的LLM来返回多个结果。

# 初始化返回多个结果的语言模型
multi_llm = OpenAI(n=4, best_of=4)

# 使用多生成语言模型加载HyDE
embeddings = HypotheticalDocumentEmbedder.from_llm(
    multi_llm, base_embeddings, "web_search"
)

# 嵌入查询
result = embeddings.embed_query("泰姬陵在哪里？")

使用自定义提示

除了使用预配置的提示外，我们也可以轻松构建自己的提示，并在生成文档的LLMChain中使用它们。如果我们知道查询将涉及的领域，这将非常有用，因为我们可以调整提示以生成更类似于该领域的文本。

以下示例中，我们将提示条件设置为生成有关国情咨文的文本。

# 定义自定义提示模板
prompt_template = """请回答用户关于最近一次国情咨文的问题
问题：{question}
答案："""
# 创建提示模板对象
prompt = PromptTemplate(input_variables=["question"], template=prompt_template)
# 初始化使用自定义提示的LLMChain
llm_chain = LLMChain(llm=llm, prompt=prompt)

# 使用自定义提示加载HyDE
embeddings = HypotheticalDocumentEmbedder(
    llm_chain=llm_chain, base_embeddings=base_embeddings
)

# 嵌入查询
result = embeddings.embed_query(
    "总统在谈到Ketanji Brown Jackson时说了什么？"
)

使用HyDE

现在我们有了HyDE，我们可以像使用其他任何嵌入类一样使用它！以下是使用它在国情咨文示例中查找相似段落的方法。

from langchain_community.vectorstores import Chroma
from langchain_text_splitters import CharacterTextSplitter

# 读取国情咨文文本
with open("../../state_of_the_union.txt") as f:
    state_of_the_union = f.read()
# 初始化文本分割器
text_splitter = CharacterTextSplitter(chunk_size=1000, chunk_overlap=0)
# 分割文本
texts = text_splitter.split_text(state_of_the_union)

# 使用Chroma从分割后的文本和嵌入创建文档搜索引擎
docsearch = Chroma.from_texts(texts, embeddings)

# 定义查询
query = "总统在谈到Ketanji Brown Jackson时说了什么？"
# 执行相似性搜索
docs = docsearch.similarity_search(query)

# 打印搜索结果
print(docs[0].page_content)

总结

本文详细介绍了如何使用假设性文档嵌入（HyDE）技术来改善文档索引。通过提供基础嵌入模型和生成文档的语言模型链（LLMChain），我们可以生成假设性答案并将其嵌入作为最终示例。此外，我们还探讨了如何使用自定义提示来生成特定领域的文本，以及如何将HyDE与其他工具结合使用，如Chroma和CharacterTextSplitter，以实现文档的高效索引和搜索。

扩展知识

• HyDE (Hypothetical Document Embeddings)：一种文档嵌入技术，通过生成假设性答案来改善文档索引和搜索。
• LLMChain：用于生成文档的语言模型链，可以与HyDE结合使用。
• OpenAIEmbeddings：OpenAI 提供的嵌入模型，用于生成文档嵌入。
• PromptTemplate：用于定义和生成自定义提示的模板。
• Chroma：一个向量存储库，用于文档搜索和相似性搜索。
• CharacterTextSplitter：用于将长文本分割成更小的块，以便于处理和索引。