贡献模板
向 Langflow 提交模板时,请遵循这些最佳实践。
For template formatting examples, see the Langflow repository's starter_projects folder.
创建 PR 提交您的模板
按照以下步骤提交您的模板:
- 在 GitHub 上 Fork Langflow 仓库。
- 将您的
template.json
文件添加到您 fork 中的 Langflow 仓库的 starter_projects 文件夹中。 - 包含下面列出的模板提交必需项目。
- 从您的 fork 创建一个 Pull Request 到主 Langflow 仓库。
- 在 PR 中包含您模板的截图。
Langflow 团队将审查您的 PR,提供反馈,并合并模板。
模板提交必需项目
提交模板时,请包含以下项目并遵循这些准则。
名称
模板名称必须简洁,不超过三个单词。 只大写每个单 词的首字母。 例如:Blog Writer 或 Travel Planning Agent。
描述
描述在 UI 中显示,用于引导用户使用您的模板。
描述应该简洁且信息丰富,说明模板的功能和预期用例。
For example:json "description": "Auto-generate a customized blog post from instructions and referenced articles.",
图标
使用 Lucide 图标库中的图标。
流程
只使用侧边栏中可用的组件。 不要使用自定义组件。
包含一个指导用户的注释。注释支持 Markdown 语法。 通常一个注释就足够了。
For example:
_17# Financial Assistant Agents_17_17The Financial Assistant Agent retrieves web content and writes reports about finance._17_17## Prerequisites_17_17* [OpenAI API Key](https://platform.openai.com/)_17* [Tavily AI Search key](https://docs.tavily.com/welcome)_17* [Sambanova API key](https://sambanova.ai/)_17_17## Quickstart_17_171. In both **Agent** components, add your OpenAI API key._172. In the **Model Provider** field, select **Sambanova**, and select a model._173. In the **Sambanova** component, add your **Sambanova API key**._174. In the **Tavily Search** component, add your **Tavily API key**._175. Click the **Playground** and ask `Why did Nvidia stock drop in January?`
格式
以 JSON 格式提交模板。
标签
将模板分配到以下类别之一:
- Assistants(助手)
- Classification(分类)
- Coding(编程)
- Content Generation(内容生成)
- Q&A(问答)
- Prompting(提示)
- RAG
- Agents(代理)
For more information, see the Langflow repository's template categories.