CloudflareWorkersAIEmbeddings

这将帮助您开始使用 Cloudflare Workers AI 嵌入模型，使用 LangChain。有关 CloudflareWorkersAIEmbeddings 功能和配置选项的详细文档，请参阅API 参考。

概述

集成详细信息

类	包	本地	Py 支持	包下载	包最新
CloudflareWorkersAIEmbeddings	@langchain/cloudflare	❌	❌

设置

要访问 Cloudflare 嵌入模型，您需要创建一个 Cloudflare 帐户并安装 @langchain/cloudflare 集成包。此集成旨在在 Cloudflare worker 中运行并接受绑定。

按照官方文档设置您的 worker。

您的 wrangler.toml 文件应该类似于以下内容

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

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

[ai]
binding = "AI"

凭据

如果您想自动跟踪您的模型调用，您还可以通过取消注释以下内容来设置您的LangSmith API 密钥

# export LANGCHAIN_TRACING_V2="true"
# export LANGCHAIN_API_KEY="your-api-key"

安装

LangChain CloudflareWorkersAIEmbeddings 集成位于 @langchain/cloudflare 包中

提示

查看此部分了解有关安装集成包的一般说明。

npm

npm i @langchain/cloudflare

yarn

yarn add @langchain/cloudflare

pnpm

pnpm add @langchain/cloudflare

用法

以下是一个使用 Workers AI 嵌入和Cloudflare Vectorize 向量存储的 worker 示例。

// @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 参考

有关所有 CloudflareWorkersAIEmbeddings 功能和配置的详细文档，请访问 API 参考：https://api.js.langchain.com/classes/langchain_cloudflare.CloudflareWorkersAIEmbeddings.html

相关

• 嵌入模型 概念指南
• 嵌入模型 操作指南