如何执行每用户检索
本指南演示如何配置检索链的运行时属性。一个示例应用程序是根据用户限制检索器可用的文档。
在构建检索应用程序时,您通常必须在考虑多个用户的情况下构建它。这意味着您可能不仅为一个用户存储数据,而且为许多不同的用户存储数据,并且他们应该无法看到彼此的数据。这意味着您需要能够将检索链配置为仅检索某些信息。这通常包括两个步骤。
第 1 步:确保您使用的检索器支持多个用户
目前,LangChain 中没有统一的标志或过滤器。相反,每个 vectorstore 和 retriever 可能都有自己的,并且可以称为不同的事物(命名空间、多租户等)。对于 vectorstore,这通常作为在similarity_search.通过阅读文档或源代码,弄清楚您使用的检索器是否支持多个用户,如果支持,如何使用它。
注意:为不支持它(或记录它)的检索器添加文档和/或为多个用户提供支持是为 LangChain 做出贡献的好方法
第 2 步:将该参数添加为链的可配置字段
这将使你能够在运行时轻松调用链并配置任何相关标志。有关配置的更多信息,请参阅此文档。
现在,在运行时,你可以使用 configurable field 调用这个链。
代码示例
让我们看一个具体的例子,说明这在代码中是什么样子的。在此示例中,我们将使用 Pinecone。
要配置 Pinecone,请设置以下环境变量:
PINECONE_API_KEY:您的 Pinecone API 密钥
from langchain_openai import OpenAIEmbeddings
from langchain_pinecone import PineconeVectorStore
embeddings = OpenAIEmbeddings()
vectorstore = PineconeVectorStore(index_name="test-example", embedding=embeddings)
vectorstore.add_texts(["I worked at Kensho"], namespace="harrison")
vectorstore.add_texts(["I worked at Facebook"], namespace="ankush")
['f907aab7-77c7-4347-acc2-6859f8142f92']
Pinecone kwarg 用于namespace可用于分隔文档
# This will only get documents for Ankush
vectorstore.as_retriever(search_kwargs={"namespace": "ankush"}).invoke(
"where did i work?"
)
[Document(id='f907aab7-77c7-4347-acc2-6859f8142f92', metadata={}, page_content='I worked at Facebook')]
# This will only get documents for Harrison
vectorstore.as_retriever(search_kwargs={"namespace": "harrison"}).invoke(
"where did i work?"
)
[Document(id='16061fc5-c6fc-4f45-a3b3-23469d7996af', metadata={}, page_content='I worked at Kensho')]
现在,我们可以创建用于问答的链。
让我们首先选择一个 LLM。
pip install -qU "langchain[openai]"
import getpass
import os
if not os.environ.get("OPENAI_API_KEY"):
os.environ["OPENAI_API_KEY"] = getpass.getpass("Enter API key for OpenAI: ")
from langchain.chat_models import init_chat_model
llm = init_chat_model("gpt-4o-mini", model_provider="openai")
这将遵循 RAG 教程中的基本实现,但我们将允许检索步骤是可配置的。
from langchain_core.prompts import ChatPromptTemplate
from langchain_core.runnables import ConfigurableField
template = """Answer the question based only on the following context:
{context}
Question: {question}
"""
prompt = ChatPromptTemplate.from_template(template)
retriever = vectorstore.as_retriever()
在这里,我们将检索器标记为具有可配置字段。所有 vectorstore 检索器都有search_kwargs作为字段。这只是一个字典,具有 vectorstore 特定的字段。
这将让我们传入一个search_kwargs在调用链时。
configurable_retriever = retriever.configurable_fields(
search_kwargs=ConfigurableField(
id="search_kwargs",
name="Search Kwargs",
description="The search kwargs to use",
)
)
我们现在可以使用可配置的检索器创建链。
from langchain_core.documents import Document
from langchain_core.runnables import RunnableConfig
from langgraph.graph import START, StateGraph
from typing_extensions import List, TypedDict
class State(TypedDict):
question: str
context: List[Document]
answer: str
def retrieve(state: State, config: RunnableConfig):
retrieved_docs = configurable_retriever.invoke(state["question"], config)
return {"context": retrieved_docs}
def generate(state: State):
docs_content = "\n\n".join(doc.page_content for doc in state["context"])
messages = prompt.invoke({"question": state["question"], "context": docs_content})
response = llm.invoke(messages)
return {"answer": response.content}
graph_builder = StateGraph(State).add_sequence([retrieve, generate])
graph_builder.add_edge(START, "retrieve")
graph = graph_builder.compile()
from IPython.display import Image, display
display(Image(graph.get_graph().draw_mermaid_png()))
我们现在可以使用可配置的选项调用链。search_kwargs是 Configurable 字段的 ID。该值是用于 Pinecone 的搜索 kwargs。
result = graph.invoke(
{"question": "Where did the user work?"},
config={"configurable": {"search_kwargs": {"namespace": "harrison"}}},
)
result
{'question': 'Where did the user work?',
'context': [Document(id='16061fc5-c6fc-4f45-a3b3-23469d7996af', metadata={}, page_content='I worked at Kensho')],
'answer': 'The user worked at Kensho.'}
result = graph.invoke(
{"question": "Where did the user work?"},
config={"configurable": {"search_kwargs": {"namespace": "ankush"}}},
)
result
{'question': 'Where did the user work?',
'context': [Document(id='f907aab7-77c7-4347-acc2-6859f8142f92', metadata={}, page_content='I worked at Facebook')],
'answer': 'The user worked at Facebook.'}
有关作特定向量存储的详细信息,请参阅集成页面。