diff --git a/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/API Access.png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/API Access.png new file mode 100644 index 0000000..a992eb5 Binary files /dev/null and b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/API Access.png differ diff --git a/en/.gitbook/assets/image (13) (1) (1).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (13) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (13) (1) (1).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (13) (1) (1).png diff --git a/en/.gitbook/assets/image (16).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (16).png similarity index 100% rename from en/.gitbook/assets/image (16).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (16).png diff --git a/en/.gitbook/assets/image (22).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (22).png similarity index 100% rename from en/.gitbook/assets/image (22).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (22).png diff --git a/en/.gitbook/assets/image (27).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (27).png similarity index 100% rename from en/.gitbook/assets/image (27).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (27).png diff --git a/en/.gitbook/assets/image (3) (1) (1) (1).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (3) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (3) (1) (1) (1).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (3) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (30).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (30).png similarity index 100% rename from en/.gitbook/assets/image (30).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (30).png diff --git a/en/.gitbook/assets/image (39).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (39).png similarity index 100% rename from en/.gitbook/assets/image (39).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (39).png diff --git a/en/.gitbook/assets/image (42).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (42).png similarity index 100% rename from en/.gitbook/assets/image (42).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (42).png diff --git a/en/.gitbook/assets/image (43).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (43).png similarity index 100% rename from en/.gitbook/assets/image (43).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (43).png diff --git a/en/.gitbook/assets/image (45).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (45).png similarity index 100% rename from en/.gitbook/assets/image (45).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (45).png diff --git a/en/.gitbook/assets/image (46).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (46).png similarity index 100% rename from en/.gitbook/assets/image (46).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (46).png diff --git a/en/.gitbook/assets/image (48).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (48).png similarity index 100% rename from en/.gitbook/assets/image (48).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (48).png diff --git a/en/.gitbook/assets/image (55).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (55).png similarity index 100% rename from en/.gitbook/assets/image (55).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (55).png diff --git a/en/.gitbook/assets/image (57).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (57).png similarity index 100% rename from en/.gitbook/assets/image (57).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (57).png diff --git a/en/.gitbook/assets/image (6) (1) (1).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (6) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (6) (1) (1).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (6) (1) (1).png diff --git a/en/.gitbook/assets/image (8) (1) (1).png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (8) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (8) (1) (1).png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/image (8) (1) (1).png diff --git a/en/.gitbook/assets/share your App.png b/en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/share your App.png similarity index 100% rename from en/.gitbook/assets/share your App.png rename to en/.gitbook/assets/guides/application-publishing/launch-your-webapp-quickly/conversation-application/share your App.png diff --git a/en/.gitbook/assets/docs-1.png b/en/.gitbook/assets/guides/application_orchestrate/agent/docs-1.png similarity index 100% rename from en/.gitbook/assets/docs-1.png rename to en/.gitbook/assets/guides/application_orchestrate/agent/docs-1.png diff --git a/en/.gitbook/assets/docs-10.png b/en/.gitbook/assets/guides/application_orchestrate/agent/docs-10.png similarity index 100% rename from en/.gitbook/assets/docs-10.png rename to en/.gitbook/assets/guides/application_orchestrate/agent/docs-10.png diff --git a/en/.gitbook/assets/docs-2.png b/en/.gitbook/assets/guides/application_orchestrate/agent/docs-2.png similarity index 100% rename from en/.gitbook/assets/docs-2.png rename to en/.gitbook/assets/guides/application_orchestrate/agent/docs-2.png diff --git a/en/.gitbook/assets/docs-3.png b/en/.gitbook/assets/guides/application_orchestrate/agent/docs-3.png similarity index 100% rename from en/.gitbook/assets/docs-3.png rename to en/.gitbook/assets/guides/application_orchestrate/agent/docs-3.png diff --git a/en/.gitbook/assets/docs-4.png b/en/.gitbook/assets/guides/application_orchestrate/agent/docs-4.png similarity index 100% rename from en/.gitbook/assets/docs-4.png rename to en/.gitbook/assets/guides/application_orchestrate/agent/docs-4.png diff --git a/en/.gitbook/assets/docs-5.png b/en/.gitbook/assets/guides/application_orchestrate/agent/docs-5.png similarity index 100% rename from en/.gitbook/assets/docs-5.png rename to en/.gitbook/assets/guides/application_orchestrate/agent/docs-5.png diff --git a/en/.gitbook/assets/docs-6.png b/en/.gitbook/assets/guides/application_orchestrate/agent/docs-6.png similarity index 100% rename from en/.gitbook/assets/docs-6.png rename to en/.gitbook/assets/guides/application_orchestrate/agent/docs-6.png diff --git a/en/.gitbook/assets/docs-8.png b/en/.gitbook/assets/guides/application_orchestrate/agent/docs-8.png similarity index 100% rename from en/.gitbook/assets/docs-8.png rename to en/.gitbook/assets/guides/application_orchestrate/agent/docs-8.png diff --git a/en/.gitbook/assets/docs-9.png b/en/.gitbook/assets/guides/application_orchestrate/agent/docs-9.png similarity index 100% rename from en/.gitbook/assets/docs-9.png rename to en/.gitbook/assets/guides/application_orchestrate/agent/docs-9.png diff --git a/en/.gitbook/assets/content_moderation.png b/en/.gitbook/assets/guides/application_orchestrate/app_toolkits/content_moderation.png similarity index 100% rename from en/.gitbook/assets/content_moderation.png rename to en/.gitbook/assets/guides/application_orchestrate/app_toolkits/content_moderation.png diff --git a/en/.gitbook/assets/image (237).png b/en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (237).png similarity index 100% rename from en/.gitbook/assets/image (237).png rename to en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (237).png diff --git a/en/.gitbook/assets/image (240).png b/en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (240).png similarity index 100% rename from en/.gitbook/assets/image (240).png rename to en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (240).png diff --git a/en/.gitbook/assets/image (241).png b/en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (241).png similarity index 100% rename from en/.gitbook/assets/image (241).png rename to en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (241).png diff --git a/en/.gitbook/assets/image (242).png b/en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (242).png similarity index 100% rename from en/.gitbook/assets/image (242).png rename to en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (242).png diff --git a/en/.gitbook/assets/image (243).png b/en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (243).png similarity index 100% rename from en/.gitbook/assets/image (243).png rename to en/.gitbook/assets/guides/application_orchestrate/app_toolkits/image (243).png diff --git a/en/.gitbook/assets/moderation2.png b/en/.gitbook/assets/guides/application_orchestrate/app_toolkits/moderation2.png similarity index 100% rename from en/.gitbook/assets/moderation2.png rename to en/.gitbook/assets/guides/application_orchestrate/app_toolkits/moderation2.png diff --git a/en/.gitbook/assets/moderation3.png b/en/.gitbook/assets/guides/application_orchestrate/app_toolkits/moderation3.png similarity index 100% rename from en/.gitbook/assets/moderation3.png rename to en/.gitbook/assets/guides/application_orchestrate/app_toolkits/moderation3.png diff --git a/en/.gitbook/assets/moderation4.png b/en/.gitbook/assets/guides/application_orchestrate/app_toolkits/moderation4.png similarity index 100% rename from en/.gitbook/assets/moderation4.png rename to en/.gitbook/assets/guides/application_orchestrate/app_toolkits/moderation4.png diff --git a/en/.gitbook/assets/image (11) (1) (1).png b/en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (11) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (11) (1) (1).png rename to en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (11) (1) (1).png diff --git a/en/.gitbook/assets/image (15) (1) (1).png b/en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (15) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (15) (1) (1).png rename to en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (15) (1) (1).png diff --git a/en/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (2) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (2) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (21).png b/en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (21).png similarity index 100% rename from en/.gitbook/assets/image (21).png rename to en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (21).png diff --git a/en/.gitbook/assets/image (29).png b/en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (29).png similarity index 100% rename from en/.gitbook/assets/image (29).png rename to en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (29).png diff --git a/en/.gitbook/assets/image (32).png b/en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (32).png similarity index 100% rename from en/.gitbook/assets/image (32).png rename to en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (32).png diff --git a/en/.gitbook/assets/image (47).png b/en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (47).png similarity index 100% rename from en/.gitbook/assets/image (47).png rename to en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (47).png diff --git a/en/.gitbook/assets/image (9) (1) (1).png b/en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (9) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (9) (1) (1).png rename to en/.gitbook/assets/guides/application_orchestrate/conversation-application/image (9) (1) (1).png diff --git a/en/.gitbook/assets/OpenAI API Key.png b/en/.gitbook/assets/guides/application_orchestrate/creating-an-application/OpenAI API Key.png similarity index 100% rename from en/.gitbook/assets/OpenAI API Key.png rename to en/.gitbook/assets/guides/application_orchestrate/creating-an-application/OpenAI API Key.png diff --git a/en/.gitbook/assets/create a new App.png b/en/.gitbook/assets/guides/application_orchestrate/creating-an-application/create a new App.png similarity index 100% rename from en/.gitbook/assets/create a new App.png rename to en/.gitbook/assets/guides/application_orchestrate/creating-an-application/create a new App.png diff --git a/en/.gitbook/assets/000.png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/000.png similarity index 100% rename from en/.gitbook/assets/000.png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/000.png diff --git a/en/.gitbook/assets/Access to the Prompt Log (1).png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/Access to the Prompt Log (1).png similarity index 100% rename from en/.gitbook/assets/Access to the Prompt Log (1).png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/Access to the Prompt Log (1).png diff --git a/en/.gitbook/assets/Context parameters.png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/Context parameters.png similarity index 100% rename from en/.gitbook/assets/Context parameters.png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/Context parameters.png diff --git a/en/.gitbook/assets/Context.png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/Context.png similarity index 100% rename from en/.gitbook/assets/Context.png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/Context.png diff --git a/en/.gitbook/assets/QUERY.png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/QUERY.png similarity index 100% rename from en/.gitbook/assets/QUERY.png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/QUERY.png diff --git a/en/.gitbook/assets/history (1).png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/history (1).png similarity index 100% rename from en/.gitbook/assets/history (1).png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/history (1).png diff --git a/en/.gitbook/assets/log1.png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/log1.png similarity index 100% rename from en/.gitbook/assets/log1.png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/log1.png diff --git a/en/.gitbook/assets/screenshot-20231017-092613.png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/screenshot-20231017-092613.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231017-092613.png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/screenshot-20231017-092613.png diff --git a/en/.gitbook/assets/screenshot-20231017-092957.png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/screenshot-20231017-092957.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231017-092957.png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/screenshot-20231017-092957.png diff --git a/en/.gitbook/assets/shortcut.png b/en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/shortcut.png similarity index 100% rename from en/.gitbook/assets/shortcut.png rename to en/.gitbook/assets/guides/application_orchestrate/prompt-engineering/shortcut.png diff --git a/en/.gitbook/assets/image (12) (1) (1).png b/en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (12) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (12) (1) (1).png rename to en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (12) (1) (1).png diff --git a/en/.gitbook/assets/image (17).png b/en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (17).png similarity index 100% rename from en/.gitbook/assets/image (17).png rename to en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (17).png diff --git a/en/.gitbook/assets/image (28).png b/en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (28).png similarity index 100% rename from en/.gitbook/assets/image (28).png rename to en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (28).png diff --git a/en/.gitbook/assets/image (35).png b/en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (35).png similarity index 100% rename from en/.gitbook/assets/image (35).png rename to en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (35).png diff --git a/en/.gitbook/assets/image (36).png b/en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (36).png similarity index 100% rename from en/.gitbook/assets/image (36).png rename to en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (36).png diff --git a/en/.gitbook/assets/image (50).png b/en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (50).png similarity index 100% rename from en/.gitbook/assets/image (50).png rename to en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (50).png diff --git a/en/.gitbook/assets/image (52).png b/en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (52).png similarity index 100% rename from en/.gitbook/assets/image (52).png rename to en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (52).png diff --git a/en/.gitbook/assets/image (7) (1) (1).png b/en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (7) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (7) (1) (1).png rename to en/.gitbook/assets/guides/application_orchestrate/text-generation-application/image (7) (1) (1).png diff --git a/en/.gitbook/assets/image (3) (1) (1).png b/en/.gitbook/assets/guides/biao-zhu/image (3) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (3) (1) (1).png rename to en/.gitbook/assets/guides/biao-zhu/image (3) (1) (1).png diff --git a/en/.gitbook/assets/screenshot-20231218-172146 (1).png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-172146 (1).png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-172146 (1).png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-172146 (1).png diff --git a/en/.gitbook/assets/screenshot-20231218-172302.png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-172302.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-172302.png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-172302.png diff --git a/en/.gitbook/assets/screenshot-20231218-175934.png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-175934.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-175934.png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-175934.png diff --git a/en/.gitbook/assets/screenshot-20231218-180013.png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180013.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-180013.png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180013.png diff --git a/en/.gitbook/assets/screenshot-20231218-180135.png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180135.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-180135.png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180135.png diff --git a/en/.gitbook/assets/screenshot-20231218-180233.png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180233.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-180233.png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180233.png diff --git a/en/.gitbook/assets/screenshot-20231218-180337.png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180337.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-180337.png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180337.png diff --git a/en/.gitbook/assets/screenshot-20231218-180508.png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180508.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-180508.png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180508.png diff --git a/en/.gitbook/assets/screenshot-20231218-180611.png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180611.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-180611.png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180611.png diff --git a/en/.gitbook/assets/screenshot-20231218-180737.png b/en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180737.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231218-180737.png rename to en/.gitbook/assets/guides/biao-zhu/screenshot-20231218-180737.png diff --git a/en/.gitbook/assets/api_extension_edit.png b/en/.gitbook/assets/guides/extension/api_based_extension/api_extension_edit.png similarity index 100% rename from en/.gitbook/assets/api_extension_edit.png rename to en/.gitbook/assets/guides/extension/api_based_extension/api_extension_edit.png diff --git a/en/.gitbook/assets/app_tools_edit.png b/en/.gitbook/assets/guides/extension/api_based_extension/app_tools_edit.png similarity index 100% rename from en/.gitbook/assets/app_tools_edit.png rename to en/.gitbook/assets/guides/extension/api_based_extension/app_tools_edit.png diff --git a/en/.gitbook/assets/screenshot-20231128-104353 (1).png b/en/.gitbook/assets/guides/extension/api_based_extension/screenshot-20231128-104353 (1).png similarity index 100% rename from en/.gitbook/assets/screenshot-20231128-104353 (1).png rename to en/.gitbook/assets/guides/extension/api_based_extension/screenshot-20231128-104353 (1).png diff --git a/en/.gitbook/assets/screenshot-20231128-104353.png b/en/.gitbook/assets/guides/extension/api_based_extension/screenshot-20231128-104353.png similarity index 100% rename from en/.gitbook/assets/screenshot-20231128-104353.png rename to en/.gitbook/assets/guides/extension/api_based_extension/screenshot-20231128-104353.png diff --git a/en/.gitbook/assets/spaces_CdDIVDY6AtAz028MFT4d_uploads_8EgAgdMcArHAaJJFEEWA_ngrock copy.jpg b/en/.gitbook/assets/guides/extension/api_based_extension/spaces_CdDIVDY6AtAz028MFT4d_uploads_8EgAgdMcArHAaJJFEEWA_ngrock copy.jpg similarity index 100% rename from en/.gitbook/assets/spaces_CdDIVDY6AtAz028MFT4d_uploads_8EgAgdMcArHAaJJFEEWA_ngrock copy.jpg rename to en/.gitbook/assets/guides/extension/api_based_extension/spaces_CdDIVDY6AtAz028MFT4d_uploads_8EgAgdMcArHAaJJFEEWA_ngrock copy.jpg diff --git a/en/.gitbook/assets/spaces_CdDIVDY6AtAz028MFT4d_uploads_Z1SpULkGZ0xDBnSXOhC1_8000.webp b/en/.gitbook/assets/guides/extension/api_based_extension/spaces_CdDIVDY6AtAz028MFT4d_uploads_Z1SpULkGZ0xDBnSXOhC1_8000.webp similarity index 100% rename from en/.gitbook/assets/spaces_CdDIVDY6AtAz028MFT4d_uploads_Z1SpULkGZ0xDBnSXOhC1_8000.webp rename to en/.gitbook/assets/guides/extension/api_based_extension/spaces_CdDIVDY6AtAz028MFT4d_uploads_Z1SpULkGZ0xDBnSXOhC1_8000.webp diff --git a/en/.gitbook/assets/spaces_CdDIVDY6AtAz028MFT4d_uploads_kLpE7vN8jg1KrzeCWZtn_download.webp b/en/.gitbook/assets/guides/extension/api_based_extension/spaces_CdDIVDY6AtAz028MFT4d_uploads_kLpE7vN8jg1KrzeCWZtn_download.webp similarity index 100% rename from en/.gitbook/assets/spaces_CdDIVDY6AtAz028MFT4d_uploads_kLpE7vN8jg1KrzeCWZtn_download.webp rename to en/.gitbook/assets/guides/extension/api_based_extension/spaces_CdDIVDY6AtAz028MFT4d_uploads_kLpE7vN8jg1KrzeCWZtn_download.webp diff --git a/en/.gitbook/assets/Weather_search_tool.jpeg b/en/.gitbook/assets/guides/knowledge-base/Weather_search_tool.jpeg similarity index 100% rename from en/.gitbook/assets/Weather_search_tool.jpeg rename to en/.gitbook/assets/guides/knowledge-base/Weather_search_tool.jpeg diff --git a/en/.gitbook/assets/api_based.png b/en/.gitbook/assets/guides/knowledge-base/api_based.png similarity index 100% rename from en/.gitbook/assets/api_based.png rename to en/.gitbook/assets/guides/knowledge-base/api_based.png diff --git a/en/.gitbook/assets/api_based_extension1.png b/en/.gitbook/assets/guides/knowledge-base/api_based_extension1.png similarity index 100% rename from en/.gitbook/assets/api_based_extension1.png rename to en/.gitbook/assets/guides/knowledge-base/api_based_extension1.png diff --git a/en/.gitbook/assets/create-knowledge-2.png b/en/.gitbook/assets/guides/knowledge-base/create-knowledge-2.png similarity index 100% rename from en/.gitbook/assets/create-knowledge-2.png rename to en/.gitbook/assets/guides/knowledge-base/create-knowledge-2.png diff --git a/en/.gitbook/assets/create-knowledge.png b/en/.gitbook/assets/guides/knowledge-base/create-knowledge.png similarity index 100% rename from en/.gitbook/assets/create-knowledge.png rename to en/.gitbook/assets/guides/knowledge-base/create-knowledge.png diff --git a/en/.gitbook/assets/custom-chunk-settings.png b/en/.gitbook/assets/guides/knowledge-base/custom-chunk-settings.png similarity index 100% rename from en/.gitbook/assets/custom-chunk-settings.png rename to en/.gitbook/assets/guides/knowledge-base/custom-chunk-settings.png diff --git a/en/.gitbook/assets/dataset-api-token.png b/en/.gitbook/assets/guides/knowledge-base/dataset-api-token.png similarity index 100% rename from en/.gitbook/assets/dataset-api-token.png rename to en/.gitbook/assets/guides/knowledge-base/dataset-api-token.png diff --git a/en/.gitbook/assets/full-text-search.png b/en/.gitbook/assets/guides/knowledge-base/full-text-search.png similarity index 100% rename from en/.gitbook/assets/full-text-search.png rename to en/.gitbook/assets/guides/knowledge-base/full-text-search.png diff --git a/en/.gitbook/assets/hybrid-search.png b/en/.gitbook/assets/guides/knowledge-base/hybrid-search.png similarity index 100% rename from en/.gitbook/assets/hybrid-search.png rename to en/.gitbook/assets/guides/knowledge-base/hybrid-search.png diff --git a/en/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (112).png b/en/.gitbook/assets/guides/knowledge-base/image (112).png similarity index 100% rename from en/.gitbook/assets/image (112).png rename to en/.gitbook/assets/guides/knowledge-base/image (112).png diff --git a/en/.gitbook/assets/image (128).png b/en/.gitbook/assets/guides/knowledge-base/image (128).png similarity index 100% rename from en/.gitbook/assets/image (128).png rename to en/.gitbook/assets/guides/knowledge-base/image (128).png diff --git a/en/.gitbook/assets/image (179).png b/en/.gitbook/assets/guides/knowledge-base/image (179).png similarity index 100% rename from en/.gitbook/assets/image (179).png rename to en/.gitbook/assets/guides/knowledge-base/image (179).png diff --git a/en/.gitbook/assets/image (180).png b/en/.gitbook/assets/guides/knowledge-base/image (180).png similarity index 100% rename from en/.gitbook/assets/image (180).png rename to en/.gitbook/assets/guides/knowledge-base/image (180).png diff --git a/en/.gitbook/assets/image (181).png b/en/.gitbook/assets/guides/knowledge-base/image (181).png similarity index 100% rename from en/.gitbook/assets/image (181).png rename to en/.gitbook/assets/guides/knowledge-base/image (181).png diff --git a/en/.gitbook/assets/image (182).png b/en/.gitbook/assets/guides/knowledge-base/image (182).png similarity index 100% rename from en/.gitbook/assets/image (182).png rename to en/.gitbook/assets/guides/knowledge-base/image (182).png diff --git a/en/.gitbook/assets/image (183).png b/en/.gitbook/assets/guides/knowledge-base/image (183).png similarity index 100% rename from en/.gitbook/assets/image (183).png rename to en/.gitbook/assets/guides/knowledge-base/image (183).png diff --git a/en/.gitbook/assets/image (185).png b/en/.gitbook/assets/guides/knowledge-base/image (185).png similarity index 100% rename from en/.gitbook/assets/image (185).png rename to en/.gitbook/assets/guides/knowledge-base/image (185).png diff --git a/en/.gitbook/assets/image (186).png b/en/.gitbook/assets/guides/knowledge-base/image (186).png similarity index 100% rename from en/.gitbook/assets/image (186).png rename to en/.gitbook/assets/guides/knowledge-base/image (186).png diff --git a/en/.gitbook/assets/image (187).png b/en/.gitbook/assets/guides/knowledge-base/image (187).png similarity index 100% rename from en/.gitbook/assets/image (187).png rename to en/.gitbook/assets/guides/knowledge-base/image (187).png diff --git a/en/.gitbook/assets/image (189).png b/en/.gitbook/assets/guides/knowledge-base/image (189).png similarity index 100% rename from en/.gitbook/assets/image (189).png rename to en/.gitbook/assets/guides/knowledge-base/image (189).png diff --git a/en/.gitbook/assets/image (190).png b/en/.gitbook/assets/guides/knowledge-base/image (190).png similarity index 100% rename from en/.gitbook/assets/image (190).png rename to en/.gitbook/assets/guides/knowledge-base/image (190).png diff --git a/en/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (2) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (2) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (2) (1) (1) (1) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (2) (1) (1) (1) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (2) (1) (1) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (2) (1) (1) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (3) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (3) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (3) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (3) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (3) (1) (1) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (3) (1) (1) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (3) (1) (1) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (3) (1) (1) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (4) (1) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (4) (1) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (4) (1) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (4) (1) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/image (5) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (5) (1).png similarity index 100% rename from en/.gitbook/assets/image (5) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (5) (1).png diff --git a/en/.gitbook/assets/image (6) (1) (1) (1) (1).png b/en/.gitbook/assets/guides/knowledge-base/image (6) (1) (1) (1) (1).png similarity index 100% rename from en/.gitbook/assets/image (6) (1) (1) (1) (1).png rename to en/.gitbook/assets/guides/knowledge-base/image (6) (1) (1) (1) (1).png diff --git a/en/.gitbook/assets/log.jpeg b/en/.gitbook/assets/guides/knowledge-base/log.jpeg similarity index 100% rename from en/.gitbook/assets/log.jpeg rename to en/.gitbook/assets/guides/knowledge-base/log.jpeg diff --git a/en/.gitbook/assets/sync-notion.png b/en/.gitbook/assets/guides/knowledge-base/sync-notion.png similarity index 100% rename from en/.gitbook/assets/sync-notion.png rename to en/.gitbook/assets/guides/knowledge-base/sync-notion.png diff --git a/en/.gitbook/assets/vector-search.png b/en/.gitbook/assets/guides/knowledge-base/vector-search.png similarity index 100% rename from en/.gitbook/assets/vector-search.png rename to en/.gitbook/assets/guides/knowledge-base/vector-search.png diff --git a/en/.gitbook/assets/weather inquiry.png b/en/.gitbook/assets/guides/knowledge-base/weather inquiry.png similarity index 100% rename from en/.gitbook/assets/weather inquiry.png rename to en/.gitbook/assets/guides/knowledge-base/weather inquiry.png diff --git a/en/guides/application-orchestrate/agent.md b/en/guides/application-orchestrate/agent.md index c539531..a1aee29 100644 --- a/en/guides/application-orchestrate/agent.md +++ b/en/guides/application-orchestrate/agent.md @@ -8,19 +8,19 @@ An Agent Assistant can leverage the reasoning abilities of large language models To facilitate quick learning and use, application templates for the Agent Assistant are available in the 'Explore' section. You can integrate these templates into your workspace. The new Dify 'Studio' also allows the creation of a custom Agent Assistant to suit individual requirements. This assistant can assist in analyzing financial reports, composing reports, designing logos, and organizing travel plans. -

