From 9a20bbbf1880d4dc3f9391fb7550ee6f4df2f6c8 Mon Sep 17 00:00:00 2001 From: AllenWriter Date: Tue, 6 May 2025 15:57:13 +0800 Subject: [PATCH] Feat: modify codeblack style and add docs --- docs.json | 225 +++++++++--------- en/features/datasets/prompt-engineering.mdx | 30 +++ .../prompt-engineering/README.mdx | 6 +- .../README.mdx => expert-mode.mdx} | 0 .../prompt-engineering-template.mdx | 0 5 files changed, 145 insertions(+), 116 deletions(-) create mode 100644 en/features/datasets/prompt-engineering.mdx rename zh-hans/learn-more/extended-reading/prompt-engineering/{prompt-engineering-1/README.mdx => expert-mode.mdx} (100%) rename zh-hans/learn-more/extended-reading/prompt-engineering/{prompt-engineering-1 => }/prompt-engineering-template.mdx (100%) diff --git a/docs.json b/docs.json index 3deda0d5..0fff73ec 100644 --- a/docs.json +++ b/docs.json @@ -34,7 +34,7 @@ { "group": "Dify Community", "pages": [ - "en/getting-started/install-self-hosted/readme", + "en/getting-started/install-self-hosted", "en/getting-started/install-self-hosted/docker-compose", "en/getting-started/install-self-hosted/local-source-code", "en/getting-started/install-self-hosted/aa-panel", @@ -54,7 +54,7 @@ { "group": "Model Configuration", "pages": [ - "en/guides/model-configuration/readme", + "en/guides/model-configuration", "en/guides/model-configuration/new-provider", "en/guides/model-configuration/predefined-model", "en/guides/model-configuration/customizable-model", @@ -66,7 +66,7 @@ { "group": "Application Orchestration", "pages": [ - "en/guides/application-orchestrate/readme", + "en/guides/application-orchestrate", "en/guides/application-orchestrate/creating-an-application", "en/guides/application-orchestrate/chatbot-application", "en/guides/application-orchestrate/multiple-llms-debugging", @@ -75,7 +75,7 @@ { "group": "Application Toolkits", "pages": [ - "en/guides/application-orchestrate/app-toolkits/readme", + "en/guides/application-orchestrate/app-toolkits", "en/guides/application-orchestrate/app-toolkits/moderation-tool" ] } @@ -84,7 +84,7 @@ { "group": "Workflow", "pages": [ - "en/guides/workflow/README", + "en/guides/workflow", "en/guides/workflow/key-concepts", "en/guides/workflow/variables", { @@ -117,7 +117,7 @@ { "group": "Error Handling", "pages": [ - "en/guides/workflow/error-handling/README", + "en/guides/workflow/error-handling", "en/guides/workflow/error-handling/predefined-error-handling-logic", "en/guides/workflow/error-handling/error-type" ] @@ -141,7 +141,7 @@ { "group": "Knowledge", "pages": [ - "en/guides/knowledge-base/readme", + "en/guides/knowledge-base", { "group": "Create Knowledge", "pages": [ @@ -149,7 +149,7 @@ { "group": "1. Import Text Data", "pages": [ - "en/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "en/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data", "en/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", "en/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] @@ -179,7 +179,7 @@ "pages": [ { "group": "Publish as a Single-page Web App", "pages": [ - "en/guides/application-publishing/launch-your-webapp-quickly/README", + "en/guides/application-publishing/launch-your-webapp-quickly", "en/guides/application-publishing/launch-your-webapp-quickly/web-app-settings", "en/guides/application-publishing/launch-your-webapp-quickly/text-generator", "en/guides/application-publishing/launch-your-webapp-quickly/conversation-application" @@ -200,12 +200,12 @@ { "group": "Monitoring", "pages": [ - "en/guides/monitoring/README", + "en/guides/monitoring", "en/guides/monitoring/analysis", { "group": "Integrate External Ops Tools", "pages": [ - "en/guides/monitoring/integrate-external-ops-tools/README", + "en/guides/monitoring/integrate-external-ops-tools", "en/guides/monitoring/integrate-external-ops-tools/integrate-langsmith", "en/guides/monitoring/integrate-external-ops-tools/integrate-langfuse", "en/guides/monitoring/integrate-external-ops-tools/integrate-opik", @@ -220,7 +220,7 @@ { "group": "API-Based Extension", "pages": [ - "en/guides/extension/api-based-extension/README", + "en/guides/extension/api-based-extension", "en/guides/extension/api-based-extension/external-data-tool", "en/guides/extension/api-based-extension/cloudflare-workers", "en/guides/extension/api-based-extension/moderation" @@ -229,7 +229,7 @@ { "group": "Code-Based Extension", "pages": [ - "en/guides/extension/code-based-extension/README", + "en/guides/extension/code-based-extension", "en/guides/extension/code-based-extension/external-data-tool", "en/guides/extension/code-based-extension/moderation" ] @@ -239,7 +239,7 @@ { "group": "Collaboration", "pages": [ - "en/guides/workspace/README", + "en/guides/workspace", "en/guides/workspace/app", "en/guides/workspace/invite-and-manage-members" ] @@ -259,7 +259,7 @@ { "group": "Workshop", "pages": [ - "en/workshop/README", + "en/workshop", { "group": "Basic", "pages": [ @@ -292,18 +292,18 @@ { "group": "Quick Start", "pages": [ - "en/plugins/quick-start/README", + "en/plugins/quick-start", "en/plugins/quick-start/install-plugins", { "group": "Develop Plugins", "pages": [ - "en/plugins/quick-start/develop-plugins/README", + "en/plugins/quick-start/develop-plugins", "en/plugins/quick-start/develop-plugins/initialize-development-tools", "en/plugins/quick-start/develop-plugins/tool-plugin", { "group": "Model Plugin", "pages": [ - "en/plugins/quick-start/develop-plugins/model-plugin/README", + "en/plugins/quick-start/develop-plugins/model-plugin", "en/plugins/quick-start/develop-plugins/model-plugin/create-model-providers", "en/plugins/quick-start/develop-plugins/model-plugin/predefined-model", "en/plugins/quick-start/develop-plugins/model-plugin/customizable-model" @@ -337,7 +337,7 @@ { "group": "Reverse Invocation of the Dify Service", "pages": [ - "en/plugins/schema-definition/reverse-invocation-of-the-dify-service/README", + "en/plugins/schema-definition/reverse-invocation-of-the-dify-service", "en/plugins/schema-definition/reverse-invocation-of-the-dify-service/app", "en/plugins/schema-definition/reverse-invocation-of-the-dify-service/model", "en/plugins/schema-definition/reverse-invocation-of-the-dify-service/tool", @@ -349,7 +349,7 @@ { "group": "Best Practice", "pages": [ - "en/plugins/best-practice/README", + "en/plugins/best-practice", "en/plugins/best-practice/develop-a-slack-bot-plugin", "en/plugins/best-practice/how-to-use-mcp-zapier" ] @@ -357,12 +357,12 @@ { "group": "Publish Plugins", "pages": [ - "en/plugins/publish-plugins/README", + "en/plugins/publish-plugins", "en/plugins/publish-plugins/plugin-auto-publish-pr", { "group": "Publish to Dify Marketplace", "pages": [ - "en/plugins/publish-plugins/publish-to-dify-marketplace/README", + "en/plugins/publish-plugins/publish-to-dify-marketplace", "en/plugins/publish-plugins/publish-to-dify-marketplace/plugin-developer-guidelines", "en/plugins/publish-plugins/publish-to-dify-marketplace/plugin-privacy-protection-guidelines" ] @@ -381,7 +381,7 @@ { "group": "Backend", "pages": [ - "en/development/backend/sandbox/README", + "en/development/backend/sandbox", "en/development/backend/sandbox/contribution" ] }, @@ -431,7 +431,7 @@ { "group": "Retrieval-Augmented Generation (RAG)", "pages": [ - "en/learn-more/extended-reading/retrieval-augment/README", + "en/learn-more/extended-reading/retrieval-augment", "en/learn-more/extended-reading/retrieval-augment/hybrid-search", "en/learn-more/extended-reading/retrieval-augment/rerank", "en/learn-more/extended-reading/retrieval-augment/retrieval" @@ -457,7 +457,7 @@ { "group": "User Agreement", "pages": [ - "en/policies/agreement/README", + "en/policies/agreement", "en/policies/agreement/tos", "en/policies/agreement/privacy", "en/policies/agreement/get-compliance-report" @@ -617,7 +617,7 @@ { "group": "Dify 社区版", "pages": [ - "zh-hans/getting-started/install-self-hosted/readme", + "zh-hans/getting-started/install-self-hosted", "zh-hans/getting-started/install-self-hosted/docker-compose", "zh-hans/getting-started/install-self-hosted/local-source-code", "zh-hans/getting-started/install-self-hosted/bt-panel", @@ -636,7 +636,7 @@ { "group": "接入大模型", "pages": [ - "zh-hans/guides/model-configuration/readme", + "zh-hans/guides/model-configuration", "zh-hans/guides/model-configuration/new-provider", "zh-hans/guides/model-configuration/predefined-model", "zh-hans/guides/model-configuration/customizable-model", @@ -648,7 +648,7 @@ { "group": "构建应用", "pages": [ - "zh-hans/guides/application-orchestrate/readme", + "zh-hans/guides/application-orchestrate", "zh-hans/guides/application-orchestrate/creating-an-application", { "group": "聊天助手", @@ -661,7 +661,7 @@ { "group": "应用工具箱", "pages": [ - "zh-hans/guides/application-orchestrate/app-toolkits/readme", + "zh-hans/guides/application-orchestrate/app-toolkits", "zh-hans/guides/application-orchestrate/app-toolkits/moderation-tool" ] } @@ -670,7 +670,7 @@ { "group": "工作流", "pages": [ - "zh-hans/guides/workflow/readme", + "zh-hans/guides/workflow", "zh-hans/guides/workflow/key-concept", "zh-hans/guides/workflow/variables", { @@ -703,7 +703,7 @@ { "group": "异常处理", "pages": [ - "zh-hans/guides/workflow/error-handling/readme", + "zh-hans/guides/workflow/error-handling", "zh-hans/guides/workflow/error-handling/predefined-nodes-failure-logic", "zh-hans/guides/workflow/error-handling/error-type" ] @@ -727,7 +727,7 @@ { "group": "知识库", "pages": [ - "zh-hans/guides/knowledge-base/readme", + "zh-hans/guides/knowledge-base", { "group": "创建知识库", "pages": [ @@ -735,7 +735,7 @@ { "group": "1. 导入文本数据", "pages": [ - "zh-hans/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "zh-hans/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data", "zh-hans/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", "zh-hans/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] @@ -763,10 +763,10 @@ { "group": "工具", "pages": [ - "zh-hans/guides/tools/readme", + "zh-hans/guides/tools", "zh-hans/guides/tools/quick-tool-integration", "zh-hans/guides/tools/advanced-tool-integration", - "zh-hans/guides/tools/tool-configuration/readme", + "zh-hans/guides/tools/tool-configuration", { "group": "工具配置详情", "pages": [ @@ -791,7 +791,7 @@ { "group": "发布为公开 Web 站点", "pages": [ - "zh-hans/guides/application-publishing/launch-your-webapp-quickly/readme", + "zh-hans/guides/application-publishing/launch-your-webapp-quickly/REDME", "zh-hans/guides/application-publishing/launch-your-webapp-quickly/web-app-settings", "zh-hans/guides/application-publishing/launch-your-webapp-quickly/text-generator", "zh-hans/guides/application-publishing/launch-your-webapp-quickly/conversation-application" @@ -812,11 +812,11 @@ { "group": "监测", "pages": [ - "zh-hans/guides/monitoring/README", + "zh-hans/guides/monitoring", { "group": "集成外部与 Ops 工具", "pages": [ - "zh-hans/guides/monitoring/integrate-external-ops-tools/readme", + "zh-hans/guides/monitoring/integrate-external-ops-tools", "zh-hans/guides/monitoring/integrate-external-ops-tools/integrate-langfuse", "zh-hans/guides/monitoring/integrate-external-ops-tools/integrate-langsmith", "zh-hans/guides/monitoring/integrate-external-ops-tools/integrate-opik", @@ -829,7 +829,7 @@ { "group": "扩展", "pages": [ - "zh-hans/guides/tools/extensions/README", + "zh-hans/guides/tools/extensions", { "group": "API 扩展", "pages": [ @@ -842,7 +842,7 @@ { "group": "代码扩展", "pages": [ - "zh-hans/guides/tools/extensions/code-based/README", + "zh-hans/guides/tools/extensions/code-based", "zh-hans/guides/tools/extensions/code-based/external-data-tool", "zh-hans/guides/tools/extensions/code-based/moderation" ] @@ -852,7 +852,7 @@ { "group": "协同", "pages": [ - "zh-hans/guides/workspace/readme", + "zh-hans/guides/workspace", "zh-hans/guides/workspace/app", "zh-hans/guides/workspace/invite-and-manage-members" ] @@ -872,7 +872,7 @@ { "group": "动手实验室", "pages": [ - "zh-hans/workshop/readme", + "zh-hans/workshop", { "group": "初级", "pages": [ @@ -905,18 +905,18 @@ { "group": "快速开始", "pages": [ - "zh-hans/plugins/quick-start/README", + "zh-hans/plugins/quick-start", "zh-hans/plugins/quick-start/install-plugins", { "group": "插件开发", "pages": [ - "zh-hans/plugins/quick-start/develop-plugins/README", + "zh-hans/plugins/quick-start/develop-plugins", "zh-hans/plugins/quick-start/develop-plugins/initialize-development-tools", "zh-hans/plugins/quick-start/develop-plugins/tool-plugin", { "group": "Model 插件", "pages": [ - "zh-hans/plugins/quick-start/develop-plugins/model-plugin/README", + "zh-hans/plugins/quick-start/develop-plugins/model-plugin", "zh-hans/plugins/quick-start/develop-plugins/model-plugin/create-model-providers", "zh-hans/plugins/quick-start/develop-plugins/model-plugin/integrate-the-predefined-model", "zh-hans/plugins/quick-start/develop-plugins/model-plugin/customizable-model" @@ -950,7 +950,7 @@ { "group": "反向调用 Dify 服务", "pages": [ - "zh-hans/plugins/schema-definition/reverse-invocation-of-the-dify-service/README", + "zh-hans/plugins/schema-definition/reverse-invocation-of-the-dify-service", "zh-hans/plugins/schema-definition/reverse-invocation-of-the-dify-service/app", "zh-hans/plugins/schema-definition/reverse-invocation-of-the-dify-service/model", "zh-hans/plugins/schema-definition/reverse-invocation-of-the-dify-service/tool", @@ -969,12 +969,12 @@ { "group": "发布插件", "pages": [ - "zh-hans/plugins/publish-plugins/README", + "zh-hans/plugins/publish-plugins", "zh-hans/plugins/publish-plugins/plugin-auto-publish-pr", { "group": "发布至 Dify Marketplace", "pages": [ - "zh-hans/plugins/publish-plugins/publish-to-dify-marketplace/README", + "zh-hans/plugins/publish-plugins/publish-to-dify-marketplace", "zh-hans/plugins/publish-plugins/publish-to-dify-marketplace/plugin-developer-guidelines", "zh-hans/plugins/publish-plugins/publish-to-dify-marketplace/plugin-privacy-protection-guidelines" ] @@ -993,7 +993,7 @@ { "group": "DifySandbox", "pages": [ - "zh-hans/development/backend/sandbox/README", + "zh-hans/development/backend/sandbox", "zh-hans/development/backend/sandbox/contribution" ] }, @@ -1052,7 +1052,7 @@ { "group": "检索增强生成（RAG）", "pages": [ - "zh-hans/learn-more/extended-reading/retrieval-augment/README", + "zh-hans/learn-more/extended-reading/retrieval-augment", "zh-hans/learn-more/extended-reading/retrieval-augment/hybrid-search", "zh-hans/learn-more/extended-reading/retrieval-augment/rerank", "zh-hans/learn-more/extended-reading/retrieval-augment/retrieval" @@ -1079,7 +1079,7 @@ { "group": "用户协议", "pages": [ - "zh-hans/policies/agreement/README", + "zh-hans/policies/agreement", "zh-hans/policies/agreement/tos", "zh-hans/policies/agreement/privacy", "zh-hans/policies/agreement/get-compliance-report" @@ -1239,7 +1239,7 @@ { "group": "Dify コミュニティ版", "pages": [ - "ja-jp/getting-started/install-self-hosted/README", + "ja-jp/getting-started/install-self-hosted", "ja-jp/getting-started/install-self-hosted/docker-compose", "ja-jp/getting-started/install-self-hosted/local-source-code", "ja-jp/getting-started/install-self-hosted/bt-panel", @@ -1258,7 +1258,7 @@ { "group": "モデル", "pages": [ - "ja-jp/guides/model-configuration/README", + "ja-jp/guides/model-configuration", "ja-jp/guides/model-configuration/new-provider", "ja-jp/guides/model-configuration/predefined-model", "ja-jp/guides/model-configuration/customizable-model", @@ -1270,7 +1270,7 @@ { "group": "アプリ・オーケストレーション", "pages": [ - "ja-jp/guides/application-orchestrate/README", + "ja-jp/guides/application-orchestrate", "ja-jp/guides/application-orchestrate/creating-an-application", { "group": "チャットボット", @@ -1283,7 +1283,7 @@ { "group": "ツールキット", "pages": [ - "ja-jp/guides/application-orchestrate/app-toolkits/README", + "ja-jp/guides/application-orchestrate/app-toolkits", "ja-jp/guides/application-orchestrate/app-toolkits/moderation-tool" ] } @@ -1324,7 +1324,7 @@ { "group": "エラー処理", "pages": [ - "ja-jp/guides/workflow/error-handling/README", + "ja-jp/guides/workflow/error-handling", "ja-jp/guides/workflow/error-handling/predefined-nodes-failure-logic", "ja-jp/guides/workflow/error-handling/error-type" ] @@ -1347,7 +1347,7 @@ { "group": "ナレッジベース", "pages": [ - "ja-jp/guides/knowledge-base/readme", + "ja-jp/guides/knowledge-base", { "group": "ナレッジベース作成", "pages": [ @@ -1355,7 +1355,7 @@ { "group": "1. オンラインデータソースの活用", "pages": [ - "ja-jp/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "ja-jp/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data", "ja-jp/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", "ja-jp/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] @@ -1367,7 +1367,7 @@ { "group": "ナレッジベースの管理", "pages": [ - "ja-jp/guides/knowledge-base/knowledge-and-documents-maintenance/readme", + "ja-jp/guides/knowledge-base/knowledge-and-documents-maintenance", "ja-jp/guides/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", "ja-jp/guides/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" ] @@ -1424,7 +1424,7 @@ { "group": "API 拡張", "pages": [ - "ja-jp/guides/extension/api-based-extension/README", + "ja-jp/guides/extension/api-based-extension", "ja-jp/guides/extension/api-based-extension/cloudflare-workers", "ja-jp/guides/extension/api-based-extension/moderation" ] @@ -1441,7 +1441,7 @@ { "group": "コラボレーション", "pages": [ - "ja-jp/guides/workspace/readme", + "ja-jp/guides/workspace", "ja-jp/guides/workspace/app", "ja-jp/guides/workspace/invite-and-manage-members" ] @@ -1464,7 +1464,7 @@ { "group": "初級編", "pages": [ - "ja-jp/workshop/basic/README", + "ja-jp/workshop/basic", "ja-jp/workshop/basic/build-ai-image-generation-app", "ja-jp/workshop/basic/travel-assistant" ] @@ -1493,18 +1493,18 @@ { "group": "クイックスタート", "pages": [ - "ja-jp/plugins/quick-start/README", + "ja-jp/plugins/quick-start", "ja-jp/plugins/quick-start/install-plugins", { "group": "プラグイン開発の入門", "pages": [ - "ja-jp/plugins/quick-start/develop-plugins/README", + "ja-jp/plugins/quick-start/develop-plugins", "ja-jp/plugins/quick-start/develop-plugins/initialize-development-tools", "ja-jp/plugins/quick-start/develop-plugins/tool-plugin", { "group": "モデル型プラグイン", "pages": [ - "ja-jp/plugins/quick-start/develop-plugins/model-plugin/README", + "ja-jp/plugins/quick-start/develop-plugins/model-plugin", "ja-jp/plugins/quick-start/develop-plugins/model-plugin/create-model-providers", "ja-jp/plugins/quick-start/develop-plugins/model-plugin/integrate-the-predefined-model", "ja-jp/plugins/quick-start/develop-plugins/model-plugin/customizable-model" @@ -1522,7 +1522,7 @@ { "group": "スキーマ仕様", "pages": [ - "ja-jp/plugins/schema-definition/README", + "ja-jp/plugins/schema-definition", "ja-jp/plugins/schema-definition/manifest", "ja-jp/plugins/schema-definition/endpoint", "ja-jp/plugins/schema-definition/tool", @@ -1530,7 +1530,7 @@ { "group": "Model", "pages": [ - "ja-jp/plugins/schema-definition/model/README", + "ja-jp/plugins/schema-definition/model", "ja-jp/plugins/schema-definition/model/model-designing-rules", "ja-jp/plugins/schema-definition/model/model-schema" ] @@ -1540,7 +1540,7 @@ { "group": "Difyサービスの逆呼び出し", "pages": [ - "ja-jp/plugins/schema-definition/reverse-invocation-of-the-dify-service/README", + "ja-jp/plugins/schema-definition/reverse-invocation-of-the-dify-service", "ja-jp/plugins/schema-definition/reverse-invocation-of-the-dify-service/app", "ja-jp/plugins/schema-definition/reverse-invocation-of-the-dify-service/model", "ja-jp/plugins/schema-definition/reverse-invocation-of-the-dify-service/tool", @@ -1552,7 +1552,7 @@ { "group": "ベストプラクティス", "pages": [ - "ja-jp/plugins/best-practice/README", + "ja-jp/plugins/best-practice", "ja-jp/plugins/best-practice/develop-a-slack-bot-plugin", "ja-jp/plugins/best-practice/how-to-use-mcp-zapier" ] @@ -1560,12 +1560,12 @@ { "group": "プラグインの公開", "pages": [ - "ja-jp/plugins/publish-plugins/README", + "ja-jp/plugins/publish-plugins", "ja-jp/plugins/publish-plugins/plugin-auto-publish-pr", { "group": "Difyマーケットプレイスへの公開", "pages": [ - "ja-jp/plugins/publish-plugins/publish-to-dify-marketplace/README", + "ja-jp/plugins/publish-plugins/publish-to-dify-marketplace", "ja-jp/plugins/publish-plugins/publish-to-dify-marketplace/plugin-developer-guidelines", "ja-jp/plugins/publish-plugins/publish-to-dify-marketplace/plugin-privacy-protection-guidelines" ] @@ -1584,7 +1584,7 @@ { "group": "バックエンド", "pages": [ - "ja-jp/development/backend/sandbox/README", + "ja-jp/development/backend/sandbox", "ja-jp/development/backend/sandbox/contribution" ] }, @@ -1637,7 +1637,7 @@ { "group": "检索增强生成（RAG）", "pages": [ - "ja-jp/learn-more/extended-reading/retrieval-augment/README", + "ja-jp/learn-more/extended-reading/retrieval-augment", "ja-jp/learn-more/extended-reading/retrieval-augment/hybrid-search", "ja-jp/learn-more/extended-reading/retrieval-augment/rerank", "ja-jp/learn-more/extended-reading/retrieval-augment/retrieval" @@ -1649,7 +1649,7 @@ { "group": "常见问题", "pages": [ - "ja-jp/learn-more/faq/README", + "ja-jp/learn-more/faq", "ja-jp/learn-more/faq/install-faq", "ja-jp/learn-more/faq/llms-use-faq", "ja-jp/learn-more/faq/plugins" @@ -1664,7 +1664,7 @@ { "group": "ユーザ規約", "pages": [ - "ja-jp/policies/agreement/README", + "ja-jp/policies/agreement", "ja-jp/policies/agreement/tos", "ja-jp/policies/agreement/privacy", "ja-jp/policies/agreement/get-compliance-report" @@ -1694,6 +1694,9 @@ "view" ] }, + "styling": { + "codeblocks": "system" + }, "redirects": [ { "source": "plugins/schema-definition/model", @@ -1785,7 +1788,7 @@ }, { "source": "zh-hans/guides/application-publishing/launch-your-webapp-quickly", - "destination": "zh-hans/guides/application-publishing/launch-your-webapp-quickly/readme" + "destination": "zh-hans/guides/application-publishing/launch-your-webapp-quickly/README" }, { "source": "zh-hans/guides/annotation", @@ -1952,7 +1955,7 @@ "destination": "/en/getting-started/dify-premium" }, { - "source": "/guides/model-configuration/readme", + "source": "/guides/model-configuration", "destination": "/en/guides/model-configuration/readme" }, { @@ -1980,7 +1983,7 @@ "destination": "/en/guides/model-configuration/load-balancing" }, { - "source": "/guides/application-orchestrate/readme", + "source": "/guides/application-orchestrate", "destination": "/en/guides/application-orchestrate/readme" }, { @@ -2000,7 +2003,7 @@ "destination": "/en/guides/application-orchestrate/agent" }, { - "source": "/guides/application-orchestrate/app-toolkits/readme", + "source": "/guides/application-orchestrate/app-toolkits", "destination": "/en/guides/application-orchestrate/app-toolkits/readme" }, { @@ -2008,7 +2011,7 @@ "destination": "/en/guides/application-orchestrate/app-toolkits/moderation-tool" }, { - "source": "/guides/workflow/readme", + "source": "/guides/workflow", "destination": "/en/guides/workflow/readme" }, { @@ -2020,8 +2023,8 @@ "destination": "/en/guides/workflow/variables" }, { - "source": "/guides/workflow/node/readme", - "destination": "/en/guides/workflow/node/readme" + "source": "/guides/workflow/node", + "destination": "/en/guides/workflow/node/start" }, { "source": "/guides/workflow/node/start", @@ -2112,7 +2115,7 @@ "destination": "/en/guides/workflow/file-upload" }, { - "source": "/guides/workflow/error-handling/readme", + "source": "/guides/workflow/error-handling", "destination": "/en/guides/workflow/error-handling/README" }, { @@ -2128,7 +2131,7 @@ "destination": "/en/guides/workflow/additional-features" }, { - "source": "/guides/workflow/debug-and-preview/readme", + "source": "/guides/workflow/debug-and-preview", "destination": "/en/guides/workflow/debug-and-preview/readme" }, { @@ -2164,7 +2167,7 @@ "destination": "/en/guides/workflow/bulletin" }, { - "source": "/guides/knowledge-base/readme", + "source": "/guides/knowledge-base", "destination": "/en/guides/knowledge-base/readme" }, { @@ -2176,7 +2179,7 @@ "destination": "/en/guides/knowledge-base/create-knowledge-and-upload-documents" }, { - "source": "/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "source": "/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data", "destination": "/en/guides/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme" }, { @@ -2196,7 +2199,7 @@ "destination": "/en/guides/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" }, { - "source": "/guides/knowledge-base/knowledge-and-documents-maintenance/readme", + "source": "/guides/knowledge-base/knowledge-and-documents-maintenance", "destination": "/en/guides/knowledge-base/knowledge-and-documents-maintenance/readme" }, { @@ -2240,7 +2243,7 @@ "destination": "/en/guides/knowledge-base/external-knowledge-api-documentation" }, { - "source": "/guides/tools/readme", + "source": "/guides/tools", "destination": "/en/guides/tools/readme" }, { @@ -2252,7 +2255,7 @@ "destination": "/en/guides/tools/advanced-tool-integration" }, { - "source": "/guides/tools/tool-configuration/readme", + "source": "/guides/tools/tool-configuration", "destination": "/en/guides/tools/tool-configuration/readme" }, { @@ -2304,12 +2307,12 @@ "destination": "/en/guides/tools/tool-configuration/comfyui" }, { - "source": "/guides/application-publishing/readme", + "source": "/guides/application-publishing", "destination": "/en/guides/application-publishing/readme" }, { - "source": "/guides/application-publishing/launch-your-webapp-quickly/readme", - "destination": "/en/guides/application-publishing/launch-your-webapp-quickly/readme" + "source": "/guides/application-publishing/launch-your-webapp-quickly", + "destination": "/en/guides/application-publishing/launch-your-webapp-quickly/README" }, { "source": "/guides/application-publishing/launch-your-webapp-quickly/web-app-settings", @@ -2336,7 +2339,7 @@ "destination": "/en/guides/application-publishing/based-on-frontend-templates" }, { - "source": "/guides/annotation/readme", + "source": "/guides/annotation", "destination": "/en/guides/annotation/readme" }, { @@ -2348,7 +2351,7 @@ "destination": "/en/guides/annotation/annotation-reply" }, { - "source": "/guides/monitoring/readme", + "source": "/guides/monitoring", "destination": "/en/guides/monitoring/readme" }, { @@ -2356,7 +2359,7 @@ "destination": "/en/guides/monitoring/analysis" }, { - "source": "/guides/monitoring/integrate-external-ops-tools/readme", + "source": "/guides/monitoring/integrate-external-ops-tools", "destination": "/en/guides/monitoring/integrate-external-ops-tools/readme" }, { @@ -2372,11 +2375,11 @@ "destination": "/en/guides/monitoring/integrate-external-ops-tools/integrate-opik" }, { - "source": "/guides/extension/readme", + "source": "/guides/extension", "destination": "/en/guides/extension/readme" }, { - "source": "/guides/extension/api-based-extension/readme", + "source": "/guides/extension/api-based-extension", "destination": "/en/guides/extension/api-based-extension/readme" }, { @@ -2392,7 +2395,7 @@ "destination": "/en/guides/extension/api-based-extension/moderation" }, { - "source": "/guides/extension/code-based-extension/readme", + "source": "/guides/extension/code-based-extension", "destination": "/en/guides/extension/code-based-extension/readme" }, { @@ -2404,7 +2407,7 @@ "destination": "/en/guides/extension/code-based-extension/moderation" }, { - "source": "/guides/workspace/readme", + "source": "/guides/workspace", "destination": "/en/guides/workspace/readme" }, { @@ -2416,7 +2419,7 @@ "destination": "/en/guides/workspace/invite-and-manage-members" }, { - "source": "/guides/management/readme", + "source": "/guides/management", "destination": "/en/guides/management/readme" }, { @@ -2440,11 +2443,11 @@ "destination": "/en/guides/management/version-control" }, { - "source": "/workshop/readme", + "source": "/workshop", "destination": "/en/workshop/readme" }, { - "source": "/workshop/basic/readme", + "source": "/workshop/basic", "destination": "/en/workshop/basic/readme" }, { @@ -2452,7 +2455,7 @@ "destination": "/en/workshop/basic/build-ai-image-generation-app" }, { - "source": "/workshop/intermediate/readme", + "source": "/workshop/intermediate", "destination": "/en/workshop/intermediate/readme" }, { @@ -2484,7 +2487,7 @@ "destination": "/en/plugins/introduction" }, { - "source": "/plugins/quick-start/readme", + "source": "/plugins/quick-start", "destination": "/en/plugins/quick-start/readme" }, { @@ -2492,7 +2495,7 @@ "destination": "/en/plugins/quick-start/install-plugins" }, { - "source": "/plugins/quick-start/develop-plugins/readme", + "source": "/plugins/quick-start/develop-plugins", "destination": "/en/plugins/quick-start/develop-plugins/readme" }, { @@ -2504,7 +2507,7 @@ "destination": "/en/plugins/quick-start/develop-plugins/tool-plugin" }, { - "source": "/plugins/quick-start/develop-plugins/model-plugin/readme", + "source": "/plugins/quick-start/develop-plugins/model-plugin", "destination": "/en/plugins/quick-start/develop-plugins/model-plugin/readme" }, { @@ -2540,7 +2543,7 @@ "destination": "/en/plugins/manage-plugins" }, { - "source": "/plugins/schema-definition/readme", + "source": "/plugins/schema-definition", "destination": "/en/plugins/schema-definition/readme" }, { @@ -2560,7 +2563,7 @@ "destination": "/en/plugins/schema-definition/agent" }, { - "source": "/plugins/schema-definition/model/readme", + "source": "/plugins/schema-definition/model", "destination": "/en/plugins/schema-definition/model/readme" }, { @@ -2580,7 +2583,7 @@ "destination": "/en/plugins/schema-definition/persistent-storage" }, { - "source": "/plugins/schema-definition/reverse-invocation-of-the-dify-service/readme", + "source": "/plugins/schema-definition/reverse-invocation-of-the-dify-service", "destination": "/en/plugins/schema-definition/reverse-invocation-of-the-dify-service/readme" }, { @@ -2648,7 +2651,7 @@ "destination": "/en/development/backend/sandbox/README" }, { - "source": "/development/backend/sandbox/readme", + "source": "/development/backend/sandbox", "destination": "/en/development/backend/sandbox/readme" }, { @@ -2792,7 +2795,7 @@ "destination": "/en/policies/open-source" }, { - "source": "/policies/agreement/readme", + "source": "/policies/agreement", "destination": "/en/policies/agreement/readme" }, { diff --git a/en/features/datasets/prompt-engineering.mdx b/en/features/datasets/prompt-engineering.mdx new file mode 100644 index 00000000..1471c479 --- /dev/null +++ b/en/features/datasets/prompt-engineering.mdx @@ -0,0 +1,30 @@ +--- +title: Designing Prompts & Orchestrating Applications +description: Learn how to use Dify to orchestrate applications and practice Prompt Engineering. By leveraging two built-in application types, you can build high-value AI applications. +--- + +At the core of Dify is a declarative approach to defining AI applications. Everything—from prompts and context to plugins—can be described in a single YAML file (this is also why it’s called “Dify”). The end result is either a single API or a ready-to-use WebApp. + +At the same time, Dify offers an intuitive visual interface for prompt orchestration, enabling developers to build application features in a WYSIWYG (What You See Is What You Get) manner based on prompts. Sounds easy, right? + +Whether your AI application is simple or complex, well-crafted prompts can significantly improve model output quality, reduce error rates, and meet specific scenario requirements. Dify provides two common types of applications: chat-based and text generation-based. In this section, you’ll visually build an AI application through orchestration. + +## Steps to Orchestrate an Application + +1. Define the application scenario and feature requirements +2. Design and test prompts and model parameters +3. Orchestrate prompts with user input +4. Publish the application +5. Monitor and iterate continuously + +## Understanding the Differences Between Application Types + +In Dify, chat-based and text generation-based applications differ slightly in how prompts are orchestrated. Chat-based apps must consider the “conversation lifecycle” to handle more complex user scenarios and context management. + +Prompt Engineering has evolved into a promising discipline worth ongoing exploration. Keep reading to learn how to orchestrate both types of applications. + +## Further Reading + +1. [Learn Prompting](https://learnprompting.org/) +2. [ChatGPT Prompt Engineering for Developers](https://www.deeplearning.ai/short-courses/chatgpt-prompt-engineering-for-developers/) +3. [Awesome ChatGPT Prompts](https://github.com/f/awesome-chatgpt-prompts) diff --git a/zh-hans/learn-more/extended-reading/prompt-engineering/README.mdx b/zh-hans/learn-more/extended-reading/prompt-engineering/README.mdx index 1f48d610..8380a74e 100644 --- a/zh-hans/learn-more/extended-reading/prompt-engineering/README.mdx +++ b/zh-hans/learn-more/extended-reading/prompt-engineering/README.mdx @@ -1,12 +1,8 @@ ---- -description: 掌握如何使用 Dify 编排应用和实践 Prompt Engineering，通过内置的两种应用类型，搭建出高价值的 AI 应用。 ---- - --- title: 设计提示词&编排应用 +description: 掌握如何使用 Dify 编排应用和实践 Prompt Engineering，通过内置的两种应用类型，搭建出高价值的 AI 应用。 --- - Dify 的核心理念是可声明式的定义 AI 应用，包括 Prompt、上下文和插件等等的一切都可以通过一个 YAML 文件描述（这也是为什么称之为 Dify ）。最终呈现的是单一 API 或开箱即用的 WebApp。 与此同时，Dify 提供了一个易用的 Prompt 编排界面，开发者能以 Prompt 为基础所见即所得的编排出各种应用特性。听上去是不是很简单？ diff --git a/zh-hans/learn-more/extended-reading/prompt-engineering/prompt-engineering-1/README.mdx b/zh-hans/learn-more/extended-reading/prompt-engineering/expert-mode.mdx similarity index 100% rename from zh-hans/learn-more/extended-reading/prompt-engineering/prompt-engineering-1/README.mdx rename to zh-hans/learn-more/extended-reading/prompt-engineering/expert-mode.mdx diff --git a/zh-hans/learn-more/extended-reading/prompt-engineering/prompt-engineering-1/prompt-engineering-template.mdx b/zh-hans/learn-more/extended-reading/prompt-engineering/prompt-engineering-template.mdx similarity index 100% rename from zh-hans/learn-more/extended-reading/prompt-engineering/prompt-engineering-1/prompt-engineering-template.mdx rename to zh-hans/learn-more/extended-reading/prompt-engineering/prompt-engineering-template.mdx