跳到主要内容
Open In ColabOpen on GitHub

Xata

Xata 是一个基于 PostgreSQLElasticsearch 的无服务器数据平台。它提供了一个 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。这用于存储 Document.pageContent 值。
  • 类型为“向量”的 embedding。 使用您计划使用的模型使用的维度。 在本笔记本中,我们使用 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
)

现在是时候创建一个 Agent 来同时使用向量存储和聊天内存了。

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?")

此页是否对您有帮助?