self-query-supabase

这个模板允许对 Supabase 进行自然语言结构化查询。

Supabase 是 Firebase 的开源替代品，构建在 PostgreSQL 之上。

它使用 pgvector 在您的表中存储嵌入。

环境设置

设置 OPENAI_API_KEY 环境变量以访问 OpenAI 模型。

要获取您的 OPENAI_API_KEY，请转到您的 OpenAI 帐户的 API keys，然后创建一个新的秘密密钥。

要找到您的 SUPABASE_URL 和 SUPABASE_SERVICE_KEY，请转到您的 Supabase 项目的 API settings。

• SUPABASE_URL 对应项目 URL

• SUPABASE_SERVICE_KEY 对应 service_role API 密钥

export SUPABASE_URL=
export SUPABASE_SERVICE_KEY=
export OPENAI_API_KEY=

设置 Supabase 数据库

如果您还没有设置 Supabase 数据库，请按以下步骤进行设置。

1. 前往 https://database.new 以配置您的 Supabase 数据库。

2. 在工作室中，转到 SQL editor，并运行以下脚本以启用 pgvector 并将您的数据库设置为向量存储：

   -- 启用 pgvector 扩展以处理嵌入向量
   create extension if not exists vector;
   -- 创建一个表来存储您的文档
   create table
     documents (
       id uuid primary key,
       content text, -- 对应 Document.pageContent
       metadata jsonb, -- 对应 Document.metadata
       embedding vector (1536) -- 1536 适用于 OpenAI 嵌入，根据需要进行更改
     );
   -- 创建一个用于搜索文档的函数
   create function match_documents (
     query_embedding vector (1536),
     filter jsonb default '{}'
   ) returns table (
     id uuid,
     content text,
     metadata jsonb,
     similarity float
   ) language plpgsql as $$
   #variable_conflict use_column
   begin
     return query
     select
       id,
       content,
       metadata,
       1 - (documents.embedding <=> query_embedding) as similarity
     from documents
     where metadata @> filter
     order by documents.embedding <=> query_embedding;
   end;
   $$;

使用

要使用此软件包，请首先安装 LangChain CLI：

pip install -U langchain-cli

创建一个新的 LangChain 项目，并将此软件包安装为唯一软件包：

langchain app new my-app --package self-query-supabase

要将其添加到现有项目中，请运行：

langchain app add self-query-supabase

将以下代码添加到您的 server.py 文件中：

from self_query_supabase.chain import chain as self_query_supabase_chain
add_routes(app, self_query_supabase_chain, path="/self-query-supabase")

（可选）如果您可以访问 LangSmith，请配置它以帮助跟踪、监视和调试 LangChain 应用程序。如果您无法访问，请跳过此部分。

export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_API_KEY=<your-api-key>
export LANGCHAIN_PROJECT=<your-project>  # 如果未指定，默认为 "default"

如果您在此目录中，则可以直接启动 LangServe 实例：

langchain serve

这将在本地启动一个带有服务器的 FastAPI 应用程序，运行在

http://localhost:8000

您可以在 http://127.0.0.1:8000/docs 查看所有模板

在 http://127.0.0.1:8000/self-query-supabase/playground 访问 playground

通过以下代码从代码中访问模板：

from langserve.client import RemoteRunnable
runnable = RemoteRunnable("http://localhost:8000/self-query-supabase")

TODO: 设置 Supabase 数据库并安装软件包的说明。