Explore-Agent Assistant Application Template

+

Explore-Agent Assistant Application Template

After entering 'Studio-Assistant', you can begin orchestrating by choosing the Agent Assistant. -

Studio-Create Agent Assistant

+

Studio-Create Agent Assistant

The task completion ability of the Agent Assistant depends on the inference capabilities of the model selected. We recommend using a more powerful model series like GPT-4 when employing Agent Assistant to achieve more stable task completion results. -

Selecting the Reasoning Model for Agent Assistant

+

Selecting the Reasoning Model for Agent Assistant

You can write prompts for the Agent Assistant in 'Instructions'. To achieve optimal results, you can clearly define its task objectives, workflow, resources, and limitations in the instructions. -

Orchestrating Prompts for Agent Assistant

+

Orchestrating Prompts for Agent Assistant

## Adding Tools for the Agent Assistant @@ -30,7 +30,7 @@ In the "Tools" section, you are able to add tools that are required for use. The You have the option to directly use built-in tools in Dify, or you can easily import custom API tools (currently supporting OpenAPI/Swagger and OpenAI Plugin standards). -

Adding Tools for the Assistant

+

Adding Tools for the Assistant

The tool allows you to create more powerful AI applications on Dify. For example, you can orchestrate suitable tools for Agent Assistant, enabling it to complete complex tasks through reasoning, step decomposition, and tool invocation. Additionally, the tool facilitates the integration of your application with other systems or services, allowing interaction with the external environment, such as code execution and access to exclusive information sources. @@ -40,22 +40,22 @@ On Dify, two inference modes are provided for Agent Assistant: Function Calling In the Agent settings, you can modify the iteration limit of the Agent. -

