让您的集成对社区可用。
请勿将集成 PR 提交至 LangChain 或 Deep Agents 代码仓库。新的集成应作为 独立的 npm 包 发布到您自己的 GitHub 组织或账户下(例如,@your-org/langchain-yourservice),而不是作为 langchain-ai/langchainjs 仓库的 PR。主仓库仅包含 LangChain 团队维护的少量第一方集成。
将您的包发布到 npm,然后按照下方让您的集成可被发现操作。

让您的集成可被发现

发布后,在 LangChain 文档仓库 中提交一个 PR,以便您的包出现在集成标签页下。您提交哪种 PR 取决于是否有资格获得托管指南。

获得托管指南的资格

LangChain 仅在 以下任一条件满足时,才会在本文档仓库中托管完整的集成指南:
  • 该包在 PyPI(或 TypeScript 的 npm)上每月下载量至少达到 50,000 次,或者
  • 维护者将该集成标记为 精选
如果您不满足任一条件,请不要提交添加新文档页面的 PR。而是添加一个 YAML 列表项,使该包出现在组件下载表中,并链接到您自己的文档。

列入下载表(默认)

提交一个 PR,向 scripts/data/integration_external_docs.yaml 添加一个条目。 每个条目至少需要:
  • name:LangChain 类名或显示名称(例如,ChatAI21)。
  • pypi 或 npm:用于下载徽章的注册表包名。
  • docs_url:名称列的链接。优先使用合作伙伴文档,其次是 GitHub 仓库,最后是 PyPI 或 npm 页面。
可选地包含组件特定字段(例如,聊天能力标志如 stream 和 tool_calling),以使表格列保持准确。请遵循相同语言和组件部分的现有条目。 合并后,刷新作业会重新生成组件表格代码片段,使您的行与托管集成并排显示。
此 PR 仅用于列出元数据。请在您自己的网站或 GitHub README 上托管使用文档。您的集成包本身应位于您 GitHub 组织或账户下的独立仓库中,并作为独立包发布。

托管指南(50K+ 或精选)

如果您的包符合获得托管指南的资格,请使用以下模板之一创建文档页面,并在文档仓库中提交一个 PR。 根据您构建的集成类型,您需要创建不同类型的文档页面。LangChain 为不同类型的集成提供了模板以帮助您开始。

聊天模型

要参考现有文档,您可以查看集成列表并找到与您类似的集成。要以原始 Markdown 形式查看给定文档页面,请使用页面右上角 “Copy page” 旁边的下拉按钮,然后选择 “View as Markdown”。
在您的个人 GitHub 账户下,Fork LangChain 文档仓库(不是主 langchain 仓库),并将其克隆到本地。为您的集成创建一个新分支。复制模板,并使用您喜欢的 Markdown 文本编辑器进行修改。编写文档时,请务必参考并遵循文档指南。 如果您的包之前已列在 integration_external_docs.yaml 中,请在同一 PR 中移除该 YAML 条目,以避免表格中出现重复行。 除非维护者要求,否则请勿在 Frontmatter 中设置 featured: true。精选状态由维护者决定。
此 PR 仅用于文档。您的集成包本身应位于您 GitHub 组织或账户下的独立仓库中,并作为独立包发布。
如果出现以下情况,我们可能会拒绝 PR 或要求修改:
在我们处理大量 PR 期间,请您耐心等待。我们将尽快审核您的 PR 并提供反馈或将其合并。请不要反复标记维护者询问您的 PR 状态。
如果您的 PR 包含 AI 生成的内容,您必须遵循我们的LLM 可接受使用政策。

后续步骤

恭喜! 您的集成已发布并被列为 LangChain 社区可用。

联合营销

联系 LangChain 营销团队,探索联合营销机会。