贡献模板
向 Langflow 提交模板时,请遵循以下最佳实践。
有关模板格式示例,请参阅 Langflow 仓库中的 /starter_projects
。
创建 PR 提交您的模板
按照以下步骤提交您的模板:
- 在 GitHub 上 fork Langflow 仓库。
- 在您的 fork 中,将您的
template.json
文件添加到/starter_projects
。 - 包含模板提交所需的必要内容。
- 从您的 fork 创建一个 Pull Request (PR) 到主 Langflow 仓库。
- 在 PR 中包含您的模板截图。
Langflow 团队将审核您的 PR,提供反馈,并在批准后合并该模板。
模板提交的必要内容
提交模板时,请包含以下内容并遵循以下指南。
名称
模板名称必须简洁,不超过三个单词。 每个单词只首字母大写。 例如:Blog Writer 或 Travel Planning Agent。
描述
简明扼要的描述,显示在可视化编辑器中,帮助用户理解模板的用途和用例。 例如:
_10 "description": "根据说明和参考文章自动生成定制化的博客文章。",
图标
使用 Lucide 图标库中的图标。
流程
仅使用可视化编辑器中 Components 菜单中可用的组件。 不要使用自定义组件。
在注释中包含简短的 README、快速入门指南或其他重要信息。注释支持 Markdown 语法。 例如:
_17# 金融助手代理_17_17金融助手代理检索网络内 容并撰写金融报告。_17_17## 先决条件_17_17* [OpenAI API 密钥](https://platform.openai.com/api-keys)_17* [Tavily AI 搜索密钥](https://docs.tavily.com/welcome)_17* [Sambanova API 密钥](https://sambanova.ai/)_17_17## 快速入门_17_171. 在两个 **Agent** 组件中,添加您的 OpenAI API 密钥。_172. 在 **Model Provider** 字段中,选择 **Sambanova**,并选择一个模型。_173. 在 **Sambanova** 组件中,添加您的 **Sambanova API 密钥**。_174. 在 **Tavily Search** 组件中,添加您的 **Tavily API 密钥**。_175. 点击 **Playground** 并询问 `为什么英伟达股票在一月份下跌?`
格式
以 JSON 格式提交模板。
标签
将模板分配到以下类别之一:
- Assistants
- Classification
- Coding
- Content Generation
- Q&A
- Prompting
- RAG
- Agents
更多信息,请参阅 Langflow 仓库的模板类别。