Function Calling Mode

+

Function Calling Mode

-

ReAct Mode

+

ReAct Mode

## Configuring the Conversation Opener You can set up a conversation opener and initial questions for your Agent Assistant. The configured conversation opener will be displayed at the beginning of each user's first interaction, showcasing the types of tasks the Agent can perform, along with examples of questions that can be asked. -

Configuring the Conversation Opener and Initial Questions

+

Configuring the Conversation Opener and Initial Questions

## Debugging and Preview After orchestrating your Agent Assistant, you have the option to debug and preview it before publishing it as an application. This allows you to assess the effectiveness of the agent in completing tasks. -

Debugging and Preview

+

Debugging and Preview

## Application Publish -

Publishing the Application as a Webapp

+

Publishing the Application as a Webapp

diff --git a/en/guides/application-orchestrate/app-toolkits/README.md b/en/guides/application-orchestrate/app-toolkits/README.md index 3d8a690..5d3f18f 100644 --- a/en/guides/application-orchestrate/app-toolkits/README.md +++ b/en/guides/application-orchestrate/app-toolkits/README.md @@ -4,31 +4,31 @@ In **Studio -- Application Orchestration**, click **Add Feature** to open the ap The application toolbox provides various additional features for Dify's [applications](../#application_type): -
+
### Conversation Opening In conversational applications, the AI will proactively say the first sentence or ask a question. You can edit the content of the opening, including the initial question. Using conversation openings can guide users to ask questions, explain the application background, and lower the barrier for initiating a conversation. -

