Cloudflare Vectorize

如果您正在 Cloudflare worker 中部署项目，则可以将 Cloudflare Vectorize 与 LangChain.js 一起使用。 这是一个强大且方便的选项，它直接内置于 Cloudflare 中。

设置

兼容性

Cloudflare Vectorize 目前处于公开 Beta 测试阶段，需要 Cloudflare 付费计划帐户才能使用。

在设置您的项目后，通过运行以下 Wrangler 命令创建索引

$ npx wrangler vectorize create <index_name> --preset @cf/baai/bge-small-en-v1.5

您可以在官方文档中查看 vectorize 命令的完整选项列表。

然后，您需要更新您的 wrangler.toml 文件，以包含 [[vectorize]] 的条目

[[vectorize]]
binding = "VECTORIZE_INDEX"
index_name = "<index_name>"

最后，您需要安装 LangChain Cloudflare 集成包

提示

有关安装集成包的通用说明，请参阅此部分。

npm

npm install @langchain/cloudflare @langchain/core

Yarn

yarn add @langchain/cloudflare @langchain/core

pnpm

pnpm add @langchain/cloudflare @langchain/core

用法

以下是一个 worker 示例，它根据使用的路径，将文档添加到向量存储、查询向量存储或清除向量存储。它还使用了 Cloudflare Workers AI 嵌入。

注意

如果本地运行，请务必以 npx wrangler dev --remote 方式运行 wrangler！

name = "langchain-test"
main = "worker.ts"
compatibility_date = "2024-01-10"

[[vectorize]]
binding = "VECTORIZE_INDEX"
index_name = "langchain-test"

[ai]
binding = "AI"

// @ts-nocheck

import type {
  VectorizeIndex,
  Fetcher,
  Request,
} from "@cloudflare/workers-types";

import {
  CloudflareVectorizeStore,
  CloudflareWorkersAIEmbeddings,
} from "@langchain/cloudflare";

export interface Env {
  VECTORIZE_INDEX: VectorizeIndex;
  AI: Fetcher;
}

export default {
  async fetch(request: Request, env: Env) {
    const { pathname } = new URL(request.url);
    const embeddings = new CloudflareWorkersAIEmbeddings({
      binding: env.AI,
      model: "@cf/baai/bge-small-en-v1.5",
    });
    const store = new CloudflareVectorizeStore(embeddings, {
      index: env.VECTORIZE_INDEX,
    });
    if (pathname === "/") {
      const results = await store.similaritySearch("hello", 5);
      return Response.json(results);
    } else if (pathname === "/load") {
      // Upsertion by id is supported
      await store.addDocuments(
        [
          {
            pageContent: "hello",
            metadata: {},
          },
          {
            pageContent: "world",
            metadata: {},
          },
          {
            pageContent: "hi",
            metadata: {},
          },
        ],
        { ids: ["id1", "id2", "id3"] }
      );

      return Response.json({ success: true });
    } else if (pathname === "/clear") {
      await store.delete({ ids: ["id1", "id2", "id3"] });
      return Response.json({ success: true });
    }

    return Response.json({ error: "Not Found" }, { status: 404 });
  },
};

API 参考

• CloudflareVectorizeStore 来自 @langchain/cloudflare
• CloudflareWorkersAIEmbeddings 来自 @langchain/cloudflare

您还可以传递 filter 参数，以按先前加载的元数据进行过滤。 有关所需格式的信息，请参阅 官方文档。

相关内容

• 向量存储概念指南
• 向量存储操作指南