diff --git a/zh_CN/SUMMARY.md b/zh_CN/SUMMARY.md index e537848..8f9999d 100644 --- a/zh_CN/SUMMARY.md +++ b/zh_CN/SUMMARY.md @@ -5,8 +5,8 @@ * [欢迎使用 Dify](README.md) * [特性与技术规格](getting-started/readme/features-and-specifications.md) * [模型供应商列表](getting-started/readme/model-providers.md) -* [使用云服务](getting-started/cloud.md) -* [部署社区版](getting-started/install-self-hosted/README.md) +* [云服务](getting-started/cloud.md) +* [社区版](getting-started/install-self-hosted/README.md) * [Docker Compose 部署](getting-started/install-self-hosted/docker-compose.md) * [本地源码启动](getting-started/install-self-hosted/local-source-code.md) * [单独启动前端 Docker 容器](getting-started/install-self-hosted/start-the-frontend-docker-container.md) @@ -26,29 +26,13 @@ * [接入 Ollama 部署的本地模型](guides/model-configuration/ollama.md) * [构建](guides/application-design/README.md) * [创建应用](guides/application-design/creating-an-application.md) + * [聊天助手](guides/application-design/conversation-application.md) + * [Agent](guides/application-design/agent.md) + * [文本生成应用](guides/application-design/text-generation-application.md) * [提示词编排](guides/application-design/prompt-engineering/README.md) - * [基础助手](guides/application-design/prompt-engineering/conversation-application.md) - * [智能助手（Agent）](guides/application-design/prompt-engineering/zhi-neng-zhu-shou-agent.md) - * [文本生成型应用](guides/application-design/prompt-engineering/text-generation-application.md) - * [提示词编排专家模式](guides/application-design/prompt-engineering/prompt-engineering-1/README.md) + * [提示词专家模式（已下线）](guides/application-design/prompt-engineering/prompt-engineering-1/README.md) * [提示词初始模版参考](guides/application-design/prompt-engineering/prompt-engineering-1/prompt-engineering-template.md) - * [标注回复](guides/application-design/annotation-reply.md) * [敏感内容审查](guides/application-design/moderation-tool.md) - * [扩展外部能力](guides/application-design/extension/README.md) - * [API 扩展](guides/application-design/extension/api\_based\_extension/README.md) - * [外部数据工具](guides/application-design/extension/api\_based\_extension/external\_data\_tool.md) - * [使用 Cloudflare Workers 部署 API Tools](guides/application-design/extension/api\_based\_extension/cloudflare\_workers.md) - * [敏感内容审查](guides/application-design/extension/api\_based\_extension/moderation.md) - * [代码扩展](guides/application-design/extension/code\_based\_extension/README.md) - * [外部数据工具](guides/application-design/extension/code\_based\_extension/external\_data\_tool.md) - * [敏感内容审查](guides/application-design/extension/code\_based\_extension/moderation.md) -* [发布](guides/application-publishing/README.md) - * [发布为公开 Web 站点](guides/application-publishing/launch-your-webapp-quickly/README.md) - * [Web 应用的设置](guides/application-publishing/launch-your-webapp-quickly/web-app-settings.md) - * [文本生成型应用](guides/application-publishing/launch-your-webapp-quickly/text-generator.md) - * [对话型应用](guides/application-publishing/launch-your-webapp-quickly/conversation-application.md) - * [基于 APIs 开发](guides/application-publishing/developing-with-apis.md) - * [基于前端组件再开发](guides/application-publishing/based-on-frontend-templates.md) * [工作流](guides/workflow/README.md) * [基本介绍](guides/workflow/introduce.md) * [关键概念](guides/workflow/key\_concept.md) @@ -83,8 +67,26 @@ * [工具配置](guides/tools/tool-configuration/README.md) * [StableDiffusion](guides/tools/tool-configuration/stable-diffusion.md) * [SearXNG](guides/tools/tool-configuration/searxng.md) -* [日志与标注](guides/logs.md) -* [团队协同](guides/workspace/README.md) +* [发布](guides/application-publishing/README.md) + * [发布为公开 Web 站点](guides/application-publishing/launch-your-webapp-quickly/README.md) + * [Web 应用的设置](guides/application-publishing/launch-your-webapp-quickly/web-app-settings.md) + * [文本生成型应用](guides/application-publishing/launch-your-webapp-quickly/text-generator.md) + * [对话型应用](guides/application-publishing/launch-your-webapp-quickly/conversation-application.md) + * [基于 APIs 开发](guides/application-publishing/developing-with-apis.md) + * [基于前端组件再开发](guides/application-publishing/based-on-frontend-templates.md) +* [标注](guides/biao-zhu/README.md) + * [日志与标注](guides/biao-zhu/logs.md) + * [标注回复](guides/biao-zhu/annotation-reply.md) +* [监测](guides/monitoring.md) +* [扩展](guides/extension/README.md) + * [API 扩展](guides/extension/api\_based\_extension/README.md) + * [外部数据工具](guides/extension/api\_based\_extension/external\_data\_tool.md) + * [使用 Cloudflare Workers 部署 API Tools](guides/extension/api\_based\_extension/cloudflare\_workers.md) + * [敏感内容审查](guides/extension/api\_based\_extension/moderation.md) + * [代码扩展](guides/extension/code\_based\_extension/README.md) + * [外部数据工具](guides/extension/code\_based\_extension/external\_data\_tool.md) + * [敏感内容审查](guides/extension/code\_based\_extension/moderation.md) +* [协同](guides/workspace/README.md) * [邀请与管理成员](guides/workspace/invite-and-manage-members.md) * [发现](guides/workspace/app/README.md) * [智聊](guides/workspace/app/chat.md) diff --git a/zh_CN/guides/application-design/prompt-engineering/zhi-neng-zhu-shou-agent.md b/zh_CN/guides/application-design/agent.md similarity index 68% rename from zh_CN/guides/application-design/prompt-engineering/zhi-neng-zhu-shou-agent.md rename to zh_CN/guides/application-design/agent.md index 10c8cbc..29f32ca 100644 --- a/zh_CN/guides/application-design/prompt-engineering/zhi-neng-zhu-shou-agent.md +++ b/zh_CN/guides/application-design/agent.md @@ -1,4 +1,4 @@ -# 智能助手（Agent） +# Agent ### 定义 @@ -8,19 +8,19 @@ 为了方便快速上手使用，您可以在“探索”中找到智能助手的应用模板，添加到自己的工作区，或者在此基础上进行自定义。在全新的 Dify 工作室中，你也可以从零编排一个专属于你自己的智能助手，帮助你完成财务报表分析、撰写报告、Logo 设计、旅程规划等任务。 -

