这将帮助您开始使用 Cloudflare Workers AI 嵌入模型 使用 LangChain。如需详细文档 CloudflareWorkersAIEmbeddings 关于功能和配置选项,请参阅 API 参考.
概述
集成详情
| 类 | 包 | 本地 | Py 支持 | 下载量 | 版本 |
|---|---|---|---|---|---|
CloudflareWorkersAIEmbeddings | @langchain/cloudflare | ❌ | ❌ | !NPM - 下载量 | !NPM - 版本 |
设置
要访问 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 LANGSMITH_TRACING="true"
# export LANGSMITH_API_KEY="your-api-key"
安装
LangChain CloudflareWorkersAIEmbeddings 集成位于 @langchain/cloudflare package:
npm install @langchain/cloudflare @langchain/core
yarn add @langchain/cloudflare @langchain/core
pnpm add @langchain/cloudflare @langchain/core
用法
以下是一个使用 Workers AI 嵌入的示例 worker,配合 Cloudflare Vectorize 向量存储.
// @ts-nocheck
VectorizeIndex,
Fetcher,
Request,
} from "@cloudflare/workers-types";
CloudflareVectorizeStore,
CloudflareWorkersAIEmbeddings,
} from "@langchain/cloudflare";
VECTORIZE_INDEX: VectorizeIndex;
AI: Fetcher;
}
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 参考.