主题
发布集成
让你的集成可供社区使用。
WARNING
不要向 LangChain 或 Deep Agents 仓库提交集成 PR。
新的集成应作为独立的 PyPI 包发布在你自己的 GitHub 组织或账户下(例如 langchain-yourservice),而不是作为 PR 提交到 langchain-ai/langchain 仓库。
主仓库只包含由 LangChain 团队维护的一小部分第一方集成(如 OpenAI、Anthropic 和 Ollama)。
既然你的包已经实现并测试完毕,现在可以发布并列出它,以便社区能够发现它。
发布你的包
就本指南而言,我们将使用 PyPI 作为包注册表。如果你愿意,也可以选择发布到其他注册表;具体说明会有所不同。
设置凭证
首先,确保你拥有一个 PyPI 账户:
如何创建 PyPI Token
创建账户
前往 PyPI 网站并创建一个账户
验证邮箱
点击 PyPI 通过电子邮件发送给你的链接,验证你的邮箱地址
启用 2FA
前往你的账户设置,点击 "Generate Recovery Codes" 以启用 2FA。要生成 API token,你必须启用 2FA
生成 token
前往你的账户设置并生成新的 API token
构建并发布
How to publish a package
来自 uv 的实用指南,介绍如何构建包并将其发布到 PyPI。
让你的集成可被发现
发布后,在 LangChain 文档仓库中提交一个 Integration listing issue,以便你的包出现在集成标签页下。
维护者会审查该 issue 并应用 integration-run 标签。这会启动自动化流程,它会读取表单字段,应用下方的资格规则,并打开一个拉取请求,在其中标记维护者和你以进行审查。表单中请优先使用合作伙伴文档 URL。
除非维护者要求,否则不要为新的上架手动打开文档 PR。
托管指南的资格
只有当满足以下任一条件时,LangChain 才会在此文档仓库中托管完整的集成指南:
- 该包在 PyPI(TypeScript 则为 npm)上每月至少有 50,000 次下载,或
- 维护者将该集成标记为推荐(featured)
如果你不满足任一条件,自动化会添加一个外部上架(YAML + 下载表 + 服务商卡片),链接到你自己的文档。它不会添加托管的 MDX 页面。
在下载表中列出(默认)
File an Integration listing issue
使用固定的表单字段填写显示名称、语言、组件、包名、文档 URL,以及简短的服务商描述。
自动化会根据你的 issue 填充 scripts/data/integration_external_docs.yaml 及相关的上架界面。
每个上架条目至少需要:
name:LangChain 类名或显示名称(例如ChatAI21)。pypi或npm:用于下载量徽章的注册表包名。docs_url:名称列的链接。优先合作伙伴文档,其次是 GitHub 仓库,然后是 PyPI 或 npm 页面。
可选地,在 issue 表单中包含组件特定的能力标志(例如聊天 stream 和 tool_calling),以便表格列保持准确。
合并后,刷新任务会重新生成组件表格片段,使你的行与托管集成一起显示。
INFO
此流程仅用于上架元数据。请将你的使用文档托管在你自己的站点或 GitHub README 上。你的集成包本身应位于你自己 GitHub 组织或账户下的独立仓库中,并作为独立包发布。
托管指南(50K+ 或推荐)
如果你的包满足资格标准,Integration listing 自动化可以基于以下模板之一打开一个包含文档页面的 PR。维护者也可能会要求你手动撰写或修订托管页面。
根据你所构建的集成类型,你需要创建不同类型的文档页面。LangChain 为不同类型的集成提供了模板,以帮助你入门。
TIP
要参考现有文档,你可以查看集成列表,找到与你类似的集成。
要以原始 markdown 查看某个文档页面,请使用页面右上角 "Copy page" 旁边的下拉按钮,并选择 "View as Markdown"。
如果你被要求手动编辑托管页面,请 fork LangChain 文档仓库(而不是主 langchain 仓库),遵循相应的模板,并遵循文档指南。
如果你的包之前已在 integration_external_docs.yaml 中列出,请在同一 PR 中移除该 YAML 条目,以免表格显示重复行。
除非维护者要求,否则不要在 frontmatter 中设置 featured: true。推荐状态由维护者决定。
INFO
托管指南 PR 仅用于文档。你的集成包本身应位于你自己 GitHub 组织或账户下的独立仓库中,并作为独立包发布。
WARNING
在以下情况下,我们可能会拒绝上架 issue 或 PR,或要求修改:
- 在请求托管页面时,该包不符合托管指南资格标准
- CI 检查失败
- 存在严重的语法错误或拼写错误
- Mintlify 组件使用不当
- 页面缺少 frontmatter
- 缺少本地化(在适用的情况下)
- 代码示例无法运行或有错误
- 未达到质量标准
由于我们要处理大量提交,请保持耐心。自动 PR 打开后请予以审查。不要就你的 issue 或 PR 反复 @ 维护者。
NOTE
如果 PR 包含 AI 生成的内容,你必须遵循我们的 LLM 可接受用途政策。
后续步骤
恭喜! 你的集成已发布并面向 LangChain 社区上架。
Co-marketing
联系 LangChain 市场团队,探索联合营销机会。