探索-智能助手应用模板

+

探索-智能助手应用模板

在“工作室-助手型应用”内选择智能助手即可开始编排。 -

工作室-构建智能助手

+

工作室-构建智能助手

选择智能助手的推理模型，智能助手的任务完成能力取决于模型推理能力，我们建议在使用智能助手时选择推理能力更强的模型系列如 gpt-4 以获得更稳定的任务完成效果。 -

选择智能助手的推理模型

+

选择智能助手的推理模型

你可以在“提示词”中编写智能助手的指令，为了能够达到更优的预期效果，你可以在指令中明确它的任务目标、工作流程、资源和限制等。 -

编排智能助手的指令提示词

+

编排智能助手的指令提示词

### 添加助手需要的工具 @@ -30,7 +30,7 @@ 你可以直接使用 Dify 生态提供的第一方内置工具，或者轻松导入自定义的 API 工具（目前支持 OpenAPI / Swagger 和 OpenAI Plugin 规范）。 -

添加助手需要的工具

+

添加助手需要的工具

工具使用户可以在 Dify 上创建更强大的 AI 应用，如你可以为智能助理型应用（Agent）编排合适的工具，它可以通过任务推理、步骤拆解、调用工具完成复杂任务。另外工具也可以方便将你的应用与其他系统或服务连接，与外部环境交互，如代码执行、对专属信息源的访问等。 @@ -40,22 +40,22 @@ 在 Agent 配置中，你可以修改助手的迭代次数限制。 -

Function Calling 模式

+

Function Calling 模式

-

ReAct 模式

