尧图网站设计 尧图网站设计YAOTU DESIGN
ARTICLE DETAIL

资讯详情

深耕网站设计与一线实操的经验洞察。

LangChain.js × Exa:@langchain/exa 集成包的检索器、工具与工程化实践

LangChain.js × Exa:@langchain/exa 集成包的检索器、工具与工程化实践 LangChain.js × Exalangchain/exa 集成包的检索器、工具与工程化实践【免费下载链接】langchainjsThe agent engineering platform项目地址: https://gitcode.com/GitHub_Trending/la/langchainjs导读langchain/exa是 LangChain.js 官方提供的 Exa 集成包通过官方 SDKexa-js将 Exa 的神经搜索Neural Search与 Find Similar 能力接入 LangChain 生态让开发者可以直接以标准BaseRetriever和Tool接口使用 Exa 进行网页搜索与相似内容发现。读完本文你将掌握该包的安装方式、ExaRetriever检索器与ExaSearchResults/ExaFindSimilarResults两个工具类的完整用法以及本仓库中该包的构建、测试、Lint 与新增入口点等工程化开发流程。一、包概览Exa 集成在 LangChain.js 中的定位Exa 是一家以神经搜索为核心的搜索服务提供商其 API 面向语义检索、AI 研究助手、RAG 应用等场景。langchain/exa包package.json封装了 Exa 的 SDK当前版本为1.0.2其描述为 Exa integration for LangChain.js。从源码结构看该包的功能面非常聚焦仅暴露两类能力见 src/index.ts检索器RetrieverExaRetriever将 Exa 搜索结果转换为 LangChain 标准的Document列表可直接用于 RAG 链路。工具ToolsExaSearchResults关键词/语义搜索与ExaFindSimilarResultsURL 相似内容发现可交给 Agent 或 Chat Model 作为工具调用。// src/index.ts 全文 export * from ./retrievers.js; export * from ./tools.js;该包的依赖关系也很简洁运行时仅依赖exa-js^1.10.3并将langchain/core^1.0.0声明为 peer dependency说明它与 LangChain v1.0 对齐见 CHANGELOG.md 中 1.0.0 版本的说明。包的exports字段同时提供了requireCJSdist/index.cjs与importESMdist/index.js双入口及对应类型声明保证 Node.js 各模块体系下都能正常引用。二、安装与 LangChain 其他集成包一致安装langchain/exa时还需要同时安装langchain/core因为 peer dependency 要求由使用者显式提供npm install langchain/exa langchain/core如果需要从源码仓库构建或直接使用exa-js类型也可以显式安装 SDKnpm install langchain/exa exa-js仓库使用 pnpm workspace 管理见根目录 pnpm-workspace.yaml包目录位于 libs/providers/langchain-exa。三、核心用法检索器与工具3.1 ExaRetriever将搜索结果转为 DocumentExaRetriever继承自langchain/core/retrievers的BaseRetriever命名空间为[langchain, retrievers, exa]见 src/retrievers.ts。其构造参数ExaRetrieverFields包含两个核心字段字段类型说明clientExaexa-js SDK 实例构造时可传入 API Key 与可选的 Base URLsearchArgsRegularSearchOptions T透传给 Exa 搜索接口的配置如numResults、text等默认泛型T为{ text: true }最小可运行示例import { ExaRetriever } from langchain/exa; import Exa from exa-js; const retriever new ExaRetriever({ client: new Exa( process.env.EXA_API_KEY, process.env.EXA_BASE_URL, // 可选默认为 Exa 官方端点 ), }); const docs await retriever.getRelevantDocuments(hello);底层调用链src/retrievers.ts 的_getRelevantDocuments方法为调用client.searchAndContentsT(query, searchArgs)获取SearchResponseT遍历res.results按优先级取正文优先取result.text若结果只有高亮片段highlights则用\n\n连接两者皆无则回退为字符串No results found.使用_getMetadata将结果中除text外的字段如title、url、publishedDate、author、score、id整体放入Document.metadata。_getMetadata的实现专门删除了text字段避免正文被重复放入元数据造成冗余export function _getMetadataT extends ContentsOptions { text: true }( result: SearchResultT ): Recordstring, unknown { const newMetadata: Recordstring, unknown { ...result }; delete newMetadata.text; return newMetadata; }这一行为有单元测试直接约束src/tests/retrievers.test.ts 构造了一个包含text字段的假结果断言_getMetadata的输出中不包含text。集成测试 src/tests/retrievers.int.test.ts 则验证了真实搜索能返回结果且metadata.url、metadata.id均已填充可作为 RAG 链路中元数据过滤的依据。3.2 ExaSearchResults作为 Agent 工具的搜索能力ExaSearchResults继承自langchain/core/tools的Tool见 src/tools.ts默认工具名name为exa_search_results_json描述为 A wrapper around Exa Search. Input should be an Exa-optimized query. Output is a JSON array of the query results。import { ExaSearchResults } from langchain/exa; import Exa from exa-js; const client new Exa(process.env.EXASEARCH_API_KEY); const tool new ExaSearchResults({ client, searchArgs: { numResults: 2, }, }); // 直接调用 await tool.invoke(what is the current weather in sf?); // 也可以传入模型生成的 ToolCall 对象调用 const modelGeneratedToolCall { args: { input: what is the current weather in sf? }, id: tool_call_id, name: tool.name, type: tool_call, }; await tool.invoke(modelGeneratedToolCall);其_call实现将client.searchAndContentsT(input, searchArgs)的完整响应用JSON.stringify序列化为字符串返回模型或 Agent 可以直接从 JSON 中读取results数组。3.3 ExaFindSimilarResults基于 URL 的相似内容发现ExaFindSimilarResults与搜索工具结构一致区别在于它调用的是 Exa 的 Find Similar 接口client.findSimilarAndContentsT(url, searchArgs)输入不再是自然语言查询而是一个 URL用于寻找语义相似或内容相关的网页。默认工具名为exa_find_similar_results_jsonimport { ExaFindSimilarResults } from langchain/exa; import Exa from exa-js; const tool new ExaFindSimilarResults{ text: true }({ client: new Exa(), }); const toolData await tool.invoke(https://langchain.com); const parsed JSON.parse(toolData); console.log(parsed.results);该用法同样有集成测试覆盖src/tests/tools.int.test.ts 分别验证了ExaSearchResults输入查询字符串、ExaFindSimilarResults输入 URL 后返回的 JSON 均包含非空results数组。3.4 泛型参数说明三个类ExaRetriever、ExaSearchResults、ExaFindSimilarResults都支持泛型T extends ContentsOptions默认值为{ text: true }用于声明你希望 Exa 返回的正文类型。例如需要高亮片段时可传入包含highlights的选项类型检索器在text in result与highlights in result之间自动选择正文来源。使用方式和exa-js的类型系统保持一致读者可参考该包的类型定义按需定制。四、作为包开发者构建、测试与质量流程该 README 同时给出了在仓库内开发该包的标准流程适用于想要为langchain/exa贡献代码或维护本地 fork 的开发者。4.1 安装依赖在仓库根目录执行 pnpm 安装工作区会同时解析该包与langchain/core的 workspace 依赖pnpm install4.2 构建在包目录内直接构建或从仓库根目录按 filter 定向构建package.json 中build脚本实际委托给 turbo 与 tsdownpnpm build从仓库根目录pnpm build --filter langchain/exa构建配置见 tsdown.config.ts入口为./src/index.ts产物输出到dist/并附带CHANGELOG.md、README.md、LICENSE等文件。4.3 运行测试测试文件约定放在src/下的tests/目录内单元测试文件名以.test.ts结尾运行pnpm test集成测试文件名以.int.test.ts结尾需要真实网络请求与 API Key运行pnpm test:int。pnpm test pnpm test:int两种测试模式分别由 vitest 的普通模式与int模式驱动见 package.json 中test/test:int脚本。本包现有测试覆盖了_getMetadata单元行为、ExaRetriever真实检索以及两个工具的调用链路可作为新增功能时的参考模板。4.4 Lint 与格式化pnpm lint pnpm formatlint脚本包含 ESLint 静态检查lint:eslint与 dpdm 循环依赖检测lint:dpdm两道关卡format使用 Prettier 统一源码风格。4.5 新增导出入口如果为包新增了对外导出的文件有两种方式接入发布产物在 src/index.ts 中import并重新export或在该包 package.json 的exports字段中新增条目然后运行pnpm build让 tsdown 生成新入口点。完成上述任一操作后重新构建即可保证新入口进入dist/并在发布时随包分发。五、仓库中的验证证据与延伸阅读包元数据与脚本libs/providers/langchain-exa/package.json统一导出入口libs/providers/langchain-exa/src/index.ts检索器实现libs/providers/langchain-exa/src/retrievers.ts工具实现libs/providers/langchain-exa/src/tools.ts单元与集成测试src/tests/retrievers.test.ts、src/tests/retrievers.int.test.ts、src/tests/tools.int.test.ts版本演进记录libs/providers/langchain-exa/CHANGELOG.md需要说明的是本包仅负责接入层即把 Exa SDK 的能力适配成 LangChain 的 Retriever 与 Tool 接口搜索参数如numResults、正文选项等的具体语义由exa-js的类型定义决定实际使用时建议结合自己的应用场景如 RAG 检索增强、Agent 联网搜索、竞品页面相似分析调整searchArgs以平衡召回量与响应成本。【免费下载链接】langchainjsThe agent engineering platform项目地址: https://gitcode.com/GitHub_Trending/la/langchainjs创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表