From 25ed8287fa7b6a96257a8ae42f131b0f1feaa520 Mon Sep 17 00:00:00 2001 From: zorroj Date: Tue, 7 Nov 2023 06:13:30 +0000 Subject: [PATCH] GITBOOK-20: zorroj's Nov 7 changes --- zh_CN/SUMMARY.md | 14 +++++++------- zh_CN/advanced/extension/README.md | 7 +++++++ .../api_based_extension/README.md | 0 .../api_based_extension/external_data_tool.md | 2 +- .../api_based_extension/moderation.md | 0 zh_CN/advanced/extension/code_based_extension.md | 8 ++++++++ zh_CN/advanced/kuo-zhan/README.md | 2 -- zh_CN/advanced/kuo-zhan/codebased-kuo-zhan.md | 2 -- ...-bu-shu-ju-gong-ju.md => external_data_tool.md} | 2 +- ...gan-nei-rong-shen-cha.md => moderation_tool.md} | 2 +- 10 files changed, 25 insertions(+), 14 deletions(-) create mode 100644 zh_CN/advanced/extension/README.md rename zh_CN/advanced/{kuo-zhan => extension}/api_based_extension/README.md (100%) rename zh_CN/advanced/{kuo-zhan => extension}/api_based_extension/external_data_tool.md (92%) rename zh_CN/advanced/{kuo-zhan => extension}/api_based_extension/moderation.md (100%) create mode 100644 zh_CN/advanced/extension/code_based_extension.md delete mode 100644 zh_CN/advanced/kuo-zhan/README.md delete mode 100644 zh_CN/advanced/kuo-zhan/codebased-kuo-zhan.md rename zh_CN/application/prompt-engineering/{wai-bu-shu-ju-gong-ju.md => external_data_tool.md} (97%) rename zh_CN/application/prompt-engineering/{min-gan-nei-rong-shen-cha.md => moderation_tool.md} (93%) diff --git a/zh_CN/SUMMARY.md b/zh_CN/SUMMARY.md index 42c061d..226c931 100644 --- a/zh_CN/SUMMARY.md +++ b/zh_CN/SUMMARY.md @@ -22,8 +22,8 @@ * [设计提示词&编排应用](application/prompt-engineering/README.md) * [文本生成型应用](application/prompt-engineering/text-generation-application.md) * [对话型应用](application/prompt-engineering/conversation-application.md) - * [外部数据工具](application/prompt-engineering/wai-bu-shu-ju-gong-ju.md) - * [敏感内容审查](application/prompt-engineering/min-gan-nei-rong-shen-cha.md) + * [外部数据工具](application/prompt-engineering/external\_data\_tool.md) + * [敏感内容审查](application/prompt-engineering/moderation\_tool.md) * [基于 APIs 开发](application/developing-with-apis.md) * [日志与标注](application/logs.md) @@ -54,11 +54,11 @@ * [接入 OpenLLM 部署的本地模型](advanced/model-configuration/openllm.md) * [接入 LocalAI 部署的本地模型](advanced/model-configuration/localai.md) * [更多集成](advanced/more-integration.md) -* [扩展](advanced/kuo-zhan/README.md) - * [API-based 扩展](advanced/kuo-zhan/api\_based\_extension/README.md) - * [外部数据工具扩展](advanced/kuo-zhan/api\_based\_extension/external\_data\_tool.md) - * [敏感内容审查扩展](advanced/kuo-zhan/api\_based\_extension/moderation.md) - * [Code-based 扩展](advanced/kuo-zhan/codebased-kuo-zhan.md) +* [扩展](advanced/extension/README.md) + * [API-based 扩展](advanced/extension/api\_based\_extension/README.md) + * [外部数据工具扩展](advanced/extension/api\_based\_extension/external\_data\_tool.md) + * [敏感内容审查扩展](advanced/extension/api\_based\_extension/moderation.md) + * [Code-based 扩展](advanced/extension/code\_based\_extension.md) ## 使用案例 diff --git a/zh_CN/advanced/extension/README.md b/zh_CN/advanced/extension/README.md new file mode 100644 index 0000000..fbb5b45 --- /dev/null +++ b/zh_CN/advanced/extension/README.md @@ -0,0 +1,7 @@ +# 扩展 + +在创造 AI 应用的过程中，开发者面临着不断变化的业务需求和复杂的技术挑战。有效地利用扩展能力不仅可以提高应用的灵活性和功能性，还可以确保企业数据的安全性和合规性。Dify 提供了以下两种扩展方式： + +[api\_based\_extension](api\_based\_extension/ "mention") + +[code\_based\_extension.md](code\_based\_extension.md "mention") diff --git a/zh_CN/advanced/kuo-zhan/api_based_extension/README.md b/zh_CN/advanced/extension/api_based_extension/README.md similarity index 100% rename from zh_CN/advanced/kuo-zhan/api_based_extension/README.md rename to zh_CN/advanced/extension/api_based_extension/README.md diff --git a/zh_CN/advanced/kuo-zhan/api_based_extension/external_data_tool.md b/zh_CN/advanced/extension/api_based_extension/external_data_tool.md similarity index 92% rename from zh_CN/advanced/kuo-zhan/api_based_extension/external_data_tool.md rename to zh_CN/advanced/extension/api_based_extension/external_data_tool.md index 3437376..bc83960 100644 --- a/zh_CN/advanced/kuo-zhan/api_based_extension/external_data_tool.md +++ b/zh_CN/advanced/extension/api_based_extension/external_data_tool.md @@ -1,6 +1,6 @@ # 外部数据工具扩展 -在创建 AI 应用时，开发者可以通过 API 扩展的方式实现使用外部工具获取额外数据组装至 Prompt 中作为 LLM 额外信息。具体的实操过程可以参考 [wai-bu-shu-ju-gong-ju.md](../../../application/prompt-engineering/wai-bu-shu-ju-gong-ju.md "mention")。 +在创建 AI 应用时，开发者可以通过 API 扩展的方式实现使用外部工具获取额外数据组装至 Prompt 中作为 LLM 额外信息。具体的实操过程可以参考 [external\_data\_tool.md](../../../application/prompt-engineering/external\_data\_tool.md "mention")。 ### 前置条件 diff --git a/zh_CN/advanced/kuo-zhan/api_based_extension/moderation.md b/zh_CN/advanced/extension/api_based_extension/moderation.md similarity index 100% rename from zh_CN/advanced/kuo-zhan/api_based_extension/moderation.md rename to zh_CN/advanced/extension/api_based_extension/moderation.md diff --git a/zh_CN/advanced/extension/code_based_extension.md b/zh_CN/advanced/extension/code_based_extension.md new file mode 100644 index 0000000..d3dc622 --- /dev/null +++ b/zh_CN/advanced/extension/code_based_extension.md @@ -0,0 +1,8 @@ +# Code-based 扩展 + +对于本地部署 Dify 的开发者，如果想实现扩展能力，无需重新写一个 API 服务，可以使用 Code-based Extension 即在 Dify 功能的基础上，以代码形式扩展或增强程序的能力（即插件能力），而不破坏 Dify 原有代码逻辑。它遵循一定的接口或规范，以实现与主程序的兼容和可插拔性。 目前，Dify 开放了两种 Code-based Extension，分别为： + +* 新增一种新的外部数据工具类型[external\_data\_tool.md](api\_based\_extension/external\_data\_tool.md "mention") +* 扩展敏感内容审查策略[moderation.md](api\_based\_extension/moderation.md "mention") + +可在上述功能的基础上，遵循代码层 interface 的规范，来实现横向扩展的目的。 diff --git a/zh_CN/advanced/kuo-zhan/README.md b/zh_CN/advanced/kuo-zhan/README.md deleted file mode 100644 index f9775c1..0000000 --- a/zh_CN/advanced/kuo-zhan/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# 扩展 - diff --git a/zh_CN/advanced/kuo-zhan/codebased-kuo-zhan.md b/zh_CN/advanced/kuo-zhan/codebased-kuo-zhan.md deleted file mode 100644 index 4b0f628..0000000 --- a/zh_CN/advanced/kuo-zhan/codebased-kuo-zhan.md +++ /dev/null @@ -1,2 +0,0 @@ -# Code-based 扩展 - diff --git a/zh_CN/application/prompt-engineering/wai-bu-shu-ju-gong-ju.md b/zh_CN/application/prompt-engineering/external_data_tool.md similarity index 97% rename from zh_CN/application/prompt-engineering/wai-bu-shu-ju-gong-ju.md rename to zh_CN/application/prompt-engineering/external_data_tool.md index 4a19809..89bb137 100644 --- a/zh_CN/application/prompt-engineering/wai-bu-shu-ju-gong-ju.md +++ b/zh_CN/application/prompt-engineering/external_data_tool.md @@ -12,7 +12,7 @@ ## 操作说明 -1. 在使用外部数据工具之前，你需要准备一个 API 和用于鉴权的 API Key，请阅读[external\_data\_tool.md](../../advanced/kuo-zhan/api\_based\_extension/external\_data\_tool.md "mention") +1. 在使用外部数据工具之前，你需要准备一个 API 和用于鉴权的 API Key，请阅读[external\_data\_tool.md](../../advanced/extension/api\_based\_extension/external\_data\_tool.md "mention") 2. Dify 提供了集中式的 API 管理，在设置界面统一添加 API 扩展配置后，即可在 Dify 上的各类应用中直接使用。

