棱镜
为了使用向量搜索增强 PostgreSQL 数据库中的现有模型,Langchain 支持将棱镜与 PostgreSQL 和pgvector
Postgres 扩展一起使用。
设置
使用 Supabase 设置数据库实例
请参阅棱镜和 Supabase 集成指南,以使用 Supabase 和棱镜设置新的数据库实例。
安装棱镜
- npm
- Yarn
- pnpm
npm install prisma
yarn add prisma
pnpm add prisma
使用 docker-compose
设置 pgvector
自托管实例
pgvector
提供一个预构建的 Docker 镜像,可用于快速设置自托管 Postgres 实例。
services:
db:
image: ankane/pgvector
ports:
- 5432:5432
volumes:
- db:/var/lib/postgresql/data
environment:
- POSTGRES_PASSWORD=
- POSTGRES_USER=
- POSTGRES_DB=
volumes:
db:
创建新的模式
假设你尚未创建模式,请创建一个新的模型,其中包含类型为 Unsupported("vector")
的 vector
字段。
model Document {
id String @id @default(cuid())
content String
vector Unsupported("vector")?
}
之后,使用 --create-only
创建新的迁移,以避免直接运行迁移。
- npm
- Yarn
- pnpm
npx prisma migrate dev --create-only
npx prisma migrate dev --create-only
npx prisma migrate dev --create-only
将以下行添加到新创建的迁移中,以启用 pgvector
扩展(如果尚未启用)。
CREATE EXTENSION IF NOT EXISTS vector;
之后运行迁移。
- npm
- Yarn
- pnpm
npx prisma migrate dev
npx prisma migrate dev
npx prisma migrate dev
用法
提示
- npm
- Yarn
- pnpm
npm install @langchain/openai @langchain/community
yarn add @langchain/openai @langchain/community
pnpm add @langchain/openai @langchain/community
危险
表名和列名(在 tableName
、vectorColumnName
、columns
和 filter
等字段中)将直接传递到 SQL 查询中,不会进行参数化。必须事先对这些字段进行消毒,以避免 SQL 注入。
import { PrismaVectorStore } from "@langchain/community/vectorstores/prisma";
import { OpenAIEmbeddings } from "@langchain/openai";
import { PrismaClient, Prisma, Document } from "@prisma/client";
export const run = async () => {
const db = new PrismaClient();
// Use the `withModel` method to get proper type hints for `metadata` field:
const vectorStore = PrismaVectorStore.withModel<Document>(db).create(
new OpenAIEmbeddings(),
{
prisma: Prisma,
tableName: "Document",
vectorColumnName: "vector",
columns: {
id: PrismaVectorStore.IdColumn,
content: PrismaVectorStore.ContentColumn,
},
}
);
const texts = ["Hello world", "Bye bye", "What's this?"];
await vectorStore.addModels(
await db.$transaction(
texts.map((content) => db.document.create({ data: { content } }))
)
);
const resultOne = await vectorStore.similaritySearch("Hello world", 1);
console.log(resultOne);
// create an instance with default filter
const vectorStore2 = PrismaVectorStore.withModel<Document>(db).create(
new OpenAIEmbeddings(),
{
prisma: Prisma,
tableName: "Document",
vectorColumnName: "vector",
columns: {
id: PrismaVectorStore.IdColumn,
content: PrismaVectorStore.ContentColumn,
},
filter: {
content: {
equals: "default",
},
},
}
);
await vectorStore2.addModels(
await db.$transaction(
texts.map((content) => db.document.create({ data: { content } }))
)
);
// Use the default filter a.k.a {"content": "default"}
const resultTwo = await vectorStore.similaritySearch("Hello world", 1);
console.log(resultTwo);
};
API 参考
- PrismaVectorStore 来自
@langchain/community/vectorstores/prisma
- OpenAIEmbeddings 来自
@langchain/openai
以下 SQL 运算符可用作过滤器:equals
、in
、isNull
、isNotNull
、like
、lt
、lte
、gt
、gte
、not
。
以上示例使用以下模式
// This is your Prisma schema file,
// learn more about it in the docs: https://pris.ly/d/prisma-schema
generator client {
provider = "prisma-client-js"
}
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
model Document {
id String @id @default(cuid())
content String
namespace String? @default("default")
vector Unsupported("vector")?
}
API 参考
如果不需要,可以删除 namespace
。