Conversation Opening

+

Conversation Opening

### Next Step Question Suggestions Setting next step question suggestions allows the AI to generate 3 follow-up questions based on the previous conversation, guiding the next round of interaction. -
+
### Text-to-Speech When enabled, this feature converts the AI's responses into natural-sounding speech. -
+
### Speech-to-Text When enabled, you can record audio within the application and automatically convert the speech into text. -
+
### Citation and Attribution diff --git a/en/guides/application-orchestrate/app-toolkits/moderation-tool.md b/en/guides/application-orchestrate/app-toolkits/moderation-tool.md index f0504fa..618cd31 100644 --- a/en/guides/application-orchestrate/app-toolkits/moderation-tool.md +++ b/en/guides/application-orchestrate/app-toolkits/moderation-tool.md @@ -2,7 +2,7 @@ In our interactions with AI applications, we often have stringent requirements in terms of content security, user experience, and legal regulations. At this point, we need the "Sensitive Word Review" feature to create a better interactive environment for end-users. On the prompt orchestration page, click "Add Function" and locate the "Content Review" toolbox at the bottom: -

Content moderation

+

Content moderation

## Call the OpenAI Moderation API @@ -10,16 +10,16 @@ OpenAI, along with most companies providing LLMs, includes content moderation fe Now you can also directly call the OpenAI Moderation API on Dify; you can review either input or output content simply by entering the corresponding "preset reply." -

OpenAI Moderation

+

OpenAI Moderation

## Keywords Developers can customize the sensitive words they need to review, such as using "kill" as a keyword to perform an audit action when users input. The preset reply content should be "The content is violating usage policies." It can be anticipated that when a user inputs a text snippet containing "kill" at the terminal, it will trigger the sensitive word review tool and return the preset reply content. -

Keywords

+

Keywords

## Moderation Extension Different enterprises often have their own mechanisms for sensitive word moderation. When developing their own AI applications, such as an internal knowledge base ChatBot, enterprises need to moderate the query content input by employees for sensitive words. For this purpose, developers can write an API extension based on their enterprise's internal sensitive word moderation mechanisms, specifically referring to [moderation-extension.md](extension/api\_based\_extension/moderation-extension.md "mention"), which can then be called on Dify to achieve a high degree of customization and privacy protection for sensitive word review. -

Moderation Extension

+

Moderation Extension

diff --git a/en/guides/application-orchestrate/conversation-application.md b/en/guides/application-orchestrate/conversation-application.md index 01e3f00..ca9f6d2 100644 --- a/en/guides/application-orchestrate/conversation-application.md +++ b/en/guides/application-orchestrate/conversation-application.md @@ -16,13 +16,13 @@ Here, we use a interviewer application as an example to introduce the way to com Click the "Create Application" button on the homepage to create an application. Fill in the application name, and select **"Chat App"** as the application type. -

Create Application

+

Create Application