+

ReAct 模式

### 配置对话开场白 您可以为智能助手配置一套会话开场白和开场问题，配置的对话开场白将在每次用户初次对话中展示助手可以完成什么样的任务，以及可以提出的问题示例。 -

配置会话开场白和开场问题

+

配置会话开场白和开场问题

### 调试与预览 编排完智能助手之后，你可以在发布成应用之前进行调试与预览，查看助手的任务完成效果。 -

调试与预览

+

调试与预览

### 应用发布 -

应用发布为 Webapp

+

应用发布为 Webapp

diff --git a/zh_CN/guides/application-design/prompt-engineering/conversation-application.md b/zh_CN/guides/application-design/conversation-application.md similarity index 76% rename from zh_CN/guides/application-design/prompt-engineering/conversation-application.md rename to zh_CN/guides/application-design/conversation-application.md index ec71192..2a0fdb5 100644 --- a/zh_CN/guides/application-design/prompt-engineering/conversation-application.md +++ b/zh_CN/guides/application-design/conversation-application.md @@ -1,4 +1,4 @@ -# 助手型应用 +# 聊天助手 对话型应用采用一问一答模式与用户持续对话。 @@ -16,13 +16,13 @@ 在首页点击 “创建应用” 按钮创建应用。填上应用名称，应用类型选择**对话型应用**。 -
+
#### 第 2 步 编排应用 应用成功后会自动跳转到应用概览页。点击左侧菜单：**提示词编排** 来编排应用。 -
+
**2.1 填写提示词** @@ -34,33 +34,33 @@ > > 当我回准备好了后，开始提问。 -![](<../../../.gitbook/assets/image (80).png>) +![](<../../.gitbook/assets/image (80).png>) 为了更好的体验，我们加上对话开场白：`你好，{{name}}。我是你的面试官，Bob。你准备好了吗？` 添加开场白的方法是，点击左上角的 “添加功能” 按钮，打开 “对话开场白” 的功能： -
+
然后编辑开场白： -![](<../../../.gitbook/assets/image (28).png>) +![](<../../.gitbook/assets/image (28).png>) #### 2.2 添加上下文 -如果应用想基于私有的上下文对话来生成内容。可以用我们[数据集](../../knowledge-base/)功能。在上下文中点 “添加” 按钮来添加数据集。 +如果应用想基于私有的上下文对话来生成内容。可以用我们[数据集](../knowledge-base/)功能。在上下文中点 “添加” 按钮来添加数据集。 -![](<../../../.gitbook/assets/image (108).png>) +![](<../../.gitbook/assets/image (108).png>) **2.3 调试** 我们在右侧填写 用户输入，输入内容进行调试。 -![](<../../../.gitbook/assets/image (67).png>) +![](<../../.gitbook/assets/image (67).png>) 如果结果不理想，可以调整提示词和模型参数。点右上角点 模型名称 来设置模型的参数： -![](<../../../.gitbook/assets/image (76).png>) +![](<../../.gitbook/assets/image (76).png>) 我们支持模型 gpt-4。 @@ -72,6 +72,6 @@ 在概览页可以找到应用的分享地址。点 “预览按钮” 预览分享出去的应用。点 “分享” 按钮获得分享的链接地址。点 “设置” 按钮设置分享出去的应用信息。 -
+
如果想定制化分享出去的应用，可以 Fork 我们的开源的 [WebApp 的模版](https://github.com/langgenius/webapp-conversation)。基于模版改成符合你的情景与风格需求的应用。 diff --git a/zh_CN/guides/application-design/extension/README.md b/zh_CN/guides/application-design/extension/README.md deleted file mode 100644 index a76844c..0000000 --- a/zh_CN/guides/application-design/extension/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# 扩展 - -在创造 AI 应用的过程中，开发者面临着不断变化的业务需求和复杂的技术挑战。有效地利用扩展能力不仅可以提高应用的灵活性和功能性，还可以确保企业数据的安全性和合规性。Dify 提供了以下两种扩展方式： - -[api\_based\_extension](api\_based\_extension/ "mention") - -[code\_based\_extension](code\_based\_extension/ "mention") \ No newline at end of file diff --git a/zh_CN/guides/application-design/moderation-tool.md b/zh_CN/guides/application-design/moderation-tool.md index 61db4a8..0e7adbd 100644 --- a/zh_CN/guides/application-design/moderation-tool.md +++ b/zh_CN/guides/application-design/moderation-tool.md @@ -18,11 +18,10 @@ OpenAI 和大多数 LLM 公司提供的模型，都带有内容审查功能， ### 功能三： 敏感词审查 Moderation 扩展 -不同的企业内部往往有着不同的敏感词审查机制，企业在开发自己的 AI 应用如企业内部知识库 ChatBot，需要对员工输入的查询内容作敏感词审查。为此，开发者可以根据自己企业内部的敏感词审查机制写一个 API 扩展，具体可参考 [moderation.md](extension/api\_based\_extension/moderation.md "mention")，从而在 Dify 上调用，实现敏感词审查的高度自定义和隐私保护。 +不同的企业内部往往有着不同的敏感词审查机制，企业在开发自己的 AI 应用如企业内部知识库 ChatBot，需要对员工输入的查询内容作敏感词审查。为此，开发者可以根据自己企业内部的敏感词审查机制写一个 API 扩展，具体可参考 [moderation.md](../extension/api\_based\_extension/moderation.md "mention")，从而在 Dify 上调用，实现敏感词审查的高度自定义和隐私保护。

Moderation Settings

比如我们在自己的本地服务中自定义敏感词审查规则：不能查询有关美国总统的名字的问题。当用户在`query`变量输入"Trump"，则在对话时会返回 "Your content violates our usage policy." 测试效果如下：

Moderation Test

- diff --git a/zh_CN/guides/application-design/prompt-engineering/prompt-engineering-1/README.md b/zh_CN/guides/application-design/prompt-engineering/prompt-engineering-1/README.md index e77b104..95f7457 100644 --- a/zh_CN/guides/application-design/prompt-engineering/prompt-engineering-1/README.md +++ b/zh_CN/guides/application-design/prompt-engineering/prompt-engineering-1/README.md @@ -1,6 +1,6 @@ -# 提示词编排专家模式 +# 提示词专家模式（已下线） -在 Dify 创建应用的编排默认为**简易模式**，这很适合想要快速创建应用的非技术人员，比如你想创建一个企业知识库 Chatbot 或者文章摘要生成器，利用**简易模式**编排对话前提示词，添加变量，添加上下文等简易步骤即可发布一个完整的应用（可参考👉[conversation-application.md](../conversation-application.md "mention")[text-generation-application.md](../text-generation-application.md "mention")）。 +在 Dify 创建应用的编排默认为**简易模式**，这很适合想要快速创建应用的非技术人员，比如你想创建一个企业知识库 Chatbot 或者文章摘要生成器，利用**简易模式**编排对话前提示词，添加变量，添加上下文等简易步骤即可发布一个完整的应用（可参考👉[conversation-application.md](../../conversation-application.md "mention")[text-generation-application.md](../../text-generation-application.md "mention")）。 而如果你是一个熟练掌握使用 **OpenAI** 的 **Playground** 的技术人员，正想创建一个学习导师应用，需要在提示词中针对不同的教学模块位置嵌入不同的上下文和变量，就可以选择**专家模式。在此模式下你可以自由地编写完整的提示词，包括修改内置的提示词，调整上下文和聊天历史内容在提示词中的位置，设定必要参数等。如果你对 Chat 和 Complete 两种模型不陌生，现在专家模式**可以快速切换 Chat 和Complete 模型以满足你的需要，并且都适用于对话型应用和文本生成型应用。 @@ -143,7 +143,7 @@ And answer according to the language English. ### 6. 调试日志 -编排调试时不仅可以查看用户的输入和 LLM 的回复。在**专家模式**下，点击发送消息左上角图标，可以看到完整的提示词，方便开发者确认输入变量内容、上下文、聊天记录和查询内容是否符合预期。日志列表的相关说明请查看日志文档 👉 ： [logs.md](../../../logs.md "mention") +编排调试时不仅可以查看用户的输入和 LLM 的回复。在**专家模式**下，点击发送消息左上角图标，可以看到完整的提示词，方便开发者确认输入变量内容、上下文、聊天记录和查询内容是否符合预期。日志列表的相关说明请查看日志文档 👉 ： [logs.md](../../../biao-zhu/logs.md "mention") #### 6.1 **查看调试日志** diff --git a/zh_CN/guides/application-design/prompt-engineering/text-generation-application.md b/zh_CN/guides/application-design/text-generation-application.md similarity index 73% rename from zh_CN/guides/application-design/prompt-engineering/text-generation-application.md rename to zh_CN/guides/application-design/text-generation-application.md index 1a5cf2a..d7830a5 100644 --- a/zh_CN/guides/application-design/prompt-engineering/text-generation-application.md +++ b/zh_CN/guides/application-design/text-generation-application.md @@ -1,4 +1,4 @@ -# 文本生成型应用 +# 文本生成应用 文本生成类应用是一种能够根据用户提供的提示，自动生成高质量文本的应用。它可以生成各种类型的文本，例如文章摘要、翻译等。 @@ -16,13 +16,13 @@ 在首页点击 “创建应用” 按钮创建应用。填上应用名称，应用类型选择**文本生成应用**。 -

创建应用

+

创建应用

#### 第 2 步 编排应用 应用成功后会自动跳转到应用概览页。点击左侧菜单：**提示词编排** 来编排应用。 -
+
**2.1 填写前缀提示词** @@ -30,31 +30,31 @@ 我们在这里填写的提示词是：`将内容翻译成：{{language}}。内容如下：` -![](<../../../.gitbook/assets/image (65).png>) +![](<../../.gitbook/assets/image (65).png>) #### 2.2 添加上下文 -如果应用想基于私有的上下文对话来生成内容。可以用我们[数据集](../../knowledge-base/)功能。在上下文中点 “添加” 按钮来添加数据集。 +如果应用想基于私有的上下文对话来生成内容。可以用我们[数据集](../knowledge-base/)功能。在上下文中点 “添加” 按钮来添加数据集。 -![](<../../../.gitbook/assets/image (88).png>) +![](<../../.gitbook/assets/image (88).png>) #### 2.3 添加功能：生成更多类似的 生成更多类似可以一次生成多条文本，可在此基础上编辑并继续生成。点击左上角的 “添加功能” 来打开该功能。 -

打开更多类似的功能

+

打开更多类似的功能

**2.4 调试** 我们在右侧 输入变量 和 查询内容 进行调试。点 **“运行”** 按钮 查看运行的结果。 -![](<../../../.gitbook/assets/image (22).png>) +![](<../../.gitbook/assets/image (22).png>) 如果结果不理想，可以调整提示词和模型参数。点右上角点 模型名称 来设置模型的参数：
-

调整模型参数

+

调整模型参数

@@ -66,6 +66,6 @@ 在概览页可以找到应用的分享地址。点 “预览按钮” 预览分享出去的应用。点 “分享” 按钮获得分享的链接地址。点 “设置” 按钮设置分享出去的应用信息。 -
+
如果想定制化分享出去的应用，可以 Fork 我们的开源的[ WebApp 的模版](https://github.com/langgenius/webapp-text-generator)。基于模版改成符合你的情景与风格需求的应用。 diff --git a/zh_CN/guides/biao-zhu/README.md b/zh_CN/guides/biao-zhu/README.md new file mode 100644 index 0000000..3e6c5bb --- /dev/null +++ b/zh_CN/guides/biao-zhu/README.md @@ -0,0 +1,2 @@ +# 标注 + diff --git a/zh_CN/guides/application-design/annotation-reply.md b/zh_CN/guides/biao-zhu/annotation-reply.md similarity index 100% rename from zh_CN/guides/application-design/annotation-reply.md rename to zh_CN/guides/biao-zhu/annotation-reply.md diff --git a/zh_CN/guides/logs.md b/zh_CN/guides/biao-zhu/logs.md similarity index 74% rename from zh_CN/guides/logs.md rename to zh_CN/guides/biao-zhu/logs.md index c37b382..6e9154c 100644 --- a/zh_CN/guides/logs.md +++ b/zh_CN/guides/biao-zhu/logs.md @@ -1,10 +1,12 @@ # 日志与标注 +🚧工作中 + {% hint style="warning" %} 请确保您的应用在收集用户数据时遵守当地法规。通常的做法是发布隐私政策并征得用户的同意。 {% endhint %} -**日志（Logs）**功能用以观察与标记 Dify 应用的工作表现，Dify 为应用的全部交互过程记录了日志，无论你是通过 WebApp 或 API 调用的，如果你是 Prompt 工程师或 LLM 运营人员，它将为你提供可视化的 LLM 应用运营体验。 +\*\*日志（Logs）\*\*功能用以观察与标记 Dify 应用的工作表现，Dify 为应用的全部交互过程记录了日志，无论你是通过 WebApp 或 API 调用的，如果你是 Prompt 工程师或 LLM 运营人员，它将为你提供可视化的 LLM 应用运营体验。 ### 使用日志控制台 @@ -22,7 +24,7 @@ 这些标记将在 Dify 的后续版本中供模型微调使用，以提升模型的准确性与回复风格，当前预览版仅支持标记。 {% endhint %} -

标记日志以改进

+

标记日志以改进

点击一条日志会在界面右侧打开日志详情面板，在该面板中运营人员可以对一次互动进行标注： @@ -31,4 +33,3 @@ * 对改进的结果标记改进回复，这代表了你期望 AI 回复的文本 注意，如果团队中的多位管理员对同一条日志进行标注，最后标注的记录将覆盖此前的标注。 - diff --git a/zh_CN/guides/extension/README.md b/zh_CN/guides/extension/README.md new file mode 100644 index 0000000..c5d6c87 --- /dev/null +++ b/zh_CN/guides/extension/README.md @@ -0,0 +1,8 @@ +# 扩展 + +在创造 AI 应用的过程中，开发者面临着不断变化的业务需求和复杂的技术挑战。有效地利用扩展能力不仅可以提高应用的灵活性和功能性，还可以确保企业数据的安全性和合规性。 + +Dify 提供了以下两种扩展方式： + +* API 扩展 +* 代码扩展 diff --git a/zh_CN/guides/application-design/extension/api_based_extension/README.md b/zh_CN/guides/extension/api_based_extension/README.md similarity index 92% rename from zh_CN/guides/application-design/extension/api_based_extension/README.md rename to zh_CN/guides/extension/api_based_extension/README.md index b451b82..f49d5db 100644 --- a/zh_CN/guides/application-design/extension/api_based_extension/README.md +++ b/zh_CN/guides/extension/api_based_extension/README.md @@ -9,7 +9,7 @@ 除了需要开发对应的模块能力，还需要遵照以下规范，以便 Dify 正确调用 API。 -

基于 API 扩展

+

基于 API 扩展

### API 规范 @@ -230,7 +230,7 @@ API 返回为： 1. 进入 [https://ngrok.com](https://ngrok.com) 官网，注册并下载 Ngrok 文件。 -

Download

+

Download

2. 下载完成后，进入下载目录，根据下方说明解压压缩包，并执行说明中的初始化脚本。 * ```Shell $ unzip /path/to/ngrok.zip @@ -238,7 +238,7 @@ API 返回为： ``` 3. 查看本地 API 服务的端口： -

查看端口

+

查看端口

并运行以下命令启动： @@ -248,17 +248,16 @@ API 返回为： 启动成功的样例如下： -

Ngrok 启动

+

Ngrok 启动

4. 我们找到 Forwarding 中，如上图：`https://177e-159-223-41-52.ngrok-free.app`（此为示例域名，请替换为自己的）即为公网域名。 * 按照上述的范例，我们把本地已经启动的服务端点暴露出去，将代码范例接口：`http://127.0.0.1:8000/api/dify/receive` 替换为 `https://177e-159-223-41-52.ngrok-free.app/api/dify/receive` -此 API 端点即可公网访问。至此，我们即可在 Dify 配置该 API 端点进行本地调试代码，配置步骤请参考 [external\_data\_tool.md](../../../knowledge-base/external\_data\_tool.md "mention")。 - +此 API 端点即可公网访问。至此，我们即可在 Dify 配置该 API 端点进行本地调试代码，配置步骤请参考 [external\_data\_tool.md](../../knowledge-base/external\_data\_tool.md "mention")。 ### 使用 Cloudflare Workers 部署 API 扩展 我们推荐你使用 Cloudflare Workers 来部署你的 API 扩展，因为 Cloudflare Workers 可以方便的提供一个公网地址，而且可以免费使用。 -[cloudflare\_workers.md](./cloudflare\_workers.md "mention")。 +[cloudflare\_workers.md](cloudflare\_workers.md "mention")。 diff --git a/zh_CN/guides/application-design/extension/api_based_extension/cloudflare_workers.md b/zh_CN/guides/extension/api_based_extension/cloudflare_workers.md similarity index 74% rename from zh_CN/guides/application-design/extension/api_based_extension/cloudflare_workers.md rename to zh_CN/guides/extension/api_based_extension/cloudflare_workers.md index b358a48..7a6dddc 100644 --- a/zh_CN/guides/application-design/extension/api_based_extension/cloudflare_workers.md +++ b/zh_CN/guides/extension/api_based_extension/cloudflare_workers.md @@ -1,4 +1,4 @@ -# 部署 API 扩展到 Cloudflare Workers +# 使用 Cloudflare Workers 部署 API Tools ## 开始 @@ -40,22 +40,15 @@ const result = await fetch(url).then(res => res.text()) ```bash npm run deploy ``` + 部署成功之后，你会得到一个公网地址，你可以在 Dify 中添加这个地址作为 API Endpoint。请注意不要遗漏 `endpoint` 这个路径。 +

在 Dify 中添加 API Endpoint

-
-

-在 Dify 中添加 API Endpoint -

-
- -
-

-在 App 编辑页面中添加上 API Tool -

-
+

在 App 编辑页面中添加上 API Tool

## 其他逻辑 TL;DR + ### 关于 Bearer Auth ```typescript @@ -66,6 +59,7 @@ import { bearerAuth } from "hono/bearer-auth"; return auth(c, next); }, ``` + 我们的 Bearer 校验逻辑在如上代码中，我们使用了 `hono/bearer-auth` 这个包来实现 Bearer 校验。你可以在 `src/index.ts` 中使用 `c.env.TOKEN` 来获取 Token。 ### 关于参数验证 @@ -91,8 +85,7 @@ const schema = z.object({ ``` -我们这里使用了 `zod` 来定义参数的类型，你可以在 `src/index.ts` 中使用 `zValidator` 来校验参数。通过 ` const { point, params } = c.req.valid("json");` 来获取校验后的参数。 我们这里的 point 只有两个值，所以我们使用了 `z.union` 来定义。 -params 是一个可选的参数，所以我们使用了 `z.optional` 来定义。 其中会有一个 `inputs` 的参数，这个参数是一个 `Record` 类型，这个类型表示一个 key 为 string，value 为 any 的对象。这个类型可以表示任意的对象，你可以在 `src/index.ts` 中使用 `params?.inputs?.count` 来获取 `count` 参数。 +我们这里使用了 `zod` 来定义参数的类型，你可以在 `src/index.ts` 中使用 `zValidator` 来校验参数。通过 `const { point, params } = c.req.valid("json");` 来获取校验后的参数。 我们这里的 point 只有两个值，所以我们使用了 `z.union` 来定义。 params 是一个可选的参数，所以我们使用了 `z.optional` 来定义。 其中会有一个 `inputs` 的参数，这个参数是一个 `Record` 类型，这个类型表示一个 key 为 string，value 为 any 的对象。这个类型可以表示任意的对象，你可以在 `src/index.ts` 中使用 `params?.inputs?.count` 来获取 `count` 参数。 ### 获取 Cloudflare Workers 的日志 @@ -102,6 +95,6 @@ wrangler tail ## 参考内容 -- [Cloudflare Workers](https://workers.cloudflare.com/) -- [Cloudflare Workers CLI](https://developers.cloudflare.com/workers/cli-wrangler/install-update) -- [Example GitHub Repository](https://github.com/crazywoola/dify-extension-workers) \ No newline at end of file +* [Cloudflare Workers](https://workers.cloudflare.com/) +* [Cloudflare Workers CLI](https://developers.cloudflare.com/workers/cli-wrangler/install-update) +* [Example GitHub Repository](https://github.com/crazywoola/dify-extension-workers) diff --git a/zh_CN/guides/application-design/extension/api_based_extension/external_data_tool.md b/zh_CN/guides/extension/api_based_extension/external_data_tool.md similarity index 95% rename from zh_CN/guides/application-design/extension/api_based_extension/external_data_tool.md rename to zh_CN/guides/extension/api_based_extension/external_data_tool.md index 7714e14..5769164 100644 --- a/zh_CN/guides/application-design/extension/api_based_extension/external_data_tool.md +++ b/zh_CN/guides/extension/api_based_extension/external_data_tool.md @@ -1,6 +1,6 @@ # 外部数据工具 -在创建 AI 应用时，开发者可以通过 API 扩展的方式实现使用外部工具获取额外数据组装至 Prompt 中作为 LLM 额外信息。具体的实操过程可以参考 [external\_data\_tool.md](../../../knowledge-base/external\_data\_tool.md "mention")。 +在创建 AI 应用时，开发者可以通过 API 扩展的方式实现使用外部工具获取额外数据组装至 Prompt 中作为 LLM 额外信息。具体的实操过程可以参考 [external\_data\_tool.md](../../knowledge-base/external\_data\_tool.md "mention")。 ### 前置条件 @@ -62,4 +62,4 @@ } ``` -\ +\\ diff --git a/zh_CN/guides/application-design/extension/api_based_extension/moderation.md b/zh_CN/guides/extension/api_based_extension/moderation.md similarity index 100% rename from zh_CN/guides/application-design/extension/api_based_extension/moderation.md rename to zh_CN/guides/extension/api_based_extension/moderation.md diff --git a/zh_CN/guides/application-design/extension/code_based_extension/README.md b/zh_CN/guides/extension/code_based_extension/README.md similarity index 100% rename from zh_CN/guides/application-design/extension/code_based_extension/README.md rename to zh_CN/guides/extension/code_based_extension/README.md diff --git a/zh_CN/guides/application-design/extension/code_based_extension/external_data_tool.md b/zh_CN/guides/extension/code_based_extension/external_data_tool.md similarity index 100% rename from zh_CN/guides/application-design/extension/code_based_extension/external_data_tool.md rename to zh_CN/guides/extension/code_based_extension/external_data_tool.md diff --git a/zh_CN/guides/application-design/extension/code_based_extension/moderation.md b/zh_CN/guides/extension/code_based_extension/moderation.md similarity index 100% rename from zh_CN/guides/application-design/extension/code_based_extension/moderation.md rename to zh_CN/guides/extension/code_based_extension/moderation.md diff --git a/zh_CN/guides/knowledge-base/external_data_tool.md b/zh_CN/guides/knowledge-base/external_data_tool.md index fee9b8a..8478df5 100644 --- a/zh_CN/guides/knowledge-base/external_data_tool.md +++ b/zh_CN/guides/knowledge-base/external_data_tool.md @@ -12,7 +12,7 @@ ## 操作说明 -1. 在使用外部数据工具之前，你需要准备一个 API 和用于鉴权的 API Key，请阅读[external\_data\_tool.md](../application-design/extension/api\_based\_extension/external\_data\_tool.md "mention") +1. 在使用外部数据工具之前，你需要准备一个 API 和用于鉴权的 API Key，请阅读[external\_data\_tool.md](../extension/api\_based\_extension/external\_data\_tool.md "mention") 2. Dify 提供了集中式的 API 管理，在设置界面统一添加 API 扩展配置后，即可在 Dify 上的各类应用中直接使用。

API-based Extension

diff --git a/zh_CN/guides/monitoring.md b/zh_CN/guides/monitoring.md new file mode 100644 index 0000000..8c3292a --- /dev/null +++ b/zh_CN/guides/monitoring.md @@ -0,0 +1,3 @@ +# 监测 + +🚧 工作中