Xata
Xata 是一个无服务器数据平台,基于
PostgreSQL
和Elasticsearch
。它提供了一个 Python SDK 用于与数据库交互,以及一个用于管理数据的 UI。通过XataChatMessageHistory
类,您可以使用 Xata 数据库进行聊天会话的长期持久化。
本笔记本涵盖了
- 一个简单示例,展示
XataChatMessageHistory
的功能。 - 一个更复杂的示例,使用 REACT 代理,该代理根据知识库或文档(存储在 Xata 中作为向量存储)回答问题,并拥有可搜索的长期历史消息(存储在 Xata 中作为内存存储)
设置
创建数据库
在 Xata UI 中创建一个新数据库。您可以随意命名,在本笔记中我们将使用 langchain
。Langchain 集成可以自动创建用于存储内存的表,这正是我们将在本示例中使用的。如果您想预先创建表,请确保其具有正确的模式,并在创建类时将 create_table
设置为 False
。预先创建表可以在每次会话初始化时节省一次数据库往返。
我们首先安装依赖项
%pip install --upgrade --quiet xata langchain-openai langchain langchain-community
接下来,我们需要获取 Xata 的环境变量。您可以通过访问账户设置创建新的 API 密钥。要查找数据库 URL,请转到您创建的数据库的“设置”页面。数据库 URL 应该看起来像这样:https://demo-uni3q8.eu-west-1.xata.sh/db/langchain
。
import getpass
api_key = getpass.getpass("Xata API key: ")
db_url = input("Xata database URL (copy it from your DB settings):")
创建一个简单的内存存储
为了单独测试内存存储功能,让我们使用以下代码片段:
from langchain_community.chat_message_histories import XataChatMessageHistory
history = XataChatMessageHistory(
session_id="session-1", api_key=api_key, db_url=db_url, table_name="memory"
)
history.add_user_message("hi!")
history.add_ai_message("whats up?")
上述代码创建了一个 ID 为 session-1
的会话,并在其中存储了两条消息。运行上述代码后,如果您访问 Xata UI,您应该会看到一个名为 memory
的表,其中添加了两条消息。
您可以使用以下代码检索特定会话的消息历史记录:
history.messages
在您的数据上使用内存的对话式问答链
现在让我们看一个更复杂的示例,其中我们结合 OpenAI、Xata 向量存储集成和 Xata 内存存储集成,在您的数据上创建一个具有后续问题和历史记录的问答聊天机器人。
我们需要访问 OpenAI API,因此我们来配置 API 密钥:
import os
if "OPENAI_API_KEY" not in os.environ:
os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API Key:")
要存储聊天机器人将搜索答案的文档,请使用 Xata UI 在 langchain
数据库中添加一个名为 docs
的表,并添加以下列:
content
类型为“Text”。这用于存储Document.pageContent
值。embedding
类型为“Vector”。使用您计划使用的模型所使用的维度。在本笔记本中,我们使用 OpenAI 嵌入,其维度为 1536。
让我们创建向量存储并向其中添加一些示例文档:
from langchain_community.vectorstores.xata import XataVectorStore
from langchain_openai import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
texts = [
"Xata is a Serverless Data platform based on PostgreSQL",
"Xata offers a built-in vector type that can be used to store and query vectors",
"Xata includes similarity search",
]
vector_store = XataVectorStore.from_texts(
texts, embeddings, api_key=api_key, db_url=db_url, table_name="docs"
)
运行上述命令后,如果您进入 Xata UI,您应该会看到文档及其嵌入加载到 docs
表中。
现在让我们创建一个 ConversationBufferMemory 来存储来自用户和 AI 的聊天消息。
from uuid import uuid4
from langchain.memory import ConversationBufferMemory
chat_memory = XataChatMessageHistory(
session_id=str(uuid4()), # needs to be unique per user session
api_key=api_key,
db_url=db_url,
table_name="memory",
)
memory = ConversationBufferMemory(
memory_key="chat_history", chat_memory=chat_memory, return_messages=True
)
现在是时候创建一个代理来同时使用向量存储和聊天内存了。
from langchain.agents import AgentType, initialize_agent
from langchain.agents.agent_toolkits import create_retriever_tool
from langchain_openai import ChatOpenAI
tool = create_retriever_tool(
vector_store.as_retriever(),
"search_docs",
"Searches and returns documents from the Xata manual. Useful when you need to answer questions about Xata.",
)
tools = [tool]
llm = ChatOpenAI(temperature=0)
agent = initialize_agent(
tools,
llm,
agent=AgentType.CHAT_CONVERSATIONAL_REACT_DESCRIPTION,
verbose=True,
memory=memory,
)
为了测试,我们来告诉代理我们的名字:
agent.run(input="My name is bob")
现在,我们来问代理一些关于 Xata 的问题:
agent.run(input="What is xata?")
请注意,它是根据文档存储中的数据进行回答的。现在,我们来问一个后续问题:
agent.run(input="Does it support similarity search?")
现在我们来测试它的记忆:
agent.run(input="Did I tell you my name? What is it?")