API-based Extension

diff --git a/zh_CN/application/prompt-engineering/min-gan-nei-rong-shen-cha.md b/zh_CN/application/prompt-engineering/moderation_tool.md similarity index 93% rename from zh_CN/application/prompt-engineering/min-gan-nei-rong-shen-cha.md rename to zh_CN/application/prompt-engineering/moderation_tool.md index b52da3b..6d4f7a5 100644 --- a/zh_CN/application/prompt-engineering/min-gan-nei-rong-shen-cha.md +++ b/zh_CN/application/prompt-engineering/moderation_tool.md @@ -18,6 +18,6 @@ OpenAI 和大多数 LLM 公司提供的模型，都带有内容审查功能， ### 功能三： 敏感词审查 Moderation 扩展 -不同的企业内部往往有着不同的敏感词审查机制，企业在开发自己的 AI 应用如企业内部知识库 ChatBot，需要对员工输入的查询内容作敏感词审查。为此，开发者可以根据自己企业内部的敏感词审查机制写一个 API 扩展，具体可参考 [moderation.md](../../advanced/kuo-zhan/api\_based\_extension/moderation.md "mention")，从而在 Dify 上调用，实现敏感词审查的高度自定义和隐私保护。 +不同的企业内部往往有着不同的敏感词审查机制，企业在开发自己的 AI 应用如企业内部知识库 ChatBot，需要对员工输入的查询内容作敏感词审查。为此，开发者可以根据自己企业内部的敏感词审查机制写一个 API 扩展，具体可参考 [moderation.md](../../advanced/extension/api\_based\_extension/moderation.md "mention")，从而在 Dify 上调用，实现敏感词审查的高度自定义和隐私保护。

Moderation 扩展