#### Step 2: Compose the Application After the application is successfully created, it will automatically redirect to the application overview page. Click on the left-hand menu: “**Prompt Eng.**” to compose the application. -
+
**2.1 Fill in Prompts** @@ -34,33 +34,33 @@ The prompt we are filling in here is: > > When I am ready, you can start asking questions. -![](<../../../.gitbook/assets/image (38).png>) +![]() For a better experience, we will add an opening dialogue: `"Hello, {{name}}. I'm your interviewer, Bob. Are you ready?"` To add the opening dialogue, click the "Add Feature" button in the upper left corner, and enable the "Conversation remarkers" feature: -
+
And then edit the opening remarks: -![](<../../../.gitbook/assets/image (15) (1) (1).png>) +![]() **2.2 Adding Context** If an application wants to generate content based on private contextual conversations, it can use our [knowledge](../../../features/datasets/) feature. Click the "Add" button in the context to add a knowledge base. -![](<../../../.gitbook/assets/image (9) (1) (1).png>) +![]() **2.3 Debugging** We fill in the user input on the right side and debug the input content. -![](<../../../.gitbook/assets/image (11) (1) (1).png>) +![]() If the results are not satisfactory, you can adjust the prompts and model parameters. Click on the model name in the upper right corner to set the parameters of the model: -![](<../../../.gitbook/assets/image (29).png>) +![]() We support the GPT-4 model. @@ -72,6 +72,6 @@ After debugging the application, click the **"Publish"** button in the upper rig On the overview page, you can find the sharing address of the application. Click the "Preview" button to preview the shared application. Click the "Share" button to get the sharing link address. Click the "Settings" button to set the shared application information. -
+
If you want to customize the application that you share, you can Fork our open source [WebApp template](https://github.com/langgenius/webapp-conversation). Based on the template, you can modify the application to meet your specific needs and style requirements. diff --git a/en/guides/application-orchestrate/creating-an-application.md b/en/guides/application-orchestrate/creating-an-application.md index 62fe8a7..860284c 100644 --- a/en/guides/application-orchestrate/creating-an-application.md +++ b/en/guides/application-orchestrate/creating-an-application.md @@ -20,7 +20,7 @@ Dify offers two types of applications: text generation and conversational. More After logging in as an administrator in Dify, go to the main navigation application page Click "Create New Application" Choose a conversational or text generation application and give it a name (modifiable later) -

Create a new App

+

Create a new App

We provide some templates in the application creation interface, and you can click to create from a template in the popup when creating an application. These templates will provide inspiration and reference for the application you want to develop. @@ -32,7 +32,7 @@ If you have obtained a template from the community or someone else, you can clic If you are using it for the first time, you will be prompted to enter your OpenAI API key. A properly functioning LLM key is a prerequisite for using Dify. If you don't have one yet, please apply for one. -

Enter your OpenAI API Key

+

Enter your OpenAI API Key

After creating an application or selecting an existing one, you will arrive at an application overview page showing the application's profile. You can directly access your WebApp or check the API status here, as well as enable or disable them. diff --git a/en/guides/application-orchestrate/prompt-engineering/README.md b/en/guides/application-orchestrate/prompt-engineering/README.md index abc48f4..b4c518c 100644 --- a/en/guides/application-orchestrate/prompt-engineering/README.md +++ b/en/guides/application-orchestrate/prompt-engineering/README.md @@ -4,7 +4,7 @@ description: >- Engineering, and build high-value AI applications with the two built-in application types. --- - + # Prompt Engineering The core concept of Dify is the declarative definition of AI applications. Everything including Prompts, context, plugins, etc. can be described in a YAML file (which is why it is called Dify). It ultimately presents a single API or out-of-the-box WebApp. diff --git a/en/guides/application-orchestrate/prompt-engineering/prompt-engineering-expert-mode.md b/en/guides/application-orchestrate/prompt-engineering/prompt-engineering-expert-mode.md index 8ddb04e..ed822ab 100644 --- a/en/guides/application-orchestrate/prompt-engineering/prompt-engineering-expert-mode.md +++ b/en/guides/application-orchestrate/prompt-engineering/prompt-engineering-expert-mode.md @@ -10,12 +10,12 @@ Well, before you try the new mode, you should be aware of some essential element * **Complete** - When choosing a model, if you see "COMPLETE" on the right side of the model name, it indicates a Text completion model e.g. + When choosing a model, if you see "COMPLETE" on the right side of the model name, it indicates a Text completion model e.g. This type of model accepts a freeform text string and generates a text completion, attempting to match any context or pattern you provide. For example, if you write the prompt `As René Descartes said, "I think, therefore"`, it's highly likely that the model will return `"I am."` as the completion.\\ * **Chat** - When choosing a model, if you see "CHAT" on the right side of the model name, it indicates a Chat completions model e.g. + When choosing a model, if you see "CHAT" on the right side of the model name, it indicates a Chat completions model e.g. This type of model takes a list of messages as input and returns a message generated by the model as output. It consists of three message types: `SYSTEM`, `USER`, and `ASSISTANT`. @@ -33,15 +33,15 @@ Well, before you try the new mode, you should be aware of some essential element Stop\_Sequences refers to specific words, phrases, or characters used to send a signal to LLM to stop generating text.\\ * **Blocks** - + When users input a query, the app processes the query as search criteria for the knowledge. The organized results from the search then replace the variable `Context`, allowing the LLM to reference the content for its response. - + The query content is only available in the Text completion models of conversational applications. The content entered by the user during the conversation will replace this variable, initiating a new turn of dialogue. - + The conversation history is only available in the Text completion model of conversational applications. When engaging in multiple conversations in dialogue applications, Dify will assemble and concatenate the historical dialogue records according to built-in rules and replace the 'Conversation History' variable. The `Human` and `Assistant` prefixes can be modified by clicking on the `...` after "Conversation History".\\ * **Prompt Template** @@ -62,7 +62,7 @@ Well, before you try the new mode, you should be aware of some essential element After creating an application, you can switch to the **Expert Mode** on the prompt design page. -

Access to the Expert Mode

+

Access to the Expert Mode

{% hint style="warning" %} After modifying the prompts in the **Expert Mode** and publishing the application, you will not be able to revert back to the **Basic Mode**. @@ -72,10 +72,10 @@ After modifying the prompts in the **Expert Mode** and publishing the applicatio In both two modes, you can modify the parameters for the inserting context, which includes **TopK** and **Score Threshold**. -

Context parameters

+

Context parameters

{% hint style="warning" %} -Please note that only after uploading the context, the built-in prompts containing will be displayed on the prompt design page. +Please note that only after uploading the context, the built-in prompts containing will be displayed on the prompt design page. {% endhint %} **TopK:** The value is an integer from 1 to 10. @@ -116,7 +116,7 @@ Because LLM stops generating content before the next `Human1:`. You can enter "/" in the text editor to quickly bring up Blocks to insert into the prompt. -

shortcut "/"

+

shortcut "/"

{% hint style="warning" %} Except for `Variables`, other Blocks cannot be inserted repeatedly. In different applications and models, the Blocks that can be inserted will vary based on different prompt template structures. @@ -159,7 +159,7 @@ During debugging, you can not only check the user's input and LLM's responses bu In the debugging preview interface, after engaging in a conversation with the AI, simply move the mouse pointer over any user session, and you will see the "Log" icon button in the upper-left corner. Click on it to view the Prompt Log. -

Access to the Prompt Log

+

Access to the Prompt Log

In the Prompt Log, we can clearly see: @@ -167,7 +167,7 @@ In the Prompt Log, we can clearly see: 2. Relevant text snippets referenced in the current session. 3. Historical session records. -

Prompt Log

+

Prompt Log

From the log, we can view the complete prompts that have been assembled by the system and sent to LLM, and we can continuously improve prompt input based on debugging results. @@ -177,4 +177,4 @@ In the initial application's main interface, you can find "Logs & Ann." in the l For more head to 👉 [logs.md](../logs.md "mention") . -

Logs & Ann.

+

Logs & Ann.

diff --git a/en/guides/application-orchestrate/text-generation-application.md b/en/guides/application-orchestrate/text-generation-application.md index d5b1249..c8190cf 100644 --- a/en/guides/application-orchestrate/text-generation-application.md +++ b/en/guides/application-orchestrate/text-generation-application.md @@ -16,13 +16,13 @@ Here, we use a translation application as an example to introduce the way to com Click the "Create Application" button on the homepage to create an application. Fill in the application name, and select "Text Generator" as the application type. -

Create Application

+

Create Application

#### Step 2: Compose the Application After the application is successfully created, it will automatically redirect to the application overview page. Click on the left-hand menu: “**Prompt Eng.**” to compose the application. -
+
**2.1 Fill in Prefix Prompts** @@ -30,29 +30,29 @@ Prompts are used to give a series of instructions and constraints to the AI resp The prompt we are filling in here is: `Translate the content to: {{language}}. The content is as follows:` -![](<../../../.gitbook/assets/image (7) (1) (1).png>) +![]() **2.2 Adding Context** If the application wants to generate content based on private contextual conversations, our [knowledge](../../../features/datasets/) feature can be used. Click the "Add" button in the context to add a knowledge base. -![](<../../../.gitbook/assets/image (12) (1) (1).png>) +![]() **2.3 Adding Future: Generate more like this** Generating more like this allows you to generate multiple texts at once, which you can edit and continue generating from. Click on the "Add Future" button in the upper left corner to enable this feature. -
+
**2.4 Debugging** We debug on the right side by entering variables and querying content. Click the "Run" button to view the results of the operation. -![](<../../../.gitbook/assets/image (17).png>) +![]() If the results are not satisfactory, you can adjust the prompts and model parameters. Click on the model name in the upper right corner to set the parameters of the model: -![](<../../../.gitbook/assets/image (36).png>) +![]() **2.5 Publish** @@ -62,6 +62,6 @@ After debugging the application, click the **"Publish"** button in the upper rig You can find the sharing address of the application on the overview page. Click the "Preview" button to preview the shared application. Click the "Share" button to obtain the sharing link address. Click the "Settings" button to set the information of the shared application. -
+
If you want to customize the application shared outside, you can Fork our open source [WebApp template](https://github.com/langgenius/webapp-text-generator). Based on the template, you can modify the application to meet your specific situation and style requirements. diff --git a/en/guides/application-publishing/developing-with-apis.md b/en/guides/application-publishing/developing-with-apis.md index 4f8d19b..232519d 100644 --- a/en/guides/application-publishing/developing-with-apis.md +++ b/en/guides/application-publishing/developing-with-apis.md @@ -15,7 +15,7 @@ Dify offers a "Backend-as-a-Service" API, providing numerous benefits to AI appl Choose an application, and find the API Access in the left-side navigation of the Apps section. On this page, you can view the API documentation provided by Dify and manage credentials for accessing the API. -

API document

+

API document

You can create multiple access credentials for an application to deliver to different users or developers. This means that API users can use the AI capabilities provided by the application developer, but the underlying Prompt engineering, knowledge, and tool capabilities are encapsulated. diff --git a/en/guides/application-publishing/launch-your-webapp-quickly/README.md b/en/guides/application-publishing/launch-your-webapp-quickly/README.md index 7248116..6365046 100644 --- a/en/guides/application-publishing/launch-your-webapp-quickly/README.md +++ b/en/guides/application-publishing/launch-your-webapp-quickly/README.md @@ -9,7 +9,7 @@ One of the benefits of creating AI applications with Dify is that you can launch In the application overview page, you can find a card for the AI site (WebApp). Simply enable WebApp access to get a shareable link for your users. -

Share your WebApp

+

Share your WebApp

We provide a sleek WebApp interface for both of the following applications: @@ -38,8 +38,8 @@ Dify supports embedding your AI application into your business website. With thi Copy the script code and paste it into the `` or `` tags on your website. -
+
For example, if you paste the script code into the section of your official website, you will get an AI chatbot on your website: -
+
diff --git a/en/guides/application-publishing/launch-your-webapp-quickly/conversation-application.md b/en/guides/application-publishing/launch-your-webapp-quickly/conversation-application.md index d73c42a..eafde08 100644 --- a/en/guides/application-publishing/launch-your-webapp-quickly/conversation-application.md +++ b/en/guides/application-publishing/launch-your-webapp-quickly/conversation-application.md @@ -12,33 +12,33 @@ Conversational applications use a question-and-answer model to maintain a dialog If you have the requirement to fill in variables when you apply the layout, you need to fill in the information according to the prompts before entering the dialog window: -
+
Fill in the necessary content and click the "Start Chat" button to start chatting. -
+
Move to the AI's answer, you can copy the content of the conversation, and give the answer "like" and "dislike". -
+
### Conversation creation, pinning and deletion Click the "New Conversation" button to start a new conversation. Move to a session, and the session can be "pinned" and "deleted". -
+
### Conversation remarks If the "Conversation remarks" function is enabled when the application is programmed, the AI application will automatically initiate the first sentence of the dialogue when creating a new dialogue: -
+
### Follow-up If the "Follow-up" function is enabled during the application arrangement, the system will automatically generate 3 related question suggestions after the dialogue: -
+
### Speech to text @@ -46,10 +46,10 @@ If the "Speech to Text" function is enabled during application programming, you _Please make sure that the device environment you are using is authorized to use the microphone._ -
+
### Citations and Attributions If the "Quotations and Attribution" feature is enabled during the application arrangement, the dialogue returns will automatically show the quoted knowledge document sources. -
+
diff --git a/en/guides/application-publishing/launch-your-webapp-quickly/text-generator.md b/en/guides/application-publishing/launch-your-webapp-quickly/text-generator.md index 05cd205..d1ecbac 100644 --- a/en/guides/application-publishing/launch-your-webapp-quickly/text-generator.md +++ b/en/guides/application-publishing/launch-your-webapp-quickly/text-generator.md @@ -15,7 +15,7 @@ Let's introduce them separately. Enter the query content, click the run button, and the result will be generated on the right, as shown in the following figure: -
+
In the generated results section, click the "Copy" button to copy the content to the clipboard. Click the "Save" button to save the content. You can see the saved content in the "Saved" tab. You can also "like" and "dislike" the generated content. @@ -29,17 +29,17 @@ In the above scenario, the batch operation function is used, which is convenient Click the "Run Batch" tab to enter the batch run page. -
+
#### Step 2 Download the template and fill in the content Click the Download Template button to download the template. Edit the template, fill in the content, and save as a `.csv` file. -
+
#### Step 3 Upload the file and run -
+
If you need to export the generated content, you can click the download "button" in the upper right corner to export as a `csv` file. @@ -49,10 +49,10 @@ If you need to export the generated content, you can click the download "button" Click the "Save" button below the generated results to save the running results. In the "Saved" tab, you can see all saved content. -
+
### Generate more similar results If the "more similar" function is turned on when applying the arrangement. Clicking the "more similar" button in the web application generates content similar to the current result. As shown below: -
+
diff --git a/en/guides/biao-zhu/annotation-reply.md b/en/guides/biao-zhu/annotation-reply.md index 4d1acd7..ea5522b 100644 --- a/en/guides/biao-zhu/annotation-reply.md +++ b/en/guides/biao-zhu/annotation-reply.md @@ -19,13 +19,13 @@ The feature provides an alternative system for enhancing retrieval, skipping the 4. Without a match, the query follows the standard LLM or RAG process. 5. Deactivating Annotation Reply ceases matching replies from the annotations. -

Annotation Reply Process

+

Annotation Reply Process

## Activation Navigate to “Build Apps -> Add Feature” to enable the Annotation Reply feature. -
+
Start by setting the parameters for Annotation Reply. These include the Score threshold and the Embedding model. @@ -34,48 +34,48 @@ Start by setting the parameters for Annotation Reply. These include the Score th Select 'Save' for immediate application of these settings. The system then creates and stores embeddings for all existing annotations. -
+
## Adding Annotations in Debug Mode Annotations can be added or modified directly on the model's replies within the debug and preview interface. -
+
Edit and save these replies to ensure high quality. -
+
When a user repeats a query, the system uses the relevant saved annotation for a direct reply. -
+
## Enabling Annotations in System Logs Turn on the Annotation Reply feature under “Build Apps -> Logs and Annotations -> Annotations.” -
+
## Adjusting Backend Parameters for Annotations **Parameter Settings:** These include the Score threshold and Embedding model, just as in the initial configuration. -
+
## Bulk Importing Annotated Q\&As **Import Process:** Use the provided template to format Q\&A pairs for annotations, then upload them in bulk. -
+
## Bulk Exporting Annotated Q\&As **Export Function:** This feature allows for a one-time export of all annotated Q\&A pairs stored in the system. -
+
## Reviewing Annotation Hit History View the history of each annotation's use, including edits, queries, replies, sources, similarity scores, and timestamps. This information is valuable for ongoing improvements to your annotations. -
+
diff --git a/en/guides/extension/README.md b/en/guides/extension/README.md index fd180df..75d1545 100644 --- a/en/guides/extension/README.md +++ b/en/guides/extension/README.md @@ -5,6 +5,3 @@ In the process of creating AI applications, developers face constantly changing [API Based Extension](api_based_extension/ "mention") [code-based-extension.md](code-based-extension.md "mention") - - - diff --git a/en/guides/extension/api-based-extension/README.md b/en/guides/extension/api-based-extension/README.md index 668b83e..9756cdd 100644 --- a/en/guides/extension/api-based-extension/README.md +++ b/en/guides/extension/api-based-extension/README.md @@ -7,7 +7,7 @@ Developers can extend module capabilities through the API extension module. Curr Before extending module capabilities, prepare an API and an API Key for authentication, which can also be automatically generated by Dify. In addition to developing the corresponding module capabilities, follow the specifications below so that Dify can invoke the API correctly. -

Add API Extension

+

Add API Extension

## API Specifications @@ -194,11 +194,11 @@ The default port is 8000. The complete address of the API is: `http://127.0.0.1: #### Configure this API in Dify. -
+
#### Select this API extension in the App. -
+
When debugging the App, Dify will request the configured API and send the following content (example): @@ -230,7 +230,7 @@ Since Dify's cloud version can't access internal network API services, you can u 1. Visit the Ngrok official website at [https://ngrok.com](https://ngrok.com/), register, and download the Ngrok file. -
+
2. After downloading, go to the download directory. Unzip the package and run the initialization script as instructed: @@ -241,7 +241,7 @@ $ ./ngrok config add-authtoken 你的Token 3. Check the port of your local API service. -
+
Run the following command to start: @@ -251,7 +251,7 @@ $ ./ngrok http [port number] Upon successful startup, you'll see something like the following: -
+
4. Find the 'Forwarding' address, like the sample domain `https://177e-159-223-41-52.ngrok-free.app`, and use it as your public domain. diff --git a/en/guides/extension/api-based-extension/cloudflare-workers.md b/en/guides/extension/api-based-extension/cloudflare-workers.md index c61bef9..3bb4b37 100644 --- a/en/guides/extension/api-based-extension/cloudflare-workers.md +++ b/en/guides/extension/api-based-extension/cloudflare-workers.md @@ -43,9 +43,9 @@ npm run deploy After successful deployment, you will get a public internet address, which you can add in Dify as an API Endpoint. Please note not to miss the `endpoint` path. -

Adding API Endpoint in Dify

+

Adding API Endpoint in Dify

-

Adding API Tool in the App edit page

+

Adding API Tool in the App edit page

## Other Logic TL;DR diff --git a/en/guides/extension/api-based-extension/external-data-tool.md b/en/guides/extension/api-based-extension/external-data-tool.md index 9234f46..cfcfc8e 100644 --- a/en/guides/extension/api-based-extension/external-data-tool.md +++ b/en/guides/extension/api-based-extension/external-data-tool.md @@ -133,6 +133,8 @@ Follow the above steps and run the service to see the newly added custom type.

Add Tool

+ + ### 5. **Debug the Extension** Now, you can select the custom `Weather Search` external data tool extension type in the Dify application orchestration interface for debugging. diff --git a/en/guides/extension/code-based-extension/external-data-tool.md b/en/guides/extension/code-based-extension/external-data-tool.md index 9234f46..cfcfc8e 100644 --- a/en/guides/extension/code-based-extension/external-data-tool.md +++ b/en/guides/extension/code-based-extension/external-data-tool.md @@ -133,6 +133,8 @@ Follow the above steps and run the service to see the newly added custom type.

Add Tool

+ + ### 5. **Debug the Extension** Now, you can select the custom `Weather Search` external data tool extension type in the Dify application orchestration interface for debugging. diff --git a/en/guides/knowledge-base/README.md b/en/guides/knowledge-base/README.md index 524593f..553cb22 100644 --- a/en/guides/knowledge-base/README.md +++ b/en/guides/knowledge-base/README.md @@ -6,7 +6,6 @@ The training data for large language models is generally based on publicly avail {% hint style="info" %} To learn more, please check the extended reading on [Retrieval-Augmented Generation (RAG)](../../learn-more/extended-reading/retrieval-augment/) {% endhint %} - Dify's knowledge base feature visualizes each step in the RAG pipeline, providing a simple and easy-to-use user interface to help application builders in managing personal or team knowledge bases, and quickly integrating them into AI applications. You only need to prepare text content, such as: diff --git a/en/guides/knowledge-base/create-knowledge-and-upload-documents.md b/en/guides/knowledge-base/create-knowledge-and-upload-documents.md index 04e2d0f..b0eace8 100644 --- a/en/guides/knowledge-base/create-knowledge-and-upload-documents.md +++ b/en/guides/knowledge-base/create-knowledge-and-upload-documents.md @@ -4,12 +4,12 @@ Click on Knowledge in the main navigation bar of Dify. On this page, you can see your existing knowledge bases. Click **Create Knowledge** to enter the setup wizard: -

Creating Knowledge

+

Creating Knowledge

* If you have already prepared the files, you can start by uploading them; * If you have not prepared any documents yet, you can first create an empty dataset; -

Creating Knowledge Base

+

Creating Knowledge Base

{% hint style="info" %} If you choose to use an external data source when creating a dataset, the type of knowledge cannot be changed. This is to prevent difficulties in managing datasets caused by having multiple data sources in a single knowledge base. If you need to use multiple data sources, it is recommended to create multiple knowledge. @@ -44,7 +44,7 @@ Segmentation and cleaning support two configuration strategies: * Automatic mode (to be phased out) * Custom mode -
+
In custom mode, users can configure chunk settings and cleaning settings according to different document formats and scenario requirements. @@ -120,7 +120,7 @@ The specific configurations for the three retrieval methods are as follows: Definition: By generating query embeddings to search the most similar text chunk to the query's vector representation. -

Vector Search Settings

+

Vector Search Settings

TopK: Used to filter the text chunk most similar to the user’s query. The system will dynamically adjust the number of chunks based on the context window size of the selected model. The default value is 3. @@ -134,7 +134,7 @@ Rerank model: After configuring the API key for the Rerank model in the “Model Definition: Indexing all terms in the document, allowing users to query any terms and return text fragments containing those terms. -

Full-Text Search Settings

+

Full-Text Search Settings

TopK: Used to filter the text fragments most similar to the user’s query. The system will dynamically adjust the number of fragments based on the context window size of the selected model. The default value is 3. @@ -144,7 +144,7 @@ Rerank model: After configuring the API key for the Rerank model in the “Model Performs full-text and vector search simultaneously, with an additional reranking step to select the best match for the user’s query from the two types of query results, requiring Rerank model API configuration. -

Hybrid Search Settings

+

Hybrid Search Settings

TopK: Used to filter the text fragments most similar to the user’s query. The system will dynamically adjust the number of fragments based on the context window size of the selected model. The default value is 3. diff --git a/en/guides/knowledge-base/external-data-tool.md b/en/guides/knowledge-base/external-data-tool.md index 8d38eda..6cbb49c 100644 --- a/en/guides/knowledge-base/external-data-tool.md +++ b/en/guides/knowledge-base/external-data-tool.md @@ -15,20 +15,20 @@ When an end-user makes a request to the dialogue system, the platform's backend 1. Before using the external data tool, you need to prepare an API and an API Key for authentication. Please read [external\_data\_tool.md](../extension/api\_based\_extension/external\_data\_tool.md "mention") 2. Dify provides centralized API management. After adding the API extension configuration in the settings interface, it can be used directly in various applications on Dify. -

API-based Extension

+

API-based Extension

3. For example, to "query the weather," enter the name, API endpoint, and API Key in the "Add API-based Extension" dialog box. After saving, we can call the API. -

Weather Inquiry

+

Weather Inquiry

4. On the prompt orchestration page, click the "+ Add" button next to "Tools." In the opened "Add Tool" dialog box, fill in the name and variable name (the variable name will be referenced in the prompt, please fill in English), and select the API-based extension added in step 2. -

External_data_tool

+

External_data_tool

5. In this way, we can assemble the queried external data into the prompt. For example, to query today's weather in London, you can add the `location` variable, input "London," combine it with the external data tool's extension variable name `weather_data`, and the debug output will be as follows: -

Weather_search_tool

+

Weather_search_tool

In the dialogue logs, we can also see the real-time data returned by the API: -

Prompt Log

\ No newline at end of file +

Prompt Log

\ No newline at end of file diff --git a/en/guides/knowledge-base/integrate-knowledge-within-application.md b/en/guides/knowledge-base/integrate-knowledge-within-application.md index 6f58b9c..30a7932 100644 --- a/en/guides/knowledge-base/integrate-knowledge-within-application.md +++ b/en/guides/knowledge-base/integrate-knowledge-within-application.md @@ -13,7 +13,7 @@ Taking a chat assistant as an example, the process is as follows: 5. In **Debug and Preview**, input user questions related to the knowledge base for debugging 6. After debugging, **Save and Publish** as an AI knowledge base Q&A application -

Associating a knowledge base within the application

+

Associating a knowledge base within the application

*** @@ -25,7 +25,7 @@ Enter **Context -- Parameter Settings -- Recall Settings** to choose the recall **Multi-Path Recall**: Matches all knowledge bases simultaneously based on user intent, querying related text fragments from multiple knowledge bases. After a re-ranking step, the best result matching the user question is selected from the multi-path query results. Requires configuration of the Rerank model API. -
+
**How to Choose a Recall Mode** @@ -43,7 +43,7 @@ When users upload a knowledge base, the system reasoning model automatically gen Below is the technical flowchart for the N-Choose-1 Recall mode: -
+
{% hint style="info" %} N-Choose-1 Recall relies on the reasoning capability of the model and has many usage restrictions. The recall strategy for this mode is planned to be adjusted in Q3 2024. @@ -69,7 +69,7 @@ The Multi-Path Recall mode does not depend on the reasoning capability of the mo The re-ranking model improves the results of semantic sorting by reordering the candidate document list based on the semantic match between the user question and the documents. It calculates the relevance score between the user question and each candidate document and returns a list of documents sorted by relevance from high to low. -

Hybrid Retrieval + Re-Ranking

+

Hybrid Retrieval + Re-Ranking

{% hint style="info" %} For more information about Rerank, please refer to the extended reading [Re-Ranking](integrate\_knowledge\_within\_application.md#zhong-pai-xu-rerank). @@ -79,7 +79,7 @@ For more information about Rerank, please refer to the extended reading [Re-Rank Dify currently supports the Cohere Rerank model. Enter the "Model Provider -> Cohere" page and fill in the Rerank model's API key: -

Configuring the Cohere Rerank model in the model provider

+

Configuring the Cohere Rerank model in the model provider

How to obtain the Cohere Rerank model? @@ -93,7 +93,7 @@ Besides supporting the Cohere Rerank API, you can also use local inference frame Go to the "Dataset -> Create Dataset -> Retrieval Settings" page and add the Rerank settings. In addition to setting Rerank when creating a dataset, you can also change the Rerank configuration in the settings of an already created dataset. Change the Rerank configuration in the recall mode settings of the application orchestration dataset. -

Setting the Rerank model in the dataset retrieval mode

+

Setting the Rerank model in the dataset retrieval mode

**TopK**: Used to set the number of relevant documents returned after Rerank. @@ -101,4 +101,4 @@ Go to the "Dataset -> Create Dataset -> Retrieval Settings" page and add the Rer When setting the recall mode to Multi-Path Recall in the "Prompt Orchestration -> Context -> Settings" page, you need to enable the Rerank model. -

Setting the Rerank model in the dataset multi-path recall mode

\ No newline at end of file +

Setting the Rerank model in the dataset multi-path recall mode

\ No newline at end of file diff --git a/en/guides/knowledge-base/knowledge-and-documents-maintenance.md b/en/guides/knowledge-base/knowledge-and-documents-maintenance.md index 7f4a402..c6dde81 100644 --- a/en/guides/knowledge-base/knowledge-and-documents-maintenance.md +++ b/en/guides/knowledge-base/knowledge-and-documents-maintenance.md @@ -4,7 +4,7 @@ Each document uploaded to the knowledge base is stored in the form of text segments (Chunks). You can view the specific text content of each segment in the segment list. -

Viewing uploaded document segments

+

Viewing uploaded document segments

*** @@ -18,15 +18,15 @@ When checking segment quality, pay attention to the following situations: * **Overly short text segments**, leading to semantic loss; -

Overly short text segments

+

Overly short text segments

* **Overly long text segments**, leading to semantic noise affecting matching accuracy; -

Overly long text segments

+

Overly long text segments

* **Obvious semantic truncation**, which occurs when using maximum segment length limits, leading to forced semantic truncation and missing content during recall; -

Obvious semantic truncation

+

Obvious semantic truncation

*** @@ -34,11 +34,11 @@ When checking segment quality, pay attention to the following situations: In the segment list, click "Add Segment" to add one or multiple custom segments to the document. -
+
When adding segments in bulk, you need to first download the CSV format segment upload template, edit all the segment content in Excel according to the template format, save the CSV file, and then upload it. -

Bulk adding custom segments

+

Bulk adding custom segments

*** @@ -46,7 +46,7 @@ When adding segments in bulk, you need to first download the CSV format segment In the segment list, you can directly edit the content of the added segments, including the text content and keywords of the segments. -

Editing document segments

+

Editing document segments

*** @@ -58,7 +58,7 @@ In addition to marking metadata information from different source documents, suc The metadata filtering and citation source functions are not yet supported in the current version. {% endhint %} -

Metadata management

+

Metadata management

*** @@ -68,7 +68,7 @@ In "Knowledge Base > Document List," click "Add File" to upload new documents or A knowledge base (Knowledge) is a collection of documents (Documents). Documents can be uploaded by developers or operators, or synchronized from other data sources (usually corresponding to a file unit in the data source). -

Uploading new documents to the knowledge base

+

Uploading new documents to the knowledge base

*** @@ -84,7 +84,7 @@ A knowledge base (Knowledge) is a collection of documents (Documents). Documents Click **Settings** in the left navigation of the knowledge base to change the following settings: -

Knowledge base settings

+

Knowledge base settings

**Knowledge Base Name**: Define a name to identify a knowledge base. @@ -108,4 +108,4 @@ When the recall mode of the knowledge base is N-Choose-1, the knowledge base is Dify Knowledge Base provides a complete set of standard APIs. Developers can use API calls to perform daily management and maintenance operations such as adding, deleting, modifying, and querying documents and segments in the knowledge base. Please refer to the [Knowledge Base API Documentation](maintain-dataset-via-api.md). -

Knowledge base API management

\ No newline at end of file +

Knowledge base API management

\ No newline at end of file diff --git a/en/guides/knowledge-base/maintain-dataset-via-api.md b/en/guides/knowledge-base/maintain-dataset-via-api.md index 5c9436b..81620db 100644 --- a/en/guides/knowledge-base/maintain-dataset-via-api.md +++ b/en/guides/knowledge-base/maintain-dataset-via-api.md @@ -13,7 +13,7 @@ Navigate to the dataset page, and you can switch to the **API** page from the left navigation. On this page, you can view the dataset API documentation provided by Dify and manage the credentials for accessing the dataset API in **API Keys**. -

Knowledge API Document

+

Knowledge API Document

### API Call Examples diff --git a/en/guides/knowledge-base/retrieval-test-and-citation.md b/en/guides/knowledge-base/retrieval-test-and-citation.md index c841e7e..aaecf1c 100644 --- a/en/guides/knowledge-base/retrieval-test-and-citation.md +++ b/en/guides/knowledge-base/retrieval-test-and-citation.md @@ -4,11 +4,11 @@ The Dify Knowledge Base provides a text recall testing feature to debug the recall effects under different retrieval methods and parameter configurations. You can enter common user questions in the **Source Text** input box, click **Test**, and view the recall results in the **Recalled Paragraph** section on the right. The **Recent Queries** section allows you to view the history of query records; if the knowledge base is linked to an application, queries triggered from within the application can also be viewed here. -

Recall Testing

+

Recall Testing

Clicking the icon in the upper right corner of the source text input box allows you to change the retrieval method and specific parameters of the current knowledge base. **Changes will only take effect during the recall testing process.** After completing the recall test and confirming changes to the retrieval parameters of the knowledge base, you need to make changes in [Knowledge Base Settings > Retrieval Settings](retrieval\_test\_and\_citation.md#zhi-shi-ku-she-zhi). -

Recall Testing - Retrieval Settings

+

Recall Testing - Retrieval Settings

**Suggested Steps for Recall Testing:** @@ -27,7 +27,7 @@ Clicking the icon in the upper right corner of the source text input box allows When testing the knowledge base effect within the application, you can go to **Workspace -- Add Function -- Citation Attribution** to enable the citation attribution feature. -

Enable Citation and Attribution Feature

+

Enable Citation and Attribution Feature

After enabling the feature, when the large language model responds to a question by citing content from the knowledge base, you can view specific citation paragraph information below the response content, including **original segment text, segment number, matching degree**, etc. Clicking **Jump to Knowledge Base** above the cited segment allows quick access to the segment list in the knowledge base, facilitating developers in debugging and editing. diff --git a/en/guides/knowledge-base/sync-from-notion.md b/en/guides/knowledge-base/sync-from-notion.md index 243e0c4..4ef70d8 100644 --- a/en/guides/knowledge-base/sync-from-notion.md +++ b/en/guides/knowledge-base/sync-from-notion.md @@ -23,7 +23,7 @@ _**Please note: Images and files are not currently supported for import, and tab If your Notion content is modified, you can directly click **Sync** in the Dify dataset **Document List Page** to perform a one-click data synchronization. This step requires token consumption. -

Sync Notion Content

+

Sync Notion Content

### Integration Configuration Method for Community Edition Notion @@ -37,11 +37,11 @@ Specific steps: Click the **New integration** button. The type is **Internal** by default (cannot be modified). Select the associated space, enter the integration name, upload a logo, and click **Submit** to create the integration successfully. -
+
After creating the integration, you can update its settings as needed under the Capabilities tab and click the **Show** button under Secrets to copy the secrets. -
+
After copying, go back to the Dify source code, and configure the relevant environment variables in the **.env** file. The environment variables are as follows: @@ -53,7 +53,7 @@ After copying, go back to the Dify source code, and configure the relevant envir **You need to upgrade the internal integration to a public integration.** Navigate to the Distribution page of the integration, and toggle the switch to make the integration public. When switching to the public setting, you need to fill in additional information in the Organization Information form below, including your company name, website, and redirect URL, then click the **Submit** button. -
+
After successfully making the integration public on the integration settings page, you will be able to access the integration key in the Keys tab: diff --git a/translate.py b/translate.py index daf5bd6..bf87a10 100644 --- a/translate.py +++ b/translate.py @@ -63,4 +63,100 @@ def translate_markdown_files(input_folder, output_folder, target_language="japan print(f"Translation completed. Translated files are saved in {output_folder}") # Example usage -translate_markdown_files("zh_CN/explore", "jp/explore", target_language="japanese") \ No newline at end of file +# translate_markdown_files("zh_CN/explore", "jp/explore", target_language="japanese") + +# ------------------------------------------------------------ +# Create a new folder for the translated files +import os +import shutil + +def create_empty_folders(source_dir, target_dir): + """ + Create a set of empty folders in the target directory with the same folder structure as the source directory. + + :param source_dir: Path to the source directory. + :param target_dir: Path to the target directory where the empty folders will be created. + """ + # Ensure the target directory exists + os.makedirs(target_dir, exist_ok=True) + + # Walk through the source directory + for dirpath, dirnames, filenames in os.walk(source_dir): + # Construct the path structure in the target directory + structure = os.path.join(target_dir, os.path.relpath(dirpath, source_dir)) + # Create each directory in the target directory + for dirname in dirnames: + os.makedirs(os.path.join(structure, dirname), exist_ok=True) + +# Example usage +source_directory = 'zh_CN' +target_directory = 'en/.gitbook' +# create_empty_folders(source_directory, target_directory) + + +# ------------------------------------------------------------ +import os +import re +import shutil + +def check_and_move_images(markdown_dir, images_dir, target_images_dir): + """ + Check if the images used in the markdown files exist and then move them to a specified location. + If images are already at the specified location, then check the existence. + + :param markdown_dir: Directory containing markdown files. + :param images_dir: Directory containing images referenced in the markdown files. + :param target_images_dir: Target directory to move the images to. + """ + # Regex to find markdown image syntax + img_regex = r'