Skip to content

让你的集成对社区可用。

重要提示:新的集成应该是独立的包,而不是提交到 LangChain 单仓库的 PR。

虽然 LangChain 在主仓库中维护了一小部分第一方和高使用率的集成(如 OpenAI、Anthropic 和 Ollama),但新的集成应该作为单独的 PyPI 包和仓库发布(例如 langchain-yourservice),用户需要与核心 LangChain 包一起安装。你不应该提交 PR 来直接将你的集成添加到主 LangChain 仓库。

现在你的包已经实现并测试完毕,你可以发布它并添加文档,使其能够被社区发现。

发布你的包 ​

本指南假设你已经实现了你的包并为其编写了测试。如果还没有,请参考实现指南和测试指南。

在本指南中,我们将使用 PyPI 作为包注册表。你也可以选择发布到其他注册表;具体说明会有所不同。

设置凭据 ​

首先,确保你有一个 PyPI 账户:

如何创建 PyPI 令牌

创建账户

访问 PyPI 网站 并创建一个账户

验证邮箱

点击 PyPI 发送给你的邮件中的链接来验证你的邮箱地址

启用 2FA

进入你的账户设置,点击"生成恢复代码"以启用双因素认证。要生成 API 令牌,你必须启用 2FA

生成令牌

进入你的账户设置,生成一个新的 API 令牌

构建和发布 ​

如何发布一个包

来自 uv 的有用指南,介绍如何构建包并发布到 PyPI。

添加文档 ​

要将你的包的文档添加到本网站的集成选项卡下,你需要创建相关的文档页面,并在 LangChain 文档仓库 中提交一个 PR。

编写文档 ​

根据你构建的集成类型,你需要创建不同类型的文档页面。LangChain 为不同类型的集成提供了模板,帮助你快速上手。

要参考现有文档,你可以查看集成列表并找到与你类似的集成。

要以原始 Markdown 格式查看某个文档页面,请使用页面右上角"复制页面"旁边的下拉按钮,并选择"以 Markdown 查看"。

提交 PR ​

在个人 GitHub 账户下 Fork LangChain 文档仓库,并在本地克隆它。为你的集成创建一个新的分支。复制模板并使用你喜欢的 Markdown 文本编辑器进行修改。在编写文档时,请务必参考并遵循文档指南。

在以下情况下,我们可能会拒绝 PR 或要求修改: - CI 检查失败 - 存在严重的语法错误或拼写错误 - Mintlify 组件 使用不正确 - 页面缺少 frontmatter - 缺少 本地化(如适用) - 代码示例 无法运行或有错误 - 未达到 质量标准

请耐心等待,因为我们处理的 PR 数量很大。我们会尽快审查你的 PR 并提供反馈或合并它。请不要反复标记维护者询问你的 PR。


后续步骤 ​

恭喜! 你的集成现已发布并完成文档编写,可供整个 LangChain 社区使用。

联合营销

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

LangChain 中文文档