From b74b1b8291be67f4425024c2e7ad46c5fcd7d6f9 Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Mon, 9 Mar 2026 16:41:50 +0800 Subject: [PATCH 01/10] fix: remove href from language blocks to preserve page on language switch Mintlify's language switcher navigates to the explicit href when set, instead of doing smart path prefix replacement. Removing href lets the switcher stay on the current page when switching languages. Co-Authored-By: Claude Opus 4.6 --- docs.json | 36 ------------------------------------ 1 file changed, 36 deletions(-) diff --git a/docs.json b/docs.json index 00179b8cd..71aa61095 100644 --- a/docs.json +++ b/docs.json @@ -21,7 +21,6 @@ { "language": "en", "default": true, - "href": "en/use-dify/getting-started/introduction", "dropdowns": [ { "dropdown": "Use Dify", @@ -408,7 +407,6 @@ }, { "language": "zh", - "href": "zh/use-dify/getting-started/introduction", "dropdowns": [ { "dropdown": "使用 Dify", @@ -795,7 +793,6 @@ }, { "language": "ja", - "href": "ja/use-dify/getting-started/introduction", "dropdowns": [ { "dropdown": "Dify を使う", @@ -1186,7 +1183,6 @@ "languages": [ { "language": "zh", - "href": "versions/3-7-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -1427,7 +1423,6 @@ { "language": "en", "default": true, - "href": "versions/3-7-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -1664,7 +1659,6 @@ }, { "language": "ja", - "href": "versions/3-7-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -1807,7 +1801,6 @@ "languages": [ { "language": "zh", - "href": "versions/3-6-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -2039,7 +2032,6 @@ { "language": "en", "default": true, - "href": "versions/3-6-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -2267,7 +2259,6 @@ }, { "language": "ja", - "href": "versions/3-6-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -2401,7 +2392,6 @@ "languages": [ { "language": "zh", - "href": "versions/3-5-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -2621,7 +2611,6 @@ { "language": "en", "default": true, - "href": "versions/3-5-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -2837,7 +2826,6 @@ }, { "language": "ja", - "href": "versions/3-5-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -2971,7 +2959,6 @@ "languages": [ { "language": "zh", - "href": "versions/3-4-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -3190,7 +3177,6 @@ { "language": "en", "default": true, - "href": "versions/3-4-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -3404,7 +3390,6 @@ }, { "language": "ja", - "href": "versions/3-4-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -3537,7 +3522,6 @@ "languages": [ { "language": "zh", - "href": "versions/3-3-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -3756,7 +3740,6 @@ { "language": "en", "default": true, - "href": "versions/3-3-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -3970,7 +3953,6 @@ }, { "language": "ja", - "href": "versions/3-3-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -4103,7 +4085,6 @@ "languages": [ { "language": "zh", - "href": "versions/3-2-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -4321,7 +4302,6 @@ { "language": "en", "default": true, - "href": "versions/3-2-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -4530,7 +4510,6 @@ { "language": "ja", "default": true, - "href": "versions/3-2-x/ja/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -4656,7 +4635,6 @@ "languages": [ { "language": "zh", - "href": "versions/3-0-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -4870,7 +4848,6 @@ { "language": "en", "default": true, - "href": "versions/3-0-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -5076,7 +5053,6 @@ }, { "language": "ja", - "href": "versions/3-0-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -5201,7 +5177,6 @@ "languages": [ { "language": "zh", - "href": "/zh/introduction", "groups": [ { "group": "用户手册", @@ -5307,7 +5282,6 @@ { "language": "en", "default": true, - "href": "/en/introduction", "groups": [ { "group": "User Guide", @@ -5428,7 +5402,6 @@ }, { "language": "ja", - "href": "/ja/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -5553,7 +5526,6 @@ "languages": [ { "language": "zh", - "href": "/zh/introduction", "groups": [ { "group": "用户手册", @@ -5659,7 +5631,6 @@ { "language": "en", "default": true, - "href": "/en/introduction", "groups": [ { "group": "User Guide", @@ -5780,7 +5751,6 @@ }, { "language": "ja", - "href": "/ja/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -5890,7 +5860,6 @@ "languages": [ { "language": "zh", - "href": "/zh/introduction", "groups": [ { "group": "用户手册", @@ -5996,7 +5965,6 @@ { "language": "en", "default": true, - "href": "/en/introduction", "groups": [ { "group": "User Guide", @@ -6117,7 +6085,6 @@ }, { "language": "ja", - "href": "/ja/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -6227,7 +6194,6 @@ "languages": [ { "language": "zh", - "href": "/zh/introduction", "groups": [ { "group": "用户手册", @@ -6332,7 +6298,6 @@ { "language": "en", "default": true, - "href": "/en/introduction", "groups": [ { "group": "User Guide", @@ -6452,7 +6417,6 @@ }, { "language": "ja", - "href": "/ja/introduction", "groups": [ { "group": "ユーザーマニュアル", From e0f62d49522eafe870ef55bb095b24e843fbd157 Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Mon, 9 Mar 2026 17:08:28 +0800 Subject: [PATCH 02/10] Revert "fix: remove href from language blocks to preserve page on language switch" This reverts commit b74b1b8291be67f4425024c2e7ad46c5fcd7d6f9. --- docs.json | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs.json b/docs.json index 71aa61095..00179b8cd 100644 --- a/docs.json +++ b/docs.json @@ -21,6 +21,7 @@ { "language": "en", "default": true, + "href": "en/use-dify/getting-started/introduction", "dropdowns": [ { "dropdown": "Use Dify", @@ -407,6 +408,7 @@ }, { "language": "zh", + "href": "zh/use-dify/getting-started/introduction", "dropdowns": [ { "dropdown": "使用 Dify", @@ -793,6 +795,7 @@ }, { "language": "ja", + "href": "ja/use-dify/getting-started/introduction", "dropdowns": [ { "dropdown": "Dify を使う", @@ -1183,6 +1186,7 @@ "languages": [ { "language": "zh", + "href": "versions/3-7-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -1423,6 +1427,7 @@ { "language": "en", "default": true, + "href": "versions/3-7-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -1659,6 +1664,7 @@ }, { "language": "ja", + "href": "versions/3-7-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -1801,6 +1807,7 @@ "languages": [ { "language": "zh", + "href": "versions/3-6-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -2032,6 +2039,7 @@ { "language": "en", "default": true, + "href": "versions/3-6-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -2259,6 +2267,7 @@ }, { "language": "ja", + "href": "versions/3-6-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -2392,6 +2401,7 @@ "languages": [ { "language": "zh", + "href": "versions/3-5-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -2611,6 +2621,7 @@ { "language": "en", "default": true, + "href": "versions/3-5-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -2826,6 +2837,7 @@ }, { "language": "ja", + "href": "versions/3-5-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -2959,6 +2971,7 @@ "languages": [ { "language": "zh", + "href": "versions/3-4-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -3177,6 +3190,7 @@ { "language": "en", "default": true, + "href": "versions/3-4-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -3390,6 +3404,7 @@ }, { "language": "ja", + "href": "versions/3-4-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -3522,6 +3537,7 @@ "languages": [ { "language": "zh", + "href": "versions/3-3-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -3740,6 +3756,7 @@ { "language": "en", "default": true, + "href": "versions/3-3-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -3953,6 +3970,7 @@ }, { "language": "ja", + "href": "versions/3-3-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -4085,6 +4103,7 @@ "languages": [ { "language": "zh", + "href": "versions/3-2-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -4302,6 +4321,7 @@ { "language": "en", "default": true, + "href": "versions/3-2-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -4510,6 +4530,7 @@ { "language": "ja", "default": true, + "href": "versions/3-2-x/ja/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -4635,6 +4656,7 @@ "languages": [ { "language": "zh", + "href": "versions/3-0-x/zh/user-guide/introduction", "groups": [ { "group": "用户手册", @@ -4848,6 +4870,7 @@ { "language": "en", "default": true, + "href": "versions/3-0-x/en/user-guide/introduction", "groups": [ { "group": "User Guide", @@ -5053,6 +5076,7 @@ }, { "language": "ja", + "href": "versions/3-0-x/ja/user-guide/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -5177,6 +5201,7 @@ "languages": [ { "language": "zh", + "href": "/zh/introduction", "groups": [ { "group": "用户手册", @@ -5282,6 +5307,7 @@ { "language": "en", "default": true, + "href": "/en/introduction", "groups": [ { "group": "User Guide", @@ -5402,6 +5428,7 @@ }, { "language": "ja", + "href": "/ja/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -5526,6 +5553,7 @@ "languages": [ { "language": "zh", + "href": "/zh/introduction", "groups": [ { "group": "用户手册", @@ -5631,6 +5659,7 @@ { "language": "en", "default": true, + "href": "/en/introduction", "groups": [ { "group": "User Guide", @@ -5751,6 +5780,7 @@ }, { "language": "ja", + "href": "/ja/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -5860,6 +5890,7 @@ "languages": [ { "language": "zh", + "href": "/zh/introduction", "groups": [ { "group": "用户手册", @@ -5965,6 +5996,7 @@ { "language": "en", "default": true, + "href": "/en/introduction", "groups": [ { "group": "User Guide", @@ -6085,6 +6117,7 @@ }, { "language": "ja", + "href": "/ja/introduction", "groups": [ { "group": "ユーザーマニュアル", @@ -6194,6 +6227,7 @@ "languages": [ { "language": "zh", + "href": "/zh/introduction", "groups": [ { "group": "用户手册", @@ -6298,6 +6332,7 @@ { "language": "en", "default": true, + "href": "/en/introduction", "groups": [ { "group": "User Guide", @@ -6417,6 +6452,7 @@ }, { "language": "ja", + "href": "/ja/introduction", "groups": [ { "group": "ユーザーマニュアル", From 755b8ec6214c15a6168b9510ec3f201ae4f261bb Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Mon, 9 Mar 2026 17:35:18 +0800 Subject: [PATCH 03/10] fix: restructure navigation from versions>languages to languages>versions Mintlify's language switcher only preserves the current page when languages are the top-level navigation partition. Previously, versions were the top level with languages nested inside, causing the switcher to redirect to the introduction page instead of the same page in the target language. Also removes explicit href from language blocks and fixes ja having default=true incorrectly in the 3.2.x version config. Co-Authored-By: Claude Opus 4.6 --- docs.json | 7176 ++++++++++++++++++++++++++--------------------------- 1 file changed, 3543 insertions(+), 3633 deletions(-) diff --git a/docs.json b/docs.json index 00179b8cd..20ffd98f6 100644 --- a/docs.json +++ b/docs.json @@ -14,14 +14,13 @@ "dark": "https://assets-docs.dify.ai/2025/05/c51f1cda47c1d9a4a162d7736f6e4c53.svg" }, "navigation": { - "versions": [ + "languages": [ { - "version": "Latest", - "languages": [ + "language": "en", + "default": true, + "versions": [ { - "language": "en", - "default": true, - "href": "en/use-dify/getting-started/introduction", + "version": "Latest", "dropdowns": [ { "dropdown": "Use Dify", @@ -404,1020 +403,681 @@ } ] } - ] + ], + "default": true }, { - "language": "zh", - "href": "zh/use-dify/getting-started/introduction", - "dropdowns": [ + "version": "3.7.x (Enterprise)", + "groups": [ { - "dropdown": "使用 Dify", - "icon": "book-open", + "group": "User Guide", "pages": [ + "versions/3-7-x/en/user-guide/introduction", { - "group": " ", + "group": "Model Configuration", + "pages": [ + "versions/3-0-x/en/user-guide/model-configuration/readme", + "versions/3-0-x/en/user-guide/model-configuration/new-provider", + "versions/3-0-x/en/user-guide/model-configuration/predefined-model", + "versions/3-0-x/en/user-guide/model-configuration/customizable-model", + "versions/3-0-x/en/user-guide/model-configuration/interfaces", + "versions/3-0-x/en/user-guide/model-configuration/schema", + "versions/3-5-x/en/user-guide/model-configuration/manage-model-credential", + "versions/3-5-x/en/user-guide/model-configuration/load-balancing" + ] + }, + { + "group": "Application Orchestration", "pages": [ + "versions/3-0-x/en/user-guide/application-orchestrate/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", + "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", + "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", + "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", + "versions/3-0-x/en/user-guide/application-orchestrate/agent", { - "group": "入门", - "expanded": false, + "group": "Application Toolkits", "pages": [ - "zh/use-dify/getting-started/introduction", - "zh/use-dify/getting-started/quick-start", - "zh/use-dify/getting-started/key-concepts" + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" ] - }, + } + ] + }, + { + "group": "Workflow", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/README", + "versions/3-0-x/en/user-guide/workflow/key-concepts", + "versions/3-0-x/en/user-guide/workflow/variables", { - "group": "节点", - "expanded": false, + "group": "Node Description", "pages": [ - "zh/use-dify/nodes/user-input", + "versions/3-7-x/en/user-guide/workflow/node/user-input", { - "group": "触发器", - "icon": "bolt-lightning", + "group": "Trigger", "pages": [ - "zh/use-dify/nodes/trigger/overview", - "zh/use-dify/nodes/trigger/schedule-trigger", - "zh/use-dify/nodes/trigger/plugin-trigger", - "zh/use-dify/nodes/trigger/webhook-trigger" + "versions/3-7-x/en/user-guide/workflow/node/trigger/overview", + "versions/3-7-x/en/user-guide/workflow/node/trigger/schedule-trigger", + "versions/3-7-x/en/user-guide/workflow/node/trigger/plugin-trigger", + "versions/3-7-x/en/user-guide/workflow/node/trigger/webhook-trigger" ] }, - "zh/use-dify/nodes/llm", - "zh/use-dify/nodes/knowledge-retrieval", - "zh/use-dify/nodes/answer", - "zh/use-dify/nodes/output", - "zh/use-dify/nodes/agent", - "zh/use-dify/nodes/question-classifier", - "zh/use-dify/nodes/ifelse", - "zh/use-dify/nodes/human-input", - "zh/use-dify/nodes/iteration", - "zh/use-dify/nodes/loop", - "zh/use-dify/nodes/code", - "zh/use-dify/nodes/template", - "zh/use-dify/nodes/variable-aggregator", - "zh/use-dify/nodes/doc-extractor", - "zh/use-dify/nodes/variable-assigner", - "zh/use-dify/nodes/parameter-extractor", - "zh/use-dify/nodes/http-request", - "zh/use-dify/nodes/list-operator", - "zh/use-dify/nodes/tools" + "versions/3-7-x/en/user-guide/workflow/node/output", + "versions/3-0-x/en/user-guide/workflow/node/answer", + "versions/3-0-x/en/user-guide/workflow/node/llm", + "versions/3-7-x/en/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/en/user-guide/workflow/node/question-classifier", + "versions/3-0-x/en/user-guide/workflow/node/ifelse", + "versions/3-0-x/en/user-guide/workflow/node/code", + "versions/3-0-x/en/user-guide/workflow/node/template", + "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", + "versions/3-0-x/en/user-guide/workflow/node/list-operator", + "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", + "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", + "versions/3-0-x/en/user-guide/workflow/node/iteration", + "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", + "versions/3-0-x/en/user-guide/workflow/node/http-request", + "versions/3-0-x/en/user-guide/workflow/node/agent", + "versions/3-0-x/en/user-guide/workflow/node/tools", + "versions/3-0-x/en/user-guide/workflow/node/loop" ] }, + "versions/3-0-x/en/user-guide/workflow/shortcut-key", + "versions/3-0-x/en/user-guide/workflow/orchestrate-node", + "versions/3-0-x/en/user-guide/workflow/file-upload", { - "group": "构建", - "expanded": false, + "group": "Error Handling", "pages": [ - "zh/use-dify/build/shortcut-key", - "zh/use-dify/build/goto-anything", - "zh/use-dify/build/orchestrate-node", - "zh/use-dify/build/predefined-error-handling-logic", - "zh/use-dify/build/mcp", - "zh/use-dify/build/version-control", - "zh/use-dify/build/additional-features" + "versions/3-0-x/en/user-guide/workflow/error-handling/README", + "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", + "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" ] }, + "versions/3-0-x/en/user-guide/workflow/additional-features", { - "group": "调试", - "expanded": false, + "group": "Debug and Preview", "pages": [ - "zh/use-dify/debug/step-run", - "zh/use-dify/debug/variable-inspect", - "zh/use-dify/debug/history-and-logs", - "zh/use-dify/debug/error-type" + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" ] }, + "versions/3-0-x/en/user-guide/workflow/publish", + "versions/3-0-x/en/user-guide/workflow/structured-outputs" + ] + }, + { + "group": "Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/readme", { - "group": "发布", - "expanded": false, + "group": "Create Knowledge", "pages": [ - "zh/use-dify/publish/README", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", { - "group": "Web App", - "icon": "globe", + "group": "1. Import Text Data", "pages": [ - "zh/use-dify/publish/webapp/workflow-webapp", - "zh/use-dify/publish/webapp/chatflow-webapp", - "zh/use-dify/publish/webapp/web-app-settings", - "zh/use-dify/publish/webapp/web-app-access", - "zh/use-dify/publish/webapp/embedding-in-websites" + "versions/3-7-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] }, - "zh/use-dify/publish/publish-mcp", - "zh/use-dify/publish/developing-with-apis", - "zh/use-dify/publish/publish-to-marketplace" + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", + "versions/3-7-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" ] }, { - "group": "监控", - "expanded": false, + "group": "Create from Knowledge Pipeline", "pages": [ - "zh/use-dify/monitor/analysis", - "zh/use-dify/monitor/logs", - "zh/use-dify/monitor/annotation-reply", - { - "group": "集成", - "icon": "grid-2-plus", - "pages": [ - "zh/use-dify/monitor/integrations/integrate-langsmith", - "zh/use-dify/monitor/integrations/integrate-langfuse", - "zh/use-dify/monitor/integrations/integrate-opik", - "zh/use-dify/monitor/integrations/integrate-weave", - "zh/use-dify/monitor/integrations/integrate-arize", - "zh/use-dify/monitor/integrations/integrate-phoenix", - "zh/use-dify/monitor/integrations/integrate-aliyun" - ] - } + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/readme", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", + "versions/3-7-x/en/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/upload-files", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" ] }, { - "group": "知识库", - "expanded": false, + "group": "Manage Knowledge", "pages": [ - "zh/use-dify/knowledge/readme", - { - "group": "创建知识库", - "icon": "square-plus", - "pages": [ - { - "group": "快速创建", - "pages": [ - "zh/use-dify/knowledge/create-knowledge/introduction", - { - "group": "导入数据", - "pages": [ - "zh/use-dify/knowledge/create-knowledge/import-text-data/readme", - "zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion", - "zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website" - ] - }, - "zh/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text", - "zh/use-dify/knowledge/create-knowledge/setting-indexing-methods" - ] - }, - { - "group": "通过知识流水线创建", - "pages": [ - "zh/use-dify/knowledge/knowledge-pipeline/readme", - "zh/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline", - "zh/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration", - "zh/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline", - "zh/use-dify/knowledge/knowledge-pipeline/upload-files", - "zh/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base", - "zh/use-dify/knowledge/knowledge-pipeline/authorize-data-source" - ] - }, - { - "group": "连接外部知识库", - "pages": [ - "zh/use-dify/knowledge/connect-external-knowledge-base", - "zh/use-dify/knowledge/external-knowledge-api" - ] - } - ] - }, - { - "group": "管理知识库", - "icon": "gear", - "pages": [ - "zh/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents", - "zh/use-dify/knowledge/manage-knowledge/introduction", - "zh/use-dify/knowledge/metadata", - "zh/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api" - ] - }, - "zh/use-dify/knowledge/test-retrieval", - "zh/use-dify/knowledge/integrate-knowledge-within-application", - "zh/use-dify/knowledge/knowledge-request-rate-limit" + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-7-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" ] }, - { - "group": "工作区", - "expanded": false, - "pages": [ - "zh/use-dify/workspace/readme", - "zh/use-dify/workspace/model-providers", - "zh/use-dify/workspace/plugins", - "zh/use-dify/workspace/app-management", - "zh/use-dify/workspace/team-members-management", - "zh/use-dify/workspace/personal-account-management", - "zh/use-dify/workspace/subscription-management", - { - "group": "API 扩展", - "icon": "puzzle-piece-simple", - "pages": [ - "zh/use-dify/workspace/api-extension/api-extension", - "zh/use-dify/workspace/api-extension/external-data-tool-api-extension", - "zh/use-dify/workspace/api-extension/moderation-api-extension", - "zh/use-dify/workspace/api-extension/cloudflare-worker" - ] - } - ] - }, - { - "group": "教程", - "expanded": false, - "pages": [ - "zh/use-dify/tutorials/simple-chatbot", - "zh/use-dify/tutorials/twitter-chatflow", - "zh/use-dify/tutorials/customer-service-bot", - "zh/use-dify/tutorials/build-ai-image-generation-app", - "zh/use-dify/tutorials/article-reader" - ] - } - ] - } - ] - }, - { - "dropdown": "自托管", - "icon": "server", - "pages": [ - { - "group": "快速开始", - "pages": [ - "zh/self-host/quick-start/docker-compose", - "zh/self-host/quick-start/faqs" - ] - }, - { - "group": "进阶部署", - "pages": [ - "zh/self-host/advanced-deployments/local-source-code", - "zh/self-host/advanced-deployments/start-the-frontend-docker-container" - ] - }, - { - "group": "配置", - "pages": [ - "zh/self-host/configuration/environments" + "versions/3-0-x/en/user-guide/knowledge-base/metadata", + "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" ] }, { - "group": "平台指南", + "group": "Tools", "pages": [ - "zh/self-host/platform-guides/bt-panel", - "zh/self-host/platform-guides/dify-premium" + "versions/3-3-x/en/user-guide/tools/mcp" ] }, { - "group": "故障排除", + "group": "Publishing", "pages": [ - "zh/self-host/troubleshooting/common-issues", - "zh/self-host/troubleshooting/docker-issues", - "zh/self-host/troubleshooting/integrations", - "zh/self-host/troubleshooting/storage-and-migration", - "zh/self-host/troubleshooting/weaviate-v4-migration" + "versions/2-8-x/en/user-guide/application-publishing/permission-management", + "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" ] - } - ] - }, - { - "dropdown": "API 文档", - "icon": "code", - "groups": [ - { - "group": "Chatbot 和 Agent", - "openapi": "zh/api-reference/openapi_chat.json" - }, - { - "group": "Chatflow", - "openapi": "zh/api-reference/openapi_chatflow.json" - }, - { - "group": "工作流", - "openapi": "zh/api-reference/openapi_workflow.json" - }, - { - "group": "知识库", - "openapi": "zh/api-reference/openapi_knowledge.json" }, { - "group": "文本生成", - "openapi": "zh/api-reference/openapi_completion.json" - } - ] - }, - { - "dropdown": "开发插件", - "icon": "code-pull-request", - "groups": [ - { - "group": "快速开始", + "group": "Annotation", "pages": [ - "zh/develop-plugin/getting-started/getting-started-dify-plugin", - "zh/develop-plugin/getting-started/cli" + "versions/3-0-x/en/user-guide/annotation/logs", + "versions/3-0-x/en/user-guide/annotation/annotation-reply" ] }, { - "group": "特性与规范", + "group": "Monitoring", "pages": [ + "versions/3-0-x/en/user-guide/monitoring/README", + "versions/3-0-x/en/user-guide/monitoring/analysis", { - "group": "插件类型", - "pages": [ - "zh/develop-plugin/features-and-specs/plugin-types/general-specifications", - "zh/develop-plugin/features-and-specs/plugin-types/model-designing-rules", - "zh/develop-plugin/features-and-specs/plugin-types/model-schema", - "zh/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv", - "zh/develop-plugin/features-and-specs/plugin-types/tool", - "zh/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest", - "zh/develop-plugin/features-and-specs/plugin-types/multilingual-readme", - "zh/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin", - "zh/develop-plugin/features-and-specs/plugin-types/plugin-logging" - ] - }, - { - "group": "高级开发", + "group": "Integrate External Ops Tools", "pages": [ - { - "group": "反向调用", - "pages": [ - "zh/develop-plugin/features-and-specs/advanced-development/bundle", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool", - "zh/develop-plugin/features-and-specs/advanced-development/customizable-model", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node" - ] - } + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] } ] }, { - "group": "开发指南与示例", - "pages": [ - "zh/develop-plugin/dev-guides-and-walkthroughs/cheatsheet", - "zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/tool-oauth", - "zh/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider", - "zh/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/endpoint", - "zh/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter", - "zh/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool" - ] - }, - { - "group": "发布", + "group": "Extensions", "pages": [ { - "group": "标准", - "pages": [ - "zh/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct", - "zh/develop-plugin/publishing/standards/privacy-protection-guidelines", - "zh/develop-plugin/publishing/standards/third-party-signature-verification" - ] - }, - { - "group": "上架插件市场", + "group": "API-Based Extension", "pages": [ - "zh/develop-plugin/publishing/marketplace-listing/plugin-auto-publish-pr", - "zh/develop-plugin/publishing/marketplace-listing/release-overview", - "zh/develop-plugin/publishing/marketplace-listing/release-by-file", - "zh/develop-plugin/publishing/marketplace-listing/release-to-dify-marketplace", - "zh/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo" + "versions/3-0-x/en/user-guide/extension/api-based-extension/README", + "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", + "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" ] }, { - "group": "常见问题", + "group": "Code-Based Extension", "pages": [ - "zh/develop-plugin/publishing/faq/faq" + "versions/3-0-x/en/user-guide/extension/code-based-extension/README", + "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" ] } ] + }, + { + "group": "Management", + "pages": [ + "versions/3-0-x/en/user-guide/management/app-management", + "versions/3-0-x/en/user-guide/management/team-members-management", + "versions/3-0-x/en/user-guide/management/personal-account-management", + "versions/3-0-x/en/user-guide/management/version-control" + ] } ] } ] }, { - "language": "ja", - "href": "ja/use-dify/getting-started/introduction", - "dropdowns": [ + "version": "3.6.x (Enterprise)", + "groups": [ { - "dropdown": "Dify を使う", - "icon": "book-open", + "group": "User Guide", "pages": [ + "versions/3-6-x/en/user-guide/introduction", { - "group": " ", + "group": "Model Configuration", + "pages": [ + "versions/3-0-x/en/user-guide/model-configuration/readme", + "versions/3-0-x/en/user-guide/model-configuration/new-provider", + "versions/3-0-x/en/user-guide/model-configuration/predefined-model", + "versions/3-0-x/en/user-guide/model-configuration/customizable-model", + "versions/3-0-x/en/user-guide/model-configuration/interfaces", + "versions/3-0-x/en/user-guide/model-configuration/schema", + "versions/3-5-x/en/user-guide/model-configuration/manage-model-credential", + "versions/3-5-x/en/user-guide/model-configuration/load-balancing" + ] + }, + { + "group": "Application Orchestration", "pages": [ + "versions/3-0-x/en/user-guide/application-orchestrate/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", + "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", + "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", + "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", + "versions/3-0-x/en/user-guide/application-orchestrate/agent", { - "group": "はじめに", - "expanded": false, + "group": "Application Toolkits", "pages": [ - "ja/use-dify/getting-started/introduction", - "ja/use-dify/getting-started/quick-start", - "ja/use-dify/getting-started/key-concepts" + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" ] - }, + } + ] + }, + { + "group": "Workflow", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/README", + "versions/3-0-x/en/user-guide/workflow/key-concepts", + "versions/3-0-x/en/user-guide/workflow/variables", { - "group": "ノード", - "expanded": false, + "group": "Node Description", "pages": [ - "ja/use-dify/nodes/user-input", - { - "group": "トリガー", - "icon": "bolt-lightning", - "pages": [ - "ja/use-dify/nodes/trigger/overview", - "ja/use-dify/nodes/trigger/schedule-trigger", - "ja/use-dify/nodes/trigger/plugin-trigger", - "ja/use-dify/nodes/trigger/webhook-trigger" - ] - }, - "ja/use-dify/nodes/llm", - "ja/use-dify/nodes/knowledge-retrieval", - "ja/use-dify/nodes/answer", - "ja/use-dify/nodes/output", - "ja/use-dify/nodes/agent", - "ja/use-dify/nodes/question-classifier", - "ja/use-dify/nodes/ifelse", - "ja/use-dify/nodes/human-input", - "ja/use-dify/nodes/iteration", - "ja/use-dify/nodes/loop", - "ja/use-dify/nodes/code", - "ja/use-dify/nodes/template", - "ja/use-dify/nodes/variable-aggregator", - "ja/use-dify/nodes/doc-extractor", - "ja/use-dify/nodes/variable-assigner", - "ja/use-dify/nodes/parameter-extractor", - "ja/use-dify/nodes/http-request", - "ja/use-dify/nodes/list-operator", - "ja/use-dify/nodes/tools" + "versions/3-0-x/en/user-guide/workflow/node/start", + "versions/3-0-x/en/user-guide/workflow/node/end", + "versions/3-0-x/en/user-guide/workflow/node/answer", + "versions/3-0-x/en/user-guide/workflow/node/llm", + "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/en/user-guide/workflow/node/question-classifier", + "versions/3-0-x/en/user-guide/workflow/node/ifelse", + "versions/3-0-x/en/user-guide/workflow/node/code", + "versions/3-0-x/en/user-guide/workflow/node/template", + "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", + "versions/3-0-x/en/user-guide/workflow/node/list-operator", + "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", + "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", + "versions/3-0-x/en/user-guide/workflow/node/iteration", + "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", + "versions/3-0-x/en/user-guide/workflow/node/http-request", + "versions/3-0-x/en/user-guide/workflow/node/agent", + "versions/3-0-x/en/user-guide/workflow/node/tools", + "versions/3-0-x/en/user-guide/workflow/node/loop" ] }, + "versions/3-0-x/en/user-guide/workflow/shortcut-key", + "versions/3-0-x/en/user-guide/workflow/orchestrate-node", + "versions/3-0-x/en/user-guide/workflow/file-upload", { - "group": "ビルド", - "expanded": false, + "group": "Error Handling", "pages": [ - "ja/use-dify/build/shortcut-key", - "ja/use-dify/build/goto-anything", - "ja/use-dify/build/orchestrate-node", - "ja/use-dify/build/predefined-error-handling-logic", - "ja/use-dify/build/mcp", - "ja/use-dify/build/version-control", - "ja/use-dify/build/additional-features" + "versions/3-0-x/en/user-guide/workflow/error-handling/README", + "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", + "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" ] }, + "versions/3-0-x/en/user-guide/workflow/additional-features", { - "group": "デバッグ", - "expanded": false, + "group": "Debug and Preview", "pages": [ - "ja/use-dify/debug/step-run", - "ja/use-dify/debug/variable-inspect", - "ja/use-dify/debug/history-and-logs", - "ja/use-dify/debug/error-type" + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" ] }, + "versions/3-0-x/en/user-guide/workflow/publish", + "versions/3-0-x/en/user-guide/workflow/structured-outputs" + ] + }, + { + "group": "Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/readme", { - "group": "公開", - "expanded": false, + "group": "Create Knowledge", "pages": [ - "ja/use-dify/publish/README", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", { - "group": "Webアプリ", - "icon": "globe", + "group": "1. Import Text Data", "pages": [ - "ja/use-dify/publish/webapp/workflow-webapp", - "ja/use-dify/publish/webapp/chatflow-webapp", - "ja/use-dify/publish/webapp/web-app-settings", - "ja/use-dify/publish/webapp/web-app-access", - "ja/use-dify/publish/webapp/embedding-in-websites" + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] }, - "ja/use-dify/publish/publish-mcp", - "ja/use-dify/publish/developing-with-apis", - "ja/use-dify/publish/publish-to-marketplace" - ] - }, - { - "group": "モニタリング", - "expanded": false, - "pages": [ - "ja/use-dify/monitor/analysis", - "ja/use-dify/monitor/logs", - "ja/use-dify/monitor/annotation-reply", - { - "group": "インテグレーション", - "icon": "grid-2-plus", - "pages": [ - "ja/use-dify/monitor/integrations/integrate-langsmith", - "ja/use-dify/monitor/integrations/integrate-langfuse", - "ja/use-dify/monitor/integrations/integrate-opik", - "ja/use-dify/monitor/integrations/integrate-weave", - "ja/use-dify/monitor/integrations/integrate-arize", - "ja/use-dify/monitor/integrations/integrate-phoenix", - "ja/use-dify/monitor/integrations/integrate-aliyun" - ] - } + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" ] }, { - "group": "ナレッジ", - "expanded": false, + "group": "Create from Knowledge Pipeline", "pages": [ - "ja/use-dify/knowledge/readme", - { - "group": "ナレッジの作成", - "icon": "square-plus", - "pages": [ - { - "group": "クイック作成", - "pages": [ - "ja/use-dify/knowledge/create-knowledge/introduction", - { - "group": "データのインポート", - "pages": [ - "ja/use-dify/knowledge/create-knowledge/import-text-data/readme", - "ja/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion", - "ja/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website" - ] - }, - "ja/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text", - "ja/use-dify/knowledge/create-knowledge/setting-indexing-methods" - ] - }, - { - "group": "ナレッジパイプラインから作成", - "pages": [ - "ja/use-dify/knowledge/knowledge-pipeline/readme", - "ja/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline", - "ja/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration", - "ja/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline", - "ja/use-dify/knowledge/knowledge-pipeline/upload-files", - "ja/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base", - "ja/use-dify/knowledge/knowledge-pipeline/authorize-data-source" - ] - }, - { - "group": "外部ナレッジベースと連携", - "pages": [ - "ja/use-dify/knowledge/connect-external-knowledge-base", - "ja/use-dify/knowledge/external-knowledge-api" - ] - } - ] - }, - { - "group": "ナレッジの管理", - "icon": "gear", - "pages": [ - "ja/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents", - "ja/use-dify/knowledge/manage-knowledge/introduction", - "ja/use-dify/knowledge/metadata", - "ja/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api" - ] - }, - "ja/use-dify/knowledge/test-retrieval", - "ja/use-dify/knowledge/integrate-knowledge-within-application", - "ja/use-dify/knowledge/knowledge-request-rate-limit" + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/readme", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/upload-files", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", + "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" ] }, { - "group": "ワークスペース", - "expanded": false, + "group": "Manage Knowledge", "pages": [ - "ja/use-dify/workspace/readme", - "ja/use-dify/workspace/model-providers", - "ja/use-dify/workspace/plugins", - "ja/use-dify/workspace/app-management", - "ja/use-dify/workspace/team-members-management", - "ja/use-dify/workspace/personal-account-management", - "ja/use-dify/workspace/subscription-management", - { - "group": "API 拡張", - "icon": "puzzle-piece-simple", - "pages": [ - "ja/use-dify/workspace/api-extension/api-extension", - "ja/use-dify/workspace/api-extension/external-data-tool-api-extension", - "ja/use-dify/workspace/api-extension/moderation-api-extension", - "ja/use-dify/workspace/api-extension/cloudflare-worker" - ] - } + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" ] }, - { - "group": "チュートリアル", - "expanded": false, - "pages": [ - "ja/use-dify/tutorials/twitter-chatflow", - "ja/use-dify/tutorials/customer-service-bot", - "ja/use-dify/tutorials/build-ai-image-generation-app", - "ja/use-dify/tutorials/article-reader" - ] - } - ] - } - ] - }, - { - "dropdown": "セルフホスティング", - "icon": "server", - "pages": [ - { - "group": "クイックスタート", - "pages": [ - "ja/self-host/quick-start/docker-compose", - "ja/self-host/quick-start/faqs" + "versions/3-0-x/en/user-guide/knowledge-base/metadata", + "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" ] }, { - "group": "高度なデプロイ", + "group": "Tools", "pages": [ - "ja/self-host/advanced-deployments/local-source-code", - "ja/self-host/advanced-deployments/start-the-frontend-docker-container" + "versions/3-3-x/en/user-guide/tools/mcp" ] }, { - "group": "設定", + "group": "Publishing", "pages": [ - "ja/self-host/configuration/environments" - ] - }, - { - "group": "プラットフォームガイド", - "pages": [ - "ja/self-host/platform-guides/bt-panel", - "ja/self-host/platform-guides/dify-premium" - ] - }, - { - "group": "トラブルシューティング", - "pages": [ - "ja/self-host/troubleshooting/common-issues", - "ja/self-host/troubleshooting/docker-issues", - "ja/self-host/troubleshooting/integrations", - "ja/self-host/troubleshooting/storage-and-migration", - "ja/self-host/troubleshooting/weaviate-v4-migration" + "versions/2-8-x/en/user-guide/application-publishing/permission-management", + "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" ] - } - ] - }, - { - "dropdown": "APIアクセス", - "icon": "code", - "groups": [ - { - "group": "ChatbotとAgent", - "openapi": "ja/api-reference/openapi_chat.json" - }, - { - "group": "チャットフロー", - "openapi": "ja/api-reference/openapi_chatflow.json" - }, - { - "group": "ワークフロー", - "openapi": "ja/api-reference/openapi_workflow.json" }, { - "group": "ナレッジ", - "openapi": "ja/api-reference/openapi_knowledge.json" - }, - { - "group": "テキスト ジェネレーター", - "openapi": "ja/api-reference/openapi_completion.json" - } - ] - }, - { - "dropdown": "プラグイン開発", - "icon": "code-pull-request", - "groups": [ - { - "group": "はじめに", + "group": "Annotation", "pages": [ - "ja/develop-plugin/getting-started/getting-started-dify-plugin", - "ja/develop-plugin/getting-started/cli" + "versions/3-0-x/en/user-guide/annotation/logs", + "versions/3-0-x/en/user-guide/annotation/annotation-reply" ] }, { - "group": "特性と仕様", + "group": "Monitoring", "pages": [ + "versions/3-0-x/en/user-guide/monitoring/README", + "versions/3-0-x/en/user-guide/monitoring/analysis", { - "group": "プラグインタイプ", - "pages": [ - "ja/develop-plugin/features-and-specs/plugin-types/general-specifications", - "ja/develop-plugin/features-and-specs/plugin-types/model-designing-rules", - "ja/develop-plugin/features-and-specs/plugin-types/model-schema", - "ja/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv", - "ja/develop-plugin/features-and-specs/plugin-types/tool", - "ja/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest", - "ja/develop-plugin/features-and-specs/plugin-types/multilingual-readme", - "ja/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin", - "ja/develop-plugin/features-and-specs/plugin-types/plugin-logging" - ] - }, - { - "group": "高度な開発", + "group": "Integrate External Ops Tools", "pages": [ - { - "group": "リバース呼び出し", - "pages": [ - "ja/develop-plugin/features-and-specs/advanced-development/bundle", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool", - "ja/develop-plugin/features-and-specs/advanced-development/customizable-model", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node" - ] - } + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] } ] }, { - "group": "開発ガイドとサンプル", - "pages": [ - "ja/develop-plugin/dev-guides-and-walkthroughs/cheatsheet", - "ja/develop-plugin/dev-guides-and-walkthroughs/tool-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/tool-oauth", - "ja/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider", - "ja/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/endpoint", - "ja/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter", - "ja/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool" - ] - }, - { - "group": "公開", + "group": "Extensions", "pages": [ { - "group": "標準", - "pages": [ - "ja/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct", - "ja/develop-plugin/publishing/standards/privacy-protection-guidelines", - "ja/develop-plugin/publishing/standards/third-party-signature-verification" - ] - }, - { - "group": "マーケットプレイスリスト", + "group": "API-Based Extension", "pages": [ - "ja/develop-plugin/publishing/marketplace-listing/plugin-auto-publish-pr", - "ja/develop-plugin/publishing/marketplace-listing/release-overview", - "ja/develop-plugin/publishing/marketplace-listing/release-by-file", - "ja/develop-plugin/publishing/marketplace-listing/release-to-dify-marketplace", - "ja/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo" + "versions/3-0-x/en/user-guide/extension/api-based-extension/README", + "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", + "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" ] }, { - "group": "よくある質問", + "group": "Code-Based Extension", "pages": [ - "ja/develop-plugin/publishing/faq/faq" + "versions/3-0-x/en/user-guide/extension/code-based-extension/README", + "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" ] } ] + }, + { + "group": "Management", + "pages": [ + "versions/3-0-x/en/user-guide/management/app-management", + "versions/3-0-x/en/user-guide/management/team-members-management", + "versions/3-0-x/en/user-guide/management/personal-account-management", + "versions/3-0-x/en/user-guide/management/version-control" + ] } ] } ] - } - ] - }, - { - "version": "3.7.x (Enterprise)", - "languages": [ + }, { - "language": "zh", - "href": "versions/3-7-x/zh/user-guide/introduction", + "version": "3.5.x (Enterprise)", "groups": [ { - "group": "用户手册", + "group": "User Guide", "pages": [ - "versions/3-7-x/zh/user-guide/introduction", + "versions/3-5-x/en/user-guide/introduction", { - "group": "接入大模型", + "group": "Model Configuration", "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-5-x/zh/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/zh/user-guide/model-configuration/load-balancing" + "versions/3-0-x/en/user-guide/model-configuration/readme", + "versions/3-0-x/en/user-guide/model-configuration/new-provider", + "versions/3-0-x/en/user-guide/model-configuration/predefined-model", + "versions/3-0-x/en/user-guide/model-configuration/customizable-model", + "versions/3-0-x/en/user-guide/model-configuration/interfaces", + "versions/3-0-x/en/user-guide/model-configuration/schema", + "versions/3-5-x/en/user-guide/model-configuration/manage-model-credential", + "versions/3-5-x/en/user-guide/model-configuration/load-balancing" ] }, { - "group": "构建应用", + "group": "Application Orchestration", "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", - { - "group": "聊天助手", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" - ] - }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", + "versions/3-0-x/en/user-guide/application-orchestrate/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", + "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", + "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", + "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", + "versions/3-0-x/en/user-guide/application-orchestrate/agent", { - "group": "应用工具箱", + "group": "Application Toolkits", "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" ] } ] }, { - "group": "工作流", + "group": "Workflow", "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", - { - "group": "节点说明", - "pages": [ - "versions/3-7-x/zh/user-guide/workflow/node/user-input", - { - "group": "触发器", - "pages": [ - "versions/3-7-x/zh/user-guide/workflow/node/trigger/overview", - "versions/3-7-x/zh/user-guide/workflow/node/trigger/schedule-trigger", - "versions/3-7-x/zh/user-guide/workflow/node/trigger/plugin-trigger", - "versions/3-7-x/zh/user-guide/workflow/node/trigger/webhook-trigger" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-7-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-7-x/zh/user-guide/workflow/node/output", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", + "versions/3-0-x/en/user-guide/workflow/README", + "versions/3-0-x/en/user-guide/workflow/key-concepts", + "versions/3-0-x/en/user-guide/workflow/variables", { - "group": "异常处理", + "group": "Node Description", "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" + "versions/3-0-x/en/user-guide/workflow/node/start", + "versions/3-0-x/en/user-guide/workflow/node/end", + "versions/3-0-x/en/user-guide/workflow/node/answer", + "versions/3-0-x/en/user-guide/workflow/node/llm", + "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/en/user-guide/workflow/node/question-classifier", + "versions/3-0-x/en/user-guide/workflow/node/ifelse", + "versions/3-0-x/en/user-guide/workflow/node/code", + "versions/3-0-x/en/user-guide/workflow/node/template", + "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", + "versions/3-0-x/en/user-guide/workflow/node/list-operator", + "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", + "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", + "versions/3-0-x/en/user-guide/workflow/node/iteration", + "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", + "versions/3-0-x/en/user-guide/workflow/node/http-request", + "versions/3-0-x/en/user-guide/workflow/node/agent", + "versions/3-0-x/en/user-guide/workflow/node/tools", + "versions/3-0-x/en/user-guide/workflow/node/loop" ] }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", + "versions/3-0-x/en/user-guide/workflow/shortcut-key", + "versions/3-0-x/en/user-guide/workflow/orchestrate-node", + "versions/3-0-x/en/user-guide/workflow/file-upload", { - "group": "预览与调试", + "group": "Error Handling", "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" + "versions/3-0-x/en/user-guide/workflow/error-handling/README", + "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", + "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" ] }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" + "versions/3-0-x/en/user-guide/workflow/additional-features", + { + "group": "Debug and Preview", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" + ] + }, + "versions/3-0-x/en/user-guide/workflow/publish", + "versions/3-0-x/en/user-guide/workflow/structured-outputs" ] }, { - "group": "知识库", + "group": "Knowledge", "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", + "versions/3-0-x/en/user-guide/knowledge-base/readme", { - "group": "创建知识库", + "group": "Create Knowledge", "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", { - "group": "1. 导入文本数据", + "group": "1. Import Text Data", "pages": [ - "versions/3-7-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-7-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "从知识流水线创建", - "pages": [ - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/readme", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", - "versions/3-7-x/zh/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/upload-files", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" ] }, { - "group": "管理知识库", + "group": "Manage Knowledge", "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-7-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" ] }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" + "versions/3-0-x/en/user-guide/knowledge-base/metadata", + "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" ] }, { - "group": "工具", + "group": "Tools", "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-3-x/zh/user-guide/tools/mcp", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", - { - "group": "工具配置详情", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" - ] - } + "versions/3-3-x/en/user-guide/tools/mcp" ] }, { - "group": "发布", + "group": "Publishing", "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - "versions/3-3-x/zh/user-guide/application-publishing/publish-mcp", + "versions/2-8-x/en/user-guide/application-publishing/permission-management", + "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", { - "group": "发布为公开 Web 站点", + "group": "Publish as a Single-page Web App", "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" + "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "标注", + "group": "Annotation", "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" + "versions/3-0-x/en/user-guide/annotation/logs", + "versions/3-0-x/en/user-guide/annotation/annotation-reply" ] }, { - "group": "监测", + "group": "Monitoring", "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", + "versions/3-0-x/en/user-guide/monitoring/README", + "versions/3-0-x/en/user-guide/monitoring/analysis", { - "group": "集成外部与 Ops 工具", + "group": "Integrate External Ops Tools", "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + ] + } + ] + }, + { + "group": "Extensions", + "pages": [ + { + "group": "API-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/api-based-extension/README", + "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", + "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" ] }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" + { + "group": "Code-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/code-based-extension/README", + "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + ] + } ] }, { - "group": "管理", + "group": "Management", "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" + "versions/3-0-x/en/user-guide/management/app-management", + "versions/3-0-x/en/user-guide/management/team-members-management", + "versions/3-0-x/en/user-guide/management/personal-account-management", + "versions/3-0-x/en/user-guide/management/version-control" ] } ] @@ -1425,14 +1085,12 @@ ] }, { - "language": "en", - "default": true, - "href": "versions/3-7-x/en/user-guide/introduction", + "version": "3.4.x (Enterprise)", "groups": [ { "group": "User Guide", "pages": [ - "versions/3-7-x/en/user-guide/introduction", + "versions/3-4-x/en/user-guide/introduction", { "group": "Model Configuration", "pages": [ @@ -1441,9 +1099,7 @@ "versions/3-0-x/en/user-guide/model-configuration/predefined-model", "versions/3-0-x/en/user-guide/model-configuration/customizable-model", "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema", - "versions/3-5-x/en/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/en/user-guide/model-configuration/load-balancing" + "versions/3-0-x/en/user-guide/model-configuration/schema" ] }, { @@ -1473,20 +1129,11 @@ { "group": "Node Description", "pages": [ - "versions/3-7-x/en/user-guide/workflow/node/user-input", - { - "group": "Trigger", - "pages": [ - "versions/3-7-x/en/user-guide/workflow/node/trigger/overview", - "versions/3-7-x/en/user-guide/workflow/node/trigger/schedule-trigger", - "versions/3-7-x/en/user-guide/workflow/node/trigger/plugin-trigger", - "versions/3-7-x/en/user-guide/workflow/node/trigger/webhook-trigger" - ] - }, - "versions/3-7-x/en/user-guide/workflow/node/output", + "versions/3-0-x/en/user-guide/workflow/node/start", + "versions/3-0-x/en/user-guide/workflow/node/end", "versions/3-0-x/en/user-guide/workflow/node/answer", "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-7-x/en/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", "versions/3-0-x/en/user-guide/workflow/node/question-classifier", "versions/3-0-x/en/user-guide/workflow/node/ifelse", "versions/3-0-x/en/user-guide/workflow/node/code", @@ -1540,279 +1187,1619 @@ { "group": "1. Import Text Data", "pages": [ - "versions/3-7-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] }, "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-7-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" ] }, { - "group": "Create from Knowledge Pipeline", + "group": "Manage Knowledge", "pages": [ - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/readme", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", - "versions/3-7-x/en/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/upload-files", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + ] + }, + "versions/3-0-x/en/user-guide/knowledge-base/metadata", + "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" + ] + }, + { + "group": "Tools", + "pages": [ + "versions/3-3-x/en/user-guide/tools/mcp" + ] + }, + { + "group": "Publishing", + "pages": [ + "versions/2-8-x/en/user-guide/application-publishing/permission-management", + "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" + ] + }, + { + "group": "Annotation", + "pages": [ + "versions/3-0-x/en/user-guide/annotation/logs", + "versions/3-0-x/en/user-guide/annotation/annotation-reply" + ] + }, + { + "group": "Monitoring", + "pages": [ + "versions/3-0-x/en/user-guide/monitoring/README", + "versions/3-0-x/en/user-guide/monitoring/analysis", + { + "group": "Integrate External Ops Tools", + "pages": [ + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + ] + } + ] + }, + { + "group": "Extensions", + "pages": [ + { + "group": "API-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/api-based-extension/README", + "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", + "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + ] + }, + { + "group": "Code-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/code-based-extension/README", + "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + ] + } + ] + }, + { + "group": "Management", + "pages": [ + "versions/3-0-x/en/user-guide/management/app-management", + "versions/3-0-x/en/user-guide/management/team-members-management", + "versions/3-0-x/en/user-guide/management/personal-account-management", + "versions/3-0-x/en/user-guide/management/version-control" + ] + } + ] + } + ] + }, + { + "version": "3.3.x (Enterprise)", + "groups": [ + { + "group": "User Guide", + "pages": [ + "versions/3-3-x/en/user-guide/introduction", + { + "group": "Model Configuration", + "pages": [ + "versions/3-0-x/en/user-guide/model-configuration/readme", + "versions/3-0-x/en/user-guide/model-configuration/new-provider", + "versions/3-0-x/en/user-guide/model-configuration/predefined-model", + "versions/3-0-x/en/user-guide/model-configuration/customizable-model", + "versions/3-0-x/en/user-guide/model-configuration/interfaces", + "versions/3-0-x/en/user-guide/model-configuration/schema" + ] + }, + { + "group": "Application Orchestration", + "pages": [ + "versions/3-0-x/en/user-guide/application-orchestrate/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", + "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", + "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", + "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", + "versions/3-0-x/en/user-guide/application-orchestrate/agent", + { + "group": "Application Toolkits", + "pages": [ + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" + ] + } + ] + }, + { + "group": "Workflow", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/README", + "versions/3-0-x/en/user-guide/workflow/key-concepts", + "versions/3-0-x/en/user-guide/workflow/variables", + { + "group": "Node Description", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/node/start", + "versions/3-0-x/en/user-guide/workflow/node/end", + "versions/3-0-x/en/user-guide/workflow/node/answer", + "versions/3-0-x/en/user-guide/workflow/node/llm", + "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/en/user-guide/workflow/node/question-classifier", + "versions/3-0-x/en/user-guide/workflow/node/ifelse", + "versions/3-0-x/en/user-guide/workflow/node/code", + "versions/3-0-x/en/user-guide/workflow/node/template", + "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", + "versions/3-0-x/en/user-guide/workflow/node/list-operator", + "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", + "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", + "versions/3-0-x/en/user-guide/workflow/node/iteration", + "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", + "versions/3-0-x/en/user-guide/workflow/node/http-request", + "versions/3-0-x/en/user-guide/workflow/node/agent", + "versions/3-0-x/en/user-guide/workflow/node/tools", + "versions/3-0-x/en/user-guide/workflow/node/loop" + ] + }, + "versions/3-0-x/en/user-guide/workflow/shortcut-key", + "versions/3-0-x/en/user-guide/workflow/orchestrate-node", + "versions/3-0-x/en/user-guide/workflow/file-upload", + { + "group": "Error Handling", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/error-handling/README", + "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", + "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" + ] + }, + "versions/3-0-x/en/user-guide/workflow/additional-features", + { + "group": "Debug and Preview", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" + ] + }, + "versions/3-0-x/en/user-guide/workflow/publish", + "versions/3-0-x/en/user-guide/workflow/structured-outputs" + ] + }, + { + "group": "Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/readme", + { + "group": "Create Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", + { + "group": "1. Import Text Data", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" + ] + }, + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" + ] + }, + { + "group": "Manage Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + ] + }, + "versions/3-0-x/en/user-guide/knowledge-base/metadata", + "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" + ] + }, + { + "group": "Tools", + "pages": [ + "versions/3-3-x/en/user-guide/tools/mcp" + ] + }, + { + "group": "Publishing", + "pages": [ + "versions/2-8-x/en/user-guide/application-publishing/permission-management", + "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" + ] + }, + { + "group": "Annotation", + "pages": [ + "versions/3-0-x/en/user-guide/annotation/logs", + "versions/3-0-x/en/user-guide/annotation/annotation-reply" + ] + }, + { + "group": "Monitoring", + "pages": [ + "versions/3-0-x/en/user-guide/monitoring/README", + "versions/3-0-x/en/user-guide/monitoring/analysis", + { + "group": "Integrate External Ops Tools", + "pages": [ + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + ] + } + ] + }, + { + "group": "Extensions", + "pages": [ + { + "group": "API-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/api-based-extension/README", + "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", + "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + ] + }, + { + "group": "Code-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/code-based-extension/README", + "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + ] + } + ] + }, + { + "group": "Management", + "pages": [ + "versions/3-0-x/en/user-guide/management/app-management", + "versions/3-0-x/en/user-guide/management/team-members-management", + "versions/3-0-x/en/user-guide/management/personal-account-management", + "versions/3-0-x/en/user-guide/management/version-control" + ] + } + ] + } + ] + }, + { + "version": "3.2.x (Enterprise)", + "groups": [ + { + "group": "User Guide", + "pages": [ + "versions/3-2-x/en/user-guide/introduction", + { + "group": "Model Configuration", + "pages": [ + "versions/3-0-x/en/user-guide/model-configuration/readme", + "versions/3-0-x/en/user-guide/model-configuration/new-provider", + "versions/3-0-x/en/user-guide/model-configuration/predefined-model", + "versions/3-0-x/en/user-guide/model-configuration/customizable-model", + "versions/3-0-x/en/user-guide/model-configuration/interfaces", + "versions/3-0-x/en/user-guide/model-configuration/schema", + "versions/3-0-x/en/user-guide/model-configuration/manage-model-credential" + ] + }, + { + "group": "Application Orchestration", + "pages": [ + "versions/3-0-x/en/user-guide/application-orchestrate/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", + "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", + "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", + "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", + "versions/3-0-x/en/user-guide/application-orchestrate/agent", + { + "group": "Application Toolkits", + "pages": [ + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" + ] + } + ] + }, + { + "group": "Workflow", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/README", + "versions/3-0-x/en/user-guide/workflow/key-concepts", + "versions/3-0-x/en/user-guide/workflow/variables", + { + "group": "Node Description", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/node/start", + "versions/3-0-x/en/user-guide/workflow/node/end", + "versions/3-0-x/en/user-guide/workflow/node/answer", + "versions/3-0-x/en/user-guide/workflow/node/llm", + "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/en/user-guide/workflow/node/question-classifier", + "versions/3-0-x/en/user-guide/workflow/node/ifelse", + "versions/3-0-x/en/user-guide/workflow/node/code", + "versions/3-0-x/en/user-guide/workflow/node/template", + "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", + "versions/3-0-x/en/user-guide/workflow/node/list-operator", + "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", + "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", + "versions/3-0-x/en/user-guide/workflow/node/iteration", + "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", + "versions/3-0-x/en/user-guide/workflow/node/http-request", + "versions/3-0-x/en/user-guide/workflow/node/agent", + "versions/3-0-x/en/user-guide/workflow/node/tools", + "versions/3-0-x/en/user-guide/workflow/node/loop" + ] + }, + "versions/3-0-x/en/user-guide/workflow/shortcut-key", + "versions/3-0-x/en/user-guide/workflow/orchestrate-node", + "versions/3-0-x/en/user-guide/workflow/file-upload", + { + "group": "Error Handling", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/error-handling/README", + "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", + "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" + ] + }, + "versions/3-0-x/en/user-guide/workflow/additional-features", + { + "group": "Debug and Preview", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" + ] + }, + "versions/3-0-x/en/user-guide/workflow/publish", + "versions/3-0-x/en/user-guide/workflow/structured-outputs" + ] + }, + { + "group": "Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/readme", + { + "group": "Create Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", + { + "group": "1. Import Text Data", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" + ] + }, + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" + ] + }, + { + "group": "Manage Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + ] + }, + "versions/3-0-x/en/user-guide/knowledge-base/metadata", + "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" + ] + }, + { + "group": "Publishing", + "pages": [ + "versions/2-8-x/en/user-guide/application-publishing/permission-management", + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" + ] + }, + { + "group": "Annotation", + "pages": [ + "versions/3-0-x/en/user-guide/annotation/logs", + "versions/3-0-x/en/user-guide/annotation/annotation-reply" + ] + }, + { + "group": "Monitoring", + "pages": [ + "versions/3-0-x/en/user-guide/monitoring/README", + "versions/3-0-x/en/user-guide/monitoring/analysis", + { + "group": "Integrate External Ops Tools", + "pages": [ + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + ] + } + ] + }, + { + "group": "Extensions", + "pages": [ + { + "group": "API-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/api-based-extension/README", + "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", + "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + ] + }, + { + "group": "Code-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/code-based-extension/README", + "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + ] + } + ] + }, + { + "group": "Management", + "pages": [ + "versions/3-0-x/en/user-guide/management/app-management", + "versions/3-0-x/en/user-guide/management/team-members-management", + "versions/3-0-x/en/user-guide/management/personal-account-management", + "versions/3-0-x/en/user-guide/management/version-control" + ] + } + ] + } + ] + }, + { + "version": "3.0.x (Enterprise)", + "groups": [ + { + "group": "User Guide", + "pages": [ + "versions/3-0-x/en/user-guide/introduction", + { + "group": "Model Configuration", + "pages": [ + "versions/3-0-x/en/user-guide/model-configuration/readme", + "versions/3-0-x/en/user-guide/model-configuration/new-provider", + "versions/3-0-x/en/user-guide/model-configuration/predefined-model", + "versions/3-0-x/en/user-guide/model-configuration/customizable-model", + "versions/3-0-x/en/user-guide/model-configuration/interfaces", + "versions/3-0-x/en/user-guide/model-configuration/schema" + ] + }, + { + "group": "Application Orchestration", + "pages": [ + "versions/3-0-x/en/user-guide/application-orchestrate/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", + "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", + "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", + "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", + "versions/3-0-x/en/user-guide/application-orchestrate/agent", + { + "group": "Application Toolkits", + "pages": [ + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", + "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" + ] + } + ] + }, + { + "group": "Workflow", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/README", + "versions/3-0-x/en/user-guide/workflow/key-concepts", + "versions/3-0-x/en/user-guide/workflow/variables", + { + "group": "Node Description", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/node/start", + "versions/3-0-x/en/user-guide/workflow/node/end", + "versions/3-0-x/en/user-guide/workflow/node/answer", + "versions/3-0-x/en/user-guide/workflow/node/llm", + "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/en/user-guide/workflow/node/question-classifier", + "versions/3-0-x/en/user-guide/workflow/node/ifelse", + "versions/3-0-x/en/user-guide/workflow/node/code", + "versions/3-0-x/en/user-guide/workflow/node/template", + "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", + "versions/3-0-x/en/user-guide/workflow/node/list-operator", + "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", + "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", + "versions/3-0-x/en/user-guide/workflow/node/iteration", + "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", + "versions/3-0-x/en/user-guide/workflow/node/http-request", + "versions/3-0-x/en/user-guide/workflow/node/agent", + "versions/3-0-x/en/user-guide/workflow/node/tools", + "versions/3-0-x/en/user-guide/workflow/node/loop" + ] + }, + "versions/3-0-x/en/user-guide/workflow/shortcut-key", + "versions/3-0-x/en/user-guide/workflow/orchestrate-node", + "versions/3-0-x/en/user-guide/workflow/file-upload", + { + "group": "Error Handling", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/error-handling/README", + "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", + "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" + ] + }, + "versions/3-0-x/en/user-guide/workflow/additional-features", + { + "group": "Debug and Preview", + "pages": [ + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history" + ] + }, + "versions/3-0-x/en/user-guide/workflow/publish", + "versions/3-0-x/en/user-guide/workflow/structured-outputs" + ] + }, + { + "group": "Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/readme", + { + "group": "Create Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", + { + "group": "1. Import Text Data", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" + ] + }, + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", + "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" + ] + }, + { + "group": "Manage Knowledge", + "pages": [ + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + ] + }, + "versions/3-0-x/en/user-guide/knowledge-base/metadata", + "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" + ] + }, + { + "group": "Publishing", + "pages": [ + "versions/2-8-x/en/user-guide/application-publishing/permission-management", + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" + ] + }, + { + "group": "Annotation", + "pages": [ + "versions/3-0-x/en/user-guide/annotation/logs", + "versions/3-0-x/en/user-guide/annotation/annotation-reply" + ] + }, + { + "group": "Monitoring", + "pages": [ + "versions/3-0-x/en/user-guide/monitoring/README", + "versions/3-0-x/en/user-guide/monitoring/analysis", + { + "group": "Integrate External Ops Tools", + "pages": [ + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + ] + } + ] + }, + { + "group": "Extensions", + "pages": [ + { + "group": "API-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/api-based-extension/README", + "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", + "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + ] + }, + { + "group": "Code-Based Extension", + "pages": [ + "versions/3-0-x/en/user-guide/extension/code-based-extension/README", + "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", + "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + ] + } + ] + }, + { + "group": "Management", + "pages": [ + "versions/3-0-x/en/user-guide/management/app-management", + "versions/3-0-x/en/user-guide/management/team-members-management", + "versions/3-0-x/en/user-guide/management/personal-account-management", + "versions/3-0-x/en/user-guide/management/version-control" + ] + } + ] + } + ] + }, + { + "version": "2.8.x (Enterprise)", + "groups": [ + { + "group": "User Guide", + "pages": [ + "versions/legacy/en/user-guide/welcome", + { + "group": "Model", + "pages": [ + "versions/legacy/en/user-guide/models/model-configuration", + "versions/legacy/en/user-guide/models/new-provider", + "versions/legacy/en/user-guide/models/predefined-model", + "versions/legacy/en/user-guide/models/customizable-model", + "versions/legacy/en/user-guide/models/interfaces", + "versions/legacy/en/user-guide/models/schema", + "versions/legacy/en/user-guide/models/load-balancing" + ] + }, + { + "group": "Application Orchestration", + "pages": [ + "versions/legacy/en/user-guide/build-app/chatbot", + "versions/legacy/en/user-guide/build-app/text-generator", + "versions/legacy/en/user-guide/build-app/agent", + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/en/user-guide/build-app/flow-app/concepts", + "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/en/user-guide/build-app/flow-app/variables", + { + "group": "Nodes", + "pages": [ + "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" + ] + }, + "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", + "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/en/user-guide/build-app/flow-app/file-upload", + "versions/legacy/en/user-guide/build-app/flow-app/additional-features" + ] + } + ] + }, + { + "group": "Debug and Preview", + "pages": [ + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" + ] + } + ] + }, + { + "group": "Application Publishing", + "pages": [ + "versions/2-8-x/en/user-guide/application-publishing/permission-management", + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/en/user-guide/application-publishing/developing-with-apis", + "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" + ] + }, + { + "group": "Management", + "pages": [ + "versions/legacy/en/user-guide/management/app-management", + "versions/legacy/en/user-guide/management/team-members-management", + "versions/legacy/en/user-guide/management/personal-account-management" + ] + }, + { + "group": "Monitoring", + "pages": [ + "versions/legacy/en/user-guide/monitoring/analysis", + "versions/legacy/en/user-guide/monitoring/logs", + "versions/legacy/en/user-guide/monitoring/annotation-reply", + { + "group": "Integrate External Ops Tools", + "pages": [ + "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" + ] + } + ] + } + ] + } + ] + }, + { + "version": "2.7.x (Enterprise)", + "groups": [ + { + "group": "User Guide", + "pages": [ + "versions/legacy/en/user-guide/welcome", + { + "group": "Model", + "pages": [ + "versions/legacy/en/user-guide/models/model-configuration", + "versions/legacy/en/user-guide/models/new-provider", + "versions/legacy/en/user-guide/models/predefined-model", + "versions/legacy/en/user-guide/models/customizable-model", + "versions/legacy/en/user-guide/models/interfaces", + "versions/legacy/en/user-guide/models/schema", + "versions/legacy/en/user-guide/models/load-balancing" + ] + }, + { + "group": "Application Orchestration", + "pages": [ + "versions/legacy/en/user-guide/build-app/chatbot", + "versions/legacy/en/user-guide/build-app/text-generator", + "versions/legacy/en/user-guide/build-app/agent", + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/en/user-guide/build-app/flow-app/concepts", + "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/en/user-guide/build-app/flow-app/variables", + { + "group": "Nodes", + "pages": [ + "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" + ] + }, + "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", + "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/en/user-guide/build-app/flow-app/file-upload", + "versions/legacy/en/user-guide/build-app/flow-app/additional-features" + ] + } + ] + }, + { + "group": "Debug and Preview", + "pages": [ + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" + ] + } + ] + }, + { + "group": "Application Publishing", + "pages": [ + "versions/legacy/en/user-guide/application-publishing/permission-management", + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/en/user-guide/application-publishing/developing-with-apis", + "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" + ] + }, + { + "group": "Management", + "pages": [ + "versions/legacy/en/user-guide/management/app-management", + "versions/legacy/en/user-guide/management/team-members-management", + "versions/legacy/en/user-guide/management/personal-account-management" + ] + }, + { + "group": "Monitoring", + "pages": [ + "versions/legacy/en/user-guide/monitoring/analysis", + "versions/legacy/en/user-guide/monitoring/logs", + "versions/legacy/en/user-guide/monitoring/annotation-reply", + { + "group": "Integrate External Ops Tools", + "pages": [ + "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" + ] + } + ] + } + ] + } + ] + }, + { + "version": "2.6.x (Enterprise)", + "groups": [ + { + "group": "User Guide", + "pages": [ + "versions/legacy/en/user-guide/welcome", + { + "group": "Model", + "pages": [ + "versions/legacy/en/user-guide/models/model-configuration", + "versions/legacy/en/user-guide/models/new-provider", + "versions/legacy/en/user-guide/models/predefined-model", + "versions/legacy/en/user-guide/models/customizable-model", + "versions/legacy/en/user-guide/models/interfaces", + "versions/legacy/en/user-guide/models/schema", + "versions/legacy/en/user-guide/models/load-balancing" + ] + }, + { + "group": "Application Orchestration", + "pages": [ + "versions/legacy/en/user-guide/build-app/chatbot", + "versions/legacy/en/user-guide/build-app/text-generator", + "versions/legacy/en/user-guide/build-app/agent", + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/en/user-guide/build-app/flow-app/concepts", + "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/en/user-guide/build-app/flow-app/variables", + { + "group": "Nodes", + "pages": [ + "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" + ] + }, + "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", + "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/en/user-guide/build-app/flow-app/file-upload", + "versions/legacy/en/user-guide/build-app/flow-app/additional-features" + ] + } + ] + }, + { + "group": "Debug and Preview", + "pages": [ + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" + ] + } + ] + }, + { + "group": "Application Publishing", + "pages": [ + "versions/legacy/en/user-guide/application-publishing/permission-management", + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/en/user-guide/application-publishing/developing-with-apis", + "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" + ] + }, + { + "group": "Management", + "pages": [ + "versions/legacy/en/user-guide/management/app-management", + "versions/legacy/en/user-guide/management/team-members-management", + "versions/legacy/en/user-guide/management/personal-account-management" + ] + }, + { + "group": "Monitoring", + "pages": [ + "versions/legacy/en/user-guide/monitoring/analysis", + "versions/legacy/en/user-guide/monitoring/logs", + "versions/legacy/en/user-guide/monitoring/annotation-reply", + { + "group": "Integrate External Ops Tools", + "pages": [ + "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" + ] + } + ] + } + ] + } + ] + }, + { + "version": "2.5.x (Enterprise)", + "groups": [ + { + "group": "User Guide", + "pages": [ + "versions/legacy/en/user-guide/welcome", + { + "group": "Model", + "pages": [ + "versions/legacy/en/user-guide/models/model-configuration", + "versions/legacy/en/user-guide/models/new-provider", + "versions/legacy/en/user-guide/models/predefined-model", + "versions/legacy/en/user-guide/models/customizable-model", + "versions/legacy/en/user-guide/models/interfaces", + "versions/legacy/en/user-guide/models/schema", + "versions/legacy/en/user-guide/models/load-balancing" + ] + }, + { + "group": "Application Orchestration", + "pages": [ + "versions/legacy/en/user-guide/build-app/chatbot", + "versions/legacy/en/user-guide/build-app/text-generator", + "versions/legacy/en/user-guide/build-app/agent", + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/en/user-guide/build-app/flow-app/concepts", + "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/en/user-guide/build-app/flow-app/variables", + { + "group": "Nodes", + "pages": [ + "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" + ] + }, + "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", + "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/en/user-guide/build-app/flow-app/file-upload", + "versions/legacy/en/user-guide/build-app/flow-app/additional-features" + ] + } + ] + }, + { + "group": "Debug and Preview", + "pages": [ + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" + ] + } + ] + }, + { + "group": "Application Publishing", + "pages": [ + { + "group": "Publish as a Single-page Web App", + "pages": [ + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/en/user-guide/application-publishing/developing-with-apis", + "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" + ] + }, + { + "group": "Management", + "pages": [ + "versions/legacy/en/user-guide/management/app-management", + "versions/legacy/en/user-guide/management/team-members-management", + "versions/legacy/en/user-guide/management/personal-account-management" + ] + }, + { + "group": "Monitoring", + "pages": [ + "versions/legacy/en/user-guide/monitoring/analysis", + "versions/legacy/en/user-guide/monitoring/logs", + "versions/legacy/en/user-guide/monitoring/annotation-reply", + { + "group": "Integrate External Ops Tools", + "pages": [ + "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "language": "zh", + "versions": [ + { + "version": "Latest", + "dropdowns": [ + { + "dropdown": "使用 Dify", + "icon": "book-open", + "pages": [ + { + "group": " ", + "pages": [ + { + "group": "入门", + "expanded": false, + "pages": [ + "zh/use-dify/getting-started/introduction", + "zh/use-dify/getting-started/quick-start", + "zh/use-dify/getting-started/key-concepts" + ] + }, + { + "group": "节点", + "expanded": false, + "pages": [ + "zh/use-dify/nodes/user-input", + { + "group": "触发器", + "icon": "bolt-lightning", + "pages": [ + "zh/use-dify/nodes/trigger/overview", + "zh/use-dify/nodes/trigger/schedule-trigger", + "zh/use-dify/nodes/trigger/plugin-trigger", + "zh/use-dify/nodes/trigger/webhook-trigger" + ] + }, + "zh/use-dify/nodes/llm", + "zh/use-dify/nodes/knowledge-retrieval", + "zh/use-dify/nodes/answer", + "zh/use-dify/nodes/output", + "zh/use-dify/nodes/agent", + "zh/use-dify/nodes/question-classifier", + "zh/use-dify/nodes/ifelse", + "zh/use-dify/nodes/human-input", + "zh/use-dify/nodes/iteration", + "zh/use-dify/nodes/loop", + "zh/use-dify/nodes/code", + "zh/use-dify/nodes/template", + "zh/use-dify/nodes/variable-aggregator", + "zh/use-dify/nodes/doc-extractor", + "zh/use-dify/nodes/variable-assigner", + "zh/use-dify/nodes/parameter-extractor", + "zh/use-dify/nodes/http-request", + "zh/use-dify/nodes/list-operator", + "zh/use-dify/nodes/tools" + ] + }, + { + "group": "构建", + "expanded": false, + "pages": [ + "zh/use-dify/build/shortcut-key", + "zh/use-dify/build/goto-anything", + "zh/use-dify/build/orchestrate-node", + "zh/use-dify/build/predefined-error-handling-logic", + "zh/use-dify/build/mcp", + "zh/use-dify/build/version-control", + "zh/use-dify/build/additional-features" + ] + }, + { + "group": "调试", + "expanded": false, + "pages": [ + "zh/use-dify/debug/step-run", + "zh/use-dify/debug/variable-inspect", + "zh/use-dify/debug/history-and-logs", + "zh/use-dify/debug/error-type" + ] + }, + { + "group": "发布", + "expanded": false, + "pages": [ + "zh/use-dify/publish/README", + { + "group": "Web App", + "icon": "globe", + "pages": [ + "zh/use-dify/publish/webapp/workflow-webapp", + "zh/use-dify/publish/webapp/chatflow-webapp", + "zh/use-dify/publish/webapp/web-app-settings", + "zh/use-dify/publish/webapp/web-app-access", + "zh/use-dify/publish/webapp/embedding-in-websites" + ] + }, + "zh/use-dify/publish/publish-mcp", + "zh/use-dify/publish/developing-with-apis", + "zh/use-dify/publish/publish-to-marketplace" + ] + }, + { + "group": "监控", + "expanded": false, + "pages": [ + "zh/use-dify/monitor/analysis", + "zh/use-dify/monitor/logs", + "zh/use-dify/monitor/annotation-reply", + { + "group": "集成", + "icon": "grid-2-plus", + "pages": [ + "zh/use-dify/monitor/integrations/integrate-langsmith", + "zh/use-dify/monitor/integrations/integrate-langfuse", + "zh/use-dify/monitor/integrations/integrate-opik", + "zh/use-dify/monitor/integrations/integrate-weave", + "zh/use-dify/monitor/integrations/integrate-arize", + "zh/use-dify/monitor/integrations/integrate-phoenix", + "zh/use-dify/monitor/integrations/integrate-aliyun" + ] + } + ] + }, + { + "group": "知识库", + "expanded": false, + "pages": [ + "zh/use-dify/knowledge/readme", + { + "group": "创建知识库", + "icon": "square-plus", + "pages": [ + { + "group": "快速创建", + "pages": [ + "zh/use-dify/knowledge/create-knowledge/introduction", + { + "group": "导入数据", + "pages": [ + "zh/use-dify/knowledge/create-knowledge/import-text-data/readme", + "zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion", + "zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website" + ] + }, + "zh/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text", + "zh/use-dify/knowledge/create-knowledge/setting-indexing-methods" + ] + }, + { + "group": "通过知识流水线创建", + "pages": [ + "zh/use-dify/knowledge/knowledge-pipeline/readme", + "zh/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline", + "zh/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration", + "zh/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline", + "zh/use-dify/knowledge/knowledge-pipeline/upload-files", + "zh/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base", + "zh/use-dify/knowledge/knowledge-pipeline/authorize-data-source" + ] + }, + { + "group": "连接外部知识库", + "pages": [ + "zh/use-dify/knowledge/connect-external-knowledge-base", + "zh/use-dify/knowledge/external-knowledge-api" + ] + } + ] + }, + { + "group": "管理知识库", + "icon": "gear", + "pages": [ + "zh/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents", + "zh/use-dify/knowledge/manage-knowledge/introduction", + "zh/use-dify/knowledge/metadata", + "zh/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api" + ] + }, + "zh/use-dify/knowledge/test-retrieval", + "zh/use-dify/knowledge/integrate-knowledge-within-application", + "zh/use-dify/knowledge/knowledge-request-rate-limit" + ] + }, + { + "group": "工作区", + "expanded": false, + "pages": [ + "zh/use-dify/workspace/readme", + "zh/use-dify/workspace/model-providers", + "zh/use-dify/workspace/plugins", + "zh/use-dify/workspace/app-management", + "zh/use-dify/workspace/team-members-management", + "zh/use-dify/workspace/personal-account-management", + "zh/use-dify/workspace/subscription-management", + { + "group": "API 扩展", + "icon": "puzzle-piece-simple", + "pages": [ + "zh/use-dify/workspace/api-extension/api-extension", + "zh/use-dify/workspace/api-extension/external-data-tool-api-extension", + "zh/use-dify/workspace/api-extension/moderation-api-extension", + "zh/use-dify/workspace/api-extension/cloudflare-worker" + ] + } ] }, { - "group": "Manage Knowledge", + "group": "教程", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-7-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + "zh/use-dify/tutorials/simple-chatbot", + "zh/use-dify/tutorials/twitter-chatflow", + "zh/use-dify/tutorials/customer-service-bot", + "zh/use-dify/tutorials/build-ai-image-generation-app", + "zh/use-dify/tutorials/article-reader" ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" - ] - }, - { - "group": "Tools", - "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" + } ] - }, + } + ] + }, + { + "dropdown": "自托管", + "icon": "server", + "pages": [ { - "group": "Publishing", + "group": "快速开始", "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" + "zh/self-host/quick-start/docker-compose", + "zh/self-host/quick-start/faqs" ] }, { - "group": "Annotation", + "group": "进阶部署", "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" + "zh/self-host/advanced-deployments/local-source-code", + "zh/self-host/advanced-deployments/start-the-frontend-docker-container" ] }, { - "group": "Monitoring", + "group": "配置", "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } + "zh/self-host/configuration/environments" ] }, { - "group": "Extensions", + "group": "平台指南", "pages": [ - { - "group": "API-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" - ] - }, - { - "group": "Code-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" - ] - } + "zh/self-host/platform-guides/bt-panel", + "zh/self-host/platform-guides/dify-premium" ] }, { - "group": "Management", + "group": "故障排除", "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" + "zh/self-host/troubleshooting/common-issues", + "zh/self-host/troubleshooting/docker-issues", + "zh/self-host/troubleshooting/integrations", + "zh/self-host/troubleshooting/storage-and-migration", + "zh/self-host/troubleshooting/weaviate-v4-migration" ] } ] - } - ] - }, - { - "language": "ja", - "href": "versions/3-7-x/ja/user-guide/introduction", - "groups": [ + }, { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-7-x/ja/user-guide/introduction", + "dropdown": "API 文档", + "icon": "code", + "groups": [ { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/3-5-x/ja/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/ja/user-guide/model-configuration/load-balancing" - ] + "group": "Chatbot 和 Agent", + "openapi": "zh/api-reference/openapi_chat.json" }, { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", - { - "group": "ノードの説明", - "pages": [ - "versions/3-7-x/ja/user-guide/workflow/node/user-input", - { - "group": "トリガー", - "pages": [ - "versions/3-7-x/ja/user-guide/workflow/node/trigger/overview", - "versions/3-7-x/ja/user-guide/workflow/node/trigger/schedule-trigger", - "versions/3-7-x/ja/user-guide/workflow/node/trigger/plugin-trigger", - "versions/3-7-x/ja/user-guide/workflow/node/trigger/webhook-trigger" - ] - }, - "versions/3-7-x/ja/user-guide/workflow/node/output", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/3-7-x/ja/user-guide/workflow/node/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } - ] + "group": "Chatflow", + "openapi": "zh/api-reference/openapi_chatflow.json" }, { - "group": "アプリのデバッグ", - "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" - ] - } - ] + "group": "工作流", + "openapi": "zh/api-reference/openapi_workflow.json" }, { - "group": "ツール", + "group": "知识库", + "openapi": "zh/api-reference/openapi_knowledge.json" + }, + { + "group": "文本生成", + "openapi": "zh/api-reference/openapi_completion.json" + } + ] + }, + { + "dropdown": "开发插件", + "icon": "code-pull-request", + "groups": [ + { + "group": "快速开始", "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" + "zh/develop-plugin/getting-started/getting-started-dify-plugin", + "zh/develop-plugin/getting-started/cli" ] }, { - "group": "アプリのリリース", + "group": "特性与规范", "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", { - "group": "公開Webアプリとしてのリリース", + "group": "插件类型", "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "zh/develop-plugin/features-and-specs/plugin-types/general-specifications", + "zh/develop-plugin/features-and-specs/plugin-types/model-designing-rules", + "zh/develop-plugin/features-and-specs/plugin-types/model-schema", + "zh/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv", + "zh/develop-plugin/features-and-specs/plugin-types/tool", + "zh/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest", + "zh/develop-plugin/features-and-specs/plugin-types/multilingual-readme", + "zh/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin", + "zh/develop-plugin/features-and-specs/plugin-types/plugin-logging" ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" + { + "group": "高级开发", + "pages": [ + { + "group": "反向调用", + "pages": [ + "zh/develop-plugin/features-and-specs/advanced-development/bundle", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool", + "zh/develop-plugin/features-and-specs/advanced-development/customizable-model", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node" + ] + } + ] + } ] }, { - "group": "管理", + "group": "开发指南与示例", "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" + "zh/develop-plugin/dev-guides-and-walkthroughs/cheatsheet", + "zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/tool-oauth", + "zh/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider", + "zh/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/endpoint", + "zh/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter", + "zh/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool" ] }, { - "group": "監視", + "group": "发布", "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", { - "group": "外部Opsツールの統合", + "group": "标准", "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + "zh/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct", + "zh/develop-plugin/publishing/standards/privacy-protection-guidelines", + "zh/develop-plugin/publishing/standards/third-party-signature-verification" + ] + }, + { + "group": "上架插件市场", + "pages": [ + "zh/develop-plugin/publishing/marketplace-listing/plugin-auto-publish-pr", + "zh/develop-plugin/publishing/marketplace-listing/release-overview", + "zh/develop-plugin/publishing/marketplace-listing/release-by-file", + "zh/develop-plugin/publishing/marketplace-listing/release-to-dify-marketplace", + "zh/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo" + ] + }, + { + "group": "常见问题", + "pages": [ + "zh/develop-plugin/publishing/faq/faq" ] } ] } ] } - ] - } - ] - }, - { - "version": "3.6.x (Enterprise)", - "languages": [ + ], + "default": true + }, { - "language": "zh", - "href": "versions/3-6-x/zh/user-guide/introduction", + "version": "3.7.x (Enterprise)", "groups": [ { "group": "用户手册", "pages": [ - "versions/3-6-x/zh/user-guide/introduction", + "versions/3-7-x/zh/user-guide/introduction", { "group": "接入大模型", "pages": [ @@ -1857,9 +2844,18 @@ { "group": "节点说明", "pages": [ - "versions/3-0-x/zh/user-guide/workflow/node/start", + "versions/3-7-x/zh/user-guide/workflow/node/user-input", + { + "group": "触发器", + "pages": [ + "versions/3-7-x/zh/user-guide/workflow/node/trigger/overview", + "versions/3-7-x/zh/user-guide/workflow/node/trigger/schedule-trigger", + "versions/3-7-x/zh/user-guide/workflow/node/trigger/plugin-trigger", + "versions/3-7-x/zh/user-guide/workflow/node/trigger/webhook-trigger" + ] + }, "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", + "versions/3-7-x/zh/user-guide/workflow/node/knowledge-retrieval", "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", "versions/3-0-x/zh/user-guide/workflow/node/ifelse", "versions/3-0-x/zh/user-guide/workflow/node/code", @@ -1873,7 +2869,7 @@ "versions/3-0-x/zh/user-guide/workflow/node/http-request", "versions/3-0-x/zh/user-guide/workflow/node/agent", "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-0-x/zh/user-guide/workflow/node/end", + "versions/3-7-x/zh/user-guide/workflow/node/output", "versions/3-0-x/zh/user-guide/workflow/node/answer", "versions/3-0-x/zh/user-guide/workflow/node/loop" ] @@ -1916,13 +2912,13 @@ { "group": "1. 导入文本数据", "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-7-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] }, "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" + "versions/3-7-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" ] }, { @@ -1930,7 +2926,7 @@ "pages": [ "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/readme", "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", + "versions/3-7-x/zh/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/upload-files", "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", @@ -1941,7 +2937,7 @@ "group": "管理知识库", "pages": [ "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-7-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" ] }, @@ -1994,414 +2990,280 @@ }, "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "标注", - "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "监测", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", - { - "group": "集成外部与 Ops 工具", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" - ] - }, - { - "group": "管理", - "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "language": "en", - "default": true, - "href": "versions/3-6-x/en/user-guide/introduction", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/3-6-x/en/user-guide/introduction", - { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema", - "versions/3-5-x/en/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/en/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "Workflow", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", - { - "group": "Debug and Preview", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" - ] - }, - { - "group": "Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", - { - "group": "Create Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. Import Text Data", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Create from Knowledge Pipeline", - "pages": [ - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/readme", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/upload-files", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" - ] - }, - { - "group": "Manage Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" + "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "Tools", + "group": "标注", "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" + "versions/3-0-x/zh/user-guide/annotation/logs", + "versions/3-0-x/zh/user-guide/annotation/annotation-reply" ] }, { - "group": "Publishing", + "group": "监测", "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", + "versions/3-0-x/zh/user-guide/monitoring/README", { - "group": "Publish as a Single-page Web App", + "group": "集成外部与 Ops 工具", "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" + "versions/3-0-x/zh/user-guide/monitoring/analysis" ] }, { - "group": "Annotation", + "group": "管理", "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" + "versions/3-0-x/zh/user-guide/management/app-management", + "versions/3-0-x/zh/user-guide/management/team-members-management", + "versions/3-0-x/zh/user-guide/management/personal-account-management", + "versions/3-0-x/zh/user-guide/management/subscription-management", + "versions/3-0-x/zh/user-guide/management/version-control" ] - }, + } + ] + } + ] + }, + { + "version": "3.6.x (Enterprise)", + "groups": [ + { + "group": "用户手册", + "pages": [ + "versions/3-6-x/zh/user-guide/introduction", { - "group": "Monitoring", + "group": "接入大模型", "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } + "versions/3-0-x/zh/user-guide/model-configuration/readme", + "versions/3-0-x/zh/user-guide/model-configuration/new-provider", + "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", + "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", + "versions/3-0-x/zh/user-guide/model-configuration/interfaces", + "versions/3-0-x/zh/user-guide/model-configuration/schema", + "versions/3-5-x/zh/user-guide/model-configuration/manage-model-credential", + "versions/3-5-x/zh/user-guide/model-configuration/load-balancing" ] }, { - "group": "Extensions", + "group": "构建应用", "pages": [ + "versions/3-0-x/zh/user-guide/application-orchestrate/readme", + "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", { - "group": "API-Based Extension", + "group": "聊天助手", "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", + "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" ] }, + "versions/3-0-x/zh/user-guide/application-orchestrate/agent", { - "group": "Code-Based Extension", + "group": "应用工具箱", "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", + "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" ] } ] }, { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "language": "ja", - "href": "versions/3-6-x/ja/user-guide/introduction", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-6-x/ja/user-guide/introduction", - { - "group": "モデルの接続", + "group": "工作流", "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/3-5-x/ja/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/ja/user-guide/model-configuration/load-balancing" + "versions/3-0-x/zh/user-guide/workflow/readme", + "versions/3-0-x/zh/user-guide/workflow/key-concept", + "versions/3-0-x/zh/user-guide/workflow/variables", + { + "group": "节点说明", + "pages": [ + "versions/3-0-x/zh/user-guide/workflow/node/start", + "versions/3-0-x/zh/user-guide/workflow/node/llm", + "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", + "versions/3-0-x/zh/user-guide/workflow/node/ifelse", + "versions/3-0-x/zh/user-guide/workflow/node/code", + "versions/3-0-x/zh/user-guide/workflow/node/template", + "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", + "versions/3-0-x/zh/user-guide/workflow/node/list-operator", + "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", + "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", + "versions/3-0-x/zh/user-guide/workflow/node/iteration", + "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", + "versions/3-0-x/zh/user-guide/workflow/node/http-request", + "versions/3-0-x/zh/user-guide/workflow/node/agent", + "versions/3-0-x/zh/user-guide/workflow/node/tools", + "versions/3-0-x/zh/user-guide/workflow/node/end", + "versions/3-0-x/zh/user-guide/workflow/node/answer", + "versions/3-0-x/zh/user-guide/workflow/node/loop" + ] + }, + "versions/3-0-x/zh/user-guide/workflow/shortcut-key", + "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", + "versions/3-0-x/zh/user-guide/workflow/file-upload", + { + "group": "异常处理", + "pages": [ + "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", + "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", + "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" + ] + }, + "versions/3-0-x/zh/user-guide/workflow/additional-feature", + { + "group": "预览与调试", + "pages": [ + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" + ] + }, + "versions/3-0-x/zh/user-guide/workflow/publish", + "versions/3-0-x/zh/user-guide/workflow/structured-outputs", + "versions/3-0-x/zh/user-guide/workflow/bulletin" ] }, { - "group": "アプリの構築", + "group": "知识库", "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", + "versions/3-0-x/zh/user-guide/knowledge-base/readme", { - "group": "チャットフロー & ワークフロー", + "group": "创建知识库", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", { - "group": "ノードの説明", + "group": "1. 导入文本数据", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" + ] + }, + { + "group": "从知识流水线创建", + "pages": [ + "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/readme", + "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", + "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", + "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", + "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/upload-files", + "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", + "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" + ] + }, + { + "group": "管理知识库", + "pages": [ + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + ] + }, + "versions/3-0-x/zh/user-guide/knowledge-base/metadata", + "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" + ] + }, + { + "group": "工具", + "pages": [ + "versions/3-0-x/zh/user-guide/tools/readme", + "versions/3-3-x/zh/user-guide/tools/mcp", + "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", + "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", + { + "group": "工具配置详情", + "pages": [ + "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" ] } ] }, { - "group": "アプリのデバッグ", + "group": "发布", "pages": [ + "versions/2-8-x/zh/user-guide/application-publishing/permission-management", + "versions/3-3-x/zh/user-guide/application-publishing/publish-mcp", { - "group": "チャットフロー & ワークフロー", + "group": "发布为公开 Web 站点", "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] - } + }, + "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "ツール", + "group": "标注", "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" + "versions/3-0-x/zh/user-guide/annotation/logs", + "versions/3-0-x/zh/user-guide/annotation/annotation-reply" ] }, { - "group": "アプリのリリース", + "group": "监测", "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", + "versions/3-0-x/zh/user-guide/monitoring/README", { - "group": "公開Webアプリとしてのリリース", + "group": "集成外部与 Ops 工具", "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" + "versions/3-0-x/zh/user-guide/monitoring/analysis" ] }, { "group": "管理", "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } + "versions/3-0-x/zh/user-guide/management/app-management", + "versions/3-0-x/zh/user-guide/management/team-members-management", + "versions/3-0-x/zh/user-guide/management/personal-account-management", + "versions/3-0-x/zh/user-guide/management/subscription-management", + "versions/3-0-x/zh/user-guide/management/version-control" ] } ] } ] - } - ] - }, - { - "version": "3.5.x (Enterprise)", - "languages": [ + }, { - "language": "zh", - "href": "versions/3-5-x/zh/user-guide/introduction", + "version": "3.5.x (Enterprise)", "groups": [ { "group": "用户手册", @@ -2619,364 +3481,229 @@ ] }, { - "language": "en", - "default": true, - "href": "versions/3-5-x/en/user-guide/introduction", + "version": "3.4.x (Enterprise)", "groups": [ { - "group": "User Guide", + "group": "用户手册", "pages": [ - "versions/3-5-x/en/user-guide/introduction", - { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema", - "versions/3-5-x/en/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/en/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "Workflow", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", - { - "group": "Debug and Preview", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" - ] - }, - { - "group": "Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", - { - "group": "Create Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. Import Text Data", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Manage Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" - ] - }, - { - "group": "Tools", - "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" - ] - }, - { - "group": "Publishing", - "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" - ] - }, + "versions/3-4-x/zh/user-guide/introduction", { - "group": "Monitoring", + "group": "接入大模型", "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } + "versions/3-0-x/zh/user-guide/model-configuration/readme", + "versions/3-0-x/zh/user-guide/model-configuration/new-provider", + "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", + "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", + "versions/3-0-x/zh/user-guide/model-configuration/interfaces", + "versions/3-0-x/zh/user-guide/model-configuration/schema", + "versions/3-0-x/zh/user-guide/model-configuration/load-balancing" ] }, { - "group": "Extensions", + "group": "构建应用", "pages": [ + "versions/3-0-x/zh/user-guide/application-orchestrate/readme", + "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", { - "group": "API-Based Extension", + "group": "聊天助手", "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", + "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" ] }, + "versions/3-0-x/zh/user-guide/application-orchestrate/agent", { - "group": "Code-Based Extension", + "group": "应用工具箱", "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", + "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" ] } ] }, { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "language": "ja", - "href": "versions/3-5-x/ja/user-guide/introduction", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-5-x/ja/user-guide/introduction", - { - "group": "モデルの接続", + "group": "工作流", "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/3-5-x/ja/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/ja/user-guide/model-configuration/load-balancing" + "versions/3-0-x/zh/user-guide/workflow/readme", + "versions/3-0-x/zh/user-guide/workflow/key-concept", + "versions/3-0-x/zh/user-guide/workflow/variables", + { + "group": "节点说明", + "pages": [ + "versions/3-0-x/zh/user-guide/workflow/node/start", + "versions/3-0-x/zh/user-guide/workflow/node/llm", + "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", + "versions/3-0-x/zh/user-guide/workflow/node/ifelse", + "versions/3-0-x/zh/user-guide/workflow/node/code", + "versions/3-0-x/zh/user-guide/workflow/node/template", + "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", + "versions/3-0-x/zh/user-guide/workflow/node/list-operator", + "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", + "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", + "versions/3-0-x/zh/user-guide/workflow/node/iteration", + "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", + "versions/3-0-x/zh/user-guide/workflow/node/http-request", + "versions/3-0-x/zh/user-guide/workflow/node/agent", + "versions/3-0-x/zh/user-guide/workflow/node/tools", + "versions/3-0-x/zh/user-guide/workflow/node/end", + "versions/3-0-x/zh/user-guide/workflow/node/answer", + "versions/3-0-x/zh/user-guide/workflow/node/loop" + ] + }, + "versions/3-0-x/zh/user-guide/workflow/shortcut-key", + "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", + "versions/3-0-x/zh/user-guide/workflow/file-upload", + { + "group": "异常处理", + "pages": [ + "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", + "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", + "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" + ] + }, + "versions/3-0-x/zh/user-guide/workflow/additional-feature", + { + "group": "预览与调试", + "pages": [ + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" + ] + }, + "versions/3-0-x/zh/user-guide/workflow/publish", + "versions/3-0-x/zh/user-guide/workflow/structured-outputs", + "versions/3-0-x/zh/user-guide/workflow/bulletin" ] }, { - "group": "アプリの構築", + "group": "知识库", "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", + "versions/3-0-x/zh/user-guide/knowledge-base/readme", { - "group": "チャットフロー & ワークフロー", + "group": "创建知识库", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", { - "group": "ノードの説明", + "group": "1. 导入文本数据", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" ] - } + }, + { + "group": "管理知识库", + "pages": [ + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + ] + }, + "versions/3-0-x/zh/user-guide/knowledge-base/metadata", + "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" ] }, { - "group": "アプリのデバッグ", + "group": "工具", "pages": [ + "versions/3-0-x/zh/user-guide/tools/readme", + "versions/3-3-x/zh/user-guide/tools/mcp", + "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", + "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", { - "group": "チャットフロー & ワークフロー", + "group": "工具配置详情", "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" + "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" ] } ] }, { - "group": "ツール", - "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" - ] - }, - { - "group": "アプリのリリース", + "group": "发布", "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", + "versions/2-8-x/zh/user-guide/application-publishing/permission-management", + "versions/3-3-x/zh/user-guide/application-publishing/publish-mcp", { - "group": "公開Webアプリとしてのリリース", + "group": "发布为公开 Web 站点", "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" + "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "管理", + "group": "标注", "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" + "versions/3-0-x/zh/user-guide/annotation/logs", + "versions/3-0-x/zh/user-guide/annotation/annotation-reply" ] }, { - "group": "監視", + "group": "监测", "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", + "versions/3-0-x/zh/user-guide/monitoring/README", { - "group": "外部Opsツールの統合", + "group": "集成外部与 Ops 工具", "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] - } + }, + "versions/3-0-x/zh/user-guide/monitoring/analysis" + ] + }, + { + "group": "管理", + "pages": [ + "versions/3-0-x/zh/user-guide/management/app-management", + "versions/3-0-x/zh/user-guide/management/team-members-management", + "versions/3-0-x/zh/user-guide/management/personal-account-management", + "versions/3-0-x/zh/user-guide/management/subscription-management", + "versions/3-0-x/zh/user-guide/management/version-control" ] } ] } ] - } - ] - }, - { - "version": "3.4.x (Enterprise)", - "languages": [ + }, { - "language": "zh", - "href": "versions/3-4-x/zh/user-guide/introduction", + "version": "3.3.x (Enterprise)", "groups": [ { "group": "用户手册", "pages": [ - "versions/3-4-x/zh/user-guide/introduction", + "versions/3-3-x/zh/user-guide/introduction", { "group": "接入大模型", "pages": [ @@ -3188,361 +3915,228 @@ ] }, { - "language": "en", - "default": true, - "href": "versions/3-4-x/en/user-guide/introduction", + "version": "3.2.x (Enterprise)", "groups": [ { - "group": "User Guide", + "group": "用户手册", "pages": [ - "versions/3-4-x/en/user-guide/introduction", - { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, + "versions/3-2-x/zh/user-guide/introduction", { - "group": "Workflow", + "group": "接入大模型", "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", - { - "group": "Debug and Preview", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" + "versions/3-0-x/zh/user-guide/model-configuration/readme", + "versions/3-0-x/zh/user-guide/model-configuration/new-provider", + "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", + "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", + "versions/3-0-x/zh/user-guide/model-configuration/interfaces", + "versions/3-0-x/zh/user-guide/model-configuration/schema", + "versions/3-0-x/zh/user-guide/model-configuration/load-balancing", + "versions/3-0-x/zh/user-guide/model-configuration/manage-model-credential" ] }, { - "group": "Knowledge", + "group": "构建应用", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", + "versions/3-0-x/zh/user-guide/application-orchestrate/readme", + "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", { - "group": "Create Knowledge", + "group": "聊天助手", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. Import Text Data", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" + "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", + "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" ] }, + "versions/3-0-x/zh/user-guide/application-orchestrate/agent", { - "group": "Manage Knowledge", + "group": "应用工具箱", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", + "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" - ] - }, - { - "group": "Tools", - "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" + } ] }, { - "group": "Publishing", + "group": "工作流", "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", + "versions/3-0-x/zh/user-guide/workflow/readme", + "versions/3-0-x/zh/user-guide/workflow/key-concept", + "versions/3-0-x/zh/user-guide/workflow/variables", { - "group": "Publish as a Single-page Web App", + "group": "节点说明", "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/3-0-x/zh/user-guide/workflow/node/start", + "versions/3-0-x/zh/user-guide/workflow/node/llm", + "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", + "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", + "versions/3-0-x/zh/user-guide/workflow/node/ifelse", + "versions/3-0-x/zh/user-guide/workflow/node/code", + "versions/3-0-x/zh/user-guide/workflow/node/template", + "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", + "versions/3-0-x/zh/user-guide/workflow/node/list-operator", + "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", + "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", + "versions/3-0-x/zh/user-guide/workflow/node/iteration", + "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", + "versions/3-0-x/zh/user-guide/workflow/node/http-request", + "versions/3-0-x/zh/user-guide/workflow/node/agent", + "versions/3-0-x/zh/user-guide/workflow/node/tools", + "versions/3-0-x/zh/user-guide/workflow/node/end", + "versions/3-0-x/zh/user-guide/workflow/node/answer", + "versions/3-0-x/zh/user-guide/workflow/node/loop" ] }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - }, - { - "group": "Extensions", - "pages": [ + "versions/3-0-x/zh/user-guide/workflow/shortcut-key", + "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", + "versions/3-0-x/zh/user-guide/workflow/file-upload", { - "group": "API-Based Extension", + "group": "异常处理", "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", + "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", + "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" ] }, + "versions/3-0-x/zh/user-guide/workflow/additional-feature", { - "group": "Code-Based Extension", + "group": "预览与调试", "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" - ] - } - ] - }, - { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "language": "ja", - "href": "versions/3-4-x/ja/user-guide/introduction", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-4-x/ja/user-guide/introduction", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" + ] + }, + "versions/3-0-x/zh/user-guide/workflow/publish", + "versions/3-0-x/zh/user-guide/workflow/structured-outputs", + "versions/3-0-x/zh/user-guide/workflow/bulletin" ] }, { - "group": "アプリの構築", + "group": "知识库", "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", + "versions/3-0-x/zh/user-guide/knowledge-base/readme", { - "group": "チャットフロー & ワークフロー", + "group": "创建知识库", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", { - "group": "ノードの説明", + "group": "1. 导入文本数据", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" ] }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", + "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" ] - } + }, + { + "group": "管理知识库", + "pages": [ + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + ] + }, + "versions/3-0-x/zh/user-guide/knowledge-base/metadata", + "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", + "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", + "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", + "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", + "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" ] }, { - "group": "アプリのデバッグ", + "group": "工具", "pages": [ + "versions/3-0-x/zh/user-guide/tools/readme", + "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", + "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", { - "group": "チャットフロー & ワークフロー", + "group": "工具配置详情", "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" + "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", + "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" ] } ] }, { - "group": "ツール", - "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" - ] - }, - { - "group": "アプリのリリース", + "group": "发布", "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", + "versions/2-8-x/zh/user-guide/application-publishing/permission-management", { - "group": "公開Webアプリとしてのリリース", + "group": "发布为公开 Web 站点", "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" + "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", + "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", + "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "管理", + "group": "标注", "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" + "versions/3-0-x/zh/user-guide/annotation/logs", + "versions/3-0-x/zh/user-guide/annotation/annotation-reply" ] }, { - "group": "監視", + "group": "监测", "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", + "versions/3-0-x/zh/user-guide/monitoring/README", { - "group": "外部Opsツールの統合", + "group": "集成外部与 Ops 工具", "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", + "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] - } + }, + "versions/3-0-x/zh/user-guide/monitoring/analysis" + ] + }, + { + "group": "管理", + "pages": [ + "versions/3-0-x/zh/user-guide/management/app-management", + "versions/3-0-x/zh/user-guide/management/team-members-management", + "versions/3-0-x/zh/user-guide/management/personal-account-management", + "versions/3-0-x/zh/user-guide/management/subscription-management", + "versions/3-0-x/zh/user-guide/management/version-control" ] } ] } ] - } - ] - }, - { - "version": "3.3.x (Enterprise)", - "languages": [ + }, { - "language": "zh", - "href": "versions/3-3-x/zh/user-guide/introduction", + "version": "3.0.x (Enterprise)", "groups": [ { "group": "用户手册", "pages": [ - "versions/3-3-x/zh/user-guide/introduction", + "versions/3-0-x/zh/user-guide/introduction", { "group": "接入大模型", "pages": [ @@ -3623,10 +4217,7 @@ "group": "预览与调试", "pages": [ "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" + "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run" ] }, "versions/3-0-x/zh/user-guide/workflow/publish", @@ -3674,7 +4265,6 @@ "group": "工具", "pages": [ "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-3-x/zh/user-guide/tools/mcp", "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", { @@ -3699,7 +4289,6 @@ "group": "发布", "pages": [ "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - "versions/3-3-x/zh/user-guide/application-publishing/publish-mcp", { "group": "发布为公开 Web 站点", "pages": [ @@ -3736,17 +4325,121 @@ "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" + "versions/3-0-x/zh/user-guide/monitoring/analysis" + ] + }, + { + "group": "管理", + "pages": [ + "versions/3-0-x/zh/user-guide/management/app-management", + "versions/3-0-x/zh/user-guide/management/team-members-management", + "versions/3-0-x/zh/user-guide/management/personal-account-management", + "versions/3-0-x/zh/user-guide/management/subscription-management", + "versions/3-0-x/zh/user-guide/management/version-control" + ] + } + ] + } + ] + }, + { + "version": "2.8.x (Enterprise)", + "groups": [ + { + "group": "用户手册", + "pages": [ + "versions/legacy/zh/user-guide/welcome", + { + "group": "接入模型", + "pages": [ + "versions/legacy/zh/user-guide/models/model-configuration", + "versions/legacy/zh/user-guide/models/new-provider", + "versions/legacy/zh/user-guide/models/predefined-model", + "versions/legacy/zh/user-guide/models/customizable-model", + "versions/legacy/zh/user-guide/models/interfaces", + "versions/legacy/zh/user-guide/models/schema", + "versions/legacy/zh/user-guide/models/load-balancing" + ] + }, + { + "group": "构建应用", + "pages": [ + "versions/legacy/zh/user-guide/build-app/chatbot", + "versions/legacy/zh/user-guide/build-app/text-generator", + "versions/legacy/zh/user-guide/build-app/agent", + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/zh/user-guide/build-app/flow-app/concepts", + "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/zh/user-guide/build-app/flow-app/variables", + { + "group": "节点说明", + "pages": [ + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" + ] + }, + "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", + "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" + ] + } + ] + }, + { + "group": "调试应用", + "pages": [ + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" + ] + } + ] + }, + { + "group": "发布应用", + "pages": [ + "versions/2-8-x/zh/user-guide/application-publishing/permission-management", + { + "group": "发布为公开 Web 站点", + "pages": [ + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", + "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" ] }, { "group": "管理", "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" + "versions/legacy/zh/user-guide/management/app-management", + "versions/legacy/zh/user-guide/management/team-members-management", + "versions/legacy/zh/user-guide/management/personal-account-management" ] } ] @@ -3754,214 +4447,207 @@ ] }, { - "language": "en", - "default": true, - "href": "versions/3-3-x/en/user-guide/introduction", + "version": "2.7.x (Enterprise)", "groups": [ { - "group": "User Guide", + "group": "用户手册", "pages": [ - "versions/3-3-x/en/user-guide/introduction", + "versions/legacy/zh/user-guide/welcome", { - "group": "Model Configuration", + "group": "接入模型", "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema" + "versions/legacy/zh/user-guide/models/model-configuration", + "versions/legacy/zh/user-guide/models/new-provider", + "versions/legacy/zh/user-guide/models/predefined-model", + "versions/legacy/zh/user-guide/models/customizable-model", + "versions/legacy/zh/user-guide/models/interfaces", + "versions/legacy/zh/user-guide/models/schema", + "versions/legacy/zh/user-guide/models/load-balancing" ] }, { - "group": "Application Orchestration", + "group": "构建应用", "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", + "versions/legacy/zh/user-guide/build-app/chatbot", + "versions/legacy/zh/user-guide/build-app/text-generator", + "versions/legacy/zh/user-guide/build-app/agent", { - "group": "Application Toolkits", + "group": "Chatflow & Workflow", "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" + "versions/legacy/zh/user-guide/build-app/flow-app/concepts", + "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/zh/user-guide/build-app/flow-app/variables", + { + "group": "节点说明", + "pages": [ + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" + ] + }, + "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", + "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" ] } ] }, { - "group": "Workflow", + "group": "调试应用", "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", { - "group": "Debug and Preview", + "group": "Chatflow & Workflow", "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" ] - }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" + } ] }, { - "group": "Knowledge", + "group": "发布应用", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", - { - "group": "Create Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. Import Text Data", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, + "versions/legacy/zh/user-guide/application-publishing/permission-management", { - "group": "Manage Knowledge", + "group": "发布为公开 Web 站点", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" + "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", + "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "Tools", + "group": "管理", "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" + "versions/legacy/zh/user-guide/management/app-management", + "versions/legacy/zh/user-guide/management/team-members-management", + "versions/legacy/zh/user-guide/management/personal-account-management" ] - }, + } + ] + } + ] + }, + { + "version": "2.6.x (Enterprise)", + "groups": [ + { + "group": "用户手册", + "pages": [ + "versions/legacy/zh/user-guide/welcome", { - "group": "Publishing", + "group": "接入模型", "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" + "versions/legacy/zh/user-guide/models/model-configuration", + "versions/legacy/zh/user-guide/models/new-provider", + "versions/legacy/zh/user-guide/models/predefined-model", + "versions/legacy/zh/user-guide/models/customizable-model", + "versions/legacy/zh/user-guide/models/interfaces", + "versions/legacy/zh/user-guide/models/schema", + "versions/legacy/zh/user-guide/models/load-balancing" ] }, { - "group": "Annotation", + "group": "构建应用", "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" + "versions/legacy/zh/user-guide/build-app/chatbot", + "versions/legacy/zh/user-guide/build-app/text-generator", + "versions/legacy/zh/user-guide/build-app/agent", + { + "group": "Chatflow & Workflow", + "pages": [ + "versions/legacy/zh/user-guide/build-app/flow-app/concepts", + "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/zh/user-guide/build-app/flow-app/variables", + { + "group": "节点说明", + "pages": [ + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" + ] + }, + "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", + "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" + ] + } ] }, { - "group": "Monitoring", + "group": "调试应用", "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", { - "group": "Integrate External Ops Tools", + "group": "Chatflow & Workflow", "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" ] } ] }, { - "group": "Extensions", + "group": "发布应用", "pages": [ + "versions/legacy/zh/user-guide/application-publishing/permission-management", { - "group": "API-Based Extension", + "group": "发布为公开 Web 站点", "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - { - "group": "Code-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" - ] - } + "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", + "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "Management", + "group": "管理", "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" + "versions/legacy/zh/user-guide/management/app-management", + "versions/legacy/zh/user-guide/management/team-members-management", + "versions/legacy/zh/user-guide/management/personal-account-management" ] } ] @@ -3969,127 +4655,102 @@ ] }, { - "language": "ja", - "href": "versions/3-3-x/ja/user-guide/introduction", + "version": "2.5.x (Enterprise)", "groups": [ { - "group": "ユーザーマニュアル", + "group": "用户手册", "pages": [ - "versions/3-3-x/ja/user-guide/introduction", + "versions/legacy/zh/user-guide/welcome", { - "group": "モデルの接続", + "group": "接入模型", "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" + "versions/legacy/zh/user-guide/models/model-configuration", + "versions/legacy/zh/user-guide/models/new-provider", + "versions/legacy/zh/user-guide/models/predefined-model", + "versions/legacy/zh/user-guide/models/customizable-model", + "versions/legacy/zh/user-guide/models/interfaces", + "versions/legacy/zh/user-guide/models/schema", + "versions/legacy/zh/user-guide/models/load-balancing" ] }, { - "group": "アプリの構築", + "group": "构建应用", "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", + "versions/legacy/zh/user-guide/build-app/chatbot", + "versions/legacy/zh/user-guide/build-app/text-generator", + "versions/legacy/zh/user-guide/build-app/agent", { - "group": "チャットフロー & ワークフロー", + "group": "Chatflow & Workflow", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", + "versions/legacy/zh/user-guide/build-app/flow-app/concepts", + "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/zh/user-guide/build-app/flow-app/variables", { - "group": "ノードの説明", + "group": "节点说明", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" ] }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" + "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", + "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" ] } ] }, { - "group": "アプリのデバッグ", + "group": "调试应用", "pages": [ { - "group": "チャットフロー & ワークフロー", + "group": "Chatflow & Workflow", "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" ] } ] }, { - "group": "ツール", - "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" - ] - }, - { - "group": "アプリのリリース", + "group": "发布应用", "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", { - "group": "公開Webアプリとしてのリリース", + "group": "发布为公开 Web 站点", "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" + "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", + "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" ] }, { "group": "管理", "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } + "versions/legacy/zh/user-guide/management/app-management", + "versions/legacy/zh/user-guide/management/team-members-management", + "versions/legacy/zh/user-guide/management/personal-account-management" ] } ] @@ -4099,443 +4760,401 @@ ] }, { - "version": "3.2.x (Enterprise)", - "languages": [ + "language": "ja", + "versions": [ { - "language": "zh", - "href": "versions/3-2-x/zh/user-guide/introduction", - "groups": [ + "version": "Latest", + "dropdowns": [ { - "group": "用户手册", + "dropdown": "Dify を使う", + "icon": "book-open", "pages": [ - "versions/3-2-x/zh/user-guide/introduction", - { - "group": "接入大模型", - "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-0-x/zh/user-guide/model-configuration/load-balancing", - "versions/3-0-x/zh/user-guide/model-configuration/manage-model-credential" - ] - }, { - "group": "构建应用", + "group": " ", "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", { - "group": "聊天助手", + "group": "はじめに", + "expanded": false, "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" + "ja/use-dify/getting-started/introduction", + "ja/use-dify/getting-started/quick-start", + "ja/use-dify/getting-started/key-concepts" + ] + }, + { + "group": "ノード", + "expanded": false, + "pages": [ + "ja/use-dify/nodes/user-input", + { + "group": "トリガー", + "icon": "bolt-lightning", + "pages": [ + "ja/use-dify/nodes/trigger/overview", + "ja/use-dify/nodes/trigger/schedule-trigger", + "ja/use-dify/nodes/trigger/plugin-trigger", + "ja/use-dify/nodes/trigger/webhook-trigger" + ] + }, + "ja/use-dify/nodes/llm", + "ja/use-dify/nodes/knowledge-retrieval", + "ja/use-dify/nodes/answer", + "ja/use-dify/nodes/output", + "ja/use-dify/nodes/agent", + "ja/use-dify/nodes/question-classifier", + "ja/use-dify/nodes/ifelse", + "ja/use-dify/nodes/human-input", + "ja/use-dify/nodes/iteration", + "ja/use-dify/nodes/loop", + "ja/use-dify/nodes/code", + "ja/use-dify/nodes/template", + "ja/use-dify/nodes/variable-aggregator", + "ja/use-dify/nodes/doc-extractor", + "ja/use-dify/nodes/variable-assigner", + "ja/use-dify/nodes/parameter-extractor", + "ja/use-dify/nodes/http-request", + "ja/use-dify/nodes/list-operator", + "ja/use-dify/nodes/tools" ] }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", { - "group": "应用工具箱", + "group": "ビルド", + "expanded": false, "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" + "ja/use-dify/build/shortcut-key", + "ja/use-dify/build/goto-anything", + "ja/use-dify/build/orchestrate-node", + "ja/use-dify/build/predefined-error-handling-logic", + "ja/use-dify/build/mcp", + "ja/use-dify/build/version-control", + "ja/use-dify/build/additional-features" ] - } - ] - }, - { - "group": "工作流", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", + }, { - "group": "节点说明", + "group": "デバッグ", + "expanded": false, "pages": [ - "versions/3-0-x/zh/user-guide/workflow/node/start", - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-0-x/zh/user-guide/workflow/node/end", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" + "ja/use-dify/debug/step-run", + "ja/use-dify/debug/variable-inspect", + "ja/use-dify/debug/history-and-logs", + "ja/use-dify/debug/error-type" ] }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", { - "group": "异常处理", + "group": "公開", + "expanded": false, "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" + "ja/use-dify/publish/README", + { + "group": "Webアプリ", + "icon": "globe", + "pages": [ + "ja/use-dify/publish/webapp/workflow-webapp", + "ja/use-dify/publish/webapp/chatflow-webapp", + "ja/use-dify/publish/webapp/web-app-settings", + "ja/use-dify/publish/webapp/web-app-access", + "ja/use-dify/publish/webapp/embedding-in-websites" + ] + }, + "ja/use-dify/publish/publish-mcp", + "ja/use-dify/publish/developing-with-apis", + "ja/use-dify/publish/publish-to-marketplace" ] }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", { - "group": "预览与调试", + "group": "モニタリング", + "expanded": false, "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" + "ja/use-dify/monitor/analysis", + "ja/use-dify/monitor/logs", + "ja/use-dify/monitor/annotation-reply", + { + "group": "インテグレーション", + "icon": "grid-2-plus", + "pages": [ + "ja/use-dify/monitor/integrations/integrate-langsmith", + "ja/use-dify/monitor/integrations/integrate-langfuse", + "ja/use-dify/monitor/integrations/integrate-opik", + "ja/use-dify/monitor/integrations/integrate-weave", + "ja/use-dify/monitor/integrations/integrate-arize", + "ja/use-dify/monitor/integrations/integrate-phoenix", + "ja/use-dify/monitor/integrations/integrate-aliyun" + ] + } ] }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" - ] - }, - { - "group": "知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", { - "group": "创建知识库", + "group": "ナレッジ", + "expanded": false, "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", + "ja/use-dify/knowledge/readme", { - "group": "1. 导入文本数据", + "group": "ナレッジの作成", + "icon": "square-plus", "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" + { + "group": "クイック作成", + "pages": [ + "ja/use-dify/knowledge/create-knowledge/introduction", + { + "group": "データのインポート", + "pages": [ + "ja/use-dify/knowledge/create-knowledge/import-text-data/readme", + "ja/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion", + "ja/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website" + ] + }, + "ja/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text", + "ja/use-dify/knowledge/create-knowledge/setting-indexing-methods" + ] + }, + { + "group": "ナレッジパイプラインから作成", + "pages": [ + "ja/use-dify/knowledge/knowledge-pipeline/readme", + "ja/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline", + "ja/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration", + "ja/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline", + "ja/use-dify/knowledge/knowledge-pipeline/upload-files", + "ja/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base", + "ja/use-dify/knowledge/knowledge-pipeline/authorize-data-source" + ] + }, + { + "group": "外部ナレッジベースと連携", + "pages": [ + "ja/use-dify/knowledge/connect-external-knowledge-base", + "ja/use-dify/knowledge/external-knowledge-api" + ] + } ] }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" + { + "group": "ナレッジの管理", + "icon": "gear", + "pages": [ + "ja/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents", + "ja/use-dify/knowledge/manage-knowledge/introduction", + "ja/use-dify/knowledge/metadata", + "ja/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api" + ] + }, + "ja/use-dify/knowledge/test-retrieval", + "ja/use-dify/knowledge/integrate-knowledge-within-application", + "ja/use-dify/knowledge/knowledge-request-rate-limit" ] }, { - "group": "管理知识库", + "group": "ワークスペース", + "expanded": false, "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + "ja/use-dify/workspace/readme", + "ja/use-dify/workspace/model-providers", + "ja/use-dify/workspace/plugins", + "ja/use-dify/workspace/app-management", + "ja/use-dify/workspace/team-members-management", + "ja/use-dify/workspace/personal-account-management", + "ja/use-dify/workspace/subscription-management", + { + "group": "API 拡張", + "icon": "puzzle-piece-simple", + "pages": [ + "ja/use-dify/workspace/api-extension/api-extension", + "ja/use-dify/workspace/api-extension/external-data-tool-api-extension", + "ja/use-dify/workspace/api-extension/moderation-api-extension", + "ja/use-dify/workspace/api-extension/cloudflare-worker" + ] + } ] }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" - ] - }, - { - "group": "工具", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", { - "group": "工具配置详情", + "group": "チュートリアル", + "expanded": false, "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" + "ja/use-dify/tutorials/twitter-chatflow", + "ja/use-dify/tutorials/customer-service-bot", + "ja/use-dify/tutorials/build-ai-image-generation-app", + "ja/use-dify/tutorials/article-reader" ] } ] + } + ] + }, + { + "dropdown": "セルフホスティング", + "icon": "server", + "pages": [ + { + "group": "クイックスタート", + "pages": [ + "ja/self-host/quick-start/docker-compose", + "ja/self-host/quick-start/faqs" + ] }, { - "group": "发布", + "group": "高度なデプロイ", "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" + "ja/self-host/advanced-deployments/local-source-code", + "ja/self-host/advanced-deployments/start-the-frontend-docker-container" ] }, { - "group": "标注", + "group": "設定", "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" + "ja/self-host/configuration/environments" ] }, { - "group": "监测", + "group": "プラットフォームガイド", "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", - { - "group": "集成外部与 Ops 工具", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" + "ja/self-host/platform-guides/bt-panel", + "ja/self-host/platform-guides/dify-premium" ] }, { - "group": "管理", + "group": "トラブルシューティング", "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" + "ja/self-host/troubleshooting/common-issues", + "ja/self-host/troubleshooting/docker-issues", + "ja/self-host/troubleshooting/integrations", + "ja/self-host/troubleshooting/storage-and-migration", + "ja/self-host/troubleshooting/weaviate-v4-migration" ] } ] - } - ] - }, - { - "language": "en", - "default": true, - "href": "versions/3-2-x/en/user-guide/introduction", - "groups": [ + }, { - "group": "User Guide", - "pages": [ - "versions/3-2-x/en/user-guide/introduction", + "dropdown": "APIアクセス", + "icon": "code", + "groups": [ { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema", - "versions/3-0-x/en/user-guide/model-configuration/manage-model-credential" - ] + "group": "ChatbotとAgent", + "openapi": "ja/api-reference/openapi_chat.json" }, { - "group": "Application Orchestration", + "group": "チャットフロー", + "openapi": "ja/api-reference/openapi_chatflow.json" + }, + { + "group": "ワークフロー", + "openapi": "ja/api-reference/openapi_workflow.json" + }, + { + "group": "ナレッジ", + "openapi": "ja/api-reference/openapi_knowledge.json" + }, + { + "group": "テキスト ジェネレーター", + "openapi": "ja/api-reference/openapi_completion.json" + } + ] + }, + { + "dropdown": "プラグイン開発", + "icon": "code-pull-request", + "groups": [ + { + "group": "はじめに", "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } + "ja/develop-plugin/getting-started/getting-started-dify-plugin", + "ja/develop-plugin/getting-started/cli" ] }, { - "group": "Workflow", + "group": "特性と仕様", "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", { - "group": "Debug and Preview", + "group": "プラグインタイプ", "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" + "ja/develop-plugin/features-and-specs/plugin-types/general-specifications", + "ja/develop-plugin/features-and-specs/plugin-types/model-designing-rules", + "ja/develop-plugin/features-and-specs/plugin-types/model-schema", + "ja/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv", + "ja/develop-plugin/features-and-specs/plugin-types/tool", + "ja/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest", + "ja/develop-plugin/features-and-specs/plugin-types/multilingual-readme", + "ja/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin", + "ja/develop-plugin/features-and-specs/plugin-types/plugin-logging" ] }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" - ] - }, - { - "group": "Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", { - "group": "Create Knowledge", + "group": "高度な開発", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", { - "group": "1. Import Text Data", + "group": "リバース呼び出し", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" + "ja/develop-plugin/features-and-specs/advanced-development/bundle", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool", + "ja/develop-plugin/features-and-specs/advanced-development/customizable-model", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node" ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Manage Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" - ] - }, - { - "group": "Publishing", - "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + } ] - }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" + } ] }, { - "group": "Annotation", + "group": "開発ガイドとサンプル", "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" + "ja/develop-plugin/dev-guides-and-walkthroughs/cheatsheet", + "ja/develop-plugin/dev-guides-and-walkthroughs/tool-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/tool-oauth", + "ja/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider", + "ja/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/endpoint", + "ja/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter", + "ja/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool" ] }, { - "group": "Monitoring", + "group": "公開", "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", { - "group": "Integrate External Ops Tools", + "group": "標準", "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + "ja/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct", + "ja/develop-plugin/publishing/standards/privacy-protection-guidelines", + "ja/develop-plugin/publishing/standards/third-party-signature-verification" ] - } - ] - }, - { - "group": "Extensions", - "pages": [ + }, { - "group": "API-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + "group": "マーケットプレイスリスト", + "pages": [ + "ja/develop-plugin/publishing/marketplace-listing/plugin-auto-publish-pr", + "ja/develop-plugin/publishing/marketplace-listing/release-overview", + "ja/develop-plugin/publishing/marketplace-listing/release-by-file", + "ja/develop-plugin/publishing/marketplace-listing/release-to-dify-marketplace", + "ja/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo" ] }, { - "group": "Code-Based Extension", + "group": "よくある質問", "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + "ja/develop-plugin/publishing/faq/faq" ] } ] - }, - { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] } ] } - ] + ], + "default": true }, { - "language": "ja", - "default": true, - "href": "versions/3-2-x/ja/user-guide/introduction", + "version": "3.7.x (Enterprise)", "groups": [ { - "group": "User Guide", + "group": "ユーザーマニュアル", "pages": [ - "versions/3-2-x/ja/user-guide/introduction", + "versions/3-7-x/ja/user-guide/introduction", { "group": "モデルの接続", "pages": [ @@ -4545,7 +5164,8 @@ "versions/legacy/ja/user-guide/models/customizable-model", "versions/legacy/ja/user-guide/models/interfaces", "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" + "versions/3-5-x/ja/user-guide/model-configuration/manage-model-credential", + "versions/3-5-x/ja/user-guide/model-configuration/load-balancing" ] }, { @@ -4563,11 +5183,20 @@ { "group": "ノードの説明", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", + "versions/3-7-x/ja/user-guide/workflow/node/user-input", + { + "group": "トリガー", + "pages": [ + "versions/3-7-x/ja/user-guide/workflow/node/trigger/overview", + "versions/3-7-x/ja/user-guide/workflow/node/trigger/schedule-trigger", + "versions/3-7-x/ja/user-guide/workflow/node/trigger/plugin-trigger", + "versions/3-7-x/ja/user-guide/workflow/node/trigger/webhook-trigger" + ] + }, + "versions/3-7-x/ja/user-guide/workflow/node/output", "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/3-7-x/ja/user-guide/workflow/node/knowledge-retrieval", "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", @@ -4604,10 +5233,17 @@ } ] }, + { + "group": "ツール", + "pages": [ + "versions/3-3-x/ja/user-guide/tools/mcp" + ] + }, { "group": "アプリのリリース", "pages": [ "versions/2-8-x/ja/user-guide/application-publishing/permission-management", + "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", { "group": "公開Webアプリとしてのリリース", "pages": [ @@ -4617,250 +5253,32 @@ ] }, "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "version": "3.0.x (Enterprise)", - "languages": [ - { - "language": "zh", - "href": "versions/3-0-x/zh/user-guide/introduction", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/3-0-x/zh/user-guide/introduction", - { - "group": "接入大模型", - "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-0-x/zh/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", - { - "group": "聊天助手", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" - ] - }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", - { - "group": "应用工具箱", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "工作流", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", - { - "group": "节点说明", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/node/start", - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-0-x/zh/user-guide/workflow/node/end", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", - { - "group": "异常处理", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", - { - "group": "预览与调试", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" - ] - }, - { - "group": "知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", - { - "group": "创建知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. 导入文本数据", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "管理知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" - ] - }, - { - "group": "工具", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", - { - "group": "工具配置详情", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" - ] - } - ] - }, - { - "group": "发布", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" + "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", + "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "标注", + "group": "管理", "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" + "versions/legacy/ja/user-guide/management/app-management", + "versions/legacy/ja/user-guide/management/team-members-management", + "versions/legacy/ja/user-guide/management/personal-account-management" ] }, { - "group": "监测", + "group": "監視", "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", + "versions/legacy/ja/user-guide/monitoring/analysis", + "versions/legacy/ja/user-guide/monitoring/logs", + "versions/legacy/ja/user-guide/monitoring/annotation-reply", { - "group": "集成外部与 Ops 工具", + "group": "外部Opsツールの統合", "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" - ] - }, - { - "group": "管理", - "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" + } ] } ] @@ -4868,220 +5286,140 @@ ] }, { - "language": "en", - "default": true, - "href": "versions/3-0-x/en/user-guide/introduction", + "version": "3.6.x (Enterprise)", "groups": [ { - "group": "User Guide", + "group": "ユーザーマニュアル", "pages": [ - "versions/3-0-x/en/user-guide/introduction", + "versions/3-6-x/ja/user-guide/introduction", { - "group": "Model Configuration", + "group": "モデルの接続", "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema" + "versions/legacy/ja/user-guide/models/model-configuration", + "versions/legacy/ja/user-guide/models/new-provider", + "versions/legacy/ja/user-guide/models/predefined-model", + "versions/legacy/ja/user-guide/models/customizable-model", + "versions/legacy/ja/user-guide/models/interfaces", + "versions/legacy/ja/user-guide/models/schema", + "versions/3-5-x/ja/user-guide/model-configuration/manage-model-credential", + "versions/3-5-x/ja/user-guide/model-configuration/load-balancing" ] }, { - "group": "Application Orchestration", + "group": "アプリの構築", "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", + "versions/legacy/ja/user-guide/build-app/chatbot", + "versions/legacy/ja/user-guide/build-app/text-generator", + "versions/legacy/ja/user-guide/build-app/agent", { - "group": "Application Toolkits", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" + "versions/legacy/ja/user-guide/build-app/flow-app/concepts", + "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/ja/user-guide/build-app/flow-app/variables", + { + "group": "ノードの説明", + "pages": [ + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" + ] + }, + "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", + "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" ] } ] }, { - "group": "Workflow", + "group": "アプリのデバッグ", "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", { - "group": "Debug and Preview", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history" + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" ] - }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" + } ] }, { - "group": "Knowledge", + "group": "ツール", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", - { - "group": "Create Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. Import Text Data", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Manage Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" + "versions/3-3-x/ja/user-guide/tools/mcp" ] }, { - "group": "Publishing", + "group": "アプリのリリース", "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", + "versions/2-8-x/ja/user-guide/application-publishing/permission-management", + "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", { - "group": "Publish as a Single-page Web App", + "group": "公開Webアプリとしてのリリース", "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" + "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", + "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "Monitoring", + "group": "管理", "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } + "versions/legacy/ja/user-guide/management/app-management", + "versions/legacy/ja/user-guide/management/team-members-management", + "versions/legacy/ja/user-guide/management/personal-account-management" ] }, { - "group": "Extensions", + "group": "監視", "pages": [ + "versions/legacy/ja/user-guide/monitoring/analysis", + "versions/legacy/ja/user-guide/monitoring/logs", + "versions/legacy/ja/user-guide/monitoring/annotation-reply", { - "group": "API-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" - ] - }, - { - "group": "Code-Based Extension", + "group": "外部Opsツールの統合", "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] } ] - }, - { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] } ] } ] }, { - "language": "ja", - "href": "versions/3-0-x/ja/user-guide/introduction", + "version": "3.5.x (Enterprise)", "groups": [ { "group": "ユーザーマニュアル", "pages": [ - "versions/3-0-x/ja/user-guide/introduction", + "versions/3-5-x/ja/user-guide/introduction", { "group": "モデルの接続", "pages": [ @@ -5091,7 +5429,8 @@ "versions/legacy/ja/user-guide/models/customizable-model", "versions/legacy/ja/user-guide/models/interfaces", "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" + "versions/3-5-x/ja/user-guide/model-configuration/manage-model-credential", + "versions/3-5-x/ja/user-guide/model-configuration/load-balancing" ] }, { @@ -5141,18 +5480,26 @@ { "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" ] } ] }, + { + "group": "ツール", + "pages": [ + "versions/3-3-x/ja/user-guide/tools/mcp" + ] + }, { "group": "アプリのリリース", "pages": [ "versions/2-8-x/ja/user-guide/application-publishing/permission-management", + "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", { "group": "公開Webアプリとしてのリリース", "pages": [ @@ -5193,231 +5540,126 @@ ] } ] - } - ] - }, - { - "version": "2.8.x (Enterprise)", - "languages": [ + }, { - "language": "zh", - "href": "/zh/introduction", + "version": "3.4.x (Enterprise)", "groups": [ { - "group": "用户手册", + "group": "ユーザーマニュアル", "pages": [ - "versions/legacy/zh/user-guide/welcome", + "versions/3-4-x/ja/user-guide/introduction", { - "group": "接入模型", + "group": "モデルの接続", "pages": [ - "versions/legacy/zh/user-guide/models/model-configuration", - "versions/legacy/zh/user-guide/models/new-provider", - "versions/legacy/zh/user-guide/models/predefined-model", - "versions/legacy/zh/user-guide/models/customizable-model", - "versions/legacy/zh/user-guide/models/interfaces", - "versions/legacy/zh/user-guide/models/schema", - "versions/legacy/zh/user-guide/models/load-balancing" + "versions/legacy/ja/user-guide/models/model-configuration", + "versions/legacy/ja/user-guide/models/new-provider", + "versions/legacy/ja/user-guide/models/predefined-model", + "versions/legacy/ja/user-guide/models/customizable-model", + "versions/legacy/ja/user-guide/models/interfaces", + "versions/legacy/ja/user-guide/models/schema", + "versions/legacy/ja/user-guide/models/load-balancing" ] }, { - "group": "构建应用", + "group": "アプリの構築", "pages": [ - "versions/legacy/zh/user-guide/build-app/chatbot", - "versions/legacy/zh/user-guide/build-app/text-generator", - "versions/legacy/zh/user-guide/build-app/agent", + "versions/legacy/ja/user-guide/build-app/chatbot", + "versions/legacy/ja/user-guide/build-app/text-generator", + "versions/legacy/ja/user-guide/build-app/agent", { - "group": "Chatflow & Workflow", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/concepts", - "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/zh/user-guide/build-app/flow-app/variables", + "versions/legacy/ja/user-guide/build-app/flow-app/concepts", + "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/ja/user-guide/build-app/flow-app/variables", { - "group": "节点说明", + "group": "ノードの説明", "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" ] }, - "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", - "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "调试应用", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" + "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", + "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" ] } ] }, { - "group": "发布应用", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", - "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/zh/user-guide/management/app-management", - "versions/legacy/zh/user-guide/management/team-members-management", - "versions/legacy/zh/user-guide/management/personal-account-management" - ] - } - ] - } - ] - }, - { - "language": "en", - "default": true, - "href": "/en/introduction", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/legacy/en/user-guide/welcome", - { - "group": "Model", - "pages": [ - "versions/legacy/en/user-guide/models/model-configuration", - "versions/legacy/en/user-guide/models/new-provider", - "versions/legacy/en/user-guide/models/predefined-model", - "versions/legacy/en/user-guide/models/customizable-model", - "versions/legacy/en/user-guide/models/interfaces", - "versions/legacy/en/user-guide/models/schema", - "versions/legacy/en/user-guide/models/load-balancing" - ] - }, - { - "group": "Application Orchestration", + "group": "アプリのデバッグ", "pages": [ - "versions/legacy/en/user-guide/build-app/chatbot", - "versions/legacy/en/user-guide/build-app/text-generator", - "versions/legacy/en/user-guide/build-app/agent", { - "group": "Chatflow & Workflow", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/concepts", - "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/en/user-guide/build-app/flow-app/variables", - { - "group": "Nodes", - "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", - "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/en/user-guide/build-app/flow-app/file-upload", - "versions/legacy/en/user-guide/build-app/flow-app/additional-features" + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" ] } ] }, { - "group": "Debug and Preview", + "group": "ツール", "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" - ] - } + "versions/3-3-x/ja/user-guide/tools/mcp" ] }, { - "group": "Application Publishing", + "group": "アプリのリリース", "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", + "versions/2-8-x/ja/user-guide/application-publishing/permission-management", + "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", { - "group": "Publish as a Single-page Web App", + "group": "公開Webアプリとしてのリリース", "pages": [ - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/en/user-guide/application-publishing/developing-with-apis", - "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" + "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", + "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "Management", - "pages": [ - "versions/legacy/en/user-guide/management/app-management", - "versions/legacy/en/user-guide/management/team-members-management", - "versions/legacy/en/user-guide/management/personal-account-management" + "group": "管理", + "pages": [ + "versions/legacy/ja/user-guide/management/app-management", + "versions/legacy/ja/user-guide/management/team-members-management", + "versions/legacy/ja/user-guide/management/personal-account-management" ] }, { - "group": "Monitoring", + "group": "監視", "pages": [ - "versions/legacy/en/user-guide/monitoring/analysis", - "versions/legacy/en/user-guide/monitoring/logs", - "versions/legacy/en/user-guide/monitoring/annotation-reply", + "versions/legacy/ja/user-guide/monitoring/analysis", + "versions/legacy/ja/user-guide/monitoring/logs", + "versions/legacy/ja/user-guide/monitoring/annotation-reply", { - "group": "Integrate External Ops Tools", + "group": "外部Opsツールの統合", "pages": [ - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] } ] @@ -5427,13 +5669,12 @@ ] }, { - "language": "ja", - "href": "/ja/introduction", + "version": "3.3.x (Enterprise)", "groups": [ { "group": "ユーザーマニュアル", "pages": [ - "versions/legacy/ja/user-guide/welcome", + "versions/3-3-x/ja/user-guide/introduction", { "group": "モデルの接続", "pages": [ @@ -5493,19 +5734,26 @@ { "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" ] } ] }, + { + "group": "ツール", + "pages": [ + "versions/3-3-x/ja/user-guide/tools/mcp" + ] + }, { "group": "アプリのリリース", "pages": [ "versions/2-8-x/ja/user-guide/application-publishing/permission-management", + "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", { "group": "公開Webアプリとしてのリリース", "pages": [ @@ -5537,239 +5785,128 @@ "group": "外部Opsツールの統合", "pages": [ "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "version": "2.7.x (Enterprise)", - "languages": [ - { - "language": "zh", - "href": "/zh/introduction", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/legacy/zh/user-guide/welcome", - { - "group": "接入模型", - "pages": [ - "versions/legacy/zh/user-guide/models/model-configuration", - "versions/legacy/zh/user-guide/models/new-provider", - "versions/legacy/zh/user-guide/models/predefined-model", - "versions/legacy/zh/user-guide/models/customizable-model", - "versions/legacy/zh/user-guide/models/interfaces", - "versions/legacy/zh/user-guide/models/schema", - "versions/legacy/zh/user-guide/models/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/legacy/zh/user-guide/build-app/chatbot", - "versions/legacy/zh/user-guide/build-app/text-generator", - "versions/legacy/zh/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/concepts", - "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/zh/user-guide/build-app/flow-app/variables", - { - "group": "节点说明", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", - "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "调试应用", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] } ] - }, - { - "group": "发布应用", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", - "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/zh/user-guide/management/app-management", - "versions/legacy/zh/user-guide/management/team-members-management", - "versions/legacy/zh/user-guide/management/personal-account-management" - ] } ] } ] }, { - "language": "en", - "default": true, - "href": "/en/introduction", + "version": "3.2.x (Enterprise)", "groups": [ { "group": "User Guide", "pages": [ - "versions/legacy/en/user-guide/welcome", + "versions/3-2-x/ja/user-guide/introduction", { - "group": "Model", + "group": "モデルの接続", "pages": [ - "versions/legacy/en/user-guide/models/model-configuration", - "versions/legacy/en/user-guide/models/new-provider", - "versions/legacy/en/user-guide/models/predefined-model", - "versions/legacy/en/user-guide/models/customizable-model", - "versions/legacy/en/user-guide/models/interfaces", - "versions/legacy/en/user-guide/models/schema", - "versions/legacy/en/user-guide/models/load-balancing" + "versions/legacy/ja/user-guide/models/model-configuration", + "versions/legacy/ja/user-guide/models/new-provider", + "versions/legacy/ja/user-guide/models/predefined-model", + "versions/legacy/ja/user-guide/models/customizable-model", + "versions/legacy/ja/user-guide/models/interfaces", + "versions/legacy/ja/user-guide/models/schema", + "versions/legacy/ja/user-guide/models/load-balancing" ] }, { - "group": "Application Orchestration", + "group": "アプリの構築", "pages": [ - "versions/legacy/en/user-guide/build-app/chatbot", - "versions/legacy/en/user-guide/build-app/text-generator", - "versions/legacy/en/user-guide/build-app/agent", + "versions/legacy/ja/user-guide/build-app/chatbot", + "versions/legacy/ja/user-guide/build-app/text-generator", + "versions/legacy/ja/user-guide/build-app/agent", { - "group": "Chatflow & Workflow", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/concepts", - "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/en/user-guide/build-app/flow-app/variables", + "versions/legacy/ja/user-guide/build-app/flow-app/concepts", + "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/ja/user-guide/build-app/flow-app/variables", { - "group": "Nodes", + "group": "ノードの説明", "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" ] }, - "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", - "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/en/user-guide/build-app/flow-app/file-upload", - "versions/legacy/en/user-guide/build-app/flow-app/additional-features" + "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", + "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" ] } ] }, { - "group": "Debug and Preview", + "group": "アプリのデバッグ", "pages": [ { - "group": "Chatflow & Workflow", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", + "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", + "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" ] } ] }, { - "group": "Application Publishing", + "group": "アプリのリリース", "pages": [ - "versions/legacy/en/user-guide/application-publishing/permission-management", + "versions/2-8-x/ja/user-guide/application-publishing/permission-management", { - "group": "Publish as a Single-page Web App", + "group": "公開Webアプリとしてのリリース", "pages": [ - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/en/user-guide/application-publishing/developing-with-apis", - "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + ] + }, + "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", + "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "Management", + "group": "管理", "pages": [ - "versions/legacy/en/user-guide/management/app-management", - "versions/legacy/en/user-guide/management/team-members-management", - "versions/legacy/en/user-guide/management/personal-account-management" + "versions/legacy/ja/user-guide/management/app-management", + "versions/legacy/ja/user-guide/management/team-members-management", + "versions/legacy/ja/user-guide/management/personal-account-management" ] }, { - "group": "Monitoring", + "group": "監視", "pages": [ - "versions/legacy/en/user-guide/monitoring/analysis", - "versions/legacy/en/user-guide/monitoring/logs", - "versions/legacy/en/user-guide/monitoring/annotation-reply", + "versions/legacy/ja/user-guide/monitoring/analysis", + "versions/legacy/ja/user-guide/monitoring/logs", + "versions/legacy/ja/user-guide/monitoring/annotation-reply", { - "group": "Integrate External Ops Tools", + "group": "外部Opsツールの統合", "pages": [ - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] } ] @@ -5779,13 +5916,12 @@ ] }, { - "language": "ja", - "href": "/ja/introduction", + "version": "3.0.x (Enterprise)", "groups": [ { "group": "ユーザーマニュアル", "pages": [ - "versions/legacy/ja/user-guide/welcome", + "versions/3-0-x/ja/user-guide/introduction", { "group": "モデルの接続", "pages": [ @@ -5848,7 +5984,6 @@ "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/checklist", "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" ] } @@ -5857,7 +5992,7 @@ { "group": "アプリのリリース", "pages": [ - "versions/legacy/ja/user-guide/application-publishing/permission-management", + "versions/2-8-x/ja/user-guide/application-publishing/permission-management", { "group": "公開Webアプリとしてのリリース", "pages": [ @@ -5878,235 +6013,138 @@ "versions/legacy/ja/user-guide/management/team-members-management", "versions/legacy/ja/user-guide/management/personal-account-management" ] - } - ] - } - ] - } - ] - }, - { - "version": "2.6.x (Enterprise)", - "languages": [ - { - "language": "zh", - "href": "/zh/introduction", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/legacy/zh/user-guide/welcome", - { - "group": "接入模型", - "pages": [ - "versions/legacy/zh/user-guide/models/model-configuration", - "versions/legacy/zh/user-guide/models/new-provider", - "versions/legacy/zh/user-guide/models/predefined-model", - "versions/legacy/zh/user-guide/models/customizable-model", - "versions/legacy/zh/user-guide/models/interfaces", - "versions/legacy/zh/user-guide/models/schema", - "versions/legacy/zh/user-guide/models/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/legacy/zh/user-guide/build-app/chatbot", - "versions/legacy/zh/user-guide/build-app/text-generator", - "versions/legacy/zh/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/concepts", - "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/zh/user-guide/build-app/flow-app/variables", - { - "group": "节点说明", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", - "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" - ] - } - ] }, { - "group": "调试应用", + "group": "監視", "pages": [ + "versions/legacy/ja/user-guide/monitoring/analysis", + "versions/legacy/ja/user-guide/monitoring/logs", + "versions/legacy/ja/user-guide/monitoring/annotation-reply", { - "group": "Chatflow & Workflow", + "group": "外部Opsツールの統合", "pages": [ - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" ] } ] - }, - { - "group": "发布应用", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", - "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/zh/user-guide/management/app-management", - "versions/legacy/zh/user-guide/management/team-members-management", - "versions/legacy/zh/user-guide/management/personal-account-management" - ] } ] } ] }, { - "language": "en", - "default": true, - "href": "/en/introduction", + "version": "2.8.x (Enterprise)", "groups": [ { - "group": "User Guide", + "group": "ユーザーマニュアル", "pages": [ - "versions/legacy/en/user-guide/welcome", + "versions/legacy/ja/user-guide/welcome", { - "group": "Model", + "group": "モデルの接続", "pages": [ - "versions/legacy/en/user-guide/models/model-configuration", - "versions/legacy/en/user-guide/models/new-provider", - "versions/legacy/en/user-guide/models/predefined-model", - "versions/legacy/en/user-guide/models/customizable-model", - "versions/legacy/en/user-guide/models/interfaces", - "versions/legacy/en/user-guide/models/schema", - "versions/legacy/en/user-guide/models/load-balancing" + "versions/legacy/ja/user-guide/models/model-configuration", + "versions/legacy/ja/user-guide/models/new-provider", + "versions/legacy/ja/user-guide/models/predefined-model", + "versions/legacy/ja/user-guide/models/customizable-model", + "versions/legacy/ja/user-guide/models/interfaces", + "versions/legacy/ja/user-guide/models/schema", + "versions/legacy/ja/user-guide/models/load-balancing" ] }, { - "group": "Application Orchestration", + "group": "アプリの構築", "pages": [ - "versions/legacy/en/user-guide/build-app/chatbot", - "versions/legacy/en/user-guide/build-app/text-generator", - "versions/legacy/en/user-guide/build-app/agent", + "versions/legacy/ja/user-guide/build-app/chatbot", + "versions/legacy/ja/user-guide/build-app/text-generator", + "versions/legacy/ja/user-guide/build-app/agent", { - "group": "Chatflow & Workflow", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/concepts", - "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/en/user-guide/build-app/flow-app/variables", + "versions/legacy/ja/user-guide/build-app/flow-app/concepts", + "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/ja/user-guide/build-app/flow-app/variables", { - "group": "Nodes", + "group": "ノードの説明", "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" ] }, - "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", - "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/en/user-guide/build-app/flow-app/file-upload", - "versions/legacy/en/user-guide/build-app/flow-app/additional-features" + "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", + "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" ] } ] }, { - "group": "Debug and Preview", + "group": "アプリのデバッグ", "pages": [ { - "group": "Chatflow & Workflow", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" ] } ] }, { - "group": "Application Publishing", + "group": "アプリのリリース", "pages": [ - "versions/legacy/en/user-guide/application-publishing/permission-management", + "versions/2-8-x/ja/user-guide/application-publishing/permission-management", { - "group": "Publish as a Single-page Web App", + "group": "公開Webアプリとしてのリリース", "pages": [ - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/en/user-guide/application-publishing/developing-with-apis", - "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" + "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", + "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "Management", - "pages": [ - "versions/legacy/en/user-guide/management/app-management", - "versions/legacy/en/user-guide/management/team-members-management", - "versions/legacy/en/user-guide/management/personal-account-management" + "group": "管理", + "pages": [ + "versions/legacy/ja/user-guide/management/app-management", + "versions/legacy/ja/user-guide/management/team-members-management", + "versions/legacy/ja/user-guide/management/personal-account-management" ] }, { - "group": "Monitoring", + "group": "監視", "pages": [ - "versions/legacy/en/user-guide/monitoring/analysis", - "versions/legacy/en/user-guide/monitoring/logs", - "versions/legacy/en/user-guide/monitoring/annotation-reply", + "versions/legacy/ja/user-guide/monitoring/analysis", + "versions/legacy/ja/user-guide/monitoring/logs", + "versions/legacy/ja/user-guide/monitoring/annotation-reply", { - "group": "Integrate External Ops Tools", + "group": "外部Opsツールの統合", "pages": [ - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", + "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" ] } ] @@ -6116,8 +6154,7 @@ ] }, { - "language": "ja", - "href": "/ja/introduction", + "version": "2.7.x (Enterprise)", "groups": [ { "group": "ユーザーマニュアル", @@ -6219,231 +6256,105 @@ ] } ] - } - ] - }, - { - "version": "2.5.x (Enterprise)", - "languages": [ - { - "language": "zh", - "href": "/zh/introduction", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/legacy/zh/user-guide/welcome", - { - "group": "接入模型", - "pages": [ - "versions/legacy/zh/user-guide/models/model-configuration", - "versions/legacy/zh/user-guide/models/new-provider", - "versions/legacy/zh/user-guide/models/predefined-model", - "versions/legacy/zh/user-guide/models/customizable-model", - "versions/legacy/zh/user-guide/models/interfaces", - "versions/legacy/zh/user-guide/models/schema", - "versions/legacy/zh/user-guide/models/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/legacy/zh/user-guide/build-app/chatbot", - "versions/legacy/zh/user-guide/build-app/text-generator", - "versions/legacy/zh/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/concepts", - "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/zh/user-guide/build-app/flow-app/variables", - { - "group": "节点说明", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", - "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "调试应用", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] - }, - { - "group": "发布应用", - "pages": [ - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", - "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/zh/user-guide/management/app-management", - "versions/legacy/zh/user-guide/management/team-members-management", - "versions/legacy/zh/user-guide/management/personal-account-management" - ] - } - ] - } - ] }, { - "language": "en", - "default": true, - "href": "/en/introduction", + "version": "2.6.x (Enterprise)", "groups": [ { - "group": "User Guide", + "group": "ユーザーマニュアル", "pages": [ - "versions/legacy/en/user-guide/welcome", + "versions/legacy/ja/user-guide/welcome", { - "group": "Model", + "group": "モデルの接続", "pages": [ - "versions/legacy/en/user-guide/models/model-configuration", - "versions/legacy/en/user-guide/models/new-provider", - "versions/legacy/en/user-guide/models/predefined-model", - "versions/legacy/en/user-guide/models/customizable-model", - "versions/legacy/en/user-guide/models/interfaces", - "versions/legacy/en/user-guide/models/schema", - "versions/legacy/en/user-guide/models/load-balancing" + "versions/legacy/ja/user-guide/models/model-configuration", + "versions/legacy/ja/user-guide/models/new-provider", + "versions/legacy/ja/user-guide/models/predefined-model", + "versions/legacy/ja/user-guide/models/customizable-model", + "versions/legacy/ja/user-guide/models/interfaces", + "versions/legacy/ja/user-guide/models/schema", + "versions/legacy/ja/user-guide/models/load-balancing" ] }, { - "group": "Application Orchestration", + "group": "アプリの構築", "pages": [ - "versions/legacy/en/user-guide/build-app/chatbot", - "versions/legacy/en/user-guide/build-app/text-generator", - "versions/legacy/en/user-guide/build-app/agent", + "versions/legacy/ja/user-guide/build-app/chatbot", + "versions/legacy/ja/user-guide/build-app/text-generator", + "versions/legacy/ja/user-guide/build-app/agent", { - "group": "Chatflow & Workflow", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/concepts", - "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/en/user-guide/build-app/flow-app/variables", + "versions/legacy/ja/user-guide/build-app/flow-app/concepts", + "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", + "versions/legacy/ja/user-guide/build-app/flow-app/variables", { - "group": "Nodes", + "group": "ノードの説明", "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", + "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" ] }, - "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", - "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/en/user-guide/build-app/flow-app/file-upload", - "versions/legacy/en/user-guide/build-app/flow-app/additional-features" + "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", + "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", + "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" ] } ] }, { - "group": "Debug and Preview", + "group": "アプリのデバッグ", "pages": [ { - "group": "Chatflow & Workflow", + "group": "チャットフロー & ワークフロー", "pages": [ - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/checklist", + "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" ] } ] }, { - "group": "Application Publishing", + "group": "アプリのリリース", "pages": [ + "versions/legacy/ja/user-guide/application-publishing/permission-management", { - "group": "Publish as a Single-page Web App", + "group": "公開Webアプリとしてのリリース", "pages": [ - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", + "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" ] }, - "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/en/user-guide/application-publishing/developing-with-apis", - "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Management", - "pages": [ - "versions/legacy/en/user-guide/management/app-management", - "versions/legacy/en/user-guide/management/team-members-management", - "versions/legacy/en/user-guide/management/personal-account-management" + "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", + "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", + "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" ] }, { - "group": "Monitoring", + "group": "管理", "pages": [ - "versions/legacy/en/user-guide/monitoring/analysis", - "versions/legacy/en/user-guide/monitoring/logs", - "versions/legacy/en/user-guide/monitoring/annotation-reply", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" - ] - } + "versions/legacy/ja/user-guide/management/app-management", + "versions/legacy/ja/user-guide/management/team-members-management", + "versions/legacy/ja/user-guide/management/personal-account-management" ] } ] @@ -6451,8 +6362,7 @@ ] }, { - "language": "ja", - "href": "/ja/introduction", + "version": "2.5.x (Enterprise)", "groups": [ { "group": "ユーザーマニュアル", From b3cff5facdf017a08794b899ab3d8c34b61e1614 Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Mon, 9 Mar 2026 18:26:54 +0800 Subject: [PATCH 04/10] fix: align zh/ja API spec operationIds with en for language switching Mintlify generates page URL slugs from operationId. When operationIds differ between languages (e.g., en: sendChatMessage vs zh: sendBasicChatMessageCn), the language switcher can't find the equivalent page and falls back to the introduction page. This aligns all zh/ja operationIds to match en for endpoints that share the same HTTP method and path. Co-Authored-By: Claude Opus 4.6 --- ja/api-reference/openapi_chat.json | 2632 +++++++++++++++++-- ja/api-reference/openapi_chatflow.json | 2709 +++++++++++++++++-- ja/api-reference/openapi_completion.json | 1508 ++++++++++- ja/api-reference/openapi_workflow.json | 1748 +++++++++++-- zh/api-reference/openapi_chat.json | 2445 +++++++++++++++-- zh/api-reference/openapi_chatflow.json | 3043 +++++++++++++++++++--- zh/api-reference/openapi_completion.json | 1748 +++++++++++-- zh/api-reference/openapi_workflow.json | 1730 ++++++++++-- 8 files changed, 15719 insertions(+), 1844 deletions(-) diff --git a/ja/api-reference/openapi_chat.json b/ja/api-reference/openapi_chat.json index ee41edfa1..96db6870b 100644 --- a/ja/api-reference/openapi_chat.json +++ b/ja/api-reference/openapi_chat.json @@ -27,8 +27,10 @@ "post": { "summary": "チャットメッセージを送信", "description": "チャットアプリケーションにリクエストを送信します。", - "operationId": "sendBasicChatMessageJa", - "tags": ["チャットメッセージ"], + "operationId": "sendChatMessage", + "tags": [ + "チャットメッセージ" + ], "requestBody": { "description": "チャットメッセージ送信リクエストボディ。", "required": true, @@ -78,9 +80,15 @@ } } }, - "400": { "$ref": "#/components/responses/BadRequestGenericJa" }, - "404": { "$ref": "#/components/responses/ConversationNotFoundJa" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJa" } + "400": { + "$ref": "#/components/responses/BadRequestGenericJa" + }, + "404": { + "$ref": "#/components/responses/ConversationNotFoundJa" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJa" + } } } }, @@ -88,8 +96,10 @@ "post": { "summary": "ファイルアップロード", "description": "メッセージ送信時に使用するためのファイルをアップロードします（現在は画像のみサポート）。画像とテキストのマルチモーダル理解を可能にします。png、jpg、jpeg、webp、gif形式をサポートしています。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", - "operationId": "uploadBasicChatFileJa", - "tags": ["ファイル操作"], + "operationId": "uploadChatFile", + "tags": [ + "ファイル操作" + ], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data`リクエストが必要です。", "required": true, @@ -97,23 +107,61 @@ "multipart/form-data": { "schema": { "type": "object", - "required": ["file", "user"], + "required": [ + "file", + "user" + ], "properties": { - "file": { "type": "string", "format": "binary", "description": "アップロードするファイル。" }, - "user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } + "file": { + "type": "string", + "format": "binary", + "description": "アップロードするファイル。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" + } } } } } }, "responses": { - "200": { "description": "ファイルアップロード成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJa" } } } }, - "201": { "description": "ファイル作成成功（代替成功コード）。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJa" } } } }, - "400": { "$ref": "#/components/responses/BadRequestFileJa" }, - "413": { "$ref": "#/components/responses/FileTooLargeJa" }, - "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileJa" }, - "503": { "$ref": "#/components/responses/S3ErrorFileJa" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJa" } + "200": { + "description": "ファイルアップロード成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseJa" + } + } + } + }, + "201": { + "description": "ファイル作成成功（代替成功コード）。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseJa" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequestFileJa" + }, + "413": { + "$ref": "#/components/responses/FileTooLargeJa" + }, + "415": { + "$ref": "#/components/responses/UnsupportedFileTypeFileJa" + }, + "503": { + "$ref": "#/components/responses/S3ErrorFileJa" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJa" + } } } }, @@ -121,15 +169,20 @@ "get": { "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", - "operationId": "getEndUserChatJa", - "tags": ["エンドユーザー"], + "operationId": "getEndUserChat", + "tags": [ + "エンドユーザー" + ], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "エンドユーザーID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -137,12 +190,18 @@ "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/EndUserDetailJa" } + "schema": { + "$ref": "#/components/schemas/EndUserDetailJa" + } } } }, - "404": { "$ref": "#/components/responses/EndUserNotFoundJa" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJa" } + "404": { + "$ref": "#/components/responses/EndUserNotFoundJa" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJa" + } } } }, @@ -150,8 +209,10 @@ "get": { "summary": "ファイルプレビュー", "description": "アップロードされたファイルのプレビューまたはダウンロード。このエンドポイントは、ファイルアップロードAPIを通じて事前にアップロードされたファイルにアクセスすることができます。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセス可能です。", - "operationId": "previewBasicChatFileJa", - "tags": ["ファイル操作"], + "operationId": "previewChatFile", + "tags": [ + "ファイル操作" + ], "parameters": [ { "name": "file_id", @@ -248,7 +309,9 @@ "description": "不正なリクエスト。可能なエラーコード:\n- `invalid_param`: 異常なパラメータ入力。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } } } }, @@ -256,7 +319,9 @@ "description": "禁止。可能なエラーコード:\n- `file_access_denied`: ファイルアクセス拒否またはファイルが現在のアプリケーションに属していません。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } } } }, @@ -264,7 +329,9 @@ "description": "見つかりません。可能なエラーコード:\n- `file_not_found`: ファイルが見つからないか削除されています。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } } } }, @@ -272,7 +339,9 @@ "description": "内部サーバーエラー。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } } } } @@ -283,354 +352,2373 @@ "post": { "summary": "生成停止", "description": "チャットメッセージの生成を停止します。ストリーミングモードでのみサポートされています。", - "operationId": "stopBasicChatMessageGenerationJa", - "tags": ["チャットメッセージ"], - "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "タスクID、ストリーミングチャンクの返り値から取得できます。", "schema": { "type": "string", "format": "uuid" } } ], - "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } } } } } }, - "responses": { "200": { "$ref": "#/components/responses/SuccessResultJa" } } + "operationId": "stopChatMessageGeneration", + "tags": [ + "チャットメッセージ" + ], + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "description": "タスクID、ストリーミングチャンクの返り値から取得できます。", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "user": { + "type": "string", + "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/SuccessResultJa" + } + } } }, "/messages/{message_id}/feedbacks": { "post": { "summary": "メッセージフィードバック", "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。", - "operationId": "postBasicChatMessageFeedbackJa", - "tags": ["メッセージフィードバック"], - "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", "schema": { "type": "string", "format": "uuid" } } ], - "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestJa" } } } }, - "responses": { "200": { "$ref": "#/components/responses/SuccessResultJa" } } + "operationId": "postChatMessageFeedback", + "tags": [ + "メッセージフィードバック" + ], + "parameters": [ + { + "name": "message_id", + "in": "path", + "required": true, + "description": "メッセージID。", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MessageFeedbackRequestJa" + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/SuccessResultJa" + } + } } }, "/app/feedbacks": { "get": { "summary": "アプリのメッセージの「いいね」とフィードバックを取得", "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", - "operationId": "getBasicChatAppFeedbacksJa", - "tags": ["メッセージフィードバック"], - "parameters": [ { "$ref": "#/components/parameters/PageQueryParamJa" }, { "$ref": "#/components/parameters/LimitQueryParamJa" } ], - "responses": { "200": { "description": "アプリのフィードバックリストを正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseJa" } } } } } + "operationId": "getChatAppFeedbacks", + "tags": [ + "メッセージフィードバック" + ], + "parameters": [ + { + "$ref": "#/components/parameters/PageQueryParamJa" + }, + { + "$ref": "#/components/parameters/LimitQueryParamJa" + } + ], + "responses": { + "200": { + "description": "アプリのフィードバックリストを正常に取得しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFeedbacksResponseJa" + } + } + } + } + } } }, "/messages/{message_id}/suggested": { "get": { "summary": "次の推奨質問", "description": "現在のメッセージに対する次の質問の提案を取得します。", - "operationId": "getBasicChatSuggestedQuestionsJa", - "tags": ["チャットメッセージ"], - "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/UserQueryParamJa" } ], - "responses": { "200": { "description": "推奨質問リストを正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestedQuestionsResponseJa" } } } } } + "operationId": "getSuggestedQuestions", + "tags": [ + "チャットメッセージ" + ], + "parameters": [ + { + "name": "message_id", + "in": "path", + "required": true, + "description": "メッセージID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + { + "$ref": "#/components/parameters/UserQueryParamJa" + } + ], + "responses": { + "200": { + "description": "推奨質問リストを正常に取得しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SuggestedQuestionsResponseJa" + } + } + } + } + } } }, "/messages": { "get": { "summary": "会話履歴メッセージを取得", "description": "スクロールロード形式で過去のチャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", - "operationId": "getBasicChatConversationHistoryJa", - "tags": ["会話管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdQueryParamJa" }, { "$ref": "#/components/parameters/UserQueryParamJa" }, { "name": "first_id", "in": "query", "description": "現在のページの最初のチャット記録のID、デフォルトはnullです。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, { "$ref": "#/components/parameters/LimitQueryParamDefault20Ja" } ], - "responses": { "200": { "description": "会話履歴メッセージを正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasicConversationHistoryResponseJa" } } } } } + "operationId": "getConversationHistory", + "tags": [ + "会話管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdQueryParamJa" + }, + { + "$ref": "#/components/parameters/UserQueryParamJa" + }, + { + "name": "first_id", + "in": "query", + "description": "現在のページの最初のチャット記録のID、デフォルトはnullです。", + "schema": { + "type": "string", + "format": "uuid", + "nullable": true + } + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Ja" + } + ], + "responses": { + "200": { + "description": "会話履歴メッセージを正常に取得しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BasicConversationHistoryResponseJa" + } + } + } + } + } } }, "/conversations": { "get": { "summary": "会話を取得", "description": "現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。", - "operationId": "getBasicChatConversationsListJa", - "tags": ["会話管理"], - "parameters": [ { "$ref": "#/components/parameters/UserQueryParamJa" }, { "$ref": "#/components/parameters/LastIdQueryParamJa" }, { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Ja" }, { "$ref": "#/components/parameters/SortByQueryParamJa" } ], - "responses": { "200": { "description": "会話リストを正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationsListResponseJa" } } } } } + "operationId": "getConversationsList", + "tags": [ + "会話管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/UserQueryParamJa" + }, + { + "$ref": "#/components/parameters/LastIdQueryParamJa" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Ja" + }, + { + "$ref": "#/components/parameters/SortByQueryParamJa" + } + ], + "responses": { + "200": { + "description": "会話リストを正常に取得しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationsListResponseJa" + } + } + } + } + } } }, "/conversations/{conversation_id}": { "delete": { "summary": "会話を削除", "description": "指定された会話を削除します。", - "operationId": "deleteBasicChatConversationJa", - "tags": ["会話管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJa" } ], - "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } } } } } }, - "responses": { "204": { "description": "会話の削除に成功しました。コンテンツはありません。" } } + "operationId": "deleteConversation", + "tags": [ + "会話管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdPathParamJa" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "user": { + "type": "string", + "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "会話の削除に成功しました。コンテンツはありません。" + } + } } }, "/conversations/{conversation_id}/name": { "post": { "summary": "会話の名前を変更", "description": "セッションの名前を変更します。セッション名は、複数のセッションをサポートするクライアントでの表示に使用されます。", - "operationId": "renameBasicChatConversationJa", - "tags": ["会話管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJa" } ], - "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameRequestJa" } } } }, - "responses": { "200": { "description": "会話の名前変更に成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameResponseJa" } } } } } + "operationId": "renameConversation", + "tags": [ + "会話管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdPathParamJa" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationRenameRequestJa" + } + } + } + }, + "responses": { + "200": { + "description": "会話の名前変更に成功しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationRenameResponseJa" + } + } + } + } + } } }, - "/conversations/{conversation_id}/variables": { + "/conversations/{conversation_id}/variables": { "get": { "summary": "会話変数の取得", "description": "特定の会話から変数を取得します。このエンドポイントは、会話中に取得された構造化データを抽出するのに役立ちます。", - "operationId": "getBasicChatConversationVariablesJa", - "tags": ["会話管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJa" }, { "$ref": "#/components/parameters/UserQueryParamJa" }, { "$ref": "#/components/parameters/LastIdQueryParamJa" }, { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Ja" }, { "$ref": "#/components/parameters/VariableNameQueryParamJa" } ], - "responses": { "200": { "description": "会話変数を正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationVariablesResponseJa" } } } }, "404": { "$ref": "#/components/responses/ConversationNotFoundJa" } } - } - }, - "/audio-to-text": { - "post": { - "summary": "音声からテキストへ", - "description": "オーディオファイルをテキストに変換します。サポートされている形式：mp3, mp4, mpeg, mpga, m4a, wav, webm。ファイルサイズ制限：15MB。", - "operationId": "basicChatAudioToTextJa", - "tags": ["音声とテキスト変換"], - "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioToTextRequestJa" } } } }, - "responses": { "200": { "description": "音声からテキストへの変換に成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioToTextResponseJa" } } } } } - } - }, - "/text-to-audio": { - "post": { - "summary": "テキストから音声へ", - "description": "テキストコンテンツを音声に変換します。", - "operationId": "basicChatTextToAudioJa", - "tags": ["音声とテキスト変換"], - "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TextToAudioFormRequestJa" } } } }, - "responses": { "200": { "description": "音声ファイルの生成に成功しました。", "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } } } - } - }, - "/info": { - "get": { - "summary": "アプリケーションの基本情報を取得", - "operationId": "getBasicChatAppInfoJa", - "tags": ["アプリケーション設定"], - "responses": { "200": { "description": "アプリケーションの基本情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseJa" } } } } } - } - }, - "/parameters": { - "get": { - "summary": "アプリケーションのパラメータ情報を取得", + "operationId": "getConversationVariables", + "tags": [ + "会話管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdPathParamJa" + }, + { + "$ref": "#/components/parameters/UserQueryParamJa" + }, + { + "$ref": "#/components/parameters/LastIdQueryParamJa" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Ja" + }, + { + "$ref": "#/components/parameters/VariableNameQueryParamJa" + } + ], + "responses": { + "200": { + "description": "会話変数を正常に取得しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationVariablesResponseJa" + } + } + } + }, + "404": { + "$ref": "#/components/responses/ConversationNotFoundJa" + } + } + } + }, + "/audio-to-text": { + "post": { + "summary": "音声からテキストへ", + "description": "オーディオファイルをテキストに変換します。サポートされている形式：mp3, mp4, mpeg, mpga, m4a, wav, webm。ファイルサイズ制限：15MB。", + "operationId": "audioToText", + "tags": [ + "音声とテキスト変換" + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/AudioToTextRequestJa" + } + } + } + }, + "responses": { + "200": { + "description": "音声からテキストへの変換に成功しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AudioToTextResponseJa" + } + } + } + } + } + } + }, + "/text-to-audio": { + "post": { + "summary": "テキストから音声へ", + "description": "テキストコンテンツを音声に変換します。", + "operationId": "textToAudioChat", + "tags": [ + "音声とテキスト変換" + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/TextToAudioFormRequestJa" + } + } + } + }, + "responses": { + "200": { + "description": "音声ファイルの生成に成功しました。", + "content": { + "audio/wav": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "audio/mp3": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "Content-Type": { + "schema": { + "type": "string", + "example": "audio/wav" + } + } + } + } + } + } + }, + "/info": { + "get": { + "summary": "アプリケーションの基本情報を取得", + "operationId": "getChatAppInfo", + "tags": [ + "アプリケーション設定" + ], + "responses": { + "200": { + "description": "アプリケーションの基本情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInfoResponseJa" + } + } + } + } + } + } + }, + "/parameters": { + "get": { + "summary": "アプリケーションのパラメータ情報を取得", "description": "ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。", - "operationId": "getBasicChatAppParametersJa", - "tags": ["アプリケーション設定"], - "responses": { "200": { "description": "アプリケーションのパラメータ情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasicChatAppParametersResponseJa" } } } } } + "operationId": "getChatAppParameters", + "tags": [ + "アプリケーション設定" + ], + "responses": { + "200": { + "description": "アプリケーションのパラメータ情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BasicChatAppParametersResponseJa" + } + } + } + } + } } }, "/meta": { "get": { "summary": "アプリケーションのメタ情報を取得", "description": "このアプリケーションのツールのアイコンを取得するために使用されます。", - "operationId": "getBasicChatAppMetaJa", - "tags": ["アプリケーション設定"], - "responses": { "200": { "description": "アプリケーションのメタ情報を正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMetaResponseJa" } } } } } + "operationId": "getChatAppMeta", + "tags": [ + "アプリケーション設定" + ], + "responses": { + "200": { + "description": "アプリケーションのメタ情報を正常に取得しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppMetaResponseJa" + } + } + } + } + } } }, "/site": { "get": { "summary": "アプリのWebApp設定を取得", "description": "アプリのWebApp設定を取得するために使用します。", - "operationId": "getBasicChatWebAppSettingsJa", - "tags": ["アプリケーション設定"], - "responses": { "200": { "description": "WebApp設定。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseJa" } } } } } + "operationId": "getChatWebAppSettings", + "tags": [ + "アプリケーション設定" + ], + "responses": { + "200": { + "description": "WebApp設定。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebAppSettingsResponseJa" + } + } + } + } + } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "APIキー認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください。形式：Bearer {API_KEY}。APIキーの漏洩を防ぐため、APIキーはクライアント側で共有または保存せず、サーバー側で保存することを強くお勧めします。" } + "ApiKeyAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "API_KEY", + "description": "APIキー認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください。形式：Bearer {API_KEY}。APIキーの漏洩を防ぐため、APIキーはクライアント側で共有または保存せず、サーバー側で保存することを強くお勧めします。" + } }, "parameters": { - "PageQueryParamJa": { "name": "page", "in": "query", "description": "（任意）ページ番号。デフォルト値：1。", "schema": { "type": "integer", "default": 1 } }, - "LimitQueryParamJa": { "name": "limit", "in": "query", "description": "（任意）1ページあたりの件数。デフォルト値：20。", "schema": { "type": "integer", "default": 20 } }, - "LimitQueryParamDefault20Ja": { "name": "limit", "in": "query", "description": "1回のリクエストで返すレコードの数、デフォルトは20です。", "schema": { "type": "integer", "default": 20 } }, - "LimitQueryParamDefault20Max100Ja": { "name": "limit", "in": "query", "description": "1回のリクエストで返すレコードの数、デフォルトは20件です。最大100、最小1。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, - "UserQueryParamJa": { "name": "user", "in": "query", "required": true, "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義される必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", "schema": { "type": "string" } }, - "ConversationIdQueryParamJa": { "name": "conversation_id", "in": "query", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } }, - "LastIdQueryParamJa": { "name": "last_id", "in": "query", "description": "(Optional)現在のページの最後のレコードのID、デフォルトはnullです。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, - "SortByQueryParamJa": { "name": "sort_by", "in": "query", "description": "(Optional)ソートフィールド、デフォルト：-updated_at（更新時間で降順にソート）。利用可能な値：created_at, -created_at, updated_at, -updated_at。フィールドの前の記号「-」は逆順を表します。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } }, - "ConversationIdPathParamJa": { "name": "conversation_id", "in": "path", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } }, - "VariableNameQueryParamJa": { "name": "variable_name", "in": "query", "description": "(Optional)変数名でフィルタリングします。", "schema": { "type": "string" } } + "PageQueryParamJa": { + "name": "page", + "in": "query", + "description": "（任意）ページ番号。デフォルト値：1。", + "schema": { + "type": "integer", + "default": 1 + } + }, + "LimitQueryParamJa": { + "name": "limit", + "in": "query", + "description": "（任意）1ページあたりの件数。デフォルト値：20。", + "schema": { + "type": "integer", + "default": 20 + } + }, + "LimitQueryParamDefault20Ja": { + "name": "limit", + "in": "query", + "description": "1回のリクエストで返すレコードの数、デフォルトは20です。", + "schema": { + "type": "integer", + "default": 20 + } + }, + "LimitQueryParamDefault20Max100Ja": { + "name": "limit", + "in": "query", + "description": "1回のリクエストで返すレコードの数、デフォルトは20件です。最大100、最小1。", + "schema": { + "type": "integer", + "default": 20, + "minimum": 1, + "maximum": 100 + } + }, + "UserQueryParamJa": { + "name": "user", + "in": "query", + "required": true, + "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義される必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", + "schema": { + "type": "string" + } + }, + "ConversationIdQueryParamJa": { + "name": "conversation_id", + "in": "query", + "required": true, + "description": "会話ID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + "LastIdQueryParamJa": { + "name": "last_id", + "in": "query", + "description": "(Optional)現在のページの最後のレコードのID、デフォルトはnullです。", + "schema": { + "type": "string", + "format": "uuid", + "nullable": true + } + }, + "SortByQueryParamJa": { + "name": "sort_by", + "in": "query", + "description": "(Optional)ソートフィールド、デフォルト：-updated_at（更新時間で降順にソート）。利用可能な値：created_at, -created_at, updated_at, -updated_at。フィールドの前の記号「-」は逆順を表します。", + "schema": { + "type": "string", + "enum": [ + "created_at", + "-created_at", + "updated_at", + "-updated_at" + ], + "default": "-updated_at" + } + }, + "ConversationIdPathParamJa": { + "name": "conversation_id", + "in": "path", + "required": true, + "description": "会話ID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + "VariableNameQueryParamJa": { + "name": "variable_name", + "in": "query", + "description": "(Optional)変数名でフィルタリングします。", + "schema": { + "type": "string" + } + } }, "responses": { - "BadRequestGenericJa": { "description": "リクエストパラメータエラー。考えられる原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, - "BadRequestFileJa": { "description": "ファイル操作リクエストエラー。考えられる原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, - "FileTooLargeJa": { "description": "ファイルが大きすぎます (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, - "UnsupportedFileTypeFileJa": { "description": "サポートされていないファイルタイプ (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, - "S3ErrorFileJa": { "description": "S3ストレージサービスエラー。考えられる原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, - "InternalServerErrorJa": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, - "SuccessResultJa": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, - "ConversationNotFoundJa": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, - "EndUserNotFoundJa": { "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } } + "BadRequestGenericJa": { + "description": "リクエストパラメータエラー。考えられる原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } + } + } + }, + "BadRequestFileJa": { + "description": "ファイル操作リクエストエラー。考えられる原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } + } + } + }, + "FileTooLargeJa": { + "description": "ファイルが大きすぎます (file_too_large)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } + } + } + }, + "UnsupportedFileTypeFileJa": { + "description": "サポートされていないファイルタイプ (unsupported_file_type)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } + } + } + }, + "S3ErrorFileJa": { + "description": "S3ストレージサービスエラー。考えられる原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } + } + } + }, + "InternalServerErrorJa": { + "description": "内部サーバーエラー。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } + } + } + }, + "SuccessResultJa": { + "description": "操作成功。", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + } + } + } + } + } + }, + "ConversationNotFoundJa": { + "description": "会話が存在しません。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } + } + } + }, + "EndUserNotFoundJa": { + "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJa" + } + } + } + } }, "schemas": { "BasicChatRequestJa": { - "type": "object", "required": ["query", "user"], + "type": "object", + "required": [ + "query", + "user" + ], "properties": { - "query": { "type": "string", "description": "ユーザー入力/質問内容。" }, - "inputs": { "type": "object", "description": "アプリで定義されたさまざまな変数値の入力を許可します。デフォルトは`{}`。", "additionalProperties": true, "default": {} }, - "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "応答の返却モード。streaming（推奨）はSSEベース。blockingは実行完了後に結果を返します（Cloudflareの100秒タイムアウト制限あり；エージェントアシスタントモードではサポートされていません）。" }, - "user": { "type": "string", "description": "ユーザー識別子、アプリケーション内で一意である必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID、以前のチャット記録に基づいて会話を続けるには、前のメッセージのconversation_idを渡す必要があります。" }, - "files": { "type": "array", "items": { "$ref": "#/components/schemas/BasicInputFileObjectJa" }, "description": "アップロードされたファイルリスト。現在は画像タイプのみサポート。" }, - "auto_generate_name": { "type": "boolean", "default": true, "description": "タイトルを自動生成します。デフォルトは`true`です。" } + "query": { + "type": "string", + "description": "ユーザー入力/質問内容。" + }, + "inputs": { + "type": "object", + "description": "アプリで定義されたさまざまな変数値の入力を許可します。デフォルトは`{}`。", + "additionalProperties": true, + "default": {} + }, + "response_mode": { + "type": "string", + "enum": [ + "streaming", + "blocking" + ], + "default": "streaming", + "description": "応答の返却モード。streaming（推奨）はSSEベース。blockingは実行完了後に結果を返します（Cloudflareの100秒タイムアウト制限あり；エージェントアシスタントモードではサポートされていません）。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子、アプリケーション内で一意である必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID、以前のチャット記録に基づいて会話を続けるには、前のメッセージのconversation_idを渡す必要があります。" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BasicInputFileObjectJa" + }, + "description": "アップロードされたファイルリスト。現在は画像タイプのみサポート。" + }, + "auto_generate_name": { + "type": "boolean", + "default": true, + "description": "タイトルを自動生成します。デフォルトは`true`です。" + } } }, "BasicInputFileObjectJa": { - "type": "object", "required": ["type", "transfer_method"], + "type": "object", + "required": [ + "type", + "transfer_method" + ], "properties": { - "type": { "type": "string", "enum": ["image"], "description": "サポートされているタイプ：`image`（現在は画像タイプのみサポート）。" }, - "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" }, - "url": { "type": "string", "format": "url", "description": "画像URL（転送方法が remote_url の場合）" }, - "upload_file_id": { "type": "string", "format":"uuid", "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" } + "type": { + "type": "string", + "enum": [ + "image" + ], + "description": "サポートされているタイプ：`image`（現在は画像タイプのみサポート）。" + }, + "transfer_method": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ], + "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" + }, + "url": { + "type": "string", + "format": "url", + "description": "画像URL（転送方法が remote_url の場合）" + }, + "upload_file_id": { + "type": "string", + "format": "uuid", + "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" + } }, "anyOf": [ { - "properties": { - "transfer_method": { "enum": ["remote_url"] }, - "url": { "type": "string", "format": "url" } + "properties": { + "transfer_method": { + "enum": [ + "remote_url" + ] + }, + "url": { + "type": "string", + "format": "url" + } }, - "required": ["url"], - "not": { "required": ["upload_file_id"] } + "required": [ + "url" + ], + "not": { + "required": [ + "upload_file_id" + ] + } }, { - "properties": { - "transfer_method": { "enum": ["local_file"] }, - "upload_file_id": { "type": "string", "format":"uuid" } + "properties": { + "transfer_method": { + "enum": [ + "local_file" + ] + }, + "upload_file_id": { + "type": "string", + "format": "uuid" + } }, - "required": ["upload_file_id"], - "not": { "required": ["url"] } + "required": [ + "upload_file_id" + ], + "not": { + "required": [ + "url" + ] + } } ] }, "ChatCompletionResponseJa": { - "type": "object", "description": "ブロッキングモードでの完全なアプリ結果。", + "type": "object", + "description": "ブロッキングモードでの完全なアプリ結果。", "properties": { - "event": { "type": "string", "example": "message", "description": "イベントタイプ、固定で `message`。" }, - "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, - "id": { "type": "string", "format": "uuid", "description": "ユニークID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, - "mode": { "type": "string", "example": "chat", "description": "アプリモード、`chat`として固定。" }, - "answer": { "type": "string", "description": "完全な応答内容。" }, - "metadata": { "$ref": "#/components/schemas/ResponseMetadataJa" }, - "created_at": { "type": "integer", "format": "int64", "description": "メッセージ作成タイムスタンプ。" } + "event": { + "type": "string", + "example": "message", + "description": "イベントタイプ、固定で `message`。" + }, + "task_id": { + "type": "string", + "format": "uuid", + "description": "タスクID。" + }, + "id": { + "type": "string", + "format": "uuid", + "description": "ユニークID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + }, + "mode": { + "type": "string", + "example": "chat", + "description": "アプリモード、`chat`として固定。" + }, + "answer": { + "type": "string", + "description": "完全な応答内容。" + }, + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataJa" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "メッセージ作成タイムスタンプ。" + } } }, "ResponseMetadataJa": { - "type": "object", "description": "メタデータ。", - "properties": { "usage": { "$ref": "#/components/schemas/UsageJa" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJa" }, "description": "引用と帰属リスト。" } } - }, - "ChunkBasicChatEventJa": { - "type": "object", "required": ["event"], - "properties": { "event": { "type": "string", "enum": ["message", "agent_message", "agent_thought", "message_file", "message_end", "tts_message", "tts_message_end", "message_replace", "error", "ping"], "description": "イベントタイプ。" } }, - "discriminator": { "propertyName": "event", "mapping": { - "message": "#/components/schemas/StreamEventChatMessageJa", "agent_message": "#/components/schemas/StreamEventAgentMessageJa", - "agent_thought": "#/components/schemas/StreamEventAgentThoughtJa", "message_file": "#/components/schemas/StreamEventMessageFileJa", - "message_end": "#/components/schemas/StreamEventMessageEndJa", "tts_message": "#/components/schemas/StreamEventTtsMessageJa", - "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJa", "message_replace": "#/components/schemas/StreamEventMessageReplaceJa", - "error": "#/components/schemas/StreamEventErrorJa", "ping": "#/components/schemas/StreamEventPingJa" - }} - }, - "StreamEventBaseChatJa": { - "type": "object", "properties": { - "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, - "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } + "type": "object", + "description": "メタデータ。", + "properties": { + "usage": { + "$ref": "#/components/schemas/UsageJa" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResourceJa" + }, + "description": "引用と帰属リスト。" + } } }, - "StreamEventChatMessageJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLMが返したテキストチャンク内容。" } } } ] }, - "StreamEventAgentMessageJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLMが返したテキストチャンク内容（エージェントモード）。" } } } ] }, + "ChunkBasicChatEventJa": { + "type": "object", + "required": [ + "event" + ], + "properties": { + "event": { + "type": "string", + "enum": [ + "message", + "agent_message", + "agent_thought", + "message_file", + "message_end", + "tts_message", + "tts_message_end", + "message_replace", + "error", + "ping" + ], + "description": "イベントタイプ。" + } + }, + "discriminator": { + "propertyName": "event", + "mapping": { + "message": "#/components/schemas/StreamEventChatMessageJa", + "agent_message": "#/components/schemas/StreamEventAgentMessageJa", + "agent_thought": "#/components/schemas/StreamEventAgentThoughtJa", + "message_file": "#/components/schemas/StreamEventMessageFileJa", + "message_end": "#/components/schemas/StreamEventMessageEndJa", + "tts_message": "#/components/schemas/StreamEventTtsMessageJa", + "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJa", + "message_replace": "#/components/schemas/StreamEventMessageReplaceJa", + "error": "#/components/schemas/StreamEventErrorJa", + "ping": "#/components/schemas/StreamEventPingJa" + } + } + }, + "StreamEventBaseChatJa": { + "type": "object", + "properties": { + "task_id": { + "type": "string", + "format": "uuid", + "description": "タスクID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, + "StreamEventChatMessageJa": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJa" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "LLMが返したテキストチャンク内容。" + } + } + } + ] + }, + "StreamEventAgentMessageJa": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJa" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "LLMが返したテキストチャンク内容（エージェントモード）。" + } + } + } + ] + }, "StreamEventAgentThoughtJa": { - "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, - { "type": "object", "required": ["id", "task_id", "message_id", "position", "created_at", "conversation_id"], + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "type": "object", + "required": [ + "id", + "task_id", + "message_id", + "position", + "created_at", + "conversation_id" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "エージェント思考ID。" + }, + "task_id": { + "type": "string", + "format": "uuid", + "description": "タスクID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "position": { + "type": "integer", + "description": "エージェント思考のメッセージ内での位置。" + }, + "thought": { + "type": "string", + "nullable": true, + "description": "エージェントの思考内容。" + }, + "observation": { + "type": "string", + "nullable": true, + "description": "ツール呼び出しからの応答。" + }, + "tool": { + "type": "string", + "nullable": true, + "description": "使用されたツールのリスト、;で区切られます。" + }, + "tool_input": { + "type": "string", + "nullable": true, + "description": "ツールの入力、JSON形式の文字列。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + }, + "message_files": { + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "description": "ファイルID" + }, + "description": "現在のエージェント思考に関連するファイルIDのリスト。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + } + } + } + ] + }, + "StreamEventMessageFileJa": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "type": "object", + "required": [ + "id", + "type", + "belongs_to", + "url", + "conversation_id" + ], "properties": { - "id": { "type": "string", "format": "uuid", "description": "エージェント思考ID。" }, - "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, - "position": { "type": "integer", "description": "エージェント思考のメッセージ内での位置。" }, - "thought": { "type": "string", "nullable": true, "description": "エージェントの思考内容。" }, - "observation": { "type": "string", "nullable": true, "description": "ツール呼び出しからの応答。" }, - "tool": { "type": "string", "nullable": true, "description": "使用されたツールのリスト、;で区切られます。" }, - "tool_input": { "type": "string", "nullable": true, "description": "ツールの入力、JSON形式の文字列。" }, - "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, - "message_files": { "type": "array", "items": { "type": "string", "format": "uuid", "description": "ファイルID" }, "description": "現在のエージェント思考に関連するファイルIDのリスト。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" } + "id": { + "type": "string", + "format": "uuid", + "description": "ファイル一意ID。" + }, + "type": { + "type": "string", + "enum": [ + "image" + ], + "description": "ファイルタイプ、現在は'image'のみ許可。" + }, + "belongs_to": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "所属、ここでは'assistant'のみ。" + }, + "url": { + "type": "string", + "format": "url", + "description": "ファイルのリモートURL。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + } + } + } + ] + }, + "StreamEventMessageEndJa": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJa" + }, + { + "type": "object", + "required": [ + "metadata" + ], + "properties": { + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataJa" + } } } ] }, - "StreamEventMessageFileJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "type": "object", "required": ["id", "type", "belongs_to", "url", "conversation_id"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ファイル一意ID。" }, "type": { "type": "string", "enum": ["image"], "description": "ファイルタイプ、現在は'image'のみ許可。" }, "belongs_to": { "type": "string", "enum": ["assistant"], "description": "所属、ここでは'assistant'のみ。" }, "url": { "type": "string", "format": "url", "description": "ファイルのリモートURL。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" } } } ] }, - "StreamEventMessageEndJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataJa" } } } ] }, - "StreamEventTtsMessageJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64エンコードされたオーディオブロック。" } } } ] }, - "StreamEventTtsMessageEndJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空の文字列。" } } } ] }, - "StreamEventMessageReplaceJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "置換内容（すべてのLLM返信テキストを直接置換）。" } } } ] }, - "StreamEventErrorJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "type": "object", "required": ["task_id", "status", "code", "message"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid", "nullable": true, "description": "一意のメッセージID（エラーイベントでは存在しない場合があります）。" }, "status": { "type": "integer", "description": "HTTPステータスコード。" }, "code": { "type": "string", "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } ] }, - "StreamEventPingJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "type": "object", "description": "接続を維持するために10秒ごとにpingイベントが発生します。" } ] }, - "UsageJa": { "type": "object", "description": "モデル使用情報。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, - "RetrieverResourceJa": { "type": "object", "description": "引用と帰属情報。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } }, - "FileUploadResponseJa": { "type": "object", "description": "ファイルアップロード成功後の応答。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ（バイト）。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, + "StreamEventTtsMessageJa": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJa" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "format": "byte", + "description": "Base64エンコードされたオーディオブロック。" + } + } + } + ] + }, + "StreamEventTtsMessageEndJa": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJa" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "description": "空の文字列。" + } + } + } + ] + }, + "StreamEventMessageReplaceJa": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJa" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "置換内容（すべてのLLM返信テキストを直接置換）。" + } + } + } + ] + }, + "StreamEventErrorJa": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "type": "object", + "required": [ + "task_id", + "status", + "code", + "message" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "message_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "一意のメッセージID（エラーイベントでは存在しない場合があります）。" + }, + "status": { + "type": "integer", + "description": "HTTPステータスコード。" + }, + "code": { + "type": "string", + "description": "エラーコード。" + }, + "message": { + "type": "string", + "description": "エラーメッセージ。" + } + } + } + ] + }, + "StreamEventPingJa": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventJa" + }, + { + "type": "object", + "description": "接続を維持するために10秒ごとにpingイベントが発生します。" + } + ] + }, + "UsageJa": { + "type": "object", + "description": "モデル使用情報。", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "prompt_unit_price": { + "type": "string" + }, + "prompt_price_unit": { + "type": "string" + }, + "prompt_price": { + "type": "string" + }, + "completion_tokens": { + "type": "integer" + }, + "completion_unit_price": { + "type": "string" + }, + "completion_price_unit": { + "type": "string" + }, + "completion_price": { + "type": "string" + }, + "total_tokens": { + "type": "integer" + }, + "total_price": { + "type": "string" + }, + "currency": { + "type": "string" + }, + "latency": { + "type": "number", + "format": "double" + } + } + }, + "RetrieverResourceJa": { + "type": "object", + "description": "引用と帰属情報。", + "properties": { + "position": { + "type": "integer" + }, + "dataset_id": { + "type": "string", + "format": "uuid" + }, + "dataset_name": { + "type": "string" + }, + "document_id": { + "type": "string", + "format": "uuid" + }, + "document_name": { + "type": "string" + }, + "segment_id": { + "type": "string", + "format": "uuid" + }, + "score": { + "type": "number", + "format": "float" + }, + "content": { + "type": "string" + } + } + }, + "FileUploadResponseJa": { + "type": "object", + "description": "ファイルアップロード成功後の応答。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "name": { + "type": "string", + "description": "ファイル名。" + }, + "size": { + "type": "integer", + "description": "ファイルサイズ（バイト）。" + }, + "extension": { + "type": "string", + "description": "ファイル拡張子。" + }, + "mime_type": { + "type": "string", + "description": "ファイルのMIMEタイプ。" + }, + "created_by": { + "type": "string", + "format": "uuid", + "description": "エンドユーザーID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, "EndUserDetailJa": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, - "tenant_id": { "type": "string", "format": "uuid" }, - "app_id": { "type": "string", "format": "uuid", "nullable": true }, - "type": { "type": "string", "example": "service_api" }, - "external_user_id": { "type": "string", "nullable": true }, - "name": { "type": "string", "nullable": true }, - "is_anonymous": { "type": "boolean" }, - "session_id": { "type": "string" }, - "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { "type": "string", "format": "date-time" } - } - }, - "MessageFeedbackRequestJa": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "アップボートは`like`、ダウンボートは`dislike`、アップボートの取り消しは`null`。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "content": { "type": "string", "nullable": true, "description": "メッセージのフィードバックです。" } } }, - "AppFeedbacksResponseJa": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemJa" }, "description": "このアプリの「いいね」とフィードバックの一覧を返します。" } } }, - "FeedbackItemJa": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, - "SuggestedQuestionsResponseJa": { "type": "object", "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "string" }, "description": "推奨質問のリスト。" } } }, - "BasicConversationHistoryResponseJa": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返されたアイテムの数。" }, "has_more": { "type": "boolean", "description": "次のページがあるかどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BasicConversationMessageItemJa" }, "description": "メッセージリスト。" } } }, - "BasicConversationMessageItemJa": { "type": "object", "description": "会話内の単一メッセージ。", "properties": { "id": { "type": "string", "format": "uuid", "description": "メッセージID。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ユーザー入力パラメータ。" }, "query": { "type": "string", "description": "ユーザー入力/質問内容。" }, "answer": { "type": "string", "description": "応答メッセージ内容。" }, "message_files": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFileItemJa" }, "description": "メッセージファイルリスト。" }, "feedback": { "type": "object", "nullable": true, "properties": { "rating": { "type": "string", "enum": ["like", "dislike"], "description": "アップボートは`like` / ダウンボートは`dislike`。" } }, "description": "フィードバック情報。" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJa" }, "description": "引用と帰属リスト。" }, "agent_thoughts": { "type": "array", "items": { "$ref": "#/components/schemas/AgentThoughtItemJa" }, "description": "エージェントの思考（基本アシスタントの場合は空）。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, + "id": { + "type": "string", + "format": "uuid" + }, + "tenant_id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "type": { + "type": "string", + "example": "service_api" + }, + "external_user_id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "is_anonymous": { + "type": "boolean" + }, + "session_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "MessageFeedbackRequestJa": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true, + "description": "アップボートは`like`、ダウンボートは`dislike`、アップボートの取り消しは`null`。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + }, + "content": { + "type": "string", + "nullable": true, + "description": "メッセージのフィードバックです。" + } + } + }, + "AppFeedbacksResponseJa": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeedbackItemJa" + }, + "description": "このアプリの「いいね」とフィードバックの一覧を返します。" + } + } + }, + "FeedbackItemJa": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid" + }, + "conversation_id": { + "type": "string", + "format": "uuid" + }, + "message_id": { + "type": "string", + "format": "uuid" + }, + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true + }, + "content": { + "type": "string" + }, + "from_source": { + "type": "string" + }, + "from_end_user_id": { + "type": "string", + "format": "uuid" + }, + "from_account_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "SuggestedQuestionsResponseJa": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + }, + "data": { + "type": "array", + "items": { + "type": "string" + }, + "description": "推奨質問のリスト。" + } + } + }, + "BasicConversationHistoryResponseJa": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "返されたアイテムの数。" + }, + "has_more": { + "type": "boolean", + "description": "次のページがあるかどうか。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BasicConversationMessageItemJa" + }, + "description": "メッセージリスト。" + } + } + }, + "BasicConversationMessageItemJa": { + "type": "object", + "description": "会話内の単一メッセージ。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "メッセージID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "ユーザー入力パラメータ。" + }, + "query": { + "type": "string", + "description": "ユーザー入力/質問内容。" + }, + "answer": { + "type": "string", + "description": "応答メッセージ内容。" + }, + "message_files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageFileItemJa" + }, + "description": "メッセージファイルリスト。" + }, + "feedback": { + "type": "object", + "nullable": true, + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike" + ], + "description": "アップボートは`like` / ダウンボートは`dislike`。" + } + }, + "description": "フィードバック情報。" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResourceJa" + }, + "description": "引用と帰属リスト。" + }, + "agent_thoughts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgentThoughtItemJa" + }, + "description": "エージェントの思考（基本アシスタントの場合は空）。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, "AgentThoughtItemJa": { - "type": "object", "description": "エージェントの思考ステップ。", - "properties": { - "id": { "type": "string", "format": "uuid", "description": "エージェント思考ID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, - "position": { "type": "integer", "description": "エージェント思考のメッセージ内での位置。" }, - "thought": { "type": "string", "nullable": true, "description": "LLMが考えていること。" }, - "observation": { "type": "string", "nullable": true, "description": "ツール呼び出しからの応答。" }, - "tool": { "type": "string", "nullable": true, "description": "呼び出されたツールのリスト、;で区切られます。" }, - "tool_input": { "type": "string", "nullable": true, "description": "ツールの入力、JSON形式。" }, - "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, - "message_files": { "type": "array", "items": { "type": "string", "format": "uuid", "description": "ファイルID" }, "description": "現在のエージェント思考に関連するファイルIDのリスト。" } - } - }, - "MessageFileItemJa": { "type": "object", "description": "メッセージ内のファイル項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "ファイルタイプ、例：'image'。" }, "url": { "type": "string", "format": "url", "description": "プレビュー画像URL。" }, "belongs_to": { "type": "string", "enum": ["user", "assistant"], "description": "所属。" } } }, - "ConversationsListResponseJa": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返されたエントリの数。" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationListItemJa" }, "description": "会話のリスト。" } } }, - "ConversationListItemJa": { "type": "object", "description": "会話リスト内の単一項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "会話ID。" }, "name": { "type": "string", "description": "会話名。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ユーザー入力パラメータ。" }, "status": { "type": "string", "description": "会話状態。" }, "introduction": { "type": "string", "nullable": true, "description": "紹介。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, "updated_at": { "type": "integer", "format": "int64", "description": "更新タイムスタンプ。" } } }, - "ConversationRenameRequestJa": { "type": "object", "required": ["user"], "properties": { "name": { "type": "string", "nullable": true, "description": "(Optional)会話の名前。`auto_generate`が`true`の場合、省略できます。" }, "auto_generate": { "type": "boolean", "default": false, "description": "(Optional)タイトルを自動生成します。デフォルトは`false`です。" }, "user": { "type": "string", "description": "ユーザー識別子。" } } }, - "ConversationRenameResponseJa": { "$ref": "#/components/schemas/ConversationListItemJa" }, - "ConversationVariablesResponseJa": { "type": "object", "properties": { "limit": { "type": "integer", "description": "ページごとのアイテム数。" }, "has_more": { "type": "boolean", "description": "さらにアイテムがあるかどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationVariableItemJa" }, "description": "変数のリスト。" } } }, - "ConversationVariableItemJa": { "type": "object", "description": "会話内の変数項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "変数ID。" }, "name": { "type": "string", "description": "変数名。" }, "value_type": { "type": "string", "description": "変数タイプ（文字列、数値、真偽値など）。" }, "value": { "type": "string", "description": "変数値。" }, "description": { "type": "string", "nullable": true, "description": "変数の説明。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, "updated_at": { "type": "integer", "format": "int64", "description": "最終更新タイムスタンプ。" } } }, - "AudioToTextRequestJa": { "type": "object", "required": ["file", "user"], "properties": { "file": { "type": "string", "format": "binary", "description": "オーディオファイル。サポートされている形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`。ファイルサイズ制限：15MB。" }, "user": { "type": "string", "description": "ユーザー識別子。" } } }, - "AudioToTextResponseJa": { "type": "object", "properties": { "text": { "type": "string", "description": "出力テキスト。" } } }, - "TextToAudioFormRequestJa": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "メッセージID（優先）。" }, "text": { "type": "string", "description": "音声生成コンテンツ。" }, "user": { "type": "string", "description": "ユーザー識別子。" } }, "description": "`user`が必要です。`message_id`または`text`を提供してください。このバージョンはmultipart/form-dataです。" }, - "AppInfoResponseJa": { "type": "object", "description": "アプリケーションの基本情報。", "properties": { "name": { "type": "string", "description": "アプリケーションの名前。" }, "description": { "type": "string", "description": "アプリケーションの説明。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "アプリケーションのタグ。" } } }, - "BasicChatAppParametersResponseJa": { "type": "object", "description": "アプリケーションのパラメータ情報。", "properties": { "opening_statement": { "type": "string", "description": "開始文。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "開始時の推奨質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "答えを有効にした後の質問を提案します。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "音声からテキストへ。" }, "text_to_speech": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" }, "voice": { "type": "string", "description": "音声タイプ。" }, "language": { "type": "string", "description": "言語。" }, "autoPlay": { "type": "string", "enum": ["enabled", "disabled"], "description": "自動再生：enabled 有効, disabled 無効。" } }, "description": "テキストから音声へ。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "引用と帰属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "注釈返信。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemJa" }, "description": "ユーザー入力フォームの構成。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "画像設定。サポートされている画像タイプ：`png`, `jpg`, `jpeg`, `webp`, `gif`。" } }, "description": "ファイルアップロード構成。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "ドキュメントアップロードサイズ制限（MB）。" }, "image_file_size_limit": { "type": "integer", "description": "画像ファイルアップロードサイズ制限（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "オーディオファイルアップロードサイズ制限（MB）。" }, "video_file_size_limit": { "type": "integer", "description": "ビデオファイルアップロードサイズ制限（MB）。" } }, "description": "システムパラメータ。" } } }, - "UserInputFormItemJa": { "type": "object", "description": "ユーザー入力フォーム内のコントロール項目。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperJa" }, { "$ref": "#/components/schemas/ParagraphControlWrapperJa" }, { "$ref": "#/components/schemas/SelectControlWrapperJa" } ] }, - "TextInputControlWrapperJa": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlJa" } }, "required":["text-input"] }, - "ParagraphControlWrapperJa": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlJa" } }, "required":["paragraph"] }, - "SelectControlWrapperJa": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlJa" } }, "required":["select"] }, - "TextInputControlJa": { "type": "object", "description": "テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, - "ParagraphControlJa": { "type": "object", "description": "段落テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, - "SelectControlJa": { "type": "object", "description": "ドロップダウンコントロール。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "オプション値。" } } }, - "AppMetaResponseJa": { "type": "object", "description": "アプリケーションのメタ情報。", "properties": { "tool_icons": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "format": "url", "description": "アイコンのURL。" }, { "$ref": "#/components/schemas/ToolIconDetailJa" } ] }, "description": "ツールアイコン。キーはツール名です。" } } }, - "ToolIconDetailJa": { "type": "object", "description": "ツールアイコンの詳細。", "properties": { "background": { "type": "string", "description": "背景色（16進数形式）。" }, "content": { "type": "string", "description": "絵文字。" } } }, - "WebAppSettingsResponseJa": { "type": "object", "description": "アプリのWebApp設定。", "properties": { "title": { "type": "string", "description": "WebApp名。" }, "chat_color_theme": { "type": "string", "description": "チャットの色テーマ、16進数形式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "チャットの色テーマを反転するかどうか。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "アイコンタイプ。" }, "icon": { "type": "string", "description": "アイコン内容（絵文字または画像URL）。" }, "icon_background": { "type": "string", "description": "16進数形式の背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "アイコンのURL。" }, "description": { "type": "string", "description": "説明。" }, "copyright": { "type": "string", "description": "著作権情報。" }, "privacy_policy": { "type": "string", "description": "プライバシーポリシーのリンク。" }, "custom_disclaimer": { "type": "string", "description": "カスタム免責事項。" }, "default_language": { "type": "string", "description": "デフォルト言語。" }, "show_workflow_steps": { "type": "boolean", "description": "ワークフローの詳細を表示するかどうか。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "WebAppのアイコンをチャット内の🤖に置き換えるかどうか。" } } }, - "ErrorResponseJa": { "type": "object", "description": "エラー応答。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTPステータスコード。" }, "code": { "type": "string", "nullable": true, "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } + "type": "object", + "description": "エージェントの思考ステップ。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "エージェント思考ID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "position": { + "type": "integer", + "description": "エージェント思考のメッセージ内での位置。" + }, + "thought": { + "type": "string", + "nullable": true, + "description": "LLMが考えていること。" + }, + "observation": { + "type": "string", + "nullable": true, + "description": "ツール呼び出しからの応答。" + }, + "tool": { + "type": "string", + "nullable": true, + "description": "呼び出されたツールのリスト、;で区切られます。" + }, + "tool_input": { + "type": "string", + "nullable": true, + "description": "ツールの入力、JSON形式。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + }, + "message_files": { + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "description": "ファイルID" + }, + "description": "現在のエージェント思考に関連するファイルIDのリスト。" + } + } + }, + "MessageFileItemJa": { + "type": "object", + "description": "メッセージ内のファイル項目。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "type": { + "type": "string", + "description": "ファイルタイプ、例：'image'。" + }, + "url": { + "type": "string", + "format": "url", + "description": "プレビュー画像URL。" + }, + "belongs_to": { + "type": "string", + "enum": [ + "user", + "assistant" + ], + "description": "所属。" + } + } + }, + "ConversationsListResponseJa": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "返されたエントリの数。" + }, + "has_more": { + "type": "boolean" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationListItemJa" + }, + "description": "会話のリスト。" + } + } + }, + "ConversationListItemJa": { + "type": "object", + "description": "会話リスト内の単一項目。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + }, + "name": { + "type": "string", + "description": "会話名。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "ユーザー入力パラメータ。" + }, + "status": { + "type": "string", + "description": "会話状態。" + }, + "introduction": { + "type": "string", + "nullable": true, + "description": "紹介。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + }, + "updated_at": { + "type": "integer", + "format": "int64", + "description": "更新タイムスタンプ。" + } + } + }, + "ConversationRenameRequestJa": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "name": { + "type": "string", + "nullable": true, + "description": "(Optional)会話の名前。`auto_generate`が`true`の場合、省略できます。" + }, + "auto_generate": { + "type": "boolean", + "default": false, + "description": "(Optional)タイトルを自動生成します。デフォルトは`false`です。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + } + } + }, + "ConversationRenameResponseJa": { + "$ref": "#/components/schemas/ConversationListItemJa" + }, + "ConversationVariablesResponseJa": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "ページごとのアイテム数。" + }, + "has_more": { + "type": "boolean", + "description": "さらにアイテムがあるかどうか。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationVariableItemJa" + }, + "description": "変数のリスト。" + } + } + }, + "ConversationVariableItemJa": { + "type": "object", + "description": "会話内の変数項目。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "変数ID。" + }, + "name": { + "type": "string", + "description": "変数名。" + }, + "value_type": { + "type": "string", + "description": "変数タイプ（文字列、数値、真偽値など）。" + }, + "value": { + "type": "string", + "description": "変数値。" + }, + "description": { + "type": "string", + "nullable": true, + "description": "変数の説明。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + }, + "updated_at": { + "type": "integer", + "format": "int64", + "description": "最終更新タイムスタンプ。" + } + } + }, + "AudioToTextRequestJa": { + "type": "object", + "required": [ + "file", + "user" + ], + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "オーディオファイル。サポートされている形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`。ファイルサイズ制限：15MB。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + } + } + }, + "AudioToTextResponseJa": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "出力テキスト。" + } + } + }, + "TextToAudioFormRequestJa": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "message_id": { + "type": "string", + "format": "uuid", + "description": "メッセージID（優先）。" + }, + "text": { + "type": "string", + "description": "音声生成コンテンツ。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + } + }, + "description": "`user`が必要です。`message_id`または`text`を提供してください。このバージョンはmultipart/form-dataです。" + }, + "AppInfoResponseJa": { + "type": "object", + "description": "アプリケーションの基本情報。", + "properties": { + "name": { + "type": "string", + "description": "アプリケーションの名前。" + }, + "description": { + "type": "string", + "description": "アプリケーションの説明。" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "アプリケーションのタグ。" + } + } + }, + "BasicChatAppParametersResponseJa": { + "type": "object", + "description": "アプリケーションのパラメータ情報。", + "properties": { + "opening_statement": { + "type": "string", + "description": "開始文。" + }, + "suggested_questions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "開始時の推奨質問のリスト。" + }, + "suggested_questions_after_answer": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + } + }, + "description": "答えを有効にした後の質問を提案します。" + }, + "speech_to_text": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + } + }, + "description": "音声からテキストへ。" + }, + "text_to_speech": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + }, + "voice": { + "type": "string", + "description": "音声タイプ。" + }, + "language": { + "type": "string", + "description": "言語。" + }, + "autoPlay": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "description": "自動再生：enabled 有効, disabled 無効。" + } + }, + "description": "テキストから音声へ。" + }, + "retriever_resource": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + } + }, + "description": "引用と帰属。" + }, + "annotation_reply": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + } + }, + "description": "注釈返信。" + }, + "user_input_form": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserInputFormItemJa" + }, + "description": "ユーザー入力フォームの構成。" + }, + "file_upload": { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "number_limits": { + "type": "integer" + }, + "transfer_methods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ] + } + } + }, + "description": "画像設定。サポートされている画像タイプ：`png`, `jpg`, `jpeg`, `webp`, `gif`。" + } + }, + "description": "ファイルアップロード構成。" + }, + "system_parameters": { + "type": "object", + "properties": { + "file_size_limit": { + "type": "integer", + "description": "ドキュメントアップロードサイズ制限（MB）。" + }, + "image_file_size_limit": { + "type": "integer", + "description": "画像ファイルアップロードサイズ制限（MB）。" + }, + "audio_file_size_limit": { + "type": "integer", + "description": "オーディオファイルアップロードサイズ制限（MB）。" + }, + "video_file_size_limit": { + "type": "integer", + "description": "ビデオファイルアップロードサイズ制限（MB）。" + } + }, + "description": "システムパラメータ。" + } + } + }, + "UserInputFormItemJa": { + "type": "object", + "description": "ユーザー入力フォーム内のコントロール項目。", + "oneOf": [ + { + "$ref": "#/components/schemas/TextInputControlWrapperJa" + }, + { + "$ref": "#/components/schemas/ParagraphControlWrapperJa" + }, + { + "$ref": "#/components/schemas/SelectControlWrapperJa" + } + ] + }, + "TextInputControlWrapperJa": { + "type": "object", + "properties": { + "text-input": { + "$ref": "#/components/schemas/TextInputControlJa" + } + }, + "required": [ + "text-input" + ] + }, + "ParagraphControlWrapperJa": { + "type": "object", + "properties": { + "paragraph": { + "$ref": "#/components/schemas/ParagraphControlJa" + } + }, + "required": [ + "paragraph" + ] + }, + "SelectControlWrapperJa": { + "type": "object", + "properties": { + "select": { + "$ref": "#/components/schemas/SelectControlJa" + } + }, + "required": [ + "select" + ] + }, + "TextInputControlJa": { + "type": "object", + "description": "テキスト入力コントロール。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + } + } + }, + "ParagraphControlJa": { + "type": "object", + "description": "段落テキスト入力コントロール。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + } + } + }, + "SelectControlJa": { + "type": "object", + "description": "ドロップダウンコントロール。", + "required": [ + "label", + "variable", + "required", + "options" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + }, + "options": { + "type": "array", + "items": { + "type": "string" + }, + "description": "オプション値。" + } + } + }, + "AppMetaResponseJa": { + "type": "object", + "description": "アプリケーションのメタ情報。", + "properties": { + "tool_icons": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "string", + "format": "url", + "description": "アイコンのURL。" + }, + { + "$ref": "#/components/schemas/ToolIconDetailJa" + } + ] + }, + "description": "ツールアイコン。キーはツール名です。" + } + } + }, + "ToolIconDetailJa": { + "type": "object", + "description": "ツールアイコンの詳細。", + "properties": { + "background": { + "type": "string", + "description": "背景色（16進数形式）。" + }, + "content": { + "type": "string", + "description": "絵文字。" + } + } + }, + "WebAppSettingsResponseJa": { + "type": "object", + "description": "アプリのWebApp設定。", + "properties": { + "title": { + "type": "string", + "description": "WebApp名。" + }, + "chat_color_theme": { + "type": "string", + "description": "チャットの色テーマ、16進数形式。" + }, + "chat_color_theme_inverted": { + "type": "boolean", + "description": "チャットの色テーマを反転するかどうか。" + }, + "icon_type": { + "type": "string", + "enum": [ + "emoji", + "image" + ], + "description": "アイコンタイプ。" + }, + "icon": { + "type": "string", + "description": "アイコン内容（絵文字または画像URL）。" + }, + "icon_background": { + "type": "string", + "description": "16進数形式の背景色。" + }, + "icon_url": { + "type": "string", + "format": "url", + "nullable": true, + "description": "アイコンのURL。" + }, + "description": { + "type": "string", + "description": "説明。" + }, + "copyright": { + "type": "string", + "description": "著作権情報。" + }, + "privacy_policy": { + "type": "string", + "description": "プライバシーポリシーのリンク。" + }, + "custom_disclaimer": { + "type": "string", + "description": "カスタム免責事項。" + }, + "default_language": { + "type": "string", + "description": "デフォルト言語。" + }, + "show_workflow_steps": { + "type": "boolean", + "description": "ワークフローの詳細を表示するかどうか。" + }, + "use_icon_as_answer_icon": { + "type": "boolean", + "description": "WebAppのアイコンをチャット内の🤖に置き換えるかどうか。" + } + } + }, + "ErrorResponseJa": { + "type": "object", + "description": "エラー応答。", + "properties": { + "status": { + "type": "integer", + "nullable": true, + "description": "HTTPステータスコード。" + }, + "code": { + "type": "string", + "nullable": true, + "description": "エラーコード。" + }, + "message": { + "type": "string", + "description": "エラーメッセージ。" + } + } + } } }, "tags": [ - { "name": "チャットメッセージ", "description": "チャットメッセージと対話に関連する操作。" }, - { "name": "ファイル操作", "description": "ファイルアップロードとプレビューに関連する操作。" }, - { "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" }, - { "name": "メッセージフィードバック", "description": "ユーザーからのメッセージフィードバック操作。" }, - { "name": "会話管理", "description": "会話セッションの管理に関連する操作。" }, - { "name": "音声とテキスト変換", "description": "テキストから音声、音声からテキストへの変換操作。" }, - { "name": "アプリケーション設定", "description": "アプリケーション設定と情報の取得に関連する操作。" } + { + "name": "チャットメッセージ", + "description": "チャットメッセージと対話に関連する操作。" + }, + { + "name": "ファイル操作", + "description": "ファイルアップロードとプレビューに関連する操作。" + }, + { + "name": "エンドユーザー", + "description": "エンドユーザー情報に関連する操作。" + }, + { + "name": "メッセージフィードバック", + "description": "ユーザーからのメッセージフィードバック操作。" + }, + { + "name": "会話管理", + "description": "会話セッションの管理に関連する操作。" + }, + { + "name": "音声とテキスト変換", + "description": "テキストから音声、音声からテキストへの変換操作。" + }, + { + "name": "アプリケーション設定", + "description": "アプリケーション設定と情報の取得に関連する操作。" + } ] -} \ No newline at end of file +} diff --git a/ja/api-reference/openapi_chatflow.json b/ja/api-reference/openapi_chatflow.json index eb6d60708..f7328f7a3 100644 --- a/ja/api-reference/openapi_chatflow.json +++ b/ja/api-reference/openapi_chatflow.json @@ -27,8 +27,10 @@ "post": { "summary": "チャットメッセージを送信", "description": "チャットアプリケーションにリクエストを送信します。", - "operationId": "sendChatflowMessageJp", - "tags": ["チャットメッセージ"], + "operationId": "sendAdvancedChatMessage", + "tags": [ + "チャットメッセージ" + ], "requestBody": { "description": "チャットメッセージ送信のリクエストボディ。", "required": true, @@ -78,9 +80,15 @@ } } }, - "400": { "$ref": "#/components/responses/BadRequestGenericJp" }, - "404": { "$ref": "#/components/responses/ConversationNotFoundJp" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + "400": { + "$ref": "#/components/responses/BadRequestGenericJp" + }, + "404": { + "$ref": "#/components/responses/ConversationNotFoundJp" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJp" + } } } }, @@ -88,8 +96,10 @@ "post": { "summary": "ファイルアップロード", "description": "メッセージ送信時に使用するファイルをアップロードし、画像とテキストのマルチモーダル理解を可能にします。アプリケーションでサポートされている形式をサポートします。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", - "operationId": "uploadChatflowFileJp", - "tags": ["ファイル操作"], + "operationId": "uploadAdvancedChatFile", + "tags": [ + "ファイル操作" + ], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data` リクエストが必要です。", "required": true, @@ -97,7 +107,10 @@ "multipart/form-data": { "schema": { "type": "object", - "required": ["file", "user"], + "required": [ + "file", + "user" + ], "properties": { "file": { "type": "string", @@ -126,13 +139,29 @@ }, "201": { "description": "ファイル作成成功（代替成功コード）。", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseJp" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequestFileJp" + }, + "413": { + "$ref": "#/components/responses/FileTooLargeJp" + }, + "415": { + "$ref": "#/components/responses/UnsupportedFileTypeFileJp" + }, + "503": { + "$ref": "#/components/responses/S3ErrorFileJp" }, - "400": { "$ref": "#/components/responses/BadRequestFileJp" }, - "413": { "$ref": "#/components/responses/FileTooLargeJp" }, - "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileJp" }, - "503": { "$ref": "#/components/responses/S3ErrorFileJp" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + "500": { + "$ref": "#/components/responses/InternalServerErrorJp" + } } } }, @@ -140,15 +169,20 @@ "get": { "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", - "operationId": "getEndUserChatflowJp", - "tags": ["エンドユーザー"], + "operationId": "getEndUserChatflow", + "tags": [ + "エンドユーザー" + ], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "エンドユーザーID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -156,12 +190,18 @@ "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/EndUserDetailJp" } + "schema": { + "$ref": "#/components/schemas/EndUserDetailJp" + } } } }, - "404": { "$ref": "#/components/responses/EndUserNotFoundJp" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + "404": { + "$ref": "#/components/responses/EndUserNotFoundJp" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJp" + } } } }, @@ -169,8 +209,10 @@ "get": { "summary": "ファイルプレビュー", "description": "アップロードされたファイルのプレビューまたはダウンロード。このエンドポイントは、ファイルアップロードAPIを通じて事前にアップロードされたファイルにアクセスすることができます。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセス可能です。", - "operationId": "previewChatflowFileJp", - "tags": ["ファイル操作"], + "operationId": "previewChatFlowFile", + "tags": [ + "ファイル操作" + ], "parameters": [ { "name": "file_id", @@ -267,7 +309,9 @@ "description": "不正なリクエスト。可能なエラーコード:\n- `invalid_param`: 異常なパラメータ入力。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } } } }, @@ -275,7 +319,9 @@ "description": "禁止。可能なエラーコード:\n- `file_access_denied`: ファイルアクセス拒否またはファイルが現在のアプリケーションに属していません。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } } } }, @@ -283,7 +329,9 @@ "description": "見つかりません。可能なエラーコード:\n- `file_not_found`: ファイルが見つからないか削除されています。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } } } }, @@ -291,7 +339,9 @@ "description": "内部サーバーエラー。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } } } } @@ -302,15 +352,20 @@ "post": { "summary": "生成を停止", "description": "チャットメッセージの生成を停止します。ストリーミングモードでのみサポートされています。", - "operationId": "stopChatflowMessageGenerationJp", - "tags": ["チャットメッセージ"], + "operationId": "stopAdvancedChatMessageGeneration", + "tags": [ + "チャットメッセージ" + ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "タスクID、ストリーミングチャンクの返り値から取得できます。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { @@ -319,7 +374,9 @@ "application/json": { "schema": { "type": "object", - "required": ["user"], + "required": [ + "user" + ], "properties": { "user": { "type": "string", @@ -331,7 +388,9 @@ } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResultJp" } + "200": { + "$ref": "#/components/responses/SuccessResultJp" + } } } }, @@ -339,27 +398,36 @@ "post": { "summary": "メッセージフィードバック", "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのを支援します。", - "operationId": "postChatflowMessageFeedbackJp", - "tags": ["メッセージフィードバック"], + "operationId": "postAdvancedChatMessageFeedback", + "tags": [ + "メッセージフィードバック" + ], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestJp" } + "schema": { + "$ref": "#/components/schemas/MessageFeedbackRequestJp" + } } } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResultJp" } + "200": { + "$ref": "#/components/responses/SuccessResultJp" + } } } }, @@ -367,18 +435,26 @@ "get": { "summary": "アプリのメッセージの「いいね」とフィードバックを取得", "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", - "operationId": "getChatflowAppFeedbacksJp", - "tags": ["メッセージフィードバック"], + "operationId": "getAdvancedChatAppFeedbacks", + "tags": [ + "メッセージフィードバック" + ], "parameters": [ - { "$ref": "#/components/parameters/PageQueryParamJp" }, - { "$ref": "#/components/parameters/LimitQueryParamJp" } + { + "$ref": "#/components/parameters/PageQueryParamJp" + }, + { + "$ref": "#/components/parameters/LimitQueryParamJp" + } ], "responses": { "200": { "description": "アプリのフィードバックリストを正常に取得しました。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseJp" } + "schema": { + "$ref": "#/components/schemas/AppFeedbacksResponseJp" + } } } } @@ -389,24 +465,33 @@ "get": { "summary": "次の推奨質問", "description": "現在のメッセージに対する次の質問の提案を取得します。", - "operationId": "getChatflowSuggestedQuestionsJp", - "tags": ["チャットメッセージ"], + "operationId": "getAdvancedSuggestedQuestions", + "tags": [ + "チャットメッセージ" + ], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } }, - { "$ref": "#/components/parameters/UserQueryParamJp" } + { + "$ref": "#/components/parameters/UserQueryParamJp" + } ], "responses": { "200": { "description": "推奨質問リストを正常に取得しました。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/SuggestedQuestionsResponseJp" } + "schema": { + "$ref": "#/components/schemas/SuggestedQuestionsResponseJp" + } } } } @@ -417,25 +502,39 @@ "get": { "summary": "会話履歴メッセージを取得", "description": "スクロールロード形式で履歴チャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", - "operationId": "getChatflowConversationHistoryJp", - "tags": ["会話管理"], + "operationId": "getAdvancedConversationHistory", + "tags": [ + "会話管理" + ], "parameters": [ - { "$ref": "#/components/parameters/ConversationIdQueryParamJp" }, - { "$ref": "#/components/parameters/UserQueryParamJp" }, + { + "$ref": "#/components/parameters/ConversationIdQueryParamJp" + }, + { + "$ref": "#/components/parameters/UserQueryParamJp" + }, { "name": "first_id", "in": "query", "description": "現在のページの最初のチャット記録のID、デフォルトはnullです。", - "schema": { "type": "string", "format": "uuid", "nullable": true } + "schema": { + "type": "string", + "format": "uuid", + "nullable": true + } }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20Jp" } + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Jp" + } ], "responses": { "200": { "description": "会話履歴メッセージを正常に取得しました。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ConversationHistoryResponseJp" } + "schema": { + "$ref": "#/components/schemas/ConversationHistoryResponseJp" + } } } } @@ -446,20 +545,32 @@ "get": { "summary": "会話を取得", "description": "現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。", - "operationId": "getChatflowConversationsListJp", - "tags": ["会話管理"], + "operationId": "getAdvancedConversationsList", + "tags": [ + "会話管理" + ], "parameters": [ - { "$ref": "#/components/parameters/UserQueryParamJp" }, - { "$ref": "#/components/parameters/LastIdQueryParamJp" }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Jp" }, - { "$ref": "#/components/parameters/SortByQueryParamJp" } + { + "$ref": "#/components/parameters/UserQueryParamJp" + }, + { + "$ref": "#/components/parameters/LastIdQueryParamJp" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Jp" + }, + { + "$ref": "#/components/parameters/SortByQueryParamJp" + } ], "responses": { "200": { "description": "会話リストを正常に取得しました。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ConversationsListResponseJp" } + "schema": { + "$ref": "#/components/schemas/ConversationsListResponseJp" + } } } } @@ -470,54 +581,114 @@ "delete": { "summary": "会話を削除", "description": "指定された会話を削除します。", - "operationId": "deleteChatflowConversationJp", - "tags": ["会話管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJp" } ], + "operationId": "deleteAdvancedConversation", + "tags": [ + "会話管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdPathParamJp" + } + ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", "required": ["user"], - "properties": { "user": { "type": "string", "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } } + "type": "object", + "required": [ + "user" + ], + "properties": { + "user": { + "type": "string", + "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" + } + } } } } }, - "responses": { "204": { "description": "会話が正常に削除されました。コンテンツはありません。" } } + "responses": { + "204": { + "description": "会話が正常に削除されました。コンテンツはありません。" + } + } } }, "/conversations/{conversation_id}/name": { "post": { "summary": "会話の名前を変更", "description": "セッションの名前を変更します。", - "operationId": "renameChatflowConversationJp", - "tags": ["会話管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJp" } ], + "operationId": "renameAdvancedConversation", + "tags": [ + "会話管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdPathParamJp" + } + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameRequestJp" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationRenameRequestJp" + } + } + } }, "responses": { - "200": { "description": "会話の名前が正常に変更されました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameResponseJp" } } } } + "200": { + "description": "会話の名前が正常に変更されました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationRenameResponseJp" + } + } + } + } } } }, - "/conversations/{conversation_id}/variables": { + "/conversations/{conversation_id}/variables": { "get": { "summary": "会話変数の取得", "description": "特定の会話から変数を取得します。このエンドポイントは、会話中に取得された構造化データを抽出するのに役立ちます。", - "operationId": "getChatflowConversationVariablesJp", - "tags": ["会話管理"], + "operationId": "getAdvancedConversationVariables", + "tags": [ + "会話管理" + ], "parameters": [ - { "$ref": "#/components/parameters/ConversationIdPathParamJp" }, - { "$ref": "#/components/parameters/UserQueryParamJp" }, - { "$ref": "#/components/parameters/LastIdQueryParamJp" }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Jp" } + { + "$ref": "#/components/parameters/ConversationIdPathParamJp" + }, + { + "$ref": "#/components/parameters/UserQueryParamJp" + }, + { + "$ref": "#/components/parameters/LastIdQueryParamJp" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Jp" + } ], "responses": { - "200": { "description": "会話変数を正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationVariablesResponseJp" } } } }, - "404": { "$ref": "#/components/responses/ConversationNotFoundJp" } + "200": { + "description": "会話変数を正常に取得しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationVariablesResponseJp" + } + } + } + }, + "404": { + "$ref": "#/components/responses/ConversationNotFoundJp" + } } } }, @@ -525,14 +696,31 @@ "post": { "summary": "音声からテキストへ", "description": "オーディオファイルをテキストに変換します。サポートされている形式：mp3, mp4, mpeg, mpga, m4a, wav, webm。ファイルサイズ制限：15MB。", - "operationId": "chatflowAudioToTextJp", - "tags": ["音声・テキスト変換"], + "operationId": "advancedAudioToText", + "tags": [ + "音声・テキスト変換" + ], "requestBody": { "required": true, - "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioToTextRequestJp" } } } + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/AudioToTextRequestJp" + } + } + } }, "responses": { - "200": { "description": "音声をテキストに正常に変換しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioToTextResponseJp" } } } } + "200": { + "description": "音声をテキストに正常に変換しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AudioToTextResponseJp" + } + } + } + } } } }, @@ -540,17 +728,45 @@ "post": { "summary": "テキストから音声へ", "description": "テキストコンテンツを音声に変換します。", - "operationId": "chatflowTextToAudioJp", - "tags": ["音声・テキスト変換"], + "operationId": "advancedTextToAudio", + "tags": [ + "音声・テキスト変換" + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextToAudioJsonRequestJp" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TextToAudioJsonRequestJp" + } + } + } }, "responses": { "200": { "description": "音声ファイルを正常に生成しました。", - "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, - "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } + "content": { + "audio/wav": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "audio/mp3": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "Content-Type": { + "schema": { + "type": "string", + "example": "audio/wav" + } + } + } } } } @@ -558,225 +774,2186 @@ "/info": { "get": { "summary": "アプリケーションの基本情報を取得", - "operationId": "getChatflowAppInfoJp", - "tags": ["アプリケーション設定"], - "responses": { "200": { "description": "アプリケーションの基本情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseJp" } } } } } + "operationId": "getAdvancedChatAppInfo", + "tags": [ + "アプリケーション設定" + ], + "responses": { + "200": { + "description": "アプリケーションの基本情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInfoResponseJp" + } + } + } + } + } } }, "/parameters": { "get": { "summary": "アプリケーションのパラメータ情報を取得", "description": "ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。", - "operationId": "getChatflowAppParametersJp", - "tags": ["アプリケーション設定"], - "responses": { "200": { "description": "アプリケーションのパラメータ情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAppParametersResponseJp" } } } } } + "operationId": "getAdvancedChatAppParameters", + "tags": [ + "アプリケーション設定" + ], + "responses": { + "200": { + "description": "アプリケーションのパラメータ情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChatAppParametersResponseJp" + } + } + } + } + } } }, "/meta": { "get": { "summary": "アプリケーションのメタ情報を取得", "description": "このアプリケーションのツールのアイコンを取得するために使用されます。", - "operationId": "getChatflowAppMetaJp", - "tags": ["アプリケーション設定"], - "responses": { "200": { "description": "アプリケーションのメタ情報を正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMetaResponseJp" } } } } } + "operationId": "getAdvancedChatAppMeta", + "tags": [ + "アプリケーション設定" + ], + "responses": { + "200": { + "description": "アプリケーションのメタ情報を正常に取得しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppMetaResponseJp" + } + } + } + } + } } }, "/site": { "get": { "summary": "アプリのWebApp設定を取得", "description": "アプリのWebApp設定を取得するために使用します。", - "operationId": "getChatflowWebAppSettingsJp", - "tags": ["アプリケーション設定"], - "responses": { "200": { "description": "WebAppの設定情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseJp" } } } } } + "operationId": "getAdvancedChatWebAppSettings", + "tags": [ + "アプリケーション設定" + ], + "responses": { + "200": { + "description": "WebAppの設定情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebAppSettingsResponseJp" + } + } + } + } + } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "APIキー認証。すべてのAPIリクエストには、Authorization HTTPヘッダーにAPIキーを `Bearer {API_KEY}` の形式で含めてください。APIキーはサーバー側に保存し、クライアント側で共有または保存しないことを強くお勧めします。" } + "ApiKeyAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "API_KEY", + "description": "APIキー認証。すべてのAPIリクエストには、Authorization HTTPヘッダーにAPIキーを `Bearer {API_KEY}` の形式で含めてください。APIキーはサーバー側に保存し、クライアント側で共有または保存しないことを強くお勧めします。" + } }, "parameters": { - "PageQueryParamJp": { "name": "page", "in": "query", "description": "（任意）ページ番号。デフォルト値：1。", "schema": { "type": "integer", "default": 1 } }, - "LimitQueryParamJp": { "name": "limit", "in": "query", "description": "（任意）1ページあたりの件数。デフォルト値：20。", "schema": { "type": "integer", "default": 20 } }, - "LimitQueryParamDefault20Jp": { "name": "limit", "in": "query", "description": "1回のリクエストで返す記録の数、デフォルトは20です。", "schema": { "type": "integer", "default": 20 } }, - "LimitQueryParamDefault20Max100Jp": { "name": "limit", "in": "query", "description": "1回のリクエストで返す記録の数、デフォルトは最新の20件です。最大100、最小1。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, - "UserQueryParamJp": { "name": "user", "in": "query", "required": true, "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義されるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", "schema": { "type": "string" } }, - "ConversationIdQueryParamJp": { "name": "conversation_id", "in": "query", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } }, - "LastIdQueryParamJp": { "name": "last_id", "in": "query", "description": "(Optional)現在のページの最後の記録のID、デフォルトはnullです。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, - "SortByQueryParamJp": { "name": "sort_by", "in": "query", "description": "(Optional)ソートフィールド、デフォルト：-updated_at（更新時間で降順にソート）。利用可能な値：created_at, -created_at, updated_at, -updated_at。'-'は逆順を表します。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } }, - "ConversationIdPathParamJp": { "name": "conversation_id", "in": "path", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } } - }, - "responses": { - "BadRequestGenericJp": { "description": "リクエストパラメータエラー。考えられる原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "BadRequestFileJp": { "description": "ファイル操作リクエストエラー。考えられる原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "FileTooLargeJp": { "description": "ファイルが大きすぎます (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "UnsupportedFileTypeFileJp": { "description": "サポートされていないファイルタイプ (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "S3ErrorFileJp": { "description": "S3ストレージサービスエラー。考えられる原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "InternalServerErrorJp": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "SuccessResultJp": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, - "ConversationNotFoundJp": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "EndUserNotFoundJp": { "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } } - }, - "schemas": { - "ChatflowRequestJp": { - "type": "object", - "required": ["query", "user"], - "properties": { - "query": { "type": "string", "description": "ユーザー入力/質問内容。" }, - "inputs": { - "type": "object", - "description": "アプリによって定義されたさまざまな変数値の入力を許可します。変数がファイルタイプの場合、InputFileObjectJp オブジェクトを指定します。", - "additionalProperties": { - "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/components/schemas/InputFileObjectJp" } ] - }, - "default": {} - }, - "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "応答の返却モード。streaming (推奨) はSSEを使用。blocking は実行完了後に結果を返します (Cloudflareの100秒タイムアウト制限あり)。" }, - "user": { "type": "string", "description": "ユーザー識別子。アプリケーション内で一意であるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。以前のチャット記録に基づいて会話を続ける場合に必要です。" }, - "files": { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectJp" }, "description": "ファイルリスト。モデルがビジョン機能をサポートしている場合に利用可能です。" }, - "auto_generate_name": { "type": "boolean", "default": true, "description": "タイトルを自動生成。デフォルトはtrue。" } + "PageQueryParamJp": { + "name": "page", + "in": "query", + "description": "（任意）ページ番号。デフォルト値：1。", + "schema": { + "type": "integer", + "default": 1 } }, - "InputFileObjectJp": { - "type": "object", - "required": ["type", "transfer_method"], - "properties": { - "type": { "type": "string", "enum": ["document", "image", "audio", "video", "custom"], "description": "ファイルタイプ。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: その他。" }, - "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" }, - "url": { "type": "string", "format": "url", "description": "画像URL（転送方法が remote_url の場合）" }, - "upload_file_id": { "type": "string", "format":"uuid", "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" } - }, - "anyOf": [ - { - "properties": { - "transfer_method": { "enum": ["remote_url"] }, - "url": { "type": "string", "format": "url" } - }, - "required": ["url"], - "not": { "required": ["upload_file_id"] } + "LimitQueryParamJp": { + "name": "limit", + "in": "query", + "description": "（任意）1ページあたりの件数。デフォルト値：20。", + "schema": { + "type": "integer", + "default": 20 + } + }, + "LimitQueryParamDefault20Jp": { + "name": "limit", + "in": "query", + "description": "1回のリクエストで返す記録の数、デフォルトは20です。", + "schema": { + "type": "integer", + "default": 20 + } + }, + "LimitQueryParamDefault20Max100Jp": { + "name": "limit", + "in": "query", + "description": "1回のリクエストで返す記録の数、デフォルトは最新の20件です。最大100、最小1。", + "schema": { + "type": "integer", + "default": 20, + "minimum": 1, + "maximum": 100 + } + }, + "UserQueryParamJp": { + "name": "user", + "in": "query", + "required": true, + "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義されるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", + "schema": { + "type": "string" + } + }, + "ConversationIdQueryParamJp": { + "name": "conversation_id", + "in": "query", + "required": true, + "description": "会話ID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + "LastIdQueryParamJp": { + "name": "last_id", + "in": "query", + "description": "(Optional)現在のページの最後の記録のID、デフォルトはnullです。", + "schema": { + "type": "string", + "format": "uuid", + "nullable": true + } + }, + "SortByQueryParamJp": { + "name": "sort_by", + "in": "query", + "description": "(Optional)ソートフィールド、デフォルト：-updated_at（更新時間で降順にソート）。利用可能な値：created_at, -created_at, updated_at, -updated_at。'-'は逆順を表します。", + "schema": { + "type": "string", + "enum": [ + "created_at", + "-created_at", + "updated_at", + "-updated_at" + ], + "default": "-updated_at" + } + }, + "ConversationIdPathParamJp": { + "name": "conversation_id", + "in": "path", + "required": true, + "description": "会話ID。", + "schema": { + "type": "string", + "format": "uuid" + } + } + }, + "responses": { + "BadRequestGenericJp": { + "description": "リクエストパラメータエラー。考えられる原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "BadRequestFileJp": { + "description": "ファイル操作リクエストエラー。考えられる原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "FileTooLargeJp": { + "description": "ファイルが大きすぎます (file_too_large)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "UnsupportedFileTypeFileJp": { + "description": "サポートされていないファイルタイプ (unsupported_file_type)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "S3ErrorFileJp": { + "description": "S3ストレージサービスエラー。考えられる原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "InternalServerErrorJp": { + "description": "内部サーバーエラー。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "SuccessResultJp": { + "description": "操作成功。", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + } + } + } + } + } + }, + "ConversationNotFoundJp": { + "description": "会話が存在しません。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "EndUserNotFoundJp": { + "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + } + }, + "schemas": { + "ChatflowRequestJp": { + "type": "object", + "required": [ + "query", + "user" + ], + "properties": { + "query": { + "type": "string", + "description": "ユーザー入力/質問内容。" + }, + "inputs": { + "type": "object", + "description": "アプリによって定義されたさまざまな変数値の入力を許可します。変数がファイルタイプの場合、InputFileObjectJp オブジェクトを指定します。", + "additionalProperties": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "$ref": "#/components/schemas/InputFileObjectJp" + } + ] + }, + "default": {} + }, + "response_mode": { + "type": "string", + "enum": [ + "streaming", + "blocking" + ], + "default": "streaming", + "description": "応答の返却モード。streaming (推奨) はSSEを使用。blocking は実行完了後に結果を返します (Cloudflareの100秒タイムアウト制限あり)。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。アプリケーション内で一意であるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。以前のチャット記録に基づいて会話を続ける場合に必要です。" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InputFileObjectJp" + }, + "description": "ファイルリスト。モデルがビジョン機能をサポートしている場合に利用可能です。" + }, + "auto_generate_name": { + "type": "boolean", + "default": true, + "description": "タイトルを自動生成。デフォルトはtrue。" + } + } + }, + "InputFileObjectJp": { + "type": "object", + "required": [ + "type", + "transfer_method" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "document", + "image", + "audio", + "video", + "custom" + ], + "description": "ファイルタイプ。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: その他。" + }, + "transfer_method": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ], + "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" + }, + "url": { + "type": "string", + "format": "url", + "description": "画像URL（転送方法が remote_url の場合）" + }, + "upload_file_id": { + "type": "string", + "format": "uuid", + "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" + } + }, + "anyOf": [ + { + "properties": { + "transfer_method": { + "enum": [ + "remote_url" + ] + }, + "url": { + "type": "string", + "format": "url" + } + }, + "required": [ + "url" + ], + "not": { + "required": [ + "upload_file_id" + ] + } }, { - "properties": { - "transfer_method": { "enum": ["local_file"] }, - "upload_file_id": { "type": "string", "format":"uuid" } + "properties": { + "transfer_method": { + "enum": [ + "local_file" + ] + }, + "upload_file_id": { + "type": "string", + "format": "uuid" + } }, - "required": ["upload_file_id"], - "not": { "required": ["url"] } + "required": [ + "upload_file_id" + ], + "not": { + "required": [ + "url" + ] + } } ] }, "ChatCompletionResponseJp": { - "type": "object", "description": "ブロッキングモードでの完全なアプリ結果。", + "type": "object", + "description": "ブロッキングモードでの完全なアプリ結果。", "properties": { - "event": { "type": "string", "example": "message", "description": "イベントタイプ、固定で `message`。" }, - "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, - "id": { "type": "string", "format": "uuid", "description": "ユニークID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, - "mode": { "type": "string", "example": "chat", "description": "アプリモード、`chat`として固定。" }, - "answer": { "type": "string", "description": "完全な応答内容。" }, - "metadata": { "$ref": "#/components/schemas/ResponseMetadataJp" }, - "created_at": { "type": "integer", "format": "int64", "description": "メッセージ作成タイムスタンプ。" } + "event": { + "type": "string", + "example": "message", + "description": "イベントタイプ、固定で `message`。" + }, + "task_id": { + "type": "string", + "format": "uuid", + "description": "タスクID。" + }, + "id": { + "type": "string", + "format": "uuid", + "description": "ユニークID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + }, + "mode": { + "type": "string", + "example": "chat", + "description": "アプリモード、`chat`として固定。" + }, + "answer": { + "type": "string", + "description": "完全な応答内容。" + }, + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataJp" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "メッセージ作成タイムスタンプ。" + } } }, "ResponseMetadataJp": { - "type": "object", "description": "メタデータ。", - "properties": { "usage": { "$ref": "#/components/schemas/UsageJp" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJp" }, "description": "引用と帰属リスト。" } } + "type": "object", + "description": "メタデータ。", + "properties": { + "usage": { + "$ref": "#/components/schemas/UsageJp" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResourceJp" + }, + "description": "引用と帰属リスト。" + } + } }, "ChunkChatflowEventJp": { - "type": "object", "required": ["event"], - "properties": { "event": { "type": "string", "enum": ["message", "message_file", "message_end", "tts_message", "tts_message_end", "message_replace", "workflow_started", "node_started", "node_finished", "workflow_finished", "error", "ping"], "description": "イベントタイプ。" } }, - "discriminator": { "propertyName": "event", "mapping": { - "message": "#/components/schemas/StreamEventChatMessageJp", "message_file": "#/components/schemas/StreamEventMessageFileJp", - "message_end": "#/components/schemas/StreamEventMessageEndJp", "tts_message": "#/components/schemas/StreamEventTtsMessageJp", - "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJp", "message_replace": "#/components/schemas/StreamEventMessageReplaceJp", - "workflow_started": "#/components/schemas/StreamEventWorkflowStartedJp", "node_started": "#/components/schemas/StreamEventNodeStartedJp", - "node_finished": "#/components/schemas/StreamEventNodeFinishedJp", "workflow_finished": "#/components/schemas/StreamEventWorkflowFinishedJp", - "error": "#/components/schemas/StreamEventErrorJp", "ping": "#/components/schemas/StreamEventPingJp" - }} + "type": "object", + "required": [ + "event" + ], + "properties": { + "event": { + "type": "string", + "enum": [ + "message", + "message_file", + "message_end", + "tts_message", + "tts_message_end", + "message_replace", + "workflow_started", + "node_started", + "node_finished", + "workflow_finished", + "error", + "ping" + ], + "description": "イベントタイプ。" + } + }, + "discriminator": { + "propertyName": "event", + "mapping": { + "message": "#/components/schemas/StreamEventChatMessageJp", + "message_file": "#/components/schemas/StreamEventMessageFileJp", + "message_end": "#/components/schemas/StreamEventMessageEndJp", + "tts_message": "#/components/schemas/StreamEventTtsMessageJp", + "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJp", + "message_replace": "#/components/schemas/StreamEventMessageReplaceJp", + "workflow_started": "#/components/schemas/StreamEventWorkflowStartedJp", + "node_started": "#/components/schemas/StreamEventNodeStartedJp", + "node_finished": "#/components/schemas/StreamEventNodeFinishedJp", + "workflow_finished": "#/components/schemas/StreamEventWorkflowFinishedJp", + "error": "#/components/schemas/StreamEventErrorJp", + "ping": "#/components/schemas/StreamEventPingJp" + } + } }, "StreamEventBaseChatJp": { - "type": "object", "properties": { - "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, - "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } - } - }, - "StreamEventChatMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLMが返したテキストチャンク内容。" } } } ] }, - "StreamEventMessageFileJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["id", "type", "belongs_to", "url", "conversation_id"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ファイル一意ID。" }, "type": { "type": "string", "enum": ["image"], "description": "ファイルタイプ、現在はimageのみ。" }, "belongs_to": { "type": "string", "enum": ["assistant"], "description": "所属、ここではassistantのみ。" }, "url": { "type": "string", "format": "url", "description": "ファイルのリモートURL。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" } } } ] }, - "StreamEventMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataJp" } } } ] }, - "StreamEventTtsMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64エンコードされたオーディオブロック。" } } } ] }, - "StreamEventTtsMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空の文字列。" } } } ] }, - "StreamEventMessageReplaceJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "置換内容（すべてのLLM返信テキストを直接置き換えます）。" } } } ] }, - "StreamEventWorkflowStartedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/WorkflowStartedDataJp" } } } ] }, - "WorkflowStartedDataJp": { "type": "object", "required": ["id", "workflow_id", "sequence_number", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "関連ワークフローのID。" }, "sequence_number": { "type": "integer", "description": "自己増加シリアル番号、アプリ内で自己増加し、1から始まります。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, - "StreamEventNodeStartedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/NodeStartedDataJp" } } } ] }, - "NodeStartedDataJp": { "type": "object", "required": ["id", "node_id", "node_type", "title", "index", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意ID (文脈からノード実行IDであるべき)。" }, "node_id": { "type": "string", "format": "uuid", "description": "ノードのID。" }, "node_type": { "type": "string", "description": "ノードのタイプ。" }, "title": { "type": "string", "description": "ノードの名前。" }, "index": { "type": "integer", "description": "実行シーケンス番号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "オプションのプレフィックスノードID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ノードで使用されるすべての前のノード変数の内容。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始のタイムスタンプ。" } } }, - "StreamEventNodeFinishedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/NodeFinishedDataJp" } } } ] }, - "NodeFinishedDataJp": { "type": "object", "required": ["id", "node_id", "node_type", "title", "index", "status", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ノード実行の一意ID。" }, "node_id": { "type": "string", "format": "uuid", "description": "ノードのID。" }, "node_type": { "type": "string", "description": "ノードのタイプ。" }, "title": { "type": "string", "description": "ノードの名前。" }, "index": { "type": "integer", "description": "実行シーケンス番号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "オプションのプレフィックスノードID。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "ノードで使用されるすべての前のノード変数の内容。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, "description": "オプションのノードプロセスデータ (JSON)。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "オプションの出力内容 (JSON)。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行の状態。" }, "error": { "type": "string", "nullable": true, "description": "オプションのエラー理由。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "オプションの使用される合計秒数。" }, "execution_metadata": { "$ref": "#/components/schemas/NodeExecutionMetadataJp" , "nullable": true, "description": "メタデータ"}, "created_at": { "type": "integer", "format": "int64", "description": "開始のタイムスタンプ。" } } }, - "NodeExecutionMetadataJp": { "type": "object", "description": "ノード実行メタデータ。", "properties": { "total_tokens": { "type": "integer", "nullable": true, "description": "オプションの使用されるトークン数。" }, "total_price": { "type": "number", "format": "float", "nullable": true, "description": "オプションの合計コスト (floatでdecimalを代用)。" }, "currency": { "type": "string", "nullable": true, "example": "USD", "description": "オプションの通貨。" } } }, - "StreamEventWorkflowFinishedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/WorkflowFinishedDataJp" } } } ] }, - "WorkflowFinishedDataJp": { "type": "object", "required": ["id", "workflow_id", "status", "created_at", "finished_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行のID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "関連ワークフローのID。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行の状態。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "オプションの出力内容 (JSON)。" }, "error": { "type": "string", "nullable": true, "description": "オプションのエラー理由。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "オプションの使用される合計秒数。" }, "total_tokens": { "type": "integer", "nullable": true, "description": "オプションの使用されるトークン数。" }, "total_steps": { "type": "integer", "default": 0, "description": "合計ステップ数、デフォルト0。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始時間。" }, "finished_at": { "type": "integer", "format": "int64", "description": "終了時間。" } } }, - "StreamEventErrorJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "status", "code", "message"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid", "nullable": true, "description": "一意のメッセージID（エラーイベントでは存在しない場合がある）。" }, "status": { "type": "integer", "description": "HTTPステータスコード。" }, "code": { "type": "string", "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } ] }, - "StreamEventPingJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "description": "接続を維持するために10秒ごとにpingイベントが発生します。" } ] }, - "UsageJp": { "type": "object", "description": "モデル使用情報。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, - "RetrieverResourceJp": { "type": "object", "description": "引用と帰属リスト。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } }, - "FileUploadResponseJp": { "type": "object", "description": "ファイルアップロード成功時の応答。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ（バイト）。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, - "EndUserDetailJp": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, - "tenant_id": { "type": "string", "format": "uuid" }, - "app_id": { "type": "string", "format": "uuid", "nullable": true }, - "type": { "type": "string", "example": "service_api" }, - "external_user_id": { "type": "string", "nullable": true }, - "name": { "type": "string", "nullable": true }, - "is_anonymous": { "type": "boolean" }, - "session_id": { "type": "string" }, - "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { "type": "string", "format": "date-time" } - } - }, - "MessageFeedbackRequestJp": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "アップボートは`like`、ダウンボートは`dislike`、取り消しは`null`。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "content": { "type": "string", "nullable": true, "description": "メッセージフィードバックの具体的な内容。" } } }, - "AppFeedbacksResponseJp": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemJp" }, "description": "このアプリの「いいね」とフィードバックの一覧。" } } }, - "FeedbackItemJp": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, - "SuggestedQuestionsResponseJp": { "type": "object", "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "string" }, "description": "推奨質問のリスト。" } } }, - "ConversationHistoryResponseJp": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返された項目数。" }, "has_more": { "type": "boolean", "description": "次のページがあるかどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMessageItemJp" }, "description": "メッセージリスト。" } } }, - "ConversationMessageItemJp": { "type": "object", "description": "会話内の単一メッセージ。", "properties": { "id": { "type": "string", "format": "uuid", "description": "メッセージID。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ユーザー入力パラメータ。" }, "query": { "type": "string", "description": "ユーザー入力/質問内容。" }, "answer": { "type": "string", "description": "応答メッセージ内容。" }, "message_files": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFileItemJp" }, "description": "メッセージファイルリスト。" }, "feedback": { "type": "object", "nullable": true, "properties": { "rating": { "type": "string", "enum": ["like", "dislike"], "description": "アップボートは`like` / ダウンボートは`dislike`。" } }, "description": "フィードバック情報。" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJp" }, "description": "引用と帰属リスト。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, - "MessageFileItemJp": { "type": "object", "description": "メッセージ内のファイル項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "ファイルタイプ、例：'image'。" }, "url": { "type": "string", "format": "url", "description": "プレビュー画像URL。" }, "belongs_to": { "type": "string", "enum": ["user", "assistant"], "description": "所属。" } } }, - "ConversationsListResponseJp": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返されたエントリ数。" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationListItemJp" }, "description": "会話のリスト。" } } }, - "ConversationListItemJp": { "type": "object", "description": "会話リスト内の単一項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "会話ID。" }, "name": { "type": "string", "description": "会話名。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ユーザー入力パラメータ。" }, "status": { "type": "string", "description": "会話状態。" }, "introduction": { "type": "string", "nullable": true, "description": "紹介。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, "updated_at": { "type": "integer", "format": "int64", "description": "更新タイムスタンプ。" } } }, - "ConversationRenameRequestJp": { "type": "object", "required": ["user"], "properties": { "name": { "type": "string", "nullable": true, "description": "(Optional)会話の名前。`auto_generate`が`true`の場合省略可。" }, "auto_generate": { "type": "boolean", "default": false, "description": "(Optional)タイトルを自動生成、デフォルトは`false`。" }, "user": { "type": "string", "description": "ユーザー識別子。" } } }, - "ConversationRenameResponseJp": { "$ref": "#/components/schemas/ConversationListItemJp" }, - "ConversationVariablesResponseJp": { "type": "object", "properties": { "limit": { "type": "integer", "description": "ページごとのアイテム数。" }, "has_more": { "type": "boolean", "description": "さらにアイテムがあるかどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationVariableItemJp" }, "description": "変数のリスト。" } } }, - "ConversationVariableItemJp": { "type": "object", "description": "会話内の変数項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "変数ID。" }, "name": { "type": "string", "description": "変数名。" }, "value_type": { "type": "string", "description": "変数タイプ（文字列、数値、真偽値など）。" }, "value": { "type": "string", "description": "変数値。" }, "description": { "type": "string", "nullable": true, "description": "変数の説明。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, "updated_at": { "type": "integer", "format": "int64", "description": "最終更新タイムスタンプ。" } } }, - "AudioToTextRequestJp": { "type": "object", "required": ["file", "user"], "properties": { "file": { "type": "string", "format": "binary", "description": "オーディオファイル。サポート形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`。サイズ制限：15MB。" }, "user": { "type": "string", "description": "ユーザー識別子。" } } }, - "AudioToTextResponseJp": { "type": "object", "properties": { "text": { "type": "string", "description": "出力テキスト。" } } }, - "TextToAudioJsonRequestJp": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "メッセージID（優先）。" }, "text": { "type": "string", "description": "音声生成コンテンツ。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "streaming": {"type": "boolean", "default": false, "description": "trueの場合、応答はオーディオチャンクのストリームになります。"} }, "description": "`user` が必要です。`message_id` または `text` を提供してください。" }, - "AppInfoResponseJp": { "type": "object", "description": "アプリケーションの基本情報。", "properties": { "name": { "type": "string", "description": "アプリケーションの名前。" }, "description": { "type": "string", "description": "アプリケーションの説明。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "アプリケーションのタグ。" } } }, - "ChatAppParametersResponseJp": { "type": "object", "description": "アプリケーションのパラメータ情報。", "properties": { "opening_statement": { "type": "string", "description": "開始の挨拶。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "開始時の推奨質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "答えを有効にした後の質問を提案します。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "音声からテキストへ。" }, "text_to_speech": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" }, "voice": { "type": "string", "description": "音声タイプ。" }, "language": { "type": "string", "description": "言語。" }, "autoPlay": { "type": "string", "enum": ["enabled", "disabled"], "description": "自動再生：enabled 有効, disabled 無効。" } }, "description": "テキストから音声へ。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "引用と帰属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "注釈返信。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemJp" }, "description": "ユーザー入力フォームの設定。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "detail": { "type": "string" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "画像設定。サポートされている画像タイプ：png, jpg, jpeg, webp, gif。" } }, "description": "ファイルアップロード設定。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "ドキュメントアップロードサイズ制限（MB）。" }, "image_file_size_limit": { "type": "integer", "description": "画像ファイルアップロードサイズ制限（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "オーディオファイルアップロードサイズ制限（MB）。" }, "video_file_size_limit": { "type": "integer", "description": "ビデオファイルアップロードサイズ制限（MB）。" } }, "description": "システムパラメータ。" } } }, - "UserInputFormItemJp": { "type": "object", "description": "ユーザー入力フォームのコントロール項目。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperJp" }, { "$ref": "#/components/schemas/ParagraphControlWrapperJp" }, { "$ref": "#/components/schemas/SelectControlWrapperJp" } ] }, - "TextInputControlWrapperJp": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlJp" } }, "required":["text-input"] }, - "ParagraphControlWrapperJp": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlJp" } }, "required":["paragraph"] }, - "SelectControlWrapperJp": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlJp" } }, "required":["select"] }, - "TextInputControlJp": { "type": "object", "description": "テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, - "ParagraphControlJp": { "type": "object", "description": "段落テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, - "SelectControlJp": { "type": "object", "description": "ドロップダウンコントロール。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "オプション値。" } } }, - "AppMetaResponseJp": { "type": "object", "description": "アプリケーションのメタ情報。", "properties": { "tool_icons": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "format": "url", "description": "アイコンのURL。" }, { "$ref": "#/components/schemas/ToolIconDetailJp" } ] }, "description": "ツールアイコン。キーはツール名です。" } } }, - "ToolIconDetailJp": { "type": "object", "description": "ツールアイコン詳細。", "properties": { "background": { "type": "string", "description": "背景色（16進数形式）。" }, "content": { "type": "string", "description": "絵文字。" } } }, - "WebAppSettingsResponseJp": { "type": "object", "description": "アプリのWebApp設定。", "properties": { "title": { "type": "string", "description": "WebApp名。" }, "chat_color_theme": { "type": "string", "description": "チャットの色テーマ、16進数形式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "チャットの色テーマを反転するかどうか。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "アイコンタイプ。" }, "icon": { "type": "string", "description": "アイコン。`emoji`タイプの場合は絵文字、`image`タイプの場合は画像URL。" }, "icon_background": { "type": "string", "description": "16進数形式の背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "アイコンのURL。" }, "description": { "type": "string", "description": "説明。" }, "copyright": { "type": "string", "description": "著作権情報。" }, "privacy_policy": { "type": "string", "description": "プライバシーポリシーのリンク。" }, "custom_disclaimer": { "type": "string", "description": "カスタム免責事項。" }, "default_language": { "type": "string", "description": "デフォルト言語。" }, "show_workflow_steps": { "type": "boolean", "description": "ワークフローの詳細を表示するかどうか。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "WebAppのアイコンをチャット内のロボットアイコンに置き換えるかどうか。" } } }, - "ErrorResponseJp": { "type": "object", "description": "エラー応答。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTPステータスコード。" }, "code": { "type": "string", "nullable": true, "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } - } - }, - "tags": [ - { "name": "チャットメッセージ", "description": "チャットメッセージとインタラクションに関連する操作。" }, - { "name": "ファイル操作", "description": "ファイルアップロードとプレビューに関連する操作。" }, - { "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" }, - { "name": "メッセージフィードバック", "description": "ユーザーメッセージへのフィードバック操作。" }, - { "name": "会話管理", "description": "会話セッションの管理に関連する操作。" }, - { "name": "音声・テキスト変換", "description": "テキストから音声へ、音声からテキストへの変換操作。" }, - { "name": "アプリケーション設定", "description": "アプリケーション設定と情報の取得に関連する操作。" } + "task_id": { + "type": "string", + "format": "uuid", + "description": "タスクID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, + "StreamEventChatMessageJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJp" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "LLMが返したテキストチャンク内容。" + } + } + } + ] + }, + "StreamEventMessageFileJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "type": "object", + "required": [ + "id", + "type", + "belongs_to", + "url", + "conversation_id" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ファイル一意ID。" + }, + "type": { + "type": "string", + "enum": [ + "image" + ], + "description": "ファイルタイプ、現在はimageのみ。" + }, + "belongs_to": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "所属、ここではassistantのみ。" + }, + "url": { + "type": "string", + "format": "url", + "description": "ファイルのリモートURL。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + } + } + } + ] + }, + "StreamEventMessageEndJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJp" + }, + { + "type": "object", + "required": [ + "metadata" + ], + "properties": { + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataJp" + } + } + } + ] + }, + "StreamEventTtsMessageJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJp" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "format": "byte", + "description": "Base64エンコードされたオーディオブロック。" + } + } + } + ] + }, + "StreamEventTtsMessageEndJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJp" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "description": "空の文字列。" + } + } + } + ] + }, + "StreamEventMessageReplaceJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatJp" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "置換内容（すべてのLLM返信テキストを直接置き換えます）。" + } + } + } + ] + }, + "StreamEventWorkflowStartedJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "type": "object", + "required": [ + "task_id", + "workflow_run_id", + "data" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid" + }, + "data": { + "$ref": "#/components/schemas/WorkflowStartedDataJp" + } + } + } + ] + }, + "WorkflowStartedDataJp": { + "type": "object", + "required": [ + "id", + "workflow_id", + "sequence_number", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ワークフロー実行の一意ID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "関連ワークフローのID。" + }, + "sequence_number": { + "type": "integer", + "description": "自己増加シリアル番号、アプリ内で自己増加し、1から始まります。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, + "StreamEventNodeStartedJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "type": "object", + "required": [ + "task_id", + "workflow_run_id", + "data" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid" + }, + "data": { + "$ref": "#/components/schemas/NodeStartedDataJp" + } + } + } + ] + }, + "NodeStartedDataJp": { + "type": "object", + "required": [ + "id", + "node_id", + "node_type", + "title", + "index", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ワークフロー実行の一意ID (文脈からノード実行IDであるべき)。" + }, + "node_id": { + "type": "string", + "format": "uuid", + "description": "ノードのID。" + }, + "node_type": { + "type": "string", + "description": "ノードのタイプ。" + }, + "title": { + "type": "string", + "description": "ノードの名前。" + }, + "index": { + "type": "integer", + "description": "実行シーケンス番号。" + }, + "predecessor_node_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "オプションのプレフィックスノードID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "ノードで使用されるすべての前のノード変数の内容。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "開始のタイムスタンプ。" + } + } + }, + "StreamEventNodeFinishedJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "type": "object", + "required": [ + "task_id", + "workflow_run_id", + "data" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid" + }, + "data": { + "$ref": "#/components/schemas/NodeFinishedDataJp" + } + } + } + ] + }, + "NodeFinishedDataJp": { + "type": "object", + "required": [ + "id", + "node_id", + "node_type", + "title", + "index", + "status", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ノード実行の一意ID。" + }, + "node_id": { + "type": "string", + "format": "uuid", + "description": "ノードのID。" + }, + "node_type": { + "type": "string", + "description": "ノードのタイプ。" + }, + "title": { + "type": "string", + "description": "ノードの名前。" + }, + "index": { + "type": "integer", + "description": "実行シーケンス番号。" + }, + "predecessor_node_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "オプションのプレフィックスノードID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "ノードで使用されるすべての前のノード変数の内容。" + }, + "process_data": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "オプションのノードプロセスデータ (JSON)。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "オプションの出力内容 (JSON)。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "実行の状態。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "オプションのエラー理由。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "オプションの使用される合計秒数。" + }, + "execution_metadata": { + "$ref": "#/components/schemas/NodeExecutionMetadataJp", + "nullable": true, + "description": "メタデータ" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "開始のタイムスタンプ。" + } + } + }, + "NodeExecutionMetadataJp": { + "type": "object", + "description": "ノード実行メタデータ。", + "properties": { + "total_tokens": { + "type": "integer", + "nullable": true, + "description": "オプションの使用されるトークン数。" + }, + "total_price": { + "type": "number", + "format": "float", + "nullable": true, + "description": "オプションの合計コスト (floatでdecimalを代用)。" + }, + "currency": { + "type": "string", + "nullable": true, + "example": "USD", + "description": "オプションの通貨。" + } + } + }, + "StreamEventWorkflowFinishedJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "type": "object", + "required": [ + "task_id", + "workflow_run_id", + "data" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid" + }, + "data": { + "$ref": "#/components/schemas/WorkflowFinishedDataJp" + } + } + } + ] + }, + "WorkflowFinishedDataJp": { + "type": "object", + "required": [ + "id", + "workflow_id", + "status", + "created_at", + "finished_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ワークフロー実行のID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "関連ワークフローのID。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "実行の状態。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "オプションの出力内容 (JSON)。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "オプションのエラー理由。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "オプションの使用される合計秒数。" + }, + "total_tokens": { + "type": "integer", + "nullable": true, + "description": "オプションの使用されるトークン数。" + }, + "total_steps": { + "type": "integer", + "default": 0, + "description": "合計ステップ数、デフォルト0。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "開始時間。" + }, + "finished_at": { + "type": "integer", + "format": "int64", + "description": "終了時間。" + } + } + }, + "StreamEventErrorJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "type": "object", + "required": [ + "task_id", + "status", + "code", + "message" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "message_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "一意のメッセージID（エラーイベントでは存在しない場合がある）。" + }, + "status": { + "type": "integer", + "description": "HTTPステータスコード。" + }, + "code": { + "type": "string", + "description": "エラーコード。" + }, + "message": { + "type": "string", + "description": "エラーメッセージ。" + } + } + } + ] + }, + "StreamEventPingJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatflowEventJp" + }, + { + "type": "object", + "description": "接続を維持するために10秒ごとにpingイベントが発生します。" + } + ] + }, + "UsageJp": { + "type": "object", + "description": "モデル使用情報。", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "prompt_unit_price": { + "type": "string" + }, + "prompt_price_unit": { + "type": "string" + }, + "prompt_price": { + "type": "string" + }, + "completion_tokens": { + "type": "integer" + }, + "completion_unit_price": { + "type": "string" + }, + "completion_price_unit": { + "type": "string" + }, + "completion_price": { + "type": "string" + }, + "total_tokens": { + "type": "integer" + }, + "total_price": { + "type": "string" + }, + "currency": { + "type": "string" + }, + "latency": { + "type": "number", + "format": "double" + } + } + }, + "RetrieverResourceJp": { + "type": "object", + "description": "引用と帰属リスト。", + "properties": { + "position": { + "type": "integer" + }, + "dataset_id": { + "type": "string", + "format": "uuid" + }, + "dataset_name": { + "type": "string" + }, + "document_id": { + "type": "string", + "format": "uuid" + }, + "document_name": { + "type": "string" + }, + "segment_id": { + "type": "string", + "format": "uuid" + }, + "score": { + "type": "number", + "format": "float" + }, + "content": { + "type": "string" + } + } + }, + "FileUploadResponseJp": { + "type": "object", + "description": "ファイルアップロード成功時の応答。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "name": { + "type": "string", + "description": "ファイル名。" + }, + "size": { + "type": "integer", + "description": "ファイルサイズ（バイト）。" + }, + "extension": { + "type": "string", + "description": "ファイル拡張子。" + }, + "mime_type": { + "type": "string", + "description": "ファイルのMIMEタイプ。" + }, + "created_by": { + "type": "string", + "format": "uuid", + "description": "エンドユーザーID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, + "EndUserDetailJp": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "tenant_id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "type": { + "type": "string", + "example": "service_api" + }, + "external_user_id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "is_anonymous": { + "type": "boolean" + }, + "session_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "MessageFeedbackRequestJp": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true, + "description": "アップボートは`like`、ダウンボートは`dislike`、取り消しは`null`。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + }, + "content": { + "type": "string", + "nullable": true, + "description": "メッセージフィードバックの具体的な内容。" + } + } + }, + "AppFeedbacksResponseJp": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeedbackItemJp" + }, + "description": "このアプリの「いいね」とフィードバックの一覧。" + } + } + }, + "FeedbackItemJp": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid" + }, + "conversation_id": { + "type": "string", + "format": "uuid" + }, + "message_id": { + "type": "string", + "format": "uuid" + }, + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true + }, + "content": { + "type": "string" + }, + "from_source": { + "type": "string" + }, + "from_end_user_id": { + "type": "string", + "format": "uuid" + }, + "from_account_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "SuggestedQuestionsResponseJp": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + }, + "data": { + "type": "array", + "items": { + "type": "string" + }, + "description": "推奨質問のリスト。" + } + } + }, + "ConversationHistoryResponseJp": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "返された項目数。" + }, + "has_more": { + "type": "boolean", + "description": "次のページがあるかどうか。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationMessageItemJp" + }, + "description": "メッセージリスト。" + } + } + }, + "ConversationMessageItemJp": { + "type": "object", + "description": "会話内の単一メッセージ。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "メッセージID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "ユーザー入力パラメータ。" + }, + "query": { + "type": "string", + "description": "ユーザー入力/質問内容。" + }, + "answer": { + "type": "string", + "description": "応答メッセージ内容。" + }, + "message_files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageFileItemJp" + }, + "description": "メッセージファイルリスト。" + }, + "feedback": { + "type": "object", + "nullable": true, + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike" + ], + "description": "アップボートは`like` / ダウンボートは`dislike`。" + } + }, + "description": "フィードバック情報。" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResourceJp" + }, + "description": "引用と帰属リスト。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, + "MessageFileItemJp": { + "type": "object", + "description": "メッセージ内のファイル項目。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "type": { + "type": "string", + "description": "ファイルタイプ、例：'image'。" + }, + "url": { + "type": "string", + "format": "url", + "description": "プレビュー画像URL。" + }, + "belongs_to": { + "type": "string", + "enum": [ + "user", + "assistant" + ], + "description": "所属。" + } + } + }, + "ConversationsListResponseJp": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "返されたエントリ数。" + }, + "has_more": { + "type": "boolean" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationListItemJp" + }, + "description": "会話のリスト。" + } + } + }, + "ConversationListItemJp": { + "type": "object", + "description": "会話リスト内の単一項目。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "会話ID。" + }, + "name": { + "type": "string", + "description": "会話名。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "ユーザー入力パラメータ。" + }, + "status": { + "type": "string", + "description": "会話状態。" + }, + "introduction": { + "type": "string", + "nullable": true, + "description": "紹介。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + }, + "updated_at": { + "type": "integer", + "format": "int64", + "description": "更新タイムスタンプ。" + } + } + }, + "ConversationRenameRequestJp": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "name": { + "type": "string", + "nullable": true, + "description": "(Optional)会話の名前。`auto_generate`が`true`の場合省略可。" + }, + "auto_generate": { + "type": "boolean", + "default": false, + "description": "(Optional)タイトルを自動生成、デフォルトは`false`。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + } + } + }, + "ConversationRenameResponseJp": { + "$ref": "#/components/schemas/ConversationListItemJp" + }, + "ConversationVariablesResponseJp": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "ページごとのアイテム数。" + }, + "has_more": { + "type": "boolean", + "description": "さらにアイテムがあるかどうか。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationVariableItemJp" + }, + "description": "変数のリスト。" + } + } + }, + "ConversationVariableItemJp": { + "type": "object", + "description": "会話内の変数項目。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "変数ID。" + }, + "name": { + "type": "string", + "description": "変数名。" + }, + "value_type": { + "type": "string", + "description": "変数タイプ（文字列、数値、真偽値など）。" + }, + "value": { + "type": "string", + "description": "変数値。" + }, + "description": { + "type": "string", + "nullable": true, + "description": "変数の説明。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + }, + "updated_at": { + "type": "integer", + "format": "int64", + "description": "最終更新タイムスタンプ。" + } + } + }, + "AudioToTextRequestJp": { + "type": "object", + "required": [ + "file", + "user" + ], + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "オーディオファイル。サポート形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`。サイズ制限：15MB。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + } + } + }, + "AudioToTextResponseJp": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "出力テキスト。" + } + } + }, + "TextToAudioJsonRequestJp": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "message_id": { + "type": "string", + "format": "uuid", + "description": "メッセージID（優先）。" + }, + "text": { + "type": "string", + "description": "音声生成コンテンツ。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + }, + "streaming": { + "type": "boolean", + "default": false, + "description": "trueの場合、応答はオーディオチャンクのストリームになります。" + } + }, + "description": "`user` が必要です。`message_id` または `text` を提供してください。" + }, + "AppInfoResponseJp": { + "type": "object", + "description": "アプリケーションの基本情報。", + "properties": { + "name": { + "type": "string", + "description": "アプリケーションの名前。" + }, + "description": { + "type": "string", + "description": "アプリケーションの説明。" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "アプリケーションのタグ。" + } + } + }, + "ChatAppParametersResponseJp": { + "type": "object", + "description": "アプリケーションのパラメータ情報。", + "properties": { + "opening_statement": { + "type": "string", + "description": "開始の挨拶。" + }, + "suggested_questions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "開始時の推奨質問のリスト。" + }, + "suggested_questions_after_answer": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + } + }, + "description": "答えを有効にした後の質問を提案します。" + }, + "speech_to_text": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + } + }, + "description": "音声からテキストへ。" + }, + "text_to_speech": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + }, + "voice": { + "type": "string", + "description": "音声タイプ。" + }, + "language": { + "type": "string", + "description": "言語。" + }, + "autoPlay": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "description": "自動再生：enabled 有効, disabled 無効。" + } + }, + "description": "テキストから音声へ。" + }, + "retriever_resource": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + } + }, + "description": "引用と帰属。" + }, + "annotation_reply": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "有効かどうか。" + } + }, + "description": "注釈返信。" + }, + "user_input_form": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserInputFormItemJp" + }, + "description": "ユーザー入力フォームの設定。" + }, + "file_upload": { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "number_limits": { + "type": "integer" + }, + "detail": { + "type": "string" + }, + "transfer_methods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ] + } + } + }, + "description": "画像設定。サポートされている画像タイプ：png, jpg, jpeg, webp, gif。" + } + }, + "description": "ファイルアップロード設定。" + }, + "system_parameters": { + "type": "object", + "properties": { + "file_size_limit": { + "type": "integer", + "description": "ドキュメントアップロードサイズ制限（MB）。" + }, + "image_file_size_limit": { + "type": "integer", + "description": "画像ファイルアップロードサイズ制限（MB）。" + }, + "audio_file_size_limit": { + "type": "integer", + "description": "オーディオファイルアップロードサイズ制限（MB）。" + }, + "video_file_size_limit": { + "type": "integer", + "description": "ビデオファイルアップロードサイズ制限（MB）。" + } + }, + "description": "システムパラメータ。" + } + } + }, + "UserInputFormItemJp": { + "type": "object", + "description": "ユーザー入力フォームのコントロール項目。", + "oneOf": [ + { + "$ref": "#/components/schemas/TextInputControlWrapperJp" + }, + { + "$ref": "#/components/schemas/ParagraphControlWrapperJp" + }, + { + "$ref": "#/components/schemas/SelectControlWrapperJp" + } + ] + }, + "TextInputControlWrapperJp": { + "type": "object", + "properties": { + "text-input": { + "$ref": "#/components/schemas/TextInputControlJp" + } + }, + "required": [ + "text-input" + ] + }, + "ParagraphControlWrapperJp": { + "type": "object", + "properties": { + "paragraph": { + "$ref": "#/components/schemas/ParagraphControlJp" + } + }, + "required": [ + "paragraph" + ] + }, + "SelectControlWrapperJp": { + "type": "object", + "properties": { + "select": { + "$ref": "#/components/schemas/SelectControlJp" + } + }, + "required": [ + "select" + ] + }, + "TextInputControlJp": { + "type": "object", + "description": "テキスト入力コントロール。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + } + } + }, + "ParagraphControlJp": { + "type": "object", + "description": "段落テキスト入力コントロール。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + } + } + }, + "SelectControlJp": { + "type": "object", + "description": "ドロップダウンコントロール。", + "required": [ + "label", + "variable", + "required", + "options" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + }, + "options": { + "type": "array", + "items": { + "type": "string" + }, + "description": "オプション値。" + } + } + }, + "AppMetaResponseJp": { + "type": "object", + "description": "アプリケーションのメタ情報。", + "properties": { + "tool_icons": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "string", + "format": "url", + "description": "アイコンのURL。" + }, + { + "$ref": "#/components/schemas/ToolIconDetailJp" + } + ] + }, + "description": "ツールアイコン。キーはツール名です。" + } + } + }, + "ToolIconDetailJp": { + "type": "object", + "description": "ツールアイコン詳細。", + "properties": { + "background": { + "type": "string", + "description": "背景色（16進数形式）。" + }, + "content": { + "type": "string", + "description": "絵文字。" + } + } + }, + "WebAppSettingsResponseJp": { + "type": "object", + "description": "アプリのWebApp設定。", + "properties": { + "title": { + "type": "string", + "description": "WebApp名。" + }, + "chat_color_theme": { + "type": "string", + "description": "チャットの色テーマ、16進数形式。" + }, + "chat_color_theme_inverted": { + "type": "boolean", + "description": "チャットの色テーマを反転するかどうか。" + }, + "icon_type": { + "type": "string", + "enum": [ + "emoji", + "image" + ], + "description": "アイコンタイプ。" + }, + "icon": { + "type": "string", + "description": "アイコン。`emoji`タイプの場合は絵文字、`image`タイプの場合は画像URL。" + }, + "icon_background": { + "type": "string", + "description": "16進数形式の背景色。" + }, + "icon_url": { + "type": "string", + "format": "url", + "nullable": true, + "description": "アイコンのURL。" + }, + "description": { + "type": "string", + "description": "説明。" + }, + "copyright": { + "type": "string", + "description": "著作権情報。" + }, + "privacy_policy": { + "type": "string", + "description": "プライバシーポリシーのリンク。" + }, + "custom_disclaimer": { + "type": "string", + "description": "カスタム免責事項。" + }, + "default_language": { + "type": "string", + "description": "デフォルト言語。" + }, + "show_workflow_steps": { + "type": "boolean", + "description": "ワークフローの詳細を表示するかどうか。" + }, + "use_icon_as_answer_icon": { + "type": "boolean", + "description": "WebAppのアイコンをチャット内のロボットアイコンに置き換えるかどうか。" + } + } + }, + "ErrorResponseJp": { + "type": "object", + "description": "エラー応答。", + "properties": { + "status": { + "type": "integer", + "nullable": true, + "description": "HTTPステータスコード。" + }, + "code": { + "type": "string", + "nullable": true, + "description": "エラーコード。" + }, + "message": { + "type": "string", + "description": "エラーメッセージ。" + } + } + } + } + }, + "tags": [ + { + "name": "チャットメッセージ", + "description": "チャットメッセージとインタラクションに関連する操作。" + }, + { + "name": "ファイル操作", + "description": "ファイルアップロードとプレビューに関連する操作。" + }, + { + "name": "エンドユーザー", + "description": "エンドユーザー情報に関連する操作。" + }, + { + "name": "メッセージフィードバック", + "description": "ユーザーメッセージへのフィードバック操作。" + }, + { + "name": "会話管理", + "description": "会話セッションの管理に関連する操作。" + }, + { + "name": "音声・テキスト変換", + "description": "テキストから音声へ、音声からテキストへの変換操作。" + }, + { + "name": "アプリケーション設定", + "description": "アプリケーション設定と情報の取得に関連する操作。" + } ] -} \ No newline at end of file +} diff --git a/ja/api-reference/openapi_completion.json b/ja/api-reference/openapi_completion.json index ad6948204..df6413386 100644 --- a/ja/api-reference/openapi_completion.json +++ b/ja/api-reference/openapi_completion.json @@ -27,8 +27,10 @@ "post": { "summary": "完了メッセージの作成", "description": "テキスト生成アプリケーションにリクエストを送信します。", - "operationId": "createCompletionMessageJp", - "tags": ["完了メッセージ"], + "operationId": "createCompletionMessage", + "tags": [ + "完了メッセージ" + ], "requestBody": { "description": "完了メッセージを作成するためのリクエストボディ。", "required": true, @@ -41,7 +43,9 @@ "streaming_example_jp": { "summary": "ストリーミングモードの例", "value": { - "inputs": {"query": "こんにちは、世界！"}, + "inputs": { + "query": "こんにちは、世界！" + }, "response_mode": "streaming", "user": "jp_user_123" } @@ -67,9 +71,15 @@ } } }, - "400": { "$ref": "#/components/responses/BadRequestGenericJp" }, - "404": { "$ref": "#/components/responses/ConversationNotFoundJp" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + "400": { + "$ref": "#/components/responses/BadRequestGenericJp" + }, + "404": { + "$ref": "#/components/responses/ConversationNotFoundJp" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJp" + } } } }, @@ -77,8 +87,10 @@ "post": { "summary": "ファイルアップロード", "description": "メッセージ送信時に使用するファイル（現在は画像のみ対応）をアップロードし、画像とテキストのマルチモーダルな理解を可能にします。png、jpg、jpeg、webp、gif形式に対応しています。アップロードされたファイルは、現在のエンドユーザーのみが使用できます。", - "operationId": "uploadCompletionFileJp", - "tags": ["ファイル操作"], + "operationId": "uploadFile", + "tags": [ + "ファイル操作" + ], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data` 形式が必要です。", "required": true, @@ -86,23 +98,61 @@ "multipart/form-data": { "schema": { "type": "object", - "required": ["file", "user"], + "required": [ + "file", + "user" + ], "properties": { - "file": { "type": "string", "format": "binary", "description": "アップロードするファイル。" }, - "user": { "type": "string", "description": "開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。" } + "file": { + "type": "string", + "format": "binary", + "description": "アップロードするファイル。" + }, + "user": { + "type": "string", + "description": "開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。" + } } } } } }, "responses": { - "200": { "description": "ファイルアップロード成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } }, - "201": { "description": "ファイル作成成功（代替成功コード）。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } }, - "400": { "$ref": "#/components/responses/BadRequestFileJp" }, - "413": { "$ref": "#/components/responses/FileTooLargeJp" }, - "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileJp" }, - "503": { "$ref": "#/components/responses/S3ErrorFileJp" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + "200": { + "description": "ファイルアップロード成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseJp" + } + } + } + }, + "201": { + "description": "ファイル作成成功（代替成功コード）。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseJp" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequestFileJp" + }, + "413": { + "$ref": "#/components/responses/FileTooLargeJp" + }, + "415": { + "$ref": "#/components/responses/UnsupportedFileTypeFileJp" + }, + "503": { + "$ref": "#/components/responses/S3ErrorFileJp" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJp" + } } } }, @@ -110,15 +160,20 @@ "get": { "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", - "operationId": "getEndUserCompletionJp", - "tags": ["エンドユーザー"], + "operationId": "getEndUserCompletion", + "tags": [ + "エンドユーザー" + ], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "エンドユーザーID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -126,12 +181,18 @@ "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/EndUserDetailJp" } + "schema": { + "$ref": "#/components/schemas/EndUserDetailJp" + } } } }, - "404": { "$ref": "#/components/responses/EndUserNotFoundJp" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + "404": { + "$ref": "#/components/responses/EndUserNotFoundJp" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJp" + } } } }, @@ -139,53 +200,170 @@ "post": { "summary": "生成の停止", "description": "完了メッセージの生成を停止します。ストリーミングモードでのみサポートされています。", - "operationId": "stopCompletionGenerationJp", - "tags": ["完了メッセージ"], + "operationId": "stopGenerate", + "tags": [ + "完了メッセージ" + ], "parameters": [ - { "name": "task_id", "in": "path", "required": true, "description": "タスクID、ストリーミングチャンクの返信から取得可能。", "schema": { "type": "string", "format": "uuid" } } + { + "name": "task_id", + "in": "path", + "required": true, + "description": "タスクID、ストリーミングチャンクの返信から取得可能。", + "schema": { + "type": "string", + "format": "uuid" + } + } ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致する必要があります。" } } } } } + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "user": { + "type": "string", + "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致する必要があります。" + } + } + } + } + } }, - "responses": { "200": { "$ref": "#/components/responses/SuccessResultJp" } } + "responses": { + "200": { + "$ref": "#/components/responses/SuccessResultJp" + } + } } }, "/messages/{message_id}/feedbacks": { "post": { "summary": "メッセージフィードバック", "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。", - "operationId": "postCompletionMessageFeedbackJp", - "tags": ["メッセージフィードバック"], - "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", "schema": { "type": "string", "format": "uuid" } } ], - "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestJp" } } } }, - "responses": { "200": { "$ref": "#/components/responses/SuccessResultJp" } } + "operationId": "postMessageFeedback", + "tags": [ + "メッセージフィードバック" + ], + "parameters": [ + { + "name": "message_id", + "in": "path", + "required": true, + "description": "メッセージID。", + "schema": { + "type": "string", + "format": "uuid" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MessageFeedbackRequestJp" + } + } + } + }, + "responses": { + "200": { + "$ref": "#/components/responses/SuccessResultJp" + } + } } }, "/app/feedbacks": { "get": { "summary": "アプリのメッセージの「いいね」とフィードバックを取得", "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", - "operationId": "getAppFeedbacksCompletionJp", - "tags": ["メッセージフィードバック"], + "operationId": "getAppFeedbacks", + "tags": [ + "メッセージフィードバック" + ], "parameters": [ - { "name": "page", "in": "query", "description": "（任意）ページ番号。デフォルト値：1。", "schema": { "type": "integer", "default": 1 } }, - { "name": "limit", "in": "query", "description": "（任意）1ページあたりの件数。デフォルト値：20。", "schema": { "type": "integer", "default": 20 } } + { + "name": "page", + "in": "query", + "description": "（任意）ページ番号。デフォルト値：1。", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "limit", + "in": "query", + "description": "（任意）1ページあたりの件数。デフォルト値：20。", + "schema": { + "type": "integer", + "default": 20 + } + } ], - "responses": { "200": { "description": "フィードバックリストの取得成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseJp" } } } } } + "responses": { + "200": { + "description": "フィードバックリストの取得成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFeedbacksResponseJp" + } + } + } + } + } } }, "/text-to-audio": { "post": { "summary": "テキストから音声", "description": "テキストを音声に変換します。", - "operationId": "textToAudioCompletionJp", - "tags": ["音声変換"], - "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextToAudioRequestJp" } } } }, + "operationId": "textToAudio", + "tags": [ + "音声変換" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TextToAudioRequestJp" + } + } + } + }, "responses": { "200": { - "description": "音声ファイル生成成功。", "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, - "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } + "description": "音声ファイル生成成功。", + "content": { + "audio/wav": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "audio/mp3": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "Content-Type": { + "schema": { + "type": "string", + "example": "audio/wav" + } + } + } } } } @@ -193,146 +371,1188 @@ "/info": { "get": { "summary": "アプリケーションの基本情報を取得", - "operationId": "getCompletionAppInfoJp", - "tags": ["アプリケーション情報"], - "responses": { "200": { "description": "アプリケーション基本情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseJp" } } } } } + "operationId": "getAppInfo", + "tags": [ + "アプリケーション情報" + ], + "responses": { + "200": { + "description": "アプリケーション基本情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInfoResponseJp" + } + } + } + } + } } }, "/parameters": { "get": { "summary": "アプリケーションのパラメータ情報を取得", - "operationId": "getCompletionAppParametersJp", - "tags": ["アプリケーション情報"], - "responses": { "200": { "description": "アプリケーションパラメータ情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletionAppParametersResponseJp" } } } } } + "operationId": "getAppParameters", + "tags": [ + "アプリケーション情報" + ], + "responses": { + "200": { + "description": "アプリケーションパラメータ情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CompletionAppParametersResponseJp" + } + } + } + } + } } }, "/site": { "get": { "summary": "アプリのWebApp設定を取得", - "operationId": "getCompletionWebAppSettingsJp", - "tags": ["アプリケーション情報"], - "responses": { "200": { "description": "WebApp設定。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseJp" } } } } } + "operationId": "getWebAppSettings", + "tags": [ + "アプリケーション情報" + ], + "responses": { + "200": { + "description": "WebApp設定。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebAppSettingsResponseJp" + } + } + } + } + } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key認証。すべてのAPIリクエストで、`Authorization` HTTPヘッダーに `Bearer {API_KEY}` の形式でAPIキーを含めてください。APIキーの漏洩を避けるため、サーバーサイドでの保存を強く推奨します。" } + "ApiKeyAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "API_KEY", + "description": "API-Key認証。すべてのAPIリクエストで、`Authorization` HTTPヘッダーに `Bearer {API_KEY}` の形式でAPIキーを含めてください。APIキーの漏洩を避けるため、サーバーサイドでの保存を強く推奨します。" + } }, "responses": { - "BadRequestGenericJp": { "description": "リクエストパラメータエラー。エラーコード例: invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "ConversationNotFoundJp": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "InternalServerErrorJp": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "BadRequestFileJp": { "description": "ファイル操作リクエストエラー。エラーコード例: no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "FileTooLargeJp": { "description": "ファイルが大きすぎます (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "UnsupportedFileTypeFileJp": { "description": "サポートされていないファイルタイプです (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "S3ErrorFileJp": { "description": "S3ストレージサービスエラー。エラーコード例: s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "SuccessResultJp": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, - "EndUserNotFoundJp": { "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } } + "BadRequestGenericJp": { + "description": "リクエストパラメータエラー。エラーコード例: invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "ConversationNotFoundJp": { + "description": "会話が存在しません。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "InternalServerErrorJp": { + "description": "内部サーバーエラー。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "BadRequestFileJp": { + "description": "ファイル操作リクエストエラー。エラーコード例: no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "FileTooLargeJp": { + "description": "ファイルが大きすぎます (file_too_large)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "UnsupportedFileTypeFileJp": { + "description": "サポートされていないファイルタイプです (unsupported_file_type)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "S3ErrorFileJp": { + "description": "S3ストレージサービスエラー。エラーコード例: s3_connection_failed, s3_permission_denied, s3_file_too_large。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "SuccessResultJp": { + "description": "操作成功。", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + } + } + } + } + } + }, + "EndUserNotFoundJp": { + "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + } }, "schemas": { "CompletionRequestJp": { - "type": "object", "required": ["inputs"], + "type": "object", + "required": [ + "inputs" + ], "properties": { - "inputs": { "type": "object", "required": ["query"], "properties": { "query": { "type": "string", "description": "入力テキスト、処理される内容。" } }, "additionalProperties": true, "description": "アプリで定義された各種変数値を入力。少なくとも1つのキー/値ペアが必要。" }, - "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "レスポンス返却モード。streaming (推奨): SSEによるタイプライター風出力。blocking: 実行完了後に結果返却 (Cloudflare 100秒制限あり)。" }, - "user": { "type": "string", "description": "ユーザー識別子。アプリケーション内で開発者が一意に定義。" }, - "files": { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectJp" }, "description": "(任意) ファイルリスト。モデルがVision機能をサポートしている場合のみ利用可能。" } + "inputs": { + "type": "object", + "required": [ + "query" + ], + "properties": { + "query": { + "type": "string", + "description": "入力テキスト、処理される内容。" + } + }, + "additionalProperties": true, + "description": "アプリで定義された各種変数値を入力。少なくとも1つのキー/値ペアが必要。" + }, + "response_mode": { + "type": "string", + "enum": [ + "streaming", + "blocking" + ], + "default": "streaming", + "description": "レスポンス返却モード。streaming (推奨): SSEによるタイプライター風出力。blocking: 実行完了後に結果返却 (Cloudflare 100秒制限あり)。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。アプリケーション内で開発者が一意に定義。" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InputFileObjectJp" + }, + "description": "(任意) ファイルリスト。モデルがVision機能をサポートしている場合のみ利用可能。" + } } }, "InputFileObjectJp": { - "type": "object", "required": ["type", "transfer_method"], + "type": "object", + "required": [ + "type", + "transfer_method" + ], "properties": { - "type": { "type": "string", "enum": ["image"], "description": "サポートされるタイプ：`image`（現在は画像タイプのみサポート）。" }, - "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" }, - "url": { "type": "string", "format": "url", "description": "画像URL（転送方法が remote_url の場合）" }, - "upload_file_id": { "type": "string", "format": "uuid", "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" } + "type": { + "type": "string", + "enum": [ + "image" + ], + "description": "サポートされるタイプ：`image`（現在は画像タイプのみサポート）。" + }, + "transfer_method": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ], + "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" + }, + "url": { + "type": "string", + "format": "url", + "description": "画像URL（転送方法が remote_url の場合）" + }, + "upload_file_id": { + "type": "string", + "format": "uuid", + "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" + } }, "anyOf": [ { - "properties": { - "transfer_method": { "enum": ["remote_url"] }, - "url": { "type": "string", "format": "url" } + "properties": { + "transfer_method": { + "enum": [ + "remote_url" + ] + }, + "url": { + "type": "string", + "format": "url" + } }, - "required": ["url"], - "not": { "required": ["upload_file_id"] } + "required": [ + "url" + ], + "not": { + "required": [ + "upload_file_id" + ] + } }, { - "properties": { - "transfer_method": { "enum": ["local_file"] }, - "upload_file_id": { "type": "string", "format": "uuid" } + "properties": { + "transfer_method": { + "enum": [ + "local_file" + ] + }, + "upload_file_id": { + "type": "string", + "format": "uuid" + } }, - "required": ["upload_file_id"], - "not": { "required": ["url"] } + "required": [ + "upload_file_id" + ], + "not": { + "required": [ + "url" + ] + } } ] }, "CompletionResponseJp": { - "type": "object", "description": "ブロッキングモードでのアプリの完全な結果。", + "type": "object", + "description": "ブロッキングモードでのアプリの完全な結果。", + "properties": { + "event": { + "type": "string", + "description": "イベントタイプ、通常 'message'。(MarkdownではChatCompletionResponseで 'chat' とあったが、Completionの文脈では 'completion' or 'message' が一般的。blocking example に合わせて 'message' を使用)" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "mode": { + "type": "string", + "description": "アプリモード。ブロッキングモードの例では 'completion'、Markdown本文では 'chat' と記載。ここでは 'completion' を採用。" + }, + "answer": { + "type": "string", + "description": "完全な応答内容。" + }, + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataJp" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "メッセージ作成タイムスタンプ。" + } + } + }, + "ResponseMetadataJp": { + "type": "object", + "description": "メタデータ。", "properties": { - "event": { "type": "string", "description": "イベントタイプ、通常 'message'。(MarkdownではChatCompletionResponseで 'chat' とあったが、Completionの文脈では 'completion' or 'message' が一般的。blocking example に合わせて 'message' を使用)" }, - "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, - "mode": { "type": "string", "description": "アプリモード。ブロッキングモードの例では 'completion'、Markdown本文では 'chat' と記載。ここでは 'completion' を採用。" }, - "answer": { "type": "string", "description": "完全な応答内容。" }, - "metadata": { "$ref": "#/components/schemas/ResponseMetadataJp" }, - "created_at": { "type": "integer", "format": "int64", "description": "メッセージ作成タイムスタンプ。" } + "usage": { + "$ref": "#/components/schemas/UsageJp" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResourceJp" + }, + "description": "引用と帰属のリスト。" + } } }, - "ResponseMetadataJp": { "type": "object", "description": "メタデータ。", "properties": { "usage": { "$ref": "#/components/schemas/UsageJp" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJp" }, "description": "引用と帰属のリスト。" } } }, "ChunkCompletionEventJp": { - "type": "object", "required": ["event"], - "properties": { "event": { "type": "string", "enum": ["message", "message_end", "tts_message", "tts_message_end", "message_replace", "error", "ping"], "description": "イベントタイプ。" } }, - "discriminator": { "propertyName": "event", "mapping": { "message": "#/components/schemas/StreamEventMessageJp", "message_end": "#/components/schemas/StreamEventMessageEndJp", "tts_message": "#/components/schemas/StreamEventTtsMessageJp", "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJp", "message_replace": "#/components/schemas/StreamEventMessageReplaceJp", "error": "#/components/schemas/StreamEventErrorJp", "ping": "#/components/schemas/StreamEventPingJp" } } - }, - "StreamEventBaseCompletionJp": { "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, - "StreamEventMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLMが返したテキストチャンクの内容。" } } } ] }, - "StreamEventMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataJp" } } } ] }, - "StreamEventTtsMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64エンコードされた音声ブロック。" } } } ] }, - "StreamEventTtsMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空文字列。" } } } ] }, - "StreamEventMessageReplaceJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "置換内容。" } } } ] }, - "StreamEventErrorJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["status", "code", "message"], "properties": { "status": { "type": "integer", "description": "HTTPステータスコード。" }, "code": { "type": "string", "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } ] }, - "StreamEventPingJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "type": "object", "description": "接続維持のためのPingイベント。" } ] }, - "UsageJp": { "type": "object", "description": "モデル使用情報。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, - "RetrieverResourceJp": { "type": "object", "description": "引用と帰属の情報。", "properties": { "document_id": { "type": "string" }, "segment_id": { "type": "string" }, "score": { "type": "number" }, "content": { "type": "string" } } }, - "FileUploadResponseJp": { "type": "object", "description": "ファイルアップロード成功時のレスポンス。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ（バイト）。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, - "EndUserDetailJp": { "type": "object", + "required": [ + "event" + ], "properties": { - "id": { "type": "string", "format": "uuid" }, - "tenant_id": { "type": "string", "format": "uuid" }, - "app_id": { "type": "string", "format": "uuid", "nullable": true }, - "type": { "type": "string", "example": "service_api" }, - "external_user_id": { "type": "string", "nullable": true }, - "name": { "type": "string", "nullable": true }, - "is_anonymous": { "type": "boolean" }, - "session_id": { "type": "string" }, - "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { "type": "string", "format": "date-time" } - } - }, - "MessageFeedbackRequestJp": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "高評価 `like`, 低評価 `dislike`, 取り消し `null`。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "content": { "type": "string", "nullable": true, "description": "メッセージフィードバックの具体的な内容。" } } }, - "AppFeedbacksResponseJp": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemJp" }, "description": "このアプリの「いいね」とフィードバックの一覧。" } } }, - "FeedbackItemJp": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, - "TextToAudioRequestJp": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "メッセージID（textより優先）。" }, "text": { "type": "string", "description": "音声生成コンテンツ。" }, "user": { "type": "string", "description": "ユーザー識別子。" } }, "description": "`user`が必須。`message_id`または`text`のいずれかを提供。" }, - "AppInfoResponseJp": { "type": "object", "description": "アプリケーションの基本情報。", "properties": { "name": { "type": "string", "description": "アプリケーションの名前。" }, "description": { "type": "string", "description": "アプリケーションの説明。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "アプリケーションのタグ。" } } }, - "CompletionAppParametersResponseJp": { "type": "object", "description": "アプリケーションのパラメータ情報。", "properties": { "opening_statement": { "type": "string", "description": "開始文。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "開始時の提案質問リスト。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "description": "回答後の提案質問。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "description": "音声からテキスト。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "description": "引用と帰属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "description": "注釈付き返信。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemJp" }, "description": "ユーザー入力フォーム設定。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "detail": { "type": "string" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "画像設定。" } }, "description": "ファイルアップロード設定。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer" }, "image_file_size_limit": { "type": "integer" }, "audio_file_size_limit": { "type": "integer" }, "video_file_size_limit": { "type": "integer" } }, "description": "システムパラメータ。" } } }, - "UserInputFormItemJp": { "type": "object", "description": "ユーザー入力フォームのコントロール項目。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperJp" }, { "$ref": "#/components/schemas/ParagraphControlWrapperJp" }, { "$ref": "#/components/schemas/SelectControlWrapperJp" } ] }, - "TextInputControlWrapperJp": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlJp" } }, "required":["text-input"] }, - "ParagraphControlWrapperJp": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlJp" } }, "required":["paragraph"] }, - "SelectControlWrapperJp": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlJp" } }, "required":["select"] }, - "TextInputControlJp": { "type": "object", "description": "テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, - "ParagraphControlJp": { "type": "object", "description": "段落テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, - "SelectControlJp": { "type": "object", "description": "ドロップダウンコントロール。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必须かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "オプション値。" } } }, - "WebAppSettingsResponseJp": { "type": "object", "description": "アプリケーションのWebApp設定。", "properties": { "title": { "type": "string", "description": "WebApp名。" }, "chat_color_theme": { "type": "string", "description": "チャットの色テーマ（16進数）。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "テーマ反転。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "アイコンタイプ。" }, "icon": { "type": "string", "description": "アイコン（emojiまたは画像URL）。" }, "icon_background": { "type": "string", "description": "背景色（16進数）。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "アイコンURL。" }, "description": { "type": "string", "description": "説明。" }, "copyright": { "type": "string", "description": "著作権情報。" }, "privacy_policy": { "type": "string", "description": "プライバシーポリシーリンク。" }, "custom_disclaimer": { "type": "string", "description": "カスタム免責事項。" }, "default_language": { "type": "string", "description": "デフォルト言語。" }, "show_workflow_steps": { "type": "boolean", "description": "ワークフロー詳細表示。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "WebAppアイコンを返信アイコンとして使用。" } } }, - "ErrorResponseJp": { "type": "object", "description": "エラーレスポンス。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTPステータスコード。" }, "code": { "type": "string", "nullable": true, "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } - } - }, - "tags": [ - { "name": "完了メッセージ", "description": "テキスト生成と完了に関連する操作。" }, - { "name": "ファイル操作", "description": "ファイル管理に関連する操作。" }, - { "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" }, - { "name": "メッセージフィードバック", "description": "ユーザーフィードバックに関連する操作。" }, - { "name": "音声変換", "description": "テキストから音声への変換に関連する操作。" }, - { "name": "アプリケーション情報", "description": "アプリケーションの設定と情報を取得する操作。" } + "event": { + "type": "string", + "enum": [ + "message", + "message_end", + "tts_message", + "tts_message_end", + "message_replace", + "error", + "ping" + ], + "description": "イベントタイプ。" + } + }, + "discriminator": { + "propertyName": "event", + "mapping": { + "message": "#/components/schemas/StreamEventMessageJp", + "message_end": "#/components/schemas/StreamEventMessageEndJp", + "tts_message": "#/components/schemas/StreamEventTtsMessageJp", + "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJp", + "message_replace": "#/components/schemas/StreamEventMessageReplaceJp", + "error": "#/components/schemas/StreamEventErrorJp", + "ping": "#/components/schemas/StreamEventPingJp" + } + } + }, + "StreamEventBaseCompletionJp": { + "type": "object", + "properties": { + "task_id": { + "type": "string", + "format": "uuid", + "description": "タスクID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, + "StreamEventMessageJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkCompletionEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseCompletionJp" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "LLMが返したテキストチャンクの内容。" + } + } + } + ] + }, + "StreamEventMessageEndJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkCompletionEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseCompletionJp" + }, + { + "type": "object", + "required": [ + "metadata" + ], + "properties": { + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataJp" + } + } + } + ] + }, + "StreamEventTtsMessageJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkCompletionEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseCompletionJp" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "format": "byte", + "description": "Base64エンコードされた音声ブロック。" + } + } + } + ] + }, + "StreamEventTtsMessageEndJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkCompletionEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseCompletionJp" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "description": "空文字列。" + } + } + } + ] + }, + "StreamEventMessageReplaceJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkCompletionEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseCompletionJp" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "置換内容。" + } + } + } + ] + }, + "StreamEventErrorJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkCompletionEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseCompletionJp" + }, + { + "type": "object", + "required": [ + "status", + "code", + "message" + ], + "properties": { + "status": { + "type": "integer", + "description": "HTTPステータスコード。" + }, + "code": { + "type": "string", + "description": "エラーコード。" + }, + "message": { + "type": "string", + "description": "エラーメッセージ。" + } + } + } + ] + }, + "StreamEventPingJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkCompletionEventJp" + }, + { + "type": "object", + "description": "接続維持のためのPingイベント。" + } + ] + }, + "UsageJp": { + "type": "object", + "description": "モデル使用情報。", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "prompt_unit_price": { + "type": "string" + }, + "prompt_price_unit": { + "type": "string" + }, + "prompt_price": { + "type": "string" + }, + "completion_tokens": { + "type": "integer" + }, + "completion_unit_price": { + "type": "string" + }, + "completion_price_unit": { + "type": "string" + }, + "completion_price": { + "type": "string" + }, + "total_tokens": { + "type": "integer" + }, + "total_price": { + "type": "string" + }, + "currency": { + "type": "string" + }, + "latency": { + "type": "number", + "format": "double" + } + } + }, + "RetrieverResourceJp": { + "type": "object", + "description": "引用と帰属の情報。", + "properties": { + "document_id": { + "type": "string" + }, + "segment_id": { + "type": "string" + }, + "score": { + "type": "number" + }, + "content": { + "type": "string" + } + } + }, + "FileUploadResponseJp": { + "type": "object", + "description": "ファイルアップロード成功時のレスポンス。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "name": { + "type": "string", + "description": "ファイル名。" + }, + "size": { + "type": "integer", + "description": "ファイルサイズ（バイト）。" + }, + "extension": { + "type": "string", + "description": "ファイル拡張子。" + }, + "mime_type": { + "type": "string", + "description": "ファイルのMIMEタイプ。" + }, + "created_by": { + "type": "string", + "format": "uuid", + "description": "エンドユーザーID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, + "EndUserDetailJp": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "tenant_id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "type": { + "type": "string", + "example": "service_api" + }, + "external_user_id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "is_anonymous": { + "type": "boolean" + }, + "session_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "MessageFeedbackRequestJp": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true, + "description": "高評価 `like`, 低評価 `dislike`, 取り消し `null`。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + }, + "content": { + "type": "string", + "nullable": true, + "description": "メッセージフィードバックの具体的な内容。" + } + } + }, + "AppFeedbacksResponseJp": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeedbackItemJp" + }, + "description": "このアプリの「いいね」とフィードバックの一覧。" + } + } + }, + "FeedbackItemJp": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid" + }, + "conversation_id": { + "type": "string", + "format": "uuid" + }, + "message_id": { + "type": "string", + "format": "uuid" + }, + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true + }, + "content": { + "type": "string" + }, + "from_source": { + "type": "string" + }, + "from_end_user_id": { + "type": "string", + "format": "uuid" + }, + "from_account_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "TextToAudioRequestJp": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "message_id": { + "type": "string", + "format": "uuid", + "description": "メッセージID（textより優先）。" + }, + "text": { + "type": "string", + "description": "音声生成コンテンツ。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + } + }, + "description": "`user`が必須。`message_id`または`text`のいずれかを提供。" + }, + "AppInfoResponseJp": { + "type": "object", + "description": "アプリケーションの基本情報。", + "properties": { + "name": { + "type": "string", + "description": "アプリケーションの名前。" + }, + "description": { + "type": "string", + "description": "アプリケーションの説明。" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "アプリケーションのタグ。" + } + } + }, + "CompletionAppParametersResponseJp": { + "type": "object", + "description": "アプリケーションのパラメータ情報。", + "properties": { + "opening_statement": { + "type": "string", + "description": "開始文。" + }, + "suggested_questions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "開始時の提案質問リスト。" + }, + "suggested_questions_after_answer": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "description": "回答後の提案質問。" + }, + "speech_to_text": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "description": "音声からテキスト。" + }, + "retriever_resource": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "description": "引用と帰属。" + }, + "annotation_reply": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + }, + "description": "注釈付き返信。" + }, + "user_input_form": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserInputFormItemJp" + }, + "description": "ユーザー入力フォーム設定。" + }, + "file_upload": { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "number_limits": { + "type": "integer" + }, + "detail": { + "type": "string" + }, + "transfer_methods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ] + } + } + }, + "description": "画像設定。" + } + }, + "description": "ファイルアップロード設定。" + }, + "system_parameters": { + "type": "object", + "properties": { + "file_size_limit": { + "type": "integer" + }, + "image_file_size_limit": { + "type": "integer" + }, + "audio_file_size_limit": { + "type": "integer" + }, + "video_file_size_limit": { + "type": "integer" + } + }, + "description": "システムパラメータ。" + } + } + }, + "UserInputFormItemJp": { + "type": "object", + "description": "ユーザー入力フォームのコントロール項目。", + "oneOf": [ + { + "$ref": "#/components/schemas/TextInputControlWrapperJp" + }, + { + "$ref": "#/components/schemas/ParagraphControlWrapperJp" + }, + { + "$ref": "#/components/schemas/SelectControlWrapperJp" + } + ] + }, + "TextInputControlWrapperJp": { + "type": "object", + "properties": { + "text-input": { + "$ref": "#/components/schemas/TextInputControlJp" + } + }, + "required": [ + "text-input" + ] + }, + "ParagraphControlWrapperJp": { + "type": "object", + "properties": { + "paragraph": { + "$ref": "#/components/schemas/ParagraphControlJp" + } + }, + "required": [ + "paragraph" + ] + }, + "SelectControlWrapperJp": { + "type": "object", + "properties": { + "select": { + "$ref": "#/components/schemas/SelectControlJp" + } + }, + "required": [ + "select" + ] + }, + "TextInputControlJp": { + "type": "object", + "description": "テキスト入力コントロール。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + } + } + }, + "ParagraphControlJp": { + "type": "object", + "description": "段落テキスト入力コントロール。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + } + } + }, + "SelectControlJp": { + "type": "object", + "description": "ドロップダウンコントロール。", + "required": [ + "label", + "variable", + "required", + "options" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必须かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + }, + "options": { + "type": "array", + "items": { + "type": "string" + }, + "description": "オプション値。" + } + } + }, + "WebAppSettingsResponseJp": { + "type": "object", + "description": "アプリケーションのWebApp設定。", + "properties": { + "title": { + "type": "string", + "description": "WebApp名。" + }, + "chat_color_theme": { + "type": "string", + "description": "チャットの色テーマ（16進数）。" + }, + "chat_color_theme_inverted": { + "type": "boolean", + "description": "テーマ反転。" + }, + "icon_type": { + "type": "string", + "enum": [ + "emoji", + "image" + ], + "description": "アイコンタイプ。" + }, + "icon": { + "type": "string", + "description": "アイコン（emojiまたは画像URL）。" + }, + "icon_background": { + "type": "string", + "description": "背景色（16進数）。" + }, + "icon_url": { + "type": "string", + "format": "url", + "nullable": true, + "description": "アイコンURL。" + }, + "description": { + "type": "string", + "description": "説明。" + }, + "copyright": { + "type": "string", + "description": "著作権情報。" + }, + "privacy_policy": { + "type": "string", + "description": "プライバシーポリシーリンク。" + }, + "custom_disclaimer": { + "type": "string", + "description": "カスタム免責事項。" + }, + "default_language": { + "type": "string", + "description": "デフォルト言語。" + }, + "show_workflow_steps": { + "type": "boolean", + "description": "ワークフロー詳細表示。" + }, + "use_icon_as_answer_icon": { + "type": "boolean", + "description": "WebAppアイコンを返信アイコンとして使用。" + } + } + }, + "ErrorResponseJp": { + "type": "object", + "description": "エラーレスポンス。", + "properties": { + "status": { + "type": "integer", + "nullable": true, + "description": "HTTPステータスコード。" + }, + "code": { + "type": "string", + "nullable": true, + "description": "エラーコード。" + }, + "message": { + "type": "string", + "description": "エラーメッセージ。" + } + } + } + } + }, + "tags": [ + { + "name": "完了メッセージ", + "description": "テキスト生成と完了に関連する操作。" + }, + { + "name": "ファイル操作", + "description": "ファイル管理に関連する操作。" + }, + { + "name": "エンドユーザー", + "description": "エンドユーザー情報に関連する操作。" + }, + { + "name": "メッセージフィードバック", + "description": "ユーザーフィードバックに関連する操作。" + }, + { + "name": "音声変換", + "description": "テキストから音声への変換に関連する操作。" + }, + { + "name": "アプリケーション情報", + "description": "アプリケーションの設定と情報を取得する操作。" + } ] -} \ No newline at end of file +} diff --git a/ja/api-reference/openapi_workflow.json b/ja/api-reference/openapi_workflow.json index 16269a904..9ea9ad7e5 100644 --- a/ja/api-reference/openapi_workflow.json +++ b/ja/api-reference/openapi_workflow.json @@ -27,8 +27,10 @@ "post": { "summary": "ワークフローを実行", "description": "ワークフローを実行します。公開されたワークフローがないと実行できません。", - "operationId": "executeWorkflowJp", - "tags": ["ワークフロー実行"], + "operationId": "executeWorkflow", + "tags": [ + "ワークフロー実行" + ], "requestBody": { "required": true, "content": { @@ -47,7 +49,7 @@ "user": "workflow_user_jp_001" } }, - "with_file_array_variable_jp":{ + "with_file_array_variable_jp": { "summary": "ファイルリスト変数を含む入力の例", "value": { "inputs": { @@ -89,8 +91,12 @@ } } }, - "400": { "$ref": "#/components/responses/BadRequestWorkflowJp" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + "400": { + "$ref": "#/components/responses/BadRequestWorkflowJp" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJp" + } } } }, @@ -98,15 +104,20 @@ "get": { "summary": "ワークフロー実行詳細を取得", "description": "ワークフロー実行IDに基づいて、ワークフロータスクの現在の実行結果を取得します。", - "operationId": "getWorkflowRunDetailJp", - "tags": ["ワークフロー実行"], + "operationId": "getWorkflowRunDetail", + "tags": [ + "ワークフロー実行" + ], "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "ワークフロー実行ID。ワークフロー実行の応答またはストリーミングイベントから取得できます。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -114,11 +125,15 @@ "description": "ワークフロー実行詳細の取得に成功しました。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/WorkflowRunDetailResponseJp" } + "schema": { + "$ref": "#/components/schemas/WorkflowRunDetailResponseJp" + } } } }, - "404": {"description": "ワークフロー実行記録が見つかりません。"} + "404": { + "description": "ワークフロー実行記録が見つかりません。" + } } } }, @@ -126,15 +141,20 @@ "post": { "summary": "生成を停止 (ワークフロータスク)", "description": "ワークフロータスクの生成を停止します。ストリーミングモードでのみサポートされています。", - "operationId": "stopWorkflowTaskGenerationJp", - "tags": ["ワークフロー実行"], + "operationId": "stopWorkflowTaskGeneration", + "tags": [ + "ワークフロー実行" + ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "タスクID。ストリーミングチャンクの返り値から取得可能。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { @@ -143,16 +163,23 @@ "application/json": { "schema": { "type": "object", - "required": ["user"], + "required": [ + "user" + ], "properties": { - "user": { "type": "string", "description": "ユーザー識別子。実行ワークフローAPIに渡されたユーザーと一致する必要があります。" } + "user": { + "type": "string", + "description": "ユーザー識別子。実行ワークフローAPIに渡されたユーザーと一致する必要があります。" + } } } } } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResultJp" } + "200": { + "$ref": "#/components/responses/SuccessResultJp" + } } } }, @@ -160,31 +187,71 @@ "post": { "summary": "ファイルアップロード (ワークフロー用)", "description": "ワークフローで使用するファイルをアップロードします。ワークフローでサポートされている任意の形式をサポートします。アップロードされたファイルは、現在のエンドユーザーのみが使用できます。", - "operationId": "uploadWorkflowFileJp", - "tags": ["ファイル操作 (ワークフロー)"], + "operationId": "uploadWorkflowFile", + "tags": [ + "ファイル操作 (ワークフロー)" + ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", - "required": ["file", "user"], + "required": [ + "file", + "user" + ], "properties": { - "file": { "type": "string", "format": "binary", "description": "アップロードするファイル。" }, - "user": { "type": "string", "description": "ユーザー識別子。" } + "file": { + "type": "string", + "format": "binary", + "description": "アップロードするファイル。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。" + } } } } } }, "responses": { - "200": { "description": "ファイルのアップロードに成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } }, - "201": { "description": "ファイルの作成に成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } }, - "400": { "$ref": "#/components/responses/BadRequestFileJp" }, - "413": { "$ref": "#/components/responses/FileTooLargeJp" }, - "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileJp" }, - "503": { "$ref": "#/components/responses/S3ErrorFileJp" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + "200": { + "description": "ファイルのアップロードに成功しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseJp" + } + } + } + }, + "201": { + "description": "ファイルの作成に成功しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseJp" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequestFileJp" + }, + "413": { + "$ref": "#/components/responses/FileTooLargeJp" + }, + "415": { + "$ref": "#/components/responses/UnsupportedFileTypeFileJp" + }, + "503": { + "$ref": "#/components/responses/S3ErrorFileJp" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJp" + } } } }, @@ -192,15 +259,20 @@ "get": { "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", - "operationId": "getEndUserWorkflowJp", - "tags": ["エンドユーザー"], + "operationId": "getEndUserWorkflow", + "tags": [ + "エンドユーザー" + ], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "エンドユーザーID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -208,241 +280,1533 @@ "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/EndUserDetailJp" } + "schema": { + "$ref": "#/components/schemas/EndUserDetailJp" + } } } }, - "404": { "$ref": "#/components/responses/EndUserNotFoundJp" }, - "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + "404": { + "$ref": "#/components/responses/EndUserNotFoundJp" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorJp" + } } } }, "/workflows/logs": { - "get": { - "summary": "ワークフローログを取得", - "description": "ワークフローログを返します。最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", - "operationId": "getWorkflowLogsJp", - "tags": ["ワークフロー実行"], - "parameters": [ - { "name": "keyword", "in": "query", "description": "（オプション）検索するキーワード。", "schema": { "type": "string" } }, - { "name": "status", "in": "query", "description": "（オプション）実行ステータス：succeeded, failed, stopped, running。", "schema": { "type": "string", "enum": ["succeeded", "failed", "stopped", "running"] } }, - { "name": "page", "in": "query", "description": "（オプション）現在のページ、デフォルトは1。", "schema": { "type": "integer", "default": 1 } }, - { "name": "limit", "in": "query", "description": "（オプション）1回のリクエストで返すアイテムの数、デフォルトは20。", "schema": { "type": "integer", "default": 20 } } - ], - "responses": { - "200": { "description": "ワークフローログの取得に成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowLogsResponseJp" } } } } + "get": { + "summary": "ワークフローログを取得", + "description": "ワークフローログを返します。最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", + "operationId": "getWorkflowLogs", + "tags": [ + "ワークフロー実行" + ], + "parameters": [ + { + "name": "keyword", + "in": "query", + "description": "（オプション）検索するキーワード。", + "schema": { + "type": "string" + } + }, + { + "name": "status", + "in": "query", + "description": "（オプション）実行ステータス：succeeded, failed, stopped, running。", + "schema": { + "type": "string", + "enum": [ + "succeeded", + "failed", + "stopped", + "running" + ] + } + }, + { + "name": "page", + "in": "query", + "description": "（オプション）現在のページ、デフォルトは1。", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "limit", + "in": "query", + "description": "（オプション）1回のリクエストで返すアイテムの数、デフォルトは20。", + "schema": { + "type": "integer", + "default": 20 + } + } + ], + "responses": { + "200": { + "description": "ワークフローログの取得に成功しました。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowLogsResponseJp" + } + } } + } } + } }, "/info": { "get": { "summary": "アプリケーションの基本情報を取得 (ワークフロー)", - "operationId": "getWorkflowAppInfoJp", - "tags": ["アプリケーション設定 (ワークフロー)"], - "responses": { "200": { "description": "アプリケーションの基本情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseJp" } } } } } + "operationId": "getWorkflowAppInfo", + "tags": [ + "アプリケーション設定 (ワークフロー)" + ], + "responses": { + "200": { + "description": "アプリケーションの基本情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInfoResponseJp" + } + } + } + } + } } }, "/parameters": { "get": { "summary": "アプリケーションのパラメータ情報を取得 (ワークフロー)", - "operationId": "getWorkflowAppParametersJp", - "tags": ["アプリケーション設定 (ワークフロー)"], - "responses": { "200": { "description": "アプリケーションのパラメータ情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAppParametersResponseJp" } } } } } + "operationId": "getWorkflowAppParameters", + "tags": [ + "アプリケーション設定 (ワークフロー)" + ], + "responses": { + "200": { + "description": "アプリケーションのパラメータ情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowAppParametersResponseJp" + } + } + } + } + } } }, "/site": { "get": { "summary": "アプリのWebApp設定を取得 (ワークフロー)", - "operationId": "getWorkflowWebAppSettingsJp", - "tags": ["アプリケーション設定 (ワークフロー)"], - "responses": { "200": { "description": "WebApp設定情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowWebAppSettingsResponseJp" } } } } } + "operationId": "getWorkflowWebAppSettings", + "tags": [ + "アプリケーション設定 (ワークフロー)" + ], + "responses": { + "200": { + "description": "WebApp設定情報。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowWebAppSettingsResponseJp" + } + } + } + } + } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください（例：Bearer {API_KEY}）。APIキーの漏洩を防ぐため、サーバー側で保存することを強くお勧めします。" } + "ApiKeyAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "API_KEY", + "description": "API-Key認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください（例：Bearer {API_KEY}）。APIキーの漏洩を防ぐため、サーバー側で保存することを強くお勧めします。" + } }, "responses": { - "BadRequestWorkflowJp": { "description": "リクエストパラメータエラーまたはワークフロー実行失敗。考えられるエラーコード：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, workflow_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "BadRequestFileJp": { "description": "ファイル操作リクエストエラー。考えられるエラーコード：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "FileTooLargeJp": { "description": "ファイルが大きすぎます (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "UnsupportedFileTypeFileJp": { "description": "サポートされていないファイルタイプです (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "S3ErrorFileJp": { "description": "S3ストレージサービスエラー。考えられるエラーコード：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "InternalServerErrorJp": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, - "SuccessResultJp": { "description": "操作に成功しました。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, - "EndUserNotFoundJp": { "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } } + "BadRequestWorkflowJp": { + "description": "リクエストパラメータエラーまたはワークフロー実行失敗。考えられるエラーコード：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, workflow_request_error。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "BadRequestFileJp": { + "description": "ファイル操作リクエストエラー。考えられるエラーコード：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "FileTooLargeJp": { + "description": "ファイルが大きすぎます (file_too_large)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "UnsupportedFileTypeFileJp": { + "description": "サポートされていないファイルタイプです (unsupported_file_type)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "S3ErrorFileJp": { + "description": "S3ストレージサービスエラー。考えられるエラーコード：s3_connection_failed, s3_permission_denied, s3_file_too_large。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "InternalServerErrorJp": { + "description": "内部サーバーエラー。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + }, + "SuccessResultJp": { + "description": "操作に成功しました。", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + } + } + } + } + } + }, + "EndUserNotFoundJp": { + "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseJp" + } + } + } + } }, "schemas": { "WorkflowExecutionRequestJp": { "type": "object", - "required": ["inputs", "response_mode", "user"], + "required": [ + "inputs", + "response_mode", + "user" + ], "properties": { "inputs": { "type": "object", "description": "アプリで定義されたさまざまな変数値の入力を許可します。変数がファイルリストの場合、その値はInputFileObjectWorkflowJpオブジェクトのリストである必要があります。", "additionalProperties": { - "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object" }, { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectWorkflowJp" } } ] + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "object" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/InputFileObjectWorkflowJp" + } + } + ] }, - "example": { "user_query": "これを翻訳してください。", "target_language": "フランス語" } + "example": { + "user_query": "これを翻訳してください。", + "target_language": "フランス語" + } }, - "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "description": "応答の返却モード。streaming (推奨) はSSEに基づきます。blocking は実行完了後に結果を返します (Cloudflareの100秒タイムアウト制限あり)。" }, - "user": { "type": "string", "description": "ユーザー識別子。アプリケーション内で一意である必要があります。" }, - "files": { "type": "array", "items": {"$ref": "#/components/schemas/InputFileObjectWorkflowJp"}, "description": "（オプション）このフィールドはinputs内のファイル型変数に置き換えられました。下位互換性のために残されていますが、inputsを使用することを推奨します。"} + "response_mode": { + "type": "string", + "enum": [ + "streaming", + "blocking" + ], + "description": "応答の返却モード。streaming (推奨) はSSEに基づきます。blocking は実行完了後に結果を返します (Cloudflareの100秒タイムアウト制限あり)。" + }, + "user": { + "type": "string", + "description": "ユーザー識別子。アプリケーション内で一意である必要があります。" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InputFileObjectWorkflowJp" + }, + "description": "（オプション）このフィールドはinputs内のファイル型変数に置き換えられました。下位互換性のために残されていますが、inputsを使用することを推奨します。" + } } }, "InputFileObjectWorkflowJp": { "type": "object", - "required": ["type", "transfer_method"], + "required": [ + "type", + "transfer_method" + ], "properties": { - "type": { "type": "string", "enum": ["document", "image", "audio", "video", "custom"], "description": "ファイルタイプ。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: その他。" }, - "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" }, - "url": { "type": "string", "format": "url", "description": "画像URL（転送方法が remote_url の場合）" }, - "upload_file_id": { "type": "string", "format": "uuid", "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" } + "type": { + "type": "string", + "enum": [ + "document", + "image", + "audio", + "video", + "custom" + ], + "description": "ファイルタイプ。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: その他。" + }, + "transfer_method": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ], + "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" + }, + "url": { + "type": "string", + "format": "url", + "description": "画像URL（転送方法が remote_url の場合）" + }, + "upload_file_id": { + "type": "string", + "format": "uuid", + "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" + } }, "anyOf": [ { - "properties": { - "transfer_method": { "enum": ["remote_url"] }, - "url": { "type": "string", "format": "url" } + "properties": { + "transfer_method": { + "enum": [ + "remote_url" + ] + }, + "url": { + "type": "string", + "format": "url" + } }, - "required": ["url"], - "not": { "required": ["upload_file_id"] } + "required": [ + "url" + ], + "not": { + "required": [ + "upload_file_id" + ] + } }, { - "properties": { - "transfer_method": { "enum": ["local_file"] }, - "upload_file_id": { "type": "string", "format": "uuid" } + "properties": { + "transfer_method": { + "enum": [ + "local_file" + ] + }, + "upload_file_id": { + "type": "string", + "format": "uuid" + } }, - "required": ["upload_file_id"], - "not": { "required": ["url"] } + "required": [ + "upload_file_id" + ], + "not": { + "required": [ + "url" + ] + } } ] }, "WorkflowCompletionResponseJp": { - "type": "object", "description": "ブロッキングモードでのワークフロー実行結果。", + "type": "object", + "description": "ブロッキングモードでのワークフロー実行結果。", "properties": { - "workflow_run_id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意のID。" }, - "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, - "data": { "$ref": "#/components/schemas/WorkflowFinishedDataJp" } + "workflow_run_id": { + "type": "string", + "format": "uuid", + "description": "ワークフロー実行の一意のID。" + }, + "task_id": { + "type": "string", + "format": "uuid", + "description": "タスクID。" + }, + "data": { + "$ref": "#/components/schemas/WorkflowFinishedDataJp" + } } }, "ChunkWorkflowEventJp": { - "type": "object", "required": ["event"], - "properties": { "event": { "type": "string", "enum": ["workflow_started", "node_started", "text_chunk", "node_finished", "workflow_finished", "tts_message", "tts_message_end", "ping"], "description": "イベントタイプ。" } }, - "discriminator": { "propertyName": "event", "mapping": { - "workflow_started": "#/components/schemas/StreamEventWfWorkflowStartedJp", "node_started": "#/components/schemas/StreamEventWfNodeStartedJp", - "text_chunk": "#/components/schemas/StreamEventWfTextChunkJp", "node_finished": "#/components/schemas/StreamEventWfNodeFinishedJp", - "workflow_finished": "#/components/schemas/StreamEventWfWorkflowFinishedJp", "tts_message": "#/components/schemas/StreamEventWfTtsMessageJp", - "tts_message_end": "#/components/schemas/StreamEventWfTtsMessageEndJp", "ping": "#/components/schemas/StreamEventWfPingJp" - }} + "type": "object", + "required": [ + "event" + ], + "properties": { + "event": { + "type": "string", + "enum": [ + "workflow_started", + "node_started", + "text_chunk", + "node_finished", + "workflow_finished", + "tts_message", + "tts_message_end", + "ping" + ], + "description": "イベントタイプ。" + } + }, + "discriminator": { + "propertyName": "event", + "mapping": { + "workflow_started": "#/components/schemas/StreamEventWfWorkflowStartedJp", + "node_started": "#/components/schemas/StreamEventWfNodeStartedJp", + "text_chunk": "#/components/schemas/StreamEventWfTextChunkJp", + "node_finished": "#/components/schemas/StreamEventWfNodeFinishedJp", + "workflow_finished": "#/components/schemas/StreamEventWfWorkflowFinishedJp", + "tts_message": "#/components/schemas/StreamEventWfTtsMessageJp", + "tts_message_end": "#/components/schemas/StreamEventWfTtsMessageEndJp", + "ping": "#/components/schemas/StreamEventWfPingJp" + } + } }, "StreamEventBaseWfJp": { - "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, "workflow_run_id": { "type": "string", "format": "uuid", "description": "ワークフロー実行ID。" } } - }, - "StreamEventWfWorkflowStartedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowStartedDataJp" } } } ] }, - "WorkflowStartedDataJp": { "type": "object", "description": "ワークフロー開始イベントの詳細。", "required": ["id", "workflow_id", "sequence_number", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意のID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "関連するワークフローのID。" }, "sequence_number": { "type": "integer", "description": "自己増加シリアル番号、1から始まります。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始時間。" } } }, - "StreamEventWfNodeStartedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/NodeStartedDataJp" } } } ] }, - "NodeStartedDataJp": { "type": "object", "description": "ノード開始イベントの詳細。", "required": ["id", "node_id", "node_type", "title", "index", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意のID（文脈上、ノード実行IDであるべき）。" }, "node_id": { "type": "string", "format": "uuid", "description": "ノードのID。" }, "node_type": { "type": "string", "description": "ノードのタイプ。" }, "title": { "type": "string", "description": "ノードの名前。" }, "index": { "type": "integer", "description": "実行シーケンス番号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（オプション）前のノードID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ノードで使用されるすべての前のノード変数の内容。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始のタイムスタンプ。" } } }, - "StreamEventWfTextChunkJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TextChunkDataJp" } } } ] }, - "TextChunkDataJp": { "type": "object", "description": "テキストフラグメントイベントの詳細。", "required": ["text", "from_variable_selector"], "properties": { "text": { "type": "string", "description": "テキスト内容。" }, "from_variable_selector": { "type": "array", "items": { "type": "string" }, "description": "テキスト生成元パス。" } } }, - "StreamEventWfNodeFinishedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/NodeFinishedDataJp" } } } ] }, - "NodeFinishedDataJp": { "type": "object", "description": "ノード終了イベントの詳細。", "required": ["id", "node_id", "index", "status", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ノード実行ID。" }, "node_id": { "type": "string", "format": "uuid", "description": "ノードのID。" }, "index": { "type": "integer", "description": "実行シーケンス番号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（オプション）前のノードID。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "ノードで使用されるすべての前のノード変数の内容。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（オプション）ノードプロセスデータ (JSON)。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（オプション）出力内容 (JSON)。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行のステータス。" }, "error": { "type": "string", "nullable": true, "description": "（オプション）エラー理由。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（オプション）使用時間（秒）。" }, "execution_metadata": { "$ref": "#/components/schemas/NodeExecutionMetadataJp" , "nullable": true, "description":"メタデータ"}, "created_at": { "type": "integer", "format": "int64", "description": "開始のタイムスタンプ。" } } }, - "NodeExecutionMetadataJp": { "type": "object", "description": "ノード実行メタデータ。", "properties": { "total_tokens": { "type": "integer", "nullable": true, "description": "（オプション）使用トークン数。" }, "total_price": { "type": "number", "format": "float", "nullable": true, "description": "（オプション）総コスト (floatでdecimalを表現)。" }, "currency": { "type": "string", "nullable": true, "example": "USD", "description": "（オプション）通貨、例：USD / RMB。" } } }, - "StreamEventWfWorkflowFinishedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowFinishedDataJp" } } } ] }, - "WorkflowFinishedDataJp": { "type": "object", "description": "ワークフロー終了イベントの詳細。", "required": ["id", "workflow_id", "status", "created_at", "finished_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行のID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "関連するワークフローのID。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行のステータス。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（オプション）出力内容 (JSON)。" }, "error": { "type": "string", "nullable": true, "description": "（オプション）エラー理由。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（オプション）使用時間（秒）。" }, "total_tokens": { "type": "integer", "nullable": true, "description": "（オプション）使用トークン数。" }, "total_steps": { "type": "integer", "default": 0, "description": "総ステップ数、デフォルト0。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始時間。" }, "finished_at": { "type": "integer", "format": "int64", "description": "終了時間。" } } }, - "StreamEventWfTtsMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["audio", "message_id", "created_at"], "properties": { "audio": { "type": "string", "format": "byte", "description": "音声合成後のオーディオ、base64テキストコンテンツ。" }, "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } } ] }, - "StreamEventWfTtsMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["audio", "message_id", "created_at"], "properties": { "audio": { "type": "string", "description": "終了イベントにはオーディオがないため、これは空の文字列です。" }, "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } } ] }, - "StreamEventWfPingJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "type": "object", "description": "接続を維持するために10秒ごとに送信されるPingイベント。" } ] }, - "WorkflowRunDetailResponseJp": { - "type": "object", "description": "ワークフロー実行詳細。", - "properties": { - "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行のID。" }, - "workflow_id": { "type": "string", "format": "uuid", "description": "関連するワークフローのID。" }, - "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行のステータス。" }, - "inputs": { "type": "string", "description": "入力内容のJSON文字列。" }, - "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "出力内容のJSONオブジェクト。" }, - "error": { "type": "string", "nullable": true, "description": "エラー理由。" }, - "total_steps": { "type": "integer", "description": "タスクの総ステップ数。" }, - "total_tokens": { "type": "integer", "description": "使用されるトークンの総数。" }, - "created_at": { "type": "integer", "format": "int64", "description": "タスク開始時間。" }, - "finished_at": { "type": "integer", "format": "int64", "nullable": true, "description": "タスク終了時間。" }, - "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "使用される総秒数。" } - } - }, - "FileUploadResponseJp": { "type": "object", "description": "ファイルアップロード成功時の応答。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ（バイト）。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, - "EndUserDetailJp": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, - "tenant_id": { "type": "string", "format": "uuid" }, - "app_id": { "type": "string", "format": "uuid", "nullable": true }, - "type": { "type": "string", "example": "service_api" }, - "external_user_id": { "type": "string", "nullable": true }, - "name": { "type": "string", "nullable": true }, - "is_anonymous": { "type": "boolean" }, - "session_id": { "type": "string" }, - "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { "type": "string", "format": "date-time" } + "task_id": { + "type": "string", + "format": "uuid", + "description": "タスクID。" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid", + "description": "ワークフロー実行ID。" + } } }, - "WorkflowLogsResponseJp": { - "type": "object", "description": "ワークフローログリストの応答。", + "StreamEventWfWorkflowStartedJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfJp" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/WorkflowStartedDataJp" + } + } + } + ] + }, + "WorkflowStartedDataJp": { + "type": "object", + "description": "ワークフロー開始イベントの詳細。", + "required": [ + "id", + "workflow_id", + "sequence_number", + "created_at" + ], "properties": { - "page": { "type": "integer", "description": "現在のページ。" }, "limit": { "type": "integer", "description": "1ページあたりのアイテム数。" }, - "total": { "type": "integer", "description": "合計アイテム数。" }, "has_more": { "type": "boolean", "description": "さらにデータがあるかどうか。" }, - "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowLogItemJp" }, "description": "現在のページのデータ。" } + "id": { + "type": "string", + "format": "uuid", + "description": "ワークフロー実行の一意のID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "関連するワークフローのID。" + }, + "sequence_number": { + "type": "integer", + "description": "自己増加シリアル番号、1から始まります。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "開始時間。" + } } }, - "WorkflowLogItemJp": { - "type": "object", "description": "単一のワークフローログアイテム。", + "StreamEventWfNodeStartedJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfJp" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NodeStartedDataJp" + } + } + } + ] + }, + "NodeStartedDataJp": { + "type": "object", + "description": "ノード開始イベントの詳細。", + "required": [ + "id", + "node_id", + "node_type", + "title", + "index", + "created_at" + ], "properties": { - "id": { "type": "string", "format": "uuid", "description": "ID。" }, - "workflow_run": { "$ref": "#/components/schemas/WorkflowRunSummaryJp", "description": "ワークフロー実行ログ。" }, - "created_from": { "type": "string", "description": "作成元。" }, - "created_by_role": { "type": "string", "description": "作成者の役割。" }, - "created_by_account": { "type": "string", "format": "uuid", "nullable": true, "description": "（オプション）作成者アカウント。" }, - "created_by_end_user": { "$ref": "#/components/schemas/EndUserSummaryJp", "description": "作成者ユーザー。" }, - "created_at": { "type": "integer", "format": "int64", "description": "作成時間。" } + "id": { + "type": "string", + "format": "uuid", + "description": "ワークフロー実行の一意のID（文脈上、ノード実行IDであるべき）。" + }, + "node_id": { + "type": "string", + "format": "uuid", + "description": "ノードのID。" + }, + "node_type": { + "type": "string", + "description": "ノードのタイプ。" + }, + "title": { + "type": "string", + "description": "ノードの名前。" + }, + "index": { + "type": "integer", + "description": "実行シーケンス番号。" + }, + "predecessor_node_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "（オプション）前のノードID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "ノードで使用されるすべての前のノード変数の内容。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "開始のタイムスタンプ。" + } } }, - "WorkflowRunSummaryJp": { - "type": "object", "description": "ワークフロー実行概要情報。", + "StreamEventWfTextChunkJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfJp" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TextChunkDataJp" + } + } + } + ] + }, + "TextChunkDataJp": { + "type": "object", + "description": "テキストフラグメントイベントの詳細。", + "required": [ + "text", + "from_variable_selector" + ], "properties": { - "id": { "type": "string", "format": "uuid", "description": "ID。" }, "version": { "type": "string", "description": "バージョン。" }, - "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行ステータス。" }, - "error": { "type": "string", "nullable": true, "description": "（オプション）エラー。" }, - "elapsed_time": { "type": "number", "format": "float", "description": "使用時間（秒）。" }, - "total_tokens": { "type": "integer", "description": "消費トークン数。" }, - "total_steps": { "type": "integer", "description": "実行ステップ長。" }, - "created_at": { "type": "integer", "format": "int64", "description": "開始時間。" }, - "finished_at": { "type": "integer", "format": "int64", "nullable": true, "description": "終了時間。" } + "text": { + "type": "string", + "description": "テキスト内容。" + }, + "from_variable_selector": { + "type": "array", + "items": { + "type": "string" + }, + "description": "テキスト生成元パス。" + } } }, - "EndUserSummaryJp": { - "type": "object", "description": "エンドユーザー概要情報。", - "properties": { - "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "タイプ。" }, - "is_anonymous": { "type": "boolean", "description": "匿名かどうか。" }, "session_id": { "type": "string", "description": "セッションID。" } - } - }, - "AppInfoResponseJp": { "type": "object", "description": "アプリケーションの基本情報。", "properties": { "name": { "type": "string", "description": "アプリケーションの名前。" }, "description": { "type": "string", "description": "アプリケーションの説明。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "アプリケーションのタグ。" } } }, - "WorkflowAppParametersResponseJp": { "type": "object", "description": "ワークフローアプリのパラメータ情報。", "properties": { "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemJp" }, "description": "ユーザー入力フォームの設定。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "detail": { "type": "string" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "画像設定。現在サポートされている画像タイプのみ：png, jpg, jpeg, webp, gif。" } }, "description": "ファイルアップロード設定。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "ドキュメントアップロードサイズ制限（MB）。" }, "image_file_size_limit": { "type": "integer", "description": "画像ファイルアップロードサイズ制限（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "オーディオファイルアップロードサイズ制限（MB）。" }, "video_file_size_limit": { "type": "integer", "description": "ビデオファイルアップロードサイズ制限（MB）。" } }, "description": "システムパラメータ。" } } }, - "UserInputFormItemJp": { "type": "object", "description": "ユーザー入力フォーム内のコントロールアイテム。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperJp" }, { "$ref": "#/components/schemas/ParagraphControlWrapperJp" }, { "$ref": "#/components/schemas/SelectControlWrapperJp" } ] }, - "TextInputControlWrapperJp": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlJp" } }, "required":["text-input"] }, - "ParagraphControlWrapperJp": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlJp" } }, "required":["paragraph"] }, - "SelectControlWrapperJp": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlJp" } }, "required":["select"] }, - "TextInputControlJp": { "type": "object", "description": "テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, - "ParagraphControlJp": { "type": "object", "description": "段落テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, - "SelectControlJp": { "type": "object", "description": "ドロップダウンコントロール。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "オプション値。" } } }, - "WorkflowWebAppSettingsResponseJp": { "type": "object", "description": "ワークフローアプリのWebApp設定。", "properties": { "title": { "type": "string", "description": "WebApp名。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "アイコンタイプ。" }, "icon": { "type": "string", "description": "アイコン内容 (emojiまたは画像URL)。" }, "icon_background": { "type": "string", "description": "16進数形式の背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "アイコンのURL。" }, "description": { "type": "string", "description": "説明。" }, "copyright": { "type": "string", "description": "著作権情報。" }, "privacy_policy": { "type": "string", "description": "プライバシーポリシーのリンク。" }, "custom_disclaimer": { "type": "string", "description": "カスタム免責事項。" }, "default_language": { "type": "string", "description": "デフォルト言語。" }, "show_workflow_steps": { "type": "boolean", "description": "ワークフローの詳細を表示するかどうか。" } } }, - "ErrorResponseJp": { "type": "object", "description": "エラー応答。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTPステータスコード。" }, "code": { "type": "string", "nullable": true, "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } - } - }, - "tags": [ - { "name": "ワークフロー実行", "description": "ワークフローの実行と管理に関連する操作。" }, - { "name": "ファイル操作 (ワークフロー)", "description": "ワークフロー固有のファイルアップロードとプレビュー操作。" }, - { "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" }, - { "name": "アプリケーション設定 (ワークフロー)", "description": "ワークフローアプリのアプリケーション設定と情報。" } + "StreamEventWfNodeFinishedJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfJp" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NodeFinishedDataJp" + } + } + } + ] + }, + "NodeFinishedDataJp": { + "type": "object", + "description": "ノード終了イベントの詳細。", + "required": [ + "id", + "node_id", + "index", + "status", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ノード実行ID。" + }, + "node_id": { + "type": "string", + "format": "uuid", + "description": "ノードのID。" + }, + "index": { + "type": "integer", + "description": "実行シーケンス番号。" + }, + "predecessor_node_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "（オプション）前のノードID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "ノードで使用されるすべての前のノード変数の内容。" + }, + "process_data": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "（オプション）ノードプロセスデータ (JSON)。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "（オプション）出力内容 (JSON)。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "実行のステータス。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "（オプション）エラー理由。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "（オプション）使用時間（秒）。" + }, + "execution_metadata": { + "$ref": "#/components/schemas/NodeExecutionMetadataJp", + "nullable": true, + "description": "メタデータ" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "開始のタイムスタンプ。" + } + } + }, + "NodeExecutionMetadataJp": { + "type": "object", + "description": "ノード実行メタデータ。", + "properties": { + "total_tokens": { + "type": "integer", + "nullable": true, + "description": "（オプション）使用トークン数。" + }, + "total_price": { + "type": "number", + "format": "float", + "nullable": true, + "description": "（オプション）総コスト (floatでdecimalを表現)。" + }, + "currency": { + "type": "string", + "nullable": true, + "example": "USD", + "description": "（オプション）通貨、例：USD / RMB。" + } + } + }, + "StreamEventWfWorkflowFinishedJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfJp" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/WorkflowFinishedDataJp" + } + } + } + ] + }, + "WorkflowFinishedDataJp": { + "type": "object", + "description": "ワークフロー終了イベントの詳細。", + "required": [ + "id", + "workflow_id", + "status", + "created_at", + "finished_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ワークフロー実行のID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "関連するワークフローのID。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "実行のステータス。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "（オプション）出力内容 (JSON)。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "（オプション）エラー理由。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "（オプション）使用時間（秒）。" + }, + "total_tokens": { + "type": "integer", + "nullable": true, + "description": "（オプション）使用トークン数。" + }, + "total_steps": { + "type": "integer", + "default": 0, + "description": "総ステップ数、デフォルト0。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "開始時間。" + }, + "finished_at": { + "type": "integer", + "format": "int64", + "description": "終了時間。" + } + } + }, + "StreamEventWfTtsMessageJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfJp" + }, + { + "type": "object", + "required": [ + "audio", + "message_id", + "created_at" + ], + "properties": { + "audio": { + "type": "string", + "format": "byte", + "description": "音声合成後のオーディオ、base64テキストコンテンツ。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + } + ] + }, + "StreamEventWfTtsMessageEndJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventJp" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfJp" + }, + { + "type": "object", + "required": [ + "audio", + "message_id", + "created_at" + ], + "properties": { + "audio": { + "type": "string", + "description": "終了イベントにはオーディオがないため、これは空の文字列です。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "一意のメッセージID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + } + ] + }, + "StreamEventWfPingJp": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventJp" + }, + { + "type": "object", + "description": "接続を維持するために10秒ごとに送信されるPingイベント。" + } + ] + }, + "WorkflowRunDetailResponseJp": { + "type": "object", + "description": "ワークフロー実行詳細。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ワークフロー実行のID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "関連するワークフローのID。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "実行のステータス。" + }, + "inputs": { + "type": "string", + "description": "入力内容のJSON文字列。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "出力内容のJSONオブジェクト。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "エラー理由。" + }, + "total_steps": { + "type": "integer", + "description": "タスクの総ステップ数。" + }, + "total_tokens": { + "type": "integer", + "description": "使用されるトークンの総数。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "タスク開始時間。" + }, + "finished_at": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "タスク終了時間。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "使用される総秒数。" + } + } + }, + "FileUploadResponseJp": { + "type": "object", + "description": "ファイルアップロード成功時の応答。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "name": { + "type": "string", + "description": "ファイル名。" + }, + "size": { + "type": "integer", + "description": "ファイルサイズ（バイト）。" + }, + "extension": { + "type": "string", + "description": "ファイル拡張子。" + }, + "mime_type": { + "type": "string", + "description": "ファイルのMIMEタイプ。" + }, + "created_by": { + "type": "string", + "format": "uuid", + "description": "エンドユーザーID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成タイムスタンプ。" + } + } + }, + "EndUserDetailJp": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "tenant_id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "type": { + "type": "string", + "example": "service_api" + }, + "external_user_id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "is_anonymous": { + "type": "boolean" + }, + "session_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "WorkflowLogsResponseJp": { + "type": "object", + "description": "ワークフローログリストの応答。", + "properties": { + "page": { + "type": "integer", + "description": "現在のページ。" + }, + "limit": { + "type": "integer", + "description": "1ページあたりのアイテム数。" + }, + "total": { + "type": "integer", + "description": "合計アイテム数。" + }, + "has_more": { + "type": "boolean", + "description": "さらにデータがあるかどうか。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowLogItemJp" + }, + "description": "現在のページのデータ。" + } + } + }, + "WorkflowLogItemJp": { + "type": "object", + "description": "単一のワークフローログアイテム。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "workflow_run": { + "$ref": "#/components/schemas/WorkflowRunSummaryJp", + "description": "ワークフロー実行ログ。" + }, + "created_from": { + "type": "string", + "description": "作成元。" + }, + "created_by_role": { + "type": "string", + "description": "作成者の役割。" + }, + "created_by_account": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "（オプション）作成者アカウント。" + }, + "created_by_end_user": { + "$ref": "#/components/schemas/EndUserSummaryJp", + "description": "作成者ユーザー。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "作成時間。" + } + } + }, + "WorkflowRunSummaryJp": { + "type": "object", + "description": "ワークフロー実行概要情報。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "version": { + "type": "string", + "description": "バージョン。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "実行ステータス。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "（オプション）エラー。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "description": "使用時間（秒）。" + }, + "total_tokens": { + "type": "integer", + "description": "消費トークン数。" + }, + "total_steps": { + "type": "integer", + "description": "実行ステップ長。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "開始時間。" + }, + "finished_at": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "終了時間。" + } + } + }, + "EndUserSummaryJp": { + "type": "object", + "description": "エンドユーザー概要情報。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "type": { + "type": "string", + "description": "タイプ。" + }, + "is_anonymous": { + "type": "boolean", + "description": "匿名かどうか。" + }, + "session_id": { + "type": "string", + "description": "セッションID。" + } + } + }, + "AppInfoResponseJp": { + "type": "object", + "description": "アプリケーションの基本情報。", + "properties": { + "name": { + "type": "string", + "description": "アプリケーションの名前。" + }, + "description": { + "type": "string", + "description": "アプリケーションの説明。" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "アプリケーションのタグ。" + } + } + }, + "WorkflowAppParametersResponseJp": { + "type": "object", + "description": "ワークフローアプリのパラメータ情報。", + "properties": { + "user_input_form": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserInputFormItemJp" + }, + "description": "ユーザー入力フォームの設定。" + }, + "file_upload": { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "number_limits": { + "type": "integer" + }, + "detail": { + "type": "string" + }, + "transfer_methods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ] + } + } + }, + "description": "画像設定。現在サポートされている画像タイプのみ：png, jpg, jpeg, webp, gif。" + } + }, + "description": "ファイルアップロード設定。" + }, + "system_parameters": { + "type": "object", + "properties": { + "file_size_limit": { + "type": "integer", + "description": "ドキュメントアップロードサイズ制限（MB）。" + }, + "image_file_size_limit": { + "type": "integer", + "description": "画像ファイルアップロードサイズ制限（MB）。" + }, + "audio_file_size_limit": { + "type": "integer", + "description": "オーディオファイルアップロードサイズ制限（MB）。" + }, + "video_file_size_limit": { + "type": "integer", + "description": "ビデオファイルアップロードサイズ制限（MB）。" + } + }, + "description": "システムパラメータ。" + } + } + }, + "UserInputFormItemJp": { + "type": "object", + "description": "ユーザー入力フォーム内のコントロールアイテム。", + "oneOf": [ + { + "$ref": "#/components/schemas/TextInputControlWrapperJp" + }, + { + "$ref": "#/components/schemas/ParagraphControlWrapperJp" + }, + { + "$ref": "#/components/schemas/SelectControlWrapperJp" + } + ] + }, + "TextInputControlWrapperJp": { + "type": "object", + "properties": { + "text-input": { + "$ref": "#/components/schemas/TextInputControlJp" + } + }, + "required": [ + "text-input" + ] + }, + "ParagraphControlWrapperJp": { + "type": "object", + "properties": { + "paragraph": { + "$ref": "#/components/schemas/ParagraphControlJp" + } + }, + "required": [ + "paragraph" + ] + }, + "SelectControlWrapperJp": { + "type": "object", + "properties": { + "select": { + "$ref": "#/components/schemas/SelectControlJp" + } + }, + "required": [ + "select" + ] + }, + "TextInputControlJp": { + "type": "object", + "description": "テキスト入力コントロール。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + } + } + }, + "ParagraphControlJp": { + "type": "object", + "description": "段落テキスト入力コントロール。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + } + } + }, + "SelectControlJp": { + "type": "object", + "description": "ドロップダウンコントロール。", + "required": [ + "label", + "variable", + "required", + "options" + ], + "properties": { + "label": { + "type": "string", + "description": "変数表示ラベル名。" + }, + "variable": { + "type": "string", + "description": "変数ID。" + }, + "required": { + "type": "boolean", + "description": "必須かどうか。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "デフォルト値。" + }, + "options": { + "type": "array", + "items": { + "type": "string" + }, + "description": "オプション値。" + } + } + }, + "WorkflowWebAppSettingsResponseJp": { + "type": "object", + "description": "ワークフローアプリのWebApp設定。", + "properties": { + "title": { + "type": "string", + "description": "WebApp名。" + }, + "icon_type": { + "type": "string", + "enum": [ + "emoji", + "image" + ], + "description": "アイコンタイプ。" + }, + "icon": { + "type": "string", + "description": "アイコン内容 (emojiまたは画像URL)。" + }, + "icon_background": { + "type": "string", + "description": "16進数形式の背景色。" + }, + "icon_url": { + "type": "string", + "format": "url", + "nullable": true, + "description": "アイコンのURL。" + }, + "description": { + "type": "string", + "description": "説明。" + }, + "copyright": { + "type": "string", + "description": "著作権情報。" + }, + "privacy_policy": { + "type": "string", + "description": "プライバシーポリシーのリンク。" + }, + "custom_disclaimer": { + "type": "string", + "description": "カスタム免責事項。" + }, + "default_language": { + "type": "string", + "description": "デフォルト言語。" + }, + "show_workflow_steps": { + "type": "boolean", + "description": "ワークフローの詳細を表示するかどうか。" + } + } + }, + "ErrorResponseJp": { + "type": "object", + "description": "エラー応答。", + "properties": { + "status": { + "type": "integer", + "nullable": true, + "description": "HTTPステータスコード。" + }, + "code": { + "type": "string", + "nullable": true, + "description": "エラーコード。" + }, + "message": { + "type": "string", + "description": "エラーメッセージ。" + } + } + } + } + }, + "tags": [ + { + "name": "ワークフロー実行", + "description": "ワークフローの実行と管理に関連する操作。" + }, + { + "name": "ファイル操作 (ワークフロー)", + "description": "ワークフロー固有のファイルアップロードとプレビュー操作。" + }, + { + "name": "エンドユーザー", + "description": "エンドユーザー情報に関連する操作。" + }, + { + "name": "アプリケーション設定 (ワークフロー)", + "description": "ワークフローアプリのアプリケーション設定と情報。" + } ] -} \ No newline at end of file +} diff --git a/zh/api-reference/openapi_chat.json b/zh/api-reference/openapi_chat.json index 296d1855f..254588b0a 100644 --- a/zh/api-reference/openapi_chat.json +++ b/zh/api-reference/openapi_chat.json @@ -27,8 +27,10 @@ "post": { "summary": "发送对话消息", "description": "创建会话消息。", - "operationId": "sendBasicChatMessageCn", - "tags": ["对话消息"], + "operationId": "sendChatMessage", + "tags": [ + "对话消息" + ], "requestBody": { "description": "发送对话消息的请求体。", "required": true, @@ -78,9 +80,15 @@ } } }, - "400": { "$ref": "#/components/responses/BadRequestGenericCn" }, - "404": { "$ref": "#/components/responses/ConversationNotFoundCn" }, - "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + "400": { + "$ref": "#/components/responses/BadRequestGenericCn" + }, + "404": { + "$ref": "#/components/responses/ConversationNotFoundCn" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorCn" + } } } }, @@ -88,8 +96,10 @@ "post": { "summary": "上传文件", "description": "上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。支持 png, jpg, jpeg, webp, gif 格式。上传的文件仅供当前终端用户使用。", - "operationId": "uploadBasicChatFileCn", - "tags": ["文件操作"], + "operationId": "uploadChatFile", + "tags": [ + "文件操作" + ], "requestBody": { "description": "文件上传请求。需使用 `multipart/form-data` 进行请求。", "required": true, @@ -97,7 +107,10 @@ "multipart/form-data": { "schema": { "type": "object", - "required": ["file", "user"], + "required": [ + "file", + "user" + ], "properties": { "file": { "type": "string", @@ -124,15 +137,31 @@ } } }, - "201": { + "201": { "description": "文件创建成功 (备选成功状态码)。", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseCn" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseCn" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequestFileCn" + }, + "413": { + "$ref": "#/components/responses/FileTooLargeCn" + }, + "415": { + "$ref": "#/components/responses/UnsupportedFileTypeFileCn" + }, + "503": { + "$ref": "#/components/responses/S3ErrorFileCn" }, - "400": { "$ref": "#/components/responses/BadRequestFileCn" }, - "413": { "$ref": "#/components/responses/FileTooLargeCn" }, - "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileCn" }, - "503": { "$ref": "#/components/responses/S3ErrorFileCn" }, - "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + "500": { + "$ref": "#/components/responses/InternalServerErrorCn" + } } } }, @@ -140,15 +169,20 @@ "get": { "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", - "operationId": "getEndUserChatCn", - "tags": ["终端用户"], + "operationId": "getEndUserChat", + "tags": [ + "终端用户" + ], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "终端用户 ID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -156,12 +190,18 @@ "description": "成功获取终端用户信息。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/EndUserDetailCn" } + "schema": { + "$ref": "#/components/schemas/EndUserDetailCn" + } } } }, - "404": { "$ref": "#/components/responses/EndUserNotFoundCn" }, - "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + "404": { + "$ref": "#/components/responses/EndUserNotFoundCn" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorCn" + } } } }, @@ -169,8 +209,10 @@ "get": { "summary": "文件预览", "description": "预览或下载已上传的文件。此端点允许你访问之前通过文件上传API上传的文件。文件只能在所属的应用程序消息内访问。", - "operationId": "previewBasicChatFileCn", - "tags": ["文件操作"], + "operationId": "previewChatFile", + "tags": [ + "文件操作" + ], "parameters": [ { "name": "file_id", @@ -267,7 +309,9 @@ "description": "错误请求。可能的错误代码:\n- `invalid_param`: 异常参数输入。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } } } }, @@ -275,7 +319,9 @@ "description": "禁止访问。可能的错误代码:\n- `file_access_denied`: 文件访问被拒绝或文件不属于当前应用程序。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } } } }, @@ -283,7 +329,9 @@ "description": "未找到。可能的错误代码:\n- `file_not_found`: 文件未找到或已被删除。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } } } }, @@ -291,7 +339,9 @@ "description": "内部服务器错误。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } } } } @@ -302,15 +352,20 @@ "post": { "summary": "停止响应", "description": "停止生成对话消息。仅支持流式模式。", - "operationId": "stopBasicChatMessageGenerationCn", - "tags": ["对话消息"], + "operationId": "stopChatMessageGeneration", + "tags": [ + "对话消息" + ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "任务 ID，可在流式返回 Chunk 中获取。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { @@ -319,7 +374,9 @@ "application/json": { "schema": { "type": "object", - "required": ["user"], + "required": [ + "user" + ], "properties": { "user": { "type": "string", @@ -331,7 +388,9 @@ } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResultCn" } + "200": { + "$ref": "#/components/responses/SuccessResultCn" + } } } }, @@ -339,27 +398,36 @@ "post": { "summary": "消息反馈（点赞）", "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", - "operationId": "postBasicChatMessageFeedbackCn", - "tags": ["消息反馈"], + "operationId": "postChatMessageFeedback", + "tags": [ + "消息反馈" + ], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestCn" } + "schema": { + "$ref": "#/components/schemas/MessageFeedbackRequestCn" + } } } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResultCn" } + "200": { + "$ref": "#/components/responses/SuccessResultCn" + } } } }, @@ -367,18 +435,26 @@ "get": { "summary": "获取APP的消息点赞和反馈", "description": "获取应用的终端用户反馈、点赞。", - "operationId": "getBasicChatAppFeedbacksCn", - "tags": ["消息反馈"], + "operationId": "getChatAppFeedbacks", + "tags": [ + "消息反馈" + ], "parameters": [ - { "$ref": "#/components/parameters/PageQueryParamCn" }, - { "$ref": "#/components/parameters/LimitQueryParamCn" } + { + "$ref": "#/components/parameters/PageQueryParamCn" + }, + { + "$ref": "#/components/parameters/LimitQueryParamCn" + } ], "responses": { "200": { "description": "成功获取应用的反馈列表。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseCn" } + "schema": { + "$ref": "#/components/schemas/AppFeedbacksResponseCn" + } } } } @@ -389,24 +465,33 @@ "get": { "summary": "获取下一轮建议问题列表", "description": "获取当前消息的下一轮建议问题列表。", - "operationId": "getBasicChatSuggestedQuestionsCn", - "tags": ["对话消息"], + "operationId": "getSuggestedQuestions", + "tags": [ + "对话消息" + ], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } }, - { "$ref": "#/components/parameters/UserQueryParamCn" } + { + "$ref": "#/components/parameters/UserQueryParamCn" + } ], "responses": { "200": { "description": "成功获取建议问题列表。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/SuggestedQuestionsResponseCn" } + "schema": { + "$ref": "#/components/schemas/SuggestedQuestionsResponseCn" + } } } } @@ -417,25 +502,39 @@ "get": { "summary": "获取会话历史消息", "description": "滚动加载形式返回历史聊天记录，第一页返回最新 `limit` 条，即倒序返回。", - "operationId": "getBasicChatConversationHistoryCn", - "tags": ["会话管理"], + "operationId": "getConversationHistory", + "tags": [ + "会话管理" + ], "parameters": [ - { "$ref": "#/components/parameters/ConversationIdQueryParamCn" }, - { "$ref": "#/components/parameters/UserQueryParamCn" }, + { + "$ref": "#/components/parameters/ConversationIdQueryParamCn" + }, + { + "$ref": "#/components/parameters/UserQueryParamCn" + }, { "name": "first_id", "in": "query", "description": "当前页第一条聊天记录的 ID，默认 null。", - "schema": { "type": "string", "format": "uuid", "nullable": true } + "schema": { + "type": "string", + "format": "uuid", + "nullable": true + } }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20Cn" } + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Cn" + } ], "responses": { "200": { "description": "成功获取会话历史消息。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/BasicConversationHistoryResponseCn" } + "schema": { + "$ref": "#/components/schemas/BasicConversationHistoryResponseCn" + } } } } @@ -446,20 +545,32 @@ "get": { "summary": "获取会话列表", "description": "获取当前用户的会话列表，默认返回最近的 20 条。", - "operationId": "getBasicChatConversationsListCn", - "tags": ["会话管理"], + "operationId": "getConversationsList", + "tags": [ + "会话管理" + ], "parameters": [ - { "$ref": "#/components/parameters/UserQueryParamCn" }, - { "$ref": "#/components/parameters/LastIdQueryParamCn" }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" }, - { "$ref": "#/components/parameters/SortByQueryParamCn" } + { + "$ref": "#/components/parameters/UserQueryParamCn" + }, + { + "$ref": "#/components/parameters/LastIdQueryParamCn" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" + }, + { + "$ref": "#/components/parameters/SortByQueryParamCn" + } ], "responses": { "200": { "description": "成功获取会话列表。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ConversationsListResponseCn" } + "schema": { + "$ref": "#/components/schemas/ConversationsListResponseCn" + } } } } @@ -470,55 +581,117 @@ "delete": { "summary": "删除会话", "description": "删除一个指定的会话。", - "operationId": "deleteBasicChatConversationCn", - "tags": ["会话管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamCn" } ], + "operationId": "deleteConversation", + "tags": [ + "会话管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdPathParamCn" + } + ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", "required": ["user"], - "properties": { "user": { "type": "string", "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" } } + "type": "object", + "required": [ + "user" + ], + "properties": { + "user": { + "type": "string", + "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" + } + } } } } }, - "responses": { "204": { "description": "会话删除成功，无内容返回。" } } + "responses": { + "204": { + "description": "会话删除成功，无内容返回。" + } + } } }, "/conversations/{conversation_id}/name": { "post": { "summary": "会话重命名", "description": "对会话进行重命名。", - "operationId": "renameBasicChatConversationCn", - "tags": ["会话管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamCn" } ], + "operationId": "renameConversation", + "tags": [ + "会话管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdPathParamCn" + } + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameRequestCn" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationRenameRequestCn" + } + } + } }, "responses": { - "200": { "description": "会话重命名成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameResponseCn" } } } } + "200": { + "description": "会话重命名成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationRenameResponseCn" + } + } + } + } } } }, - "/conversations/{conversation_id}/variables": { + "/conversations/{conversation_id}/variables": { "get": { "summary": "获取对话变量", "description": "从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。", - "operationId": "getBasicChatConversationVariablesCn", - "tags": ["会话管理"], + "operationId": "getConversationVariables", + "tags": [ + "会话管理" + ], "parameters": [ - { "$ref": "#/components/parameters/ConversationIdPathParamCn" }, - { "$ref": "#/components/parameters/UserQueryParamCn" }, - { "$ref": "#/components/parameters/LastIdQueryParamCn" }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" }, - { "$ref": "#/components/parameters/VariableNameQueryParamCn" } + { + "$ref": "#/components/parameters/ConversationIdPathParamCn" + }, + { + "$ref": "#/components/parameters/UserQueryParamCn" + }, + { + "$ref": "#/components/parameters/LastIdQueryParamCn" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" + }, + { + "$ref": "#/components/parameters/VariableNameQueryParamCn" + } ], "responses": { - "200": { "description": "成功获取对话变量。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationVariablesResponseCn" } } } }, - "404": { "$ref": "#/components/responses/ConversationNotFoundCn" } + "200": { + "description": "成功获取对话变量。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationVariablesResponseCn" + } + } + } + }, + "404": { + "$ref": "#/components/responses/ConversationNotFoundCn" + } } } }, @@ -526,14 +699,31 @@ "post": { "summary": "语音转文字", "description": "将语音文件转换为文字。支持格式：mp3, mp4, mpeg, mpga, m4a, wav, webm。文件大小限制：15MB。", - "operationId": "basicChatAudioToTextCn", - "tags": ["语音与文字转换"], + "operationId": "audioToText", + "tags": [ + "语音与文字转换" + ], "requestBody": { "required": true, - "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioToTextRequestCn" } } } + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/AudioToTextRequestCn" + } + } + } }, "responses": { - "200": { "description": "成功将语音转换为文字。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioToTextResponseCn" } } } } + "200": { + "description": "成功将语音转换为文字。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AudioToTextResponseCn" + } + } + } + } } } }, @@ -541,19 +731,45 @@ "post": { "summary": "文字转语音", "description": "将文字内容转换为语音。", - "operationId": "basicChatTextToAudioCn", - "tags": ["语音与文字转换"], + "operationId": "textToAudioChat", + "tags": [ + "语音与文字转换" + ], "requestBody": { "required": true, - "content": { - "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TextToAudioFormRequestCn" } } + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/TextToAudioFormRequestCn" + } + } } }, "responses": { "200": { "description": "成功生成语音文件。", - "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, - "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } + "content": { + "audio/wav": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "audio/mp3": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "Content-Type": { + "schema": { + "type": "string", + "example": "audio/wav" + } + } + } } } } @@ -561,135 +777,518 @@ "/info": { "get": { "summary": "获取应用基本信息", - "operationId": "getBasicChatAppInfoCn", - "tags": ["应用配置"], - "responses": { "200": { "description": "应用基本信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseCn" } } } } } + "operationId": "getChatAppInfo", + "tags": [ + "应用配置" + ], + "responses": { + "200": { + "description": "应用基本信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInfoResponseCn" + } + } + } + } + } } }, "/parameters": { "get": { "summary": "获取应用参数", "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", - "operationId": "getBasicChatAppParametersCn", - "tags": ["应用配置"], - "responses": { "200": { "description": "应用参数信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAppParametersResponseCn" } } } } } + "operationId": "getChatAppParameters", + "tags": [ + "应用配置" + ], + "responses": { + "200": { + "description": "应用参数信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChatAppParametersResponseCn" + } + } + } + } + } } }, "/meta": { "get": { "summary": "获取应用Meta信息", "description": "用于获取工具 icon。", - "operationId": "getBasicChatAppMetaCn", - "tags": ["应用配置"], - "responses": { "200": { "description": "成功获取应用 Meta 信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMetaResponseCn" } } } } } + "operationId": "getChatAppMeta", + "tags": [ + "应用配置" + ], + "responses": { + "200": { + "description": "成功获取应用 Meta 信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppMetaResponseCn" + } + } + } + } + } } }, "/site": { "get": { "summary": "获取应用 WebApp 设置", "description": "用于获取应用的 WebApp 设置。", - "operationId": "getBasicChatWebAppSettingsCn", - "tags": ["应用配置"], - "responses": { "200": { "description": "WebApp 设置信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseCn" } } } } } + "operationId": "getChatWebAppSettings", + "tags": [ + "应用配置" + ], + "responses": { + "200": { + "description": "WebApp 设置信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebAppSettingsResponseCn" + } + } + } + } + } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" } + "ApiKeyAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "API_KEY", + "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" + } }, "parameters": { - "PageQueryParamCn": { "name": "page", "in": "query", "description": "页码，（选填）默认值：1。", "schema": { "type": "integer", "default": 1 } }, - "LimitQueryParamCn": { "name": "limit", "in": "query", "description": "每页数量，（选填）默认值：20。", "schema": { "type": "integer", "default": 20 } }, - "LimitQueryParamDefault20Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录，默认 20 条。", "schema": { "type": "integer", "default": 20 } }, - "LimitQueryParamDefault20Max100Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, - "UserQueryParamCn": { "name": "user", "in": "query", "required": true, "description": "用户标识，由开发者定义规则，需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", "schema": { "type": "string" } }, - "ConversationIdQueryParamCn": { "name": "conversation_id", "in": "query", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } }, - "LastIdQueryParamCn": { "name": "last_id", "in": "query", "description": "（选填）当前页最后面一条记录的 ID，默认 null。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, - "SortByQueryParamCn": { "name": "sort_by", "in": "query", "description": "（选填）排序字段，默认 -updated_at (按更新时间倒序排列)。可选值：created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } }, - "ConversationIdPathParamCn": { "name": "conversation_id", "in": "path", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } }, - "VariableNameQueryParamCn": { "name": "variable_name", "in": "query", "description": "（选填）按变量名称筛选。", "schema": { "type": "string" } } - }, - "responses": { - "BadRequestGenericCn": { "description": "请求参数错误。可能原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "BadRequestFileCn": { "description": "文件操作请求错误。可能原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "FileTooLargeCn": { "description": "文件太大 (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "UnsupportedFileTypeFileCn": { "description": "不支持的文件类型 (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "S3ErrorFileCn": { "description": "S3 存储服务错误。可能原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "InternalServerErrorCn": { "description": "服务内部异常。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "SuccessResultCn": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, - "ConversationNotFoundCn": { "description": "对话不存在。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "EndUserNotFoundCn": { "description": "终端用户不存在。错误码：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } } - }, - "schemas": { - "BasicChatRequestCn": { - "type": "object", - "required": ["query", "user"], - "properties": { - "query": { "type": "string", "description": "用户输入/提问内容。" }, - "inputs": { - "type": "object", - "description": "允许传入 App 定义的各变量值。", - "additionalProperties": true, - "default": {} - }, - "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制；Agent模式下不允许)。" }, - "user": { "type": "string", "description": "用户标识，应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "（选填）会话 ID，用于继续之前的对话。" }, - "files": { "type": "array", "items": { "$ref": "#/components/schemas/BasicInputFileObjectCn" }, "description": "（选填）上传的文件列表 (目前仅支持图片)。" }, - "auto_generate_name": { "type": "boolean", "default": true, "description": "（选填）自动生成会话标题，默认 true。" } + "PageQueryParamCn": { + "name": "page", + "in": "query", + "description": "页码，（选填）默认值：1。", + "schema": { + "type": "integer", + "default": 1 } }, - "BasicInputFileObjectCn": { - "type": "object", - "required": ["type", "transfer_method"], - "properties": { - "type": { "type": "string", "enum": ["image"], "description": "文件类型，目前仅支持 'image'。" }, - "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" }, - "url": { "type": "string", "format": "url", "description": "图片地址（当传递方式为 remote_url 时）" }, - "upload_file_id": { "type": "string", "format":"uuid", "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" } - }, - "anyOf": [ - { - "properties": { - "transfer_method": { "enum": ["remote_url"] }, - "url": { "type": "string", "format": "url" } - }, - "required": ["url"], - "not": { "required": ["upload_file_id"] } + "LimitQueryParamCn": { + "name": "limit", + "in": "query", + "description": "每页数量，（选填）默认值：20。", + "schema": { + "type": "integer", + "default": 20 + } + }, + "LimitQueryParamDefault20Cn": { + "name": "limit", + "in": "query", + "description": "一次请求返回多少条记录，默认 20 条。", + "schema": { + "type": "integer", + "default": 20 + } + }, + "LimitQueryParamDefault20Max100Cn": { + "name": "limit", + "in": "query", + "description": "一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。", + "schema": { + "type": "integer", + "default": 20, + "minimum": 1, + "maximum": 100 + } + }, + "UserQueryParamCn": { + "name": "user", + "in": "query", + "required": true, + "description": "用户标识，由开发者定义规则，需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", + "schema": { + "type": "string" + } + }, + "ConversationIdQueryParamCn": { + "name": "conversation_id", + "in": "query", + "required": true, + "description": "会话 ID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + "LastIdQueryParamCn": { + "name": "last_id", + "in": "query", + "description": "（选填）当前页最后面一条记录的 ID，默认 null。", + "schema": { + "type": "string", + "format": "uuid", + "nullable": true + } + }, + "SortByQueryParamCn": { + "name": "sort_by", + "in": "query", + "description": "（选填）排序字段，默认 -updated_at (按更新时间倒序排列)。可选值：created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", + "schema": { + "type": "string", + "enum": [ + "created_at", + "-created_at", + "updated_at", + "-updated_at" + ], + "default": "-updated_at" + } + }, + "ConversationIdPathParamCn": { + "name": "conversation_id", + "in": "path", + "required": true, + "description": "会话 ID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + "VariableNameQueryParamCn": { + "name": "variable_name", + "in": "query", + "description": "（选填）按变量名称筛选。", + "schema": { + "type": "string" + } + } + }, + "responses": { + "BadRequestGenericCn": { + "description": "请求参数错误。可能原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "BadRequestFileCn": { + "description": "文件操作请求错误。可能原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "FileTooLargeCn": { + "description": "文件太大 (file_too_large)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "UnsupportedFileTypeFileCn": { + "description": "不支持的文件类型 (unsupported_file_type)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "S3ErrorFileCn": { + "description": "S3 存储服务错误。可能原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "InternalServerErrorCn": { + "description": "服务内部异常。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "SuccessResultCn": { + "description": "操作成功。", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + } + } + } + } + } + }, + "ConversationNotFoundCn": { + "description": "对话不存在。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "EndUserNotFoundCn": { + "description": "终端用户不存在。错误码：`end_user_not_found`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + } + }, + "schemas": { + "BasicChatRequestCn": { + "type": "object", + "required": [ + "query", + "user" + ], + "properties": { + "query": { + "type": "string", + "description": "用户输入/提问内容。" + }, + "inputs": { + "type": "object", + "description": "允许传入 App 定义的各变量值。", + "additionalProperties": true, + "default": {} + }, + "response_mode": { + "type": "string", + "enum": [ + "streaming", + "blocking" + ], + "default": "streaming", + "description": "响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制；Agent模式下不允许)。" + }, + "user": { + "type": "string", + "description": "用户标识，应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "（选填）会话 ID，用于继续之前的对话。" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BasicInputFileObjectCn" + }, + "description": "（选填）上传的文件列表 (目前仅支持图片)。" + }, + "auto_generate_name": { + "type": "boolean", + "default": true, + "description": "（选填）自动生成会话标题，默认 true。" + } + } + }, + "BasicInputFileObjectCn": { + "type": "object", + "required": [ + "type", + "transfer_method" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "image" + ], + "description": "文件类型，目前仅支持 'image'。" + }, + "transfer_method": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ], + "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" + }, + "url": { + "type": "string", + "format": "url", + "description": "图片地址（当传递方式为 remote_url 时）" + }, + "upload_file_id": { + "type": "string", + "format": "uuid", + "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" + } + }, + "anyOf": [ + { + "properties": { + "transfer_method": { + "enum": [ + "remote_url" + ] + }, + "url": { + "type": "string", + "format": "url" + } + }, + "required": [ + "url" + ], + "not": { + "required": [ + "upload_file_id" + ] + } }, { - "properties": { - "transfer_method": { "enum": ["local_file"] }, - "upload_file_id": { "type": "string", "format":"uuid" } + "properties": { + "transfer_method": { + "enum": [ + "local_file" + ] + }, + "upload_file_id": { + "type": "string", + "format": "uuid" + } }, - "required": ["upload_file_id"], - "not": { "required": ["url"] } + "required": [ + "upload_file_id" + ], + "not": { + "required": [ + "url" + ] + } } ] }, "ChatCompletionResponseCn": { - "type": "object", "description": "阻塞模式下的完整 App 结果。", + "type": "object", + "description": "阻塞模式下的完整 App 结果。", "properties": { - "event": { "type": "string", "example": "message", "description": "事件类型，固定为 `message`。" }, - "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, - "id": { "type": "string", "format": "uuid", "description": "唯一ID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, - "mode": { "type": "string", "example": "chat", "description": "App 模式，固定为 `chat`。" }, - "answer": { "type": "string", "description": "完整回复内容。" }, - "metadata": { "$ref": "#/components/schemas/ResponseMetadataCn" }, - "created_at": { "type": "integer", "format": "int64", "description": "消息创建时间戳。" } + "event": { + "type": "string", + "example": "message", + "description": "事件类型，固定为 `message`。" + }, + "task_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID。" + }, + "id": { + "type": "string", + "format": "uuid", + "description": "唯一ID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息唯一 ID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会话 ID。" + }, + "mode": { + "type": "string", + "example": "chat", + "description": "App 模式，固定为 `chat`。" + }, + "answer": { + "type": "string", + "description": "完整回复内容。" + }, + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataCn" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "消息创建时间戳。" + } } }, "ResponseMetadataCn": { - "type": "object", "description": "元数据。", - "properties": { "usage": { "$ref": "#/components/schemas/UsageCn" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceCn" }, "description": "引用和归属分段列表。" } } + "type": "object", + "description": "元数据。", + "properties": { + "usage": { + "$ref": "#/components/schemas/UsageCn" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResourceCn" + }, + "description": "引用和归属分段列表。" + } + } }, "ChunkBasicChatEventCn": { - "type": "object", "required": ["event"], - "properties": { "event": { "type": "string", "enum": ["message", "agent_message", "agent_thought", "message_file", "message_end", "tts_message", "tts_message_end", "message_replace", "error", "ping"], "description": "事件类型。" } }, - "discriminator": { "propertyName": "event", "mapping": { + "type": "object", + "required": [ + "event" + ], + "properties": { + "event": { + "type": "string", + "enum": [ + "message", + "agent_message", + "agent_thought", + "message_file", + "message_end", + "tts_message", + "tts_message_end", + "message_replace", + "error", + "ping" + ], + "description": "事件类型。" + } + }, + "discriminator": { + "propertyName": "event", + "mapping": { "message": "#/components/schemas/StreamEventChatMessageCn", "agent_message": "#/components/schemas/StreamEventAgentMessageCn", "agent_thought": "#/components/schemas/StreamEventAgentThoughtCn", @@ -700,111 +1299,1401 @@ "message_replace": "#/components/schemas/StreamEventMessageReplaceCn", "error": "#/components/schemas/StreamEventErrorCn", "ping": "#/components/schemas/StreamEventPingCn" - }} + } + } }, "StreamEventBaseChatCn": { - "type": "object", "properties": { - "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, - "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } + "type": "object", + "properties": { + "task_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息唯一 ID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会话 ID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间戳。" + } } }, - "StreamEventChatMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLM 返回文本块内容。" } } } ] }, - "StreamEventAgentMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "Agent模式下 LLM 返回文本块内容。" } } } ] }, + "StreamEventChatMessageCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "LLM 返回文本块内容。" + } + } + } + ] + }, + "StreamEventAgentMessageCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "Agent模式下 LLM 返回文本块内容。" + } + } + } + ] + }, "StreamEventAgentThoughtCn": { - "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, - { "type": "object", "required": ["id", "position"], + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "id", + "position" + ], "properties": { - "id": { "type": "string", "format": "uuid", "description": "agent_thought ID。" }, - "position": { "type": "integer", "description": "agent_thought 在消息中的位置。" }, - "thought": { "type": "string", "description": "agent 的思考内容。" }, - "observation": { "type": "string", "description": "工具调用的返回结果。" }, - "tool": { "type": "string", "description": "使用的工具列表，以 ';' 分割。" }, - "tool_input": { "type": "string", "description": "工具的输入，JSON 格式的字符串。" }, - "message_files": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "当前 agent_thought 关联的文件ID列表 (原描述为 file_id 字符串，修正为数组以匹配 agent_thoughts 历史消息中的 files)。" } + "id": { + "type": "string", + "format": "uuid", + "description": "agent_thought ID。" + }, + "position": { + "type": "integer", + "description": "agent_thought 在消息中的位置。" + }, + "thought": { + "type": "string", + "description": "agent 的思考内容。" + }, + "observation": { + "type": "string", + "description": "工具调用的返回结果。" + }, + "tool": { + "type": "string", + "description": "使用的工具列表，以 ';' 分割。" + }, + "tool_input": { + "type": "string", + "description": "工具的输入，JSON 格式的字符串。" + }, + "message_files": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "description": "当前 agent_thought 关联的文件ID列表 (原描述为 file_id 字符串，修正为数组以匹配 agent_thoughts 历史消息中的 files)。" + } } } ] }, - "StreamEventMessageFileCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "type": "object", "required": ["id", "type", "belongs_to", "url", "conversation_id"], "properties": { "id": { "type": "string", "format": "uuid", "description": "文件唯一ID。" }, "type": { "type": "string", "enum": ["image"], "description": "文件类型，目前仅为 image。" }, "belongs_to": { "type": "string", "enum": ["assistant"], "description": "文件归属，仅为 assistant。" }, "url": { "type": "string", "format": "url", "description": "文件访问地址。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会话ID。" } } } ] }, - "StreamEventMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataCn" } } } ] }, - "StreamEventTtsMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64 编码的音频块。" } } } ] }, - "StreamEventTtsMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空字符串。" } } } ] }, - "StreamEventMessageReplaceCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "替换内容（直接替换 LLM 所有回复文本）。" } } } ] }, - "StreamEventErrorCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "type": "object", "required": ["task_id", "status", "code", "message"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid", "nullable": true, "description": "消息唯一 ID（错误事件中可能不存在）。" }, "status": { "type": "integer", "description": "HTTP 状态码。" }, "code": { "type": "string", "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } ] }, - "StreamEventPingCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "type": "object", "description": "每 10s 一次的 ping 事件，保持连接存活。" } ] }, - "UsageCn": { "type": "object", "description": "模型用量信息。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, - "RetrieverResourceCn": { "type": "object", "description": "引用和归属分段信息。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } }, - "FileUploadResponseCn": { "type": "object", "description": "文件上传成功后的响应。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "文件名。" }, "size": { "type": "integer", "description": "文件大小 (byte)。" }, "extension": { "type": "string", "description": "文件后缀。" }, "mime_type": { "type": "string", "description": "文件 mime-type。" }, "created_by": { "type": "string", "format": "uuid", "description": "上传人 ID。" }, "created_at": { "type": "integer", "format": "int64", "description": "上传时间。" } } }, - "EndUserDetailCn": { - "type": "object", - "properties": { - "id": { "type": "string", "format": "uuid" }, - "tenant_id": { "type": "string", "format": "uuid" }, - "app_id": { "type": "string", "format": "uuid", "nullable": true }, - "type": { "type": "string", "example": "service_api" }, - "external_user_id": { "type": "string", "nullable": true }, - "name": { "type": "string", "nullable": true }, - "is_anonymous": { "type": "boolean" }, - "session_id": { "type": "string" }, - "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { "type": "string", "format": "date-time" } - } - }, - "MessageFeedbackRequestCn": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "点赞 'like', 点踩 'dislike', 撤销点赞 null。" }, "user": { "type": "string", "description": "用户标识。" }, "content": { "type": "string", "nullable": true, "description": "消息反馈的具体信息。" } } }, - "AppFeedbacksResponseCn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemCn" }, "description": "返回该APP的点赞、反馈列表。" } } }, - "FeedbackItemCn": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, - "SuggestedQuestionsResponseCn": { "type": "object", "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "string" }, "description": "建议问题列表。" } } }, - "BasicConversationHistoryResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返回条数。" }, "has_more": { "type": "boolean", "description": "是否存在下一页。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BasicConversationMessageItemCn" }, "description": "消息列表。" } } }, - "BasicConversationMessageItemCn": { "type": "object", "description": "会话中的单条消息。", "properties": { "id": { "type": "string", "format": "uuid", "description": "消息 ID。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "用户输入参数。" }, "query": { "type": "string", "description": "用户输入/提问内容。" }, "answer": { "type": "string", "description": "回答消息内容。" }, "message_files": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFileItemCn" }, "description": "消息文件列表。" }, "feedback": { "type": "object", "nullable": true, "properties": { "rating": { "type": "string", "enum": ["like", "dislike"], "description": "点赞 'like' / 点踩 'dislike'。" } }, "description": "反馈信息。" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceCn" }, "description": "引用和归属分段列表。" }, "agent_thoughts": { "type": "array", "items": { "$ref": "#/components/schemas/AgentThoughtItemCn" }, "description": "Agent思考内容（仅Agent模式下不为空）。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" } } }, - "MessageFileItemCn": { "type": "object", "description": "消息中的文件项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "文件类型，例如 'image'。" }, "url": { "type": "string", "format": "url", "description": "预览图片地址。" }, "belongs_to": { "type": "string", "enum": ["user", "assistant"], "description": "文件归属方。" } } }, - "AgentThoughtItemCn": { - "type": "object", "description": "Agent思考内容。", - "properties": { - "id": { "type": "string", "format": "uuid", "description": "agent_thought ID。" }, - "chain_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（示例中存在，描述中未明确，暂定为可选）"}, - "message_id": { "type": "string", "format": "uuid", "description": "消息唯一ID。" }, - "position": { "type": "integer", "description": "agent_thought在消息中的位置。" }, - "thought": { "type": "string", "description": "agent的思考内容。" }, - "tool": { "type": "string", "description": "使用的工具列表，以 ';' 分割。" }, - "tool_input": { "type": "string", "description": "工具的输入，JSON格式的字符串。" }, - "observation": { "type": "string", "description": "工具调用的返回结果。" }, - "files": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "当前agent_thought关联的文件ID (示例中为files，markdown中为message_files.file_id)。" }, - "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } - } - }, - "ConversationsListResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返回条数。" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationListItemCn" }, "description": "会话列表。" } } }, - "ConversationListItemCn": { "type": "object", "description": "会话列表中的单项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, "name": { "type": "string", "description": "会话名称。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "用户输入参数。" }, "status": { "type": "string", "description": "会话状态。" }, "introduction": { "type": "string", "nullable": true, "description": "开场白。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" }, "updated_at": { "type": "integer", "format": "int64", "description": "更新时间。" } } }, - "ConversationRenameRequestCn": { "type": "object", "required": ["user"], "properties": { "name": { "type": "string", "nullable": true, "description": "（选填）名称，若 auto_generate 为 true 时可不传。" }, "auto_generate": { "type": "boolean", "default": false, "description": "（选填）自动生成标题，默认 false。" }, "user": { "type": "string", "description": "用户标识。" } } }, - "ConversationRenameResponseCn": { "$ref": "#/components/schemas/ConversationListItemCn" }, - "ConversationVariablesResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "每页项目数。" }, "has_more": { "type": "boolean", "description": "是否有更多项目。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationVariableItemCn" }, "description": "变量列表。" } } }, - "ConversationVariableItemCn": { "type": "object", "description": "对话中的变量项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "变量ID。" }, "name": { "type": "string", "description": "变量名称。" }, "value_type": { "type": "string", "description": "变量类型 (string, number, boolean 等)。" }, "value": { "type": "string", "description": "变量值。" }, "description": { "type": "string", "nullable": true, "description": "变量描述。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" }, "updated_at": { "type": "integer", "format": "int64", "description": "最后更新时间戳。" } } }, - "AudioToTextRequestCn": { "type": "object", "required": ["file", "user"], "properties": { "file": { "type": "string", "format": "binary", "description": "语音文件。支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']。大小限制：15MB。" }, "user": { "type": "string", "description": "用户标识。" } } }, - "AudioToTextResponseCn": { "type": "object", "properties": { "text": { "type": "string", "description": "输出文字。" } } }, - "TextToAudioFormRequestCn": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "消息ID (优先)。" }, "text": { "type": "string", "description": "语音生成内容。" }, "user": { "type": "string", "description": "用户标识。" } }, "description": "需要 `user`。提供 `message_id` 或 `text`。" }, - "AppInfoResponseCn": { "type": "object", "description": "应用基本信息。", "properties": { "name": { "type": "string", "description": "应用名称。" }, "description": { "type": "string", "description": "应用描述。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "应用标签。" } } }, - "ChatAppParametersResponseCn": { "type": "object", "description": "应用参数信息。", "properties": { "opening_statement": { "type": "string", "description": "开场白。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "开场推荐问题列表。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "启用回答后给出推荐问题。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "语音转文本。" }, "text_to_speech": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" }, "voice": { "type": "string", "description": "语音类型。" }, "language": { "type": "string", "description": "语言。" }, "autoPlay": { "type": "string", "enum": ["enabled", "disabled"], "description": "自动播放：enabled 开启, disabled 关闭。" } }, "description": "文本转语音。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "引用和归属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "标记回复。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemCn" }, "description": "用户输入表单配置。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "图片设置。支持 png, jpg, jpeg, webp, gif。" } }, "description": "文件上传配置。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "文档上传大小限制 (MB)。" }, "image_file_size_limit": { "type": "integer", "description": "图片文件上传大小限制（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "音频文件上传大小限制 (MB)。" }, "video_file_size_limit": { "type": "integer", "description": "视频文件上传大小限制 (MB)。" } }, "description": "系统参数。" } } }, - "UserInputFormItemCn": { "type": "object", "description": "用户输入表单中的控件项。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperCn" }, { "$ref": "#/components/schemas/ParagraphControlWrapperCn" }, { "$ref": "#/components/schemas/SelectControlWrapperCn" } ] }, - "TextInputControlWrapperCn": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlCn" } }, "required":["text-input"] }, - "ParagraphControlWrapperCn": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlCn" } }, "required":["paragraph"] }, - "SelectControlWrapperCn": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlCn" } }, "required":["select"] }, - "TextInputControlCn": { "type": "object", "description": "文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, - "ParagraphControlCn": { "type": "object", "description": "段落文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, - "SelectControlCn": { "type": "object", "description": "下拉控件。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "选项值。" } } }, - "AppMetaResponseCn": { "type": "object", "description": "应用 Meta 信息。", "properties": { "tool_icons": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "format": "url", "description": "图标 URL。" }, { "$ref": "#/components/schemas/ToolIconDetailCn" } ] }, "description": "工具图标，键为工具名称。" } } }, - "ToolIconDetailCn": { "type": "object", "description": "工具图标详情。", "properties": { "background": { "type": "string", "description": "hex 格式的背景色。" }, "content": { "type": "string", "description": "emoji。" } } }, - "WebAppSettingsResponseCn": { "type": "object", "description": "应用 WebApp 设置。", "properties": { "title": { "type": "string", "description": "WebApp 名称。" }, "chat_color_theme": { "type": "string", "description": "聊天颜色主题, hex 格式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "图标类型。" }, "icon": { "type": "string", "description": "图标内容 (emoji 或图片 URL)。" }, "icon_background": { "type": "string", "description": "hex 格式的背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "图标 URL。" }, "description": { "type": "string", "description": "描述。" }, "copyright": { "type": "string", "description": "版权信息。" }, "privacy_policy": { "type": "string", "description": "隐私政策链接。" }, "custom_disclaimer": { "type": "string", "description": "自定义免责声明。" }, "default_language": { "type": "string", "description": "默认语言。" }, "show_workflow_steps": { "type": "boolean", "description": "是否显示工作流详情。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "是否使用 WebApp 图标替换聊天中的机器人图标。" } } }, - "ErrorResponseCn": { "type": "object", "description": "错误响应。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTP 状态码。" }, "code": { "type": "string", "nullable": true, "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } - } - }, - "tags": [ - { "name": "对话消息", "description": "与对话消息和交互相关的操作。" }, - { "name": "文件操作", "description": "文件上传和预览相关的操作。" }, - { "name": "终端用户", "description": "终端用户信息相关的操作。" }, - { "name": "消息反馈", "description": "用户对消息的反馈操作。" }, - { "name": "会话管理", "description": "管理对话会话相关的操作。" }, - { "name": "语音与文字转换", "description": "文本转语音和语音转文本操作。" }, - { "name": "应用配置", "description": "获取应用设置和信息相关的操作。" } + "StreamEventMessageFileCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "type": "object", + "required": [ + "id", + "type", + "belongs_to", + "url", + "conversation_id" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "文件唯一ID。" + }, + "type": { + "type": "string", + "enum": [ + "image" + ], + "description": "文件类型，目前仅为 image。" + }, + "belongs_to": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "文件归属，仅为 assistant。" + }, + "url": { + "type": "string", + "format": "url", + "description": "文件访问地址。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会话ID。" + } + } + } + ] + }, + "StreamEventMessageEndCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "metadata" + ], + "properties": { + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataCn" + } + } + } + ] + }, + "StreamEventTtsMessageCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "format": "byte", + "description": "Base64 编码的音频块。" + } + } + } + ] + }, + "StreamEventTtsMessageEndCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "description": "空字符串。" + } + } + } + ] + }, + "StreamEventMessageReplaceCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "替换内容（直接替换 LLM 所有回复文本）。" + } + } + } + ] + }, + "StreamEventErrorCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "type": "object", + "required": [ + "task_id", + "status", + "code", + "message" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "message_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "消息唯一 ID（错误事件中可能不存在）。" + }, + "status": { + "type": "integer", + "description": "HTTP 状态码。" + }, + "code": { + "type": "string", + "description": "错误码。" + }, + "message": { + "type": "string", + "description": "错误消息。" + } + } + } + ] + }, + "StreamEventPingCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkBasicChatEventCn" + }, + { + "type": "object", + "description": "每 10s 一次的 ping 事件，保持连接存活。" + } + ] + }, + "UsageCn": { + "type": "object", + "description": "模型用量信息。", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "prompt_unit_price": { + "type": "string" + }, + "prompt_price_unit": { + "type": "string" + }, + "prompt_price": { + "type": "string" + }, + "completion_tokens": { + "type": "integer" + }, + "completion_unit_price": { + "type": "string" + }, + "completion_price_unit": { + "type": "string" + }, + "completion_price": { + "type": "string" + }, + "total_tokens": { + "type": "integer" + }, + "total_price": { + "type": "string" + }, + "currency": { + "type": "string" + }, + "latency": { + "type": "number", + "format": "double" + } + } + }, + "RetrieverResourceCn": { + "type": "object", + "description": "引用和归属分段信息。", + "properties": { + "position": { + "type": "integer" + }, + "dataset_id": { + "type": "string", + "format": "uuid" + }, + "dataset_name": { + "type": "string" + }, + "document_id": { + "type": "string", + "format": "uuid" + }, + "document_name": { + "type": "string" + }, + "segment_id": { + "type": "string", + "format": "uuid" + }, + "score": { + "type": "number", + "format": "float" + }, + "content": { + "type": "string" + } + } + }, + "FileUploadResponseCn": { + "type": "object", + "description": "文件上传成功后的响应。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "name": { + "type": "string", + "description": "文件名。" + }, + "size": { + "type": "integer", + "description": "文件大小 (byte)。" + }, + "extension": { + "type": "string", + "description": "文件后缀。" + }, + "mime_type": { + "type": "string", + "description": "文件 mime-type。" + }, + "created_by": { + "type": "string", + "format": "uuid", + "description": "上传人 ID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "上传时间。" + } + } + }, + "EndUserDetailCn": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "tenant_id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "type": { + "type": "string", + "example": "service_api" + }, + "external_user_id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "is_anonymous": { + "type": "boolean" + }, + "session_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "MessageFeedbackRequestCn": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true, + "description": "点赞 'like', 点踩 'dislike', 撤销点赞 null。" + }, + "user": { + "type": "string", + "description": "用户标识。" + }, + "content": { + "type": "string", + "nullable": true, + "description": "消息反馈的具体信息。" + } + } + }, + "AppFeedbacksResponseCn": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeedbackItemCn" + }, + "description": "返回该APP的点赞、反馈列表。" + } + } + }, + "FeedbackItemCn": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid" + }, + "conversation_id": { + "type": "string", + "format": "uuid" + }, + "message_id": { + "type": "string", + "format": "uuid" + }, + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true + }, + "content": { + "type": "string" + }, + "from_source": { + "type": "string" + }, + "from_end_user_id": { + "type": "string", + "format": "uuid" + }, + "from_account_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "SuggestedQuestionsResponseCn": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + }, + "data": { + "type": "array", + "items": { + "type": "string" + }, + "description": "建议问题列表。" + } + } + }, + "BasicConversationHistoryResponseCn": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "返回条数。" + }, + "has_more": { + "type": "boolean", + "description": "是否存在下一页。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BasicConversationMessageItemCn" + }, + "description": "消息列表。" + } + } + }, + "BasicConversationMessageItemCn": { + "type": "object", + "description": "会话中的单条消息。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "消息 ID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会话 ID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "用户输入参数。" + }, + "query": { + "type": "string", + "description": "用户输入/提问内容。" + }, + "answer": { + "type": "string", + "description": "回答消息内容。" + }, + "message_files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageFileItemCn" + }, + "description": "消息文件列表。" + }, + "feedback": { + "type": "object", + "nullable": true, + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike" + ], + "description": "点赞 'like' / 点踩 'dislike'。" + } + }, + "description": "反馈信息。" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResourceCn" + }, + "description": "引用和归属分段列表。" + }, + "agent_thoughts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AgentThoughtItemCn" + }, + "description": "Agent思考内容（仅Agent模式下不为空）。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间。" + } + } + }, + "MessageFileItemCn": { + "type": "object", + "description": "消息中的文件项。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "type": { + "type": "string", + "description": "文件类型，例如 'image'。" + }, + "url": { + "type": "string", + "format": "url", + "description": "预览图片地址。" + }, + "belongs_to": { + "type": "string", + "enum": [ + "user", + "assistant" + ], + "description": "文件归属方。" + } + } + }, + "AgentThoughtItemCn": { + "type": "object", + "description": "Agent思考内容。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "agent_thought ID。" + }, + "chain_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "（示例中存在，描述中未明确，暂定为可选）" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息唯一ID。" + }, + "position": { + "type": "integer", + "description": "agent_thought在消息中的位置。" + }, + "thought": { + "type": "string", + "description": "agent的思考内容。" + }, + "tool": { + "type": "string", + "description": "使用的工具列表，以 ';' 分割。" + }, + "tool_input": { + "type": "string", + "description": "工具的输入，JSON格式的字符串。" + }, + "observation": { + "type": "string", + "description": "工具调用的返回结果。" + }, + "files": { + "type": "array", + "items": { + "type": "string", + "format": "uuid" + }, + "description": "当前agent_thought关联的文件ID (示例中为files，markdown中为message_files.file_id)。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间戳。" + } + } + }, + "ConversationsListResponseCn": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "返回条数。" + }, + "has_more": { + "type": "boolean" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationListItemCn" + }, + "description": "会话列表。" + } + } + }, + "ConversationListItemCn": { + "type": "object", + "description": "会话列表中的单项。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "会话 ID。" + }, + "name": { + "type": "string", + "description": "会话名称。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "用户输入参数。" + }, + "status": { + "type": "string", + "description": "会话状态。" + }, + "introduction": { + "type": "string", + "nullable": true, + "description": "开场白。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间。" + }, + "updated_at": { + "type": "integer", + "format": "int64", + "description": "更新时间。" + } + } + }, + "ConversationRenameRequestCn": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "name": { + "type": "string", + "nullable": true, + "description": "（选填）名称，若 auto_generate 为 true 时可不传。" + }, + "auto_generate": { + "type": "boolean", + "default": false, + "description": "（选填）自动生成标题，默认 false。" + }, + "user": { + "type": "string", + "description": "用户标识。" + } + } + }, + "ConversationRenameResponseCn": { + "$ref": "#/components/schemas/ConversationListItemCn" + }, + "ConversationVariablesResponseCn": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "每页项目数。" + }, + "has_more": { + "type": "boolean", + "description": "是否有更多项目。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationVariableItemCn" + }, + "description": "变量列表。" + } + } + }, + "ConversationVariableItemCn": { + "type": "object", + "description": "对话中的变量项。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "变量ID。" + }, + "name": { + "type": "string", + "description": "变量名称。" + }, + "value_type": { + "type": "string", + "description": "变量类型 (string, number, boolean 等)。" + }, + "value": { + "type": "string", + "description": "变量值。" + }, + "description": { + "type": "string", + "nullable": true, + "description": "变量描述。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间戳。" + }, + "updated_at": { + "type": "integer", + "format": "int64", + "description": "最后更新时间戳。" + } + } + }, + "AudioToTextRequestCn": { + "type": "object", + "required": [ + "file", + "user" + ], + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "语音文件。支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']。大小限制：15MB。" + }, + "user": { + "type": "string", + "description": "用户标识。" + } + } + }, + "AudioToTextResponseCn": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "输出文字。" + } + } + }, + "TextToAudioFormRequestCn": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息ID (优先)。" + }, + "text": { + "type": "string", + "description": "语音生成内容。" + }, + "user": { + "type": "string", + "description": "用户标识。" + } + }, + "description": "需要 `user`。提供 `message_id` 或 `text`。" + }, + "AppInfoResponseCn": { + "type": "object", + "description": "应用基本信息。", + "properties": { + "name": { + "type": "string", + "description": "应用名称。" + }, + "description": { + "type": "string", + "description": "应用描述。" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "应用标签。" + } + } + }, + "ChatAppParametersResponseCn": { + "type": "object", + "description": "应用参数信息。", + "properties": { + "opening_statement": { + "type": "string", + "description": "开场白。" + }, + "suggested_questions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "开场推荐问题列表。" + }, + "suggested_questions_after_answer": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + } + }, + "description": "启用回答后给出推荐问题。" + }, + "speech_to_text": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + } + }, + "description": "语音转文本。" + }, + "text_to_speech": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + }, + "voice": { + "type": "string", + "description": "语音类型。" + }, + "language": { + "type": "string", + "description": "语言。" + }, + "autoPlay": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "description": "自动播放：enabled 开启, disabled 关闭。" + } + }, + "description": "文本转语音。" + }, + "retriever_resource": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + } + }, + "description": "引用和归属。" + }, + "annotation_reply": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + } + }, + "description": "标记回复。" + }, + "user_input_form": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserInputFormItemCn" + }, + "description": "用户输入表单配置。" + }, + "file_upload": { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "number_limits": { + "type": "integer" + }, + "transfer_methods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ] + } + } + }, + "description": "图片设置。支持 png, jpg, jpeg, webp, gif。" + } + }, + "description": "文件上传配置。" + }, + "system_parameters": { + "type": "object", + "properties": { + "file_size_limit": { + "type": "integer", + "description": "文档上传大小限制 (MB)。" + }, + "image_file_size_limit": { + "type": "integer", + "description": "图片文件上传大小限制（MB）。" + }, + "audio_file_size_limit": { + "type": "integer", + "description": "音频文件上传大小限制 (MB)。" + }, + "video_file_size_limit": { + "type": "integer", + "description": "视频文件上传大小限制 (MB)。" + } + }, + "description": "系统参数。" + } + } + }, + "UserInputFormItemCn": { + "type": "object", + "description": "用户输入表单中的控件项。", + "oneOf": [ + { + "$ref": "#/components/schemas/TextInputControlWrapperCn" + }, + { + "$ref": "#/components/schemas/ParagraphControlWrapperCn" + }, + { + "$ref": "#/components/schemas/SelectControlWrapperCn" + } + ] + }, + "TextInputControlWrapperCn": { + "type": "object", + "properties": { + "text-input": { + "$ref": "#/components/schemas/TextInputControlCn" + } + }, + "required": [ + "text-input" + ] + }, + "ParagraphControlWrapperCn": { + "type": "object", + "properties": { + "paragraph": { + "$ref": "#/components/schemas/ParagraphControlCn" + } + }, + "required": [ + "paragraph" + ] + }, + "SelectControlWrapperCn": { + "type": "object", + "properties": { + "select": { + "$ref": "#/components/schemas/SelectControlCn" + } + }, + "required": [ + "select" + ] + }, + "TextInputControlCn": { + "type": "object", + "description": "文本输入控件。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "默认值。" + } + } + }, + "ParagraphControlCn": { + "type": "object", + "description": "段落文本输入控件。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "默认值。" + } + } + }, + "SelectControlCn": { + "type": "object", + "description": "下拉控件。", + "required": [ + "label", + "variable", + "required", + "options" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "默认值。" + }, + "options": { + "type": "array", + "items": { + "type": "string" + }, + "description": "选项值。" + } + } + }, + "AppMetaResponseCn": { + "type": "object", + "description": "应用 Meta 信息。", + "properties": { + "tool_icons": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "string", + "format": "url", + "description": "图标 URL。" + }, + { + "$ref": "#/components/schemas/ToolIconDetailCn" + } + ] + }, + "description": "工具图标，键为工具名称。" + } + } + }, + "ToolIconDetailCn": { + "type": "object", + "description": "工具图标详情。", + "properties": { + "background": { + "type": "string", + "description": "hex 格式的背景色。" + }, + "content": { + "type": "string", + "description": "emoji。" + } + } + }, + "WebAppSettingsResponseCn": { + "type": "object", + "description": "应用 WebApp 设置。", + "properties": { + "title": { + "type": "string", + "description": "WebApp 名称。" + }, + "chat_color_theme": { + "type": "string", + "description": "聊天颜色主题, hex 格式。" + }, + "chat_color_theme_inverted": { + "type": "boolean", + "description": "聊天颜色主题是否反转。" + }, + "icon_type": { + "type": "string", + "enum": [ + "emoji", + "image" + ], + "description": "图标类型。" + }, + "icon": { + "type": "string", + "description": "图标内容 (emoji 或图片 URL)。" + }, + "icon_background": { + "type": "string", + "description": "hex 格式的背景色。" + }, + "icon_url": { + "type": "string", + "format": "url", + "nullable": true, + "description": "图标 URL。" + }, + "description": { + "type": "string", + "description": "描述。" + }, + "copyright": { + "type": "string", + "description": "版权信息。" + }, + "privacy_policy": { + "type": "string", + "description": "隐私政策链接。" + }, + "custom_disclaimer": { + "type": "string", + "description": "自定义免责声明。" + }, + "default_language": { + "type": "string", + "description": "默认语言。" + }, + "show_workflow_steps": { + "type": "boolean", + "description": "是否显示工作流详情。" + }, + "use_icon_as_answer_icon": { + "type": "boolean", + "description": "是否使用 WebApp 图标替换聊天中的机器人图标。" + } + } + }, + "ErrorResponseCn": { + "type": "object", + "description": "错误响应。", + "properties": { + "status": { + "type": "integer", + "nullable": true, + "description": "HTTP 状态码。" + }, + "code": { + "type": "string", + "nullable": true, + "description": "错误码。" + }, + "message": { + "type": "string", + "description": "错误消息。" + } + } + } + } + }, + "tags": [ + { + "name": "对话消息", + "description": "与对话消息和交互相关的操作。" + }, + { + "name": "文件操作", + "description": "文件上传和预览相关的操作。" + }, + { + "name": "终端用户", + "description": "终端用户信息相关的操作。" + }, + { + "name": "消息反馈", + "description": "用户对消息的反馈操作。" + }, + { + "name": "会话管理", + "description": "管理对话会话相关的操作。" + }, + { + "name": "语音与文字转换", + "description": "文本转语音和语音转文本操作。" + }, + { + "name": "应用配置", + "description": "获取应用设置和信息相关的操作。" + } ] -} \ No newline at end of file +} diff --git a/zh/api-reference/openapi_chatflow.json b/zh/api-reference/openapi_chatflow.json index 341280133..17f374c62 100644 --- a/zh/api-reference/openapi_chatflow.json +++ b/zh/api-reference/openapi_chatflow.json @@ -27,8 +27,10 @@ "post": { "summary": "发送对话消息", "description": "创建会话消息。", - "operationId": "sendChatMessageCn", - "tags": ["对话消息"], + "operationId": "sendAdvancedChatMessage", + "tags": [ + "对话消息" + ], "requestBody": { "description": "发送对话消息的请求体。", "required": true, @@ -78,9 +80,15 @@ } } }, - "400": { "$ref": "#/components/responses/BadRequestGenericCn" }, - "404": { "$ref": "#/components/responses/ConversationNotFoundCn" }, - "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + "400": { + "$ref": "#/components/responses/BadRequestGenericCn" + }, + "404": { + "$ref": "#/components/responses/ConversationNotFoundCn" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorCn" + } } } }, @@ -88,8 +96,10 @@ "post": { "summary": "上传文件", "description": "上传文件并在发送消息时使用，可实现图文多模态理解。支持你的应用程序所支持的所有格式。上传的文件仅供当前终端用户使用。", - "operationId": "uploadFileCn", - "tags": ["文件操作"], + "operationId": "uploadAdvancedChatFile", + "tags": [ + "文件操作" + ], "requestBody": { "description": "文件上传请求。需使用 `multipart/form-data` 进行请求。", "required": true, @@ -97,7 +107,10 @@ "multipart/form-data": { "schema": { "type": "object", - "required": ["file", "user"], + "required": [ + "file", + "user" + ], "properties": { "file": { "type": "string", @@ -124,15 +137,31 @@ } } }, - "201": { + "201": { "description": "文件创建成功 (备选成功状态码)。", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseCn" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseCn" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequestFileCn" + }, + "413": { + "$ref": "#/components/responses/FileTooLargeCn" + }, + "415": { + "$ref": "#/components/responses/UnsupportedFileTypeFileCn" + }, + "503": { + "$ref": "#/components/responses/S3ErrorFileCn" }, - "400": { "$ref": "#/components/responses/BadRequestFileCn" }, - "413": { "$ref": "#/components/responses/FileTooLargeCn" }, - "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileCn" }, - "503": { "$ref": "#/components/responses/S3ErrorFileCn" }, - "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + "500": { + "$ref": "#/components/responses/InternalServerErrorCn" + } } } }, @@ -140,15 +169,20 @@ "get": { "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", - "operationId": "getEndUserChatflowCn", - "tags": ["终端用户"], + "operationId": "getEndUserChatflow", + "tags": [ + "终端用户" + ], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "终端用户 ID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -156,12 +190,18 @@ "description": "成功获取终端用户信息。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/EndUserDetailCn" } + "schema": { + "$ref": "#/components/schemas/EndUserDetailCn" + } } } }, - "404": { "$ref": "#/components/responses/EndUserNotFoundCn" }, - "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + "404": { + "$ref": "#/components/responses/EndUserNotFoundCn" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorCn" + } } } }, @@ -169,8 +209,10 @@ "get": { "summary": "文件预览", "description": "预览或下载已上传的文件。此端点允许你访问之前通过文件上传API上传的文件。文件只能在所属的应用程序消息内访问。", - "operationId": "previewChatFlowFileCn", - "tags": ["文件操作"], + "operationId": "previewChatFlowFile", + "tags": [ + "文件操作" + ], "parameters": [ { "name": "file_id", @@ -267,7 +309,9 @@ "description": "错误请求。可能的错误代码:\n- `invalid_param`: 异常参数输入。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } } } }, @@ -275,7 +319,9 @@ "description": "禁止访问。可能的错误代码:\n- `file_access_denied`: 文件访问被拒绝或文件不属于当前应用程序。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } } } }, @@ -283,7 +329,9 @@ "description": "未找到。可能的错误代码:\n- `file_not_found`: 文件未找到或已被删除。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } } } }, @@ -291,7 +339,9 @@ "description": "内部服务器错误。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } } } } @@ -302,15 +352,20 @@ "post": { "summary": "停止响应", "description": "停止生成对话消息。仅支持流式模式。", - "operationId": "stopChatMessageGenerationCn", - "tags": ["对话消息"], + "operationId": "stopAdvancedChatMessageGeneration", + "tags": [ + "对话消息" + ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "任务 ID，可在流式返回 Chunk 中获取。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { @@ -319,7 +374,9 @@ "application/json": { "schema": { "type": "object", - "required": ["user"], + "required": [ + "user" + ], "properties": { "user": { "type": "string", @@ -331,7 +388,9 @@ } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResultCn" } + "200": { + "$ref": "#/components/responses/SuccessResultCn" + } } } }, @@ -339,27 +398,36 @@ "post": { "summary": "消息反馈（点赞）", "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", - "operationId": "postMessageFeedbackCn", - "tags": ["消息反馈"], + "operationId": "postAdvancedChatMessageFeedback", + "tags": [ + "消息反馈" + ], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestCn" } + "schema": { + "$ref": "#/components/schemas/MessageFeedbackRequestCn" + } } } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResultCn" } + "200": { + "$ref": "#/components/responses/SuccessResultCn" + } } } }, @@ -367,18 +435,26 @@ "get": { "summary": "获取APP的消息点赞和反馈", "description": "获取应用的终端用户反馈、点赞。", - "operationId": "getAppFeedbacksCn", - "tags": ["消息反馈"], + "operationId": "getAdvancedChatAppFeedbacks", + "tags": [ + "消息反馈" + ], "parameters": [ - { "$ref": "#/components/parameters/PageQueryParamCn" }, - { "$ref": "#/components/parameters/LimitQueryParamCn" } + { + "$ref": "#/components/parameters/PageQueryParamCn" + }, + { + "$ref": "#/components/parameters/LimitQueryParamCn" + } ], "responses": { "200": { "description": "成功获取应用的反馈列表。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseCn" } + "schema": { + "$ref": "#/components/schemas/AppFeedbacksResponseCn" + } } } } @@ -389,24 +465,33 @@ "get": { "summary": "获取下一轮建议问题列表", "description": "获取当前消息的下一轮建议问题列表。", - "operationId": "getSuggestedQuestionsCn", - "tags": ["对话消息"], + "operationId": "getAdvancedSuggestedQuestions", + "tags": [ + "对话消息" + ], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } }, - { "$ref": "#/components/parameters/UserQueryParamCn" } + { + "$ref": "#/components/parameters/UserQueryParamCn" + } ], "responses": { "200": { "description": "成功获取建议问题列表。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/SuggestedQuestionsResponseCn" } + "schema": { + "$ref": "#/components/schemas/SuggestedQuestionsResponseCn" + } } } } @@ -417,25 +502,39 @@ "get": { "summary": "获取会话历史消息", "description": "滚动加载形式返回历史聊天记录，第一页返回最新 `limit` 条，即倒序返回。", - "operationId": "getConversationHistoryCn", - "tags": ["会话管理"], + "operationId": "getAdvancedConversationHistory", + "tags": [ + "会话管理" + ], "parameters": [ - { "$ref": "#/components/parameters/ConversationIdQueryParamCn" }, - { "$ref": "#/components/parameters/UserQueryParamCn" }, + { + "$ref": "#/components/parameters/ConversationIdQueryParamCn" + }, + { + "$ref": "#/components/parameters/UserQueryParamCn" + }, { "name": "first_id", "in": "query", "description": "当前页第一条聊天记录的 ID，默认 null。", - "schema": { "type": "string", "format": "uuid", "nullable": true } + "schema": { + "type": "string", + "format": "uuid", + "nullable": true + } }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20Cn" } + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Cn" + } ], "responses": { "200": { "description": "成功获取会话历史消息。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ConversationHistoryResponseCn" } + "schema": { + "$ref": "#/components/schemas/ConversationHistoryResponseCn" + } } } } @@ -446,20 +545,32 @@ "get": { "summary": "获取会话列表", "description": "获取当前用户的会话列表，默认返回最近的 20 条。", - "operationId": "getConversationsListCn", - "tags": ["会话管理"], + "operationId": "getAdvancedConversationsList", + "tags": [ + "会话管理" + ], "parameters": [ - { "$ref": "#/components/parameters/UserQueryParamCn" }, - { "$ref": "#/components/parameters/LastIdQueryParamCn" }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" }, - { "$ref": "#/components/parameters/SortByQueryParamCn" } + { + "$ref": "#/components/parameters/UserQueryParamCn" + }, + { + "$ref": "#/components/parameters/LastIdQueryParamCn" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" + }, + { + "$ref": "#/components/parameters/SortByQueryParamCn" + } ], "responses": { "200": { "description": "成功获取会话列表。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ConversationsListResponseCn" } + "schema": { + "$ref": "#/components/schemas/ConversationsListResponseCn" + } } } } @@ -470,54 +581,114 @@ "delete": { "summary": "删除会话", "description": "删除一个指定的会话。", - "operationId": "deleteConversationCn", - "tags": ["会话管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamCn" } ], + "operationId": "deleteAdvancedConversation", + "tags": [ + "会话管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdPathParamCn" + } + ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", "required": ["user"], - "properties": { "user": { "type": "string", "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" } } + "type": "object", + "required": [ + "user" + ], + "properties": { + "user": { + "type": "string", + "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" + } + } } } } }, - "responses": { "204": { "description": "会话删除成功，无内容返回。" } } + "responses": { + "204": { + "description": "会话删除成功，无内容返回。" + } + } } }, "/conversations/{conversation_id}/name": { "post": { "summary": "会话重命名", "description": "对会话进行重命名。", - "operationId": "renameConversationCn", - "tags": ["会话管理"], - "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamCn" } ], + "operationId": "renameAdvancedConversation", + "tags": [ + "会话管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/ConversationIdPathParamCn" + } + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameRequestCn" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationRenameRequestCn" + } + } + } }, "responses": { - "200": { "description": "会话重命名成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameResponseCn" } } } } + "200": { + "description": "会话重命名成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationRenameResponseCn" + } + } + } + } } } }, - "/conversations/{conversation_id}/variables": { + "/conversations/{conversation_id}/variables": { "get": { "summary": "获取对话变量", "description": "从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。", - "operationId": "getConversationVariablesCn", - "tags": ["会话管理"], + "operationId": "getAdvancedConversationVariables", + "tags": [ + "会话管理" + ], "parameters": [ - { "$ref": "#/components/parameters/ConversationIdPathParamCn" }, - { "$ref": "#/components/parameters/UserQueryParamCn" }, - { "$ref": "#/components/parameters/LastIdQueryParamCn" }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" } + { + "$ref": "#/components/parameters/ConversationIdPathParamCn" + }, + { + "$ref": "#/components/parameters/UserQueryParamCn" + }, + { + "$ref": "#/components/parameters/LastIdQueryParamCn" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" + } ], "responses": { - "200": { "description": "成功获取对话变量。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationVariablesResponseCn" } } } }, - "404": { "$ref": "#/components/responses/ConversationNotFoundCn" } + "200": { + "description": "成功获取对话变量。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConversationVariablesResponseCn" + } + } + } + }, + "404": { + "$ref": "#/components/responses/ConversationNotFoundCn" + } } } }, @@ -525,14 +696,31 @@ "post": { "summary": "语音转文字", "description": "将语音文件转换为文字。支持格式：mp3, mp4, mpeg, mpga, m4a, wav, webm。文件大小限制：15MB。", - "operationId": "audioToTextCn", - "tags": ["语音与文字转换"], + "operationId": "advancedAudioToText", + "tags": [ + "语音与文字转换" + ], "requestBody": { "required": true, - "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioToTextRequestCn" } } } + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/AudioToTextRequestCn" + } + } + } }, "responses": { - "200": { "description": "成功将语音转换为文字。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioToTextResponseCn" } } } } + "200": { + "description": "成功将语音转换为文字。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AudioToTextResponseCn" + } + } + } + } } } }, @@ -540,17 +728,45 @@ "post": { "summary": "文字转语音", "description": "将文字内容转换为语音。", - "operationId": "textToAudioCn", - "tags": ["语音与文字转换"], + "operationId": "advancedTextToAudio", + "tags": [ + "语音与文字转换" + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextToAudioJsonRequestCn" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TextToAudioJsonRequestCn" + } + } + } }, "responses": { "200": { "description": "成功生成语音文件。", - "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, - "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } + "content": { + "audio/wav": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "audio/mp3": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "Content-Type": { + "schema": { + "type": "string", + "example": "audio/wav" + } + } + } } } } @@ -558,295 +774,2542 @@ "/info": { "get": { "summary": "获取应用基本信息", - "operationId": "getAppInfoCn", - "tags": ["应用配置"], - "responses": { "200": { "description": "应用基本信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseCn" } } } } } + "operationId": "getAdvancedChatAppInfo", + "tags": [ + "应用配置" + ], + "responses": { + "200": { + "description": "应用基本信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInfoResponseCn" + } + } + } + } + } } }, "/parameters": { "get": { "summary": "获取应用参数", "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", - "operationId": "getAppParametersCn", - "tags": ["应用配置"], - "responses": { "200": { "description": "应用参数信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAppParametersResponseCn" } } } } } + "operationId": "getAdvancedChatAppParameters", + "tags": [ + "应用配置" + ], + "responses": { + "200": { + "description": "应用参数信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ChatAppParametersResponseCn" + } + } + } + } + } } }, "/meta": { "get": { "summary": "获取应用Meta信息", "description": "用于获取工具 icon。", - "operationId": "getAppMetaCn", - "tags": ["应用配置"], - "responses": { "200": { "description": "成功获取应用 Meta 信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMetaResponseCn" } } } } } + "operationId": "getAdvancedChatAppMeta", + "tags": [ + "应用配置" + ], + "responses": { + "200": { + "description": "成功获取应用 Meta 信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppMetaResponseCn" + } + } + } + } + } } }, "/site": { "get": { "summary": "获取应用 WebApp 设置", "description": "用于获取应用的 WebApp 设置。", - "operationId": "getWebAppSettingsCn", - "tags": ["应用配置"], - "responses": { "200": { "description": "WebApp 设置信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseCn" } } } } } + "operationId": "getAdvancedChatWebAppSettings", + "tags": [ + "应用配置" + ], + "responses": { + "200": { + "description": "WebApp 设置信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebAppSettingsResponseCn" + } + } + } + } + } } }, "/apps/annotations": { "get": { "summary": "获取标注列表", - "operationId": "getAnnotationListCn", - "tags": ["标注管理"], - "parameters": [ { "$ref": "#/components/parameters/PageQueryParamCn" }, { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" } ], - "responses": { "200": { "description": "成功获取标注列表。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationListResponseCn" } } } } } + "operationId": "getAdvancedAnnotationList", + "tags": [ + "标注管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/PageQueryParamCn" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" + } + ], + "responses": { + "200": { + "description": "成功获取标注列表。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnnotationListResponseCn" + } + } + } + } + } }, "post": { "summary": "创建标注", - "operationId": "createAnnotationCn", - "tags": ["标注管理"], - "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationRequestCn" } } } }, - "responses": { - "200": { "description": "标注创建成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItemCn" } } } }, - "201": { "description": "标注创建成功 (备选)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItemCn" } } } } - } - } - }, - "/apps/annotations/{annotation_id}": { + "operationId": "createAdvancedAnnotation", + "tags": [ + "标注管理" + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAnnotationRequestCn" + } + } + } + }, + "responses": { + "200": { + "description": "标注创建成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnnotationItemCn" + } + } + } + }, + "201": { + "description": "标注创建成功 (备选)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnnotationItemCn" + } + } + } + } + } + } + }, + "/apps/annotations/{annotation_id}": { "put": { "summary": "更新标注", - "operationId": "updateAnnotationCn", - "tags": ["标注管理"], - "parameters": [ { "$ref": "#/components/parameters/AnnotationIdPathParamCn" } ], - "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnnotationRequestCn" } } } }, - "responses": { "200": { "description": "标注更新成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItemCn" } } } } } + "operationId": "updateAdvancedAnnotation", + "tags": [ + "标注管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/AnnotationIdPathParamCn" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAnnotationRequestCn" + } + } + } + }, + "responses": { + "200": { + "description": "标注更新成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnnotationItemCn" + } + } + } + } + } }, "delete": { "summary": "删除标注", - "operationId": "deleteAnnotationCn", - "tags": ["标注管理"], - "parameters": [ { "$ref": "#/components/parameters/AnnotationIdPathParamCn" } ], - "responses": { "204": { "description": "标注删除成功。" } } + "operationId": "deleteAdvancedAnnotation", + "tags": [ + "标注管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/AnnotationIdPathParamCn" + } + ], + "responses": { + "204": { + "description": "标注删除成功。" + } + } } }, "/apps/annotation-reply/{action}": { "post": { "summary": "标注回复初始设置", "description": "启用或禁用标注回复功能，并配置相关的嵌入模型和阈值。此接口异步执行。", - "operationId": "initialAnnotationReplySettingsCn", - "tags": ["标注管理"], - "parameters": [ { "$ref": "#/components/parameters/AnnotationActionPathParamCn" } ], - "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsRequestCn" } } } }, + "operationId": "initialAdvancedAnnotationReplySettings", + "tags": [ + "标注管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/AnnotationActionPathParamCn" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InitialAnnotationReplySettingsRequestCn" + } + } + } + }, "responses": { - "200": { "description": "任务已启动。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsResponseCn" } } } }, - "202": { "description": "任务已接受处理。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsResponseCn" } } } } + "200": { + "description": "任务已启动。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InitialAnnotationReplySettingsResponseCn" + } + } + } + }, + "202": { + "description": "任务已接受处理。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InitialAnnotationReplySettingsResponseCn" + } + } + } + } } } }, "/apps/annotation-reply/{action}/status/{job_id}": { "get": { "summary": "查询标注回复初始设置任务状态", - "operationId": "getInitialAnnotationReplySettingsStatusCn", - "tags": ["标注管理"], - "parameters": [ { "$ref": "#/components/parameters/AnnotationActionPathParamCn" }, { "$ref": "#/components/parameters/JobIdPathParamCn" } ], - "responses": { "200": { "description": "任务状态。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsStatusResponseCn" } } } } } + "operationId": "getAdvancedInitialAnnotationReplySettingsStatus", + "tags": [ + "标注管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/AnnotationActionPathParamCn" + }, + { + "$ref": "#/components/parameters/JobIdPathParamCn" + } + ], + "responses": { + "200": { + "description": "任务状态。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InitialAnnotationReplySettingsStatusResponseCn" + } + } + } + } + } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" } + "ApiKeyAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "API_KEY", + "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" + } }, "parameters": { - "PageQueryParamCn": { "name": "page", "in": "query", "description": "页码，（选填）默认值：1。", "schema": { "type": "integer", "default": 1 } }, - "LimitQueryParamCn": { "name": "limit", "in": "query", "description": "每页数量，（选填）默认值：20。", "schema": { "type": "integer", "default": 20 } }, - "LimitQueryParamDefault20Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录，默认 20 条。", "schema": { "type": "integer", "default": 20 } }, - "LimitQueryParamDefault20Max100Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, - "UserQueryParamCn": { "name": "user", "in": "query", "required": true, "description": "用户标识，由开发者定义规则，需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", "schema": { "type": "string" } }, - "ConversationIdQueryParamCn": { "name": "conversation_id", "in": "query", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } }, - "LastIdQueryParamCn": { "name": "last_id", "in": "query", "description": "（选填）当前页最后面一条记录的 ID，默认 null。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, - "SortByQueryParamCn": { "name": "sort_by", "in": "query", "description": "（选填）排序字段，默认 -updated_at (按更新时间倒序排列)。可选值：created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } }, - "ConversationIdPathParamCn": { "name": "conversation_id", "in": "path", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } }, - "AnnotationIdPathParamCn": { "name": "annotation_id", "in": "path", "required": true, "description": "标注 ID。", "schema": { "type": "string", "format": "uuid" } }, - "AnnotationActionPathParamCn": { "name": "action", "in": "path", "required": true, "description": "动作，只能是 'enable' 或 'disable'。", "schema": { "type": "string", "enum": ["enable", "disable"] } }, - "JobIdPathParamCn": { "name": "job_id", "in": "path", "required": true, "description": "任务 ID，从标注回复初始设置接口返回的 job_id。", "schema": { "type": "string", "format": "uuid" } } + "PageQueryParamCn": { + "name": "page", + "in": "query", + "description": "页码，（选填）默认值：1。", + "schema": { + "type": "integer", + "default": 1 + } + }, + "LimitQueryParamCn": { + "name": "limit", + "in": "query", + "description": "每页数量，（选填）默认值：20。", + "schema": { + "type": "integer", + "default": 20 + } + }, + "LimitQueryParamDefault20Cn": { + "name": "limit", + "in": "query", + "description": "一次请求返回多少条记录，默认 20 条。", + "schema": { + "type": "integer", + "default": 20 + } + }, + "LimitQueryParamDefault20Max100Cn": { + "name": "limit", + "in": "query", + "description": "一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。", + "schema": { + "type": "integer", + "default": 20, + "minimum": 1, + "maximum": 100 + } + }, + "UserQueryParamCn": { + "name": "user", + "in": "query", + "required": true, + "description": "用户标识，由开发者定义规则，需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", + "schema": { + "type": "string" + } + }, + "ConversationIdQueryParamCn": { + "name": "conversation_id", + "in": "query", + "required": true, + "description": "会话 ID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + "LastIdQueryParamCn": { + "name": "last_id", + "in": "query", + "description": "（选填）当前页最后面一条记录的 ID，默认 null。", + "schema": { + "type": "string", + "format": "uuid", + "nullable": true + } + }, + "SortByQueryParamCn": { + "name": "sort_by", + "in": "query", + "description": "（选填）排序字段，默认 -updated_at (按更新时间倒序排列)。可选值：created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", + "schema": { + "type": "string", + "enum": [ + "created_at", + "-created_at", + "updated_at", + "-updated_at" + ], + "default": "-updated_at" + } + }, + "ConversationIdPathParamCn": { + "name": "conversation_id", + "in": "path", + "required": true, + "description": "会话 ID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + "AnnotationIdPathParamCn": { + "name": "annotation_id", + "in": "path", + "required": true, + "description": "标注 ID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + "AnnotationActionPathParamCn": { + "name": "action", + "in": "path", + "required": true, + "description": "动作，只能是 'enable' 或 'disable'。", + "schema": { + "type": "string", + "enum": [ + "enable", + "disable" + ] + } + }, + "JobIdPathParamCn": { + "name": "job_id", + "in": "path", + "required": true, + "description": "任务 ID，从标注回复初始设置接口返回的 job_id。", + "schema": { + "type": "string", + "format": "uuid" + } + } }, "responses": { - "BadRequestGenericCn": { "description": "请求参数错误。可能原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "BadRequestFileCn": { "description": "文件操作请求错误。可能原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "FileTooLargeCn": { "description": "文件太大 (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "UnsupportedFileTypeFileCn": { "description": "不支持的文件类型 (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "S3ErrorFileCn": { "description": "S3 存储服务错误。可能原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "InternalServerErrorCn": { "description": "服务内部异常。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "SuccessResultCn": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, - "ConversationNotFoundCn": { "description": "对话不存在。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "EndUserNotFoundCn": { "description": "终端用户不存在。错误码：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } } + "BadRequestGenericCn": { + "description": "请求参数错误。可能原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "BadRequestFileCn": { + "description": "文件操作请求错误。可能原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "FileTooLargeCn": { + "description": "文件太大 (file_too_large)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "UnsupportedFileTypeFileCn": { + "description": "不支持的文件类型 (unsupported_file_type)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "S3ErrorFileCn": { + "description": "S3 存储服务错误。可能原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "InternalServerErrorCn": { + "description": "服务内部异常。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "SuccessResultCn": { + "description": "操作成功。", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + } + } + } + } + } + }, + "ConversationNotFoundCn": { + "description": "对话不存在。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "EndUserNotFoundCn": { + "description": "终端用户不存在。错误码：`end_user_not_found`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + } }, "schemas": { "ChatRequestCn": { "type": "object", - "required": ["query", "user"], + "required": [ + "query", + "user" + ], "properties": { - "query": { "type": "string", "description": "用户输入/提问内容。" }, + "query": { + "type": "string", + "description": "用户输入/提问内容。" + }, "inputs": { "type": "object", "description": "允许传入 App 定义的各变量值。如果变量是文件类型，请指定一个 InputFileObjectCn 对象。", "additionalProperties": { - "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/components/schemas/InputFileObjectCn" } ] + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "$ref": "#/components/schemas/InputFileObjectCn" + } + ] }, "default": {} }, - "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。" }, - "user": { "type": "string", "description": "用户标识，应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "（选填）会话 ID，用于继续之前的对话。" }, - "files": { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectCn" }, "description": "（选填）文件列表，仅当模型支持 Vision 能力时可用。" }, - "auto_generate_name": { "type": "boolean", "default": true, "description": "（选填）自动生成会话标题，默认 true。" } + "response_mode": { + "type": "string", + "enum": [ + "streaming", + "blocking" + ], + "default": "streaming", + "description": "响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。" + }, + "user": { + "type": "string", + "description": "用户标识，应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "（选填）会话 ID，用于继续之前的对话。" + }, + "files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InputFileObjectCn" + }, + "description": "（选填）文件列表，仅当模型支持 Vision 能力时可用。" + }, + "auto_generate_name": { + "type": "boolean", + "default": true, + "description": "（选填）自动生成会话标题，默认 true。" + } } }, "InputFileObjectCn": { "type": "object", - "required": ["type", "transfer_method"], + "required": [ + "type", + "transfer_method" + ], "properties": { - "type": { "type": "string", "enum": ["document", "image", "audio", "video", "custom"], "description": "文件类型。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: 其他。" }, - "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" }, - "url": { "type": "string", "format": "url", "description": "图片地址（当传递方式为 remote_url 时）" }, - "upload_file_id": { "type": "string", "format":"uuid", "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" } + "type": { + "type": "string", + "enum": [ + "document", + "image", + "audio", + "video", + "custom" + ], + "description": "文件类型。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: 其他。" + }, + "transfer_method": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ], + "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" + }, + "url": { + "type": "string", + "format": "url", + "description": "图片地址（当传递方式为 remote_url 时）" + }, + "upload_file_id": { + "type": "string", + "format": "uuid", + "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" + } }, "anyOf": [ { - "properties": { - "transfer_method": { "enum": ["remote_url"] }, - "url": { "type": "string", "format": "url" } + "properties": { + "transfer_method": { + "enum": [ + "remote_url" + ] + }, + "url": { + "type": "string", + "format": "url" + } }, - "required": ["url"], - "not": { "required": ["upload_file_id"] } + "required": [ + "url" + ], + "not": { + "required": [ + "upload_file_id" + ] + } }, { - "properties": { - "transfer_method": { "enum": ["local_file"] }, - "upload_file_id": { "type": "string", "format":"uuid" } + "properties": { + "transfer_method": { + "enum": [ + "local_file" + ] + }, + "upload_file_id": { + "type": "string", + "format": "uuid" + } }, - "required": ["upload_file_id"], - "not": { "required": ["url"] } + "required": [ + "upload_file_id" + ], + "not": { + "required": [ + "url" + ] + } } ] }, "ChatCompletionResponseCn": { - "type": "object", "description": "阻塞模式下的完整 App 结果。", + "type": "object", + "description": "阻塞模式下的完整 App 结果。", "properties": { - "event": { "type": "string", "example": "message", "description": "事件类型，固定为 `message`。" }, - "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, - "id": { "type": "string", "format": "uuid", "description": "唯一ID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, - "mode": { "type": "string", "example": "chat", "description": "App 模式，固定为 `chat`。" }, - "answer": { "type": "string", "description": "完整回复内容。" }, - "metadata": { "$ref": "#/components/schemas/ResponseMetadataCn" }, - "created_at": { "type": "integer", "format": "int64", "description": "消息创建时间戳。" } + "event": { + "type": "string", + "example": "message", + "description": "事件类型，固定为 `message`。" + }, + "task_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID。" + }, + "id": { + "type": "string", + "format": "uuid", + "description": "唯一ID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息唯一 ID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会话 ID。" + }, + "mode": { + "type": "string", + "example": "chat", + "description": "App 模式，固定为 `chat`。" + }, + "answer": { + "type": "string", + "description": "完整回复内容。" + }, + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataCn" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "消息创建时间戳。" + } } }, "ResponseMetadataCn": { - "type": "object", "description": "元数据。", - "properties": { "usage": { "$ref": "#/components/schemas/UsageCn" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceCn" }, "description": "引用和归属分段列表。" } } + "type": "object", + "description": "元数据。", + "properties": { + "usage": { + "$ref": "#/components/schemas/UsageCn" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResourceCn" + }, + "description": "引用和归属分段列表。" + } + } }, "ChunkChatEventCn": { - "type": "object", "required": ["event"], - "properties": { "event": { "type": "string", "enum": ["message", "message_file", "message_end", "tts_message", "tts_message_end", "message_replace", "workflow_started", "node_started", "node_finished", "workflow_finished", "error", "ping"], "description": "事件类型。" } }, - "discriminator": { "propertyName": "event", "mapping": { - "message": "#/components/schemas/StreamEventChatMessageCn", "message_file": "#/components/schemas/StreamEventMessageFileCn", - "message_end": "#/components/schemas/StreamEventMessageEndCn", "tts_message": "#/components/schemas/StreamEventTtsMessageCn", - "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndCn", "message_replace": "#/components/schemas/StreamEventMessageReplaceCn", - "workflow_started": "#/components/schemas/StreamEventWorkflowStartedCn", "node_started": "#/components/schemas/StreamEventNodeStartedCn", - "node_finished": "#/components/schemas/StreamEventNodeFinishedCn", "workflow_finished": "#/components/schemas/StreamEventWorkflowFinishedCn", - "error": "#/components/schemas/StreamEventErrorCn", "ping": "#/components/schemas/StreamEventPingCn" - }} + "type": "object", + "required": [ + "event" + ], + "properties": { + "event": { + "type": "string", + "enum": [ + "message", + "message_file", + "message_end", + "tts_message", + "tts_message_end", + "message_replace", + "workflow_started", + "node_started", + "node_finished", + "workflow_finished", + "error", + "ping" + ], + "description": "事件类型。" + } + }, + "discriminator": { + "propertyName": "event", + "mapping": { + "message": "#/components/schemas/StreamEventChatMessageCn", + "message_file": "#/components/schemas/StreamEventMessageFileCn", + "message_end": "#/components/schemas/StreamEventMessageEndCn", + "tts_message": "#/components/schemas/StreamEventTtsMessageCn", + "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndCn", + "message_replace": "#/components/schemas/StreamEventMessageReplaceCn", + "workflow_started": "#/components/schemas/StreamEventWorkflowStartedCn", + "node_started": "#/components/schemas/StreamEventNodeStartedCn", + "node_finished": "#/components/schemas/StreamEventNodeFinishedCn", + "workflow_finished": "#/components/schemas/StreamEventWorkflowFinishedCn", + "error": "#/components/schemas/StreamEventErrorCn", + "ping": "#/components/schemas/StreamEventPingCn" + } + } }, "StreamEventBaseChatCn": { - "type": "object", "properties": { - "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, - "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, - "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, - "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } - } - }, - "StreamEventChatMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLM 返回文本块内容。" } } } ] }, - "StreamEventMessageFileCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["id", "type", "belongs_to", "url", "conversation_id"], "properties": { "id": { "type": "string", "format": "uuid", "description": "文件唯一ID。" }, "type": { "type": "string", "enum": ["image"], "description": "文件类型，目前仅为 image。" }, "belongs_to": { "type": "string", "enum": ["assistant"], "description": "文件归属，仅为 assistant。" }, "url": { "type": "string", "format": "url", "description": "文件访问地址。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会话ID。" } } } ] }, - "StreamEventMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataCn" } } } ] }, - "StreamEventTtsMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64 编码的音频块。" } } } ] }, - "StreamEventTtsMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空字符串。" } } } ] }, - "StreamEventMessageReplaceCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "替换内容（直接替换 LLM 所有回复文本）。" } } } ] }, - "StreamEventWorkflowStartedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/WorkflowStartedDataCn" } } } ] }, - "WorkflowStartedDataCn": { "type": "object", "required": ["id", "workflow_id", "sequence_number", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "关联 Workflow ID。" }, "sequence_number": { "type": "integer", "description": "自增序号，App 内自增，从 1 开始。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, - "StreamEventNodeStartedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/NodeStartedDataCn" } } } ] }, - "NodeStartedDataCn": { "type": "object", "required": ["id", "node_id", "node_type", "title", "index", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID (应为 node 执行 ID，根据上下文修正)。" }, "node_id": { "type": "string", "format": "uuid", "description": "节点 ID。" }, "node_type": { "type": "string", "description": "节点类型。" }, "title": { "type": "string", "description": "节点名称。" }, "index": { "type": "integer", "description": "执行序号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "前置节点 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "节点使用的前置变量内容。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, - "StreamEventNodeFinishedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/NodeFinishedDataCn" } } } ] }, - "NodeFinishedDataCn": { "type": "object", "required": ["id", "node_id", "index", "status", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "node 执行 ID。" }, "node_id": { "type": "string", "format": "uuid", "description": "节点 ID。" }, "index": { "type": "integer", "description": "执行序号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（可选）前置节点 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "节点使用的前置变量内容。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）节点过程数据 (JSON)。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）输出内容 (JSON)。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, "error": { "type": "string", "nullable": true, "description": "（可选）错误原因。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（可选）耗时(秒)。" }, "execution_metadata": { "$ref": "#/components/schemas/NodeExecutionMetadataCn" , "nullable": true, "description":"元数据"}, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, - "NodeExecutionMetadataCn": { "type": "object", "description": "节点执行元数据。", "properties": { "total_tokens": { "type": "integer", "nullable": true, "description": "（可选）总使用 tokens。" }, "total_price": { "type": "number", "format": "float", "nullable": true, "description": "（可选）总费用 (使用 float 兼容 decimal)。" }, "currency": { "type": "string", "nullable": true, "example": "USD", "description": "（可选）货币。" } } }, - "StreamEventWorkflowFinishedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/WorkflowFinishedDataCn" } } } ] }, - "WorkflowFinishedDataCn": { "type": "object", "required": ["id", "workflow_id", "status", "created_at", "finished_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "关联 Workflow ID。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）输出内容 (JSON)。" }, "error": { "type": "string", "nullable": true, "description": "（可选）错误原因。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（可选）耗时(秒)。" }, "total_tokens": { "type": "integer", "nullable": true, "description": "（可选）总使用 tokens。" }, "total_steps": { "type": "integer", "default": 0, "description": "总步数，默认 0。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" }, "finished_at": { "type": "integer", "format": "int64", "description": "结束时间。" } } }, - "StreamEventErrorCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "status", "code", "message"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid", "nullable": true, "description": "消息唯一 ID（错误事件中可能不存在）。" }, "status": { "type": "integer", "description": "HTTP 状态码。" }, "code": { "type": "string", "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } ] }, - "StreamEventPingCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "description": "每 10s 一次的 ping 事件，保持连接存活。" } ] }, - "UsageCn": { "type": "object", "description": "模型用量信息。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, - "RetrieverResourceCn": { "type": "object", "description": "引用和归属分段信息。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } }, - "FileUploadResponseCn": { "type": "object", "description": "文件上传成功后的响应。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "文件名。" }, "size": { "type": "integer", "description": "文件大小 (byte)。" }, "extension": { "type": "string", "description": "文件后缀。" }, "mime_type": { "type": "string", "description": "文件 mime-type。" }, "created_by": { "type": "string", "format": "uuid", "description": "上传人 ID (应为 uuid，示例中为 int，已修正)。" }, "created_at": { "type": "integer", "format": "int64", "description": "上传时间。" } } }, - "EndUserDetailCn": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, - "tenant_id": { "type": "string", "format": "uuid" }, - "app_id": { "type": "string", "format": "uuid", "nullable": true }, - "type": { "type": "string", "example": "service_api" }, - "external_user_id": { "type": "string", "nullable": true }, - "name": { "type": "string", "nullable": true }, - "is_anonymous": { "type": "boolean" }, - "session_id": { "type": "string" }, - "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { "type": "string", "format": "date-time" } - } - }, - "MessageFeedbackRequestCn": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "点赞 'like', 点踩 'dislike', 撤销点赞 null。" }, "user": { "type": "string", "description": "用户标识。" }, "content": { "type": "string", "nullable": true, "description": "消息反馈的具体信息。" } } }, - "AppFeedbacksResponseCn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemCn" }, "description": "返回该APP的点赞、反馈列表。" } } }, - "FeedbackItemCn": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, - "SuggestedQuestionsResponseCn": { "type": "object", "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "string" }, "description": "建议问题列表。" } } }, - "ConversationHistoryResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返回条数。" }, "has_more": { "type": "boolean", "description": "是否存在下一页。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMessageItemCn" }, "description": "消息列表。" } } }, - "ConversationMessageItemCn": { "type": "object", "description": "会话中的单条消息。", "properties": { "id": { "type": "string", "format": "uuid", "description": "消息 ID。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "用户输入参数。" }, "query": { "type": "string", "description": "用户输入/提问内容。" }, "answer": { "type": "string", "description": "回答消息内容。" }, "message_files": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFileItemCn" }, "description": "消息文件列表。" }, "feedback": { "type": "object", "nullable": true, "properties": { "rating": { "type": "string", "enum": ["like", "dislike"], "description": "点赞 'like' / 点踩 'dislike'。" } }, "description": "反馈信息。" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceCn" }, "description": "引用和归属分段列表。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" } } }, - "MessageFileItemCn": { "type": "object", "description": "消息中的文件项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "文件类型，例如 'image'。" }, "url": { "type": "string", "format": "url", "description": "预览图片地址。" }, "belongs_to": { "type": "string", "enum": ["user", "assistant"], "description": "文件归属方。" } } }, - "ConversationsListResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返回条数。" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationListItemCn" }, "description": "会话列表。" } } }, - "ConversationListItemCn": { "type": "object", "description": "会话列表中的单项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, "name": { "type": "string", "description": "会话名称。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "用户输入参数。" }, "status": { "type": "string", "description": "会话状态。" }, "introduction": { "type": "string", "nullable": true, "description": "开场白。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" }, "updated_at": { "type": "integer", "format": "int64", "description": "更新时间。" } } }, - "ConversationRenameRequestCn": { "type": "object", "required": ["user"], "properties": { "name": { "type": "string", "nullable": true, "description": "（选填）名称，若 auto_generate 为 true 时可不传。" }, "auto_generate": { "type": "boolean", "default": false, "description": "（选填）自动生成标题，默认 false。" }, "user": { "type": "string", "description": "用户标识。" } } }, - "ConversationRenameResponseCn": { "$ref": "#/components/schemas/ConversationListItemCn" }, - "ConversationVariablesResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "每页项目数。" }, "has_more": { "type": "boolean", "description": "是否有更多项目。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationVariableItemCn" }, "description": "变量列表。" } } }, - "ConversationVariableItemCn": { "type": "object", "description": "对话中的变量项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "变量ID。" }, "name": { "type": "string", "description": "变量名称。" }, "value_type": { "type": "string", "description": "变量类型 (string, number, boolean 等)。" }, "value": { "type": "string", "description": "变量值。" }, "description": { "type": "string", "nullable": true, "description": "变量描述。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" }, "updated_at": { "type": "integer", "format": "int64", "description": "最后更新时间戳。" } } }, - "AudioToTextRequestCn": { "type": "object", "required": ["file", "user"], "properties": { "file": { "type": "string", "format": "binary", "description": "语音文件。支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']。大小限制：15MB。" }, "user": { "type": "string", "description": "用户标识。" } } }, - "AudioToTextResponseCn": { "type": "object", "properties": { "text": { "type": "string", "description": "输出文字。" } } }, - "TextToAudioJsonRequestCn": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "消息ID (优先)。" }, "text": { "type": "string", "description": "语音生成内容。" }, "user": { "type": "string", "description": "用户标识。" } }, "description": "需要 `user`。提供 `message_id` 或 `text`。" }, - "AppInfoResponseCn": { "type": "object", "description": "应用基本信息。", "properties": { "name": { "type": "string", "description": "应用名称。" }, "description": { "type": "string", "description": "应用描述。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "应用标签。" } } }, - "ChatAppParametersResponseCn": { "type": "object", "description": "应用参数信息。", "properties": { "opening_statement": { "type": "string", "description": "开场白。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "开场推荐问题列表。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "启用回答后给出推荐问题。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "语音转文本。" }, "text_to_speech": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" }, "voice": { "type": "string", "description": "语音类型。" }, "language": { "type": "string", "description": "语言。" }, "autoPlay": { "type": "string", "enum": ["enabled", "disabled"], "description": "自动播放：enabled 开启, disabled 关闭。" } }, "description": "文本转语音。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "引用和归属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "标记回复。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemCn" }, "description": "用户输入表单配置。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "图片设置。支持 png, jpg, jpeg, webp, gif。" } }, "description": "文件上传配置。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "文档上传大小限制 (MB)。" }, "image_file_size_limit": { "type": "integer", "description": "图片文件上传大小限制 (MB)。" }, "audio_file_size_limit": { "type": "integer", "description": "音频文件上传大小限制 (MB)。" }, "video_file_size_limit": { "type": "integer", "description": "视频文件上传大小限制 (MB)。" } }, "description": "系统参数。" } } }, - "UserInputFormItemCn": { "type": "object", "description": "用户输入表单中的控件项。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperCn" }, { "$ref": "#/components/schemas/ParagraphControlWrapperCn" }, { "$ref": "#/components/schemas/SelectControlWrapperCn" } ] }, - "TextInputControlWrapperCn": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlCn" } }, "required":["text-input"] }, - "ParagraphControlWrapperCn": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlCn" } }, "required":["paragraph"] }, - "SelectControlWrapperCn": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlCn" } }, "required":["select"] }, - "TextInputControlCn": { "type": "object", "description": "文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, - "ParagraphControlCn": { "type": "object", "description": "段落文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, - "SelectControlCn": { "type": "object", "description": "下拉控件。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "选项值。" } } }, - "AppMetaResponseCn": { "type": "object", "description": "应用 Meta 信息。", "properties": { "tool_icons": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "format": "url", "description": "图标 URL。" }, { "$ref": "#/components/schemas/ToolIconDetailCn" } ] }, "description": "工具图标，键为工具名称。" } } }, - "ToolIconDetailCn": { "type": "object", "description": "工具图标详情。", "properties": { "background": { "type": "string", "description": "hex 格式的背景色。" }, "content": { "type": "string", "description": "emoji。" } } }, - "WebAppSettingsResponseCn": { "type": "object", "description": "应用 WebApp 设置。", "properties": { "title": { "type": "string", "description": "WebApp 名称。" }, "chat_color_theme": { "type": "string", "description": "聊天颜色主题, hex 格式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "图标类型。" }, "icon": { "type": "string", "description": "图标内容 (emoji 或图片 URL)。" }, "icon_background": { "type": "string", "description": "hex 格式的背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "图标 URL。" }, "description": { "type": "string", "description": "描述。" }, "copyright": { "type": "string", "description": "版权信息。" }, "privacy_policy": { "type": "string", "description": "隐私政策链接。" }, "custom_disclaimer": { "type": "string", "description": "自定义免责声明。" }, "default_language": { "type": "string", "description": "默认语言。" }, "show_workflow_steps": { "type": "boolean", "description": "是否显示工作流详情。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "是否使用 WebApp 图标替换聊天中的机器人图标。" } } }, - "AnnotationListResponseCn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationItemCn" } }, "has_more": { "type": "boolean" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "page": { "type": "integer" } } }, - "AnnotationItemCn": { "type": "object", "description": "标注项。", "properties": { "id": { "type": "string", "format": "uuid" }, "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" }, "hit_count": { "type": "integer", "description": "命中次数。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" } } }, - "CreateAnnotationRequestCn": { "type": "object", "required": ["question", "answer"], "properties": { "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" } } }, - "UpdateAnnotationRequestCn": { "type": "object", "required": ["question", "answer"], "properties": { "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" } } }, - "InitialAnnotationReplySettingsRequestCn": { "type": "object", "required": ["score_threshold"], "properties": { "embedding_provider_name": { "type": "string", "nullable": true, "description": "指定的嵌入模型提供商名称。" }, "embedding_model_name": { "type": "string", "nullable": true, "description": "指定的嵌入模型名称。" }, "score_threshold": { "type": "number", "format": "float", "description": "相似度阈值。" } } }, - "InitialAnnotationReplySettingsResponseCn": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, "job_status": { "type": "string", "description": "任务状态。" } } }, - "InitialAnnotationReplySettingsStatusResponseCn": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, "job_status": { "type": "string", "description": "任务状态。" }, "error_msg": { "type": "string", "nullable": true, "description": "错误信息。" } } }, - "ErrorResponseCn": { "type": "object", "description": "错误响应。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTP 状态码。" }, "code": { "type": "string", "nullable": true, "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } - } - }, - "tags": [ - { "name": "对话消息", "description": "与对话消息和交互相关的操作。" }, - { "name": "文件操作", "description": "文件上传和预览相关的操作。" }, - { "name": "终端用户", "description": "终端用户信息相关的操作。" }, - { "name": "消息反馈", "description": "用户对消息的反馈操作。" }, - { "name": "会话管理", "description": "管理对话会话相关的操作。" }, - { "name": "语音与文字转换", "description": "文本转语音和语音转文本操作。" }, - { "name": "应用配置", "description": "获取应用设置和信息相关的操作。" }, - { "name": "标注管理", "description": "管理用于直接回复的标注数据。" } + "task_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息唯一 ID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会话 ID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间戳。" + } + } + }, + "StreamEventChatMessageCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "LLM 返回文本块内容。" + } + } + } + ] + }, + "StreamEventMessageFileCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "type": "object", + "required": [ + "id", + "type", + "belongs_to", + "url", + "conversation_id" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "文件唯一ID。" + }, + "type": { + "type": "string", + "enum": [ + "image" + ], + "description": "文件类型，目前仅为 image。" + }, + "belongs_to": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "文件归属，仅为 assistant。" + }, + "url": { + "type": "string", + "format": "url", + "description": "文件访问地址。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会话ID。" + } + } + } + ] + }, + "StreamEventMessageEndCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "metadata" + ], + "properties": { + "metadata": { + "$ref": "#/components/schemas/ResponseMetadataCn" + } + } + } + ] + }, + "StreamEventTtsMessageCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "format": "byte", + "description": "Base64 编码的音频块。" + } + } + } + ] + }, + "StreamEventTtsMessageEndCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "description": "空字符串。" + } + } + } + ] + }, + "StreamEventMessageReplaceCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseChatCn" + }, + { + "type": "object", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "替换内容（直接替换 LLM 所有回复文本）。" + } + } + } + ] + }, + "StreamEventWorkflowStartedCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "type": "object", + "required": [ + "task_id", + "workflow_run_id", + "data" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid" + }, + "data": { + "$ref": "#/components/schemas/WorkflowStartedDataCn" + } + } + } + ] + }, + "WorkflowStartedDataCn": { + "type": "object", + "required": [ + "id", + "workflow_id", + "sequence_number", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "workflow 执行 ID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "关联 Workflow ID。" + }, + "sequence_number": { + "type": "integer", + "description": "自增序号，App 内自增，从 1 开始。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "开始时间。" + } + } + }, + "StreamEventNodeStartedCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "type": "object", + "required": [ + "task_id", + "workflow_run_id", + "data" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid" + }, + "data": { + "$ref": "#/components/schemas/NodeStartedDataCn" + } + } + } + ] + }, + "NodeStartedDataCn": { + "type": "object", + "required": [ + "id", + "node_id", + "node_type", + "title", + "index", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "workflow 执行 ID (应为 node 执行 ID，根据上下文修正)。" + }, + "node_id": { + "type": "string", + "format": "uuid", + "description": "节点 ID。" + }, + "node_type": { + "type": "string", + "description": "节点类型。" + }, + "title": { + "type": "string", + "description": "节点名称。" + }, + "index": { + "type": "integer", + "description": "执行序号。" + }, + "predecessor_node_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "前置节点 ID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "节点使用的前置变量内容。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "开始时间。" + } + } + }, + "StreamEventNodeFinishedCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "type": "object", + "required": [ + "task_id", + "workflow_run_id", + "data" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid" + }, + "data": { + "$ref": "#/components/schemas/NodeFinishedDataCn" + } + } + } + ] + }, + "NodeFinishedDataCn": { + "type": "object", + "required": [ + "id", + "node_id", + "index", + "status", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "node 执行 ID。" + }, + "node_id": { + "type": "string", + "format": "uuid", + "description": "节点 ID。" + }, + "index": { + "type": "integer", + "description": "执行序号。" + }, + "predecessor_node_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "（可选）前置节点 ID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "节点使用的前置变量内容。" + }, + "process_data": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "（可选）节点过程数据 (JSON)。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "（可选）输出内容 (JSON)。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "执行状态。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "（可选）错误原因。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "（可选）耗时(秒)。" + }, + "execution_metadata": { + "$ref": "#/components/schemas/NodeExecutionMetadataCn", + "nullable": true, + "description": "元数据" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "开始时间。" + } + } + }, + "NodeExecutionMetadataCn": { + "type": "object", + "description": "节点执行元数据。", + "properties": { + "total_tokens": { + "type": "integer", + "nullable": true, + "description": "（可选）总使用 tokens。" + }, + "total_price": { + "type": "number", + "format": "float", + "nullable": true, + "description": "（可选）总费用 (使用 float 兼容 decimal)。" + }, + "currency": { + "type": "string", + "nullable": true, + "example": "USD", + "description": "（可选）货币。" + } + } + }, + "StreamEventWorkflowFinishedCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "type": "object", + "required": [ + "task_id", + "workflow_run_id", + "data" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid" + }, + "data": { + "$ref": "#/components/schemas/WorkflowFinishedDataCn" + } + } + } + ] + }, + "WorkflowFinishedDataCn": { + "type": "object", + "required": [ + "id", + "workflow_id", + "status", + "created_at", + "finished_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "workflow 执行 ID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "关联 Workflow ID。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "执行状态。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "（可选）输出内容 (JSON)。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "（可选）错误原因。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "（可选）耗时(秒)。" + }, + "total_tokens": { + "type": "integer", + "nullable": true, + "description": "（可选）总使用 tokens。" + }, + "total_steps": { + "type": "integer", + "default": 0, + "description": "总步数，默认 0。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "开始时间。" + }, + "finished_at": { + "type": "integer", + "format": "int64", + "description": "结束时间。" + } + } + }, + "StreamEventErrorCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "type": "object", + "required": [ + "task_id", + "status", + "code", + "message" + ], + "properties": { + "task_id": { + "type": "string", + "format": "uuid" + }, + "message_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "消息唯一 ID（错误事件中可能不存在）。" + }, + "status": { + "type": "integer", + "description": "HTTP 状态码。" + }, + "code": { + "type": "string", + "description": "错误码。" + }, + "message": { + "type": "string", + "description": "错误消息。" + } + } + } + ] + }, + "StreamEventPingCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkChatEventCn" + }, + { + "type": "object", + "description": "每 10s 一次的 ping 事件，保持连接存活。" + } + ] + }, + "UsageCn": { + "type": "object", + "description": "模型用量信息。", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "prompt_unit_price": { + "type": "string" + }, + "prompt_price_unit": { + "type": "string" + }, + "prompt_price": { + "type": "string" + }, + "completion_tokens": { + "type": "integer" + }, + "completion_unit_price": { + "type": "string" + }, + "completion_price_unit": { + "type": "string" + }, + "completion_price": { + "type": "string" + }, + "total_tokens": { + "type": "integer" + }, + "total_price": { + "type": "string" + }, + "currency": { + "type": "string" + }, + "latency": { + "type": "number", + "format": "double" + } + } + }, + "RetrieverResourceCn": { + "type": "object", + "description": "引用和归属分段信息。", + "properties": { + "position": { + "type": "integer" + }, + "dataset_id": { + "type": "string", + "format": "uuid" + }, + "dataset_name": { + "type": "string" + }, + "document_id": { + "type": "string", + "format": "uuid" + }, + "document_name": { + "type": "string" + }, + "segment_id": { + "type": "string", + "format": "uuid" + }, + "score": { + "type": "number", + "format": "float" + }, + "content": { + "type": "string" + } + } + }, + "FileUploadResponseCn": { + "type": "object", + "description": "文件上传成功后的响应。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "name": { + "type": "string", + "description": "文件名。" + }, + "size": { + "type": "integer", + "description": "文件大小 (byte)。" + }, + "extension": { + "type": "string", + "description": "文件后缀。" + }, + "mime_type": { + "type": "string", + "description": "文件 mime-type。" + }, + "created_by": { + "type": "string", + "format": "uuid", + "description": "上传人 ID (应为 uuid，示例中为 int，已修正)。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "上传时间。" + } + } + }, + "EndUserDetailCn": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "tenant_id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "type": { + "type": "string", + "example": "service_api" + }, + "external_user_id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "is_anonymous": { + "type": "boolean" + }, + "session_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "MessageFeedbackRequestCn": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true, + "description": "点赞 'like', 点踩 'dislike', 撤销点赞 null。" + }, + "user": { + "type": "string", + "description": "用户标识。" + }, + "content": { + "type": "string", + "nullable": true, + "description": "消息反馈的具体信息。" + } + } + }, + "AppFeedbacksResponseCn": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeedbackItemCn" + }, + "description": "返回该APP的点赞、反馈列表。" + } + } + }, + "FeedbackItemCn": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid" + }, + "conversation_id": { + "type": "string", + "format": "uuid" + }, + "message_id": { + "type": "string", + "format": "uuid" + }, + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true + }, + "content": { + "type": "string" + }, + "from_source": { + "type": "string" + }, + "from_end_user_id": { + "type": "string", + "format": "uuid" + }, + "from_account_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "SuggestedQuestionsResponseCn": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + }, + "data": { + "type": "array", + "items": { + "type": "string" + }, + "description": "建议问题列表。" + } + } + }, + "ConversationHistoryResponseCn": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "返回条数。" + }, + "has_more": { + "type": "boolean", + "description": "是否存在下一页。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationMessageItemCn" + }, + "description": "消息列表。" + } + } + }, + "ConversationMessageItemCn": { + "type": "object", + "description": "会话中的单条消息。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "消息 ID。" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "description": "会话 ID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "用户输入参数。" + }, + "query": { + "type": "string", + "description": "用户输入/提问内容。" + }, + "answer": { + "type": "string", + "description": "回答消息内容。" + }, + "message_files": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageFileItemCn" + }, + "description": "消息文件列表。" + }, + "feedback": { + "type": "object", + "nullable": true, + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike" + ], + "description": "点赞 'like' / 点踩 'dislike'。" + } + }, + "description": "反馈信息。" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResourceCn" + }, + "description": "引用和归属分段列表。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间。" + } + } + }, + "MessageFileItemCn": { + "type": "object", + "description": "消息中的文件项。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "type": { + "type": "string", + "description": "文件类型，例如 'image'。" + }, + "url": { + "type": "string", + "format": "url", + "description": "预览图片地址。" + }, + "belongs_to": { + "type": "string", + "enum": [ + "user", + "assistant" + ], + "description": "文件归属方。" + } + } + }, + "ConversationsListResponseCn": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "返回条数。" + }, + "has_more": { + "type": "boolean" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationListItemCn" + }, + "description": "会话列表。" + } + } + }, + "ConversationListItemCn": { + "type": "object", + "description": "会话列表中的单项。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "会话 ID。" + }, + "name": { + "type": "string", + "description": "会话名称。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "用户输入参数。" + }, + "status": { + "type": "string", + "description": "会话状态。" + }, + "introduction": { + "type": "string", + "nullable": true, + "description": "开场白。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间。" + }, + "updated_at": { + "type": "integer", + "format": "int64", + "description": "更新时间。" + } + } + }, + "ConversationRenameRequestCn": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "name": { + "type": "string", + "nullable": true, + "description": "（选填）名称，若 auto_generate 为 true 时可不传。" + }, + "auto_generate": { + "type": "boolean", + "default": false, + "description": "（选填）自动生成标题，默认 false。" + }, + "user": { + "type": "string", + "description": "用户标识。" + } + } + }, + "ConversationRenameResponseCn": { + "$ref": "#/components/schemas/ConversationListItemCn" + }, + "ConversationVariablesResponseCn": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "每页项目数。" + }, + "has_more": { + "type": "boolean", + "description": "是否有更多项目。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ConversationVariableItemCn" + }, + "description": "变量列表。" + } + } + }, + "ConversationVariableItemCn": { + "type": "object", + "description": "对话中的变量项。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "变量ID。" + }, + "name": { + "type": "string", + "description": "变量名称。" + }, + "value_type": { + "type": "string", + "description": "变量类型 (string, number, boolean 等)。" + }, + "value": { + "type": "string", + "description": "变量值。" + }, + "description": { + "type": "string", + "nullable": true, + "description": "变量描述。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间戳。" + }, + "updated_at": { + "type": "integer", + "format": "int64", + "description": "最后更新时间戳。" + } + } + }, + "AudioToTextRequestCn": { + "type": "object", + "required": [ + "file", + "user" + ], + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "语音文件。支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']。大小限制：15MB。" + }, + "user": { + "type": "string", + "description": "用户标识。" + } + } + }, + "AudioToTextResponseCn": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "输出文字。" + } + } + }, + "TextToAudioJsonRequestCn": { + "type": "object", + "required": [ + "user" + ], + "properties": { + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息ID (优先)。" + }, + "text": { + "type": "string", + "description": "语音生成内容。" + }, + "user": { + "type": "string", + "description": "用户标识。" + } + }, + "description": "需要 `user`。提供 `message_id` 或 `text`。" + }, + "AppInfoResponseCn": { + "type": "object", + "description": "应用基本信息。", + "properties": { + "name": { + "type": "string", + "description": "应用名称。" + }, + "description": { + "type": "string", + "description": "应用描述。" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "应用标签。" + } + } + }, + "ChatAppParametersResponseCn": { + "type": "object", + "description": "应用参数信息。", + "properties": { + "opening_statement": { + "type": "string", + "description": "开场白。" + }, + "suggested_questions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "开场推荐问题列表。" + }, + "suggested_questions_after_answer": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + } + }, + "description": "启用回答后给出推荐问题。" + }, + "speech_to_text": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + } + }, + "description": "语音转文本。" + }, + "text_to_speech": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + }, + "voice": { + "type": "string", + "description": "语音类型。" + }, + "language": { + "type": "string", + "description": "语言。" + }, + "autoPlay": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ], + "description": "自动播放：enabled 开启, disabled 关闭。" + } + }, + "description": "文本转语音。" + }, + "retriever_resource": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + } + }, + "description": "引用和归属。" + }, + "annotation_reply": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + } + }, + "description": "标记回复。" + }, + "user_input_form": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserInputFormItemCn" + }, + "description": "用户输入表单配置。" + }, + "file_upload": { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "number_limits": { + "type": "integer" + }, + "transfer_methods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ] + } + } + }, + "description": "图片设置。支持 png, jpg, jpeg, webp, gif。" + } + }, + "description": "文件上传配置。" + }, + "system_parameters": { + "type": "object", + "properties": { + "file_size_limit": { + "type": "integer", + "description": "文档上传大小限制 (MB)。" + }, + "image_file_size_limit": { + "type": "integer", + "description": "图片文件上传大小限制 (MB)。" + }, + "audio_file_size_limit": { + "type": "integer", + "description": "音频文件上传大小限制 (MB)。" + }, + "video_file_size_limit": { + "type": "integer", + "description": "视频文件上传大小限制 (MB)。" + } + }, + "description": "系统参数。" + } + } + }, + "UserInputFormItemCn": { + "type": "object", + "description": "用户输入表单中的控件项。", + "oneOf": [ + { + "$ref": "#/components/schemas/TextInputControlWrapperCn" + }, + { + "$ref": "#/components/schemas/ParagraphControlWrapperCn" + }, + { + "$ref": "#/components/schemas/SelectControlWrapperCn" + } + ] + }, + "TextInputControlWrapperCn": { + "type": "object", + "properties": { + "text-input": { + "$ref": "#/components/schemas/TextInputControlCn" + } + }, + "required": [ + "text-input" + ] + }, + "ParagraphControlWrapperCn": { + "type": "object", + "properties": { + "paragraph": { + "$ref": "#/components/schemas/ParagraphControlCn" + } + }, + "required": [ + "paragraph" + ] + }, + "SelectControlWrapperCn": { + "type": "object", + "properties": { + "select": { + "$ref": "#/components/schemas/SelectControlCn" + } + }, + "required": [ + "select" + ] + }, + "TextInputControlCn": { + "type": "object", + "description": "文本输入控件。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "默认值。" + } + } + }, + "ParagraphControlCn": { + "type": "object", + "description": "段落文本输入控件。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "默认值。" + } + } + }, + "SelectControlCn": { + "type": "object", + "description": "下拉控件。", + "required": [ + "label", + "variable", + "required", + "options" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "默认值。" + }, + "options": { + "type": "array", + "items": { + "type": "string" + }, + "description": "选项值。" + } + } + }, + "AppMetaResponseCn": { + "type": "object", + "description": "应用 Meta 信息。", + "properties": { + "tool_icons": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "string", + "format": "url", + "description": "图标 URL。" + }, + { + "$ref": "#/components/schemas/ToolIconDetailCn" + } + ] + }, + "description": "工具图标，键为工具名称。" + } + } + }, + "ToolIconDetailCn": { + "type": "object", + "description": "工具图标详情。", + "properties": { + "background": { + "type": "string", + "description": "hex 格式的背景色。" + }, + "content": { + "type": "string", + "description": "emoji。" + } + } + }, + "WebAppSettingsResponseCn": { + "type": "object", + "description": "应用 WebApp 设置。", + "properties": { + "title": { + "type": "string", + "description": "WebApp 名称。" + }, + "chat_color_theme": { + "type": "string", + "description": "聊天颜色主题, hex 格式。" + }, + "chat_color_theme_inverted": { + "type": "boolean", + "description": "聊天颜色主题是否反转。" + }, + "icon_type": { + "type": "string", + "enum": [ + "emoji", + "image" + ], + "description": "图标类型。" + }, + "icon": { + "type": "string", + "description": "图标内容 (emoji 或图片 URL)。" + }, + "icon_background": { + "type": "string", + "description": "hex 格式的背景色。" + }, + "icon_url": { + "type": "string", + "format": "url", + "nullable": true, + "description": "图标 URL。" + }, + "description": { + "type": "string", + "description": "描述。" + }, + "copyright": { + "type": "string", + "description": "版权信息。" + }, + "privacy_policy": { + "type": "string", + "description": "隐私政策链接。" + }, + "custom_disclaimer": { + "type": "string", + "description": "自定义免责声明。" + }, + "default_language": { + "type": "string", + "description": "默认语言。" + }, + "show_workflow_steps": { + "type": "boolean", + "description": "是否显示工作流详情。" + }, + "use_icon_as_answer_icon": { + "type": "boolean", + "description": "是否使用 WebApp 图标替换聊天中的机器人图标。" + } + } + }, + "AnnotationListResponseCn": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AnnotationItemCn" + } + }, + "has_more": { + "type": "boolean" + }, + "limit": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "page": { + "type": "integer" + } + } + }, + "AnnotationItemCn": { + "type": "object", + "description": "标注项。", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "question": { + "type": "string", + "description": "问题。" + }, + "answer": { + "type": "string", + "description": "答案内容。" + }, + "hit_count": { + "type": "integer", + "description": "命中次数。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间。" + } + } + }, + "CreateAnnotationRequestCn": { + "type": "object", + "required": [ + "question", + "answer" + ], + "properties": { + "question": { + "type": "string", + "description": "问题。" + }, + "answer": { + "type": "string", + "description": "答案内容。" + } + } + }, + "UpdateAnnotationRequestCn": { + "type": "object", + "required": [ + "question", + "answer" + ], + "properties": { + "question": { + "type": "string", + "description": "问题。" + }, + "answer": { + "type": "string", + "description": "答案内容。" + } + } + }, + "InitialAnnotationReplySettingsRequestCn": { + "type": "object", + "required": [ + "score_threshold" + ], + "properties": { + "embedding_provider_name": { + "type": "string", + "nullable": true, + "description": "指定的嵌入模型提供商名称。" + }, + "embedding_model_name": { + "type": "string", + "nullable": true, + "description": "指定的嵌入模型名称。" + }, + "score_threshold": { + "type": "number", + "format": "float", + "description": "相似度阈值。" + } + } + }, + "InitialAnnotationReplySettingsResponseCn": { + "type": "object", + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID。" + }, + "job_status": { + "type": "string", + "description": "任务状态。" + } + } + }, + "InitialAnnotationReplySettingsStatusResponseCn": { + "type": "object", + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID。" + }, + "job_status": { + "type": "string", + "description": "任务状态。" + }, + "error_msg": { + "type": "string", + "nullable": true, + "description": "错误信息。" + } + } + }, + "ErrorResponseCn": { + "type": "object", + "description": "错误响应。", + "properties": { + "status": { + "type": "integer", + "nullable": true, + "description": "HTTP 状态码。" + }, + "code": { + "type": "string", + "nullable": true, + "description": "错误码。" + }, + "message": { + "type": "string", + "description": "错误消息。" + } + } + } + } + }, + "tags": [ + { + "name": "对话消息", + "description": "与对话消息和交互相关的操作。" + }, + { + "name": "文件操作", + "description": "文件上传和预览相关的操作。" + }, + { + "name": "终端用户", + "description": "终端用户信息相关的操作。" + }, + { + "name": "消息反馈", + "description": "用户对消息的反馈操作。" + }, + { + "name": "会话管理", + "description": "管理对话会话相关的操作。" + }, + { + "name": "语音与文字转换", + "description": "文本转语音和语音转文本操作。" + }, + { + "name": "应用配置", + "description": "获取应用设置和信息相关的操作。" + }, + { + "name": "标注管理", + "description": "管理用于直接回复的标注数据。" + } ] -} \ No newline at end of file +} diff --git a/zh/api-reference/openapi_completion.json b/zh/api-reference/openapi_completion.json index 27b149097..2a8b4dd41 100644 --- a/zh/api-reference/openapi_completion.json +++ b/zh/api-reference/openapi_completion.json @@ -28,7 +28,9 @@ "summary": "发送消息", "description": "发送请求给文本生成型应用。", "operationId": "createCompletionMessage", - "tags": ["文本生成"], + "tags": [ + "文本生成" + ], "requestBody": { "description": "创建完成消息的请求体。", "required": true, @@ -41,7 +43,9 @@ "streaming_example": { "summary": "流式模式示例", "value": { - "inputs": {"query": "你好，世界！"}, + "inputs": { + "query": "你好，世界！" + }, "response_mode": "streaming", "user": "abc-123" } @@ -59,17 +63,17 @@ "$ref": "#/components/schemas/ChatCompletionResponse" }, "examples": { - "blockingResponse": { - "summary": "阻塞模式响应示例", - "value": { - "id": "0b089b9a-24d9-48cc-94f8-762677276261", - "message_id": "0b089b9a-24d9-48cc-94f8-762677276261", - "mode": "chat", - "answer": "how are you?", - "metadata": {}, - "created_at": 1679586667 - } + "blockingResponse": { + "summary": "阻塞模式响应示例", + "value": { + "id": "0b089b9a-24d9-48cc-94f8-762677276261", + "message_id": "0b089b9a-24d9-48cc-94f8-762677276261", + "mode": "chat", + "answer": "how are you?", + "metadata": {}, + "created_at": 1679586667 } + } } }, "text/event-stream": { @@ -86,9 +90,15 @@ } } }, - "400": { "$ref": "#/components/responses/BadRequestCompletion" }, - "404": { "$ref": "#/components/responses/ConversationNotFound" }, - "500": { "$ref": "#/components/responses/InternalServerError" } + "400": { + "$ref": "#/components/responses/BadRequestCompletion" + }, + "404": { + "$ref": "#/components/responses/ConversationNotFound" + }, + "500": { + "$ref": "#/components/responses/InternalServerError" + } } } }, @@ -97,7 +107,9 @@ "summary": "上传文件", "description": "上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。支持 png, jpg, jpeg, webp, gif 格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadFile", - "tags": ["文件管理"], + "tags": [ + "文件管理" + ], "requestBody": { "description": "文件上传请求，需使用 `multipart/form-data`。", "required": true, @@ -105,7 +117,10 @@ "multipart/form-data": { "schema": { "type": "object", - "required": ["file", "user"], + "required": [ + "file", + "user" + ], "properties": { "file": { "type": "string", @@ -142,10 +157,18 @@ } } }, - "400": { "$ref": "#/components/responses/BadRequestFile" }, - "413": { "$ref": "#/components/responses/FileTooLarge" }, - "415": { "$ref": "#/components/responses/UnsupportedFileTypeFile" }, - "503": { "$ref": "#/components/responses/S3ErrorFile" } + "400": { + "$ref": "#/components/responses/BadRequestFile" + }, + "413": { + "$ref": "#/components/responses/FileTooLarge" + }, + "415": { + "$ref": "#/components/responses/UnsupportedFileTypeFile" + }, + "503": { + "$ref": "#/components/responses/S3ErrorFile" + } } } }, @@ -153,15 +176,20 @@ "get": { "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", - "operationId": "getEndUserCompletionCn", - "tags": ["终端用户"], + "operationId": "getEndUserCompletion", + "tags": [ + "终端用户" + ], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "终端用户 ID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -169,7 +197,9 @@ "description": "成功获取终端用户信息。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/EndUserDetail" } + "schema": { + "$ref": "#/components/schemas/EndUserDetail" + } } } }, @@ -177,7 +207,9 @@ "description": "终端用户不存在。错误码：`end_user_not_found`", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } }, @@ -185,7 +217,9 @@ "description": "服务内部异常。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/ErrorResponse" } + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } } } @@ -196,15 +230,20 @@ "post": { "summary": "停止响应", "description": "停止生成任务，仅支持流式模式。", - "operationId": "stopCompletionGeneration", - "tags": ["文本生成"], + "operationId": "stopGenerate", + "tags": [ + "文本生成" + ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "任务 ID，可在流式返回 Chunk 中获取。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { @@ -213,7 +252,9 @@ "application/json": { "schema": { "type": "object", - "required": ["user"], + "required": [ + "user" + ], "properties": { "user": { "type": "string", @@ -225,7 +266,9 @@ } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResult" } + "200": { + "$ref": "#/components/responses/SuccessResult" + } } } }, @@ -234,26 +277,35 @@ "summary": "消息反馈（点赞）", "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", "operationId": "postMessageFeedback", - "tags": ["反馈"], + "tags": [ + "反馈" + ], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/MessageFeedbackRequest" } + "schema": { + "$ref": "#/components/schemas/MessageFeedbackRequest" + } } } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResult" } + "200": { + "$ref": "#/components/responses/SuccessResult" + } } } }, @@ -262,17 +314,25 @@ "summary": "获取应用反馈列表", "description": "获取应用的反馈信息。", "operationId": "getAppFeedbacks", - "tags": ["反馈"], + "tags": [ + "反馈" + ], "parameters": [ - { "$ref": "#/components/parameters/PageQueryParam" }, - { "$ref": "#/components/parameters/LimitQueryParamDefault20" } + { + "$ref": "#/components/parameters/PageQueryParam" + }, + { + "$ref": "#/components/parameters/LimitQueryParamDefault20" + } ], "responses": { "200": { "description": "成功获取应用反馈列表。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/AppFeedbacksResponse" } + "schema": { + "$ref": "#/components/schemas/AppFeedbacksResponse" + } } } } @@ -284,12 +344,16 @@ "summary": "文字转语音", "description": "将文本内容转换为语音。", "operationId": "textToAudio", - "tags": ["语音服务"], + "tags": [ + "语音服务" + ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/TextToAudioRequest" } + "schema": { + "$ref": "#/components/schemas/TextToAudioRequest" + } } } }, @@ -297,11 +361,29 @@ "200": { "description": "语音文件生成成功。", "content": { - "audio/wav": { "schema": { "type": "string", "format": "binary", "description": "生成的 WAV 格式音频文件。" } }, - "audio/mp3": { "schema": { "type": "string", "format": "binary", "description": "生成的 MP3 格式音频文件。" } } + "audio/wav": { + "schema": { + "type": "string", + "format": "binary", + "description": "生成的 WAV 格式音频文件。" + } + }, + "audio/mp3": { + "schema": { + "type": "string", + "format": "binary", + "description": "生成的 MP3 格式音频文件。" + } + } }, "headers": { - "Content-Type": { "schema": { "type": "string", "example": "audio/wav" }, "description": "响应的内容类型，通常为 `audio/wav` 或 `audio/mp3`。" } + "Content-Type": { + "schema": { + "type": "string", + "example": "audio/wav" + }, + "description": "响应的内容类型，通常为 `audio/wav` 或 `audio/mp3`。" + } } } } @@ -312,11 +394,19 @@ "summary": "获取应用基本信息", "description": "用于获取此应用的基本信息。", "operationId": "getAppInfo", - "tags": ["应用设置"], + "tags": [ + "应用设置" + ], "responses": { "200": { "description": "应用的基本信息。", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInfoResponse" + } + } + } } } } @@ -326,11 +416,19 @@ "summary": "获取应用参数", "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", "operationId": "getAppParameters", - "tags": ["应用设置"], + "tags": [ + "应用设置" + ], "responses": { "200": { "description": "应用的参数信息。", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppParametersResponseCompletion" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppParametersResponseCompletion" + } + } + } } } } @@ -340,11 +438,19 @@ "summary": "获取应用 WebApp 设置", "description": "用于获取应用的 WebApp 设置。", "operationId": "getWebAppSettings", - "tags": ["应用设置"], + "tags": [ + "应用设置" + ], "responses": { "200": { "description": "应用的 WebApp 设置信息。", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebAppSettingsResponse" + } + } + } } } } @@ -354,27 +460,68 @@ "summary": "获取标注列表", "description": "获取应用的标注列表。", "operationId": "getAnnotationList", - "tags": ["标注管理"], + "tags": [ + "标注管理" + ], "parameters": [ - { "$ref": "#/components/parameters/PageQueryParam" }, - { "$ref": "#/components/parameters/LimitQueryParamAnnotation" } + { + "$ref": "#/components/parameters/PageQueryParam" + }, + { + "$ref": "#/components/parameters/LimitQueryParamAnnotation" + } ], "responses": { - "200": { "description": "成功获取标注列表。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationListResponse" } } } } + "200": { + "description": "成功获取标注列表。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnnotationListResponse" + } + } + } + } } }, "post": { "summary": "创建标注", "description": "创建一个新的标注。", "operationId": "createAnnotation", - "tags": ["标注管理"], + "tags": [ + "标注管理" + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationRequest" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateAnnotationRequest" + } + } + } }, "responses": { - "200": { "description": "标注创建成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItem" } } } }, - "201": { "description": "标注创建成功 (备选)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItem" } } } } + "200": { + "description": "标注创建成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnnotationItem" + } + } + } + }, + "201": { + "description": "标注创建成功 (备选)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnnotationItem" + } + } + } + } } } }, @@ -383,23 +530,54 @@ "summary": "更新标注", "description": "更新一个已存在的标注。", "operationId": "updateAnnotation", - "tags": ["标注管理"], - "parameters": [ { "$ref": "#/components/parameters/AnnotationIdPathParam" } ], + "tags": [ + "标注管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/AnnotationIdPathParam" + } + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnnotationRequest" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateAnnotationRequest" + } + } + } }, "responses": { - "200": { "description": "标注更新成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItem" } } } } + "200": { + "description": "标注更新成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnnotationItem" + } + } + } + } } }, "delete": { "summary": "删除标注", "description": "删除一个标注。", "operationId": "deleteAnnotation", - "tags": ["标注管理"], - "parameters": [ { "$ref": "#/components/parameters/AnnotationIdPathParam" } ], - "responses": { "204": { "description": "标注删除成功，无内容返回。" } } + "tags": [ + "标注管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/AnnotationIdPathParam" + } + ], + "responses": { + "204": { + "description": "标注删除成功，无内容返回。" + } + } } }, "/apps/annotation-reply/{action}": { @@ -407,15 +585,45 @@ "summary": "标注回复初始设置", "description": "启用或禁用标注回复设置，并配置嵌入模型。此接口异步执行。嵌入模型的提供商和模型名称可通过 v1/workspaces/current/models/model-types/text-embedding 接口获取（使用 Dataset API Token 鉴权）。", "operationId": "initialAnnotationReplySettings", - "tags": ["标注管理"], - "parameters": [ { "$ref": "#/components/parameters/AnnotationActionPathParam" } ], + "tags": [ + "标注管理" + ], + "parameters": [ + { + "$ref": "#/components/parameters/AnnotationActionPathParam" + } + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsRequest" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InitialAnnotationReplySettingsRequest" + } + } + } }, "responses": { - "200": { "description": "标注回复设置任务已启动。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncJobResponse" } } } }, - "202": { "description": "标注回复设置任务已接受。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncJobResponse" } } } } + "200": { + "description": "标注回复设置任务已启动。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncJobResponse" + } + } + } + }, + "202": { + "description": "标注回复设置任务已接受。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncJobResponse" + } + } + } + } } } }, @@ -424,13 +632,28 @@ "summary": "查询标注回复初始设置任务状态", "description": "查询异步执行的标注回复初始设置任务的状态。", "operationId": "getInitialAnnotationReplySettingsStatus", - "tags": ["标注管理"], + "tags": [ + "标注管理" + ], "parameters": [ - { "$ref": "#/components/parameters/AnnotationActionPathParam" }, - { "$ref": "#/components/parameters/JobIdPathParam" } + { + "$ref": "#/components/parameters/AnnotationActionPathParam" + }, + { + "$ref": "#/components/parameters/JobIdPathParam" + } ], "responses": { - "200": { "description": "成功获取任务状态。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncJobStatusResponse" } } } } + "200": { + "description": "成功获取任务状态。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncJobStatusResponse" + } + } + } + } } } } @@ -445,71 +668,274 @@ } }, "parameters": { - "PageQueryParam": { "name": "page", "in": "query", "description": "（可选）分页页码，默认：1。", "schema": { "type": "integer", "default": 1 } }, - "LimitQueryParamDefault20": { "name": "limit", "in": "query", "description": "（可选）每页记录数，默认：20。", "schema": { "type": "integer", "default": 20 } }, - "LimitQueryParamAnnotation": { "name": "limit", "in": "query", "description": "每页数量，默认 20，范围 1-100。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, - "AnnotationIdPathParam": { "name": "annotation_id", "in": "path", "required": true, "description": "标注 ID。", "schema": { "type": "string", "format": "uuid" } }, - "AnnotationActionPathParam": { "name": "action", "in": "path", "required": true, "description": "动作，只能是 'enable' 或 'disable'。", "schema": { "type": "string", "enum": ["enable", "disable"] } }, - "JobIdPathParam": { "name": "job_id", "in": "path", "required": true, "description": "任务 ID，从标注回复初始设置接口返回。", "schema": { "type": "string", "format": "uuid" } } + "PageQueryParam": { + "name": "page", + "in": "query", + "description": "（可选）分页页码，默认：1。", + "schema": { + "type": "integer", + "default": 1 + } + }, + "LimitQueryParamDefault20": { + "name": "limit", + "in": "query", + "description": "（可选）每页记录数，默认：20。", + "schema": { + "type": "integer", + "default": 20 + } + }, + "LimitQueryParamAnnotation": { + "name": "limit", + "in": "query", + "description": "每页数量，默认 20，范围 1-100。", + "schema": { + "type": "integer", + "default": 20, + "minimum": 1, + "maximum": 100 + } + }, + "AnnotationIdPathParam": { + "name": "annotation_id", + "in": "path", + "required": true, + "description": "标注 ID。", + "schema": { + "type": "string", + "format": "uuid" + } + }, + "AnnotationActionPathParam": { + "name": "action", + "in": "path", + "required": true, + "description": "动作，只能是 'enable' 或 'disable'。", + "schema": { + "type": "string", + "enum": [ + "enable", + "disable" + ] + } + }, + "JobIdPathParam": { + "name": "job_id", + "in": "path", + "required": true, + "description": "任务 ID，从标注回复初始设置接口返回。", + "schema": { + "type": "string", + "format": "uuid" + } + } }, "responses": { - "BadRequestCompletion": { "description": "错误的请求。可能原因：`invalid_param`（参数异常），`app_unavailable`（App 配置不可用），`provider_not_initialize`（无可用模型凭据），`provider_quota_exceeded`（额度不足），`model_currently_not_support`（模型不可用），`completion_request_error`（文本生成失败）。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "BadRequestFile": { "description": "文件操作相关的错误请求。可能原因：`no_file_uploaded`，`too_many_files`，`unsupported_preview`，`unsupported_estimate`。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "ConversationNotFound": { "description": "对话不存在。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "FileTooLarge": { "description": "文件太大 (`file_too_large`)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "UnsupportedFileTypeFile": { "description": "不支持的文件类型 (`unsupported_file_type`)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "S3ErrorFile": { "description": "S3 存储服务错误。可能原因：`s3_connection_failed`，`s3_permission_denied`，`s3_file_too_large`。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "InternalServerError": { "description": "服务内部异常。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, - "SuccessResult": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } } + "BadRequestCompletion": { + "description": "错误的请求。可能原因：`invalid_param`（参数异常），`app_unavailable`（App 配置不可用），`provider_not_initialize`（无可用模型凭据），`provider_quota_exceeded`（额度不足），`model_currently_not_support`（模型不可用），`completion_request_error`（文本生成失败）。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "BadRequestFile": { + "description": "文件操作相关的错误请求。可能原因：`no_file_uploaded`，`too_many_files`，`unsupported_preview`，`unsupported_estimate`。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "ConversationNotFound": { + "description": "对话不存在。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "FileTooLarge": { + "description": "文件太大 (`file_too_large`)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "UnsupportedFileTypeFile": { + "description": "不支持的文件类型 (`unsupported_file_type`)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "S3ErrorFile": { + "description": "S3 存储服务错误。可能原因：`s3_connection_failed`，`s3_permission_denied`，`s3_file_too_large`。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "InternalServerError": { + "description": "服务内部异常。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "SuccessResult": { + "description": "操作成功。", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + } + } + } + } + } + } }, "schemas": { "CompletionRequest": { "type": "object", - "required": ["inputs", "response_mode", "user"], + "required": [ + "inputs", + "response_mode", + "user" + ], "properties": { "inputs": { "type": "object", "description": "（选填）允许传入 App 定义的各变量值。inputs 参数包含了多组键值对，每组的键对应一个特定变量，值则是该变量的具体值。文本生成型应用要求至少传入一组键值对。", - "required": ["query"], + "required": [ + "query" + ], "properties": { - "query": { "type": "string", "description": "用户输入的文本内容。" } + "query": { + "type": "string", + "description": "用户输入的文本内容。" + } }, - "additionalProperties": true + "additionalProperties": true + }, + "response_mode": { + "type": "string", + "enum": [ + "streaming", + "blocking" + ], + "description": "响应返回模式。`streaming`：流式模式（推荐），基于 SSE 实现打字机输出。`blocking`：阻塞模式，等待执行完毕后返回（长流程可能中断）。Cloudflare 限制为 100 秒超时。" + }, + "user": { + "type": "string", + "description": "用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一。" }, - "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "description": "响应返回模式。`streaming`：流式模式（推荐），基于 SSE 实现打字机输出。`blocking`：阻塞模式，等待执行完毕后返回（长流程可能中断）。Cloudflare 限制为 100 秒超时。" }, - "user": { "type": "string", "description": "用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一。" }, "files": { "type": "array", - "items": { "$ref": "#/components/schemas/InputFileObject" }, + "items": { + "$ref": "#/components/schemas/InputFileObject" + }, "description": "上传的文件列表（目前仅支持图片）。" } } }, "InputFileObject": { "type": "object", - "required": ["type", "transfer_method"], + "required": [ + "type", + "transfer_method" + ], "properties": { - "type": { "type": "string", "enum": ["image"], "description": "支持类型：图片 `image`。" }, - "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" }, - "url": { "type": "string", "format": "url", "description": "图片地址（当传递方式为 remote_url 时）" }, - "upload_file_id": { "type": "string", "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" } + "type": { + "type": "string", + "enum": [ + "image" + ], + "description": "支持类型：图片 `image`。" + }, + "transfer_method": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ], + "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" + }, + "url": { + "type": "string", + "format": "url", + "description": "图片地址（当传递方式为 remote_url 时）" + }, + "upload_file_id": { + "type": "string", + "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" + } }, "anyOf": [ { - "properties": { - "transfer_method": { "enum": ["remote_url"] }, - "url": { "type": "string", "format": "url" } + "properties": { + "transfer_method": { + "enum": [ + "remote_url" + ] + }, + "url": { + "type": "string", + "format": "url" + } }, - "required": ["url"], - "not": { "required": ["upload_file_id"] } + "required": [ + "url" + ], + "not": { + "required": [ + "upload_file_id" + ] + } }, { - "properties": { - "transfer_method": { "enum": ["local_file"] }, - "upload_file_id": { "type": "string" } + "properties": { + "transfer_method": { + "enum": [ + "local_file" + ] + }, + "upload_file_id": { + "type": "string" + } }, - "required": ["upload_file_id"], - "not": { "required": ["url"] } + "required": [ + "upload_file_id" + ], + "not": { + "required": [ + "url" + ] + } } ] }, @@ -517,26 +943,66 @@ "type": "object", "description": "阻塞模式下的完整 App 结果。", "properties": { - "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, - "mode": { "type": "string", "description": "App 模式，固定为 `chat`。", "example": "chat" }, - "answer": { "type": "string", "description": "完整回复内容。" }, - "metadata": { "$ref": "#/components/schemas/ResponseMetadata" }, - "created_at": { "type": "integer", "format": "int64", "description": "消息创建时间戳，如：1705395332。" } + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息唯一 ID。" + }, + "mode": { + "type": "string", + "description": "App 模式，固定为 `chat`。", + "example": "chat" + }, + "answer": { + "type": "string", + "description": "完整回复内容。" + }, + "metadata": { + "$ref": "#/components/schemas/ResponseMetadata" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "消息创建时间戳，如：1705395332。" + } } }, "ResponseMetadata": { - "type": "object", "description": "元数据。", + "type": "object", + "description": "元数据。", "properties": { - "usage": { "$ref": "#/components/schemas/Usage" }, - "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResource" }, "description": "引用和归属分段列表。" } + "usage": { + "$ref": "#/components/schemas/Usage" + }, + "retriever_resources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RetrieverResource" + }, + "description": "引用和归属分段列表。" + } } }, "ChunkEvent": { "type": "object", "description": "流式响应中的事件块结构。", - "required": ["event"], + "required": [ + "event" + ], "properties": { - "event": { "type": "string", "enum": ["message", "message_end", "tts_message", "tts_message_end", "message_replace", "error", "ping"], "description": "事件类型。" } + "event": { + "type": "string", + "enum": [ + "message", + "message_end", + "tts_message", + "tts_message_end", + "message_replace", + "error", + "ping" + ], + "description": "事件类型。" + } }, "discriminator": { "propertyName": "event", @@ -552,168 +1018,1020 @@ } }, "StreamEventBase": { - "type": "object", - "properties": { - "task_id": { "type": "string", "format": "uuid", "description": "任务 ID，用于请求跟踪和停止响应接口。" }, - "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, - "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳，如：1705395332。" } + "type": "object", + "properties": { + "task_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID，用于请求跟踪和停止响应接口。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息唯一 ID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间戳，如：1705395332。" } + } }, "StreamEventMessage": { - "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, - { "type": "object", "description": "LLM 返回文本块事件。", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLM 返回文本块内容。" } } } + "allOf": [ + { + "$ref": "#/components/schemas/ChunkEvent" + }, + { + "$ref": "#/components/schemas/StreamEventBase" + }, + { + "type": "object", + "description": "LLM 返回文本块事件。", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "LLM 返回文本块内容。" + } + } + } ] }, "StreamEventMessageEnd": { - "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, - { "type": "object", "description": "消息结束事件。", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadata" } } } + "allOf": [ + { + "$ref": "#/components/schemas/ChunkEvent" + }, + { + "$ref": "#/components/schemas/StreamEventBase" + }, + { + "type": "object", + "description": "消息结束事件。", + "required": [ + "metadata" + ], + "properties": { + "metadata": { + "$ref": "#/components/schemas/ResponseMetadata" + } + } + } ] }, "StreamEventTtsMessage": { - "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, - { "type": "object", "description": "TTS 音频流事件 (Mp3格式, Base64编码)。开启自动播放时可用。", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64 编码的音频块。" } } } + "allOf": [ + { + "$ref": "#/components/schemas/ChunkEvent" + }, + { + "$ref": "#/components/schemas/StreamEventBase" + }, + { + "type": "object", + "description": "TTS 音频流事件 (Mp3格式, Base64编码)。开启自动播放时可用。", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "format": "byte", + "description": "Base64 编码的音频块。" + } + } + } ] }, "StreamEventTtsMessageEnd": { - "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, - { "type": "object", "description": "TTS 音频流结束事件。", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空字符串。" } } } + "allOf": [ + { + "$ref": "#/components/schemas/ChunkEvent" + }, + { + "$ref": "#/components/schemas/StreamEventBase" + }, + { + "type": "object", + "description": "TTS 音频流结束事件。", + "required": [ + "audio" + ], + "properties": { + "audio": { + "type": "string", + "description": "空字符串。" + } + } + } ] }, "StreamEventMessageReplace": { - "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, - { "type": "object", "description": "消息内容替换事件（内容审查触发）。", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "替换内容（直接替换所有 LLM 回复）。" } } } + "allOf": [ + { + "$ref": "#/components/schemas/ChunkEvent" + }, + { + "$ref": "#/components/schemas/StreamEventBase" + }, + { + "type": "object", + "description": "消息内容替换事件（内容审查触发）。", + "required": [ + "answer" + ], + "properties": { + "answer": { + "type": "string", + "description": "替换内容（直接替换所有 LLM 回复）。" + } + } + } ] }, "StreamEventError": { - "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, - { "type": "object", "description": "流式输出过程中的异常事件。", "required": ["status", "code", "message"], - "properties": { "status": { "type": "integer", "description": "HTTP 状态码。" }, "code": { "type": "string", "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } + "allOf": [ + { + "$ref": "#/components/schemas/ChunkEvent" + }, + { + "$ref": "#/components/schemas/StreamEventBase" + }, + { + "type": "object", + "description": "流式输出过程中的异常事件。", + "required": [ + "status", + "code", + "message" + ], + "properties": { + "status": { + "type": "integer", + "description": "HTTP 状态码。" + }, + "code": { + "type": "string", + "description": "错误码。" + }, + "message": { + "type": "string", + "description": "错误消息。" + } + } } ] }, "StreamEventPing": { - "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "type": "object", "description": "每 10s 一次的 ping 事件，保持连接存活。" } ] + "allOf": [ + { + "$ref": "#/components/schemas/ChunkEvent" + }, + { + "type": "object", + "description": "每 10s 一次的 ping 事件，保持连接存活。" + } + ] }, "Usage": { - "type": "object", "description": "模型用量信息。", - "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } + "type": "object", + "description": "模型用量信息。", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "prompt_unit_price": { + "type": "string" + }, + "prompt_price_unit": { + "type": "string" + }, + "prompt_price": { + "type": "string" + }, + "completion_tokens": { + "type": "integer" + }, + "completion_unit_price": { + "type": "string" + }, + "completion_price_unit": { + "type": "string" + }, + "completion_price": { + "type": "string" + }, + "total_tokens": { + "type": "integer" + }, + "total_price": { + "type": "string" + }, + "currency": { + "type": "string" + }, + "latency": { + "type": "number", + "format": "double" + } + } }, "RetrieverResource": { - "type": "object", "description": "引用和归属分段信息。", - "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } + "type": "object", + "description": "引用和归属分段信息。", + "properties": { + "position": { + "type": "integer" + }, + "dataset_id": { + "type": "string", + "format": "uuid" + }, + "dataset_name": { + "type": "string" + }, + "document_id": { + "type": "string", + "format": "uuid" + }, + "document_name": { + "type": "string" + }, + "segment_id": { + "type": "string", + "format": "uuid" + }, + "score": { + "type": "number", + "format": "float" + }, + "content": { + "type": "string" + } + } }, "FileUploadResponse": { - "type": "object", "description": "文件上传成功后的响应。", - "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "文件名。" }, "size": { "type": "integer", "description": "文件大小（byte）。" }, "extension": { "type": "string", "description": "文件后缀。" }, "mime_type": { "type": "string", "description": "文件 mime-type。" }, "created_by": { "type": "string", "format": "uuid", "description": "上传人 ID (示例中为integer，规范为uuid)。" }, "created_at": { "type": "integer", "format": "int64", "description": "上传时间。" } } + "type": "object", + "description": "文件上传成功后的响应。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "name": { + "type": "string", + "description": "文件名。" + }, + "size": { + "type": "integer", + "description": "文件大小（byte）。" + }, + "extension": { + "type": "string", + "description": "文件后缀。" + }, + "mime_type": { + "type": "string", + "description": "文件 mime-type。" + }, + "created_by": { + "type": "string", + "format": "uuid", + "description": "上传人 ID (示例中为integer，规范为uuid)。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "上传时间。" + } + } }, "EndUserDetail": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, - "tenant_id": { "type": "string", "format": "uuid" }, - "app_id": { "type": "string", "format": "uuid", "nullable": true }, - "type": { "type": "string", "example": "service_api" }, - "external_user_id": { "type": "string", "nullable": true }, - "name": { "type": "string", "nullable": true }, - "is_anonymous": { "type": "boolean" }, - "session_id": { "type": "string" }, - "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { "type": "string", "format": "date-time" } + "id": { + "type": "string", + "format": "uuid" + }, + "tenant_id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "type": { + "type": "string", + "example": "service_api" + }, + "external_user_id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "is_anonymous": { + "type": "boolean" + }, + "session_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } } }, "MessageFeedbackRequest": { - "type": "object", "required": ["user"], "description": "消息反馈请求体。", - "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "点赞 `like`, 点踩 `dislike`, 撤销 `null`。" }, "user": { "type": "string", "description": "用户标识，应用内唯一。" }, "content": { "type": "string", "nullable": true, "description": "消息反馈的具体信息。" } } + "type": "object", + "required": [ + "user" + ], + "description": "消息反馈请求体。", + "properties": { + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true, + "description": "点赞 `like`, 点踩 `dislike`, 撤销 `null`。" + }, + "user": { + "type": "string", + "description": "用户标识，应用内唯一。" + }, + "content": { + "type": "string", + "nullable": true, + "description": "消息反馈的具体信息。" + } + } }, "AppFeedbacksResponse": { - "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItem" }, "description": "应用反馈列表。" } } + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FeedbackItem" + }, + "description": "应用反馈列表。" + } + } }, "FeedbackItem": { - "type": "object", "description": "单个反馈条目。", - "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid", "nullable": true }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string", "nullable": true }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } + "type": "object", + "description": "单个反馈条目。", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid" + }, + "conversation_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "message_id": { + "type": "string", + "format": "uuid" + }, + "rating": { + "type": "string", + "enum": [ + "like", + "dislike", + null + ], + "nullable": true + }, + "content": { + "type": "string", + "nullable": true + }, + "from_source": { + "type": "string" + }, + "from_end_user_id": { + "type": "string", + "format": "uuid" + }, + "from_account_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } }, "TextToAudioRequest": { - "type": "object", "required": ["user"], "description": "文字转语音请求体。", - "properties": { "message_id": { "type": "string", "format": "uuid", "description": "Dify 生成的消息 ID（优先使用）。" }, "text": { "type": "string", "description": "语音生成内容（若无 message_id）。" }, "user": { "type": "string", "description": "用户标识，应用内唯一。" }, "streaming": {"type": "boolean", "default": false, "description": "是否流式返回音频。"} }, - "example": { "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "text": "你好Dify", "user": "abc-123", "streaming": false } + "type": "object", + "required": [ + "user" + ], + "description": "文字转语音请求体。", + "properties": { + "message_id": { + "type": "string", + "format": "uuid", + "description": "Dify 生成的消息 ID（优先使用）。" + }, + "text": { + "type": "string", + "description": "语音生成内容（若无 message_id）。" + }, + "user": { + "type": "string", + "description": "用户标识，应用内唯一。" + }, + "streaming": { + "type": "boolean", + "default": false, + "description": "是否流式返回音频。" + } + }, + "example": { + "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", + "text": "你好Dify", + "user": "abc-123", + "streaming": false + } }, "AppInfoResponse": { - "type": "object", "description": "应用基本信息。", - "properties": { "name": { "type": "string", "description": "应用名称。" }, "description": { "type": "string", "description": "应用描述。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "应用标签。" } } + "type": "object", + "description": "应用基本信息。", + "properties": { + "name": { + "type": "string", + "description": "应用名称。" + }, + "description": { + "type": "string", + "description": "应用描述。" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "应用标签。" + } + } }, "AppParametersResponseCompletion": { - "type": "object", "description": "应用参数信息。", - "properties": { - "opening_statement": { "type": "string", "description": "开场白。", "example": "nice to meet you" }, - "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "开场推荐问题列表。" }, - "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启回答后推荐问题。" } } }, - "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启语音转文本。" } } }, - "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启引用和归属。" } } }, - "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启标记回复。" } } }, - "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItem" }, "description": "用户输入表单配置。" }, - "file_upload": { "$ref": "#/components/schemas/FileUploadSetting" }, - "system_parameters": { "$ref": "#/components/schemas/SystemParameters" } - } - }, - "UserInputFormItem": { "type": "object", "description": "用户输入表单中的一个控件。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapper" }, { "$ref": "#/components/schemas/ParagraphControlWrapper" }, { "$ref": "#/components/schemas/SelectControlWrapper" } ] }, - "TextInputControlWrapper": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControl" } }, "required":["text-input"] }, - "ParagraphControlWrapper": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControl" } }, "required":["paragraph"] }, - "SelectControlWrapper": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControl" } }, "required":["select"] }, - "TextInputControl": { "type": "object", "description": "文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "description": "默认值。" }, "max_length": {"type": "integer", "description": "最大长度 (来自示例)。", "nullable": true} } }, - "ParagraphControl": { "type": "object", "description": "段落文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "description": "默认值。" } } }, - "SelectControl": { "type": "object", "description": "下拉控件。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "description": "默认值。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "选项值。" } } }, + "type": "object", + "description": "应用参数信息。", + "properties": { + "opening_statement": { + "type": "string", + "description": "开场白。", + "example": "nice to meet you" + }, + "suggested_questions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "开场推荐问题列表。" + }, + "suggested_questions_after_answer": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启回答后推荐问题。" + } + } + }, + "speech_to_text": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启语音转文本。" + } + } + }, + "retriever_resource": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启引用和归属。" + } + } + }, + "annotation_reply": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启标记回复。" + } + } + }, + "user_input_form": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserInputFormItem" + }, + "description": "用户输入表单配置。" + }, + "file_upload": { + "$ref": "#/components/schemas/FileUploadSetting" + }, + "system_parameters": { + "$ref": "#/components/schemas/SystemParameters" + } + } + }, + "UserInputFormItem": { + "type": "object", + "description": "用户输入表单中的一个控件。", + "oneOf": [ + { + "$ref": "#/components/schemas/TextInputControlWrapper" + }, + { + "$ref": "#/components/schemas/ParagraphControlWrapper" + }, + { + "$ref": "#/components/schemas/SelectControlWrapper" + } + ] + }, + "TextInputControlWrapper": { + "type": "object", + "properties": { + "text-input": { + "$ref": "#/components/schemas/TextInputControl" + } + }, + "required": [ + "text-input" + ] + }, + "ParagraphControlWrapper": { + "type": "object", + "properties": { + "paragraph": { + "$ref": "#/components/schemas/ParagraphControl" + } + }, + "required": [ + "paragraph" + ] + }, + "SelectControlWrapper": { + "type": "object", + "properties": { + "select": { + "$ref": "#/components/schemas/SelectControl" + } + }, + "required": [ + "select" + ] + }, + "TextInputControl": { + "type": "object", + "description": "文本输入控件。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "description": "默认值。" + }, + "max_length": { + "type": "integer", + "description": "最大长度 (来自示例)。", + "nullable": true + } + } + }, + "ParagraphControl": { + "type": "object", + "description": "段落文本输入控件。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "description": "默认值。" + } + } + }, + "SelectControl": { + "type": "object", + "description": "下拉控件。", + "required": [ + "label", + "variable", + "required", + "options" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "description": "默认值。" + }, + "options": { + "type": "array", + "items": { + "type": "string" + }, + "description": "选项值。" + } + } + }, "FileUploadSetting": { - "type": "object", "description": "文件上传配置。", - "properties": { "image": { "type": "object", "description": "图片设置。当前仅支持图片类型：`png`, `jpg`, `jpeg`, `webp`, `gif`。", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" }, "number_limits": { "type": "integer", "description": "图片数量限制，默认 3。" }, "detail": {"type": "string", "description": "图片细节 (来自示例)。", "nullable": true}, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] }, "description": "传递方式列表，remote_url , local_file，必选一个。" } } } } + "type": "object", + "description": "文件上传配置。", + "properties": { + "image": { + "type": "object", + "description": "图片设置。当前仅支持图片类型：`png`, `jpg`, `jpeg`, `webp`, `gif`。", + "properties": { + "enabled": { + "type": "boolean", + "description": "是否开启。" + }, + "number_limits": { + "type": "integer", + "description": "图片数量限制，默认 3。" + }, + "detail": { + "type": "string", + "description": "图片细节 (来自示例)。", + "nullable": true + }, + "transfer_methods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ] + }, + "description": "传递方式列表，remote_url , local_file，必选一个。" + } + } + } + } }, "SystemParameters": { - "type": "object", "description": "系统参数。", - "properties": { "file_size_limit": { "type": "integer", "description": "文档上传大小限制 (MB)。" }, "image_file_size_limit": { "type": "integer", "description": "图片文件上传大小限制（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "音频文件上传大小限制 (MB)。" }, "video_file_size_limit": { "type": "integer", "description": "视频文件上传大小限制 (MB)。" } } + "type": "object", + "description": "系统参数。", + "properties": { + "file_size_limit": { + "type": "integer", + "description": "文档上传大小限制 (MB)。" + }, + "image_file_size_limit": { + "type": "integer", + "description": "图片文件上传大小限制（MB）。" + }, + "audio_file_size_limit": { + "type": "integer", + "description": "音频文件上传大小限制 (MB)。" + }, + "video_file_size_limit": { + "type": "integer", + "description": "视频文件上传大小限制 (MB)。" + } + } }, "WebAppSettingsResponse": { - "type": "object", "description": "应用的 WebApp 设置。", - "properties": { "title": { "type": "string", "description": "WebApp 名称。" }, "chat_color_theme": { "type": "string", "description": "聊天颜色主题, hex 格式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "图标类型, `emoji`-表情, `image`-图片。" }, "icon": { "type": "string", "description": "图标, emoji 或图片 URL。" }, "icon_background": { "type": "string", "description": "hex 格式的背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "图标 URL。" }, "description": { "type": "string", "description": "描述。" }, "copyright": { "type": "string", "description": "版权信息。" }, "privacy_policy": { "type": "string", "description": "隐私政策链接。" }, "custom_disclaimer": { "type": "string", "description": "自定义免责声明。" }, "default_language": { "type": "string", "description": "默认语言。" }, "show_workflow_steps": { "type": "boolean", "description": "是否显示工作流详情。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "是否使用 WebApp 图标替换聊天中的 机器人图标。" } } + "type": "object", + "description": "应用的 WebApp 设置。", + "properties": { + "title": { + "type": "string", + "description": "WebApp 名称。" + }, + "chat_color_theme": { + "type": "string", + "description": "聊天颜色主题, hex 格式。" + }, + "chat_color_theme_inverted": { + "type": "boolean", + "description": "聊天颜色主题是否反转。" + }, + "icon_type": { + "type": "string", + "enum": [ + "emoji", + "image" + ], + "description": "图标类型, `emoji`-表情, `image`-图片。" + }, + "icon": { + "type": "string", + "description": "图标, emoji 或图片 URL。" + }, + "icon_background": { + "type": "string", + "description": "hex 格式的背景色。" + }, + "icon_url": { + "type": "string", + "format": "url", + "nullable": true, + "description": "图标 URL。" + }, + "description": { + "type": "string", + "description": "描述。" + }, + "copyright": { + "type": "string", + "description": "版权信息。" + }, + "privacy_policy": { + "type": "string", + "description": "隐私政策链接。" + }, + "custom_disclaimer": { + "type": "string", + "description": "自定义免责声明。" + }, + "default_language": { + "type": "string", + "description": "默认语言。" + }, + "show_workflow_steps": { + "type": "boolean", + "description": "是否显示工作流详情。" + }, + "use_icon_as_answer_icon": { + "type": "boolean", + "description": "是否使用 WebApp 图标替换聊天中的 机器人图标。" + } + } }, "AnnotationListResponse": { - "type": "object", "description": "标注列表响应。", - "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationItem" } }, "has_more": { "type": "boolean" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "page": { "type": "integer" } } + "type": "object", + "description": "标注列表响应。", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AnnotationItem" + } + }, + "has_more": { + "type": "boolean" + }, + "limit": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "page": { + "type": "integer" + } + } }, "AnnotationItem": { - "type": "object", "description": "单个标注条目。", - "properties": { "id": { "type": "string", "format": "uuid" }, "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" }, "hit_count": { "type": "integer", "description": "命中次数。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } } + "type": "object", + "description": "单个标注条目。", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "question": { + "type": "string", + "description": "问题。" + }, + "answer": { + "type": "string", + "description": "答案内容。" + }, + "hit_count": { + "type": "integer", + "description": "命中次数。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间戳。" + } + } }, "CreateAnnotationRequest": { - "type": "object", "required": ["question", "answer"], "description": "创建标注请求体。", - "properties": { "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" } } + "type": "object", + "required": [ + "question", + "answer" + ], + "description": "创建标注请求体。", + "properties": { + "question": { + "type": "string", + "description": "问题。" + }, + "answer": { + "type": "string", + "description": "答案内容。" + } + } }, "UpdateAnnotationRequest": { - "type": "object", "required": ["question", "answer"], "description": "更新标注请求体。", - "properties": { "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" } } + "type": "object", + "required": [ + "question", + "answer" + ], + "description": "更新标注请求体。", + "properties": { + "question": { + "type": "string", + "description": "问题。" + }, + "answer": { + "type": "string", + "description": "答案内容。" + } + } }, "InitialAnnotationReplySettingsRequest": { - "type": "object", "required": ["score_threshold"], "description": "标注回复初始设置请求体。", - "properties": { "embedding_provider_name": { "type": "string", "nullable": true, "description": "（可选）指定的嵌入模型提供商名称。" }, "embedding_model_name": { "type": "string", "nullable": true, "description": "（可选）指定的嵌入模型名称。" }, "score_threshold": { "type": "number", "format": "float", "description": "相似度阈值。" } } + "type": "object", + "required": [ + "score_threshold" + ], + "description": "标注回复初始设置请求体。", + "properties": { + "embedding_provider_name": { + "type": "string", + "nullable": true, + "description": "（可选）指定的嵌入模型提供商名称。" + }, + "embedding_model_name": { + "type": "string", + "nullable": true, + "description": "（可选）指定的嵌入模型名称。" + }, + "score_threshold": { + "type": "number", + "format": "float", + "description": "相似度阈值。" + } + } }, "AsyncJobResponse": { - "type": "object", "description": "异步任务响应。", - "properties": { "job_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, "job_status": { "type": "string", "description": "任务状态。" } } + "type": "object", + "description": "异步任务响应。", + "properties": { + "job_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID。" + }, + "job_status": { + "type": "string", + "description": "任务状态。" + } + } }, "AsyncJobStatusResponse": { - "allOf": [ { "$ref": "#/components/schemas/AsyncJobResponse" }, { "type": "object", "properties": { "error_msg": { "type": "string", "nullable": true, "description": "错误信息（如果任务失败）。" } } } ] + "allOf": [ + { + "$ref": "#/components/schemas/AsyncJobResponse" + }, + { + "type": "object", + "properties": { + "error_msg": { + "type": "string", + "nullable": true, + "description": "错误信息（如果任务失败）。" + } + } + } + ] }, "ErrorResponse": { - "type": "object", "description": "错误响应结构。", - "properties": { "status": { "type": "integer", "description": "HTTP 状态码。", "nullable": true }, "code": { "type": "string", "description": "错误码。", "nullable": true }, "message": { "type": "string", "description": "错误消息。" } } + "type": "object", + "description": "错误响应结构。", + "properties": { + "status": { + "type": "integer", + "description": "HTTP 状态码。", + "nullable": true + }, + "code": { + "type": "string", + "description": "错误码。", + "nullable": true + }, + "message": { + "type": "string", + "description": "错误消息。" + } + } } } }, "tags": [ - { "name": "文本生成", "description": "与文本生成和完成相关的操作。" }, - { "name": "文件管理", "description": "与文件上传和管理相关的操作。" }, - { "name": "终端用户", "description": "终端用户信息相关的操作。" }, - { "name": "反馈", "description": "与用户反馈相关的操作。" }, - { "name": "语音服务", "description": "与文本转语音相关的操作。" }, - { "name": "应用设置", "description": "获取应用基本信息和参数配置的操作。" }, - { "name": "标注管理", "description": "与标注（用于直接回复）相关的操作。" } + { + "name": "文本生成", + "description": "与文本生成和完成相关的操作。" + }, + { + "name": "文件管理", + "description": "与文件上传和管理相关的操作。" + }, + { + "name": "终端用户", + "description": "终端用户信息相关的操作。" + }, + { + "name": "反馈", + "description": "与用户反馈相关的操作。" + }, + { + "name": "语音服务", + "description": "与文本转语音相关的操作。" + }, + { + "name": "应用设置", + "description": "获取应用基本信息和参数配置的操作。" + }, + { + "name": "标注管理", + "description": "与标注（用于直接回复）相关的操作。" + } ] -} \ No newline at end of file +} diff --git a/zh/api-reference/openapi_workflow.json b/zh/api-reference/openapi_workflow.json index ed9742e9a..4795d2e69 100644 --- a/zh/api-reference/openapi_workflow.json +++ b/zh/api-reference/openapi_workflow.json @@ -27,8 +27,10 @@ "post": { "summary": "执行 workflow", "description": "执行 workflow，没有已发布的 workflow，不可执行。", - "operationId": "executeWorkflowCn", - "tags": ["工作流执行"], + "operationId": "executeWorkflow", + "tags": [ + "工作流执行" + ], "requestBody": { "required": true, "content": { @@ -47,7 +49,7 @@ "user": "workflow_user_001" } }, - "with_file_array_variable_cn":{ + "with_file_array_variable_cn": { "summary": "包含文件列表变量的输入示例", "value": { "inputs": { @@ -89,8 +91,12 @@ } } }, - "400": { "$ref": "#/components/responses/BadRequestWorkflowCn" }, - "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + "400": { + "$ref": "#/components/responses/BadRequestWorkflowCn" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorCn" + } } } }, @@ -98,15 +104,20 @@ "get": { "summary": "获取workflow执行情况", "description": "根据 workflow 执行 ID 获取 workflow 任务当前执行结果。", - "operationId": "getWorkflowRunDetailCn", - "tags": ["工作流执行"], + "operationId": "getWorkflowRunDetail", + "tags": [ + "工作流执行" + ], "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "workflow 执行 ID，可在流式返回 Chunk 或阻塞模式响应中获取。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -114,11 +125,15 @@ "description": "成功获取 workflow 执行详情。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/WorkflowRunDetailResponseCn" } + "schema": { + "$ref": "#/components/schemas/WorkflowRunDetailResponseCn" + } } } }, - "404": {"description": "Workflow 执行记录未找到。"} + "404": { + "description": "Workflow 执行记录未找到。" + } } } }, @@ -126,15 +141,20 @@ "post": { "summary": "停止响应 (Workflow Task)", "description": "停止 workflow 任务的生成。仅支持流式模式。", - "operationId": "stopWorkflowTaskGenerationCn", - "tags": ["工作流执行"], + "operationId": "stopWorkflowTaskGeneration", + "tags": [ + "工作流执行" + ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "任务 ID，可在流式返回 Chunk 中获取。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "requestBody": { @@ -143,16 +163,23 @@ "application/json": { "schema": { "type": "object", - "required": ["user"], + "required": [ + "user" + ], "properties": { - "user": { "type": "string", "description": "用户标识，必须和执行 workflow 接口传入的 user 保持一致。" } + "user": { + "type": "string", + "description": "用户标识，必须和执行 workflow 接口传入的 user 保持一致。" + } } } } } }, "responses": { - "200": { "$ref": "#/components/responses/SuccessResultCn" } + "200": { + "$ref": "#/components/responses/SuccessResultCn" + } } } }, @@ -160,31 +187,71 @@ "post": { "summary": "上传文件 (Workflow)", "description": "上传文件并在执行 workflow 时使用。支持你的工作流程所支持的任何格式。上传的文件仅供当前终端用户使用。", - "operationId": "uploadWorkflowFileCn", - "tags": ["文件操作 (Workflow)"], + "operationId": "uploadWorkflowFile", + "tags": [ + "文件操作 (Workflow)" + ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", - "required": ["file", "user"], + "required": [ + "file", + "user" + ], "properties": { - "file": { "type": "string", "format": "binary", "description": "要上传的文件。" }, - "user": { "type": "string", "description": "用户标识。" } + "file": { + "type": "string", + "format": "binary", + "description": "要上传的文件。" + }, + "user": { + "type": "string", + "description": "用户标识。" + } } } } } }, "responses": { - "200": { "description": "文件上传成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseCn" } } } }, - "201": { "description": "文件创建成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseCn" } } } }, - "400": { "$ref": "#/components/responses/BadRequestFileCn" }, - "413": { "$ref": "#/components/responses/FileTooLargeCn" }, - "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileCn" }, - "503": { "$ref": "#/components/responses/S3ErrorFileCn" }, - "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + "200": { + "description": "文件上传成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseCn" + } + } + } + }, + "201": { + "description": "文件创建成功。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FileUploadResponseCn" + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequestFileCn" + }, + "413": { + "$ref": "#/components/responses/FileTooLargeCn" + }, + "415": { + "$ref": "#/components/responses/UnsupportedFileTypeFileCn" + }, + "503": { + "$ref": "#/components/responses/S3ErrorFileCn" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorCn" + } } } }, @@ -192,15 +259,20 @@ "get": { "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", - "operationId": "getEndUserWorkflowCn", - "tags": ["终端用户"], + "operationId": "getEndUserWorkflow", + "tags": [ + "终端用户" + ], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "终端用户 ID。", - "schema": { "type": "string", "format": "uuid" } + "schema": { + "type": "string", + "format": "uuid" + } } ], "responses": { @@ -208,240 +280,1524 @@ "description": "成功获取终端用户信息。", "content": { "application/json": { - "schema": { "$ref": "#/components/schemas/EndUserDetailCn" } + "schema": { + "$ref": "#/components/schemas/EndUserDetailCn" + } } } }, - "404": { "$ref": "#/components/responses/EndUserNotFoundCn" }, - "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + "404": { + "$ref": "#/components/responses/EndUserNotFoundCn" + }, + "500": { + "$ref": "#/components/responses/InternalServerErrorCn" + } } } }, "/workflows/logs": { - "get": { - "summary": "获取 workflow 日志", - "description": "倒序返回 workflow 日志。", - "operationId": "getWorkflowLogsCn", - "tags": ["工作流执行"], - "parameters": [ - { "name": "keyword", "in": "query", "description": "（可选）关键字。", "schema": { "type": "string" } }, - { "name": "status", "in": "query", "description": "（可选）执行状态：succeeded, failed, stopped, running。", "schema": { "type": "string", "enum": ["succeeded", "failed", "stopped", "running"] } }, - { "name": "page", "in": "query", "description": "（可选）当前页码, 默认1。", "schema": { "type": "integer", "default": 1 } }, - { "name": "limit", "in": "query", "description": "（可选）每页条数, 默认20。", "schema": { "type": "integer", "default": 20 } } - ], - "responses": { - "200": { "description": "成功获取 workflow 日志。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowLogsResponseCn" } } } } + "get": { + "summary": "获取 workflow 日志", + "description": "倒序返回 workflow 日志。", + "operationId": "getWorkflowLogs", + "tags": [ + "工作流执行" + ], + "parameters": [ + { + "name": "keyword", + "in": "query", + "description": "（可选）关键字。", + "schema": { + "type": "string" + } + }, + { + "name": "status", + "in": "query", + "description": "（可选）执行状态：succeeded, failed, stopped, running。", + "schema": { + "type": "string", + "enum": [ + "succeeded", + "failed", + "stopped", + "running" + ] + } + }, + { + "name": "page", + "in": "query", + "description": "（可选）当前页码, 默认1。", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "limit", + "in": "query", + "description": "（可选）每页条数, 默认20。", + "schema": { + "type": "integer", + "default": 20 + } + } + ], + "responses": { + "200": { + "description": "成功获取 workflow 日志。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowLogsResponseCn" + } + } } + } } + } }, "/info": { "get": { "summary": "获取应用基本信息 (Workflow)", - "operationId": "getWorkflowAppInfoCn", - "tags": ["应用配置 (Workflow)"], - "responses": { "200": { "description": "应用基本信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseCn" } } } } } + "operationId": "getWorkflowAppInfo", + "tags": [ + "应用配置 (Workflow)" + ], + "responses": { + "200": { + "description": "应用基本信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppInfoResponseCn" + } + } + } + } + } } }, "/parameters": { "get": { "summary": "获取应用参数 (Workflow)", - "operationId": "getWorkflowAppParametersCn", - "tags": ["应用配置 (Workflow)"], - "responses": { "200": { "description": "应用参数信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAppParametersResponseCn" } } } } } + "operationId": "getWorkflowAppParameters", + "tags": [ + "应用配置 (Workflow)" + ], + "responses": { + "200": { + "description": "应用参数信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowAppParametersResponseCn" + } + } + } + } + } } }, "/site": { "get": { "summary": "获取应用 WebApp 设置 (Workflow)", - "operationId": "getWorkflowWebAppSettingsCn", - "tags": ["应用配置 (Workflow)"], - "responses": { "200": { "description": "WebApp 设置信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowWebAppSettingsResponseCn" } } } } } + "operationId": "getWorkflowWebAppSettings", + "tags": [ + "应用配置 (Workflow)" + ], + "responses": { + "200": { + "description": "WebApp 设置信息。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowWebAppSettingsResponseCn" + } + } + } + } + } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" } + "ApiKeyAuth": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "API_KEY", + "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" + } }, "responses": { - "BadRequestWorkflowCn": { "description": "请求参数错误或工作流执行失败。可能错误码：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, workflow_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "BadRequestFileCn": { "description": "文件操作请求错误。可能错误码：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "FileTooLargeCn": { "description": "文件太大 (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "UnsupportedFileTypeFileCn": { "description": "不支持的文件类型 (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "S3ErrorFileCn": { "description": "S3 存储服务错误。可能错误码：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "InternalServerErrorCn": { "description": "服务内部异常。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, - "SuccessResultCn": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, - "EndUserNotFoundCn": { "description": "终端用户不存在。错误码：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } } + "BadRequestWorkflowCn": { + "description": "请求参数错误或工作流执行失败。可能错误码：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, workflow_request_error。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "BadRequestFileCn": { + "description": "文件操作请求错误。可能错误码：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "FileTooLargeCn": { + "description": "文件太大 (file_too_large)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "UnsupportedFileTypeFileCn": { + "description": "不支持的文件类型 (unsupported_file_type)。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "S3ErrorFileCn": { + "description": "S3 存储服务错误。可能错误码：s3_connection_failed, s3_permission_denied, s3_file_too_large。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "InternalServerErrorCn": { + "description": "服务内部异常。", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + }, + "SuccessResultCn": { + "description": "操作成功。", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string", + "example": "success" + } + } + } + } + } + }, + "EndUserNotFoundCn": { + "description": "终端用户不存在。错误码：`end_user_not_found`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponseCn" + } + } + } + } }, "schemas": { "WorkflowExecutionRequestCn": { "type": "object", - "required": ["inputs", "response_mode", "user"], + "required": [ + "inputs", + "response_mode", + "user" + ], "properties": { "inputs": { "type": "object", "description": "允许传入 App 定义的各变量值。如果变量是文件列表类型，该变量对应的值应是 InputFileObjectWorkflowCn 对象的列表。", "additionalProperties": { - "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object" }, { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectWorkflowCn" } } ] + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "object" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/InputFileObjectWorkflowCn" + } + } + ] }, - "example": { "user_query": "请帮我翻译这句话。", "target_language": "法语" } + "example": { + "user_query": "请帮我翻译这句话。", + "target_language": "法语" + } }, - "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "description": "返回响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。" }, - "user": { "type": "string", "description": "用户标识，应用内唯一。" } + "response_mode": { + "type": "string", + "enum": [ + "streaming", + "blocking" + ], + "description": "返回响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。" + }, + "user": { + "type": "string", + "description": "用户标识，应用内唯一。" + } } }, "InputFileObjectWorkflowCn": { "type": "object", - "required": ["type", "transfer_method"], + "required": [ + "type", + "transfer_method" + ], "properties": { - "type": { "type": "string", "enum": ["document", "image", "audio", "video", "custom"], "description": "文件类型。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: 其他。" }, - "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" }, - "url": { "type": "string", "format": "url", "description": "图片地址（当传递方式为 remote_url 时）" }, - "upload_file_id": { "type": "string", "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" } + "type": { + "type": "string", + "enum": [ + "document", + "image", + "audio", + "video", + "custom" + ], + "description": "文件类型。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: 其他。" + }, + "transfer_method": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ], + "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" + }, + "url": { + "type": "string", + "format": "url", + "description": "图片地址（当传递方式为 remote_url 时）" + }, + "upload_file_id": { + "type": "string", + "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" + } }, "anyOf": [ { - "properties": { - "transfer_method": { "enum": ["remote_url"] }, - "url": { "type": "string", "format": "url" } + "properties": { + "transfer_method": { + "enum": [ + "remote_url" + ] + }, + "url": { + "type": "string", + "format": "url" + } }, - "required": ["url"], - "not": { "required": ["upload_file_id"] } + "required": [ + "url" + ], + "not": { + "required": [ + "upload_file_id" + ] + } }, { - "properties": { - "transfer_method": { "enum": ["local_file"] }, - "upload_file_id": { "type": "string" } + "properties": { + "transfer_method": { + "enum": [ + "local_file" + ] + }, + "upload_file_id": { + "type": "string" + } }, - "required": ["upload_file_id"], - "not": { "required": ["url"] } + "required": [ + "upload_file_id" + ], + "not": { + "required": [ + "url" + ] + } } ] }, "WorkflowCompletionResponseCn": { - "type": "object", "description": "阻塞模式下的 workflow 执行结果。", + "type": "object", + "description": "阻塞模式下的 workflow 执行结果。", "properties": { - "workflow_run_id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, - "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, - "data": { "$ref": "#/components/schemas/WorkflowFinishedDataCn" } + "workflow_run_id": { + "type": "string", + "format": "uuid", + "description": "workflow 执行 ID。" + }, + "task_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID。" + }, + "data": { + "$ref": "#/components/schemas/WorkflowFinishedDataCn" + } } }, "ChunkWorkflowEventCn": { - "type": "object", "required": ["event"], - "properties": { "event": { "type": "string", "enum": ["workflow_started", "node_started", "text_chunk", "node_finished", "workflow_finished", "tts_message", "tts_message_end", "ping"], "description": "事件类型。" } }, - "discriminator": { "propertyName": "event", "mapping": { - "workflow_started": "#/components/schemas/StreamEventWfWorkflowStartedCn", "node_started": "#/components/schemas/StreamEventWfNodeStartedCn", - "text_chunk": "#/components/schemas/StreamEventWfTextChunkCn", "node_finished": "#/components/schemas/StreamEventWfNodeFinishedCn", - "workflow_finished": "#/components/schemas/StreamEventWfWorkflowFinishedCn", "tts_message": "#/components/schemas/StreamEventWfTtsMessageCn", - "tts_message_end": "#/components/schemas/StreamEventWfTtsMessageEndCn", "ping": "#/components/schemas/StreamEventWfPingCn" - }} + "type": "object", + "required": [ + "event" + ], + "properties": { + "event": { + "type": "string", + "enum": [ + "workflow_started", + "node_started", + "text_chunk", + "node_finished", + "workflow_finished", + "tts_message", + "tts_message_end", + "ping" + ], + "description": "事件类型。" + } + }, + "discriminator": { + "propertyName": "event", + "mapping": { + "workflow_started": "#/components/schemas/StreamEventWfWorkflowStartedCn", + "node_started": "#/components/schemas/StreamEventWfNodeStartedCn", + "text_chunk": "#/components/schemas/StreamEventWfTextChunkCn", + "node_finished": "#/components/schemas/StreamEventWfNodeFinishedCn", + "workflow_finished": "#/components/schemas/StreamEventWfWorkflowFinishedCn", + "tts_message": "#/components/schemas/StreamEventWfTtsMessageCn", + "tts_message_end": "#/components/schemas/StreamEventWfTtsMessageEndCn", + "ping": "#/components/schemas/StreamEventWfPingCn" + } + } }, "StreamEventBaseWfCn": { - "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, "workflow_run_id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" } } - }, - "StreamEventWfWorkflowStartedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowStartedDataCn" } } } ] }, - "WorkflowStartedDataCn": { "type": "object", "description": "Workflow 开始执行事件的详细内容。", "required": ["id", "workflow_id", "sequence_number", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "关联 Workflow ID。" }, "sequence_number": { "type": "integer", "description": "自增序号，App 内自增，从 1 开始。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, - "StreamEventWfNodeStartedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/NodeStartedDataCn" } } } ] }, - "NodeStartedDataCn": { "type": "object", "description": "Node 开始执行事件的详细内容。", "required": ["id", "node_id", "node_type", "title", "index", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID (应为 node 执行 ID，根据上下文修正)。" }, "node_id": { "type": "string", "format": "uuid", "description": "节点 ID。" }, "node_type": { "type": "string", "description": "节点类型。" }, "title": { "type": "string", "description": "节点名称。" }, "index": { "type": "integer", "description": "执行序号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "前置节点 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "节点中所有使用到的前置节点变量内容。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, - "StreamEventWfTextChunkCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TextChunkDataCn" } } } ] }, - "TextChunkDataCn": { "type": "object", "description": "文本片段事件的详细内容。", "required": ["text", "from_variable_selector"], "properties": { "text": { "type": "string", "description": "文本内容。" }, "from_variable_selector": { "type": "array", "items": { "type": "string" }, "description": "文本来源路径，帮助开发者了解文本是由哪个节点的哪个变量生成的。" } } }, - "StreamEventWfNodeFinishedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/NodeFinishedDataCn" } } } ] }, - "NodeFinishedDataCn": { "type": "object", "description": "Node 执行结束事件的详细内容。", "required": ["id", "node_id", "index", "status", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "node 执行 ID。" }, "node_id": { "type": "string", "format": "uuid", "description": "节点 ID。" }, "index": { "type": "integer", "description": "执行序号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（可选）前置节点 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "节点中所有使用到的前置节点变量内容。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）节点过程数据 (JSON)。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）输出内容 (JSON)。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, "error": { "type": "string", "nullable": true, "description": "（可选）错误原因。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（可选）耗时(秒)。" }, "execution_metadata": { "$ref": "#/components/schemas/NodeExecutionMetadataCn" , "nullable": true, "description":"元数据"}, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, - "NodeExecutionMetadataCn": { "type": "object", "description": "节点执行元数据。", "properties": { "total_tokens": { "type": "integer", "nullable": true, "description": "（可选）总使用 tokens。" }, "total_price": { "type": "number", "format": "float", "nullable": true, "description": "（可选）总费用 (使用 float 兼容 decimal)。" }, "currency": { "type": "string", "nullable": true, "example": "USD", "description": "（可选）货币，如 USD / RMB。" } } }, - "StreamEventWfWorkflowFinishedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowFinishedDataCn" } } } ] }, - "WorkflowFinishedDataCn": { "type": "object", "description": "Workflow 执行结束事件的详细内容。", "required": ["id", "workflow_id", "status", "created_at", "finished_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "关联 Workflow ID。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）输出内容 (JSON)。" }, "error": { "type": "string", "nullable": true, "description": "（可选）错误原因。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（可选）耗时(秒)。" }, "total_tokens": { "type": "integer", "nullable": true, "description": "（可选）总使用 tokens。" }, "total_steps": { "type": "integer", "default": 0, "description": "总步数，默认 0。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" }, "finished_at": { "type": "integer", "format": "int64", "description": "结束时间。" } } }, - "StreamEventWfTtsMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["audio", "message_id", "created_at"], "properties": { "audio": { "type": "string", "format": "byte", "description": "语音合成之后的音频块 Base64 编码文本。" }, "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } } } ] }, - "StreamEventWfTtsMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["audio", "message_id", "created_at"], "properties": { "audio": { "type": "string", "description": "结束事件音频为空字符串。" }, "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } } } ] }, - "StreamEventWfPingCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "type": "object", "description": "每 10s 一次的 ping 事件，保持连接存活。" } ] }, - "WorkflowRunDetailResponseCn": { - "type": "object", "description": "Workflow 执行详情。", - "properties": { - "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, - "workflow_id": { "type": "string", "format": "uuid", "description": "关联的 Workflow ID。" }, - "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, - "inputs": { "type": "string", "description": "任务输入内容的 JSON 字符串。" }, - "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "任务输出内容的 JSON 对象。" }, - "error": { "type": "string", "nullable": true, "description": "错误原因。" }, - "total_steps": { "type": "integer", "description": "任务执行总步数。" }, - "total_tokens": { "type": "integer", "description": "任务执行总 tokens。" }, - "created_at": { "type": "integer", "format": "int64", "description": "任务开始时间。" }, - "finished_at": { "type": "integer", "format": "int64", "nullable": true, "description": "任务结束时间。" }, - "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "耗时(秒)。" } - } - }, - "FileUploadResponseCn": { "type": "object", "description": "文件上传成功响应。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "文件名。" }, "size": { "type": "integer", "description": "文件大小 (byte)。" }, "extension": { "type": "string", "description": "文件后缀。" }, "mime_type": { "type": "string", "description": "文件 mime-type。" }, "created_by": { "type": "string", "format": "uuid", "description": "上传人 ID (应为 uuid，示例中为 int，已修正)。" }, "created_at": { "type": "integer", "format": "int64", "description": "上传时间。" } } }, - "EndUserDetailCn": { "type": "object", "properties": { - "id": { "type": "string", "format": "uuid" }, - "tenant_id": { "type": "string", "format": "uuid" }, - "app_id": { "type": "string", "format": "uuid", "nullable": true }, - "type": { "type": "string", "example": "service_api" }, - "external_user_id": { "type": "string", "nullable": true }, - "name": { "type": "string", "nullable": true }, - "is_anonymous": { "type": "boolean" }, - "session_id": { "type": "string" }, - "created_at": { "type": "string", "format": "date-time" }, - "updated_at": { "type": "string", "format": "date-time" } + "task_id": { + "type": "string", + "format": "uuid", + "description": "任务 ID。" + }, + "workflow_run_id": { + "type": "string", + "format": "uuid", + "description": "workflow 执行 ID。" + } } }, - "WorkflowLogsResponseCn": { - "type": "object", "description": "Workflow 日志列表响应。", + "StreamEventWfWorkflowStartedCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfCn" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/WorkflowStartedDataCn" + } + } + } + ] + }, + "WorkflowStartedDataCn": { + "type": "object", + "description": "Workflow 开始执行事件的详细内容。", + "required": [ + "id", + "workflow_id", + "sequence_number", + "created_at" + ], "properties": { - "page": { "type": "integer", "description": "当前页码。" }, "limit": { "type": "integer", "description": "每页条数。" }, - "total": { "type": "integer", "description": "总条数。" }, "has_more": { "type": "boolean", "description": "是否还有更多数据。" }, - "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowLogItemCn" }, "description": "当前页码的数据。" } + "id": { + "type": "string", + "format": "uuid", + "description": "workflow 执行 ID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "关联 Workflow ID。" + }, + "sequence_number": { + "type": "integer", + "description": "自增序号，App 内自增，从 1 开始。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "开始时间。" + } } }, - "WorkflowLogItemCn": { - "type": "object", "description": "单条 Workflow 日志。", + "StreamEventWfNodeStartedCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfCn" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NodeStartedDataCn" + } + } + } + ] + }, + "NodeStartedDataCn": { + "type": "object", + "description": "Node 开始执行事件的详细内容。", + "required": [ + "id", + "node_id", + "node_type", + "title", + "index", + "created_at" + ], "properties": { - "id": { "type": "string", "format": "uuid", "description": "标识。" }, - "workflow_run": { "$ref": "#/components/schemas/WorkflowRunSummaryCn", "description": "Workflow 执行日志。" }, - "created_from": { "type": "string", "description": "来源。" }, - "created_by_role": { "type": "string", "description": "角色。" }, - "created_by_account": { "type": "string", "format": "uuid", "nullable": true, "description": "（可选）帐号。" }, - "created_by_end_user": { "$ref": "#/components/schemas/EndUserSummaryCn", "description": "用户。" }, - "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" } + "id": { + "type": "string", + "format": "uuid", + "description": "workflow 执行 ID (应为 node 执行 ID，根据上下文修正)。" + }, + "node_id": { + "type": "string", + "format": "uuid", + "description": "节点 ID。" + }, + "node_type": { + "type": "string", + "description": "节点类型。" + }, + "title": { + "type": "string", + "description": "节点名称。" + }, + "index": { + "type": "integer", + "description": "执行序号。" + }, + "predecessor_node_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "前置节点 ID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "description": "节点中所有使用到的前置节点变量内容。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "开始时间。" + } } }, - "WorkflowRunSummaryCn": { - "type": "object", "description": "Workflow 执行摘要信息。", + "StreamEventWfTextChunkCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfCn" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TextChunkDataCn" + } + } + } + ] + }, + "TextChunkDataCn": { + "type": "object", + "description": "文本片段事件的详细内容。", + "required": [ + "text", + "from_variable_selector" + ], "properties": { - "id": { "type": "string", "format": "uuid", "description": "标识。" }, "version": { "type": "string", "description": "版本。" }, - "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, - "error": { "type": "string", "nullable": true, "description": "（可选）错误。" }, - "elapsed_time": { "type": "number", "format": "float", "description": "耗时，单位秒。" }, - "total_tokens": { "type": "integer", "description": "消耗的token数量。" }, - "total_steps": { "type": "integer", "description": "执行步骤长度。" }, - "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" }, - "finished_at": { "type": "integer", "format": "int64", "nullable": true, "description": "结束时间。" } + "text": { + "type": "string", + "description": "文本内容。" + }, + "from_variable_selector": { + "type": "array", + "items": { + "type": "string" + }, + "description": "文本来源路径，帮助开发者了解文本是由哪个节点的哪个变量生成的。" + } } }, - "EndUserSummaryCn": { - "type": "object", "description": "终端用户信息摘要。", + "StreamEventWfNodeFinishedCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfCn" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NodeFinishedDataCn" + } + } + } + ] + }, + "NodeFinishedDataCn": { + "type": "object", + "description": "Node 执行结束事件的详细内容。", + "required": [ + "id", + "node_id", + "index", + "status", + "created_at" + ], "properties": { - "id": { "type": "string", "format": "uuid", "description": "标识。" }, "type": { "type": "string", "description": "类型。" }, - "is_anonymous": { "type": "boolean", "description": "是否匿名。" }, "session_id": { "type": "string", "description": "会话标识。" } - } - }, - "AppInfoResponseCn": { "type": "object", "description": "应用基本信息。", "properties": { "name": { "type": "string", "description": "应用名称。" }, "description": { "type": "string", "description": "应用描述。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "应用标签。" } } }, - "WorkflowAppParametersResponseCn": { "type": "object", "description": "Workflow 应用参数信息。", "properties": { "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemCn" }, "description": "用户输入表单配置。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "detail": { "type": "string" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "图片设置。当前仅支持图片类型：png, jpg, jpeg, webp, gif。" } }, "description": "文件上传配置。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "文档上传大小限制 (MB)。" }, "image_file_size_limit": { "type": "integer", "description": "图片文件上传大小限制（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "音频文件上传大小限制 (MB)。" }, "video_file_size_limit": { "type": "integer", "description": "视频文件上传大小限制 (MB)。" } }, "description": "系统参数。" } } }, - "UserInputFormItemCn": { "type": "object", "description": "用户输入表单中的控件项。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperCn" }, { "$ref": "#/components/schemas/ParagraphControlWrapperCn" }, { "$ref": "#/components/schemas/SelectControlWrapperCn" } ] }, - "TextInputControlWrapperCn": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlCn" } }, "required":["text-input"] }, - "ParagraphControlWrapperCn": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlCn" } }, "required":["paragraph"] }, - "SelectControlWrapperCn": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlCn" } }, "required":["select"] }, - "TextInputControlCn": { "type": "object", "description": "文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, - "ParagraphControlCn": { "type": "object", "description": "段落文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, - "SelectControlCn": { "type": "object", "description": "下拉控件。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "选项值。" } } }, - "WorkflowWebAppSettingsResponseCn": { "type": "object", "description": "Workflow 应用 WebApp 设置。", "properties": { "title": { "type": "string", "description": "WebApp 名称。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "图标类型。" }, "icon": { "type": "string", "description": "图标内容 (emoji 或图片 URL)。" }, "icon_background": { "type": "string", "description": "hex 格式的背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "图标 URL。" }, "description": { "type": "string", "description": "描述。" }, "copyright": { "type": "string", "description": "版权信息。" }, "privacy_policy": { "type": "string", "description": "隐私政策链接。" }, "custom_disclaimer": { "type": "string", "description": "自定义免责声明。" }, "default_language": { "type": "string", "description": "默认语言。" }, "show_workflow_steps": { "type": "boolean", "description": "是否显示工作流详情。" } } }, - "ErrorResponseCn": { "type": "object", "description": "错误响应。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTP 状态码。" }, "code": { "type": "string", "nullable": true, "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } + "id": { + "type": "string", + "format": "uuid", + "description": "node 执行 ID。" + }, + "node_id": { + "type": "string", + "format": "uuid", + "description": "节点 ID。" + }, + "index": { + "type": "integer", + "description": "执行序号。" + }, + "predecessor_node_id": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "（可选）前置节点 ID。" + }, + "inputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "节点中所有使用到的前置节点变量内容。" + }, + "process_data": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "（可选）节点过程数据 (JSON)。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "（可选）输出内容 (JSON)。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "执行状态。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "（可选）错误原因。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "（可选）耗时(秒)。" + }, + "execution_metadata": { + "$ref": "#/components/schemas/NodeExecutionMetadataCn", + "nullable": true, + "description": "元数据" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "开始时间。" + } + } + }, + "NodeExecutionMetadataCn": { + "type": "object", + "description": "节点执行元数据。", + "properties": { + "total_tokens": { + "type": "integer", + "nullable": true, + "description": "（可选）总使用 tokens。" + }, + "total_price": { + "type": "number", + "format": "float", + "nullable": true, + "description": "（可选）总费用 (使用 float 兼容 decimal)。" + }, + "currency": { + "type": "string", + "nullable": true, + "example": "USD", + "description": "（可选）货币，如 USD / RMB。" + } + } + }, + "StreamEventWfWorkflowFinishedCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfCn" + }, + { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/WorkflowFinishedDataCn" + } + } + } + ] + }, + "WorkflowFinishedDataCn": { + "type": "object", + "description": "Workflow 执行结束事件的详细内容。", + "required": [ + "id", + "workflow_id", + "status", + "created_at", + "finished_at" + ], + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "workflow 执行 ID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "关联 Workflow ID。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "执行状态。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "（可选）输出内容 (JSON)。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "（可选）错误原因。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "（可选）耗时(秒)。" + }, + "total_tokens": { + "type": "integer", + "nullable": true, + "description": "（可选）总使用 tokens。" + }, + "total_steps": { + "type": "integer", + "default": 0, + "description": "总步数，默认 0。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "开始时间。" + }, + "finished_at": { + "type": "integer", + "format": "int64", + "description": "结束时间。" + } + } + }, + "StreamEventWfTtsMessageCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfCn" + }, + { + "type": "object", + "required": [ + "audio", + "message_id", + "created_at" + ], + "properties": { + "audio": { + "type": "string", + "format": "byte", + "description": "语音合成之后的音频块 Base64 编码文本。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息唯一 ID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间戳。" + } + } + } + ] + }, + "StreamEventWfTtsMessageEndCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventCn" + }, + { + "$ref": "#/components/schemas/StreamEventBaseWfCn" + }, + { + "type": "object", + "required": [ + "audio", + "message_id", + "created_at" + ], + "properties": { + "audio": { + "type": "string", + "description": "结束事件音频为空字符串。" + }, + "message_id": { + "type": "string", + "format": "uuid", + "description": "消息唯一 ID。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间戳。" + } + } + } + ] + }, + "StreamEventWfPingCn": { + "allOf": [ + { + "$ref": "#/components/schemas/ChunkWorkflowEventCn" + }, + { + "type": "object", + "description": "每 10s 一次的 ping 事件，保持连接存活。" + } + ] + }, + "WorkflowRunDetailResponseCn": { + "type": "object", + "description": "Workflow 执行详情。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "workflow 执行 ID。" + }, + "workflow_id": { + "type": "string", + "format": "uuid", + "description": "关联的 Workflow ID。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "执行状态。" + }, + "inputs": { + "type": "string", + "description": "任务输入内容的 JSON 字符串。" + }, + "outputs": { + "type": "object", + "additionalProperties": true, + "nullable": true, + "description": "任务输出内容的 JSON 对象。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "错误原因。" + }, + "total_steps": { + "type": "integer", + "description": "任务执行总步数。" + }, + "total_tokens": { + "type": "integer", + "description": "任务执行总 tokens。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "任务开始时间。" + }, + "finished_at": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "任务结束时间。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "nullable": true, + "description": "耗时(秒)。" + } + } + }, + "FileUploadResponseCn": { + "type": "object", + "description": "文件上传成功响应。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID。" + }, + "name": { + "type": "string", + "description": "文件名。" + }, + "size": { + "type": "integer", + "description": "文件大小 (byte)。" + }, + "extension": { + "type": "string", + "description": "文件后缀。" + }, + "mime_type": { + "type": "string", + "description": "文件 mime-type。" + }, + "created_by": { + "type": "string", + "format": "uuid", + "description": "上传人 ID (应为 uuid，示例中为 int，已修正)。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "上传时间。" + } + } + }, + "EndUserDetailCn": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "tenant_id": { + "type": "string", + "format": "uuid" + }, + "app_id": { + "type": "string", + "format": "uuid", + "nullable": true + }, + "type": { + "type": "string", + "example": "service_api" + }, + "external_user_id": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + }, + "is_anonymous": { + "type": "boolean" + }, + "session_id": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "WorkflowLogsResponseCn": { + "type": "object", + "description": "Workflow 日志列表响应。", + "properties": { + "page": { + "type": "integer", + "description": "当前页码。" + }, + "limit": { + "type": "integer", + "description": "每页条数。" + }, + "total": { + "type": "integer", + "description": "总条数。" + }, + "has_more": { + "type": "boolean", + "description": "是否还有更多数据。" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WorkflowLogItemCn" + }, + "description": "当前页码的数据。" + } + } + }, + "WorkflowLogItemCn": { + "type": "object", + "description": "单条 Workflow 日志。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "标识。" + }, + "workflow_run": { + "$ref": "#/components/schemas/WorkflowRunSummaryCn", + "description": "Workflow 执行日志。" + }, + "created_from": { + "type": "string", + "description": "来源。" + }, + "created_by_role": { + "type": "string", + "description": "角色。" + }, + "created_by_account": { + "type": "string", + "format": "uuid", + "nullable": true, + "description": "（可选）帐号。" + }, + "created_by_end_user": { + "$ref": "#/components/schemas/EndUserSummaryCn", + "description": "用户。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "创建时间。" + } + } + }, + "WorkflowRunSummaryCn": { + "type": "object", + "description": "Workflow 执行摘要信息。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "标识。" + }, + "version": { + "type": "string", + "description": "版本。" + }, + "status": { + "type": "string", + "enum": [ + "running", + "succeeded", + "failed", + "stopped" + ], + "description": "执行状态。" + }, + "error": { + "type": "string", + "nullable": true, + "description": "（可选）错误。" + }, + "elapsed_time": { + "type": "number", + "format": "float", + "description": "耗时，单位秒。" + }, + "total_tokens": { + "type": "integer", + "description": "消耗的token数量。" + }, + "total_steps": { + "type": "integer", + "description": "执行步骤长度。" + }, + "created_at": { + "type": "integer", + "format": "int64", + "description": "开始时间。" + }, + "finished_at": { + "type": "integer", + "format": "int64", + "nullable": true, + "description": "结束时间。" + } + } + }, + "EndUserSummaryCn": { + "type": "object", + "description": "终端用户信息摘要。", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "标识。" + }, + "type": { + "type": "string", + "description": "类型。" + }, + "is_anonymous": { + "type": "boolean", + "description": "是否匿名。" + }, + "session_id": { + "type": "string", + "description": "会话标识。" + } + } + }, + "AppInfoResponseCn": { + "type": "object", + "description": "应用基本信息。", + "properties": { + "name": { + "type": "string", + "description": "应用名称。" + }, + "description": { + "type": "string", + "description": "应用描述。" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "应用标签。" + } + } + }, + "WorkflowAppParametersResponseCn": { + "type": "object", + "description": "Workflow 应用参数信息。", + "properties": { + "user_input_form": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserInputFormItemCn" + }, + "description": "用户输入表单配置。" + }, + "file_upload": { + "type": "object", + "properties": { + "image": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "number_limits": { + "type": "integer" + }, + "detail": { + "type": "string" + }, + "transfer_methods": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "remote_url", + "local_file" + ] + } + } + }, + "description": "图片设置。当前仅支持图片类型：png, jpg, jpeg, webp, gif。" + } + }, + "description": "文件上传配置。" + }, + "system_parameters": { + "type": "object", + "properties": { + "file_size_limit": { + "type": "integer", + "description": "文档上传大小限制 (MB)。" + }, + "image_file_size_limit": { + "type": "integer", + "description": "图片文件上传大小限制（MB）。" + }, + "audio_file_size_limit": { + "type": "integer", + "description": "音频文件上传大小限制 (MB)。" + }, + "video_file_size_limit": { + "type": "integer", + "description": "视频文件上传大小限制 (MB)。" + } + }, + "description": "系统参数。" + } + } + }, + "UserInputFormItemCn": { + "type": "object", + "description": "用户输入表单中的控件项。", + "oneOf": [ + { + "$ref": "#/components/schemas/TextInputControlWrapperCn" + }, + { + "$ref": "#/components/schemas/ParagraphControlWrapperCn" + }, + { + "$ref": "#/components/schemas/SelectControlWrapperCn" + } + ] + }, + "TextInputControlWrapperCn": { + "type": "object", + "properties": { + "text-input": { + "$ref": "#/components/schemas/TextInputControlCn" + } + }, + "required": [ + "text-input" + ] + }, + "ParagraphControlWrapperCn": { + "type": "object", + "properties": { + "paragraph": { + "$ref": "#/components/schemas/ParagraphControlCn" + } + }, + "required": [ + "paragraph" + ] + }, + "SelectControlWrapperCn": { + "type": "object", + "properties": { + "select": { + "$ref": "#/components/schemas/SelectControlCn" + } + }, + "required": [ + "select" + ] + }, + "TextInputControlCn": { + "type": "object", + "description": "文本输入控件。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "默认值。" + } + } + }, + "ParagraphControlCn": { + "type": "object", + "description": "段落文本输入控件。", + "required": [ + "label", + "variable", + "required" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "默认值。" + } + } + }, + "SelectControlCn": { + "type": "object", + "description": "下拉控件。", + "required": [ + "label", + "variable", + "required", + "options" + ], + "properties": { + "label": { + "type": "string", + "description": "控件展示标签名。" + }, + "variable": { + "type": "string", + "description": "控件 ID。" + }, + "required": { + "type": "boolean", + "description": "是否必填。" + }, + "default": { + "type": "string", + "nullable": true, + "description": "默认值。" + }, + "options": { + "type": "array", + "items": { + "type": "string" + }, + "description": "选项值。" + } + } + }, + "WorkflowWebAppSettingsResponseCn": { + "type": "object", + "description": "Workflow 应用 WebApp 设置。", + "properties": { + "title": { + "type": "string", + "description": "WebApp 名称。" + }, + "icon_type": { + "type": "string", + "enum": [ + "emoji", + "image" + ], + "description": "图标类型。" + }, + "icon": { + "type": "string", + "description": "图标内容 (emoji 或图片 URL)。" + }, + "icon_background": { + "type": "string", + "description": "hex 格式的背景色。" + }, + "icon_url": { + "type": "string", + "format": "url", + "nullable": true, + "description": "图标 URL。" + }, + "description": { + "type": "string", + "description": "描述。" + }, + "copyright": { + "type": "string", + "description": "版权信息。" + }, + "privacy_policy": { + "type": "string", + "description": "隐私政策链接。" + }, + "custom_disclaimer": { + "type": "string", + "description": "自定义免责声明。" + }, + "default_language": { + "type": "string", + "description": "默认语言。" + }, + "show_workflow_steps": { + "type": "boolean", + "description": "是否显示工作流详情。" + } + } + }, + "ErrorResponseCn": { + "type": "object", + "description": "错误响应。", + "properties": { + "status": { + "type": "integer", + "nullable": true, + "description": "HTTP 状态码。" + }, + "code": { + "type": "string", + "nullable": true, + "description": "错误码。" + }, + "message": { + "type": "string", + "description": "错误消息。" + } + } + } } }, "tags": [ - { "name": "工作流执行", "description": "与执行和管理工作流相关的操作。" }, - { "name": "文件操作 (工作流)", "description": "特定于工作流的文件上传和预览操作。" }, - { "name": "终端用户", "description": "终端用户信息相关的操作。" }, - { "name": "应用配置 (Workflow)", "description": "工作流应用的应用设置和信息。" } + { + "name": "工作流执行", + "description": "与执行和管理工作流相关的操作。" + }, + { + "name": "文件操作 (工作流)", + "description": "特定于工作流的文件上传和预览操作。" + }, + { + "name": "终端用户", + "description": "终端用户信息相关的操作。" + }, + { + "name": "应用配置 (Workflow)", + "description": "工作流应用的应用设置和信息。" + } ] -} \ No newline at end of file +} From 468ba37dc0750717c45c931b2d7240d66d82eb12 Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Mon, 9 Mar 2026 18:39:09 +0800 Subject: [PATCH 05/10] fix: align OpenAPI tags across languages for consistent URL slugs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Mintlify uses OpenAPI tags to generate URL category paths (e.g., tag "Chat" → /chat/). When zh uses "对话消息" and ja uses "チャットメッセージ", the generated URLs differ from en's, breaking language switching. This aligns all zh/ja OpenAPI spec tags to match en, ensuring identical URL structures across languages. Co-Authored-By: Claude Opus 4.6 --- ja/api-reference/openapi_chat.json | 70 ++++++++++---------- ja/api-reference/openapi_chatflow.json | 70 ++++++++++---------- ja/api-reference/openapi_completion.json | 44 ++++++------- ja/api-reference/openapi_knowledge.json | 84 ++++++++++++------------ ja/api-reference/openapi_workflow.json | 34 +++++----- zh/api-reference/openapi_chat.json | 70 ++++++++++---------- zh/api-reference/openapi_chatflow.json | 82 +++++++++++------------ zh/api-reference/openapi_completion.json | 48 +++++++------- zh/api-reference/openapi_knowledge.json | 84 ++++++++++++------------ zh/api-reference/openapi_workflow.json | 34 +++++----- 10 files changed, 314 insertions(+), 306 deletions(-) diff --git a/ja/api-reference/openapi_chat.json b/ja/api-reference/openapi_chat.json index 96db6870b..11ff328a7 100644 --- a/ja/api-reference/openapi_chat.json +++ b/ja/api-reference/openapi_chat.json @@ -29,7 +29,7 @@ "description": "チャットアプリケーションにリクエストを送信します。", "operationId": "sendChatMessage", "tags": [ - "チャットメッセージ" + "Chat" ], "requestBody": { "description": "チャットメッセージ送信リクエストボディ。", @@ -98,7 +98,7 @@ "description": "メッセージ送信時に使用するためのファイルをアップロードします（現在は画像のみサポート）。画像とテキストのマルチモーダル理解を可能にします。png、jpg、jpeg、webp、gif形式をサポートしています。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", "operationId": "uploadChatFile", "tags": [ - "ファイル操作" + "Files" ], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data`リクエストが必要です。", @@ -171,7 +171,7 @@ "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", "operationId": "getEndUserChat", "tags": [ - "エンドユーザー" + "End Users" ], "parameters": [ { @@ -211,7 +211,7 @@ "description": "アップロードされたファイルのプレビューまたはダウンロード。このエンドポイントは、ファイルアップロードAPIを通じて事前にアップロードされたファイルにアクセスすることができます。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセス可能です。", "operationId": "previewChatFile", "tags": [ - "ファイル操作" + "Files" ], "parameters": [ { @@ -354,7 +354,7 @@ "description": "チャットメッセージの生成を停止します。ストリーミングモードでのみサポートされています。", "operationId": "stopChatMessageGeneration", "tags": [ - "チャットメッセージ" + "Chat" ], "parameters": [ { @@ -400,7 +400,7 @@ "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。", "operationId": "postChatMessageFeedback", "tags": [ - "メッセージフィードバック" + "Feedback" ], "parameters": [ { @@ -437,7 +437,7 @@ "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", "operationId": "getChatAppFeedbacks", "tags": [ - "メッセージフィードバック" + "Feedback" ], "parameters": [ { @@ -467,7 +467,7 @@ "description": "現在のメッセージに対する次の質問の提案を取得します。", "operationId": "getSuggestedQuestions", "tags": [ - "チャットメッセージ" + "Chat" ], "parameters": [ { @@ -504,7 +504,7 @@ "description": "スクロールロード形式で過去のチャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", "operationId": "getConversationHistory", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -547,7 +547,7 @@ "description": "現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。", "operationId": "getConversationsList", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -583,7 +583,7 @@ "description": "指定された会話を削除します。", "operationId": "deleteConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -622,7 +622,7 @@ "description": "セッションの名前を変更します。セッション名は、複数のセッションをサポートするクライアントでの表示に使用されます。", "operationId": "renameConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -659,7 +659,7 @@ "description": "特定の会話から変数を取得します。このエンドポイントは、会話中に取得された構造化データを抽出するのに役立ちます。", "operationId": "getConversationVariables", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -701,7 +701,7 @@ "description": "オーディオファイルをテキストに変換します。サポートされている形式：mp3, mp4, mpeg, mpga, m4a, wav, webm。ファイルサイズ制限：15MB。", "operationId": "audioToText", "tags": [ - "音声とテキスト変換" + "TTS" ], "requestBody": { "required": true, @@ -733,7 +733,7 @@ "description": "テキストコンテンツを音声に変換します。", "operationId": "textToAudioChat", "tags": [ - "音声とテキスト変換" + "TTS" ], "requestBody": { "required": true, @@ -779,7 +779,7 @@ "summary": "アプリケーションの基本情報を取得", "operationId": "getChatAppInfo", "tags": [ - "アプリケーション設定" + "Application" ], "responses": { "200": { @@ -801,7 +801,7 @@ "description": "ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。", "operationId": "getChatAppParameters", "tags": [ - "アプリケーション設定" + "Application" ], "responses": { "200": { @@ -823,7 +823,7 @@ "description": "このアプリケーションのツールのアイコンを取得するために使用されます。", "operationId": "getChatAppMeta", "tags": [ - "アプリケーション設定" + "Application" ], "responses": { "200": { @@ -845,7 +845,7 @@ "description": "アプリのWebApp設定を取得するために使用します。", "operationId": "getChatWebAppSettings", "tags": [ - "アプリケーション設定" + "Application" ], "responses": { "200": { @@ -2693,32 +2693,36 @@ }, "tags": [ { - "name": "チャットメッセージ", - "description": "チャットメッセージと対話に関連する操作。" + "name": "Chat", + "description": "Operations related to chat messages and interactions." }, { - "name": "ファイル操作", - "description": "ファイルアップロードとプレビューに関連する操作。" + "name": "Files", + "description": "File upload and preview operations." }, { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作。" + "name": "End Users", + "description": "Operations related to end user information." }, { - "name": "メッセージフィードバック", - "description": "ユーザーからのメッセージフィードバック操作。" + "name": "Feedback", + "description": "User feedback operations." }, { - "name": "会話管理", - "description": "会話セッションの管理に関連する操作。" + "name": "Conversations", + "description": "Operations related to managing conversations." }, { - "name": "音声とテキスト変換", - "description": "テキストから音声、音声からテキストへの変換操作。" + "name": "TTS", + "description": "Text-to-Speech and Speech-to-Text operations." }, { - "name": "アプリケーション設定", - "description": "アプリケーション設定と情報の取得に関連する操作。" + "name": "Application", + "description": "Operations to retrieve application settings and information." + }, + { + "name": "Annotations", + "description": "Operations related to managing annotations for direct replies." } ] } diff --git a/ja/api-reference/openapi_chatflow.json b/ja/api-reference/openapi_chatflow.json index f7328f7a3..04efb00ae 100644 --- a/ja/api-reference/openapi_chatflow.json +++ b/ja/api-reference/openapi_chatflow.json @@ -29,7 +29,7 @@ "description": "チャットアプリケーションにリクエストを送信します。", "operationId": "sendAdvancedChatMessage", "tags": [ - "チャットメッセージ" + "Chatflow" ], "requestBody": { "description": "チャットメッセージ送信のリクエストボディ。", @@ -98,7 +98,7 @@ "description": "メッセージ送信時に使用するファイルをアップロードし、画像とテキストのマルチモーダル理解を可能にします。アプリケーションでサポートされている形式をサポートします。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", "operationId": "uploadAdvancedChatFile", "tags": [ - "ファイル操作" + "Files" ], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data` リクエストが必要です。", @@ -171,7 +171,7 @@ "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", "operationId": "getEndUserChatflow", "tags": [ - "エンドユーザー" + "End Users" ], "parameters": [ { @@ -211,7 +211,7 @@ "description": "アップロードされたファイルのプレビューまたはダウンロード。このエンドポイントは、ファイルアップロードAPIを通じて事前にアップロードされたファイルにアクセスすることができます。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセス可能です。", "operationId": "previewChatFlowFile", "tags": [ - "ファイル操作" + "Files" ], "parameters": [ { @@ -354,7 +354,7 @@ "description": "チャットメッセージの生成を停止します。ストリーミングモードでのみサポートされています。", "operationId": "stopAdvancedChatMessageGeneration", "tags": [ - "チャットメッセージ" + "Chatflow" ], "parameters": [ { @@ -400,7 +400,7 @@ "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのを支援します。", "operationId": "postAdvancedChatMessageFeedback", "tags": [ - "メッセージフィードバック" + "Feedback" ], "parameters": [ { @@ -437,7 +437,7 @@ "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", "operationId": "getAdvancedChatAppFeedbacks", "tags": [ - "メッセージフィードバック" + "Feedback" ], "parameters": [ { @@ -467,7 +467,7 @@ "description": "現在のメッセージに対する次の質問の提案を取得します。", "operationId": "getAdvancedSuggestedQuestions", "tags": [ - "チャットメッセージ" + "Chatflow" ], "parameters": [ { @@ -504,7 +504,7 @@ "description": "スクロールロード形式で履歴チャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", "operationId": "getAdvancedConversationHistory", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -547,7 +547,7 @@ "description": "現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。", "operationId": "getAdvancedConversationsList", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -583,7 +583,7 @@ "description": "指定された会話を削除します。", "operationId": "deleteAdvancedConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -622,7 +622,7 @@ "description": "セッションの名前を変更します。", "operationId": "renameAdvancedConversation", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -659,7 +659,7 @@ "description": "特定の会話から変数を取得します。このエンドポイントは、会話中に取得された構造化データを抽出するのに役立ちます。", "operationId": "getAdvancedConversationVariables", "tags": [ - "会話管理" + "Conversations" ], "parameters": [ { @@ -698,7 +698,7 @@ "description": "オーディオファイルをテキストに変換します。サポートされている形式：mp3, mp4, mpeg, mpga, m4a, wav, webm。ファイルサイズ制限：15MB。", "operationId": "advancedAudioToText", "tags": [ - "音声・テキスト変換" + "TTS" ], "requestBody": { "required": true, @@ -730,7 +730,7 @@ "description": "テキストコンテンツを音声に変換します。", "operationId": "advancedTextToAudio", "tags": [ - "音声・テキスト変換" + "TTS" ], "requestBody": { "required": true, @@ -776,7 +776,7 @@ "summary": "アプリケーションの基本情報を取得", "operationId": "getAdvancedChatAppInfo", "tags": [ - "アプリケーション設定" + "Application" ], "responses": { "200": { @@ -798,7 +798,7 @@ "description": "ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。", "operationId": "getAdvancedChatAppParameters", "tags": [ - "アプリケーション設定" + "Application" ], "responses": { "200": { @@ -820,7 +820,7 @@ "description": "このアプリケーションのツールのアイコンを取得するために使用されます。", "operationId": "getAdvancedChatAppMeta", "tags": [ - "アプリケーション設定" + "Application" ], "responses": { "200": { @@ -842,7 +842,7 @@ "description": "アプリのWebApp設定を取得するために使用します。", "operationId": "getAdvancedChatWebAppSettings", "tags": [ - "アプリケーション設定" + "Application" ], "responses": { "200": { @@ -2928,32 +2928,36 @@ }, "tags": [ { - "name": "チャットメッセージ", - "description": "チャットメッセージとインタラクションに関連する操作。" + "name": "Chatflow", + "description": "Advanced chat operations with workflow events." }, { - "name": "ファイル操作", - "description": "ファイルアップロードとプレビューに関連する操作。" + "name": "Files", + "description": "File upload and preview operations for advanced chat." }, { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作。" + "name": "End Users", + "description": "Operations related to end user information." }, { - "name": "メッセージフィードバック", - "description": "ユーザーメッセージへのフィードバック操作。" + "name": "Feedback", + "description": "User feedback operations for advanced chat." }, { - "name": "会話管理", - "description": "会話セッションの管理に関連する操作。" + "name": "Conversations", + "description": "Conversation management for advanced chat." }, { - "name": "音声・テキスト変換", - "description": "テキストから音声へ、音声からテキストへの変換操作。" + "name": "TTS", + "description": "Speech and Text conversion for advanced chat." }, { - "name": "アプリケーション設定", - "description": "アプリケーション設定と情報の取得に関連する操作。" + "name": "Application", + "description": "Application settings and info for advanced chat." + }, + { + "name": "Annotations", + "description": "Annotation management for advanced chat." } ] } diff --git a/ja/api-reference/openapi_completion.json b/ja/api-reference/openapi_completion.json index df6413386..1068fb470 100644 --- a/ja/api-reference/openapi_completion.json +++ b/ja/api-reference/openapi_completion.json @@ -29,7 +29,7 @@ "description": "テキスト生成アプリケーションにリクエストを送信します。", "operationId": "createCompletionMessage", "tags": [ - "完了メッセージ" + "Completion" ], "requestBody": { "description": "完了メッセージを作成するためのリクエストボディ。", @@ -89,7 +89,7 @@ "description": "メッセージ送信時に使用するファイル（現在は画像のみ対応）をアップロードし、画像とテキストのマルチモーダルな理解を可能にします。png、jpg、jpeg、webp、gif形式に対応しています。アップロードされたファイルは、現在のエンドユーザーのみが使用できます。", "operationId": "uploadFile", "tags": [ - "ファイル操作" + "Files" ], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data` 形式が必要です。", @@ -162,7 +162,7 @@ "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", "operationId": "getEndUserCompletion", "tags": [ - "エンドユーザー" + "End Users" ], "parameters": [ { @@ -202,7 +202,7 @@ "description": "完了メッセージの生成を停止します。ストリーミングモードでのみサポートされています。", "operationId": "stopGenerate", "tags": [ - "完了メッセージ" + "Completion" ], "parameters": [ { @@ -248,7 +248,7 @@ "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。", "operationId": "postMessageFeedback", "tags": [ - "メッセージフィードバック" + "Feedback" ], "parameters": [ { @@ -285,7 +285,7 @@ "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", "operationId": "getAppFeedbacks", "tags": [ - "メッセージフィードバック" + "Feedback" ], "parameters": [ { @@ -327,7 +327,7 @@ "description": "テキストを音声に変換します。", "operationId": "textToAudio", "tags": [ - "音声変換" + "TTS" ], "requestBody": { "required": true, @@ -373,7 +373,7 @@ "summary": "アプリケーションの基本情報を取得", "operationId": "getAppInfo", "tags": [ - "アプリケーション情報" + "Application" ], "responses": { "200": { @@ -394,7 +394,7 @@ "summary": "アプリケーションのパラメータ情報を取得", "operationId": "getAppParameters", "tags": [ - "アプリケーション情報" + "Application" ], "responses": { "200": { @@ -415,7 +415,7 @@ "summary": "アプリのWebApp設定を取得", "operationId": "getWebAppSettings", "tags": [ - "アプリケーション情報" + "Application" ], "responses": { "200": { @@ -1531,28 +1531,28 @@ }, "tags": [ { - "name": "完了メッセージ", - "description": "テキスト生成と完了に関連する操作。" + "name": "Completion", + "description": "Operations related to text generation and completion." }, { - "name": "ファイル操作", - "description": "ファイル管理に関連する操作。" + "name": "Files", + "description": "Operations related to file management." }, { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作。" + "name": "End Users", + "description": "Operations related to end user information." }, { - "name": "メッセージフィードバック", - "description": "ユーザーフィードバックに関連する操作。" + "name": "Feedback", + "description": "Operations related to user feedback." }, { - "name": "音声変換", - "description": "テキストから音声への変換に関連する操作。" + "name": "TTS", + "description": "Operations related to Text-to-Speech." }, { - "name": "アプリケーション情報", - "description": "アプリケーションの設定と情報を取得する操作。" + "name": "Application", + "description": "Operations to retrieve application settings and information." } ] } diff --git a/ja/api-reference/openapi_knowledge.json b/ja/api-reference/openapi_knowledge.json index d55eecd87..7f333fe6b 100644 --- a/ja/api-reference/openapi_knowledge.json +++ b/ja/api-reference/openapi_knowledge.json @@ -24,31 +24,31 @@ ], "tags": [ { - "name": "データセット", - "description": "ナレッジベース（データセット）の管理に関連する操作。" + "name": "Datasets", + "description": "Operations related to managing knowledge bases (datasets)." }, { - "name": "ドキュメント", - "description": "データセット内のドキュメントの作成、更新、管理のための操作。" + "name": "Documents", + "description": "Operations for creating, updating, and managing documents within a dataset." }, { - "name": "チャンク", - "description": "ドキュメントのチャンク（セグメント）の管理のための操作。" + "name": "Chunks", + "description": "Operations for managing document chunks (segments)." }, { - "name": "メタデータ・タグ", - "description": "データセットタグとメタデータの管理のための操作。" + "name": "Metadata & Tags", + "description": "Operations for managing dataset tags and metadata." }, { - "name": "モデル", - "description": "利用可能なモデルの取得のための操作。" + "name": "Models", + "description": "Operations for retrieving available models." } ], "paths": { "/datasets": { "post": { "tags": [ - "データセット" + "Datasets" ], "summary": "空のナレッジベースを作成", "description": "指定された設定で新しい空のナレッジベース（データセット）を作成します。", @@ -81,7 +81,7 @@ }, "get": { "tags": [ - "データセット" + "Datasets" ], "summary": "ナレッジベースリストを取得", "description": "ページネーションとフィルタリングのオプション付きでナレッジベースのリストを取得します。", @@ -155,7 +155,7 @@ "/datasets/{dataset_id}": { "get": { "tags": [ - "データセット" + "Datasets" ], "summary": "ナレッジベース詳細を取得", "description": "IDで特定のナレッジベースの詳細情報を取得します。", @@ -187,7 +187,7 @@ }, "patch": { "tags": [ - "データセット" + "Datasets" ], "summary": "ナレッジベースを更新", "description": "特定のナレッジベースの設定を更新します。", @@ -232,7 +232,7 @@ }, "delete": { "tags": [ - "データセット" + "Datasets" ], "summary": "ナレッジベースを削除", "description": "ナレッジベースとそれに関連するすべてのドキュメントとデータを削除します。", @@ -259,7 +259,7 @@ "/datasets/{dataset_id}/document/create-by-text": { "post": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "テキストからドキュメントを作成", "description": "テキストコンテンツから既存のナレッジベース内に新しいドキュメントを直接作成します。", @@ -303,7 +303,7 @@ "/datasets/{dataset_id}/document/create-by-file": { "post": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ファイルからドキュメントを作成", "description": "ファイルをアップロードして既存のナレッジベース内に新しいドキュメントを作成します。", @@ -368,7 +368,7 @@ "/datasets/{dataset_id}/documents/{document_id}/update-by-text": { "post": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "テキストでドキュメントを更新", "description": "テキストを使用して既存のドキュメントのコンテンツまたは設定を更新します。", @@ -422,7 +422,7 @@ "/datasets/{dataset_id}/documents/{document_id}/update-by-file": { "post": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ファイルでドキュメントを更新", "description": "新しいファイルをアップロードして既存のドキュメントを更新し、そのコンテンツを置き換えます。", @@ -488,7 +488,7 @@ "/datasets/{dataset_id}/documents/{batch}/indexing-status": { "get": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ドキュメント埋め込みステータス（進捗）を取得", "description": "ドキュメントのバッチのインデックス化ステータスを取得し、埋め込みと処理の進捗を表示します。", @@ -539,7 +539,7 @@ "/datasets/{dataset_id}/documents/{document_id}": { "get": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ドキュメント詳細を取得", "description": "処理ルールとステータスを含む単一ドキュメントの詳細情報を取得します。", @@ -595,7 +595,7 @@ }, "delete": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ドキュメントを削除", "description": "ナレッジベースから特定のドキュメントを削除します。", @@ -632,7 +632,7 @@ "/datasets/{dataset_id}/documents": { "get": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ナレッジベースのドキュメントリストを取得", "description": "指定されたナレッジベース内のすべてのドキュメントのページネーションリストを取得します。", @@ -694,7 +694,7 @@ "/datasets/{dataset_id}/documents/status/{action}": { "patch": { "tags": [ - "ドキュメント" + "Documents" ], "summary": "ドキュメントステータスを更新", "description": "1つまたは複数のドキュメントのステータスを更新するバッチアクションを実行します（例：有効化、無効化、アーカイブ）。", @@ -759,7 +759,7 @@ "/datasets/{dataset_id}/documents/{document_id}/segments": { "post": { "tags": [ - "チャンク" + "Chunks" ], "summary": "ドキュメントにチャンクを追加", "description": "特定のドキュメントに1つまたは複数の新しいチャンク（セグメント）を追加します。手動でキュレートされたコンテンツを追加するのに便利です。", @@ -811,7 +811,7 @@ }, "get": { "tags": [ - "チャンク" + "Chunks" ], "summary": "ドキュメントからチャンクを取得", "description": "特定のドキュメントからチャンク（セグメント）のページネーションリストを取得します。", @@ -892,7 +892,7 @@ "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}": { "get": { "tags": [ - "チャンク" + "Chunks" ], "summary": "ドキュメント内のチャンク詳細を取得", "description": "ドキュメント内の特定のチャンク（セグメント）の詳細を取得します。", @@ -944,7 +944,7 @@ }, "post": { "tags": [ - "チャンク" + "Chunks" ], "summary": "ドキュメント内のチャンクを更新", "description": "特定のチャンク（セグメント）のコンテンツ、キーワード、またはステータスを更新します。", @@ -1006,7 +1006,7 @@ }, "delete": { "tags": [ - "チャンク" + "Chunks" ], "summary": "ドキュメント内のチャンクを削除", "description": "ドキュメントから特定のチャンク（セグメント）を削除します。", @@ -1053,7 +1053,7 @@ "/datasets/{dataset_id}/retrieve": { "post": { "tags": [ - "データセット" + "Datasets" ], "summary": "ナレッジベースからチャンクを取得 / テスト検索", "description": "ナレッジベースに対して検索クエリを実行し、最も関連性の高いチャンク（セグメント）を取得します。このエンドポイントは、本番環境での検索とテスト検索の両方に使用できます。", @@ -1097,7 +1097,7 @@ "/workspaces/current/models/model-types/text-embedding": { "get": { "tags": [ - "モデル" + "Models" ], "summary": "利用可能な埋め込みモデルを取得", "description": "ナレッジベースの作成とクエリに使用できるすべての利用可能なテキスト埋め込みモデルのリストを取得します。", @@ -1127,7 +1127,7 @@ "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks": { "post": { "tags": [ - "チャンク" + "Chunks" ], "summary": "子チャンクを作成", "description": "階層モードを使用してドキュメント内の親セグメントの下に新しい子チャンクを作成します。", @@ -1189,7 +1189,7 @@ }, "get": { "tags": [ - "チャンク" + "Chunks" ], "summary": "子チャンクを取得", "description": "特定の親セグメントの子チャンクのリストを取得します。", @@ -1270,7 +1270,7 @@ "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}": { "patch": { "tags": [ - "チャンク" + "Chunks" ], "summary": "子チャンクを更新", "description": "特定の子チャンクのコンテンツを更新します。", @@ -1342,7 +1342,7 @@ }, "delete": { "tags": [ - "チャンク" + "Chunks" ], "summary": "子チャンクを削除", "description": "特定の子チャンクを削除します。", @@ -1399,7 +1399,7 @@ "/datasets/tags": { "post": { "tags": [ - "メタデータ・タグ" + "Metadata & Tags" ], "summary": "新しいナレッジベースタイプタグを作成", "description": "ナレッジベースを分類するために使用できる新しいタグを作成します。", @@ -1439,7 +1439,7 @@ }, "get": { "tags": [ - "メタデータ・タグ" + "Metadata & Tags" ], "summary": "ナレッジベースタイプタグを取得", "description": "利用可能なすべてのナレッジベースタグのリストを取得します。", @@ -1462,7 +1462,7 @@ }, "patch": { "tags": [ - "メタデータ・タグ" + "Metadata & Tags" ], "summary": "ナレッジベースタイプタグ名を変更", "description": "既存のタグの名前を更新します。", @@ -1508,7 +1508,7 @@ }, "delete": { "tags": [ - "メタデータ・タグ" + "Metadata & Tags" ], "summary": "ナレッジベースタイプタグを削除", "description": "タグを削除します。タグはどのナレッジベースにもバインドされていない必要があります。", @@ -1543,7 +1543,7 @@ "/datasets/tags/binding": { "post": { "tags": [ - "メタデータ・タグ" + "Metadata & Tags" ], "summary": "データセットをナレッジベースタイプタグにバインド", "description": "1つまたは複数のタグを特定のナレッジベースにバインドします。", @@ -1587,7 +1587,7 @@ "/datasets/tags/unbinding": { "post": { "tags": [ - "メタデータ・タグ" + "Metadata & Tags" ], "summary": "データセットとナレッジベースタイプタグのバインドを解除", "description": "ナレッジベースから特定のタグのバインドを解除します。", @@ -1628,7 +1628,7 @@ "/datasets/{dataset_id}/tags": { "get": { "tags": [ - "メタデータ・タグ" + "Metadata & Tags" ], "summary": "データセットにバインドされたタグをクエリ", "description": "特定のデータセットに現在バインドされているすべてのタグを取得します。", diff --git a/ja/api-reference/openapi_workflow.json b/ja/api-reference/openapi_workflow.json index 9ea9ad7e5..a783f0fa8 100644 --- a/ja/api-reference/openapi_workflow.json +++ b/ja/api-reference/openapi_workflow.json @@ -29,7 +29,7 @@ "description": "ワークフローを実行します。公開されたワークフローがないと実行できません。", "operationId": "executeWorkflow", "tags": [ - "ワークフロー実行" + "Workflow Execution" ], "requestBody": { "required": true, @@ -106,7 +106,7 @@ "description": "ワークフロー実行IDに基づいて、ワークフロータスクの現在の実行結果を取得します。", "operationId": "getWorkflowRunDetail", "tags": [ - "ワークフロー実行" + "Workflow Execution" ], "parameters": [ { @@ -143,7 +143,7 @@ "description": "ワークフロータスクの生成を停止します。ストリーミングモードでのみサポートされています。", "operationId": "stopWorkflowTaskGeneration", "tags": [ - "ワークフロー実行" + "Workflow Execution" ], "parameters": [ { @@ -189,7 +189,7 @@ "description": "ワークフローで使用するファイルをアップロードします。ワークフローでサポートされている任意の形式をサポートします。アップロードされたファイルは、現在のエンドユーザーのみが使用できます。", "operationId": "uploadWorkflowFile", "tags": [ - "ファイル操作 (ワークフロー)" + "Files" ], "requestBody": { "required": true, @@ -261,7 +261,7 @@ "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", "operationId": "getEndUserWorkflow", "tags": [ - "エンドユーザー" + "End Users" ], "parameters": [ { @@ -301,7 +301,7 @@ "description": "ワークフローログを返します。最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", "operationId": "getWorkflowLogs", "tags": [ - "ワークフロー実行" + "Workflow Execution" ], "parameters": [ { @@ -364,7 +364,7 @@ "summary": "アプリケーションの基本情報を取得 (ワークフロー)", "operationId": "getWorkflowAppInfo", "tags": [ - "アプリケーション設定 (ワークフロー)" + "Application" ], "responses": { "200": { @@ -385,7 +385,7 @@ "summary": "アプリケーションのパラメータ情報を取得 (ワークフロー)", "operationId": "getWorkflowAppParameters", "tags": [ - "アプリケーション設定 (ワークフロー)" + "Application" ], "responses": { "200": { @@ -406,7 +406,7 @@ "summary": "アプリのWebApp設定を取得 (ワークフロー)", "operationId": "getWorkflowWebAppSettings", "tags": [ - "アプリケーション設定 (ワークフロー)" + "Application" ], "responses": { "200": { @@ -1793,20 +1793,20 @@ }, "tags": [ { - "name": "ワークフロー実行", - "description": "ワークフローの実行と管理に関連する操作。" + "name": "Workflow Execution", + "description": "Operations related to executing and managing workflows." }, { - "name": "ファイル操作 (ワークフロー)", - "description": "ワークフロー固有のファイルアップロードとプレビュー操作。" + "name": "Files", + "description": "File upload and preview operations specific to workflows." }, { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作。" + "name": "End Users", + "description": "Operations related to end user information." }, { - "name": "アプリケーション設定 (ワークフロー)", - "description": "ワークフローアプリのアプリケーション設定と情報。" + "name": "Application", + "description": "Application settings and info for workflow apps." } ] } diff --git a/zh/api-reference/openapi_chat.json b/zh/api-reference/openapi_chat.json index 254588b0a..f469d5839 100644 --- a/zh/api-reference/openapi_chat.json +++ b/zh/api-reference/openapi_chat.json @@ -29,7 +29,7 @@ "description": "创建会话消息。", "operationId": "sendChatMessage", "tags": [ - "对话消息" + "Chat" ], "requestBody": { "description": "发送对话消息的请求体。", @@ -98,7 +98,7 @@ "description": "上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。支持 png, jpg, jpeg, webp, gif 格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadChatFile", "tags": [ - "文件操作" + "Files" ], "requestBody": { "description": "文件上传请求。需使用 `multipart/form-data` 进行请求。", @@ -171,7 +171,7 @@ "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", "operationId": "getEndUserChat", "tags": [ - "终端用户" + "End Users" ], "parameters": [ { @@ -211,7 +211,7 @@ "description": "预览或下载已上传的文件。此端点允许你访问之前通过文件上传API上传的文件。文件只能在所属的应用程序消息内访问。", "operationId": "previewChatFile", "tags": [ - "文件操作" + "Files" ], "parameters": [ { @@ -354,7 +354,7 @@ "description": "停止生成对话消息。仅支持流式模式。", "operationId": "stopChatMessageGeneration", "tags": [ - "对话消息" + "Chat" ], "parameters": [ { @@ -400,7 +400,7 @@ "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", "operationId": "postChatMessageFeedback", "tags": [ - "消息反馈" + "Feedback" ], "parameters": [ { @@ -437,7 +437,7 @@ "description": "获取应用的终端用户反馈、点赞。", "operationId": "getChatAppFeedbacks", "tags": [ - "消息反馈" + "Feedback" ], "parameters": [ { @@ -467,7 +467,7 @@ "description": "获取当前消息的下一轮建议问题列表。", "operationId": "getSuggestedQuestions", "tags": [ - "对话消息" + "Chat" ], "parameters": [ { @@ -504,7 +504,7 @@ "description": "滚动加载形式返回历史聊天记录，第一页返回最新 `limit` 条，即倒序返回。", "operationId": "getConversationHistory", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -547,7 +547,7 @@ "description": "获取当前用户的会话列表，默认返回最近的 20 条。", "operationId": "getConversationsList", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -583,7 +583,7 @@ "description": "删除一个指定的会话。", "operationId": "deleteConversation", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -622,7 +622,7 @@ "description": "对会话进行重命名。", "operationId": "renameConversation", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -659,7 +659,7 @@ "description": "从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。", "operationId": "getConversationVariables", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -701,7 +701,7 @@ "description": "将语音文件转换为文字。支持格式：mp3, mp4, mpeg, mpga, m4a, wav, webm。文件大小限制：15MB。", "operationId": "audioToText", "tags": [ - "语音与文字转换" + "TTS" ], "requestBody": { "required": true, @@ -733,7 +733,7 @@ "description": "将文字内容转换为语音。", "operationId": "textToAudioChat", "tags": [ - "语音与文字转换" + "TTS" ], "requestBody": { "required": true, @@ -779,7 +779,7 @@ "summary": "获取应用基本信息", "operationId": "getChatAppInfo", "tags": [ - "应用配置" + "Application" ], "responses": { "200": { @@ -801,7 +801,7 @@ "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", "operationId": "getChatAppParameters", "tags": [ - "应用配置" + "Application" ], "responses": { "200": { @@ -823,7 +823,7 @@ "description": "用于获取工具 icon。", "operationId": "getChatAppMeta", "tags": [ - "应用配置" + "Application" ], "responses": { "200": { @@ -845,7 +845,7 @@ "description": "用于获取应用的 WebApp 设置。", "operationId": "getChatWebAppSettings", "tags": [ - "应用配置" + "Application" ], "responses": { "200": { @@ -2668,32 +2668,36 @@ }, "tags": [ { - "name": "对话消息", - "description": "与对话消息和交互相关的操作。" + "name": "Chat", + "description": "Operations related to chat messages and interactions." }, { - "name": "文件操作", - "description": "文件上传和预览相关的操作。" + "name": "Files", + "description": "File upload and preview operations." }, { - "name": "终端用户", - "description": "终端用户信息相关的操作。" + "name": "End Users", + "description": "Operations related to end user information." }, { - "name": "消息反馈", - "description": "用户对消息的反馈操作。" + "name": "Feedback", + "description": "User feedback operations." }, { - "name": "会话管理", - "description": "管理对话会话相关的操作。" + "name": "Conversations", + "description": "Operations related to managing conversations." }, { - "name": "语音与文字转换", - "description": "文本转语音和语音转文本操作。" + "name": "TTS", + "description": "Text-to-Speech and Speech-to-Text operations." }, { - "name": "应用配置", - "description": "获取应用设置和信息相关的操作。" + "name": "Application", + "description": "Operations to retrieve application settings and information." + }, + { + "name": "Annotations", + "description": "Operations related to managing annotations for direct replies." } ] } diff --git a/zh/api-reference/openapi_chatflow.json b/zh/api-reference/openapi_chatflow.json index 17f374c62..1c3a72d99 100644 --- a/zh/api-reference/openapi_chatflow.json +++ b/zh/api-reference/openapi_chatflow.json @@ -29,7 +29,7 @@ "description": "创建会话消息。", "operationId": "sendAdvancedChatMessage", "tags": [ - "对话消息" + "Chatflow" ], "requestBody": { "description": "发送对话消息的请求体。", @@ -98,7 +98,7 @@ "description": "上传文件并在发送消息时使用，可实现图文多模态理解。支持你的应用程序所支持的所有格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadAdvancedChatFile", "tags": [ - "文件操作" + "Files" ], "requestBody": { "description": "文件上传请求。需使用 `multipart/form-data` 进行请求。", @@ -171,7 +171,7 @@ "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", "operationId": "getEndUserChatflow", "tags": [ - "终端用户" + "End Users" ], "parameters": [ { @@ -211,7 +211,7 @@ "description": "预览或下载已上传的文件。此端点允许你访问之前通过文件上传API上传的文件。文件只能在所属的应用程序消息内访问。", "operationId": "previewChatFlowFile", "tags": [ - "文件操作" + "Files" ], "parameters": [ { @@ -354,7 +354,7 @@ "description": "停止生成对话消息。仅支持流式模式。", "operationId": "stopAdvancedChatMessageGeneration", "tags": [ - "对话消息" + "Chatflow" ], "parameters": [ { @@ -400,7 +400,7 @@ "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", "operationId": "postAdvancedChatMessageFeedback", "tags": [ - "消息反馈" + "Feedback" ], "parameters": [ { @@ -437,7 +437,7 @@ "description": "获取应用的终端用户反馈、点赞。", "operationId": "getAdvancedChatAppFeedbacks", "tags": [ - "消息反馈" + "Feedback" ], "parameters": [ { @@ -467,7 +467,7 @@ "description": "获取当前消息的下一轮建议问题列表。", "operationId": "getAdvancedSuggestedQuestions", "tags": [ - "对话消息" + "Chatflow" ], "parameters": [ { @@ -504,7 +504,7 @@ "description": "滚动加载形式返回历史聊天记录，第一页返回最新 `limit` 条，即倒序返回。", "operationId": "getAdvancedConversationHistory", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -547,7 +547,7 @@ "description": "获取当前用户的会话列表，默认返回最近的 20 条。", "operationId": "getAdvancedConversationsList", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -583,7 +583,7 @@ "description": "删除一个指定的会话。", "operationId": "deleteAdvancedConversation", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -622,7 +622,7 @@ "description": "对会话进行重命名。", "operationId": "renameAdvancedConversation", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -659,7 +659,7 @@ "description": "从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。", "operationId": "getAdvancedConversationVariables", "tags": [ - "会话管理" + "Conversations" ], "parameters": [ { @@ -698,7 +698,7 @@ "description": "将语音文件转换为文字。支持格式：mp3, mp4, mpeg, mpga, m4a, wav, webm。文件大小限制：15MB。", "operationId": "advancedAudioToText", "tags": [ - "语音与文字转换" + "TTS" ], "requestBody": { "required": true, @@ -730,7 +730,7 @@ "description": "将文字内容转换为语音。", "operationId": "advancedTextToAudio", "tags": [ - "语音与文字转换" + "TTS" ], "requestBody": { "required": true, @@ -776,7 +776,7 @@ "summary": "获取应用基本信息", "operationId": "getAdvancedChatAppInfo", "tags": [ - "应用配置" + "Application" ], "responses": { "200": { @@ -798,7 +798,7 @@ "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", "operationId": "getAdvancedChatAppParameters", "tags": [ - "应用配置" + "Application" ], "responses": { "200": { @@ -820,7 +820,7 @@ "description": "用于获取工具 icon。", "operationId": "getAdvancedChatAppMeta", "tags": [ - "应用配置" + "Application" ], "responses": { "200": { @@ -842,7 +842,7 @@ "description": "用于获取应用的 WebApp 设置。", "operationId": "getAdvancedChatWebAppSettings", "tags": [ - "应用配置" + "Application" ], "responses": { "200": { @@ -863,7 +863,7 @@ "summary": "获取标注列表", "operationId": "getAdvancedAnnotationList", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -890,7 +890,7 @@ "summary": "创建标注", "operationId": "createAdvancedAnnotation", "tags": [ - "标注管理" + "Annotations" ], "requestBody": { "required": true, @@ -931,7 +931,7 @@ "summary": "更新标注", "operationId": "updateAdvancedAnnotation", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -965,7 +965,7 @@ "summary": "删除标注", "operationId": "deleteAdvancedAnnotation", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -985,7 +985,7 @@ "description": "启用或禁用标注回复功能，并配置相关的嵌入模型和阈值。此接口异步执行。", "operationId": "initialAdvancedAnnotationReplySettings", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -1031,7 +1031,7 @@ "summary": "查询标注回复初始设置任务状态", "operationId": "getAdvancedInitialAnnotationReplySettingsStatus", "tags": [ - "标注管理" + "Annotations" ], "parameters": [ { @@ -3280,36 +3280,36 @@ }, "tags": [ { - "name": "对话消息", - "description": "与对话消息和交互相关的操作。" + "name": "Chatflow", + "description": "Advanced chat operations with workflow events." }, { - "name": "文件操作", - "description": "文件上传和预览相关的操作。" + "name": "Files", + "description": "File upload and preview operations for advanced chat." }, { - "name": "终端用户", - "description": "终端用户信息相关的操作。" + "name": "End Users", + "description": "Operations related to end user information." }, { - "name": "消息反馈", - "description": "用户对消息的反馈操作。" + "name": "Feedback", + "description": "User feedback operations for advanced chat." }, { - "name": "会话管理", - "description": "管理对话会话相关的操作。" + "name": "Conversations", + "description": "Conversation management for advanced chat." }, { - "name": "语音与文字转换", - "description": "文本转语音和语音转文本操作。" + "name": "TTS", + "description": "Speech and Text conversion for advanced chat." }, { - "name": "应用配置", - "description": "获取应用设置和信息相关的操作。" + "name": "Application", + "description": "Application settings and info for advanced chat." }, { - "name": "标注管理", - "description": "管理用于直接回复的标注数据。" + "name": "Annotations", + "description": "Annotation management for advanced chat." } ] } diff --git a/zh/api-reference/openapi_completion.json b/zh/api-reference/openapi_completion.json index 2a8b4dd41..1b9ee5e3b 100644 --- a/zh/api-reference/openapi_completion.json +++ b/zh/api-reference/openapi_completion.json @@ -29,7 +29,7 @@ "description": "发送请求给文本生成型应用。", "operationId": "createCompletionMessage", "tags": [ - "文本生成" + "Completion" ], "requestBody": { "description": "创建完成消息的请求体。", @@ -108,7 +108,7 @@ "description": "上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。支持 png, jpg, jpeg, webp, gif 格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadFile", "tags": [ - "文件管理" + "Files" ], "requestBody": { "description": "文件上传请求，需使用 `multipart/form-data`。", @@ -178,7 +178,7 @@ "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", "operationId": "getEndUserCompletion", "tags": [ - "终端用户" + "End Users" ], "parameters": [ { @@ -232,7 +232,7 @@ "description": "停止生成任务，仅支持流式模式。", "operationId": "stopGenerate", "tags": [ - "文本生成" + "Completion" ], "parameters": [ { @@ -278,7 +278,7 @@ "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", "operationId": "postMessageFeedback", "tags": [ - "反馈" + "Feedback" ], "parameters": [ { @@ -315,7 +315,7 @@ "description": "获取应用的反馈信息。", "operationId": "getAppFeedbacks", "tags": [ - "反馈" + "Feedback" ], "parameters": [ { @@ -345,7 +345,7 @@ "description": "将文本内容转换为语音。", "operationId": "textToAudio", "tags": [ - "语音服务" + "TTS" ], "requestBody": { "required": true, @@ -395,7 +395,7 @@ "description": "用于获取此应用的基本信息。", "operationId": "getAppInfo", "tags": [ - "应用设置" + "Application" ], "responses": { "200": { @@ -417,7 +417,7 @@ "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", "operationId": "getAppParameters", "tags": [ - "应用设置" + "Application" ], "responses": { "200": { @@ -439,7 +439,7 @@ "description": "用于获取应用的 WebApp 设置。", "operationId": "getWebAppSettings", "tags": [ - "应用设置" + "Application" ], "responses": { "200": { @@ -2006,32 +2006,28 @@ }, "tags": [ { - "name": "文本生成", - "description": "与文本生成和完成相关的操作。" + "name": "Completion", + "description": "Operations related to text generation and completion." }, { - "name": "文件管理", - "description": "与文件上传和管理相关的操作。" + "name": "Files", + "description": "Operations related to file management." }, { - "name": "终端用户", - "description": "终端用户信息相关的操作。" + "name": "End Users", + "description": "Operations related to end user information." }, { - "name": "反馈", - "description": "与用户反馈相关的操作。" + "name": "Feedback", + "description": "Operations related to user feedback." }, { - "name": "语音服务", - "description": "与文本转语音相关的操作。" + "name": "TTS", + "description": "Operations related to Text-to-Speech." }, { - "name": "应用设置", - "description": "获取应用基本信息和参数配置的操作。" - }, - { - "name": "标注管理", - "description": "与标注（用于直接回复）相关的操作。" + "name": "Application", + "description": "Operations to retrieve application settings and information." } ] } diff --git a/zh/api-reference/openapi_knowledge.json b/zh/api-reference/openapi_knowledge.json index 0c1e92e6b..20a72a402 100644 --- a/zh/api-reference/openapi_knowledge.json +++ b/zh/api-reference/openapi_knowledge.json @@ -24,31 +24,31 @@ ], "tags": [ { - "name": "数据集", - "description": "与管理知识库（数据集）相关的操作。" + "name": "Datasets", + "description": "Operations related to managing knowledge bases (datasets)." }, { - "name": "文档", - "description": "用于在数据集中创建、更新和管理文档的操作。" + "name": "Documents", + "description": "Operations for creating, updating, and managing documents within a dataset." }, { - "name": "文档块", - "description": "用于管理文档块（段落）的操作。" + "name": "Chunks", + "description": "Operations for managing document chunks (segments)." }, { - "name": "元数据和标签", - "description": "用于管理数据集标签和元数据的操作。" + "name": "Metadata & Tags", + "description": "Operations for managing dataset tags and metadata." }, { - "name": "模型", - "description": "用于检索可用模型的操作。" + "name": "Models", + "description": "Operations for retrieving available models." } ], "paths": { "/datasets": { "post": { "tags": [ - "数据集" + "Datasets" ], "summary": "创建空知识库", "description": "使用指定配置创建一个新的空知识库（数据集）。", @@ -81,7 +81,7 @@ }, "get": { "tags": [ - "数据集" + "Datasets" ], "summary": "获取知识库列表", "description": "检索知识库列表，支持分页和过滤选项。", @@ -155,7 +155,7 @@ "/datasets/{dataset_id}": { "get": { "tags": [ - "数据集" + "Datasets" ], "summary": "获取知识库详情", "description": "通过 ID 获取特定知识库的详细信息。", @@ -187,7 +187,7 @@ }, "patch": { "tags": [ - "数据集" + "Datasets" ], "summary": "更新知识库", "description": "更新特定知识库的设置。", @@ -232,7 +232,7 @@ }, "delete": { "tags": [ - "数据集" + "Datasets" ], "summary": "删除知识库", "description": "删除知识库及其所有相关文档和数据。", @@ -259,7 +259,7 @@ "/datasets/{dataset_id}/document/create-by-text": { "post": { "tags": [ - "文档" + "Documents" ], "summary": "从文本创建文档", "description": "直接从文本内容在现有知识库中创建新文档。", @@ -303,7 +303,7 @@ "/datasets/{dataset_id}/document/create-by-file": { "post": { "tags": [ - "文档" + "Documents" ], "summary": "从文件创建文档", "description": "通过上传文件在现有知识库中创建新文档。", @@ -368,7 +368,7 @@ "/datasets/{dataset_id}/documents/{document_id}/update-by-text": { "post": { "tags": [ - "文档" + "Documents" ], "summary": "用文本更新文档", "description": "使用文本更新现有文档的内容或设置。", @@ -422,7 +422,7 @@ "/datasets/{dataset_id}/documents/{document_id}/update-by-file": { "post": { "tags": [ - "文档" + "Documents" ], "summary": "用文件更新文档", "description": "通过上传新文件更新现有文档，替换其内容。", @@ -488,7 +488,7 @@ "/datasets/{dataset_id}/documents/{batch}/indexing-status": { "get": { "tags": [ - "文档" + "Documents" ], "summary": "获取文档嵌入状态（进度）", "description": "检索文档批次的索引状态，显示嵌入和处理的进度。", @@ -539,7 +539,7 @@ "/datasets/{dataset_id}/documents/{document_id}": { "get": { "tags": [ - "文档" + "Documents" ], "summary": "获取文档详情", "description": "检索单个文档的详细信息，包括其处理规则和状态。", @@ -595,7 +595,7 @@ }, "delete": { "tags": [ - "文档" + "Documents" ], "summary": "删除文档", "description": "从知识库中删除特定文档。", @@ -632,7 +632,7 @@ "/datasets/{dataset_id}/documents": { "get": { "tags": [ - "文档" + "Documents" ], "summary": "获取知识库的文档列表", "description": "检索指定知识库中所有文档的分页列表。", @@ -694,7 +694,7 @@ "/datasets/{dataset_id}/documents/status/{action}": { "patch": { "tags": [ - "文档" + "Documents" ], "summary": "更新文档状态", "description": "执行批量操作以更新一个或多个文档的状态（例如，启用、禁用、归档）。", @@ -759,7 +759,7 @@ "/datasets/{dataset_id}/documents/{document_id}/segments": { "post": { "tags": [ - "文档块" + "Chunks" ], "summary": "向文档添加块", "description": "向特定文档添加一个或多个新块（段落）。这对于手动添加精心策划的内容很有用。", @@ -811,7 +811,7 @@ }, "get": { "tags": [ - "文档块" + "Chunks" ], "summary": "从文档获取块", "description": "从特定文档检索块（段落）的分页列表。", @@ -892,7 +892,7 @@ "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}": { "get": { "tags": [ - "文档块" + "Chunks" ], "summary": "获取文档中的块详情", "description": "检索文档中特定块（段落）的详情。", @@ -944,7 +944,7 @@ }, "post": { "tags": [ - "文档块" + "Chunks" ], "summary": "更新文档中的块", "description": "更新特定块（段落）的内容、关键词或状态。", @@ -1006,7 +1006,7 @@ }, "delete": { "tags": [ - "文档块" + "Chunks" ], "summary": "删除文档中的块", "description": "从文档中删除特定块（段落）。", @@ -1053,7 +1053,7 @@ "/datasets/{dataset_id}/retrieve": { "post": { "tags": [ - "数据集" + "Datasets" ], "summary": "从知识库检索块 / 测试检索", "description": "对知识库执行搜索查询以检索最相关的块（段落）。此端点可用于生产检索和测试检索。", @@ -1097,7 +1097,7 @@ "/workspaces/current/models/model-types/text-embedding": { "get": { "tags": [ - "模型" + "Models" ], "summary": "获取可用的嵌入模型", "description": "获取可用于创建和查询知识库的所有可用文本嵌入模型列表。", @@ -1127,7 +1127,7 @@ "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks": { "post": { "tags": [ - "文档块" + "Chunks" ], "summary": "创建子块", "description": "使用分层模式在文档中的父段落下创建新的子块。", @@ -1189,7 +1189,7 @@ }, "get": { "tags": [ - "文档块" + "Chunks" ], "summary": "获取子块", "description": "检索特定父段落的子块列表。", @@ -1270,7 +1270,7 @@ "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}": { "patch": { "tags": [ - "文档块" + "Chunks" ], "summary": "更新子块", "description": "更新特定子块的内容。", @@ -1342,7 +1342,7 @@ }, "delete": { "tags": [ - "文档块" + "Chunks" ], "summary": "删除子块", "description": "删除特定的子块。", @@ -1399,7 +1399,7 @@ "/datasets/tags": { "post": { "tags": [ - "元数据和标签" + "Metadata & Tags" ], "summary": "创建新的知识库类型标签", "description": "创建可用于分类知识库的新标签。", @@ -1439,7 +1439,7 @@ }, "get": { "tags": [ - "元数据和标签" + "Metadata & Tags" ], "summary": "获取知识库类型标签", "description": "检索所有可用知识库标签的列表。", @@ -1462,7 +1462,7 @@ }, "patch": { "tags": [ - "元数据和标签" + "Metadata & Tags" ], "summary": "修改知识库类型标签名称", "description": "更新现有标签的名称。", @@ -1508,7 +1508,7 @@ }, "delete": { "tags": [ - "元数据和标签" + "Metadata & Tags" ], "summary": "删除知识库类型标签", "description": "删除标签。标签不得绑定到任何知识库。", @@ -1543,7 +1543,7 @@ "/datasets/tags/binding": { "post": { "tags": [ - "元数据和标签" + "Metadata & Tags" ], "summary": "将数据集绑定到知识库类型标签", "description": "将一个或多个标签绑定到特定知识库。", @@ -1587,7 +1587,7 @@ "/datasets/tags/unbinding": { "post": { "tags": [ - "元数据和标签" + "Metadata & Tags" ], "summary": "解绑数据集和知识库类型标签", "description": "从知识库解绑特定标签。", @@ -1628,7 +1628,7 @@ "/datasets/{dataset_id}/tags": { "get": { "tags": [ - "元数据和标签" + "Metadata & Tags" ], "summary": "查询绑定到数据集的标签", "description": "检索当前绑定到特定数据集的所有标签。", diff --git a/zh/api-reference/openapi_workflow.json b/zh/api-reference/openapi_workflow.json index 4795d2e69..0e7cc6090 100644 --- a/zh/api-reference/openapi_workflow.json +++ b/zh/api-reference/openapi_workflow.json @@ -29,7 +29,7 @@ "description": "执行 workflow，没有已发布的 workflow，不可执行。", "operationId": "executeWorkflow", "tags": [ - "工作流执行" + "Workflow Execution" ], "requestBody": { "required": true, @@ -106,7 +106,7 @@ "description": "根据 workflow 执行 ID 获取 workflow 任务当前执行结果。", "operationId": "getWorkflowRunDetail", "tags": [ - "工作流执行" + "Workflow Execution" ], "parameters": [ { @@ -143,7 +143,7 @@ "description": "停止 workflow 任务的生成。仅支持流式模式。", "operationId": "stopWorkflowTaskGeneration", "tags": [ - "工作流执行" + "Workflow Execution" ], "parameters": [ { @@ -189,7 +189,7 @@ "description": "上传文件并在执行 workflow 时使用。支持你的工作流程所支持的任何格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadWorkflowFile", "tags": [ - "文件操作 (Workflow)" + "Files" ], "requestBody": { "required": true, @@ -261,7 +261,7 @@ "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", "operationId": "getEndUserWorkflow", "tags": [ - "终端用户" + "End Users" ], "parameters": [ { @@ -301,7 +301,7 @@ "description": "倒序返回 workflow 日志。", "operationId": "getWorkflowLogs", "tags": [ - "工作流执行" + "Workflow Execution" ], "parameters": [ { @@ -364,7 +364,7 @@ "summary": "获取应用基本信息 (Workflow)", "operationId": "getWorkflowAppInfo", "tags": [ - "应用配置 (Workflow)" + "Application" ], "responses": { "200": { @@ -385,7 +385,7 @@ "summary": "获取应用参数 (Workflow)", "operationId": "getWorkflowAppParameters", "tags": [ - "应用配置 (Workflow)" + "Application" ], "responses": { "200": { @@ -406,7 +406,7 @@ "summary": "获取应用 WebApp 设置 (Workflow)", "operationId": "getWorkflowWebAppSettings", "tags": [ - "应用配置 (Workflow)" + "Application" ], "responses": { "200": { @@ -1784,20 +1784,20 @@ }, "tags": [ { - "name": "工作流执行", - "description": "与执行和管理工作流相关的操作。" + "name": "Workflow Execution", + "description": "Operations related to executing and managing workflows." }, { - "name": "文件操作 (工作流)", - "description": "特定于工作流的文件上传和预览操作。" + "name": "Files", + "description": "File upload and preview operations specific to workflows." }, { - "name": "终端用户", - "description": "终端用户信息相关的操作。" + "name": "End Users", + "description": "Operations related to end user information." }, { - "name": "应用配置 (Workflow)", - "description": "工作流应用的应用设置和信息。" + "name": "Application", + "description": "Application settings and info for workflow apps." } ] } From 94095cfb1485d7e7081ecae01cc0577c9ece0b36 Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Mon, 9 Mar 2026 18:43:50 +0800 Subject: [PATCH 06/10] fix: add x-displayName to preserve translated tag names in sidebar Tags use English names for URL slug generation (consistent across languages) but x-displayName holds the translated names for display in the sidebar, so Chinese/Japanese users still see localized labels. Co-Authored-By: Claude Opus 4.6 --- ja/api-reference/openapi_chat.json | 21 ++++++++++++++------- ja/api-reference/openapi_chatflow.json | 21 ++++++++++++++------- ja/api-reference/openapi_completion.json | 18 ++++++++++++------ ja/api-reference/openapi_knowledge.json | 15 ++++++++++----- ja/api-reference/openapi_workflow.json | 12 ++++++++---- zh/api-reference/openapi_chat.json | 21 ++++++++++++++------- zh/api-reference/openapi_chatflow.json | 24 ++++++++++++++++-------- zh/api-reference/openapi_completion.json | 18 ++++++++++++------ zh/api-reference/openapi_knowledge.json | 15 ++++++++++----- zh/api-reference/openapi_workflow.json | 12 ++++++++---- 10 files changed, 118 insertions(+), 59 deletions(-) diff --git a/ja/api-reference/openapi_chat.json b/ja/api-reference/openapi_chat.json index 11ff328a7..9db4c564c 100644 --- a/ja/api-reference/openapi_chat.json +++ b/ja/api-reference/openapi_chat.json @@ -2694,31 +2694,38 @@ "tags": [ { "name": "Chat", - "description": "Operations related to chat messages and interactions." + "description": "Operations related to chat messages and interactions.", + "x-displayName": "チャットメッセージ" }, { "name": "Files", - "description": "File upload and preview operations." + "description": "File upload and preview operations.", + "x-displayName": "ファイル操作" }, { "name": "End Users", - "description": "Operations related to end user information." + "description": "Operations related to end user information.", + "x-displayName": "エンドユーザー" }, { "name": "Feedback", - "description": "User feedback operations." + "description": "User feedback operations.", + "x-displayName": "メッセージフィードバック" }, { "name": "Conversations", - "description": "Operations related to managing conversations." + "description": "Operations related to managing conversations.", + "x-displayName": "会話管理" }, { "name": "TTS", - "description": "Text-to-Speech and Speech-to-Text operations." + "description": "Text-to-Speech and Speech-to-Text operations.", + "x-displayName": "音声とテキスト変換" }, { "name": "Application", - "description": "Operations to retrieve application settings and information." + "description": "Operations to retrieve application settings and information.", + "x-displayName": "アプリケーション設定" }, { "name": "Annotations", diff --git a/ja/api-reference/openapi_chatflow.json b/ja/api-reference/openapi_chatflow.json index 04efb00ae..64774fd76 100644 --- a/ja/api-reference/openapi_chatflow.json +++ b/ja/api-reference/openapi_chatflow.json @@ -2929,31 +2929,38 @@ "tags": [ { "name": "Chatflow", - "description": "Advanced chat operations with workflow events." + "description": "Advanced chat operations with workflow events.", + "x-displayName": "チャットメッセージ" }, { "name": "Files", - "description": "File upload and preview operations for advanced chat." + "description": "File upload and preview operations for advanced chat.", + "x-displayName": "ファイル操作" }, { "name": "End Users", - "description": "Operations related to end user information." + "description": "Operations related to end user information.", + "x-displayName": "エンドユーザー" }, { "name": "Feedback", - "description": "User feedback operations for advanced chat." + "description": "User feedback operations for advanced chat.", + "x-displayName": "メッセージフィードバック" }, { "name": "Conversations", - "description": "Conversation management for advanced chat." + "description": "Conversation management for advanced chat.", + "x-displayName": "会話管理" }, { "name": "TTS", - "description": "Speech and Text conversion for advanced chat." + "description": "Speech and Text conversion for advanced chat.", + "x-displayName": "音声・テキスト変換" }, { "name": "Application", - "description": "Application settings and info for advanced chat." + "description": "Application settings and info for advanced chat.", + "x-displayName": "アプリケーション設定" }, { "name": "Annotations", diff --git a/ja/api-reference/openapi_completion.json b/ja/api-reference/openapi_completion.json index 1068fb470..50f25c5ac 100644 --- a/ja/api-reference/openapi_completion.json +++ b/ja/api-reference/openapi_completion.json @@ -1532,27 +1532,33 @@ "tags": [ { "name": "Completion", - "description": "Operations related to text generation and completion." + "description": "Operations related to text generation and completion.", + "x-displayName": "完了メッセージ" }, { "name": "Files", - "description": "Operations related to file management." + "description": "Operations related to file management.", + "x-displayName": "ファイル操作" }, { "name": "End Users", - "description": "Operations related to end user information." + "description": "Operations related to end user information.", + "x-displayName": "エンドユーザー" }, { "name": "Feedback", - "description": "Operations related to user feedback." + "description": "Operations related to user feedback.", + "x-displayName": "メッセージフィードバック" }, { "name": "TTS", - "description": "Operations related to Text-to-Speech." + "description": "Operations related to Text-to-Speech.", + "x-displayName": "音声変換" }, { "name": "Application", - "description": "Operations to retrieve application settings and information." + "description": "Operations to retrieve application settings and information.", + "x-displayName": "アプリケーション情報" } ] } diff --git a/ja/api-reference/openapi_knowledge.json b/ja/api-reference/openapi_knowledge.json index 7f333fe6b..b6d81c14e 100644 --- a/ja/api-reference/openapi_knowledge.json +++ b/ja/api-reference/openapi_knowledge.json @@ -25,23 +25,28 @@ "tags": [ { "name": "Datasets", - "description": "Operations related to managing knowledge bases (datasets)." + "description": "Operations related to managing knowledge bases (datasets).", + "x-displayName": "データセット" }, { "name": "Documents", - "description": "Operations for creating, updating, and managing documents within a dataset." + "description": "Operations for creating, updating, and managing documents within a dataset.", + "x-displayName": "ドキュメント" }, { "name": "Chunks", - "description": "Operations for managing document chunks (segments)." + "description": "Operations for managing document chunks (segments).", + "x-displayName": "チャンク" }, { "name": "Metadata & Tags", - "description": "Operations for managing dataset tags and metadata." + "description": "Operations for managing dataset tags and metadata.", + "x-displayName": "メタデータ・タグ" }, { "name": "Models", - "description": "Operations for retrieving available models." + "description": "Operations for retrieving available models.", + "x-displayName": "モデル" } ], "paths": { diff --git a/ja/api-reference/openapi_workflow.json b/ja/api-reference/openapi_workflow.json index a783f0fa8..619decbbf 100644 --- a/ja/api-reference/openapi_workflow.json +++ b/ja/api-reference/openapi_workflow.json @@ -1794,19 +1794,23 @@ "tags": [ { "name": "Workflow Execution", - "description": "Operations related to executing and managing workflows." + "description": "Operations related to executing and managing workflows.", + "x-displayName": "ワークフロー実行" }, { "name": "Files", - "description": "File upload and preview operations specific to workflows." + "description": "File upload and preview operations specific to workflows.", + "x-displayName": "ファイル操作 (ワークフロー)" }, { "name": "End Users", - "description": "Operations related to end user information." + "description": "Operations related to end user information.", + "x-displayName": "エンドユーザー" }, { "name": "Application", - "description": "Application settings and info for workflow apps." + "description": "Application settings and info for workflow apps.", + "x-displayName": "アプリケーション設定 (ワークフロー)" } ] } diff --git a/zh/api-reference/openapi_chat.json b/zh/api-reference/openapi_chat.json index f469d5839..93bfe5f6c 100644 --- a/zh/api-reference/openapi_chat.json +++ b/zh/api-reference/openapi_chat.json @@ -2669,31 +2669,38 @@ "tags": [ { "name": "Chat", - "description": "Operations related to chat messages and interactions." + "description": "Operations related to chat messages and interactions.", + "x-displayName": "对话消息" }, { "name": "Files", - "description": "File upload and preview operations." + "description": "File upload and preview operations.", + "x-displayName": "文件操作" }, { "name": "End Users", - "description": "Operations related to end user information." + "description": "Operations related to end user information.", + "x-displayName": "终端用户" }, { "name": "Feedback", - "description": "User feedback operations." + "description": "User feedback operations.", + "x-displayName": "消息反馈" }, { "name": "Conversations", - "description": "Operations related to managing conversations." + "description": "Operations related to managing conversations.", + "x-displayName": "会话管理" }, { "name": "TTS", - "description": "Text-to-Speech and Speech-to-Text operations." + "description": "Text-to-Speech and Speech-to-Text operations.", + "x-displayName": "语音与文字转换" }, { "name": "Application", - "description": "Operations to retrieve application settings and information." + "description": "Operations to retrieve application settings and information.", + "x-displayName": "应用配置" }, { "name": "Annotations", diff --git a/zh/api-reference/openapi_chatflow.json b/zh/api-reference/openapi_chatflow.json index 1c3a72d99..f411f38f7 100644 --- a/zh/api-reference/openapi_chatflow.json +++ b/zh/api-reference/openapi_chatflow.json @@ -3281,35 +3281,43 @@ "tags": [ { "name": "Chatflow", - "description": "Advanced chat operations with workflow events." + "description": "Advanced chat operations with workflow events.", + "x-displayName": "对话消息" }, { "name": "Files", - "description": "File upload and preview operations for advanced chat." + "description": "File upload and preview operations for advanced chat.", + "x-displayName": "文件操作" }, { "name": "End Users", - "description": "Operations related to end user information." + "description": "Operations related to end user information.", + "x-displayName": "终端用户" }, { "name": "Feedback", - "description": "User feedback operations for advanced chat." + "description": "User feedback operations for advanced chat.", + "x-displayName": "消息反馈" }, { "name": "Conversations", - "description": "Conversation management for advanced chat." + "description": "Conversation management for advanced chat.", + "x-displayName": "会话管理" }, { "name": "TTS", - "description": "Speech and Text conversion for advanced chat." + "description": "Speech and Text conversion for advanced chat.", + "x-displayName": "语音与文字转换" }, { "name": "Application", - "description": "Application settings and info for advanced chat." + "description": "Application settings and info for advanced chat.", + "x-displayName": "应用配置" }, { "name": "Annotations", - "description": "Annotation management for advanced chat." + "description": "Annotation management for advanced chat.", + "x-displayName": "标注管理" } ] } diff --git a/zh/api-reference/openapi_completion.json b/zh/api-reference/openapi_completion.json index 1b9ee5e3b..2ef6c3ad1 100644 --- a/zh/api-reference/openapi_completion.json +++ b/zh/api-reference/openapi_completion.json @@ -2007,27 +2007,33 @@ "tags": [ { "name": "Completion", - "description": "Operations related to text generation and completion." + "description": "Operations related to text generation and completion.", + "x-displayName": "文本生成" }, { "name": "Files", - "description": "Operations related to file management." + "description": "Operations related to file management.", + "x-displayName": "文件管理" }, { "name": "End Users", - "description": "Operations related to end user information." + "description": "Operations related to end user information.", + "x-displayName": "终端用户" }, { "name": "Feedback", - "description": "Operations related to user feedback." + "description": "Operations related to user feedback.", + "x-displayName": "反馈" }, { "name": "TTS", - "description": "Operations related to Text-to-Speech." + "description": "Operations related to Text-to-Speech.", + "x-displayName": "语音服务" }, { "name": "Application", - "description": "Operations to retrieve application settings and information." + "description": "Operations to retrieve application settings and information.", + "x-displayName": "应用设置" } ] } diff --git a/zh/api-reference/openapi_knowledge.json b/zh/api-reference/openapi_knowledge.json index 20a72a402..ca5bd30b7 100644 --- a/zh/api-reference/openapi_knowledge.json +++ b/zh/api-reference/openapi_knowledge.json @@ -25,23 +25,28 @@ "tags": [ { "name": "Datasets", - "description": "Operations related to managing knowledge bases (datasets)." + "description": "Operations related to managing knowledge bases (datasets).", + "x-displayName": "数据集" }, { "name": "Documents", - "description": "Operations for creating, updating, and managing documents within a dataset." + "description": "Operations for creating, updating, and managing documents within a dataset.", + "x-displayName": "文档" }, { "name": "Chunks", - "description": "Operations for managing document chunks (segments)." + "description": "Operations for managing document chunks (segments).", + "x-displayName": "文档块" }, { "name": "Metadata & Tags", - "description": "Operations for managing dataset tags and metadata." + "description": "Operations for managing dataset tags and metadata.", + "x-displayName": "元数据和标签" }, { "name": "Models", - "description": "Operations for retrieving available models." + "description": "Operations for retrieving available models.", + "x-displayName": "模型" } ], "paths": { diff --git a/zh/api-reference/openapi_workflow.json b/zh/api-reference/openapi_workflow.json index 0e7cc6090..b464821b9 100644 --- a/zh/api-reference/openapi_workflow.json +++ b/zh/api-reference/openapi_workflow.json @@ -1785,19 +1785,23 @@ "tags": [ { "name": "Workflow Execution", - "description": "Operations related to executing and managing workflows." + "description": "Operations related to executing and managing workflows.", + "x-displayName": "工作流执行" }, { "name": "Files", - "description": "File upload and preview operations specific to workflows." + "description": "File upload and preview operations specific to workflows.", + "x-displayName": "文件操作 (工作流)" }, { "name": "End Users", - "description": "Operations related to end user information." + "description": "Operations related to end user information.", + "x-displayName": "终端用户" }, { "name": "Application", - "description": "Application settings and info for workflow apps." + "description": "Application settings and info for workflow apps.", + "x-displayName": "应用配置 (Workflow)" } ] } From fd5241883d1ad8fe98037f1242b9faf84751e861 Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Mon, 9 Mar 2026 18:49:03 +0800 Subject: [PATCH 07/10] fix: use x-mint href to align API reference URLs across languages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Mintlify generates API page URLs from the tag name + summary, both of which are translated in zh/ja specs. This produces different URL slugs (e.g., en: /chat/send-chat-message vs zh: /对话消息/发送对话消息), making language switching impossible. Instead of changing the visible content (tags, summaries), this adds x-mint: { href: ... } to each endpoint in zh/ja specs, explicitly setting the URL path to match en. All translated content (tags, summaries, descriptions) is preserved as-is for readers. Co-Authored-By: Claude Opus 4.6 --- ja/api-reference/openapi_chat.json | 172 +++++++++++------- ja/api-reference/openapi_chatflow.json | 172 +++++++++++------- ja/api-reference/openapi_completion.json | 100 +++++++---- ja/api-reference/openapi_knowledge.json | 185 ++++++++++++++----- ja/api-reference/openapi_workflow.json | 83 +++++---- zh/api-reference/openapi_chat.json | 172 +++++++++++------- zh/api-reference/openapi_chatflow.json | 215 +++++++++++++++-------- zh/api-reference/openapi_completion.json | 88 ++++++---- zh/api-reference/openapi_knowledge.json | 185 ++++++++++++++----- zh/api-reference/openapi_workflow.json | 83 +++++---- 10 files changed, 970 insertions(+), 485 deletions(-) diff --git a/ja/api-reference/openapi_chat.json b/ja/api-reference/openapi_chat.json index 9db4c564c..78158ca22 100644 --- a/ja/api-reference/openapi_chat.json +++ b/ja/api-reference/openapi_chat.json @@ -27,9 +27,9 @@ "post": { "summary": "チャットメッセージを送信", "description": "チャットアプリケーションにリクエストを送信します。", - "operationId": "sendChatMessage", + "operationId": "sendBasicChatMessageJa", "tags": [ - "Chat" + "チャットメッセージ" ], "requestBody": { "description": "チャットメッセージ送信リクエストボディ。", @@ -89,6 +89,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJa" } + }, + "x-mint": { + "href": "/api-reference/chat/send-chat-message" } } }, @@ -96,9 +99,9 @@ "post": { "summary": "ファイルアップロード", "description": "メッセージ送信時に使用するためのファイルをアップロードします（現在は画像のみサポート）。画像とテキストのマルチモーダル理解を可能にします。png、jpg、jpeg、webp、gif形式をサポートしています。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", - "operationId": "uploadChatFile", + "operationId": "uploadBasicChatFileJa", "tags": [ - "Files" + "ファイル操作" ], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data`リクエストが必要です。", @@ -162,6 +165,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJa" } + }, + "x-mint": { + "href": "/api-reference/files/file-upload" } } }, @@ -169,9 +175,9 @@ "get": { "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", - "operationId": "getEndUserChat", + "operationId": "getEndUserChatJa", "tags": [ - "End Users" + "エンドユーザー" ], "parameters": [ { @@ -202,6 +208,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJa" } + }, + "x-mint": { + "href": "/api-reference/end-users/get-end-user" } } }, @@ -209,9 +218,9 @@ "get": { "summary": "ファイルプレビュー", "description": "アップロードされたファイルのプレビューまたはダウンロード。このエンドポイントは、ファイルアップロードAPIを通じて事前にアップロードされたファイルにアクセスすることができます。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセス可能です。", - "operationId": "previewChatFile", + "operationId": "previewBasicChatFileJa", "tags": [ - "Files" + "ファイル操作" ], "parameters": [ { @@ -345,6 +354,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/files/file-preview" } } }, @@ -352,9 +364,9 @@ "post": { "summary": "生成停止", "description": "チャットメッセージの生成を停止します。ストリーミングモードでのみサポートされています。", - "operationId": "stopChatMessageGeneration", + "operationId": "stopBasicChatMessageGenerationJa", "tags": [ - "Chat" + "チャットメッセージ" ], "parameters": [ { @@ -391,6 +403,9 @@ "200": { "$ref": "#/components/responses/SuccessResultJa" } + }, + "x-mint": { + "href": "/api-reference/chat/stop-chat-message-generation" } } }, @@ -398,9 +413,9 @@ "post": { "summary": "メッセージフィードバック", "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。", - "operationId": "postChatMessageFeedback", + "operationId": "postBasicChatMessageFeedbackJa", "tags": [ - "Feedback" + "メッセージフィードバック" ], "parameters": [ { @@ -428,6 +443,9 @@ "200": { "$ref": "#/components/responses/SuccessResultJa" } + }, + "x-mint": { + "href": "/api-reference/feedback/message-feedback" } } }, @@ -435,9 +453,9 @@ "get": { "summary": "アプリのメッセージの「いいね」とフィードバックを取得", "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", - "operationId": "getChatAppFeedbacks", + "operationId": "getBasicChatAppFeedbacksJa", "tags": [ - "Feedback" + "メッセージフィードバック" ], "parameters": [ { @@ -458,6 +476,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -465,9 +486,9 @@ "get": { "summary": "次の推奨質問", "description": "現在のメッセージに対する次の質問の提案を取得します。", - "operationId": "getSuggestedQuestions", + "operationId": "getBasicChatSuggestedQuestionsJa", "tags": [ - "Chat" + "チャットメッセージ" ], "parameters": [ { @@ -495,6 +516,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chat/next-suggested-questions" } } }, @@ -502,9 +526,9 @@ "get": { "summary": "会話履歴メッセージを取得", "description": "スクロールロード形式で過去のチャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", - "operationId": "getConversationHistory", + "operationId": "getBasicChatConversationHistoryJa", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -538,6 +562,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversation-history-messages" } } }, @@ -545,9 +572,9 @@ "get": { "summary": "会話を取得", "description": "現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。", - "operationId": "getConversationsList", + "operationId": "getBasicChatConversationsListJa", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -574,6 +601,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversations" } } }, @@ -581,9 +611,9 @@ "delete": { "summary": "会話を削除", "description": "指定された会話を削除します。", - "operationId": "deleteConversation", + "operationId": "deleteBasicChatConversationJa", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -613,6 +643,9 @@ "204": { "description": "会話の削除に成功しました。コンテンツはありません。" } + }, + "x-mint": { + "href": "/api-reference/conversations/delete-conversation" } } }, @@ -620,9 +653,9 @@ "post": { "summary": "会話の名前を変更", "description": "セッションの名前を変更します。セッション名は、複数のセッションをサポートするクライアントでの表示に使用されます。", - "operationId": "renameConversation", + "operationId": "renameBasicChatConversationJa", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -650,6 +683,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/conversation-rename" } } }, @@ -657,9 +693,9 @@ "get": { "summary": "会話変数の取得", "description": "特定の会話から変数を取得します。このエンドポイントは、会話中に取得された構造化データを抽出するのに役立ちます。", - "operationId": "getConversationVariables", + "operationId": "getBasicChatConversationVariablesJa", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -692,6 +728,9 @@ "404": { "$ref": "#/components/responses/ConversationNotFoundJa" } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversation-variables" } } }, @@ -699,9 +738,9 @@ "post": { "summary": "音声からテキストへ", "description": "オーディオファイルをテキストに変換します。サポートされている形式：mp3, mp4, mpeg, mpga, m4a, wav, webm。ファイルサイズ制限：15MB。", - "operationId": "audioToText", + "operationId": "basicChatAudioToTextJa", "tags": [ - "TTS" + "音声とテキスト変換" ], "requestBody": { "required": true, @@ -724,6 +763,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/speech-to-text" } } }, @@ -731,9 +773,9 @@ "post": { "summary": "テキストから音声へ", "description": "テキストコンテンツを音声に変換します。", - "operationId": "textToAudioChat", + "operationId": "basicChatTextToAudioJa", "tags": [ - "TTS" + "音声とテキスト変換" ], "requestBody": { "required": true, @@ -771,15 +813,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/text-to-audio" } } }, "/info": { "get": { "summary": "アプリケーションの基本情報を取得", - "operationId": "getChatAppInfo", + "operationId": "getBasicChatAppInfoJa", "tags": [ - "Application" + "アプリケーション設定" ], "responses": { "200": { @@ -792,6 +837,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-basic-information" } } }, @@ -799,9 +847,9 @@ "get": { "summary": "アプリケーションのパラメータ情報を取得", "description": "ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。", - "operationId": "getChatAppParameters", + "operationId": "getBasicChatAppParametersJa", "tags": [ - "Application" + "アプリケーション設定" ], "responses": { "200": { @@ -814,6 +862,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-parameters-information" } } }, @@ -821,9 +872,9 @@ "get": { "summary": "アプリケーションのメタ情報を取得", "description": "このアプリケーションのツールのアイコンを取得するために使用されます。", - "operationId": "getChatAppMeta", + "operationId": "getBasicChatAppMetaJa", "tags": [ - "Application" + "アプリケーション設定" ], "responses": { "200": { @@ -836,6 +887,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-meta-information" } } }, @@ -843,9 +897,9 @@ "get": { "summary": "アプリのWebApp設定を取得", "description": "アプリのWebApp設定を取得するために使用します。", - "operationId": "getChatWebAppSettings", + "operationId": "getBasicChatWebAppSettingsJa", "tags": [ - "Application" + "アプリケーション設定" ], "responses": { "200": { @@ -858,6 +912,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-webapp-settings" } } } @@ -2693,43 +2750,32 @@ }, "tags": [ { - "name": "Chat", - "description": "Operations related to chat messages and interactions.", - "x-displayName": "チャットメッセージ" - }, - { - "name": "Files", - "description": "File upload and preview operations.", - "x-displayName": "ファイル操作" + "name": "チャットメッセージ", + "description": "チャットメッセージと対話に関連する操作。" }, { - "name": "End Users", - "description": "Operations related to end user information.", - "x-displayName": "エンドユーザー" + "name": "ファイル操作", + "description": "ファイルアップロードとプレビューに関連する操作。" }, { - "name": "Feedback", - "description": "User feedback operations.", - "x-displayName": "メッセージフィードバック" + "name": "エンドユーザー", + "description": "エンドユーザー情報に関連する操作。" }, { - "name": "Conversations", - "description": "Operations related to managing conversations.", - "x-displayName": "会話管理" + "name": "メッセージフィードバック", + "description": "ユーザーからのメッセージフィードバック操作。" }, { - "name": "TTS", - "description": "Text-to-Speech and Speech-to-Text operations.", - "x-displayName": "音声とテキスト変換" + "name": "会話管理", + "description": "会話セッションの管理に関連する操作。" }, { - "name": "Application", - "description": "Operations to retrieve application settings and information.", - "x-displayName": "アプリケーション設定" + "name": "音声とテキスト変換", + "description": "テキストから音声、音声からテキストへの変換操作。" }, { - "name": "Annotations", - "description": "Operations related to managing annotations for direct replies." + "name": "アプリケーション設定", + "description": "アプリケーション設定と情報の取得に関連する操作。" } ] } diff --git a/ja/api-reference/openapi_chatflow.json b/ja/api-reference/openapi_chatflow.json index 64774fd76..01d6f91f8 100644 --- a/ja/api-reference/openapi_chatflow.json +++ b/ja/api-reference/openapi_chatflow.json @@ -27,9 +27,9 @@ "post": { "summary": "チャットメッセージを送信", "description": "チャットアプリケーションにリクエストを送信します。", - "operationId": "sendAdvancedChatMessage", + "operationId": "sendChatflowMessageJp", "tags": [ - "Chatflow" + "チャットメッセージ" ], "requestBody": { "description": "チャットメッセージ送信のリクエストボディ。", @@ -89,6 +89,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + }, + "x-mint": { + "href": "/api-reference/chatflow/send-chat-message" } } }, @@ -96,9 +99,9 @@ "post": { "summary": "ファイルアップロード", "description": "メッセージ送信時に使用するファイルをアップロードし、画像とテキストのマルチモーダル理解を可能にします。アプリケーションでサポートされている形式をサポートします。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", - "operationId": "uploadAdvancedChatFile", + "operationId": "uploadChatflowFileJp", "tags": [ - "Files" + "ファイル操作" ], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data` リクエストが必要です。", @@ -162,6 +165,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + }, + "x-mint": { + "href": "/api-reference/files/file-upload" } } }, @@ -169,9 +175,9 @@ "get": { "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", - "operationId": "getEndUserChatflow", + "operationId": "getEndUserChatflowJp", "tags": [ - "End Users" + "エンドユーザー" ], "parameters": [ { @@ -202,6 +208,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + }, + "x-mint": { + "href": "/api-reference/end-users/get-end-user" } } }, @@ -209,9 +218,9 @@ "get": { "summary": "ファイルプレビュー", "description": "アップロードされたファイルのプレビューまたはダウンロード。このエンドポイントは、ファイルアップロードAPIを通じて事前にアップロードされたファイルにアクセスすることができます。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセス可能です。", - "operationId": "previewChatFlowFile", + "operationId": "previewChatflowFileJp", "tags": [ - "Files" + "ファイル操作" ], "parameters": [ { @@ -345,6 +354,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/files/file-preview" } } }, @@ -352,9 +364,9 @@ "post": { "summary": "生成を停止", "description": "チャットメッセージの生成を停止します。ストリーミングモードでのみサポートされています。", - "operationId": "stopAdvancedChatMessageGeneration", + "operationId": "stopChatflowMessageGenerationJp", "tags": [ - "Chatflow" + "チャットメッセージ" ], "parameters": [ { @@ -391,6 +403,9 @@ "200": { "$ref": "#/components/responses/SuccessResultJp" } + }, + "x-mint": { + "href": "/api-reference/chatflow/stop-advanced-chat-message-generation" } } }, @@ -398,9 +413,9 @@ "post": { "summary": "メッセージフィードバック", "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのを支援します。", - "operationId": "postAdvancedChatMessageFeedback", + "operationId": "postChatflowMessageFeedbackJp", "tags": [ - "Feedback" + "メッセージフィードバック" ], "parameters": [ { @@ -428,6 +443,9 @@ "200": { "$ref": "#/components/responses/SuccessResultJp" } + }, + "x-mint": { + "href": "/api-reference/feedback/message-feedback" } } }, @@ -435,9 +453,9 @@ "get": { "summary": "アプリのメッセージの「いいね」とフィードバックを取得", "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", - "operationId": "getAdvancedChatAppFeedbacks", + "operationId": "getChatflowAppFeedbacksJp", "tags": [ - "Feedback" + "メッセージフィードバック" ], "parameters": [ { @@ -458,6 +476,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -465,9 +486,9 @@ "get": { "summary": "次の推奨質問", "description": "現在のメッセージに対する次の質問の提案を取得します。", - "operationId": "getAdvancedSuggestedQuestions", + "operationId": "getChatflowSuggestedQuestionsJp", "tags": [ - "Chatflow" + "チャットメッセージ" ], "parameters": [ { @@ -495,6 +516,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chatflow/next-suggested-questions" } } }, @@ -502,9 +526,9 @@ "get": { "summary": "会話履歴メッセージを取得", "description": "スクロールロード形式で履歴チャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", - "operationId": "getAdvancedConversationHistory", + "operationId": "getChatflowConversationHistoryJp", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -538,6 +562,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversation-history-messages" } } }, @@ -545,9 +572,9 @@ "get": { "summary": "会話を取得", "description": "現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。", - "operationId": "getAdvancedConversationsList", + "operationId": "getChatflowConversationsListJp", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -574,6 +601,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversations" } } }, @@ -581,9 +611,9 @@ "delete": { "summary": "会話を削除", "description": "指定された会話を削除します。", - "operationId": "deleteAdvancedConversation", + "operationId": "deleteChatflowConversationJp", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -613,6 +643,9 @@ "204": { "description": "会話が正常に削除されました。コンテンツはありません。" } + }, + "x-mint": { + "href": "/api-reference/conversations/delete-conversation" } } }, @@ -620,9 +653,9 @@ "post": { "summary": "会話の名前を変更", "description": "セッションの名前を変更します。", - "operationId": "renameAdvancedConversation", + "operationId": "renameChatflowConversationJp", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -650,6 +683,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/conversation-rename" } } }, @@ -657,9 +693,9 @@ "get": { "summary": "会話変数の取得", "description": "特定の会話から変数を取得します。このエンドポイントは、会話中に取得された構造化データを抽出するのに役立ちます。", - "operationId": "getAdvancedConversationVariables", + "operationId": "getChatflowConversationVariablesJp", "tags": [ - "Conversations" + "会話管理" ], "parameters": [ { @@ -689,6 +725,9 @@ "404": { "$ref": "#/components/responses/ConversationNotFoundJp" } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversation-variables" } } }, @@ -696,9 +735,9 @@ "post": { "summary": "音声からテキストへ", "description": "オーディオファイルをテキストに変換します。サポートされている形式：mp3, mp4, mpeg, mpga, m4a, wav, webm。ファイルサイズ制限：15MB。", - "operationId": "advancedAudioToText", + "operationId": "chatflowAudioToTextJp", "tags": [ - "TTS" + "音声・テキスト変換" ], "requestBody": { "required": true, @@ -721,6 +760,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/speech-to-text" } } }, @@ -728,9 +770,9 @@ "post": { "summary": "テキストから音声へ", "description": "テキストコンテンツを音声に変換します。", - "operationId": "advancedTextToAudio", + "operationId": "chatflowTextToAudioJp", "tags": [ - "TTS" + "音声・テキスト変換" ], "requestBody": { "required": true, @@ -768,15 +810,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/text-to-audio" } } }, "/info": { "get": { "summary": "アプリケーションの基本情報を取得", - "operationId": "getAdvancedChatAppInfo", + "operationId": "getChatflowAppInfoJp", "tags": [ - "Application" + "アプリケーション設定" ], "responses": { "200": { @@ -789,6 +834,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-basic-information" } } }, @@ -796,9 +844,9 @@ "get": { "summary": "アプリケーションのパラメータ情報を取得", "description": "ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。", - "operationId": "getAdvancedChatAppParameters", + "operationId": "getChatflowAppParametersJp", "tags": [ - "Application" + "アプリケーション設定" ], "responses": { "200": { @@ -811,6 +859,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-parameters-information" } } }, @@ -818,9 +869,9 @@ "get": { "summary": "アプリケーションのメタ情報を取得", "description": "このアプリケーションのツールのアイコンを取得するために使用されます。", - "operationId": "getAdvancedChatAppMeta", + "operationId": "getChatflowAppMetaJp", "tags": [ - "Application" + "アプリケーション設定" ], "responses": { "200": { @@ -833,6 +884,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-meta-information" } } }, @@ -840,9 +894,9 @@ "get": { "summary": "アプリのWebApp設定を取得", "description": "アプリのWebApp設定を取得するために使用します。", - "operationId": "getAdvancedChatWebAppSettings", + "operationId": "getChatflowWebAppSettingsJp", "tags": [ - "Application" + "アプリケーション設定" ], "responses": { "200": { @@ -855,6 +909,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-webapp-settings" } } } @@ -2928,43 +2985,32 @@ }, "tags": [ { - "name": "Chatflow", - "description": "Advanced chat operations with workflow events.", - "x-displayName": "チャットメッセージ" - }, - { - "name": "Files", - "description": "File upload and preview operations for advanced chat.", - "x-displayName": "ファイル操作" + "name": "チャットメッセージ", + "description": "チャットメッセージとインタラクションに関連する操作。" }, { - "name": "End Users", - "description": "Operations related to end user information.", - "x-displayName": "エンドユーザー" + "name": "ファイル操作", + "description": "ファイルアップロードとプレビューに関連する操作。" }, { - "name": "Feedback", - "description": "User feedback operations for advanced chat.", - "x-displayName": "メッセージフィードバック" + "name": "エンドユーザー", + "description": "エンドユーザー情報に関連する操作。" }, { - "name": "Conversations", - "description": "Conversation management for advanced chat.", - "x-displayName": "会話管理" + "name": "メッセージフィードバック", + "description": "ユーザーメッセージへのフィードバック操作。" }, { - "name": "TTS", - "description": "Speech and Text conversion for advanced chat.", - "x-displayName": "音声・テキスト変換" + "name": "会話管理", + "description": "会話セッションの管理に関連する操作。" }, { - "name": "Application", - "description": "Application settings and info for advanced chat.", - "x-displayName": "アプリケーション設定" + "name": "音声・テキスト変換", + "description": "テキストから音声へ、音声からテキストへの変換操作。" }, { - "name": "Annotations", - "description": "Annotation management for advanced chat." + "name": "アプリケーション設定", + "description": "アプリケーション設定と情報の取得に関連する操作。" } ] } diff --git a/ja/api-reference/openapi_completion.json b/ja/api-reference/openapi_completion.json index 50f25c5ac..4659b632f 100644 --- a/ja/api-reference/openapi_completion.json +++ b/ja/api-reference/openapi_completion.json @@ -27,9 +27,9 @@ "post": { "summary": "完了メッセージの作成", "description": "テキスト生成アプリケーションにリクエストを送信します。", - "operationId": "createCompletionMessage", + "operationId": "createCompletionMessageJp", "tags": [ - "Completion" + "完了メッセージ" ], "requestBody": { "description": "完了メッセージを作成するためのリクエストボディ。", @@ -80,6 +80,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + }, + "x-mint": { + "href": "/api-reference/completion/create-completion-message" } } }, @@ -87,9 +90,9 @@ "post": { "summary": "ファイルアップロード", "description": "メッセージ送信時に使用するファイル（現在は画像のみ対応）をアップロードし、画像とテキストのマルチモーダルな理解を可能にします。png、jpg、jpeg、webp、gif形式に対応しています。アップロードされたファイルは、現在のエンドユーザーのみが使用できます。", - "operationId": "uploadFile", + "operationId": "uploadCompletionFileJp", "tags": [ - "Files" + "ファイル操作" ], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data` 形式が必要です。", @@ -153,6 +156,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + }, + "x-mint": { + "href": "/api-reference/files/file-upload" } } }, @@ -160,9 +166,9 @@ "get": { "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", - "operationId": "getEndUserCompletion", + "operationId": "getEndUserCompletionJp", "tags": [ - "End Users" + "エンドユーザー" ], "parameters": [ { @@ -193,6 +199,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + }, + "x-mint": { + "href": "/api-reference/end-users/get-end-user" } } }, @@ -200,9 +209,9 @@ "post": { "summary": "生成の停止", "description": "完了メッセージの生成を停止します。ストリーミングモードでのみサポートされています。", - "operationId": "stopGenerate", + "operationId": "stopCompletionGenerationJp", "tags": [ - "Completion" + "完了メッセージ" ], "parameters": [ { @@ -239,6 +248,9 @@ "200": { "$ref": "#/components/responses/SuccessResultJp" } + }, + "x-mint": { + "href": "/api-reference/completion/stop-generate" } } }, @@ -246,9 +258,9 @@ "post": { "summary": "メッセージフィードバック", "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。", - "operationId": "postMessageFeedback", + "operationId": "postCompletionMessageFeedbackJp", "tags": [ - "Feedback" + "メッセージフィードバック" ], "parameters": [ { @@ -276,6 +288,9 @@ "200": { "$ref": "#/components/responses/SuccessResultJp" } + }, + "x-mint": { + "href": "/api-reference/feedback/message-feedback" } } }, @@ -283,9 +298,9 @@ "get": { "summary": "アプリのメッセージの「いいね」とフィードバックを取得", "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", - "operationId": "getAppFeedbacks", + "operationId": "getAppFeedbacksCompletionJp", "tags": [ - "Feedback" + "メッセージフィードバック" ], "parameters": [ { @@ -318,6 +333,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -325,9 +343,9 @@ "post": { "summary": "テキストから音声", "description": "テキストを音声に変換します。", - "operationId": "textToAudio", + "operationId": "textToAudioCompletionJp", "tags": [ - "TTS" + "音声変換" ], "requestBody": { "required": true, @@ -365,15 +383,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/text-to-audio" } } }, "/info": { "get": { "summary": "アプリケーションの基本情報を取得", - "operationId": "getAppInfo", + "operationId": "getCompletionAppInfoJp", "tags": [ - "Application" + "アプリケーション情報" ], "responses": { "200": { @@ -386,15 +407,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-basic-information" } } }, "/parameters": { "get": { "summary": "アプリケーションのパラメータ情報を取得", - "operationId": "getAppParameters", + "operationId": "getCompletionAppParametersJp", "tags": [ - "Application" + "アプリケーション情報" ], "responses": { "200": { @@ -407,15 +431,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-parameters-information" } } }, "/site": { "get": { "summary": "アプリのWebApp設定を取得", - "operationId": "getWebAppSettings", + "operationId": "getCompletionWebAppSettingsJp", "tags": [ - "Application" + "アプリケーション情報" ], "responses": { "200": { @@ -428,6 +455,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-webapp-settings" } } } @@ -1531,34 +1561,28 @@ }, "tags": [ { - "name": "Completion", - "description": "Operations related to text generation and completion.", - "x-displayName": "完了メッセージ" + "name": "完了メッセージ", + "description": "テキスト生成と完了に関連する操作。" }, { - "name": "Files", - "description": "Operations related to file management.", - "x-displayName": "ファイル操作" + "name": "ファイル操作", + "description": "ファイル管理に関連する操作。" }, { - "name": "End Users", - "description": "Operations related to end user information.", - "x-displayName": "エンドユーザー" + "name": "エンドユーザー", + "description": "エンドユーザー情報に関連する操作。" }, { - "name": "Feedback", - "description": "Operations related to user feedback.", - "x-displayName": "メッセージフィードバック" + "name": "メッセージフィードバック", + "description": "ユーザーフィードバックに関連する操作。" }, { - "name": "TTS", - "description": "Operations related to Text-to-Speech.", - "x-displayName": "音声変換" + "name": "音声変換", + "description": "テキストから音声への変換に関連する操作。" }, { - "name": "Application", - "description": "Operations to retrieve application settings and information.", - "x-displayName": "アプリケーション情報" + "name": "アプリケーション情報", + "description": "アプリケーションの設定と情報を取得する操作。" } ] } diff --git a/ja/api-reference/openapi_knowledge.json b/ja/api-reference/openapi_knowledge.json index b6d81c14e..0184439aa 100644 --- a/ja/api-reference/openapi_knowledge.json +++ b/ja/api-reference/openapi_knowledge.json @@ -24,36 +24,31 @@ ], "tags": [ { - "name": "Datasets", - "description": "Operations related to managing knowledge bases (datasets).", - "x-displayName": "データセット" + "name": "データセット", + "description": "ナレッジベース（データセット）の管理に関連する操作。" }, { - "name": "Documents", - "description": "Operations for creating, updating, and managing documents within a dataset.", - "x-displayName": "ドキュメント" + "name": "ドキュメント", + "description": "データセット内のドキュメントの作成、更新、管理のための操作。" }, { - "name": "Chunks", - "description": "Operations for managing document chunks (segments).", - "x-displayName": "チャンク" + "name": "チャンク", + "description": "ドキュメントのチャンク（セグメント）の管理のための操作。" }, { - "name": "Metadata & Tags", - "description": "Operations for managing dataset tags and metadata.", - "x-displayName": "メタデータ・タグ" + "name": "メタデータ・タグ", + "description": "データセットタグとメタデータの管理のための操作。" }, { - "name": "Models", - "description": "Operations for retrieving available models.", - "x-displayName": "モデル" + "name": "モデル", + "description": "利用可能なモデルの取得のための操作。" } ], "paths": { "/datasets": { "post": { "tags": [ - "Datasets" + "データセット" ], "summary": "空のナレッジベースを作成", "description": "指定された設定で新しい空のナレッジベース（データセット）を作成します。", @@ -82,11 +77,14 @@ "409": { "$ref": "#/components/responses/DatasetNameDuplicate" } + }, + "x-mint": { + "href": "/api-reference/datasets/create-an-empty-knowledge-base" } }, "get": { "tags": [ - "Datasets" + "データセット" ], "summary": "ナレッジベースリストを取得", "description": "ページネーションとフィルタリングのオプション付きでナレッジベースのリストを取得します。", @@ -154,13 +152,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/datasets/get-knowledge-base-list" } } }, "/datasets/{dataset_id}": { "get": { "tags": [ - "Datasets" + "データセット" ], "summary": "ナレッジベース詳細を取得", "description": "IDで特定のナレッジベースの詳細情報を取得します。", @@ -188,11 +189,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/datasets/get-knowledge-base-details" } }, "patch": { "tags": [ - "Datasets" + "データセット" ], "summary": "ナレッジベースを更新", "description": "特定のナレッジベースの設定を更新します。", @@ -233,11 +237,14 @@ "409": { "$ref": "#/components/responses/DatasetNameDuplicate" } + }, + "x-mint": { + "href": "/api-reference/datasets/update-knowledge-base" } }, "delete": { "tags": [ - "Datasets" + "データセット" ], "summary": "ナレッジベースを削除", "description": "ナレッジベースとそれに関連するすべてのドキュメントとデータを削除します。", @@ -258,13 +265,16 @@ "204": { "description": "データセットの削除に成功しました。" } + }, + "x-mint": { + "href": "/api-reference/datasets/delete-a-knowledge-base" } } }, "/datasets/{dataset_id}/document/create-by-text": { "post": { "tags": [ - "Documents" + "ドキュメント" ], "summary": "テキストからドキュメントを作成", "description": "テキストコンテンツから既存のナレッジベース内に新しいドキュメントを直接作成します。", @@ -302,13 +312,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/create-a-document-from-text" } } }, "/datasets/{dataset_id}/document/create-by-file": { "post": { "tags": [ - "Documents" + "ドキュメント" ], "summary": "ファイルからドキュメントを作成", "description": "ファイルをアップロードして既存のナレッジベース内に新しいドキュメントを作成します。", @@ -367,13 +380,16 @@ "415": { "$ref": "#/components/responses/UnsupportedFileType" } + }, + "x-mint": { + "href": "/api-reference/documents/create-a-document-from-a-file" } } }, "/datasets/{dataset_id}/documents/{document_id}/update-by-text": { "post": { "tags": [ - "Documents" + "ドキュメント" ], "summary": "テキストでドキュメントを更新", "description": "テキストを使用して既存のドキュメントのコンテンツまたは設定を更新します。", @@ -421,13 +437,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/update-a-document-with-text" } } }, "/datasets/{dataset_id}/documents/{document_id}/update-by-file": { "post": { "tags": [ - "Documents" + "ドキュメント" ], "summary": "ファイルでドキュメントを更新", "description": "新しいファイルをアップロードして既存のドキュメントを更新し、そのコンテンツを置き換えます。", @@ -487,13 +506,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/update-a-document-with-a-file" } } }, "/datasets/{dataset_id}/documents/{batch}/indexing-status": { "get": { "tags": [ - "Documents" + "ドキュメント" ], "summary": "ドキュメント埋め込みステータス（進捗）を取得", "description": "ドキュメントのバッチのインデックス化ステータスを取得し、埋め込みと処理の進捗を表示します。", @@ -538,13 +560,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/get-document-embedding-status-progress" } } }, "/datasets/{dataset_id}/documents/{document_id}": { "get": { "tags": [ - "Documents" + "ドキュメント" ], "summary": "ドキュメント詳細を取得", "description": "処理ルールとステータスを含む単一ドキュメントの詳細情報を取得します。", @@ -596,11 +621,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/get-document-detail" } }, "delete": { "tags": [ - "Documents" + "ドキュメント" ], "summary": "ドキュメントを削除", "description": "ナレッジベースから特定のドキュメントを削除します。", @@ -631,13 +659,16 @@ "204": { "description": "ドキュメントの削除に成功しました。" } + }, + "x-mint": { + "href": "/api-reference/documents/delete-a-document" } } }, "/datasets/{dataset_id}/documents": { "get": { "tags": [ - "Documents" + "ドキュメント" ], "summary": "ナレッジベースのドキュメントリストを取得", "description": "指定されたナレッジベース内のすべてのドキュメントのページネーションリストを取得します。", @@ -693,13 +724,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/get-the-document-list-of-a-knowledge-base" } } }, "/datasets/{dataset_id}/documents/status/{action}": { "patch": { "tags": [ - "Documents" + "ドキュメント" ], "summary": "ドキュメントステータスを更新", "description": "1つまたは複数のドキュメントのステータスを更新するバッチアクションを実行します（例：有効化、無効化、アーカイブ）。", @@ -758,13 +792,16 @@ "200": { "$ref": "#/components/responses/Success" } + }, + "x-mint": { + "href": "/api-reference/documents/update-document-status" } } }, "/datasets/{dataset_id}/documents/{document_id}/segments": { "post": { "tags": [ - "Chunks" + "チャンク" ], "summary": "ドキュメントにチャンクを追加", "description": "特定のドキュメントに1つまたは複数の新しいチャンク（セグメント）を追加します。手動でキュレートされたコンテンツを追加するのに便利です。", @@ -812,11 +849,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/add-chunks-to-a-document" } }, "get": { "tags": [ - "Chunks" + "チャンク" ], "summary": "ドキュメントからチャンクを取得", "description": "特定のドキュメントからチャンク（セグメント）のページネーションリストを取得します。", @@ -891,13 +931,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/get-chunks-from-a-document" } } }, "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}": { "get": { "tags": [ - "Chunks" + "チャンク" ], "summary": "ドキュメント内のチャンク詳細を取得", "description": "ドキュメント内の特定のチャンク（セグメント）の詳細を取得します。", @@ -945,11 +988,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/get-a-chunk-details-in-a-document" } }, "post": { "tags": [ - "Chunks" + "チャンク" ], "summary": "ドキュメント内のチャンクを更新", "description": "特定のチャンク（セグメント）のコンテンツ、キーワード、またはステータスを更新します。", @@ -1007,11 +1053,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/update-a-chunk-in-a-document" } }, "delete": { "tags": [ - "Chunks" + "チャンク" ], "summary": "ドキュメント内のチャンクを削除", "description": "ドキュメントから特定のチャンク（セグメント）を削除します。", @@ -1052,13 +1101,16 @@ "204": { "description": "セグメントの削除に成功しました。" } + }, + "x-mint": { + "href": "/api-reference/chunks/delete-a-chunk-in-a-document" } } }, "/datasets/{dataset_id}/retrieve": { "post": { "tags": [ - "Datasets" + "データセット" ], "summary": "ナレッジベースからチャンクを取得 / テスト検索", "description": "ナレッジベースに対して検索クエリを実行し、最も関連性の高いチャンク（セグメント）を取得します。このエンドポイントは、本番環境での検索とテスト検索の両方に使用できます。", @@ -1096,13 +1148,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/datasets/retrieve-chunks-from-a-knowledge-base-test-retrieval" } } }, "/workspaces/current/models/model-types/text-embedding": { "get": { "tags": [ - "Models" + "モデル" ], "summary": "利用可能な埋め込みモデルを取得", "description": "ナレッジベースの作成とクエリに使用できるすべての利用可能なテキスト埋め込みモデルのリストを取得します。", @@ -1126,13 +1181,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/models/get-available-embedding-models" } } }, "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks": { "post": { "tags": [ - "Chunks" + "チャンク" ], "summary": "子チャンクを作成", "description": "階層モードを使用してドキュメント内の親セグメントの下に新しい子チャンクを作成します。", @@ -1190,11 +1248,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/create-child-chunk" } }, "get": { "tags": [ - "Chunks" + "チャンク" ], "summary": "子チャンクを取得", "description": "特定の親セグメントの子チャンクのリストを取得します。", @@ -1269,13 +1330,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/get-child-chunks" } } }, "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}": { "patch": { "tags": [ - "Chunks" + "チャンク" ], "summary": "子チャンクを更新", "description": "特定の子チャンクのコンテンツを更新します。", @@ -1343,11 +1407,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/update-child-chunk" } }, "delete": { "tags": [ - "Chunks" + "チャンク" ], "summary": "子チャンクを削除", "description": "特定の子チャンクを削除します。", @@ -1398,13 +1465,16 @@ "204": { "description": "子チャンクの削除に成功しました。" } + }, + "x-mint": { + "href": "/api-reference/chunks/delete-child-chunk" } } }, "/datasets/tags": { "post": { "tags": [ - "Metadata & Tags" + "メタデータ・タグ" ], "summary": "新しいナレッジベースタイプタグを作成", "description": "ナレッジベースを分類するために使用できる新しいタグを作成します。", @@ -1440,11 +1510,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/create-new-knowledge-base-type-tag" } }, "get": { "tags": [ - "Metadata & Tags" + "メタデータ・タグ" ], "summary": "ナレッジベースタイプタグを取得", "description": "利用可能なすべてのナレッジベースタグのリストを取得します。", @@ -1463,11 +1536,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/get-knowledge-base-type-tags" } }, "patch": { "tags": [ - "Metadata & Tags" + "メタデータ・タグ" ], "summary": "ナレッジベースタイプタグ名を変更", "description": "既存のタグの名前を更新します。", @@ -1509,11 +1585,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/modify-knowledge-base-type-tag-name" } }, "delete": { "tags": [ - "Metadata & Tags" + "メタデータ・タグ" ], "summary": "ナレッジベースタイプタグを削除", "description": "タグを削除します。タグはどのナレッジベースにもバインドされていない必要があります。", @@ -1542,13 +1621,16 @@ "200": { "$ref": "#/components/responses/Success" } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/delete-knowledge-base-type-tag" } } }, "/datasets/tags/binding": { "post": { "tags": [ - "Metadata & Tags" + "メタデータ・タグ" ], "summary": "データセットをナレッジベースタイプタグにバインド", "description": "1つまたは複数のタグを特定のナレッジベースにバインドします。", @@ -1586,13 +1668,16 @@ "200": { "$ref": "#/components/responses/Success" } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/bind-dataset-to-knowledge-base-type-tag" } } }, "/datasets/tags/unbinding": { "post": { "tags": [ - "Metadata & Tags" + "メタデータ・タグ" ], "summary": "データセットとナレッジベースタイプタグのバインドを解除", "description": "ナレッジベースから特定のタグのバインドを解除します。", @@ -1627,13 +1712,16 @@ "200": { "$ref": "#/components/responses/Success" } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/unbind-dataset-and-knowledge-base-type-tag" } } }, "/datasets/{dataset_id}/tags": { "get": { "tags": [ - "Metadata & Tags" + "メタデータ・タグ" ], "summary": "データセットにバインドされたタグをクエリ", "description": "特定のデータセットに現在バインドされているすべてのタグを取得します。", @@ -1681,6 +1769,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/query-tags-bound-to-a-dataset" } } } diff --git a/ja/api-reference/openapi_workflow.json b/ja/api-reference/openapi_workflow.json index 619decbbf..f0ee9676c 100644 --- a/ja/api-reference/openapi_workflow.json +++ b/ja/api-reference/openapi_workflow.json @@ -27,9 +27,9 @@ "post": { "summary": "ワークフローを実行", "description": "ワークフローを実行します。公開されたワークフローがないと実行できません。", - "operationId": "executeWorkflow", + "operationId": "executeWorkflowJp", "tags": [ - "Workflow Execution" + "ワークフロー実行" ], "requestBody": { "required": true, @@ -97,6 +97,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + }, + "x-mint": { + "href": "/api-reference/workflow-execution/execute-workflow" } } }, @@ -104,9 +107,9 @@ "get": { "summary": "ワークフロー実行詳細を取得", "description": "ワークフロー実行IDに基づいて、ワークフロータスクの現在の実行結果を取得します。", - "operationId": "getWorkflowRunDetail", + "operationId": "getWorkflowRunDetailJp", "tags": [ - "Workflow Execution" + "ワークフロー実行" ], "parameters": [ { @@ -134,6 +137,9 @@ "404": { "description": "ワークフロー実行記録が見つかりません。" } + }, + "x-mint": { + "href": "/api-reference/workflow-execution/get-workflow-run-detail" } } }, @@ -141,9 +147,9 @@ "post": { "summary": "生成を停止 (ワークフロータスク)", "description": "ワークフロータスクの生成を停止します。ストリーミングモードでのみサポートされています。", - "operationId": "stopWorkflowTaskGeneration", + "operationId": "stopWorkflowTaskGenerationJp", "tags": [ - "Workflow Execution" + "ワークフロー実行" ], "parameters": [ { @@ -180,6 +186,9 @@ "200": { "$ref": "#/components/responses/SuccessResultJp" } + }, + "x-mint": { + "href": "/api-reference/workflow-execution/stop-workflow-task-generation" } } }, @@ -187,9 +196,9 @@ "post": { "summary": "ファイルアップロード (ワークフロー用)", "description": "ワークフローで使用するファイルをアップロードします。ワークフローでサポートされている任意の形式をサポートします。アップロードされたファイルは、現在のエンドユーザーのみが使用できます。", - "operationId": "uploadWorkflowFile", + "operationId": "uploadWorkflowFileJp", "tags": [ - "Files" + "ファイル操作 (ワークフロー)" ], "requestBody": { "required": true, @@ -252,6 +261,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + }, + "x-mint": { + "href": "/api-reference/files/file-upload-for-workflow" } } }, @@ -259,9 +271,9 @@ "get": { "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", - "operationId": "getEndUserWorkflow", + "operationId": "getEndUserWorkflowJp", "tags": [ - "End Users" + "エンドユーザー" ], "parameters": [ { @@ -292,6 +304,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorJp" } + }, + "x-mint": { + "href": "/api-reference/end-users/get-end-user" } } }, @@ -299,9 +314,9 @@ "get": { "summary": "ワークフローログを取得", "description": "ワークフローログを返します。最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", - "operationId": "getWorkflowLogs", + "operationId": "getWorkflowLogsJp", "tags": [ - "Workflow Execution" + "ワークフロー実行" ], "parameters": [ { @@ -356,15 +371,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/workflow-execution/get-workflow-logs" } } }, "/info": { "get": { "summary": "アプリケーションの基本情報を取得 (ワークフロー)", - "operationId": "getWorkflowAppInfo", + "operationId": "getWorkflowAppInfoJp", "tags": [ - "Application" + "アプリケーション設定 (ワークフロー)" ], "responses": { "200": { @@ -377,15 +395,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-basic-information" } } }, "/parameters": { "get": { "summary": "アプリケーションのパラメータ情報を取得 (ワークフロー)", - "operationId": "getWorkflowAppParameters", + "operationId": "getWorkflowAppParametersJp", "tags": [ - "Application" + "アプリケーション設定 (ワークフロー)" ], "responses": { "200": { @@ -398,15 +419,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-parameters-information" } } }, "/site": { "get": { "summary": "アプリのWebApp設定を取得 (ワークフロー)", - "operationId": "getWorkflowWebAppSettings", + "operationId": "getWorkflowWebAppSettingsJp", "tags": [ - "Application" + "アプリケーション設定 (ワークフロー)" ], "responses": { "200": { @@ -419,6 +443,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-webapp-settings" } } } @@ -1793,24 +1820,20 @@ }, "tags": [ { - "name": "Workflow Execution", - "description": "Operations related to executing and managing workflows.", - "x-displayName": "ワークフロー実行" + "name": "ワークフロー実行", + "description": "ワークフローの実行と管理に関連する操作。" }, { - "name": "Files", - "description": "File upload and preview operations specific to workflows.", - "x-displayName": "ファイル操作 (ワークフロー)" + "name": "ファイル操作 (ワークフロー)", + "description": "ワークフロー固有のファイルアップロードとプレビュー操作。" }, { - "name": "End Users", - "description": "Operations related to end user information.", - "x-displayName": "エンドユーザー" + "name": "エンドユーザー", + "description": "エンドユーザー情報に関連する操作。" }, { - "name": "Application", - "description": "Application settings and info for workflow apps.", - "x-displayName": "アプリケーション設定 (ワークフロー)" + "name": "アプリケーション設定 (ワークフロー)", + "description": "ワークフローアプリのアプリケーション設定と情報。" } ] } diff --git a/zh/api-reference/openapi_chat.json b/zh/api-reference/openapi_chat.json index 93bfe5f6c..6cbd7e450 100644 --- a/zh/api-reference/openapi_chat.json +++ b/zh/api-reference/openapi_chat.json @@ -27,9 +27,9 @@ "post": { "summary": "发送对话消息", "description": "创建会话消息。", - "operationId": "sendChatMessage", + "operationId": "sendBasicChatMessageCn", "tags": [ - "Chat" + "对话消息" ], "requestBody": { "description": "发送对话消息的请求体。", @@ -89,6 +89,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + }, + "x-mint": { + "href": "/api-reference/chat/send-chat-message" } } }, @@ -96,9 +99,9 @@ "post": { "summary": "上传文件", "description": "上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。支持 png, jpg, jpeg, webp, gif 格式。上传的文件仅供当前终端用户使用。", - "operationId": "uploadChatFile", + "operationId": "uploadBasicChatFileCn", "tags": [ - "Files" + "文件操作" ], "requestBody": { "description": "文件上传请求。需使用 `multipart/form-data` 进行请求。", @@ -162,6 +165,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + }, + "x-mint": { + "href": "/api-reference/files/file-upload" } } }, @@ -169,9 +175,9 @@ "get": { "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", - "operationId": "getEndUserChat", + "operationId": "getEndUserChatCn", "tags": [ - "End Users" + "终端用户" ], "parameters": [ { @@ -202,6 +208,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + }, + "x-mint": { + "href": "/api-reference/end-users/get-end-user" } } }, @@ -209,9 +218,9 @@ "get": { "summary": "文件预览", "description": "预览或下载已上传的文件。此端点允许你访问之前通过文件上传API上传的文件。文件只能在所属的应用程序消息内访问。", - "operationId": "previewChatFile", + "operationId": "previewBasicChatFileCn", "tags": [ - "Files" + "文件操作" ], "parameters": [ { @@ -345,6 +354,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/files/file-preview" } } }, @@ -352,9 +364,9 @@ "post": { "summary": "停止响应", "description": "停止生成对话消息。仅支持流式模式。", - "operationId": "stopChatMessageGeneration", + "operationId": "stopBasicChatMessageGenerationCn", "tags": [ - "Chat" + "对话消息" ], "parameters": [ { @@ -391,6 +403,9 @@ "200": { "$ref": "#/components/responses/SuccessResultCn" } + }, + "x-mint": { + "href": "/api-reference/chat/stop-chat-message-generation" } } }, @@ -398,9 +413,9 @@ "post": { "summary": "消息反馈（点赞）", "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", - "operationId": "postChatMessageFeedback", + "operationId": "postBasicChatMessageFeedbackCn", "tags": [ - "Feedback" + "消息反馈" ], "parameters": [ { @@ -428,6 +443,9 @@ "200": { "$ref": "#/components/responses/SuccessResultCn" } + }, + "x-mint": { + "href": "/api-reference/feedback/message-feedback" } } }, @@ -435,9 +453,9 @@ "get": { "summary": "获取APP的消息点赞和反馈", "description": "获取应用的终端用户反馈、点赞。", - "operationId": "getChatAppFeedbacks", + "operationId": "getBasicChatAppFeedbacksCn", "tags": [ - "Feedback" + "消息反馈" ], "parameters": [ { @@ -458,6 +476,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -465,9 +486,9 @@ "get": { "summary": "获取下一轮建议问题列表", "description": "获取当前消息的下一轮建议问题列表。", - "operationId": "getSuggestedQuestions", + "operationId": "getBasicChatSuggestedQuestionsCn", "tags": [ - "Chat" + "对话消息" ], "parameters": [ { @@ -495,6 +516,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chat/next-suggested-questions" } } }, @@ -502,9 +526,9 @@ "get": { "summary": "获取会话历史消息", "description": "滚动加载形式返回历史聊天记录，第一页返回最新 `limit` 条，即倒序返回。", - "operationId": "getConversationHistory", + "operationId": "getBasicChatConversationHistoryCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -538,6 +562,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversation-history-messages" } } }, @@ -545,9 +572,9 @@ "get": { "summary": "获取会话列表", "description": "获取当前用户的会话列表，默认返回最近的 20 条。", - "operationId": "getConversationsList", + "operationId": "getBasicChatConversationsListCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -574,6 +601,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversations" } } }, @@ -581,9 +611,9 @@ "delete": { "summary": "删除会话", "description": "删除一个指定的会话。", - "operationId": "deleteConversation", + "operationId": "deleteBasicChatConversationCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -613,6 +643,9 @@ "204": { "description": "会话删除成功，无内容返回。" } + }, + "x-mint": { + "href": "/api-reference/conversations/delete-conversation" } } }, @@ -620,9 +653,9 @@ "post": { "summary": "会话重命名", "description": "对会话进行重命名。", - "operationId": "renameConversation", + "operationId": "renameBasicChatConversationCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -650,6 +683,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/conversation-rename" } } }, @@ -657,9 +693,9 @@ "get": { "summary": "获取对话变量", "description": "从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。", - "operationId": "getConversationVariables", + "operationId": "getBasicChatConversationVariablesCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -692,6 +728,9 @@ "404": { "$ref": "#/components/responses/ConversationNotFoundCn" } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversation-variables" } } }, @@ -699,9 +738,9 @@ "post": { "summary": "语音转文字", "description": "将语音文件转换为文字。支持格式：mp3, mp4, mpeg, mpga, m4a, wav, webm。文件大小限制：15MB。", - "operationId": "audioToText", + "operationId": "basicChatAudioToTextCn", "tags": [ - "TTS" + "语音与文字转换" ], "requestBody": { "required": true, @@ -724,6 +763,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/speech-to-text" } } }, @@ -731,9 +773,9 @@ "post": { "summary": "文字转语音", "description": "将文字内容转换为语音。", - "operationId": "textToAudioChat", + "operationId": "basicChatTextToAudioCn", "tags": [ - "TTS" + "语音与文字转换" ], "requestBody": { "required": true, @@ -771,15 +813,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/text-to-audio" } } }, "/info": { "get": { "summary": "获取应用基本信息", - "operationId": "getChatAppInfo", + "operationId": "getBasicChatAppInfoCn", "tags": [ - "Application" + "应用配置" ], "responses": { "200": { @@ -792,6 +837,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-basic-information" } } }, @@ -799,9 +847,9 @@ "get": { "summary": "获取应用参数", "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", - "operationId": "getChatAppParameters", + "operationId": "getBasicChatAppParametersCn", "tags": [ - "Application" + "应用配置" ], "responses": { "200": { @@ -814,6 +862,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-parameters-information" } } }, @@ -821,9 +872,9 @@ "get": { "summary": "获取应用Meta信息", "description": "用于获取工具 icon。", - "operationId": "getChatAppMeta", + "operationId": "getBasicChatAppMetaCn", "tags": [ - "Application" + "应用配置" ], "responses": { "200": { @@ -836,6 +887,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-meta-information" } } }, @@ -843,9 +897,9 @@ "get": { "summary": "获取应用 WebApp 设置", "description": "用于获取应用的 WebApp 设置。", - "operationId": "getChatWebAppSettings", + "operationId": "getBasicChatWebAppSettingsCn", "tags": [ - "Application" + "应用配置" ], "responses": { "200": { @@ -858,6 +912,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-webapp-settings" } } } @@ -2668,43 +2725,32 @@ }, "tags": [ { - "name": "Chat", - "description": "Operations related to chat messages and interactions.", - "x-displayName": "对话消息" - }, - { - "name": "Files", - "description": "File upload and preview operations.", - "x-displayName": "文件操作" + "name": "对话消息", + "description": "与对话消息和交互相关的操作。" }, { - "name": "End Users", - "description": "Operations related to end user information.", - "x-displayName": "终端用户" + "name": "文件操作", + "description": "文件上传和预览相关的操作。" }, { - "name": "Feedback", - "description": "User feedback operations.", - "x-displayName": "消息反馈" + "name": "终端用户", + "description": "终端用户信息相关的操作。" }, { - "name": "Conversations", - "description": "Operations related to managing conversations.", - "x-displayName": "会话管理" + "name": "消息反馈", + "description": "用户对消息的反馈操作。" }, { - "name": "TTS", - "description": "Text-to-Speech and Speech-to-Text operations.", - "x-displayName": "语音与文字转换" + "name": "会话管理", + "description": "管理对话会话相关的操作。" }, { - "name": "Application", - "description": "Operations to retrieve application settings and information.", - "x-displayName": "应用配置" + "name": "语音与文字转换", + "description": "文本转语音和语音转文本操作。" }, { - "name": "Annotations", - "description": "Operations related to managing annotations for direct replies." + "name": "应用配置", + "description": "获取应用设置和信息相关的操作。" } ] } diff --git a/zh/api-reference/openapi_chatflow.json b/zh/api-reference/openapi_chatflow.json index f411f38f7..424dce7f2 100644 --- a/zh/api-reference/openapi_chatflow.json +++ b/zh/api-reference/openapi_chatflow.json @@ -27,9 +27,9 @@ "post": { "summary": "发送对话消息", "description": "创建会话消息。", - "operationId": "sendAdvancedChatMessage", + "operationId": "sendChatMessageCn", "tags": [ - "Chatflow" + "对话消息" ], "requestBody": { "description": "发送对话消息的请求体。", @@ -89,6 +89,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + }, + "x-mint": { + "href": "/api-reference/chatflow/send-chat-message" } } }, @@ -96,9 +99,9 @@ "post": { "summary": "上传文件", "description": "上传文件并在发送消息时使用，可实现图文多模态理解。支持你的应用程序所支持的所有格式。上传的文件仅供当前终端用户使用。", - "operationId": "uploadAdvancedChatFile", + "operationId": "uploadFileCn", "tags": [ - "Files" + "文件操作" ], "requestBody": { "description": "文件上传请求。需使用 `multipart/form-data` 进行请求。", @@ -162,6 +165,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + }, + "x-mint": { + "href": "/api-reference/files/file-upload" } } }, @@ -169,9 +175,9 @@ "get": { "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", - "operationId": "getEndUserChatflow", + "operationId": "getEndUserChatflowCn", "tags": [ - "End Users" + "终端用户" ], "parameters": [ { @@ -202,6 +208,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + }, + "x-mint": { + "href": "/api-reference/end-users/get-end-user" } } }, @@ -209,9 +218,9 @@ "get": { "summary": "文件预览", "description": "预览或下载已上传的文件。此端点允许你访问之前通过文件上传API上传的文件。文件只能在所属的应用程序消息内访问。", - "operationId": "previewChatFlowFile", + "operationId": "previewChatFlowFileCn", "tags": [ - "Files" + "文件操作" ], "parameters": [ { @@ -345,6 +354,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/files/file-preview" } } }, @@ -352,9 +364,9 @@ "post": { "summary": "停止响应", "description": "停止生成对话消息。仅支持流式模式。", - "operationId": "stopAdvancedChatMessageGeneration", + "operationId": "stopChatMessageGenerationCn", "tags": [ - "Chatflow" + "对话消息" ], "parameters": [ { @@ -391,6 +403,9 @@ "200": { "$ref": "#/components/responses/SuccessResultCn" } + }, + "x-mint": { + "href": "/api-reference/chatflow/stop-advanced-chat-message-generation" } } }, @@ -398,9 +413,9 @@ "post": { "summary": "消息反馈（点赞）", "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", - "operationId": "postAdvancedChatMessageFeedback", + "operationId": "postMessageFeedbackCn", "tags": [ - "Feedback" + "消息反馈" ], "parameters": [ { @@ -428,6 +443,9 @@ "200": { "$ref": "#/components/responses/SuccessResultCn" } + }, + "x-mint": { + "href": "/api-reference/feedback/message-feedback" } } }, @@ -435,9 +453,9 @@ "get": { "summary": "获取APP的消息点赞和反馈", "description": "获取应用的终端用户反馈、点赞。", - "operationId": "getAdvancedChatAppFeedbacks", + "operationId": "getAppFeedbacksCn", "tags": [ - "Feedback" + "消息反馈" ], "parameters": [ { @@ -458,6 +476,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -465,9 +486,9 @@ "get": { "summary": "获取下一轮建议问题列表", "description": "获取当前消息的下一轮建议问题列表。", - "operationId": "getAdvancedSuggestedQuestions", + "operationId": "getSuggestedQuestionsCn", "tags": [ - "Chatflow" + "对话消息" ], "parameters": [ { @@ -495,6 +516,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chatflow/next-suggested-questions" } } }, @@ -502,9 +526,9 @@ "get": { "summary": "获取会话历史消息", "description": "滚动加载形式返回历史聊天记录，第一页返回最新 `limit` 条，即倒序返回。", - "operationId": "getAdvancedConversationHistory", + "operationId": "getConversationHistoryCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -538,6 +562,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversation-history-messages" } } }, @@ -545,9 +572,9 @@ "get": { "summary": "获取会话列表", "description": "获取当前用户的会话列表，默认返回最近的 20 条。", - "operationId": "getAdvancedConversationsList", + "operationId": "getConversationsListCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -574,6 +601,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversations" } } }, @@ -581,9 +611,9 @@ "delete": { "summary": "删除会话", "description": "删除一个指定的会话。", - "operationId": "deleteAdvancedConversation", + "operationId": "deleteConversationCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -613,6 +643,9 @@ "204": { "description": "会话删除成功，无内容返回。" } + }, + "x-mint": { + "href": "/api-reference/conversations/delete-conversation" } } }, @@ -620,9 +653,9 @@ "post": { "summary": "会话重命名", "description": "对会话进行重命名。", - "operationId": "renameAdvancedConversation", + "operationId": "renameConversationCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -650,6 +683,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/conversations/conversation-rename" } } }, @@ -657,9 +693,9 @@ "get": { "summary": "获取对话变量", "description": "从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。", - "operationId": "getAdvancedConversationVariables", + "operationId": "getConversationVariablesCn", "tags": [ - "Conversations" + "会话管理" ], "parameters": [ { @@ -689,6 +725,9 @@ "404": { "$ref": "#/components/responses/ConversationNotFoundCn" } + }, + "x-mint": { + "href": "/api-reference/conversations/get-conversation-variables" } } }, @@ -696,9 +735,9 @@ "post": { "summary": "语音转文字", "description": "将语音文件转换为文字。支持格式：mp3, mp4, mpeg, mpga, m4a, wav, webm。文件大小限制：15MB。", - "operationId": "advancedAudioToText", + "operationId": "audioToTextCn", "tags": [ - "TTS" + "语音与文字转换" ], "requestBody": { "required": true, @@ -721,6 +760,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/speech-to-text" } } }, @@ -728,9 +770,9 @@ "post": { "summary": "文字转语音", "description": "将文字内容转换为语音。", - "operationId": "advancedTextToAudio", + "operationId": "textToAudioCn", "tags": [ - "TTS" + "语音与文字转换" ], "requestBody": { "required": true, @@ -768,15 +810,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/text-to-audio" } } }, "/info": { "get": { "summary": "获取应用基本信息", - "operationId": "getAdvancedChatAppInfo", + "operationId": "getAppInfoCn", "tags": [ - "Application" + "应用配置" ], "responses": { "200": { @@ -789,6 +834,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-basic-information" } } }, @@ -796,9 +844,9 @@ "get": { "summary": "获取应用参数", "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", - "operationId": "getAdvancedChatAppParameters", + "operationId": "getAppParametersCn", "tags": [ - "Application" + "应用配置" ], "responses": { "200": { @@ -811,6 +859,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-parameters-information" } } }, @@ -818,9 +869,9 @@ "get": { "summary": "获取应用Meta信息", "description": "用于获取工具 icon。", - "operationId": "getAdvancedChatAppMeta", + "operationId": "getAppMetaCn", "tags": [ - "Application" + "应用配置" ], "responses": { "200": { @@ -833,6 +884,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-meta-information" } } }, @@ -840,9 +894,9 @@ "get": { "summary": "获取应用 WebApp 设置", "description": "用于获取应用的 WebApp 设置。", - "operationId": "getAdvancedChatWebAppSettings", + "operationId": "getWebAppSettingsCn", "tags": [ - "Application" + "应用配置" ], "responses": { "200": { @@ -855,15 +909,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-webapp-settings" } } }, "/apps/annotations": { "get": { "summary": "获取标注列表", - "operationId": "getAdvancedAnnotationList", + "operationId": "getAnnotationListCn", "tags": [ - "Annotations" + "标注管理" ], "parameters": [ { @@ -884,13 +941,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/annotations/get-annotation-list" } }, "post": { "summary": "创建标注", - "operationId": "createAdvancedAnnotation", + "operationId": "createAnnotationCn", "tags": [ - "Annotations" + "标注管理" ], "requestBody": { "required": true, @@ -923,15 +983,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/annotations/create-annotation" } } }, "/apps/annotations/{annotation_id}": { "put": { "summary": "更新标注", - "operationId": "updateAdvancedAnnotation", + "operationId": "updateAnnotationCn", "tags": [ - "Annotations" + "标注管理" ], "parameters": [ { @@ -959,13 +1022,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/annotations/update-annotation" } }, "delete": { "summary": "删除标注", - "operationId": "deleteAdvancedAnnotation", + "operationId": "deleteAnnotationCn", "tags": [ - "Annotations" + "标注管理" ], "parameters": [ { @@ -976,6 +1042,9 @@ "204": { "description": "标注删除成功。" } + }, + "x-mint": { + "href": "/api-reference/annotations/delete-annotation" } } }, @@ -983,9 +1052,9 @@ "post": { "summary": "标注回复初始设置", "description": "启用或禁用标注回复功能，并配置相关的嵌入模型和阈值。此接口异步执行。", - "operationId": "initialAdvancedAnnotationReplySettings", + "operationId": "initialAnnotationReplySettingsCn", "tags": [ - "Annotations" + "标注管理" ], "parameters": [ { @@ -1023,15 +1092,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/annotations/initial-annotation-reply-settings" } } }, "/apps/annotation-reply/{action}/status/{job_id}": { "get": { "summary": "查询标注回复初始设置任务状态", - "operationId": "getAdvancedInitialAnnotationReplySettingsStatus", + "operationId": "getInitialAnnotationReplySettingsStatusCn", "tags": [ - "Annotations" + "标注管理" ], "parameters": [ { @@ -1052,6 +1124,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/annotations/query-initial-annotation-reply-settings-task-status" } } } @@ -3280,44 +3355,36 @@ }, "tags": [ { - "name": "Chatflow", - "description": "Advanced chat operations with workflow events.", - "x-displayName": "对话消息" + "name": "对话消息", + "description": "与对话消息和交互相关的操作。" }, { - "name": "Files", - "description": "File upload and preview operations for advanced chat.", - "x-displayName": "文件操作" + "name": "文件操作", + "description": "文件上传和预览相关的操作。" }, { - "name": "End Users", - "description": "Operations related to end user information.", - "x-displayName": "终端用户" + "name": "终端用户", + "description": "终端用户信息相关的操作。" }, { - "name": "Feedback", - "description": "User feedback operations for advanced chat.", - "x-displayName": "消息反馈" + "name": "消息反馈", + "description": "用户对消息的反馈操作。" }, { - "name": "Conversations", - "description": "Conversation management for advanced chat.", - "x-displayName": "会话管理" + "name": "会话管理", + "description": "管理对话会话相关的操作。" }, { - "name": "TTS", - "description": "Speech and Text conversion for advanced chat.", - "x-displayName": "语音与文字转换" + "name": "语音与文字转换", + "description": "文本转语音和语音转文本操作。" }, { - "name": "Application", - "description": "Application settings and info for advanced chat.", - "x-displayName": "应用配置" + "name": "应用配置", + "description": "获取应用设置和信息相关的操作。" }, { - "name": "Annotations", - "description": "Annotation management for advanced chat.", - "x-displayName": "标注管理" + "name": "标注管理", + "description": "管理用于直接回复的标注数据。" } ] } diff --git a/zh/api-reference/openapi_completion.json b/zh/api-reference/openapi_completion.json index 2ef6c3ad1..d9452cbb8 100644 --- a/zh/api-reference/openapi_completion.json +++ b/zh/api-reference/openapi_completion.json @@ -29,7 +29,7 @@ "description": "发送请求给文本生成型应用。", "operationId": "createCompletionMessage", "tags": [ - "Completion" + "文本生成" ], "requestBody": { "description": "创建完成消息的请求体。", @@ -99,6 +99,9 @@ "500": { "$ref": "#/components/responses/InternalServerError" } + }, + "x-mint": { + "href": "/api-reference/completion/create-completion-message" } } }, @@ -108,7 +111,7 @@ "description": "上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。支持 png, jpg, jpeg, webp, gif 格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadFile", "tags": [ - "Files" + "文件管理" ], "requestBody": { "description": "文件上传请求，需使用 `multipart/form-data`。", @@ -169,6 +172,9 @@ "503": { "$ref": "#/components/responses/S3ErrorFile" } + }, + "x-mint": { + "href": "/api-reference/files/file-upload" } } }, @@ -176,9 +182,9 @@ "get": { "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", - "operationId": "getEndUserCompletion", + "operationId": "getEndUserCompletionCn", "tags": [ - "End Users" + "终端用户" ], "parameters": [ { @@ -223,6 +229,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/end-users/get-end-user" } } }, @@ -230,9 +239,9 @@ "post": { "summary": "停止响应", "description": "停止生成任务，仅支持流式模式。", - "operationId": "stopGenerate", + "operationId": "stopCompletionGeneration", "tags": [ - "Completion" + "文本生成" ], "parameters": [ { @@ -269,6 +278,9 @@ "200": { "$ref": "#/components/responses/SuccessResult" } + }, + "x-mint": { + "href": "/api-reference/completion/stop-generate" } } }, @@ -278,7 +290,7 @@ "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", "operationId": "postMessageFeedback", "tags": [ - "Feedback" + "反馈" ], "parameters": [ { @@ -306,6 +318,9 @@ "200": { "$ref": "#/components/responses/SuccessResult" } + }, + "x-mint": { + "href": "/api-reference/feedback/message-feedback" } } }, @@ -315,7 +330,7 @@ "description": "获取应用的反馈信息。", "operationId": "getAppFeedbacks", "tags": [ - "Feedback" + "反馈" ], "parameters": [ { @@ -336,6 +351,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -345,7 +363,7 @@ "description": "将文本内容转换为语音。", "operationId": "textToAudio", "tags": [ - "TTS" + "语音服务" ], "requestBody": { "required": true, @@ -386,6 +404,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/tts/text-to-audio" } } }, @@ -395,7 +416,7 @@ "description": "用于获取此应用的基本信息。", "operationId": "getAppInfo", "tags": [ - "Application" + "应用设置" ], "responses": { "200": { @@ -408,6 +429,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-basic-information" } } }, @@ -417,7 +441,7 @@ "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", "operationId": "getAppParameters", "tags": [ - "Application" + "应用设置" ], "responses": { "200": { @@ -430,6 +454,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-parameters-information" } } }, @@ -439,7 +466,7 @@ "description": "用于获取应用的 WebApp 设置。", "operationId": "getWebAppSettings", "tags": [ - "Application" + "应用设置" ], "responses": { "200": { @@ -452,6 +479,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-webapp-settings" } } }, @@ -2006,34 +2036,32 @@ }, "tags": [ { - "name": "Completion", - "description": "Operations related to text generation and completion.", - "x-displayName": "文本生成" + "name": "文本生成", + "description": "与文本生成和完成相关的操作。" + }, + { + "name": "文件管理", + "description": "与文件上传和管理相关的操作。" }, { - "name": "Files", - "description": "Operations related to file management.", - "x-displayName": "文件管理" + "name": "终端用户", + "description": "终端用户信息相关的操作。" }, { - "name": "End Users", - "description": "Operations related to end user information.", - "x-displayName": "终端用户" + "name": "反馈", + "description": "与用户反馈相关的操作。" }, { - "name": "Feedback", - "description": "Operations related to user feedback.", - "x-displayName": "反馈" + "name": "语音服务", + "description": "与文本转语音相关的操作。" }, { - "name": "TTS", - "description": "Operations related to Text-to-Speech.", - "x-displayName": "语音服务" + "name": "应用设置", + "description": "获取应用基本信息和参数配置的操作。" }, { - "name": "Application", - "description": "Operations to retrieve application settings and information.", - "x-displayName": "应用设置" + "name": "标注管理", + "description": "与标注（用于直接回复）相关的操作。" } ] } diff --git a/zh/api-reference/openapi_knowledge.json b/zh/api-reference/openapi_knowledge.json index ca5bd30b7..f356af99b 100644 --- a/zh/api-reference/openapi_knowledge.json +++ b/zh/api-reference/openapi_knowledge.json @@ -24,36 +24,31 @@ ], "tags": [ { - "name": "Datasets", - "description": "Operations related to managing knowledge bases (datasets).", - "x-displayName": "数据集" + "name": "数据集", + "description": "与管理知识库（数据集）相关的操作。" }, { - "name": "Documents", - "description": "Operations for creating, updating, and managing documents within a dataset.", - "x-displayName": "文档" + "name": "文档", + "description": "用于在数据集中创建、更新和管理文档的操作。" }, { - "name": "Chunks", - "description": "Operations for managing document chunks (segments).", - "x-displayName": "文档块" + "name": "文档块", + "description": "用于管理文档块（段落）的操作。" }, { - "name": "Metadata & Tags", - "description": "Operations for managing dataset tags and metadata.", - "x-displayName": "元数据和标签" + "name": "元数据和标签", + "description": "用于管理数据集标签和元数据的操作。" }, { - "name": "Models", - "description": "Operations for retrieving available models.", - "x-displayName": "模型" + "name": "模型", + "description": "用于检索可用模型的操作。" } ], "paths": { "/datasets": { "post": { "tags": [ - "Datasets" + "数据集" ], "summary": "创建空知识库", "description": "使用指定配置创建一个新的空知识库（数据集）。", @@ -82,11 +77,14 @@ "409": { "$ref": "#/components/responses/DatasetNameDuplicate" } + }, + "x-mint": { + "href": "/api-reference/datasets/create-an-empty-knowledge-base" } }, "get": { "tags": [ - "Datasets" + "数据集" ], "summary": "获取知识库列表", "description": "检索知识库列表，支持分页和过滤选项。", @@ -154,13 +152,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/datasets/get-knowledge-base-list" } } }, "/datasets/{dataset_id}": { "get": { "tags": [ - "Datasets" + "数据集" ], "summary": "获取知识库详情", "description": "通过 ID 获取特定知识库的详细信息。", @@ -188,11 +189,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/datasets/get-knowledge-base-details" } }, "patch": { "tags": [ - "Datasets" + "数据集" ], "summary": "更新知识库", "description": "更新特定知识库的设置。", @@ -233,11 +237,14 @@ "409": { "$ref": "#/components/responses/DatasetNameDuplicate" } + }, + "x-mint": { + "href": "/api-reference/datasets/update-knowledge-base" } }, "delete": { "tags": [ - "Datasets" + "数据集" ], "summary": "删除知识库", "description": "删除知识库及其所有相关文档和数据。", @@ -258,13 +265,16 @@ "204": { "description": "成功删除数据集。" } + }, + "x-mint": { + "href": "/api-reference/datasets/delete-a-knowledge-base" } } }, "/datasets/{dataset_id}/document/create-by-text": { "post": { "tags": [ - "Documents" + "文档" ], "summary": "从文本创建文档", "description": "直接从文本内容在现有知识库中创建新文档。", @@ -302,13 +312,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/create-a-document-from-text" } } }, "/datasets/{dataset_id}/document/create-by-file": { "post": { "tags": [ - "Documents" + "文档" ], "summary": "从文件创建文档", "description": "通过上传文件在现有知识库中创建新文档。", @@ -367,13 +380,16 @@ "415": { "$ref": "#/components/responses/UnsupportedFileType" } + }, + "x-mint": { + "href": "/api-reference/documents/create-a-document-from-a-file" } } }, "/datasets/{dataset_id}/documents/{document_id}/update-by-text": { "post": { "tags": [ - "Documents" + "文档" ], "summary": "用文本更新文档", "description": "使用文本更新现有文档的内容或设置。", @@ -421,13 +437,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/update-a-document-with-text" } } }, "/datasets/{dataset_id}/documents/{document_id}/update-by-file": { "post": { "tags": [ - "Documents" + "文档" ], "summary": "用文件更新文档", "description": "通过上传新文件更新现有文档，替换其内容。", @@ -487,13 +506,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/update-a-document-with-a-file" } } }, "/datasets/{dataset_id}/documents/{batch}/indexing-status": { "get": { "tags": [ - "Documents" + "文档" ], "summary": "获取文档嵌入状态（进度）", "description": "检索文档批次的索引状态，显示嵌入和处理的进度。", @@ -538,13 +560,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/get-document-embedding-status-progress" } } }, "/datasets/{dataset_id}/documents/{document_id}": { "get": { "tags": [ - "Documents" + "文档" ], "summary": "获取文档详情", "description": "检索单个文档的详细信息，包括其处理规则和状态。", @@ -596,11 +621,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/get-document-detail" } }, "delete": { "tags": [ - "Documents" + "文档" ], "summary": "删除文档", "description": "从知识库中删除特定文档。", @@ -631,13 +659,16 @@ "204": { "description": "成功删除文档。" } + }, + "x-mint": { + "href": "/api-reference/documents/delete-a-document" } } }, "/datasets/{dataset_id}/documents": { "get": { "tags": [ - "Documents" + "文档" ], "summary": "获取知识库的文档列表", "description": "检索指定知识库中所有文档的分页列表。", @@ -693,13 +724,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/documents/get-the-document-list-of-a-knowledge-base" } } }, "/datasets/{dataset_id}/documents/status/{action}": { "patch": { "tags": [ - "Documents" + "文档" ], "summary": "更新文档状态", "description": "执行批量操作以更新一个或多个文档的状态（例如，启用、禁用、归档）。", @@ -758,13 +792,16 @@ "200": { "$ref": "#/components/responses/Success" } + }, + "x-mint": { + "href": "/api-reference/documents/update-document-status" } } }, "/datasets/{dataset_id}/documents/{document_id}/segments": { "post": { "tags": [ - "Chunks" + "文档块" ], "summary": "向文档添加块", "description": "向特定文档添加一个或多个新块（段落）。这对于手动添加精心策划的内容很有用。", @@ -812,11 +849,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/add-chunks-to-a-document" } }, "get": { "tags": [ - "Chunks" + "文档块" ], "summary": "从文档获取块", "description": "从特定文档检索块（段落）的分页列表。", @@ -891,13 +931,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/get-chunks-from-a-document" } } }, "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}": { "get": { "tags": [ - "Chunks" + "文档块" ], "summary": "获取文档中的块详情", "description": "检索文档中特定块（段落）的详情。", @@ -945,11 +988,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/get-a-chunk-details-in-a-document" } }, "post": { "tags": [ - "Chunks" + "文档块" ], "summary": "更新文档中的块", "description": "更新特定块（段落）的内容、关键词或状态。", @@ -1007,11 +1053,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/update-a-chunk-in-a-document" } }, "delete": { "tags": [ - "Chunks" + "文档块" ], "summary": "删除文档中的块", "description": "从文档中删除特定块（段落）。", @@ -1052,13 +1101,16 @@ "204": { "description": "成功删除段落。" } + }, + "x-mint": { + "href": "/api-reference/chunks/delete-a-chunk-in-a-document" } } }, "/datasets/{dataset_id}/retrieve": { "post": { "tags": [ - "Datasets" + "数据集" ], "summary": "从知识库检索块 / 测试检索", "description": "对知识库执行搜索查询以检索最相关的块（段落）。此端点可用于生产检索和测试检索。", @@ -1096,13 +1148,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/datasets/retrieve-chunks-from-a-knowledge-base-test-retrieval" } } }, "/workspaces/current/models/model-types/text-embedding": { "get": { "tags": [ - "Models" + "模型" ], "summary": "获取可用的嵌入模型", "description": "获取可用于创建和查询知识库的所有可用文本嵌入模型列表。", @@ -1126,13 +1181,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/models/get-available-embedding-models" } } }, "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks": { "post": { "tags": [ - "Chunks" + "文档块" ], "summary": "创建子块", "description": "使用分层模式在文档中的父段落下创建新的子块。", @@ -1190,11 +1248,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/create-child-chunk" } }, "get": { "tags": [ - "Chunks" + "文档块" ], "summary": "获取子块", "description": "检索特定父段落的子块列表。", @@ -1269,13 +1330,16 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/get-child-chunks" } } }, "/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}": { "patch": { "tags": [ - "Chunks" + "文档块" ], "summary": "更新子块", "description": "更新特定子块的内容。", @@ -1343,11 +1407,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/chunks/update-child-chunk" } }, "delete": { "tags": [ - "Chunks" + "文档块" ], "summary": "删除子块", "description": "删除特定的子块。", @@ -1398,13 +1465,16 @@ "204": { "description": "成功删除子块。" } + }, + "x-mint": { + "href": "/api-reference/chunks/delete-child-chunk" } } }, "/datasets/tags": { "post": { "tags": [ - "Metadata & Tags" + "元数据和标签" ], "summary": "创建新的知识库类型标签", "description": "创建可用于分类知识库的新标签。", @@ -1440,11 +1510,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/create-new-knowledge-base-type-tag" } }, "get": { "tags": [ - "Metadata & Tags" + "元数据和标签" ], "summary": "获取知识库类型标签", "description": "检索所有可用知识库标签的列表。", @@ -1463,11 +1536,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/get-knowledge-base-type-tags" } }, "patch": { "tags": [ - "Metadata & Tags" + "元数据和标签" ], "summary": "修改知识库类型标签名称", "description": "更新现有标签的名称。", @@ -1509,11 +1585,14 @@ } } } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/modify-knowledge-base-type-tag-name" } }, "delete": { "tags": [ - "Metadata & Tags" + "元数据和标签" ], "summary": "删除知识库类型标签", "description": "删除标签。标签不得绑定到任何知识库。", @@ -1542,13 +1621,16 @@ "200": { "$ref": "#/components/responses/Success" } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/delete-knowledge-base-type-tag" } } }, "/datasets/tags/binding": { "post": { "tags": [ - "Metadata & Tags" + "元数据和标签" ], "summary": "将数据集绑定到知识库类型标签", "description": "将一个或多个标签绑定到特定知识库。", @@ -1586,13 +1668,16 @@ "200": { "$ref": "#/components/responses/Success" } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/bind-dataset-to-knowledge-base-type-tag" } } }, "/datasets/tags/unbinding": { "post": { "tags": [ - "Metadata & Tags" + "元数据和标签" ], "summary": "解绑数据集和知识库类型标签", "description": "从知识库解绑特定标签。", @@ -1627,13 +1712,16 @@ "200": { "$ref": "#/components/responses/Success" } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/unbind-dataset-and-knowledge-base-type-tag" } } }, "/datasets/{dataset_id}/tags": { "get": { "tags": [ - "Metadata & Tags" + "元数据和标签" ], "summary": "查询绑定到数据集的标签", "description": "检索当前绑定到特定数据集的所有标签。", @@ -1681,6 +1769,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/metadata-tags/query-tags-bound-to-a-dataset" } } } diff --git a/zh/api-reference/openapi_workflow.json b/zh/api-reference/openapi_workflow.json index b464821b9..1ae28be5e 100644 --- a/zh/api-reference/openapi_workflow.json +++ b/zh/api-reference/openapi_workflow.json @@ -27,9 +27,9 @@ "post": { "summary": "执行 workflow", "description": "执行 workflow，没有已发布的 workflow，不可执行。", - "operationId": "executeWorkflow", + "operationId": "executeWorkflowCn", "tags": [ - "Workflow Execution" + "工作流执行" ], "requestBody": { "required": true, @@ -97,6 +97,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + }, + "x-mint": { + "href": "/api-reference/workflow-execution/execute-workflow" } } }, @@ -104,9 +107,9 @@ "get": { "summary": "获取workflow执行情况", "description": "根据 workflow 执行 ID 获取 workflow 任务当前执行结果。", - "operationId": "getWorkflowRunDetail", + "operationId": "getWorkflowRunDetailCn", "tags": [ - "Workflow Execution" + "工作流执行" ], "parameters": [ { @@ -134,6 +137,9 @@ "404": { "description": "Workflow 执行记录未找到。" } + }, + "x-mint": { + "href": "/api-reference/workflow-execution/get-workflow-run-detail" } } }, @@ -141,9 +147,9 @@ "post": { "summary": "停止响应 (Workflow Task)", "description": "停止 workflow 任务的生成。仅支持流式模式。", - "operationId": "stopWorkflowTaskGeneration", + "operationId": "stopWorkflowTaskGenerationCn", "tags": [ - "Workflow Execution" + "工作流执行" ], "parameters": [ { @@ -180,6 +186,9 @@ "200": { "$ref": "#/components/responses/SuccessResultCn" } + }, + "x-mint": { + "href": "/api-reference/workflow-execution/stop-workflow-task-generation" } } }, @@ -187,9 +196,9 @@ "post": { "summary": "上传文件 (Workflow)", "description": "上传文件并在执行 workflow 时使用。支持你的工作流程所支持的任何格式。上传的文件仅供当前终端用户使用。", - "operationId": "uploadWorkflowFile", + "operationId": "uploadWorkflowFileCn", "tags": [ - "Files" + "文件操作 (Workflow)" ], "requestBody": { "required": true, @@ -252,6 +261,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + }, + "x-mint": { + "href": "/api-reference/files/file-upload-for-workflow" } } }, @@ -259,9 +271,9 @@ "get": { "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", - "operationId": "getEndUserWorkflow", + "operationId": "getEndUserWorkflowCn", "tags": [ - "End Users" + "终端用户" ], "parameters": [ { @@ -292,6 +304,9 @@ "500": { "$ref": "#/components/responses/InternalServerErrorCn" } + }, + "x-mint": { + "href": "/api-reference/end-users/get-end-user" } } }, @@ -299,9 +314,9 @@ "get": { "summary": "获取 workflow 日志", "description": "倒序返回 workflow 日志。", - "operationId": "getWorkflowLogs", + "operationId": "getWorkflowLogsCn", "tags": [ - "Workflow Execution" + "工作流执行" ], "parameters": [ { @@ -356,15 +371,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/workflow-execution/get-workflow-logs" } } }, "/info": { "get": { "summary": "获取应用基本信息 (Workflow)", - "operationId": "getWorkflowAppInfo", + "operationId": "getWorkflowAppInfoCn", "tags": [ - "Application" + "应用配置 (Workflow)" ], "responses": { "200": { @@ -377,15 +395,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-basic-information" } } }, "/parameters": { "get": { "summary": "获取应用参数 (Workflow)", - "operationId": "getWorkflowAppParameters", + "operationId": "getWorkflowAppParametersCn", "tags": [ - "Application" + "应用配置 (Workflow)" ], "responses": { "200": { @@ -398,15 +419,18 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-parameters-information" } } }, "/site": { "get": { "summary": "获取应用 WebApp 设置 (Workflow)", - "operationId": "getWorkflowWebAppSettings", + "operationId": "getWorkflowWebAppSettingsCn", "tags": [ - "Application" + "应用配置 (Workflow)" ], "responses": { "200": { @@ -419,6 +443,9 @@ } } } + }, + "x-mint": { + "href": "/api-reference/application/get-application-webapp-settings" } } } @@ -1784,24 +1811,20 @@ }, "tags": [ { - "name": "Workflow Execution", - "description": "Operations related to executing and managing workflows.", - "x-displayName": "工作流执行" + "name": "工作流执行", + "description": "与执行和管理工作流相关的操作。" }, { - "name": "Files", - "description": "File upload and preview operations specific to workflows.", - "x-displayName": "文件操作 (工作流)" + "name": "文件操作 (工作流)", + "description": "特定于工作流的文件上传和预览操作。" }, { - "name": "End Users", - "description": "Operations related to end user information.", - "x-displayName": "终端用户" + "name": "终端用户", + "description": "终端用户信息相关的操作。" }, { - "name": "Application", - "description": "Application settings and info for workflow apps.", - "x-displayName": "应用配置 (Workflow)" + "name": "应用配置 (Workflow)", + "description": "工作流应用的应用设置和信息。" } ] } From f1e82faea22c72a94685ca0e21b0e1e981ab5b94 Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Mon, 9 Mar 2026 18:57:42 +0800 Subject: [PATCH 08/10] fix: add language prefix to x-mint href to prevent cross-language conflicts Without the language prefix, zh/ja endpoints claimed the same absolute URL as en (e.g., /api-reference/chat/send-chat-message), causing ja content to appear on en pages. Now each language has its own prefixed href (e.g., /zh/api-reference/chat/send-chat-message), keeping content correctly scoped while enabling language switching. Co-Authored-By: Claude Opus 4.6 --- ja/api-reference/openapi_chat.json | 38 +++++++------- ja/api-reference/openapi_chatflow.json | 38 +++++++------- ja/api-reference/openapi_completion.json | 20 ++++---- ja/api-reference/openapi_knowledge.json | 64 ++++++++++++------------ ja/api-reference/openapi_workflow.json | 18 +++---- zh/api-reference/openapi_chat.json | 38 +++++++------- zh/api-reference/openapi_chatflow.json | 50 +++++++++--------- zh/api-reference/openapi_completion.json | 20 ++++---- zh/api-reference/openapi_knowledge.json | 64 ++++++++++++------------ zh/api-reference/openapi_workflow.json | 18 +++---- 10 files changed, 184 insertions(+), 184 deletions(-) diff --git a/ja/api-reference/openapi_chat.json b/ja/api-reference/openapi_chat.json index 78158ca22..d147b0445 100644 --- a/ja/api-reference/openapi_chat.json +++ b/ja/api-reference/openapi_chat.json @@ -91,7 +91,7 @@ } }, "x-mint": { - "href": "/api-reference/chat/send-chat-message" + "href": "/ja/api-reference/chat/send-chat-message" } } }, @@ -167,7 +167,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-upload" + "href": "/ja/api-reference/files/file-upload" } } }, @@ -210,7 +210,7 @@ } }, "x-mint": { - "href": "/api-reference/end-users/get-end-user" + "href": "/ja/api-reference/end-users/get-end-user" } } }, @@ -356,7 +356,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-preview" + "href": "/ja/api-reference/files/file-preview" } } }, @@ -405,7 +405,7 @@ } }, "x-mint": { - "href": "/api-reference/chat/stop-chat-message-generation" + "href": "/ja/api-reference/chat/stop-chat-message-generation" } } }, @@ -445,7 +445,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/message-feedback" + "href": "/ja/api-reference/feedback/message-feedback" } } }, @@ -478,7 +478,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/get-feedbacks-of-application" + "href": "/ja/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -518,7 +518,7 @@ } }, "x-mint": { - "href": "/api-reference/chat/next-suggested-questions" + "href": "/ja/api-reference/chat/next-suggested-questions" } } }, @@ -564,7 +564,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversation-history-messages" + "href": "/ja/api-reference/conversations/get-conversation-history-messages" } } }, @@ -603,7 +603,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversations" + "href": "/ja/api-reference/conversations/get-conversations" } } }, @@ -645,7 +645,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/delete-conversation" + "href": "/ja/api-reference/conversations/delete-conversation" } } }, @@ -685,7 +685,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/conversation-rename" + "href": "/ja/api-reference/conversations/conversation-rename" } } }, @@ -730,7 +730,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversation-variables" + "href": "/ja/api-reference/conversations/get-conversation-variables" } } }, @@ -765,7 +765,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/speech-to-text" + "href": "/ja/api-reference/tts/speech-to-text" } } }, @@ -815,7 +815,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/text-to-audio" + "href": "/ja/api-reference/tts/text-to-audio" } } }, @@ -839,7 +839,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-basic-information" + "href": "/ja/api-reference/application/get-application-basic-information" } } }, @@ -864,7 +864,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-parameters-information" + "href": "/ja/api-reference/application/get-application-parameters-information" } } }, @@ -889,7 +889,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-meta-information" + "href": "/ja/api-reference/application/get-application-meta-information" } } }, @@ -914,7 +914,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-webapp-settings" + "href": "/ja/api-reference/application/get-application-webapp-settings" } } } diff --git a/ja/api-reference/openapi_chatflow.json b/ja/api-reference/openapi_chatflow.json index 01d6f91f8..f5fa3c386 100644 --- a/ja/api-reference/openapi_chatflow.json +++ b/ja/api-reference/openapi_chatflow.json @@ -91,7 +91,7 @@ } }, "x-mint": { - "href": "/api-reference/chatflow/send-chat-message" + "href": "/ja/api-reference/chatflow/send-chat-message" } } }, @@ -167,7 +167,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-upload" + "href": "/ja/api-reference/files/file-upload" } } }, @@ -210,7 +210,7 @@ } }, "x-mint": { - "href": "/api-reference/end-users/get-end-user" + "href": "/ja/api-reference/end-users/get-end-user" } } }, @@ -356,7 +356,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-preview" + "href": "/ja/api-reference/files/file-preview" } } }, @@ -405,7 +405,7 @@ } }, "x-mint": { - "href": "/api-reference/chatflow/stop-advanced-chat-message-generation" + "href": "/ja/api-reference/chatflow/stop-advanced-chat-message-generation" } } }, @@ -445,7 +445,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/message-feedback" + "href": "/ja/api-reference/feedback/message-feedback" } } }, @@ -478,7 +478,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/get-feedbacks-of-application" + "href": "/ja/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -518,7 +518,7 @@ } }, "x-mint": { - "href": "/api-reference/chatflow/next-suggested-questions" + "href": "/ja/api-reference/chatflow/next-suggested-questions" } } }, @@ -564,7 +564,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversation-history-messages" + "href": "/ja/api-reference/conversations/get-conversation-history-messages" } } }, @@ -603,7 +603,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversations" + "href": "/ja/api-reference/conversations/get-conversations" } } }, @@ -645,7 +645,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/delete-conversation" + "href": "/ja/api-reference/conversations/delete-conversation" } } }, @@ -685,7 +685,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/conversation-rename" + "href": "/ja/api-reference/conversations/conversation-rename" } } }, @@ -727,7 +727,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversation-variables" + "href": "/ja/api-reference/conversations/get-conversation-variables" } } }, @@ -762,7 +762,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/speech-to-text" + "href": "/ja/api-reference/tts/speech-to-text" } } }, @@ -812,7 +812,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/text-to-audio" + "href": "/ja/api-reference/tts/text-to-audio" } } }, @@ -836,7 +836,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-basic-information" + "href": "/ja/api-reference/application/get-application-basic-information" } } }, @@ -861,7 +861,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-parameters-information" + "href": "/ja/api-reference/application/get-application-parameters-information" } } }, @@ -886,7 +886,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-meta-information" + "href": "/ja/api-reference/application/get-application-meta-information" } } }, @@ -911,7 +911,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-webapp-settings" + "href": "/ja/api-reference/application/get-application-webapp-settings" } } } diff --git a/ja/api-reference/openapi_completion.json b/ja/api-reference/openapi_completion.json index 4659b632f..8fe9291de 100644 --- a/ja/api-reference/openapi_completion.json +++ b/ja/api-reference/openapi_completion.json @@ -82,7 +82,7 @@ } }, "x-mint": { - "href": "/api-reference/completion/create-completion-message" + "href": "/ja/api-reference/completion/create-completion-message" } } }, @@ -158,7 +158,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-upload" + "href": "/ja/api-reference/files/file-upload" } } }, @@ -201,7 +201,7 @@ } }, "x-mint": { - "href": "/api-reference/end-users/get-end-user" + "href": "/ja/api-reference/end-users/get-end-user" } } }, @@ -250,7 +250,7 @@ } }, "x-mint": { - "href": "/api-reference/completion/stop-generate" + "href": "/ja/api-reference/completion/stop-generate" } } }, @@ -290,7 +290,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/message-feedback" + "href": "/ja/api-reference/feedback/message-feedback" } } }, @@ -335,7 +335,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/get-feedbacks-of-application" + "href": "/ja/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -385,7 +385,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/text-to-audio" + "href": "/ja/api-reference/tts/text-to-audio" } } }, @@ -409,7 +409,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-basic-information" + "href": "/ja/api-reference/application/get-application-basic-information" } } }, @@ -433,7 +433,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-parameters-information" + "href": "/ja/api-reference/application/get-application-parameters-information" } } }, @@ -457,7 +457,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-webapp-settings" + "href": "/ja/api-reference/application/get-application-webapp-settings" } } } diff --git a/ja/api-reference/openapi_knowledge.json b/ja/api-reference/openapi_knowledge.json index 0184439aa..349c18566 100644 --- a/ja/api-reference/openapi_knowledge.json +++ b/ja/api-reference/openapi_knowledge.json @@ -79,7 +79,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/create-an-empty-knowledge-base" + "href": "/ja/api-reference/datasets/create-an-empty-knowledge-base" } }, "get": { @@ -154,7 +154,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/get-knowledge-base-list" + "href": "/ja/api-reference/datasets/get-knowledge-base-list" } } }, @@ -191,7 +191,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/get-knowledge-base-details" + "href": "/ja/api-reference/datasets/get-knowledge-base-details" } }, "patch": { @@ -239,7 +239,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/update-knowledge-base" + "href": "/ja/api-reference/datasets/update-knowledge-base" } }, "delete": { @@ -267,7 +267,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/delete-a-knowledge-base" + "href": "/ja/api-reference/datasets/delete-a-knowledge-base" } } }, @@ -314,7 +314,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/create-a-document-from-text" + "href": "/ja/api-reference/documents/create-a-document-from-text" } } }, @@ -382,7 +382,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/create-a-document-from-a-file" + "href": "/ja/api-reference/documents/create-a-document-from-a-file" } } }, @@ -439,7 +439,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/update-a-document-with-text" + "href": "/ja/api-reference/documents/update-a-document-with-text" } } }, @@ -508,7 +508,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/update-a-document-with-a-file" + "href": "/ja/api-reference/documents/update-a-document-with-a-file" } } }, @@ -562,7 +562,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/get-document-embedding-status-progress" + "href": "/ja/api-reference/documents/get-document-embedding-status-progress" } } }, @@ -623,7 +623,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/get-document-detail" + "href": "/ja/api-reference/documents/get-document-detail" } }, "delete": { @@ -661,7 +661,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/delete-a-document" + "href": "/ja/api-reference/documents/delete-a-document" } } }, @@ -726,7 +726,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/get-the-document-list-of-a-knowledge-base" + "href": "/ja/api-reference/documents/get-the-document-list-of-a-knowledge-base" } } }, @@ -794,7 +794,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/update-document-status" + "href": "/ja/api-reference/documents/update-document-status" } } }, @@ -851,7 +851,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/add-chunks-to-a-document" + "href": "/ja/api-reference/chunks/add-chunks-to-a-document" } }, "get": { @@ -933,7 +933,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/get-chunks-from-a-document" + "href": "/ja/api-reference/chunks/get-chunks-from-a-document" } } }, @@ -990,7 +990,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/get-a-chunk-details-in-a-document" + "href": "/ja/api-reference/chunks/get-a-chunk-details-in-a-document" } }, "post": { @@ -1055,7 +1055,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/update-a-chunk-in-a-document" + "href": "/ja/api-reference/chunks/update-a-chunk-in-a-document" } }, "delete": { @@ -1103,7 +1103,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/delete-a-chunk-in-a-document" + "href": "/ja/api-reference/chunks/delete-a-chunk-in-a-document" } } }, @@ -1150,7 +1150,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/retrieve-chunks-from-a-knowledge-base-test-retrieval" + "href": "/ja/api-reference/datasets/retrieve-chunks-from-a-knowledge-base-test-retrieval" } } }, @@ -1183,7 +1183,7 @@ } }, "x-mint": { - "href": "/api-reference/models/get-available-embedding-models" + "href": "/ja/api-reference/models/get-available-embedding-models" } } }, @@ -1250,7 +1250,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/create-child-chunk" + "href": "/ja/api-reference/chunks/create-child-chunk" } }, "get": { @@ -1332,7 +1332,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/get-child-chunks" + "href": "/ja/api-reference/chunks/get-child-chunks" } } }, @@ -1409,7 +1409,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/update-child-chunk" + "href": "/ja/api-reference/chunks/update-child-chunk" } }, "delete": { @@ -1467,7 +1467,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/delete-child-chunk" + "href": "/ja/api-reference/chunks/delete-child-chunk" } } }, @@ -1512,7 +1512,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/create-new-knowledge-base-type-tag" + "href": "/ja/api-reference/metadata-tags/create-new-knowledge-base-type-tag" } }, "get": { @@ -1538,7 +1538,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/get-knowledge-base-type-tags" + "href": "/ja/api-reference/metadata-tags/get-knowledge-base-type-tags" } }, "patch": { @@ -1587,7 +1587,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/modify-knowledge-base-type-tag-name" + "href": "/ja/api-reference/metadata-tags/modify-knowledge-base-type-tag-name" } }, "delete": { @@ -1623,7 +1623,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/delete-knowledge-base-type-tag" + "href": "/ja/api-reference/metadata-tags/delete-knowledge-base-type-tag" } } }, @@ -1670,7 +1670,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/bind-dataset-to-knowledge-base-type-tag" + "href": "/ja/api-reference/metadata-tags/bind-dataset-to-knowledge-base-type-tag" } } }, @@ -1714,7 +1714,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/unbind-dataset-and-knowledge-base-type-tag" + "href": "/ja/api-reference/metadata-tags/unbind-dataset-and-knowledge-base-type-tag" } } }, @@ -1771,7 +1771,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/query-tags-bound-to-a-dataset" + "href": "/ja/api-reference/metadata-tags/query-tags-bound-to-a-dataset" } } } diff --git a/ja/api-reference/openapi_workflow.json b/ja/api-reference/openapi_workflow.json index f0ee9676c..cf9c7f004 100644 --- a/ja/api-reference/openapi_workflow.json +++ b/ja/api-reference/openapi_workflow.json @@ -99,7 +99,7 @@ } }, "x-mint": { - "href": "/api-reference/workflow-execution/execute-workflow" + "href": "/ja/api-reference/workflow-execution/execute-workflow" } } }, @@ -139,7 +139,7 @@ } }, "x-mint": { - "href": "/api-reference/workflow-execution/get-workflow-run-detail" + "href": "/ja/api-reference/workflow-execution/get-workflow-run-detail" } } }, @@ -188,7 +188,7 @@ } }, "x-mint": { - "href": "/api-reference/workflow-execution/stop-workflow-task-generation" + "href": "/ja/api-reference/workflow-execution/stop-workflow-task-generation" } } }, @@ -263,7 +263,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-upload-for-workflow" + "href": "/ja/api-reference/files/file-upload-for-workflow" } } }, @@ -306,7 +306,7 @@ } }, "x-mint": { - "href": "/api-reference/end-users/get-end-user" + "href": "/ja/api-reference/end-users/get-end-user" } } }, @@ -373,7 +373,7 @@ } }, "x-mint": { - "href": "/api-reference/workflow-execution/get-workflow-logs" + "href": "/ja/api-reference/workflow-execution/get-workflow-logs" } } }, @@ -397,7 +397,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-basic-information" + "href": "/ja/api-reference/application/get-application-basic-information" } } }, @@ -421,7 +421,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-parameters-information" + "href": "/ja/api-reference/application/get-application-parameters-information" } } }, @@ -445,7 +445,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-webapp-settings" + "href": "/ja/api-reference/application/get-application-webapp-settings" } } } diff --git a/zh/api-reference/openapi_chat.json b/zh/api-reference/openapi_chat.json index 6cbd7e450..33903cc9c 100644 --- a/zh/api-reference/openapi_chat.json +++ b/zh/api-reference/openapi_chat.json @@ -91,7 +91,7 @@ } }, "x-mint": { - "href": "/api-reference/chat/send-chat-message" + "href": "/zh/api-reference/chat/send-chat-message" } } }, @@ -167,7 +167,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-upload" + "href": "/zh/api-reference/files/file-upload" } } }, @@ -210,7 +210,7 @@ } }, "x-mint": { - "href": "/api-reference/end-users/get-end-user" + "href": "/zh/api-reference/end-users/get-end-user" } } }, @@ -356,7 +356,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-preview" + "href": "/zh/api-reference/files/file-preview" } } }, @@ -405,7 +405,7 @@ } }, "x-mint": { - "href": "/api-reference/chat/stop-chat-message-generation" + "href": "/zh/api-reference/chat/stop-chat-message-generation" } } }, @@ -445,7 +445,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/message-feedback" + "href": "/zh/api-reference/feedback/message-feedback" } } }, @@ -478,7 +478,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/get-feedbacks-of-application" + "href": "/zh/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -518,7 +518,7 @@ } }, "x-mint": { - "href": "/api-reference/chat/next-suggested-questions" + "href": "/zh/api-reference/chat/next-suggested-questions" } } }, @@ -564,7 +564,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversation-history-messages" + "href": "/zh/api-reference/conversations/get-conversation-history-messages" } } }, @@ -603,7 +603,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversations" + "href": "/zh/api-reference/conversations/get-conversations" } } }, @@ -645,7 +645,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/delete-conversation" + "href": "/zh/api-reference/conversations/delete-conversation" } } }, @@ -685,7 +685,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/conversation-rename" + "href": "/zh/api-reference/conversations/conversation-rename" } } }, @@ -730,7 +730,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversation-variables" + "href": "/zh/api-reference/conversations/get-conversation-variables" } } }, @@ -765,7 +765,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/speech-to-text" + "href": "/zh/api-reference/tts/speech-to-text" } } }, @@ -815,7 +815,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/text-to-audio" + "href": "/zh/api-reference/tts/text-to-audio" } } }, @@ -839,7 +839,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-basic-information" + "href": "/zh/api-reference/application/get-application-basic-information" } } }, @@ -864,7 +864,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-parameters-information" + "href": "/zh/api-reference/application/get-application-parameters-information" } } }, @@ -889,7 +889,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-meta-information" + "href": "/zh/api-reference/application/get-application-meta-information" } } }, @@ -914,7 +914,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-webapp-settings" + "href": "/zh/api-reference/application/get-application-webapp-settings" } } } diff --git a/zh/api-reference/openapi_chatflow.json b/zh/api-reference/openapi_chatflow.json index 424dce7f2..951b0086d 100644 --- a/zh/api-reference/openapi_chatflow.json +++ b/zh/api-reference/openapi_chatflow.json @@ -91,7 +91,7 @@ } }, "x-mint": { - "href": "/api-reference/chatflow/send-chat-message" + "href": "/zh/api-reference/chatflow/send-chat-message" } } }, @@ -167,7 +167,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-upload" + "href": "/zh/api-reference/files/file-upload" } } }, @@ -210,7 +210,7 @@ } }, "x-mint": { - "href": "/api-reference/end-users/get-end-user" + "href": "/zh/api-reference/end-users/get-end-user" } } }, @@ -356,7 +356,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-preview" + "href": "/zh/api-reference/files/file-preview" } } }, @@ -405,7 +405,7 @@ } }, "x-mint": { - "href": "/api-reference/chatflow/stop-advanced-chat-message-generation" + "href": "/zh/api-reference/chatflow/stop-advanced-chat-message-generation" } } }, @@ -445,7 +445,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/message-feedback" + "href": "/zh/api-reference/feedback/message-feedback" } } }, @@ -478,7 +478,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/get-feedbacks-of-application" + "href": "/zh/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -518,7 +518,7 @@ } }, "x-mint": { - "href": "/api-reference/chatflow/next-suggested-questions" + "href": "/zh/api-reference/chatflow/next-suggested-questions" } } }, @@ -564,7 +564,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversation-history-messages" + "href": "/zh/api-reference/conversations/get-conversation-history-messages" } } }, @@ -603,7 +603,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversations" + "href": "/zh/api-reference/conversations/get-conversations" } } }, @@ -645,7 +645,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/delete-conversation" + "href": "/zh/api-reference/conversations/delete-conversation" } } }, @@ -685,7 +685,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/conversation-rename" + "href": "/zh/api-reference/conversations/conversation-rename" } } }, @@ -727,7 +727,7 @@ } }, "x-mint": { - "href": "/api-reference/conversations/get-conversation-variables" + "href": "/zh/api-reference/conversations/get-conversation-variables" } } }, @@ -762,7 +762,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/speech-to-text" + "href": "/zh/api-reference/tts/speech-to-text" } } }, @@ -812,7 +812,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/text-to-audio" + "href": "/zh/api-reference/tts/text-to-audio" } } }, @@ -836,7 +836,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-basic-information" + "href": "/zh/api-reference/application/get-application-basic-information" } } }, @@ -861,7 +861,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-parameters-information" + "href": "/zh/api-reference/application/get-application-parameters-information" } } }, @@ -886,7 +886,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-meta-information" + "href": "/zh/api-reference/application/get-application-meta-information" } } }, @@ -911,7 +911,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-webapp-settings" + "href": "/zh/api-reference/application/get-application-webapp-settings" } } }, @@ -943,7 +943,7 @@ } }, "x-mint": { - "href": "/api-reference/annotations/get-annotation-list" + "href": "/zh/api-reference/annotations/get-annotation-list" } }, "post": { @@ -985,7 +985,7 @@ } }, "x-mint": { - "href": "/api-reference/annotations/create-annotation" + "href": "/zh/api-reference/annotations/create-annotation" } } }, @@ -1024,7 +1024,7 @@ } }, "x-mint": { - "href": "/api-reference/annotations/update-annotation" + "href": "/zh/api-reference/annotations/update-annotation" } }, "delete": { @@ -1044,7 +1044,7 @@ } }, "x-mint": { - "href": "/api-reference/annotations/delete-annotation" + "href": "/zh/api-reference/annotations/delete-annotation" } } }, @@ -1094,7 +1094,7 @@ } }, "x-mint": { - "href": "/api-reference/annotations/initial-annotation-reply-settings" + "href": "/zh/api-reference/annotations/initial-annotation-reply-settings" } } }, @@ -1126,7 +1126,7 @@ } }, "x-mint": { - "href": "/api-reference/annotations/query-initial-annotation-reply-settings-task-status" + "href": "/zh/api-reference/annotations/query-initial-annotation-reply-settings-task-status" } } } diff --git a/zh/api-reference/openapi_completion.json b/zh/api-reference/openapi_completion.json index d9452cbb8..10e41ffd6 100644 --- a/zh/api-reference/openapi_completion.json +++ b/zh/api-reference/openapi_completion.json @@ -101,7 +101,7 @@ } }, "x-mint": { - "href": "/api-reference/completion/create-completion-message" + "href": "/zh/api-reference/completion/create-completion-message" } } }, @@ -174,7 +174,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-upload" + "href": "/zh/api-reference/files/file-upload" } } }, @@ -231,7 +231,7 @@ } }, "x-mint": { - "href": "/api-reference/end-users/get-end-user" + "href": "/zh/api-reference/end-users/get-end-user" } } }, @@ -280,7 +280,7 @@ } }, "x-mint": { - "href": "/api-reference/completion/stop-generate" + "href": "/zh/api-reference/completion/stop-generate" } } }, @@ -320,7 +320,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/message-feedback" + "href": "/zh/api-reference/feedback/message-feedback" } } }, @@ -353,7 +353,7 @@ } }, "x-mint": { - "href": "/api-reference/feedback/get-feedbacks-of-application" + "href": "/zh/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -406,7 +406,7 @@ } }, "x-mint": { - "href": "/api-reference/tts/text-to-audio" + "href": "/zh/api-reference/tts/text-to-audio" } } }, @@ -431,7 +431,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-basic-information" + "href": "/zh/api-reference/application/get-application-basic-information" } } }, @@ -456,7 +456,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-parameters-information" + "href": "/zh/api-reference/application/get-application-parameters-information" } } }, @@ -481,7 +481,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-webapp-settings" + "href": "/zh/api-reference/application/get-application-webapp-settings" } } }, diff --git a/zh/api-reference/openapi_knowledge.json b/zh/api-reference/openapi_knowledge.json index f356af99b..a8575feb5 100644 --- a/zh/api-reference/openapi_knowledge.json +++ b/zh/api-reference/openapi_knowledge.json @@ -79,7 +79,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/create-an-empty-knowledge-base" + "href": "/zh/api-reference/datasets/create-an-empty-knowledge-base" } }, "get": { @@ -154,7 +154,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/get-knowledge-base-list" + "href": "/zh/api-reference/datasets/get-knowledge-base-list" } } }, @@ -191,7 +191,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/get-knowledge-base-details" + "href": "/zh/api-reference/datasets/get-knowledge-base-details" } }, "patch": { @@ -239,7 +239,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/update-knowledge-base" + "href": "/zh/api-reference/datasets/update-knowledge-base" } }, "delete": { @@ -267,7 +267,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/delete-a-knowledge-base" + "href": "/zh/api-reference/datasets/delete-a-knowledge-base" } } }, @@ -314,7 +314,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/create-a-document-from-text" + "href": "/zh/api-reference/documents/create-a-document-from-text" } } }, @@ -382,7 +382,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/create-a-document-from-a-file" + "href": "/zh/api-reference/documents/create-a-document-from-a-file" } } }, @@ -439,7 +439,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/update-a-document-with-text" + "href": "/zh/api-reference/documents/update-a-document-with-text" } } }, @@ -508,7 +508,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/update-a-document-with-a-file" + "href": "/zh/api-reference/documents/update-a-document-with-a-file" } } }, @@ -562,7 +562,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/get-document-embedding-status-progress" + "href": "/zh/api-reference/documents/get-document-embedding-status-progress" } } }, @@ -623,7 +623,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/get-document-detail" + "href": "/zh/api-reference/documents/get-document-detail" } }, "delete": { @@ -661,7 +661,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/delete-a-document" + "href": "/zh/api-reference/documents/delete-a-document" } } }, @@ -726,7 +726,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/get-the-document-list-of-a-knowledge-base" + "href": "/zh/api-reference/documents/get-the-document-list-of-a-knowledge-base" } } }, @@ -794,7 +794,7 @@ } }, "x-mint": { - "href": "/api-reference/documents/update-document-status" + "href": "/zh/api-reference/documents/update-document-status" } } }, @@ -851,7 +851,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/add-chunks-to-a-document" + "href": "/zh/api-reference/chunks/add-chunks-to-a-document" } }, "get": { @@ -933,7 +933,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/get-chunks-from-a-document" + "href": "/zh/api-reference/chunks/get-chunks-from-a-document" } } }, @@ -990,7 +990,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/get-a-chunk-details-in-a-document" + "href": "/zh/api-reference/chunks/get-a-chunk-details-in-a-document" } }, "post": { @@ -1055,7 +1055,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/update-a-chunk-in-a-document" + "href": "/zh/api-reference/chunks/update-a-chunk-in-a-document" } }, "delete": { @@ -1103,7 +1103,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/delete-a-chunk-in-a-document" + "href": "/zh/api-reference/chunks/delete-a-chunk-in-a-document" } } }, @@ -1150,7 +1150,7 @@ } }, "x-mint": { - "href": "/api-reference/datasets/retrieve-chunks-from-a-knowledge-base-test-retrieval" + "href": "/zh/api-reference/datasets/retrieve-chunks-from-a-knowledge-base-test-retrieval" } } }, @@ -1183,7 +1183,7 @@ } }, "x-mint": { - "href": "/api-reference/models/get-available-embedding-models" + "href": "/zh/api-reference/models/get-available-embedding-models" } } }, @@ -1250,7 +1250,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/create-child-chunk" + "href": "/zh/api-reference/chunks/create-child-chunk" } }, "get": { @@ -1332,7 +1332,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/get-child-chunks" + "href": "/zh/api-reference/chunks/get-child-chunks" } } }, @@ -1409,7 +1409,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/update-child-chunk" + "href": "/zh/api-reference/chunks/update-child-chunk" } }, "delete": { @@ -1467,7 +1467,7 @@ } }, "x-mint": { - "href": "/api-reference/chunks/delete-child-chunk" + "href": "/zh/api-reference/chunks/delete-child-chunk" } } }, @@ -1512,7 +1512,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/create-new-knowledge-base-type-tag" + "href": "/zh/api-reference/metadata-tags/create-new-knowledge-base-type-tag" } }, "get": { @@ -1538,7 +1538,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/get-knowledge-base-type-tags" + "href": "/zh/api-reference/metadata-tags/get-knowledge-base-type-tags" } }, "patch": { @@ -1587,7 +1587,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/modify-knowledge-base-type-tag-name" + "href": "/zh/api-reference/metadata-tags/modify-knowledge-base-type-tag-name" } }, "delete": { @@ -1623,7 +1623,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/delete-knowledge-base-type-tag" + "href": "/zh/api-reference/metadata-tags/delete-knowledge-base-type-tag" } } }, @@ -1670,7 +1670,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/bind-dataset-to-knowledge-base-type-tag" + "href": "/zh/api-reference/metadata-tags/bind-dataset-to-knowledge-base-type-tag" } } }, @@ -1714,7 +1714,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/unbind-dataset-and-knowledge-base-type-tag" + "href": "/zh/api-reference/metadata-tags/unbind-dataset-and-knowledge-base-type-tag" } } }, @@ -1771,7 +1771,7 @@ } }, "x-mint": { - "href": "/api-reference/metadata-tags/query-tags-bound-to-a-dataset" + "href": "/zh/api-reference/metadata-tags/query-tags-bound-to-a-dataset" } } } diff --git a/zh/api-reference/openapi_workflow.json b/zh/api-reference/openapi_workflow.json index 1ae28be5e..e247c6eb0 100644 --- a/zh/api-reference/openapi_workflow.json +++ b/zh/api-reference/openapi_workflow.json @@ -99,7 +99,7 @@ } }, "x-mint": { - "href": "/api-reference/workflow-execution/execute-workflow" + "href": "/zh/api-reference/workflow-execution/execute-workflow" } } }, @@ -139,7 +139,7 @@ } }, "x-mint": { - "href": "/api-reference/workflow-execution/get-workflow-run-detail" + "href": "/zh/api-reference/workflow-execution/get-workflow-run-detail" } } }, @@ -188,7 +188,7 @@ } }, "x-mint": { - "href": "/api-reference/workflow-execution/stop-workflow-task-generation" + "href": "/zh/api-reference/workflow-execution/stop-workflow-task-generation" } } }, @@ -263,7 +263,7 @@ } }, "x-mint": { - "href": "/api-reference/files/file-upload-for-workflow" + "href": "/zh/api-reference/files/file-upload-for-workflow" } } }, @@ -306,7 +306,7 @@ } }, "x-mint": { - "href": "/api-reference/end-users/get-end-user" + "href": "/zh/api-reference/end-users/get-end-user" } } }, @@ -373,7 +373,7 @@ } }, "x-mint": { - "href": "/api-reference/workflow-execution/get-workflow-logs" + "href": "/zh/api-reference/workflow-execution/get-workflow-logs" } } }, @@ -397,7 +397,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-basic-information" + "href": "/zh/api-reference/application/get-application-basic-information" } } }, @@ -421,7 +421,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-parameters-information" + "href": "/zh/api-reference/application/get-application-parameters-information" } } }, @@ -445,7 +445,7 @@ } }, "x-mint": { - "href": "/api-reference/application/get-application-webapp-settings" + "href": "/zh/api-reference/application/get-application-webapp-settings" } } } From 2fa1b9412ae44365ec2218a3488731fc4d967ad7 Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Fri, 13 Mar 2026 17:47:05 +0800 Subject: [PATCH 09/10] revert: remove all API spec changes (x-mint href, operationId, tag alignment) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit These changes are breaking and need careful coordination with the dev team before implementation. Only the navigation restructure (versions>languages → languages>versions) is kept for this PR. Co-Authored-By: Claude Opus 4.6 --- ja/api-reference/openapi_chat.json | 2601 ++---------------- ja/api-reference/openapi_chatflow.json | 2680 ++----------------- ja/api-reference/openapi_completion.json | 1512 +---------- ja/api-reference/openapi_knowledge.json | 96 - ja/api-reference/openapi_workflow.json | 1749 ++----------- zh/api-reference/openapi_chat.json | 2412 ++--------------- zh/api-reference/openapi_chatflow.json | 3052 ++-------------------- zh/api-reference/openapi_completion.json | 1774 ++----------- zh/api-reference/openapi_knowledge.json | 96 - zh/api-reference/openapi_workflow.json | 1739 ++---------- 10 files changed, 1642 insertions(+), 16069 deletions(-) diff --git a/ja/api-reference/openapi_chat.json b/ja/api-reference/openapi_chat.json index d147b0445..ee41edfa1 100644 --- a/ja/api-reference/openapi_chat.json +++ b/ja/api-reference/openapi_chat.json @@ -28,9 +28,7 @@ "summary": "チャットメッセージを送信", "description": "チャットアプリケーションにリクエストを送信します。", "operationId": "sendBasicChatMessageJa", - "tags": [ - "チャットメッセージ" - ], + "tags": ["チャットメッセージ"], "requestBody": { "description": "チャットメッセージ送信リクエストボディ。", "required": true, @@ -80,18 +78,9 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequestGenericJa" - }, - "404": { - "$ref": "#/components/responses/ConversationNotFoundJa" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJa" - } - }, - "x-mint": { - "href": "/ja/api-reference/chat/send-chat-message" + "400": { "$ref": "#/components/responses/BadRequestGenericJa" }, + "404": { "$ref": "#/components/responses/ConversationNotFoundJa" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJa" } } } }, @@ -100,9 +89,7 @@ "summary": "ファイルアップロード", "description": "メッセージ送信時に使用するためのファイルをアップロードします（現在は画像のみサポート）。画像とテキストのマルチモーダル理解を可能にします。png、jpg、jpeg、webp、gif形式をサポートしています。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", "operationId": "uploadBasicChatFileJa", - "tags": [ - "ファイル操作" - ], + "tags": ["ファイル操作"], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data`リクエストが必要です。", "required": true, @@ -110,64 +97,23 @@ "multipart/form-data": { "schema": { "type": "object", - "required": [ - "file", - "user" - ], + "required": ["file", "user"], "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "アップロードするファイル。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" - } + "file": { "type": "string", "format": "binary", "description": "アップロードするファイル。" }, + "user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } } } } } }, "responses": { - "200": { - "description": "ファイルアップロード成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseJa" - } - } - } - }, - "201": { - "description": "ファイル作成成功（代替成功コード）。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseJa" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequestFileJa" - }, - "413": { - "$ref": "#/components/responses/FileTooLargeJa" - }, - "415": { - "$ref": "#/components/responses/UnsupportedFileTypeFileJa" - }, - "503": { - "$ref": "#/components/responses/S3ErrorFileJa" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJa" - } - }, - "x-mint": { - "href": "/ja/api-reference/files/file-upload" + "200": { "description": "ファイルアップロード成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJa" } } } }, + "201": { "description": "ファイル作成成功（代替成功コード）。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJa" } } } }, + "400": { "$ref": "#/components/responses/BadRequestFileJa" }, + "413": { "$ref": "#/components/responses/FileTooLargeJa" }, + "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileJa" }, + "503": { "$ref": "#/components/responses/S3ErrorFileJa" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJa" } } } }, @@ -176,19 +122,14 @@ "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", "operationId": "getEndUserChatJa", - "tags": [ - "エンドユーザー" - ], + "tags": ["エンドユーザー"], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "エンドユーザーID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -196,21 +137,12 @@ "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/EndUserDetailJa" - } + "schema": { "$ref": "#/components/schemas/EndUserDetailJa" } } } }, - "404": { - "$ref": "#/components/responses/EndUserNotFoundJa" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJa" - } - }, - "x-mint": { - "href": "/ja/api-reference/end-users/get-end-user" + "404": { "$ref": "#/components/responses/EndUserNotFoundJa" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJa" } } } }, @@ -219,9 +151,7 @@ "summary": "ファイルプレビュー", "description": "アップロードされたファイルのプレビューまたはダウンロード。このエンドポイントは、ファイルアップロードAPIを通じて事前にアップロードされたファイルにアクセスすることができます。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセス可能です。", "operationId": "previewBasicChatFileJa", - "tags": [ - "ファイル操作" - ], + "tags": ["ファイル操作"], "parameters": [ { "name": "file_id", @@ -318,9 +248,7 @@ "description": "不正なリクエスト。可能なエラーコード:\n- `invalid_param`: 異常なパラメータ入力。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, @@ -328,9 +256,7 @@ "description": "禁止。可能なエラーコード:\n- `file_access_denied`: ファイルアクセス拒否またはファイルが現在のアプリケーションに属していません。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, @@ -338,9 +264,7 @@ "description": "見つかりません。可能なエラーコード:\n- `file_not_found`: ファイルが見つからないか削除されています。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, @@ -348,15 +272,10 @@ "description": "内部サーバーエラー。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } } - }, - "x-mint": { - "href": "/ja/api-reference/files/file-preview" } } }, @@ -365,48 +284,10 @@ "summary": "生成停止", "description": "チャットメッセージの生成を停止します。ストリーミングモードでのみサポートされています。", "operationId": "stopBasicChatMessageGenerationJa", - "tags": [ - "チャットメッセージ" - ], - "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "description": "タスクID、ストリーミングチャンクの返り値から取得できます。", - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "user": { - "type": "string", - "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" - } - } - } - } - } - }, - "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultJa" - } - }, - "x-mint": { - "href": "/ja/api-reference/chat/stop-chat-message-generation" - } + "tags": ["チャットメッセージ"], + "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "タスクID、ストリーミングチャンクの返り値から取得できます。", "schema": { "type": "string", "format": "uuid" } } ], + "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致している必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } } } } } }, + "responses": { "200": { "$ref": "#/components/responses/SuccessResultJa" } } } }, "/messages/{message_id}/feedbacks": { @@ -414,39 +295,10 @@ "summary": "メッセージフィードバック", "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。", "operationId": "postBasicChatMessageFeedbackJa", - "tags": [ - "メッセージフィードバック" - ], - "parameters": [ - { - "name": "message_id", - "in": "path", - "required": true, - "description": "メッセージID。", - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MessageFeedbackRequestJa" - } - } - } - }, - "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultJa" - } - }, - "x-mint": { - "href": "/ja/api-reference/feedback/message-feedback" - } + "tags": ["メッセージフィードバック"], + "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", "schema": { "type": "string", "format": "uuid" } } ], + "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestJa" } } } }, + "responses": { "200": { "$ref": "#/components/responses/SuccessResultJa" } } } }, "/app/feedbacks": { @@ -454,32 +306,9 @@ "summary": "アプリのメッセージの「いいね」とフィードバックを取得", "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", "operationId": "getBasicChatAppFeedbacksJa", - "tags": [ - "メッセージフィードバック" - ], - "parameters": [ - { - "$ref": "#/components/parameters/PageQueryParamJa" - }, - { - "$ref": "#/components/parameters/LimitQueryParamJa" - } - ], - "responses": { - "200": { - "description": "アプリのフィードバックリストを正常に取得しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFeedbacksResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/feedback/get-feedbacks-of-application" - } + "tags": ["メッセージフィードバック"], + "parameters": [ { "$ref": "#/components/parameters/PageQueryParamJa" }, { "$ref": "#/components/parameters/LimitQueryParamJa" } ], + "responses": { "200": { "description": "アプリのフィードバックリストを正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseJa" } } } } } } }, "/messages/{message_id}/suggested": { @@ -487,39 +316,9 @@ "summary": "次の推奨質問", "description": "現在のメッセージに対する次の質問の提案を取得します。", "operationId": "getBasicChatSuggestedQuestionsJa", - "tags": [ - "チャットメッセージ" - ], - "parameters": [ - { - "name": "message_id", - "in": "path", - "required": true, - "description": "メッセージID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - { - "$ref": "#/components/parameters/UserQueryParamJa" - } - ], - "responses": { - "200": { - "description": "推奨質問リストを正常に取得しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SuggestedQuestionsResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/chat/next-suggested-questions" - } + "tags": ["チャットメッセージ"], + "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/UserQueryParamJa" } ], + "responses": { "200": { "description": "推奨質問リストを正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuggestedQuestionsResponseJa" } } } } } } }, "/messages": { @@ -527,45 +326,9 @@ "summary": "会話履歴メッセージを取得", "description": "スクロールロード形式で過去のチャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", "operationId": "getBasicChatConversationHistoryJa", - "tags": [ - "会話管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdQueryParamJa" - }, - { - "$ref": "#/components/parameters/UserQueryParamJa" - }, - { - "name": "first_id", - "in": "query", - "description": "現在のページの最初のチャット記録のID、デフォルトはnullです。", - "schema": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Ja" - } - ], - "responses": { - "200": { - "description": "会話履歴メッセージを正常に取得しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicConversationHistoryResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/get-conversation-history-messages" - } + "tags": ["会話管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdQueryParamJa" }, { "$ref": "#/components/parameters/UserQueryParamJa" }, { "name": "first_id", "in": "query", "description": "現在のページの最初のチャット記録のID、デフォルトはnullです。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, { "$ref": "#/components/parameters/LimitQueryParamDefault20Ja" } ], + "responses": { "200": { "description": "会話履歴メッセージを正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasicConversationHistoryResponseJa" } } } } } } }, "/conversations": { @@ -573,38 +336,9 @@ "summary": "会話を取得", "description": "現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。", "operationId": "getBasicChatConversationsListJa", - "tags": [ - "会話管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/UserQueryParamJa" - }, - { - "$ref": "#/components/parameters/LastIdQueryParamJa" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Ja" - }, - { - "$ref": "#/components/parameters/SortByQueryParamJa" - } - ], - "responses": { - "200": { - "description": "会話リストを正常に取得しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationsListResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/get-conversations" - } + "tags": ["会話管理"], + "parameters": [ { "$ref": "#/components/parameters/UserQueryParamJa" }, { "$ref": "#/components/parameters/LastIdQueryParamJa" }, { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Ja" }, { "$ref": "#/components/parameters/SortByQueryParamJa" } ], + "responses": { "200": { "description": "会話リストを正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationsListResponseJa" } } } } } } }, "/conversations/{conversation_id}": { @@ -612,41 +346,10 @@ "summary": "会話を削除", "description": "指定された会話を削除します。", "operationId": "deleteBasicChatConversationJa", - "tags": [ - "会話管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamJa" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "user": { - "type": "string", - "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "会話の削除に成功しました。コンテンツはありません。" - } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/delete-conversation" - } + "tags": ["会話管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJa" } ], + "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } } } } } }, + "responses": { "204": { "description": "会話の削除に成功しました。コンテンツはありません。" } } } }, "/conversations/{conversation_id}/name": { @@ -654,84 +357,20 @@ "summary": "会話の名前を変更", "description": "セッションの名前を変更します。セッション名は、複数のセッションをサポートするクライアントでの表示に使用されます。", "operationId": "renameBasicChatConversationJa", - "tags": [ - "会話管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamJa" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationRenameRequestJa" - } - } - } - }, - "responses": { - "200": { - "description": "会話の名前変更に成功しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationRenameResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/conversation-rename" - } + "tags": ["会話管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJa" } ], + "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameRequestJa" } } } }, + "responses": { "200": { "description": "会話の名前変更に成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameResponseJa" } } } } } } }, - "/conversations/{conversation_id}/variables": { + "/conversations/{conversation_id}/variables": { "get": { "summary": "会話変数の取得", "description": "特定の会話から変数を取得します。このエンドポイントは、会話中に取得された構造化データを抽出するのに役立ちます。", "operationId": "getBasicChatConversationVariablesJa", - "tags": [ - "会話管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamJa" - }, - { - "$ref": "#/components/parameters/UserQueryParamJa" - }, - { - "$ref": "#/components/parameters/LastIdQueryParamJa" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Ja" - }, - { - "$ref": "#/components/parameters/VariableNameQueryParamJa" - } - ], - "responses": { - "200": { - "description": "会話変数を正常に取得しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationVariablesResponseJa" - } - } - } - }, - "404": { - "$ref": "#/components/responses/ConversationNotFoundJa" - } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/get-conversation-variables" - } + "tags": ["会話管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJa" }, { "$ref": "#/components/parameters/UserQueryParamJa" }, { "$ref": "#/components/parameters/LastIdQueryParamJa" }, { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Ja" }, { "$ref": "#/components/parameters/VariableNameQueryParamJa" } ], + "responses": { "200": { "description": "会話変数を正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationVariablesResponseJa" } } } }, "404": { "$ref": "#/components/responses/ConversationNotFoundJa" } } } }, "/audio-to-text": { @@ -739,34 +378,9 @@ "summary": "音声からテキストへ", "description": "オーディオファイルをテキストに変換します。サポートされている形式：mp3, mp4, mpeg, mpga, m4a, wav, webm。ファイルサイズ制限：15MB。", "operationId": "basicChatAudioToTextJa", - "tags": [ - "音声とテキスト変換" - ], - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AudioToTextRequestJa" - } - } - } - }, - "responses": { - "200": { - "description": "音声からテキストへの変換に成功しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AudioToTextResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/tts/speech-to-text" - } + "tags": ["音声とテキスト変換"], + "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioToTextRequestJa" } } } }, + "responses": { "200": { "description": "音声からテキストへの変換に成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioToTextResponseJa" } } } } } } }, "/text-to-audio": { @@ -774,73 +388,17 @@ "summary": "テキストから音声へ", "description": "テキストコンテンツを音声に変換します。", "operationId": "basicChatTextToAudioJa", - "tags": [ - "音声とテキスト変換" - ], - "requestBody": { - "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/TextToAudioFormRequestJa" - } - } - } - }, - "responses": { - "200": { - "description": "音声ファイルの生成に成功しました。", - "content": { - "audio/wav": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "audio/mp3": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "headers": { - "Content-Type": { - "schema": { - "type": "string", - "example": "audio/wav" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/tts/text-to-audio" - } + "tags": ["音声とテキスト変換"], + "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TextToAudioFormRequestJa" } } } }, + "responses": { "200": { "description": "音声ファイルの生成に成功しました。", "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } } } } }, "/info": { "get": { "summary": "アプリケーションの基本情報を取得", "operationId": "getBasicChatAppInfoJa", - "tags": [ - "アプリケーション設定" - ], - "responses": { - "200": { - "description": "アプリケーションの基本情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfoResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-basic-information" - } + "tags": ["アプリケーション設定"], + "responses": { "200": { "description": "アプリケーションの基本情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseJa" } } } } } } }, "/parameters": { @@ -848,24 +406,8 @@ "summary": "アプリケーションのパラメータ情報を取得", "description": "ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。", "operationId": "getBasicChatAppParametersJa", - "tags": [ - "アプリケーション設定" - ], - "responses": { - "200": { - "description": "アプリケーションのパラメータ情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicChatAppParametersResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-parameters-information" - } + "tags": ["アプリケーション設定"], + "responses": { "200": { "description": "アプリケーションのパラメータ情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasicChatAppParametersResponseJa" } } } } } } }, "/meta": { @@ -873,24 +415,8 @@ "summary": "アプリケーションのメタ情報を取得", "description": "このアプリケーションのツールのアイコンを取得するために使用されます。", "operationId": "getBasicChatAppMetaJa", - "tags": [ - "アプリケーション設定" - ], - "responses": { - "200": { - "description": "アプリケーションのメタ情報を正常に取得しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppMetaResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-meta-information" - } + "tags": ["アプリケーション設定"], + "responses": { "200": { "description": "アプリケーションのメタ情報を正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMetaResponseJa" } } } } } } }, "/site": { @@ -898,1884 +424,213 @@ "summary": "アプリのWebApp設定を取得", "description": "アプリのWebApp設定を取得するために使用します。", "operationId": "getBasicChatWebAppSettingsJa", - "tags": [ - "アプリケーション設定" - ], - "responses": { - "200": { - "description": "WebApp設定。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebAppSettingsResponseJa" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-webapp-settings" - } + "tags": ["アプリケーション設定"], + "responses": { "200": { "description": "WebApp設定。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseJa" } } } } } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "API_KEY", - "description": "APIキー認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください。形式：Bearer {API_KEY}。APIキーの漏洩を防ぐため、APIキーはクライアント側で共有または保存せず、サーバー側で保存することを強くお勧めします。" - } + "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "APIキー認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください。形式：Bearer {API_KEY}。APIキーの漏洩を防ぐため、APIキーはクライアント側で共有または保存せず、サーバー側で保存することを強くお勧めします。" } }, "parameters": { - "PageQueryParamJa": { - "name": "page", - "in": "query", - "description": "（任意）ページ番号。デフォルト値：1。", - "schema": { - "type": "integer", - "default": 1 - } - }, - "LimitQueryParamJa": { - "name": "limit", - "in": "query", - "description": "（任意）1ページあたりの件数。デフォルト値：20。", - "schema": { - "type": "integer", - "default": 20 - } - }, - "LimitQueryParamDefault20Ja": { - "name": "limit", - "in": "query", - "description": "1回のリクエストで返すレコードの数、デフォルトは20です。", - "schema": { - "type": "integer", - "default": 20 - } - }, - "LimitQueryParamDefault20Max100Ja": { - "name": "limit", - "in": "query", - "description": "1回のリクエストで返すレコードの数、デフォルトは20件です。最大100、最小1。", - "schema": { - "type": "integer", - "default": 20, - "minimum": 1, - "maximum": 100 - } - }, - "UserQueryParamJa": { - "name": "user", - "in": "query", - "required": true, - "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義される必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", - "schema": { - "type": "string" - } - }, - "ConversationIdQueryParamJa": { - "name": "conversation_id", - "in": "query", - "required": true, - "description": "会話ID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - "LastIdQueryParamJa": { - "name": "last_id", - "in": "query", - "description": "(Optional)現在のページの最後のレコードのID、デフォルトはnullです。", - "schema": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "SortByQueryParamJa": { - "name": "sort_by", - "in": "query", - "description": "(Optional)ソートフィールド、デフォルト：-updated_at（更新時間で降順にソート）。利用可能な値：created_at, -created_at, updated_at, -updated_at。フィールドの前の記号「-」は逆順を表します。", - "schema": { - "type": "string", - "enum": [ - "created_at", - "-created_at", - "updated_at", - "-updated_at" - ], - "default": "-updated_at" - } - }, - "ConversationIdPathParamJa": { - "name": "conversation_id", - "in": "path", - "required": true, - "description": "会話ID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - "VariableNameQueryParamJa": { - "name": "variable_name", - "in": "query", - "description": "(Optional)変数名でフィルタリングします。", - "schema": { - "type": "string" - } - } + "PageQueryParamJa": { "name": "page", "in": "query", "description": "（任意）ページ番号。デフォルト値：1。", "schema": { "type": "integer", "default": 1 } }, + "LimitQueryParamJa": { "name": "limit", "in": "query", "description": "（任意）1ページあたりの件数。デフォルト値：20。", "schema": { "type": "integer", "default": 20 } }, + "LimitQueryParamDefault20Ja": { "name": "limit", "in": "query", "description": "1回のリクエストで返すレコードの数、デフォルトは20です。", "schema": { "type": "integer", "default": 20 } }, + "LimitQueryParamDefault20Max100Ja": { "name": "limit", "in": "query", "description": "1回のリクエストで返すレコードの数、デフォルトは20件です。最大100、最小1。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, + "UserQueryParamJa": { "name": "user", "in": "query", "required": true, "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義される必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", "schema": { "type": "string" } }, + "ConversationIdQueryParamJa": { "name": "conversation_id", "in": "query", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } }, + "LastIdQueryParamJa": { "name": "last_id", "in": "query", "description": "(Optional)現在のページの最後のレコードのID、デフォルトはnullです。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, + "SortByQueryParamJa": { "name": "sort_by", "in": "query", "description": "(Optional)ソートフィールド、デフォルト：-updated_at（更新時間で降順にソート）。利用可能な値：created_at, -created_at, updated_at, -updated_at。フィールドの前の記号「-」は逆順を表します。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } }, + "ConversationIdPathParamJa": { "name": "conversation_id", "in": "path", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } }, + "VariableNameQueryParamJa": { "name": "variable_name", "in": "query", "description": "(Optional)変数名でフィルタリングします。", "schema": { "type": "string" } } }, "responses": { - "BadRequestGenericJa": { - "description": "リクエストパラメータエラー。考えられる原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } - } - } - }, - "BadRequestFileJa": { - "description": "ファイル操作リクエストエラー。考えられる原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } - } - } - }, - "FileTooLargeJa": { - "description": "ファイルが大きすぎます (file_too_large)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } - } - } - }, - "UnsupportedFileTypeFileJa": { - "description": "サポートされていないファイルタイプ (unsupported_file_type)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } - } - } - }, - "S3ErrorFileJa": { - "description": "S3ストレージサービスエラー。考えられる原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } - } - } - }, - "InternalServerErrorJa": { - "description": "内部サーバーエラー。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } - } - } - }, - "SuccessResultJa": { - "description": "操作成功。", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - } - } - } - } - } - }, - "ConversationNotFoundJa": { - "description": "会話が存在しません。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } - } - } - }, - "EndUserNotFoundJa": { - "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJa" - } - } - } - } + "BadRequestGenericJa": { "description": "リクエストパラメータエラー。考えられる原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, + "BadRequestFileJa": { "description": "ファイル操作リクエストエラー。考えられる原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, + "FileTooLargeJa": { "description": "ファイルが大きすぎます (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, + "UnsupportedFileTypeFileJa": { "description": "サポートされていないファイルタイプ (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, + "S3ErrorFileJa": { "description": "S3ストレージサービスエラー。考えられる原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, + "InternalServerErrorJa": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, + "SuccessResultJa": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, + "ConversationNotFoundJa": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }, + "EndUserNotFoundJa": { "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } } }, "schemas": { "BasicChatRequestJa": { - "type": "object", - "required": [ - "query", - "user" - ], + "type": "object", "required": ["query", "user"], "properties": { - "query": { - "type": "string", - "description": "ユーザー入力/質問内容。" - }, - "inputs": { - "type": "object", - "description": "アプリで定義されたさまざまな変数値の入力を許可します。デフォルトは`{}`。", - "additionalProperties": true, - "default": {} - }, - "response_mode": { - "type": "string", - "enum": [ - "streaming", - "blocking" - ], - "default": "streaming", - "description": "応答の返却モード。streaming（推奨）はSSEベース。blockingは実行完了後に結果を返します（Cloudflareの100秒タイムアウト制限あり；エージェントアシスタントモードではサポートされていません）。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子、アプリケーション内で一意である必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID、以前のチャット記録に基づいて会話を続けるには、前のメッセージのconversation_idを渡す必要があります。" - }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BasicInputFileObjectJa" - }, - "description": "アップロードされたファイルリスト。現在は画像タイプのみサポート。" - }, - "auto_generate_name": { - "type": "boolean", - "default": true, - "description": "タイトルを自動生成します。デフォルトは`true`です。" - } + "query": { "type": "string", "description": "ユーザー入力/質問内容。" }, + "inputs": { "type": "object", "description": "アプリで定義されたさまざまな変数値の入力を許可します。デフォルトは`{}`。", "additionalProperties": true, "default": {} }, + "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "応答の返却モード。streaming（推奨）はSSEベース。blockingは実行完了後に結果を返します（Cloudflareの100秒タイムアウト制限あり；エージェントアシスタントモードではサポートされていません）。" }, + "user": { "type": "string", "description": "ユーザー識別子、アプリケーション内で一意である必要があります。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID、以前のチャット記録に基づいて会話を続けるには、前のメッセージのconversation_idを渡す必要があります。" }, + "files": { "type": "array", "items": { "$ref": "#/components/schemas/BasicInputFileObjectJa" }, "description": "アップロードされたファイルリスト。現在は画像タイプのみサポート。" }, + "auto_generate_name": { "type": "boolean", "default": true, "description": "タイトルを自動生成します。デフォルトは`true`です。" } } }, "BasicInputFileObjectJa": { - "type": "object", - "required": [ - "type", - "transfer_method" - ], + "type": "object", "required": ["type", "transfer_method"], "properties": { - "type": { - "type": "string", - "enum": [ - "image" - ], - "description": "サポートされているタイプ：`image`（現在は画像タイプのみサポート）。" - }, - "transfer_method": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ], - "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" - }, - "url": { - "type": "string", - "format": "url", - "description": "画像URL（転送方法が remote_url の場合）" - }, - "upload_file_id": { - "type": "string", - "format": "uuid", - "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" - } + "type": { "type": "string", "enum": ["image"], "description": "サポートされているタイプ：`image`（現在は画像タイプのみサポート）。" }, + "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" }, + "url": { "type": "string", "format": "url", "description": "画像URL（転送方法が remote_url の場合）" }, + "upload_file_id": { "type": "string", "format":"uuid", "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" } }, "anyOf": [ { - "properties": { - "transfer_method": { - "enum": [ - "remote_url" - ] - }, - "url": { - "type": "string", - "format": "url" - } + "properties": { + "transfer_method": { "enum": ["remote_url"] }, + "url": { "type": "string", "format": "url" } }, - "required": [ - "url" - ], - "not": { - "required": [ - "upload_file_id" - ] - } + "required": ["url"], + "not": { "required": ["upload_file_id"] } }, { - "properties": { - "transfer_method": { - "enum": [ - "local_file" - ] - }, - "upload_file_id": { - "type": "string", - "format": "uuid" - } + "properties": { + "transfer_method": { "enum": ["local_file"] }, + "upload_file_id": { "type": "string", "format":"uuid" } }, - "required": [ - "upload_file_id" - ], - "not": { - "required": [ - "url" - ] - } + "required": ["upload_file_id"], + "not": { "required": ["url"] } } ] }, "ChatCompletionResponseJa": { - "type": "object", - "description": "ブロッキングモードでの完全なアプリ結果。", + "type": "object", "description": "ブロッキングモードでの完全なアプリ結果。", "properties": { - "event": { - "type": "string", - "example": "message", - "description": "イベントタイプ、固定で `message`。" - }, - "task_id": { - "type": "string", - "format": "uuid", - "description": "タスクID。" - }, - "id": { - "type": "string", - "format": "uuid", - "description": "ユニークID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - }, - "mode": { - "type": "string", - "example": "chat", - "description": "アプリモード、`chat`として固定。" - }, - "answer": { - "type": "string", - "description": "完全な応答内容。" - }, - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataJa" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "メッセージ作成タイムスタンプ。" - } + "event": { "type": "string", "example": "message", "description": "イベントタイプ、固定で `message`。" }, + "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, + "id": { "type": "string", "format": "uuid", "description": "ユニークID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, + "mode": { "type": "string", "example": "chat", "description": "アプリモード、`chat`として固定。" }, + "answer": { "type": "string", "description": "完全な応答内容。" }, + "metadata": { "$ref": "#/components/schemas/ResponseMetadataJa" }, + "created_at": { "type": "integer", "format": "int64", "description": "メッセージ作成タイムスタンプ。" } } }, "ResponseMetadataJa": { - "type": "object", - "description": "メタデータ。", - "properties": { - "usage": { - "$ref": "#/components/schemas/UsageJa" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResourceJa" - }, - "description": "引用と帰属リスト。" - } - } + "type": "object", "description": "メタデータ。", + "properties": { "usage": { "$ref": "#/components/schemas/UsageJa" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJa" }, "description": "引用と帰属リスト。" } } }, "ChunkBasicChatEventJa": { - "type": "object", - "required": [ - "event" - ], - "properties": { - "event": { - "type": "string", - "enum": [ - "message", - "agent_message", - "agent_thought", - "message_file", - "message_end", - "tts_message", - "tts_message_end", - "message_replace", - "error", - "ping" - ], - "description": "イベントタイプ。" - } - }, - "discriminator": { - "propertyName": "event", - "mapping": { - "message": "#/components/schemas/StreamEventChatMessageJa", - "agent_message": "#/components/schemas/StreamEventAgentMessageJa", - "agent_thought": "#/components/schemas/StreamEventAgentThoughtJa", - "message_file": "#/components/schemas/StreamEventMessageFileJa", - "message_end": "#/components/schemas/StreamEventMessageEndJa", - "tts_message": "#/components/schemas/StreamEventTtsMessageJa", - "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJa", - "message_replace": "#/components/schemas/StreamEventMessageReplaceJa", - "error": "#/components/schemas/StreamEventErrorJa", - "ping": "#/components/schemas/StreamEventPingJa" - } - } + "type": "object", "required": ["event"], + "properties": { "event": { "type": "string", "enum": ["message", "agent_message", "agent_thought", "message_file", "message_end", "tts_message", "tts_message_end", "message_replace", "error", "ping"], "description": "イベントタイプ。" } }, + "discriminator": { "propertyName": "event", "mapping": { + "message": "#/components/schemas/StreamEventChatMessageJa", "agent_message": "#/components/schemas/StreamEventAgentMessageJa", + "agent_thought": "#/components/schemas/StreamEventAgentThoughtJa", "message_file": "#/components/schemas/StreamEventMessageFileJa", + "message_end": "#/components/schemas/StreamEventMessageEndJa", "tts_message": "#/components/schemas/StreamEventTtsMessageJa", + "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJa", "message_replace": "#/components/schemas/StreamEventMessageReplaceJa", + "error": "#/components/schemas/StreamEventErrorJa", "ping": "#/components/schemas/StreamEventPingJa" + }} }, "StreamEventBaseChatJa": { - "type": "object", - "properties": { - "task_id": { - "type": "string", - "format": "uuid", - "description": "タスクID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } + "type": "object", "properties": { + "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, + "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, - "StreamEventChatMessageJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJa" - }, - { - "type": "object", - "required": [ - "answer" - ], + "StreamEventChatMessageJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLMが返したテキストチャンク内容。" } } } ] }, + "StreamEventAgentMessageJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLMが返したテキストチャンク内容（エージェントモード）。" } } } ] }, + "StreamEventAgentThoughtJa": { + "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, + { "type": "object", "required": ["id", "task_id", "message_id", "position", "created_at", "conversation_id"], "properties": { - "answer": { - "type": "string", - "description": "LLMが返したテキストチャンク内容。" - } + "id": { "type": "string", "format": "uuid", "description": "エージェント思考ID。" }, + "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, + "position": { "type": "integer", "description": "エージェント思考のメッセージ内での位置。" }, + "thought": { "type": "string", "nullable": true, "description": "エージェントの思考内容。" }, + "observation": { "type": "string", "nullable": true, "description": "ツール呼び出しからの応答。" }, + "tool": { "type": "string", "nullable": true, "description": "使用されたツールのリスト、;で区切られます。" }, + "tool_input": { "type": "string", "nullable": true, "description": "ツールの入力、JSON形式の文字列。" }, + "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, + "message_files": { "type": "array", "items": { "type": "string", "format": "uuid", "description": "ファイルID" }, "description": "現在のエージェント思考に関連するファイルIDのリスト。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" } } } ] }, - "StreamEventAgentMessageJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJa" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "LLMが返したテキストチャンク内容（エージェントモード）。" - } - } - } - ] - }, - "StreamEventAgentThoughtJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "type": "object", - "required": [ - "id", - "task_id", - "message_id", - "position", - "created_at", - "conversation_id" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "エージェント思考ID。" - }, - "task_id": { - "type": "string", - "format": "uuid", - "description": "タスクID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "position": { - "type": "integer", - "description": "エージェント思考のメッセージ内での位置。" - }, - "thought": { - "type": "string", - "nullable": true, - "description": "エージェントの思考内容。" - }, - "observation": { - "type": "string", - "nullable": true, - "description": "ツール呼び出しからの応答。" - }, - "tool": { - "type": "string", - "nullable": true, - "description": "使用されたツールのリスト、;で区切られます。" - }, - "tool_input": { - "type": "string", - "nullable": true, - "description": "ツールの入力、JSON形式の文字列。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - }, - "message_files": { - "type": "array", - "items": { - "type": "string", - "format": "uuid", - "description": "ファイルID" - }, - "description": "現在のエージェント思考に関連するファイルIDのリスト。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - } - } - } - ] - }, - "StreamEventMessageFileJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "type": "object", - "required": [ - "id", - "type", - "belongs_to", - "url", - "conversation_id" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ファイル一意ID。" - }, - "type": { - "type": "string", - "enum": [ - "image" - ], - "description": "ファイルタイプ、現在は'image'のみ許可。" - }, - "belongs_to": { - "type": "string", - "enum": [ - "assistant" - ], - "description": "所属、ここでは'assistant'のみ。" - }, - "url": { - "type": "string", - "format": "url", - "description": "ファイルのリモートURL。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - } - } - } - ] - }, - "StreamEventMessageEndJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJa" - }, - { - "type": "object", - "required": [ - "metadata" - ], - "properties": { - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataJa" - } - } - } - ] - }, - "StreamEventTtsMessageJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJa" - }, - { - "type": "object", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "format": "byte", - "description": "Base64エンコードされたオーディオブロック。" - } - } - } - ] - }, - "StreamEventTtsMessageEndJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJa" - }, - { - "type": "object", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "description": "空の文字列。" - } - } - } - ] - }, - "StreamEventMessageReplaceJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJa" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "置換内容（すべてのLLM返信テキストを直接置換）。" - } - } - } - ] - }, - "StreamEventErrorJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "type": "object", - "required": [ - "task_id", - "status", - "code", - "message" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "message_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "一意のメッセージID（エラーイベントでは存在しない場合があります）。" - }, - "status": { - "type": "integer", - "description": "HTTPステータスコード。" - }, - "code": { - "type": "string", - "description": "エラーコード。" - }, - "message": { - "type": "string", - "description": "エラーメッセージ。" - } - } - } - ] - }, - "StreamEventPingJa": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventJa" - }, - { - "type": "object", - "description": "接続を維持するために10秒ごとにpingイベントが発生します。" - } - ] - }, - "UsageJa": { - "type": "object", - "description": "モデル使用情報。", - "properties": { - "prompt_tokens": { - "type": "integer" - }, - "prompt_unit_price": { - "type": "string" - }, - "prompt_price_unit": { - "type": "string" - }, - "prompt_price": { - "type": "string" - }, - "completion_tokens": { - "type": "integer" - }, - "completion_unit_price": { - "type": "string" - }, - "completion_price_unit": { - "type": "string" - }, - "completion_price": { - "type": "string" - }, - "total_tokens": { - "type": "integer" - }, - "total_price": { - "type": "string" - }, - "currency": { - "type": "string" - }, - "latency": { - "type": "number", - "format": "double" - } - } - }, - "RetrieverResourceJa": { - "type": "object", - "description": "引用と帰属情報。", - "properties": { - "position": { - "type": "integer" - }, - "dataset_id": { - "type": "string", - "format": "uuid" - }, - "dataset_name": { - "type": "string" - }, - "document_id": { - "type": "string", - "format": "uuid" - }, - "document_name": { - "type": "string" - }, - "segment_id": { - "type": "string", - "format": "uuid" - }, - "score": { - "type": "number", - "format": "float" - }, - "content": { - "type": "string" - } - } - }, - "FileUploadResponseJa": { - "type": "object", - "description": "ファイルアップロード成功後の応答。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "name": { - "type": "string", - "description": "ファイル名。" - }, - "size": { - "type": "integer", - "description": "ファイルサイズ（バイト）。" - }, - "extension": { - "type": "string", - "description": "ファイル拡張子。" - }, - "mime_type": { - "type": "string", - "description": "ファイルのMIMEタイプ。" - }, - "created_by": { - "type": "string", - "format": "uuid", - "description": "エンドユーザーID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - }, + "StreamEventMessageFileJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "type": "object", "required": ["id", "type", "belongs_to", "url", "conversation_id"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ファイル一意ID。" }, "type": { "type": "string", "enum": ["image"], "description": "ファイルタイプ、現在は'image'のみ許可。" }, "belongs_to": { "type": "string", "enum": ["assistant"], "description": "所属、ここでは'assistant'のみ。" }, "url": { "type": "string", "format": "url", "description": "ファイルのリモートURL。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" } } } ] }, + "StreamEventMessageEndJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataJa" } } } ] }, + "StreamEventTtsMessageJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64エンコードされたオーディオブロック。" } } } ] }, + "StreamEventTtsMessageEndJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空の文字列。" } } } ] }, + "StreamEventMessageReplaceJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "$ref": "#/components/schemas/StreamEventBaseChatJa" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "置換内容（すべてのLLM返信テキストを直接置換）。" } } } ] }, + "StreamEventErrorJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "type": "object", "required": ["task_id", "status", "code", "message"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid", "nullable": true, "description": "一意のメッセージID（エラーイベントでは存在しない場合があります）。" }, "status": { "type": "integer", "description": "HTTPステータスコード。" }, "code": { "type": "string", "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } ] }, + "StreamEventPingJa": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventJa" }, { "type": "object", "description": "接続を維持するために10秒ごとにpingイベントが発生します。" } ] }, + "UsageJa": { "type": "object", "description": "モデル使用情報。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, + "RetrieverResourceJa": { "type": "object", "description": "引用と帰属情報。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } }, + "FileUploadResponseJa": { "type": "object", "description": "ファイルアップロード成功後の応答。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ（バイト）。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, "EndUserDetailJa": { "type": "object", "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "tenant_id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "type": { - "type": "string", - "example": "service_api" - }, - "external_user_id": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "is_anonymous": { - "type": "boolean" - }, - "session_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "MessageFeedbackRequestJa": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true, - "description": "アップボートは`like`、ダウンボートは`dislike`、アップボートの取り消しは`null`。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - }, - "content": { - "type": "string", - "nullable": true, - "description": "メッセージのフィードバックです。" - } - } - }, - "AppFeedbacksResponseJa": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeedbackItemJa" - }, - "description": "このアプリの「いいね」とフィードバックの一覧を返します。" - } - } - }, - "FeedbackItemJa": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid" - }, - "conversation_id": { - "type": "string", - "format": "uuid" - }, - "message_id": { - "type": "string", - "format": "uuid" - }, - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true - }, - "content": { - "type": "string" - }, - "from_source": { - "type": "string" - }, - "from_end_user_id": { - "type": "string", - "format": "uuid" - }, - "from_account_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "SuggestedQuestionsResponseJa": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - }, - "data": { - "type": "array", - "items": { - "type": "string" - }, - "description": "推奨質問のリスト。" - } - } - }, - "BasicConversationHistoryResponseJa": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "返されたアイテムの数。" - }, - "has_more": { - "type": "boolean", - "description": "次のページがあるかどうか。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BasicConversationMessageItemJa" - }, - "description": "メッセージリスト。" - } - } - }, - "BasicConversationMessageItemJa": { - "type": "object", - "description": "会話内の単一メッセージ。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "メッセージID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "ユーザー入力パラメータ。" - }, - "query": { - "type": "string", - "description": "ユーザー入力/質問内容。" - }, - "answer": { - "type": "string", - "description": "応答メッセージ内容。" - }, - "message_files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MessageFileItemJa" - }, - "description": "メッセージファイルリスト。" - }, - "feedback": { - "type": "object", - "nullable": true, - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike" - ], - "description": "アップボートは`like` / ダウンボートは`dislike`。" - } - }, - "description": "フィードバック情報。" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResourceJa" - }, - "description": "引用と帰属リスト。" - }, - "agent_thoughts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AgentThoughtItemJa" - }, - "description": "エージェントの思考（基本アシスタントの場合は空）。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - }, + "id": { "type": "string", "format": "uuid" }, + "tenant_id": { "type": "string", "format": "uuid" }, + "app_id": { "type": "string", "format": "uuid", "nullable": true }, + "type": { "type": "string", "example": "service_api" }, + "external_user_id": { "type": "string", "nullable": true }, + "name": { "type": "string", "nullable": true }, + "is_anonymous": { "type": "boolean" }, + "session_id": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + } + }, + "MessageFeedbackRequestJa": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "アップボートは`like`、ダウンボートは`dislike`、アップボートの取り消しは`null`。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "content": { "type": "string", "nullable": true, "description": "メッセージのフィードバックです。" } } }, + "AppFeedbacksResponseJa": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemJa" }, "description": "このアプリの「いいね」とフィードバックの一覧を返します。" } } }, + "FeedbackItemJa": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, + "SuggestedQuestionsResponseJa": { "type": "object", "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "string" }, "description": "推奨質問のリスト。" } } }, + "BasicConversationHistoryResponseJa": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返されたアイテムの数。" }, "has_more": { "type": "boolean", "description": "次のページがあるかどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BasicConversationMessageItemJa" }, "description": "メッセージリスト。" } } }, + "BasicConversationMessageItemJa": { "type": "object", "description": "会話内の単一メッセージ。", "properties": { "id": { "type": "string", "format": "uuid", "description": "メッセージID。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ユーザー入力パラメータ。" }, "query": { "type": "string", "description": "ユーザー入力/質問内容。" }, "answer": { "type": "string", "description": "応答メッセージ内容。" }, "message_files": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFileItemJa" }, "description": "メッセージファイルリスト。" }, "feedback": { "type": "object", "nullable": true, "properties": { "rating": { "type": "string", "enum": ["like", "dislike"], "description": "アップボートは`like` / ダウンボートは`dislike`。" } }, "description": "フィードバック情報。" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJa" }, "description": "引用と帰属リスト。" }, "agent_thoughts": { "type": "array", "items": { "$ref": "#/components/schemas/AgentThoughtItemJa" }, "description": "エージェントの思考（基本アシスタントの場合は空）。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, "AgentThoughtItemJa": { - "type": "object", - "description": "エージェントの思考ステップ。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "エージェント思考ID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "position": { - "type": "integer", - "description": "エージェント思考のメッセージ内での位置。" - }, - "thought": { - "type": "string", - "nullable": true, - "description": "LLMが考えていること。" - }, - "observation": { - "type": "string", - "nullable": true, - "description": "ツール呼び出しからの応答。" - }, - "tool": { - "type": "string", - "nullable": true, - "description": "呼び出されたツールのリスト、;で区切られます。" - }, - "tool_input": { - "type": "string", - "nullable": true, - "description": "ツールの入力、JSON形式。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - }, - "message_files": { - "type": "array", - "items": { - "type": "string", - "format": "uuid", - "description": "ファイルID" - }, - "description": "現在のエージェント思考に関連するファイルIDのリスト。" - } - } - }, - "MessageFileItemJa": { - "type": "object", - "description": "メッセージ内のファイル項目。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "type": { - "type": "string", - "description": "ファイルタイプ、例：'image'。" - }, - "url": { - "type": "string", - "format": "url", - "description": "プレビュー画像URL。" - }, - "belongs_to": { - "type": "string", - "enum": [ - "user", - "assistant" - ], - "description": "所属。" - } - } - }, - "ConversationsListResponseJa": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "返されたエントリの数。" - }, - "has_more": { - "type": "boolean" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationListItemJa" - }, - "description": "会話のリスト。" - } - } - }, - "ConversationListItemJa": { - "type": "object", - "description": "会話リスト内の単一項目。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - }, - "name": { - "type": "string", - "description": "会話名。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "ユーザー入力パラメータ。" - }, - "status": { - "type": "string", - "description": "会話状態。" - }, - "introduction": { - "type": "string", - "nullable": true, - "description": "紹介。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "更新タイムスタンプ。" - } - } - }, - "ConversationRenameRequestJa": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "name": { - "type": "string", - "nullable": true, - "description": "(Optional)会話の名前。`auto_generate`が`true`の場合、省略できます。" - }, - "auto_generate": { - "type": "boolean", - "default": false, - "description": "(Optional)タイトルを自動生成します。デフォルトは`false`です。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - } - } - }, - "ConversationRenameResponseJa": { - "$ref": "#/components/schemas/ConversationListItemJa" - }, - "ConversationVariablesResponseJa": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "ページごとのアイテム数。" - }, - "has_more": { - "type": "boolean", - "description": "さらにアイテムがあるかどうか。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationVariableItemJa" - }, - "description": "変数のリスト。" - } - } - }, - "ConversationVariableItemJa": { - "type": "object", - "description": "会話内の変数項目。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "変数ID。" - }, - "name": { - "type": "string", - "description": "変数名。" - }, - "value_type": { - "type": "string", - "description": "変数タイプ（文字列、数値、真偽値など）。" - }, - "value": { - "type": "string", - "description": "変数値。" - }, - "description": { - "type": "string", - "nullable": true, - "description": "変数の説明。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "最終更新タイムスタンプ。" - } - } - }, - "AudioToTextRequestJa": { - "type": "object", - "required": [ - "file", - "user" - ], - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "オーディオファイル。サポートされている形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`。ファイルサイズ制限：15MB。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - } - } - }, - "AudioToTextResponseJa": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "出力テキスト。" - } - } - }, - "TextToAudioFormRequestJa": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "message_id": { - "type": "string", - "format": "uuid", - "description": "メッセージID（優先）。" - }, - "text": { - "type": "string", - "description": "音声生成コンテンツ。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - } - }, - "description": "`user`が必要です。`message_id`または`text`を提供してください。このバージョンはmultipart/form-dataです。" - }, - "AppInfoResponseJa": { - "type": "object", - "description": "アプリケーションの基本情報。", - "properties": { - "name": { - "type": "string", - "description": "アプリケーションの名前。" - }, - "description": { - "type": "string", - "description": "アプリケーションの説明。" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "アプリケーションのタグ。" - } - } - }, - "BasicChatAppParametersResponseJa": { - "type": "object", - "description": "アプリケーションのパラメータ情報。", - "properties": { - "opening_statement": { - "type": "string", - "description": "開始文。" - }, - "suggested_questions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "開始時の推奨質問のリスト。" - }, - "suggested_questions_after_answer": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - } - }, - "description": "答えを有効にした後の質問を提案します。" - }, - "speech_to_text": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - } - }, - "description": "音声からテキストへ。" - }, - "text_to_speech": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - }, - "voice": { - "type": "string", - "description": "音声タイプ。" - }, - "language": { - "type": "string", - "description": "言語。" - }, - "autoPlay": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ], - "description": "自動再生：enabled 有効, disabled 無効。" - } - }, - "description": "テキストから音声へ。" - }, - "retriever_resource": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - } - }, - "description": "引用と帰属。" - }, - "annotation_reply": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - } - }, - "description": "注釈返信。" - }, - "user_input_form": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserInputFormItemJa" - }, - "description": "ユーザー入力フォームの構成。" - }, - "file_upload": { - "type": "object", - "properties": { - "image": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "number_limits": { - "type": "integer" - }, - "transfer_methods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ] - } - } - }, - "description": "画像設定。サポートされている画像タイプ：`png`, `jpg`, `jpeg`, `webp`, `gif`。" - } - }, - "description": "ファイルアップロード構成。" - }, - "system_parameters": { - "type": "object", - "properties": { - "file_size_limit": { - "type": "integer", - "description": "ドキュメントアップロードサイズ制限（MB）。" - }, - "image_file_size_limit": { - "type": "integer", - "description": "画像ファイルアップロードサイズ制限（MB）。" - }, - "audio_file_size_limit": { - "type": "integer", - "description": "オーディオファイルアップロードサイズ制限（MB）。" - }, - "video_file_size_limit": { - "type": "integer", - "description": "ビデオファイルアップロードサイズ制限（MB）。" - } - }, - "description": "システムパラメータ。" - } - } - }, - "UserInputFormItemJa": { - "type": "object", - "description": "ユーザー入力フォーム内のコントロール項目。", - "oneOf": [ - { - "$ref": "#/components/schemas/TextInputControlWrapperJa" - }, - { - "$ref": "#/components/schemas/ParagraphControlWrapperJa" - }, - { - "$ref": "#/components/schemas/SelectControlWrapperJa" - } - ] - }, - "TextInputControlWrapperJa": { - "type": "object", - "properties": { - "text-input": { - "$ref": "#/components/schemas/TextInputControlJa" - } - }, - "required": [ - "text-input" - ] - }, - "ParagraphControlWrapperJa": { - "type": "object", - "properties": { - "paragraph": { - "$ref": "#/components/schemas/ParagraphControlJa" - } - }, - "required": [ - "paragraph" - ] - }, - "SelectControlWrapperJa": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/SelectControlJa" - } - }, - "required": [ - "select" - ] - }, - "TextInputControlJa": { - "type": "object", - "description": "テキスト入力コントロール。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - } - } - }, - "ParagraphControlJa": { - "type": "object", - "description": "段落テキスト入力コントロール。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - } - } - }, - "SelectControlJa": { - "type": "object", - "description": "ドロップダウンコントロール。", - "required": [ - "label", - "variable", - "required", - "options" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - }, - "options": { - "type": "array", - "items": { - "type": "string" - }, - "description": "オプション値。" - } - } - }, - "AppMetaResponseJa": { - "type": "object", - "description": "アプリケーションのメタ情報。", - "properties": { - "tool_icons": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "string", - "format": "url", - "description": "アイコンのURL。" - }, - { - "$ref": "#/components/schemas/ToolIconDetailJa" - } - ] - }, - "description": "ツールアイコン。キーはツール名です。" - } - } - }, - "ToolIconDetailJa": { - "type": "object", - "description": "ツールアイコンの詳細。", - "properties": { - "background": { - "type": "string", - "description": "背景色（16進数形式）。" - }, - "content": { - "type": "string", - "description": "絵文字。" - } - } - }, - "WebAppSettingsResponseJa": { - "type": "object", - "description": "アプリのWebApp設定。", - "properties": { - "title": { - "type": "string", - "description": "WebApp名。" - }, - "chat_color_theme": { - "type": "string", - "description": "チャットの色テーマ、16進数形式。" - }, - "chat_color_theme_inverted": { - "type": "boolean", - "description": "チャットの色テーマを反転するかどうか。" - }, - "icon_type": { - "type": "string", - "enum": [ - "emoji", - "image" - ], - "description": "アイコンタイプ。" - }, - "icon": { - "type": "string", - "description": "アイコン内容（絵文字または画像URL）。" - }, - "icon_background": { - "type": "string", - "description": "16進数形式の背景色。" - }, - "icon_url": { - "type": "string", - "format": "url", - "nullable": true, - "description": "アイコンのURL。" - }, - "description": { - "type": "string", - "description": "説明。" - }, - "copyright": { - "type": "string", - "description": "著作権情報。" - }, - "privacy_policy": { - "type": "string", - "description": "プライバシーポリシーのリンク。" - }, - "custom_disclaimer": { - "type": "string", - "description": "カスタム免責事項。" - }, - "default_language": { - "type": "string", - "description": "デフォルト言語。" - }, - "show_workflow_steps": { - "type": "boolean", - "description": "ワークフローの詳細を表示するかどうか。" - }, - "use_icon_as_answer_icon": { - "type": "boolean", - "description": "WebAppのアイコンをチャット内の🤖に置き換えるかどうか。" - } - } - }, - "ErrorResponseJa": { - "type": "object", - "description": "エラー応答。", - "properties": { - "status": { - "type": "integer", - "nullable": true, - "description": "HTTPステータスコード。" - }, - "code": { - "type": "string", - "nullable": true, - "description": "エラーコード。" - }, - "message": { - "type": "string", - "description": "エラーメッセージ。" - } - } - } + "type": "object", "description": "エージェントの思考ステップ。", + "properties": { + "id": { "type": "string", "format": "uuid", "description": "エージェント思考ID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, + "position": { "type": "integer", "description": "エージェント思考のメッセージ内での位置。" }, + "thought": { "type": "string", "nullable": true, "description": "LLMが考えていること。" }, + "observation": { "type": "string", "nullable": true, "description": "ツール呼び出しからの応答。" }, + "tool": { "type": "string", "nullable": true, "description": "呼び出されたツールのリスト、;で区切られます。" }, + "tool_input": { "type": "string", "nullable": true, "description": "ツールの入力、JSON形式。" }, + "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, + "message_files": { "type": "array", "items": { "type": "string", "format": "uuid", "description": "ファイルID" }, "description": "現在のエージェント思考に関連するファイルIDのリスト。" } + } + }, + "MessageFileItemJa": { "type": "object", "description": "メッセージ内のファイル項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "ファイルタイプ、例：'image'。" }, "url": { "type": "string", "format": "url", "description": "プレビュー画像URL。" }, "belongs_to": { "type": "string", "enum": ["user", "assistant"], "description": "所属。" } } }, + "ConversationsListResponseJa": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返されたエントリの数。" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationListItemJa" }, "description": "会話のリスト。" } } }, + "ConversationListItemJa": { "type": "object", "description": "会話リスト内の単一項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "会話ID。" }, "name": { "type": "string", "description": "会話名。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ユーザー入力パラメータ。" }, "status": { "type": "string", "description": "会話状態。" }, "introduction": { "type": "string", "nullable": true, "description": "紹介。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, "updated_at": { "type": "integer", "format": "int64", "description": "更新タイムスタンプ。" } } }, + "ConversationRenameRequestJa": { "type": "object", "required": ["user"], "properties": { "name": { "type": "string", "nullable": true, "description": "(Optional)会話の名前。`auto_generate`が`true`の場合、省略できます。" }, "auto_generate": { "type": "boolean", "default": false, "description": "(Optional)タイトルを自動生成します。デフォルトは`false`です。" }, "user": { "type": "string", "description": "ユーザー識別子。" } } }, + "ConversationRenameResponseJa": { "$ref": "#/components/schemas/ConversationListItemJa" }, + "ConversationVariablesResponseJa": { "type": "object", "properties": { "limit": { "type": "integer", "description": "ページごとのアイテム数。" }, "has_more": { "type": "boolean", "description": "さらにアイテムがあるかどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationVariableItemJa" }, "description": "変数のリスト。" } } }, + "ConversationVariableItemJa": { "type": "object", "description": "会話内の変数項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "変数ID。" }, "name": { "type": "string", "description": "変数名。" }, "value_type": { "type": "string", "description": "変数タイプ（文字列、数値、真偽値など）。" }, "value": { "type": "string", "description": "変数値。" }, "description": { "type": "string", "nullable": true, "description": "変数の説明。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, "updated_at": { "type": "integer", "format": "int64", "description": "最終更新タイムスタンプ。" } } }, + "AudioToTextRequestJa": { "type": "object", "required": ["file", "user"], "properties": { "file": { "type": "string", "format": "binary", "description": "オーディオファイル。サポートされている形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`。ファイルサイズ制限：15MB。" }, "user": { "type": "string", "description": "ユーザー識別子。" } } }, + "AudioToTextResponseJa": { "type": "object", "properties": { "text": { "type": "string", "description": "出力テキスト。" } } }, + "TextToAudioFormRequestJa": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "メッセージID（優先）。" }, "text": { "type": "string", "description": "音声生成コンテンツ。" }, "user": { "type": "string", "description": "ユーザー識別子。" } }, "description": "`user`が必要です。`message_id`または`text`を提供してください。このバージョンはmultipart/form-dataです。" }, + "AppInfoResponseJa": { "type": "object", "description": "アプリケーションの基本情報。", "properties": { "name": { "type": "string", "description": "アプリケーションの名前。" }, "description": { "type": "string", "description": "アプリケーションの説明。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "アプリケーションのタグ。" } } }, + "BasicChatAppParametersResponseJa": { "type": "object", "description": "アプリケーションのパラメータ情報。", "properties": { "opening_statement": { "type": "string", "description": "開始文。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "開始時の推奨質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "答えを有効にした後の質問を提案します。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "音声からテキストへ。" }, "text_to_speech": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" }, "voice": { "type": "string", "description": "音声タイプ。" }, "language": { "type": "string", "description": "言語。" }, "autoPlay": { "type": "string", "enum": ["enabled", "disabled"], "description": "自動再生：enabled 有効, disabled 無効。" } }, "description": "テキストから音声へ。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "引用と帰属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "注釈返信。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemJa" }, "description": "ユーザー入力フォームの構成。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "画像設定。サポートされている画像タイプ：`png`, `jpg`, `jpeg`, `webp`, `gif`。" } }, "description": "ファイルアップロード構成。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "ドキュメントアップロードサイズ制限（MB）。" }, "image_file_size_limit": { "type": "integer", "description": "画像ファイルアップロードサイズ制限（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "オーディオファイルアップロードサイズ制限（MB）。" }, "video_file_size_limit": { "type": "integer", "description": "ビデオファイルアップロードサイズ制限（MB）。" } }, "description": "システムパラメータ。" } } }, + "UserInputFormItemJa": { "type": "object", "description": "ユーザー入力フォーム内のコントロール項目。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperJa" }, { "$ref": "#/components/schemas/ParagraphControlWrapperJa" }, { "$ref": "#/components/schemas/SelectControlWrapperJa" } ] }, + "TextInputControlWrapperJa": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlJa" } }, "required":["text-input"] }, + "ParagraphControlWrapperJa": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlJa" } }, "required":["paragraph"] }, + "SelectControlWrapperJa": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlJa" } }, "required":["select"] }, + "TextInputControlJa": { "type": "object", "description": "テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, + "ParagraphControlJa": { "type": "object", "description": "段落テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, + "SelectControlJa": { "type": "object", "description": "ドロップダウンコントロール。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "オプション値。" } } }, + "AppMetaResponseJa": { "type": "object", "description": "アプリケーションのメタ情報。", "properties": { "tool_icons": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "format": "url", "description": "アイコンのURL。" }, { "$ref": "#/components/schemas/ToolIconDetailJa" } ] }, "description": "ツールアイコン。キーはツール名です。" } } }, + "ToolIconDetailJa": { "type": "object", "description": "ツールアイコンの詳細。", "properties": { "background": { "type": "string", "description": "背景色（16進数形式）。" }, "content": { "type": "string", "description": "絵文字。" } } }, + "WebAppSettingsResponseJa": { "type": "object", "description": "アプリのWebApp設定。", "properties": { "title": { "type": "string", "description": "WebApp名。" }, "chat_color_theme": { "type": "string", "description": "チャットの色テーマ、16進数形式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "チャットの色テーマを反転するかどうか。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "アイコンタイプ。" }, "icon": { "type": "string", "description": "アイコン内容（絵文字または画像URL）。" }, "icon_background": { "type": "string", "description": "16進数形式の背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "アイコンのURL。" }, "description": { "type": "string", "description": "説明。" }, "copyright": { "type": "string", "description": "著作権情報。" }, "privacy_policy": { "type": "string", "description": "プライバシーポリシーのリンク。" }, "custom_disclaimer": { "type": "string", "description": "カスタム免責事項。" }, "default_language": { "type": "string", "description": "デフォルト言語。" }, "show_workflow_steps": { "type": "boolean", "description": "ワークフローの詳細を表示するかどうか。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "WebAppのアイコンをチャット内の🤖に置き換えるかどうか。" } } }, + "ErrorResponseJa": { "type": "object", "description": "エラー応答。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTPステータスコード。" }, "code": { "type": "string", "nullable": true, "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } } }, "tags": [ - { - "name": "チャットメッセージ", - "description": "チャットメッセージと対話に関連する操作。" - }, - { - "name": "ファイル操作", - "description": "ファイルアップロードとプレビューに関連する操作。" - }, - { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作。" - }, - { - "name": "メッセージフィードバック", - "description": "ユーザーからのメッセージフィードバック操作。" - }, - { - "name": "会話管理", - "description": "会話セッションの管理に関連する操作。" - }, - { - "name": "音声とテキスト変換", - "description": "テキストから音声、音声からテキストへの変換操作。" - }, - { - "name": "アプリケーション設定", - "description": "アプリケーション設定と情報の取得に関連する操作。" - } + { "name": "チャットメッセージ", "description": "チャットメッセージと対話に関連する操作。" }, + { "name": "ファイル操作", "description": "ファイルアップロードとプレビューに関連する操作。" }, + { "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" }, + { "name": "メッセージフィードバック", "description": "ユーザーからのメッセージフィードバック操作。" }, + { "name": "会話管理", "description": "会話セッションの管理に関連する操作。" }, + { "name": "音声とテキスト変換", "description": "テキストから音声、音声からテキストへの変換操作。" }, + { "name": "アプリケーション設定", "description": "アプリケーション設定と情報の取得に関連する操作。" } ] -} +} \ No newline at end of file diff --git a/ja/api-reference/openapi_chatflow.json b/ja/api-reference/openapi_chatflow.json index f5fa3c386..eb6d60708 100644 --- a/ja/api-reference/openapi_chatflow.json +++ b/ja/api-reference/openapi_chatflow.json @@ -28,9 +28,7 @@ "summary": "チャットメッセージを送信", "description": "チャットアプリケーションにリクエストを送信します。", "operationId": "sendChatflowMessageJp", - "tags": [ - "チャットメッセージ" - ], + "tags": ["チャットメッセージ"], "requestBody": { "description": "チャットメッセージ送信のリクエストボディ。", "required": true, @@ -80,18 +78,9 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequestGenericJp" - }, - "404": { - "$ref": "#/components/responses/ConversationNotFoundJp" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/chatflow/send-chat-message" + "400": { "$ref": "#/components/responses/BadRequestGenericJp" }, + "404": { "$ref": "#/components/responses/ConversationNotFoundJp" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJp" } } } }, @@ -100,9 +89,7 @@ "summary": "ファイルアップロード", "description": "メッセージ送信時に使用するファイルをアップロードし、画像とテキストのマルチモーダル理解を可能にします。アプリケーションでサポートされている形式をサポートします。アップロードされたファイルは現在のエンドユーザーのみが使用できます。", "operationId": "uploadChatflowFileJp", - "tags": [ - "ファイル操作" - ], + "tags": ["ファイル操作"], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data` リクエストが必要です。", "required": true, @@ -110,10 +97,7 @@ "multipart/form-data": { "schema": { "type": "object", - "required": [ - "file", - "user" - ], + "required": ["file", "user"], "properties": { "file": { "type": "string", @@ -142,32 +126,13 @@ }, "201": { "description": "ファイル作成成功（代替成功コード）。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseJp" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } }, - "400": { - "$ref": "#/components/responses/BadRequestFileJp" - }, - "413": { - "$ref": "#/components/responses/FileTooLargeJp" - }, - "415": { - "$ref": "#/components/responses/UnsupportedFileTypeFileJp" - }, - "503": { - "$ref": "#/components/responses/S3ErrorFileJp" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/files/file-upload" + "400": { "$ref": "#/components/responses/BadRequestFileJp" }, + "413": { "$ref": "#/components/responses/FileTooLargeJp" }, + "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileJp" }, + "503": { "$ref": "#/components/responses/S3ErrorFileJp" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJp" } } } }, @@ -176,19 +141,14 @@ "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", "operationId": "getEndUserChatflowJp", - "tags": [ - "エンドユーザー" - ], + "tags": ["エンドユーザー"], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "エンドユーザーID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -196,21 +156,12 @@ "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/EndUserDetailJp" - } + "schema": { "$ref": "#/components/schemas/EndUserDetailJp" } } } }, - "404": { - "$ref": "#/components/responses/EndUserNotFoundJp" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/end-users/get-end-user" + "404": { "$ref": "#/components/responses/EndUserNotFoundJp" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJp" } } } }, @@ -219,9 +170,7 @@ "summary": "ファイルプレビュー", "description": "アップロードされたファイルのプレビューまたはダウンロード。このエンドポイントは、ファイルアップロードAPIを通じて事前にアップロードされたファイルにアクセスすることができます。ファイルは、リクエストしているアプリケーション内のメッセージに属している場合のみアクセス可能です。", "operationId": "previewChatflowFileJp", - "tags": [ - "ファイル操作" - ], + "tags": ["ファイル操作"], "parameters": [ { "name": "file_id", @@ -318,9 +267,7 @@ "description": "不正なリクエスト。可能なエラーコード:\n- `invalid_param`: 異常なパラメータ入力。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, @@ -328,9 +275,7 @@ "description": "禁止。可能なエラーコード:\n- `file_access_denied`: ファイルアクセス拒否またはファイルが現在のアプリケーションに属していません。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, @@ -338,9 +283,7 @@ "description": "見つかりません。可能なエラーコード:\n- `file_not_found`: ファイルが見つからないか削除されています。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, @@ -348,15 +291,10 @@ "description": "内部サーバーエラー。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } } - }, - "x-mint": { - "href": "/ja/api-reference/files/file-preview" } } }, @@ -365,19 +303,14 @@ "summary": "生成を停止", "description": "チャットメッセージの生成を停止します。ストリーミングモードでのみサポートされています。", "operationId": "stopChatflowMessageGenerationJp", - "tags": [ - "チャットメッセージ" - ], + "tags": ["チャットメッセージ"], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "タスクID、ストリーミングチャンクの返り値から取得できます。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { @@ -386,9 +319,7 @@ "application/json": { "schema": { "type": "object", - "required": [ - "user" - ], + "required": ["user"], "properties": { "user": { "type": "string", @@ -400,12 +331,7 @@ } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/chatflow/stop-advanced-chat-message-generation" + "200": { "$ref": "#/components/responses/SuccessResultJp" } } } }, @@ -414,38 +340,26 @@ "summary": "メッセージフィードバック", "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのを支援します。", "operationId": "postChatflowMessageFeedbackJp", - "tags": [ - "メッセージフィードバック" - ], + "tags": ["メッセージフィードバック"], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/MessageFeedbackRequestJp" - } + "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestJp" } } } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/feedback/message-feedback" + "200": { "$ref": "#/components/responses/SuccessResultJp" } } } }, @@ -454,31 +368,20 @@ "summary": "アプリのメッセージの「いいね」とフィードバックを取得", "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", "operationId": "getChatflowAppFeedbacksJp", - "tags": [ - "メッセージフィードバック" - ], + "tags": ["メッセージフィードバック"], "parameters": [ - { - "$ref": "#/components/parameters/PageQueryParamJp" - }, - { - "$ref": "#/components/parameters/LimitQueryParamJp" - } + { "$ref": "#/components/parameters/PageQueryParamJp" }, + { "$ref": "#/components/parameters/LimitQueryParamJp" } ], "responses": { "200": { "description": "アプリのフィードバックリストを正常に取得しました。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFeedbacksResponseJp" - } + "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseJp" } } } } - }, - "x-mint": { - "href": "/ja/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -487,38 +390,26 @@ "summary": "次の推奨質問", "description": "現在のメッセージに対する次の質問の提案を取得します。", "operationId": "getChatflowSuggestedQuestionsJp", - "tags": [ - "チャットメッセージ" - ], + "tags": ["チャットメッセージ"], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } }, - { - "$ref": "#/components/parameters/UserQueryParamJp" - } + { "$ref": "#/components/parameters/UserQueryParamJp" } ], "responses": { "200": { "description": "推奨質問リストを正常に取得しました。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/SuggestedQuestionsResponseJp" - } + "schema": { "$ref": "#/components/schemas/SuggestedQuestionsResponseJp" } } } } - }, - "x-mint": { - "href": "/ja/api-reference/chatflow/next-suggested-questions" } } }, @@ -527,44 +418,27 @@ "summary": "会話履歴メッセージを取得", "description": "スクロールロード形式で履歴チャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", "operationId": "getChatflowConversationHistoryJp", - "tags": [ - "会話管理" - ], + "tags": ["会話管理"], "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdQueryParamJp" - }, - { - "$ref": "#/components/parameters/UserQueryParamJp" - }, + { "$ref": "#/components/parameters/ConversationIdQueryParamJp" }, + { "$ref": "#/components/parameters/UserQueryParamJp" }, { "name": "first_id", "in": "query", "description": "現在のページの最初のチャット記録のID、デフォルトはnullです。", - "schema": { - "type": "string", - "format": "uuid", - "nullable": true - } + "schema": { "type": "string", "format": "uuid", "nullable": true } }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Jp" - } + { "$ref": "#/components/parameters/LimitQueryParamDefault20Jp" } ], "responses": { "200": { "description": "会話履歴メッセージを正常に取得しました。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationHistoryResponseJp" - } + "schema": { "$ref": "#/components/schemas/ConversationHistoryResponseJp" } } } } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/get-conversation-history-messages" } } }, @@ -573,37 +447,22 @@ "summary": "会話を取得", "description": "現在のユーザーの会話リストを取得し、デフォルトで最新の20件を返します。", "operationId": "getChatflowConversationsListJp", - "tags": [ - "会話管理" - ], + "tags": ["会話管理"], "parameters": [ - { - "$ref": "#/components/parameters/UserQueryParamJp" - }, - { - "$ref": "#/components/parameters/LastIdQueryParamJp" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Jp" - }, - { - "$ref": "#/components/parameters/SortByQueryParamJp" - } + { "$ref": "#/components/parameters/UserQueryParamJp" }, + { "$ref": "#/components/parameters/LastIdQueryParamJp" }, + { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Jp" }, + { "$ref": "#/components/parameters/SortByQueryParamJp" } ], "responses": { "200": { "description": "会話リストを正常に取得しました。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationsListResponseJp" - } + "schema": { "$ref": "#/components/schemas/ConversationsListResponseJp" } } } } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/get-conversations" } } }, @@ -612,41 +471,20 @@ "summary": "会話を削除", "description": "指定された会話を削除します。", "operationId": "deleteChatflowConversationJp", - "tags": [ - "会話管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamJp" - } - ], + "tags": ["会話管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJp" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "user": { - "type": "string", - "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" - } - } + "type": "object", "required": ["user"], + "properties": { "user": { "type": "string", "description": "ユーザー識別子。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" } } } } } }, - "responses": { - "204": { - "description": "会話が正常に削除されました。コンテンツはありません。" - } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/delete-conversation" - } + "responses": { "204": { "description": "会話が正常に削除されました。コンテンツはありません。" } } } }, "/conversations/{conversation_id}/name": { @@ -654,80 +492,32 @@ "summary": "会話の名前を変更", "description": "セッションの名前を変更します。", "operationId": "renameChatflowConversationJp", - "tags": [ - "会話管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamJp" - } - ], + "tags": ["会話管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamJp" } ], "requestBody": { "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationRenameRequestJp" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameRequestJp" } } } }, "responses": { - "200": { - "description": "会話の名前が正常に変更されました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationRenameResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/conversation-rename" + "200": { "description": "会話の名前が正常に変更されました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameResponseJp" } } } } } } }, - "/conversations/{conversation_id}/variables": { + "/conversations/{conversation_id}/variables": { "get": { "summary": "会話変数の取得", "description": "特定の会話から変数を取得します。このエンドポイントは、会話中に取得された構造化データを抽出するのに役立ちます。", "operationId": "getChatflowConversationVariablesJp", - "tags": [ - "会話管理" - ], + "tags": ["会話管理"], "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamJp" - }, - { - "$ref": "#/components/parameters/UserQueryParamJp" - }, - { - "$ref": "#/components/parameters/LastIdQueryParamJp" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Jp" - } + { "$ref": "#/components/parameters/ConversationIdPathParamJp" }, + { "$ref": "#/components/parameters/UserQueryParamJp" }, + { "$ref": "#/components/parameters/LastIdQueryParamJp" }, + { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Jp" } ], "responses": { - "200": { - "description": "会話変数を正常に取得しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationVariablesResponseJp" - } - } - } - }, - "404": { - "$ref": "#/components/responses/ConversationNotFoundJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/conversations/get-conversation-variables" + "200": { "description": "会話変数を正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationVariablesResponseJp" } } } }, + "404": { "$ref": "#/components/responses/ConversationNotFoundJp" } } } }, @@ -736,33 +526,13 @@ "summary": "音声からテキストへ", "description": "オーディオファイルをテキストに変換します。サポートされている形式：mp3, mp4, mpeg, mpga, m4a, wav, webm。ファイルサイズ制限：15MB。", "operationId": "chatflowAudioToTextJp", - "tags": [ - "音声・テキスト変換" - ], + "tags": ["音声・テキスト変換"], "requestBody": { "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AudioToTextRequestJp" - } - } - } + "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioToTextRequestJp" } } } }, "responses": { - "200": { - "description": "音声をテキストに正常に変換しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AudioToTextResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/tts/speech-to-text" + "200": { "description": "音声をテキストに正常に変換しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioToTextResponseJp" } } } } } } }, @@ -771,48 +541,17 @@ "summary": "テキストから音声へ", "description": "テキストコンテンツを音声に変換します。", "operationId": "chatflowTextToAudioJp", - "tags": [ - "音声・テキスト変換" - ], + "tags": ["音声・テキスト変換"], "requestBody": { "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TextToAudioJsonRequestJp" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextToAudioJsonRequestJp" } } } }, "responses": { "200": { "description": "音声ファイルを正常に生成しました。", - "content": { - "audio/wav": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "audio/mp3": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "headers": { - "Content-Type": { - "schema": { - "type": "string", - "example": "audio/wav" - } - } - } + "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, + "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } } - }, - "x-mint": { - "href": "/ja/api-reference/tts/text-to-audio" } } }, @@ -820,24 +559,8 @@ "get": { "summary": "アプリケーションの基本情報を取得", "operationId": "getChatflowAppInfoJp", - "tags": [ - "アプリケーション設定" - ], - "responses": { - "200": { - "description": "アプリケーションの基本情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfoResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-basic-information" - } + "tags": ["アプリケーション設定"], + "responses": { "200": { "description": "アプリケーションの基本情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseJp" } } } } } } }, "/parameters": { @@ -845,24 +568,8 @@ "summary": "アプリケーションのパラメータ情報を取得", "description": "ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。", "operationId": "getChatflowAppParametersJp", - "tags": [ - "アプリケーション設定" - ], - "responses": { - "200": { - "description": "アプリケーションのパラメータ情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatAppParametersResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-parameters-information" - } + "tags": ["アプリケーション設定"], + "responses": { "200": { "description": "アプリケーションのパラメータ情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAppParametersResponseJp" } } } } } } }, "/meta": { @@ -870,24 +577,8 @@ "summary": "アプリケーションのメタ情報を取得", "description": "このアプリケーションのツールのアイコンを取得するために使用されます。", "operationId": "getChatflowAppMetaJp", - "tags": [ - "アプリケーション設定" - ], - "responses": { - "200": { - "description": "アプリケーションのメタ情報を正常に取得しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppMetaResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-meta-information" - } + "tags": ["アプリケーション設定"], + "responses": { "200": { "description": "アプリケーションのメタ情報を正常に取得しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMetaResponseJp" } } } } } } }, "/site": { @@ -895,2122 +586,197 @@ "summary": "アプリのWebApp設定を取得", "description": "アプリのWebApp設定を取得するために使用します。", "operationId": "getChatflowWebAppSettingsJp", - "tags": [ - "アプリケーション設定" - ], - "responses": { - "200": { - "description": "WebAppの設定情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebAppSettingsResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-webapp-settings" - } + "tags": ["アプリケーション設定"], + "responses": { "200": { "description": "WebAppの設定情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseJp" } } } } } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "API_KEY", - "description": "APIキー認証。すべてのAPIリクエストには、Authorization HTTPヘッダーにAPIキーを `Bearer {API_KEY}` の形式で含めてください。APIキーはサーバー側に保存し、クライアント側で共有または保存しないことを強くお勧めします。" - } + "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "APIキー認証。すべてのAPIリクエストには、Authorization HTTPヘッダーにAPIキーを `Bearer {API_KEY}` の形式で含めてください。APIキーはサーバー側に保存し、クライアント側で共有または保存しないことを強くお勧めします。" } }, "parameters": { - "PageQueryParamJp": { - "name": "page", - "in": "query", - "description": "（任意）ページ番号。デフォルト値：1。", - "schema": { - "type": "integer", - "default": 1 - } - }, - "LimitQueryParamJp": { - "name": "limit", - "in": "query", - "description": "（任意）1ページあたりの件数。デフォルト値：20。", - "schema": { - "type": "integer", - "default": 20 - } - }, - "LimitQueryParamDefault20Jp": { - "name": "limit", - "in": "query", - "description": "1回のリクエストで返す記録の数、デフォルトは20です。", - "schema": { - "type": "integer", - "default": 20 - } - }, - "LimitQueryParamDefault20Max100Jp": { - "name": "limit", - "in": "query", - "description": "1回のリクエストで返す記録の数、デフォルトは最新の20件です。最大100、最小1。", - "schema": { - "type": "integer", - "default": 20, - "minimum": 1, - "maximum": 100 - } - }, - "UserQueryParamJp": { - "name": "user", - "in": "query", - "required": true, - "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義されるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", - "schema": { - "type": "string" - } - }, - "ConversationIdQueryParamJp": { - "name": "conversation_id", - "in": "query", - "required": true, - "description": "会話ID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - "LastIdQueryParamJp": { - "name": "last_id", - "in": "query", - "description": "(Optional)現在のページの最後の記録のID、デフォルトはnullです。", - "schema": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "SortByQueryParamJp": { - "name": "sort_by", - "in": "query", - "description": "(Optional)ソートフィールド、デフォルト：-updated_at（更新時間で降順にソート）。利用可能な値：created_at, -created_at, updated_at, -updated_at。'-'は逆順を表します。", - "schema": { - "type": "string", - "enum": [ - "created_at", - "-created_at", - "updated_at", - "-updated_at" - ], - "default": "-updated_at" - } - }, - "ConversationIdPathParamJp": { - "name": "conversation_id", - "in": "path", - "required": true, - "description": "会話ID。", - "schema": { - "type": "string", - "format": "uuid" - } - } + "PageQueryParamJp": { "name": "page", "in": "query", "description": "（任意）ページ番号。デフォルト値：1。", "schema": { "type": "integer", "default": 1 } }, + "LimitQueryParamJp": { "name": "limit", "in": "query", "description": "（任意）1ページあたりの件数。デフォルト値：20。", "schema": { "type": "integer", "default": 20 } }, + "LimitQueryParamDefault20Jp": { "name": "limit", "in": "query", "description": "1回のリクエストで返す記録の数、デフォルトは20です。", "schema": { "type": "integer", "default": 20 } }, + "LimitQueryParamDefault20Max100Jp": { "name": "limit", "in": "query", "description": "1回のリクエストで返す記録の数、デフォルトは最新の20件です。最大100、最小1。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, + "UserQueryParamJp": { "name": "user", "in": "query", "required": true, "description": "ユーザー識別子。アプリケーション内で開発者によって一意に定義されるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。", "schema": { "type": "string" } }, + "ConversationIdQueryParamJp": { "name": "conversation_id", "in": "query", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } }, + "LastIdQueryParamJp": { "name": "last_id", "in": "query", "description": "(Optional)現在のページの最後の記録のID、デフォルトはnullです。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, + "SortByQueryParamJp": { "name": "sort_by", "in": "query", "description": "(Optional)ソートフィールド、デフォルト：-updated_at（更新時間で降順にソート）。利用可能な値：created_at, -created_at, updated_at, -updated_at。'-'は逆順を表します。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } }, + "ConversationIdPathParamJp": { "name": "conversation_id", "in": "path", "required": true, "description": "会話ID。", "schema": { "type": "string", "format": "uuid" } } }, "responses": { - "BadRequestGenericJp": { - "description": "リクエストパラメータエラー。考えられる原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "BadRequestFileJp": { - "description": "ファイル操作リクエストエラー。考えられる原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "FileTooLargeJp": { - "description": "ファイルが大きすぎます (file_too_large)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "UnsupportedFileTypeFileJp": { - "description": "サポートされていないファイルタイプ (unsupported_file_type)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "S3ErrorFileJp": { - "description": "S3ストレージサービスエラー。考えられる原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "InternalServerErrorJp": { - "description": "内部サーバーエラー。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "SuccessResultJp": { - "description": "操作成功。", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - } - } - } - } - } - }, - "ConversationNotFoundJp": { - "description": "会話が存在しません。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "EndUserNotFoundJp": { - "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - } + "BadRequestGenericJp": { "description": "リクエストパラメータエラー。考えられる原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "BadRequestFileJp": { "description": "ファイル操作リクエストエラー。考えられる原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "FileTooLargeJp": { "description": "ファイルが大きすぎます (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "UnsupportedFileTypeFileJp": { "description": "サポートされていないファイルタイプ (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "S3ErrorFileJp": { "description": "S3ストレージサービスエラー。考えられる原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "InternalServerErrorJp": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "SuccessResultJp": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, + "ConversationNotFoundJp": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "EndUserNotFoundJp": { "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } } }, "schemas": { "ChatflowRequestJp": { "type": "object", - "required": [ - "query", - "user" - ], + "required": ["query", "user"], "properties": { - "query": { - "type": "string", - "description": "ユーザー入力/質問内容。" - }, + "query": { "type": "string", "description": "ユーザー入力/質問内容。" }, "inputs": { "type": "object", "description": "アプリによって定義されたさまざまな変数値の入力を許可します。変数がファイルタイプの場合、InputFileObjectJp オブジェクトを指定します。", "additionalProperties": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/InputFileObjectJp" - } - ] + "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/components/schemas/InputFileObjectJp" } ] }, "default": {} }, - "response_mode": { - "type": "string", - "enum": [ - "streaming", - "blocking" - ], - "default": "streaming", - "description": "応答の返却モード。streaming (推奨) はSSEを使用。blocking は実行完了後に結果を返します (Cloudflareの100秒タイムアウト制限あり)。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。アプリケーション内で一意であるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。以前のチャット記録に基づいて会話を続ける場合に必要です。" - }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InputFileObjectJp" - }, - "description": "ファイルリスト。モデルがビジョン機能をサポートしている場合に利用可能です。" - }, - "auto_generate_name": { - "type": "boolean", - "default": true, - "description": "タイトルを自動生成。デフォルトはtrue。" - } + "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "応答の返却モード。streaming (推奨) はSSEを使用。blocking は実行完了後に結果を返します (Cloudflareの100秒タイムアウト制限あり)。" }, + "user": { "type": "string", "description": "ユーザー識別子。アプリケーション内で一意であるべきです。**重要な注意事項**: Service API は WebApp で作成された対話を共有しません。API を通じて作成された対話は、WebApp インターフェースで作成されたものとは分離されています。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。以前のチャット記録に基づいて会話を続ける場合に必要です。" }, + "files": { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectJp" }, "description": "ファイルリスト。モデルがビジョン機能をサポートしている場合に利用可能です。" }, + "auto_generate_name": { "type": "boolean", "default": true, "description": "タイトルを自動生成。デフォルトはtrue。" } } }, "InputFileObjectJp": { "type": "object", - "required": [ - "type", - "transfer_method" - ], + "required": ["type", "transfer_method"], "properties": { - "type": { - "type": "string", - "enum": [ - "document", - "image", - "audio", - "video", - "custom" - ], - "description": "ファイルタイプ。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: その他。" - }, - "transfer_method": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ], - "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" - }, - "url": { - "type": "string", - "format": "url", - "description": "画像URL（転送方法が remote_url の場合）" - }, - "upload_file_id": { - "type": "string", - "format": "uuid", - "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" - } + "type": { "type": "string", "enum": ["document", "image", "audio", "video", "custom"], "description": "ファイルタイプ。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: その他。" }, + "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" }, + "url": { "type": "string", "format": "url", "description": "画像URL（転送方法が remote_url の場合）" }, + "upload_file_id": { "type": "string", "format":"uuid", "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" } }, "anyOf": [ { - "properties": { - "transfer_method": { - "enum": [ - "remote_url" - ] - }, - "url": { - "type": "string", - "format": "url" - } + "properties": { + "transfer_method": { "enum": ["remote_url"] }, + "url": { "type": "string", "format": "url" } }, - "required": [ - "url" - ], - "not": { - "required": [ - "upload_file_id" - ] - } + "required": ["url"], + "not": { "required": ["upload_file_id"] } }, { - "properties": { - "transfer_method": { - "enum": [ - "local_file" - ] - }, - "upload_file_id": { - "type": "string", - "format": "uuid" - } + "properties": { + "transfer_method": { "enum": ["local_file"] }, + "upload_file_id": { "type": "string", "format":"uuid" } }, - "required": [ - "upload_file_id" - ], - "not": { - "required": [ - "url" - ] - } + "required": ["upload_file_id"], + "not": { "required": ["url"] } } ] }, "ChatCompletionResponseJp": { - "type": "object", - "description": "ブロッキングモードでの完全なアプリ結果。", + "type": "object", "description": "ブロッキングモードでの完全なアプリ結果。", "properties": { - "event": { - "type": "string", - "example": "message", - "description": "イベントタイプ、固定で `message`。" - }, - "task_id": { - "type": "string", - "format": "uuid", - "description": "タスクID。" - }, - "id": { - "type": "string", - "format": "uuid", - "description": "ユニークID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - }, - "mode": { - "type": "string", - "example": "chat", - "description": "アプリモード、`chat`として固定。" - }, - "answer": { - "type": "string", - "description": "完全な応答内容。" - }, - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataJp" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "メッセージ作成タイムスタンプ。" - } + "event": { "type": "string", "example": "message", "description": "イベントタイプ、固定で `message`。" }, + "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, + "id": { "type": "string", "format": "uuid", "description": "ユニークID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, + "mode": { "type": "string", "example": "chat", "description": "アプリモード、`chat`として固定。" }, + "answer": { "type": "string", "description": "完全な応答内容。" }, + "metadata": { "$ref": "#/components/schemas/ResponseMetadataJp" }, + "created_at": { "type": "integer", "format": "int64", "description": "メッセージ作成タイムスタンプ。" } } }, "ResponseMetadataJp": { - "type": "object", - "description": "メタデータ。", - "properties": { - "usage": { - "$ref": "#/components/schemas/UsageJp" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResourceJp" - }, - "description": "引用と帰属リスト。" - } - } + "type": "object", "description": "メタデータ。", + "properties": { "usage": { "$ref": "#/components/schemas/UsageJp" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJp" }, "description": "引用と帰属リスト。" } } }, "ChunkChatflowEventJp": { - "type": "object", - "required": [ - "event" - ], - "properties": { - "event": { - "type": "string", - "enum": [ - "message", - "message_file", - "message_end", - "tts_message", - "tts_message_end", - "message_replace", - "workflow_started", - "node_started", - "node_finished", - "workflow_finished", - "error", - "ping" - ], - "description": "イベントタイプ。" - } - }, - "discriminator": { - "propertyName": "event", - "mapping": { - "message": "#/components/schemas/StreamEventChatMessageJp", - "message_file": "#/components/schemas/StreamEventMessageFileJp", - "message_end": "#/components/schemas/StreamEventMessageEndJp", - "tts_message": "#/components/schemas/StreamEventTtsMessageJp", - "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJp", - "message_replace": "#/components/schemas/StreamEventMessageReplaceJp", - "workflow_started": "#/components/schemas/StreamEventWorkflowStartedJp", - "node_started": "#/components/schemas/StreamEventNodeStartedJp", - "node_finished": "#/components/schemas/StreamEventNodeFinishedJp", - "workflow_finished": "#/components/schemas/StreamEventWorkflowFinishedJp", - "error": "#/components/schemas/StreamEventErrorJp", - "ping": "#/components/schemas/StreamEventPingJp" - } - } + "type": "object", "required": ["event"], + "properties": { "event": { "type": "string", "enum": ["message", "message_file", "message_end", "tts_message", "tts_message_end", "message_replace", "workflow_started", "node_started", "node_finished", "workflow_finished", "error", "ping"], "description": "イベントタイプ。" } }, + "discriminator": { "propertyName": "event", "mapping": { + "message": "#/components/schemas/StreamEventChatMessageJp", "message_file": "#/components/schemas/StreamEventMessageFileJp", + "message_end": "#/components/schemas/StreamEventMessageEndJp", "tts_message": "#/components/schemas/StreamEventTtsMessageJp", + "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJp", "message_replace": "#/components/schemas/StreamEventMessageReplaceJp", + "workflow_started": "#/components/schemas/StreamEventWorkflowStartedJp", "node_started": "#/components/schemas/StreamEventNodeStartedJp", + "node_finished": "#/components/schemas/StreamEventNodeFinishedJp", "workflow_finished": "#/components/schemas/StreamEventWorkflowFinishedJp", + "error": "#/components/schemas/StreamEventErrorJp", "ping": "#/components/schemas/StreamEventPingJp" + }} }, "StreamEventBaseChatJp": { + "type": "object", "properties": { + "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, + "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } + } + }, + "StreamEventChatMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLMが返したテキストチャンク内容。" } } } ] }, + "StreamEventMessageFileJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["id", "type", "belongs_to", "url", "conversation_id"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ファイル一意ID。" }, "type": { "type": "string", "enum": ["image"], "description": "ファイルタイプ、現在はimageのみ。" }, "belongs_to": { "type": "string", "enum": ["assistant"], "description": "所属、ここではassistantのみ。" }, "url": { "type": "string", "format": "url", "description": "ファイルのリモートURL。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" } } } ] }, + "StreamEventMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataJp" } } } ] }, + "StreamEventTtsMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64エンコードされたオーディオブロック。" } } } ] }, + "StreamEventTtsMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空の文字列。" } } } ] }, + "StreamEventMessageReplaceJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseChatJp" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "置換内容（すべてのLLM返信テキストを直接置き換えます）。" } } } ] }, + "StreamEventWorkflowStartedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/WorkflowStartedDataJp" } } } ] }, + "WorkflowStartedDataJp": { "type": "object", "required": ["id", "workflow_id", "sequence_number", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "関連ワークフローのID。" }, "sequence_number": { "type": "integer", "description": "自己増加シリアル番号、アプリ内で自己増加し、1から始まります。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, + "StreamEventNodeStartedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/NodeStartedDataJp" } } } ] }, + "NodeStartedDataJp": { "type": "object", "required": ["id", "node_id", "node_type", "title", "index", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意ID (文脈からノード実行IDであるべき)。" }, "node_id": { "type": "string", "format": "uuid", "description": "ノードのID。" }, "node_type": { "type": "string", "description": "ノードのタイプ。" }, "title": { "type": "string", "description": "ノードの名前。" }, "index": { "type": "integer", "description": "実行シーケンス番号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "オプションのプレフィックスノードID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ノードで使用されるすべての前のノード変数の内容。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始のタイムスタンプ。" } } }, + "StreamEventNodeFinishedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/NodeFinishedDataJp" } } } ] }, + "NodeFinishedDataJp": { "type": "object", "required": ["id", "node_id", "node_type", "title", "index", "status", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ノード実行の一意ID。" }, "node_id": { "type": "string", "format": "uuid", "description": "ノードのID。" }, "node_type": { "type": "string", "description": "ノードのタイプ。" }, "title": { "type": "string", "description": "ノードの名前。" }, "index": { "type": "integer", "description": "実行シーケンス番号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "オプションのプレフィックスノードID。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "ノードで使用されるすべての前のノード変数の内容。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, "description": "オプションのノードプロセスデータ (JSON)。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "オプションの出力内容 (JSON)。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行の状態。" }, "error": { "type": "string", "nullable": true, "description": "オプションのエラー理由。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "オプションの使用される合計秒数。" }, "execution_metadata": { "$ref": "#/components/schemas/NodeExecutionMetadataJp" , "nullable": true, "description": "メタデータ"}, "created_at": { "type": "integer", "format": "int64", "description": "開始のタイムスタンプ。" } } }, + "NodeExecutionMetadataJp": { "type": "object", "description": "ノード実行メタデータ。", "properties": { "total_tokens": { "type": "integer", "nullable": true, "description": "オプションの使用されるトークン数。" }, "total_price": { "type": "number", "format": "float", "nullable": true, "description": "オプションの合計コスト (floatでdecimalを代用)。" }, "currency": { "type": "string", "nullable": true, "example": "USD", "description": "オプションの通貨。" } } }, + "StreamEventWorkflowFinishedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/WorkflowFinishedDataJp" } } } ] }, + "WorkflowFinishedDataJp": { "type": "object", "required": ["id", "workflow_id", "status", "created_at", "finished_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行のID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "関連ワークフローのID。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行の状態。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "オプションの出力内容 (JSON)。" }, "error": { "type": "string", "nullable": true, "description": "オプションのエラー理由。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "オプションの使用される合計秒数。" }, "total_tokens": { "type": "integer", "nullable": true, "description": "オプションの使用されるトークン数。" }, "total_steps": { "type": "integer", "default": 0, "description": "合計ステップ数、デフォルト0。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始時間。" }, "finished_at": { "type": "integer", "format": "int64", "description": "終了時間。" } } }, + "StreamEventErrorJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "required": ["task_id", "status", "code", "message"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid", "nullable": true, "description": "一意のメッセージID（エラーイベントでは存在しない場合がある）。" }, "status": { "type": "integer", "description": "HTTPステータスコード。" }, "code": { "type": "string", "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } ] }, + "StreamEventPingJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatflowEventJp" }, { "type": "object", "description": "接続を維持するために10秒ごとにpingイベントが発生します。" } ] }, + "UsageJp": { "type": "object", "description": "モデル使用情報。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, + "RetrieverResourceJp": { "type": "object", "description": "引用と帰属リスト。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } }, + "FileUploadResponseJp": { "type": "object", "description": "ファイルアップロード成功時の応答。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ（バイト）。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, + "EndUserDetailJp": { "type": "object", "properties": { - "task_id": { - "type": "string", - "format": "uuid", - "description": "タスクID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - }, - "StreamEventChatMessageJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJp" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "LLMが返したテキストチャンク内容。" - } - } - } - ] - }, - "StreamEventMessageFileJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "type": "object", - "required": [ - "id", - "type", - "belongs_to", - "url", - "conversation_id" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ファイル一意ID。" - }, - "type": { - "type": "string", - "enum": [ - "image" - ], - "description": "ファイルタイプ、現在はimageのみ。" - }, - "belongs_to": { - "type": "string", - "enum": [ - "assistant" - ], - "description": "所属、ここではassistantのみ。" - }, - "url": { - "type": "string", - "format": "url", - "description": "ファイルのリモートURL。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - } - } - } - ] - }, - "StreamEventMessageEndJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJp" - }, - { - "type": "object", - "required": [ - "metadata" - ], - "properties": { - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataJp" - } - } - } - ] - }, - "StreamEventTtsMessageJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJp" - }, - { - "type": "object", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "format": "byte", - "description": "Base64エンコードされたオーディオブロック。" - } - } - } - ] - }, - "StreamEventTtsMessageEndJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJp" - }, - { - "type": "object", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "description": "空の文字列。" - } - } - } - ] - }, - "StreamEventMessageReplaceJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatJp" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "置換内容（すべてのLLM返信テキストを直接置き換えます）。" - } - } - } - ] - }, - "StreamEventWorkflowStartedJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "type": "object", - "required": [ - "task_id", - "workflow_run_id", - "data" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid" - }, - "data": { - "$ref": "#/components/schemas/WorkflowStartedDataJp" - } - } - } - ] - }, - "WorkflowStartedDataJp": { - "type": "object", - "required": [ - "id", - "workflow_id", - "sequence_number", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ワークフロー実行の一意ID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "関連ワークフローのID。" - }, - "sequence_number": { - "type": "integer", - "description": "自己増加シリアル番号、アプリ内で自己増加し、1から始まります。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - }, - "StreamEventNodeStartedJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "type": "object", - "required": [ - "task_id", - "workflow_run_id", - "data" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid" - }, - "data": { - "$ref": "#/components/schemas/NodeStartedDataJp" - } - } - } - ] - }, - "NodeStartedDataJp": { - "type": "object", - "required": [ - "id", - "node_id", - "node_type", - "title", - "index", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ワークフロー実行の一意ID (文脈からノード実行IDであるべき)。" - }, - "node_id": { - "type": "string", - "format": "uuid", - "description": "ノードのID。" - }, - "node_type": { - "type": "string", - "description": "ノードのタイプ。" - }, - "title": { - "type": "string", - "description": "ノードの名前。" - }, - "index": { - "type": "integer", - "description": "実行シーケンス番号。" - }, - "predecessor_node_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "オプションのプレフィックスノードID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "ノードで使用されるすべての前のノード変数の内容。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "開始のタイムスタンプ。" - } - } - }, - "StreamEventNodeFinishedJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "type": "object", - "required": [ - "task_id", - "workflow_run_id", - "data" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid" - }, - "data": { - "$ref": "#/components/schemas/NodeFinishedDataJp" - } - } - } - ] - }, - "NodeFinishedDataJp": { - "type": "object", - "required": [ - "id", - "node_id", - "node_type", - "title", - "index", - "status", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ノード実行の一意ID。" - }, - "node_id": { - "type": "string", - "format": "uuid", - "description": "ノードのID。" - }, - "node_type": { - "type": "string", - "description": "ノードのタイプ。" - }, - "title": { - "type": "string", - "description": "ノードの名前。" - }, - "index": { - "type": "integer", - "description": "実行シーケンス番号。" - }, - "predecessor_node_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "オプションのプレフィックスノードID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "ノードで使用されるすべての前のノード変数の内容。" - }, - "process_data": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "オプションのノードプロセスデータ (JSON)。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "オプションの出力内容 (JSON)。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "実行の状態。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "オプションのエラー理由。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "オプションの使用される合計秒数。" - }, - "execution_metadata": { - "$ref": "#/components/schemas/NodeExecutionMetadataJp", - "nullable": true, - "description": "メタデータ" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "開始のタイムスタンプ。" - } - } - }, - "NodeExecutionMetadataJp": { - "type": "object", - "description": "ノード実行メタデータ。", - "properties": { - "total_tokens": { - "type": "integer", - "nullable": true, - "description": "オプションの使用されるトークン数。" - }, - "total_price": { - "type": "number", - "format": "float", - "nullable": true, - "description": "オプションの合計コスト (floatでdecimalを代用)。" - }, - "currency": { - "type": "string", - "nullable": true, - "example": "USD", - "description": "オプションの通貨。" - } - } - }, - "StreamEventWorkflowFinishedJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "type": "object", - "required": [ - "task_id", - "workflow_run_id", - "data" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid" - }, - "data": { - "$ref": "#/components/schemas/WorkflowFinishedDataJp" - } - } - } - ] - }, - "WorkflowFinishedDataJp": { - "type": "object", - "required": [ - "id", - "workflow_id", - "status", - "created_at", - "finished_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ワークフロー実行のID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "関連ワークフローのID。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "実行の状態。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "オプションの出力内容 (JSON)。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "オプションのエラー理由。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "オプションの使用される合計秒数。" - }, - "total_tokens": { - "type": "integer", - "nullable": true, - "description": "オプションの使用されるトークン数。" - }, - "total_steps": { - "type": "integer", - "default": 0, - "description": "合計ステップ数、デフォルト0。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "開始時間。" - }, - "finished_at": { - "type": "integer", - "format": "int64", - "description": "終了時間。" - } - } - }, - "StreamEventErrorJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "type": "object", - "required": [ - "task_id", - "status", - "code", - "message" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "message_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "一意のメッセージID（エラーイベントでは存在しない場合がある）。" - }, - "status": { - "type": "integer", - "description": "HTTPステータスコード。" - }, - "code": { - "type": "string", - "description": "エラーコード。" - }, - "message": { - "type": "string", - "description": "エラーメッセージ。" - } - } - } - ] - }, - "StreamEventPingJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatflowEventJp" - }, - { - "type": "object", - "description": "接続を維持するために10秒ごとにpingイベントが発生します。" - } - ] - }, - "UsageJp": { - "type": "object", - "description": "モデル使用情報。", - "properties": { - "prompt_tokens": { - "type": "integer" - }, - "prompt_unit_price": { - "type": "string" - }, - "prompt_price_unit": { - "type": "string" - }, - "prompt_price": { - "type": "string" - }, - "completion_tokens": { - "type": "integer" - }, - "completion_unit_price": { - "type": "string" - }, - "completion_price_unit": { - "type": "string" - }, - "completion_price": { - "type": "string" - }, - "total_tokens": { - "type": "integer" - }, - "total_price": { - "type": "string" - }, - "currency": { - "type": "string" - }, - "latency": { - "type": "number", - "format": "double" - } - } - }, - "RetrieverResourceJp": { - "type": "object", - "description": "引用と帰属リスト。", - "properties": { - "position": { - "type": "integer" - }, - "dataset_id": { - "type": "string", - "format": "uuid" - }, - "dataset_name": { - "type": "string" - }, - "document_id": { - "type": "string", - "format": "uuid" - }, - "document_name": { - "type": "string" - }, - "segment_id": { - "type": "string", - "format": "uuid" - }, - "score": { - "type": "number", - "format": "float" - }, - "content": { - "type": "string" - } - } - }, - "FileUploadResponseJp": { - "type": "object", - "description": "ファイルアップロード成功時の応答。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "name": { - "type": "string", - "description": "ファイル名。" - }, - "size": { - "type": "integer", - "description": "ファイルサイズ（バイト）。" - }, - "extension": { - "type": "string", - "description": "ファイル拡張子。" - }, - "mime_type": { - "type": "string", - "description": "ファイルのMIMEタイプ。" - }, - "created_by": { - "type": "string", - "format": "uuid", - "description": "エンドユーザーID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - }, - "EndUserDetailJp": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "tenant_id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "type": { - "type": "string", - "example": "service_api" - }, - "external_user_id": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "is_anonymous": { - "type": "boolean" - }, - "session_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "MessageFeedbackRequestJp": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true, - "description": "アップボートは`like`、ダウンボートは`dislike`、取り消しは`null`。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - }, - "content": { - "type": "string", - "nullable": true, - "description": "メッセージフィードバックの具体的な内容。" - } - } - }, - "AppFeedbacksResponseJp": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeedbackItemJp" - }, - "description": "このアプリの「いいね」とフィードバックの一覧。" - } - } - }, - "FeedbackItemJp": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid" - }, - "conversation_id": { - "type": "string", - "format": "uuid" - }, - "message_id": { - "type": "string", - "format": "uuid" - }, - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true - }, - "content": { - "type": "string" - }, - "from_source": { - "type": "string" - }, - "from_end_user_id": { - "type": "string", - "format": "uuid" - }, - "from_account_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "SuggestedQuestionsResponseJp": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - }, - "data": { - "type": "array", - "items": { - "type": "string" - }, - "description": "推奨質問のリスト。" - } - } - }, - "ConversationHistoryResponseJp": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "返された項目数。" - }, - "has_more": { - "type": "boolean", - "description": "次のページがあるかどうか。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationMessageItemJp" - }, - "description": "メッセージリスト。" - } - } - }, - "ConversationMessageItemJp": { - "type": "object", - "description": "会話内の単一メッセージ。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "メッセージID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "ユーザー入力パラメータ。" - }, - "query": { - "type": "string", - "description": "ユーザー入力/質問内容。" - }, - "answer": { - "type": "string", - "description": "応答メッセージ内容。" - }, - "message_files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MessageFileItemJp" - }, - "description": "メッセージファイルリスト。" - }, - "feedback": { - "type": "object", - "nullable": true, - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike" - ], - "description": "アップボートは`like` / ダウンボートは`dislike`。" - } - }, - "description": "フィードバック情報。" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResourceJp" - }, - "description": "引用と帰属リスト。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - }, - "MessageFileItemJp": { - "type": "object", - "description": "メッセージ内のファイル項目。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "type": { - "type": "string", - "description": "ファイルタイプ、例：'image'。" - }, - "url": { - "type": "string", - "format": "url", - "description": "プレビュー画像URL。" - }, - "belongs_to": { - "type": "string", - "enum": [ - "user", - "assistant" - ], - "description": "所属。" - } - } - }, - "ConversationsListResponseJp": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "返されたエントリ数。" - }, - "has_more": { - "type": "boolean" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationListItemJp" - }, - "description": "会話のリスト。" - } - } - }, - "ConversationListItemJp": { - "type": "object", - "description": "会話リスト内の単一項目。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "会話ID。" - }, - "name": { - "type": "string", - "description": "会話名。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "ユーザー入力パラメータ。" - }, - "status": { - "type": "string", - "description": "会話状態。" - }, - "introduction": { - "type": "string", - "nullable": true, - "description": "紹介。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "更新タイムスタンプ。" - } - } - }, - "ConversationRenameRequestJp": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "name": { - "type": "string", - "nullable": true, - "description": "(Optional)会話の名前。`auto_generate`が`true`の場合省略可。" - }, - "auto_generate": { - "type": "boolean", - "default": false, - "description": "(Optional)タイトルを自動生成、デフォルトは`false`。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - } - } - }, - "ConversationRenameResponseJp": { - "$ref": "#/components/schemas/ConversationListItemJp" - }, - "ConversationVariablesResponseJp": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "ページごとのアイテム数。" - }, - "has_more": { - "type": "boolean", - "description": "さらにアイテムがあるかどうか。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationVariableItemJp" - }, - "description": "変数のリスト。" - } - } - }, - "ConversationVariableItemJp": { - "type": "object", - "description": "会話内の変数項目。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "変数ID。" - }, - "name": { - "type": "string", - "description": "変数名。" - }, - "value_type": { - "type": "string", - "description": "変数タイプ（文字列、数値、真偽値など）。" - }, - "value": { - "type": "string", - "description": "変数値。" - }, - "description": { - "type": "string", - "nullable": true, - "description": "変数の説明。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "最終更新タイムスタンプ。" - } - } - }, - "AudioToTextRequestJp": { - "type": "object", - "required": [ - "file", - "user" - ], - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "オーディオファイル。サポート形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`。サイズ制限：15MB。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - } - } - }, - "AudioToTextResponseJp": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "出力テキスト。" - } - } - }, - "TextToAudioJsonRequestJp": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "message_id": { - "type": "string", - "format": "uuid", - "description": "メッセージID（優先）。" - }, - "text": { - "type": "string", - "description": "音声生成コンテンツ。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - }, - "streaming": { - "type": "boolean", - "default": false, - "description": "trueの場合、応答はオーディオチャンクのストリームになります。" - } - }, - "description": "`user` が必要です。`message_id` または `text` を提供してください。" - }, - "AppInfoResponseJp": { - "type": "object", - "description": "アプリケーションの基本情報。", - "properties": { - "name": { - "type": "string", - "description": "アプリケーションの名前。" - }, - "description": { - "type": "string", - "description": "アプリケーションの説明。" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "アプリケーションのタグ。" - } - } - }, - "ChatAppParametersResponseJp": { - "type": "object", - "description": "アプリケーションのパラメータ情報。", - "properties": { - "opening_statement": { - "type": "string", - "description": "開始の挨拶。" - }, - "suggested_questions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "開始時の推奨質問のリスト。" - }, - "suggested_questions_after_answer": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - } - }, - "description": "答えを有効にした後の質問を提案します。" - }, - "speech_to_text": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - } - }, - "description": "音声からテキストへ。" - }, - "text_to_speech": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - }, - "voice": { - "type": "string", - "description": "音声タイプ。" - }, - "language": { - "type": "string", - "description": "言語。" - }, - "autoPlay": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ], - "description": "自動再生：enabled 有効, disabled 無効。" - } - }, - "description": "テキストから音声へ。" - }, - "retriever_resource": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - } - }, - "description": "引用と帰属。" - }, - "annotation_reply": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "有効かどうか。" - } - }, - "description": "注釈返信。" - }, - "user_input_form": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserInputFormItemJp" - }, - "description": "ユーザー入力フォームの設定。" - }, - "file_upload": { - "type": "object", - "properties": { - "image": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "number_limits": { - "type": "integer" - }, - "detail": { - "type": "string" - }, - "transfer_methods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ] - } - } - }, - "description": "画像設定。サポートされている画像タイプ：png, jpg, jpeg, webp, gif。" - } - }, - "description": "ファイルアップロード設定。" - }, - "system_parameters": { - "type": "object", - "properties": { - "file_size_limit": { - "type": "integer", - "description": "ドキュメントアップロードサイズ制限（MB）。" - }, - "image_file_size_limit": { - "type": "integer", - "description": "画像ファイルアップロードサイズ制限（MB）。" - }, - "audio_file_size_limit": { - "type": "integer", - "description": "オーディオファイルアップロードサイズ制限（MB）。" - }, - "video_file_size_limit": { - "type": "integer", - "description": "ビデオファイルアップロードサイズ制限（MB）。" - } - }, - "description": "システムパラメータ。" - } - } - }, - "UserInputFormItemJp": { - "type": "object", - "description": "ユーザー入力フォームのコントロール項目。", - "oneOf": [ - { - "$ref": "#/components/schemas/TextInputControlWrapperJp" - }, - { - "$ref": "#/components/schemas/ParagraphControlWrapperJp" - }, - { - "$ref": "#/components/schemas/SelectControlWrapperJp" - } - ] - }, - "TextInputControlWrapperJp": { - "type": "object", - "properties": { - "text-input": { - "$ref": "#/components/schemas/TextInputControlJp" - } - }, - "required": [ - "text-input" - ] - }, - "ParagraphControlWrapperJp": { - "type": "object", - "properties": { - "paragraph": { - "$ref": "#/components/schemas/ParagraphControlJp" - } - }, - "required": [ - "paragraph" - ] - }, - "SelectControlWrapperJp": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/SelectControlJp" - } - }, - "required": [ - "select" - ] - }, - "TextInputControlJp": { - "type": "object", - "description": "テキスト入力コントロール。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - } - } - }, - "ParagraphControlJp": { - "type": "object", - "description": "段落テキスト入力コントロール。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - } - } - }, - "SelectControlJp": { - "type": "object", - "description": "ドロップダウンコントロール。", - "required": [ - "label", - "variable", - "required", - "options" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - }, - "options": { - "type": "array", - "items": { - "type": "string" - }, - "description": "オプション値。" - } - } - }, - "AppMetaResponseJp": { - "type": "object", - "description": "アプリケーションのメタ情報。", - "properties": { - "tool_icons": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "string", - "format": "url", - "description": "アイコンのURL。" - }, - { - "$ref": "#/components/schemas/ToolIconDetailJp" - } - ] - }, - "description": "ツールアイコン。キーはツール名です。" - } - } - }, - "ToolIconDetailJp": { - "type": "object", - "description": "ツールアイコン詳細。", - "properties": { - "background": { - "type": "string", - "description": "背景色（16進数形式）。" - }, - "content": { - "type": "string", - "description": "絵文字。" - } - } - }, - "WebAppSettingsResponseJp": { - "type": "object", - "description": "アプリのWebApp設定。", - "properties": { - "title": { - "type": "string", - "description": "WebApp名。" - }, - "chat_color_theme": { - "type": "string", - "description": "チャットの色テーマ、16進数形式。" - }, - "chat_color_theme_inverted": { - "type": "boolean", - "description": "チャットの色テーマを反転するかどうか。" - }, - "icon_type": { - "type": "string", - "enum": [ - "emoji", - "image" - ], - "description": "アイコンタイプ。" - }, - "icon": { - "type": "string", - "description": "アイコン。`emoji`タイプの場合は絵文字、`image`タイプの場合は画像URL。" - }, - "icon_background": { - "type": "string", - "description": "16進数形式の背景色。" - }, - "icon_url": { - "type": "string", - "format": "url", - "nullable": true, - "description": "アイコンのURL。" - }, - "description": { - "type": "string", - "description": "説明。" - }, - "copyright": { - "type": "string", - "description": "著作権情報。" - }, - "privacy_policy": { - "type": "string", - "description": "プライバシーポリシーのリンク。" - }, - "custom_disclaimer": { - "type": "string", - "description": "カスタム免責事項。" - }, - "default_language": { - "type": "string", - "description": "デフォルト言語。" - }, - "show_workflow_steps": { - "type": "boolean", - "description": "ワークフローの詳細を表示するかどうか。" - }, - "use_icon_as_answer_icon": { - "type": "boolean", - "description": "WebAppのアイコンをチャット内のロボットアイコンに置き換えるかどうか。" - } - } - }, - "ErrorResponseJp": { - "type": "object", - "description": "エラー応答。", - "properties": { - "status": { - "type": "integer", - "nullable": true, - "description": "HTTPステータスコード。" - }, - "code": { - "type": "string", - "nullable": true, - "description": "エラーコード。" - }, - "message": { - "type": "string", - "description": "エラーメッセージ。" - } - } - } + "id": { "type": "string", "format": "uuid" }, + "tenant_id": { "type": "string", "format": "uuid" }, + "app_id": { "type": "string", "format": "uuid", "nullable": true }, + "type": { "type": "string", "example": "service_api" }, + "external_user_id": { "type": "string", "nullable": true }, + "name": { "type": "string", "nullable": true }, + "is_anonymous": { "type": "boolean" }, + "session_id": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + } + }, + "MessageFeedbackRequestJp": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "アップボートは`like`、ダウンボートは`dislike`、取り消しは`null`。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "content": { "type": "string", "nullable": true, "description": "メッセージフィードバックの具体的な内容。" } } }, + "AppFeedbacksResponseJp": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemJp" }, "description": "このアプリの「いいね」とフィードバックの一覧。" } } }, + "FeedbackItemJp": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, + "SuggestedQuestionsResponseJp": { "type": "object", "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "string" }, "description": "推奨質問のリスト。" } } }, + "ConversationHistoryResponseJp": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返された項目数。" }, "has_more": { "type": "boolean", "description": "次のページがあるかどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMessageItemJp" }, "description": "メッセージリスト。" } } }, + "ConversationMessageItemJp": { "type": "object", "description": "会話内の単一メッセージ。", "properties": { "id": { "type": "string", "format": "uuid", "description": "メッセージID。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会話ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ユーザー入力パラメータ。" }, "query": { "type": "string", "description": "ユーザー入力/質問内容。" }, "answer": { "type": "string", "description": "応答メッセージ内容。" }, "message_files": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFileItemJp" }, "description": "メッセージファイルリスト。" }, "feedback": { "type": "object", "nullable": true, "properties": { "rating": { "type": "string", "enum": ["like", "dislike"], "description": "アップボートは`like` / ダウンボートは`dislike`。" } }, "description": "フィードバック情報。" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJp" }, "description": "引用と帰属リスト。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, + "MessageFileItemJp": { "type": "object", "description": "メッセージ内のファイル項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "ファイルタイプ、例：'image'。" }, "url": { "type": "string", "format": "url", "description": "プレビュー画像URL。" }, "belongs_to": { "type": "string", "enum": ["user", "assistant"], "description": "所属。" } } }, + "ConversationsListResponseJp": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返されたエントリ数。" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationListItemJp" }, "description": "会話のリスト。" } } }, + "ConversationListItemJp": { "type": "object", "description": "会話リスト内の単一項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "会話ID。" }, "name": { "type": "string", "description": "会話名。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ユーザー入力パラメータ。" }, "status": { "type": "string", "description": "会話状態。" }, "introduction": { "type": "string", "nullable": true, "description": "紹介。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, "updated_at": { "type": "integer", "format": "int64", "description": "更新タイムスタンプ。" } } }, + "ConversationRenameRequestJp": { "type": "object", "required": ["user"], "properties": { "name": { "type": "string", "nullable": true, "description": "(Optional)会話の名前。`auto_generate`が`true`の場合省略可。" }, "auto_generate": { "type": "boolean", "default": false, "description": "(Optional)タイトルを自動生成、デフォルトは`false`。" }, "user": { "type": "string", "description": "ユーザー識別子。" } } }, + "ConversationRenameResponseJp": { "$ref": "#/components/schemas/ConversationListItemJp" }, + "ConversationVariablesResponseJp": { "type": "object", "properties": { "limit": { "type": "integer", "description": "ページごとのアイテム数。" }, "has_more": { "type": "boolean", "description": "さらにアイテムがあるかどうか。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationVariableItemJp" }, "description": "変数のリスト。" } } }, + "ConversationVariableItemJp": { "type": "object", "description": "会話内の変数項目。", "properties": { "id": { "type": "string", "format": "uuid", "description": "変数ID。" }, "name": { "type": "string", "description": "変数名。" }, "value_type": { "type": "string", "description": "変数タイプ（文字列、数値、真偽値など）。" }, "value": { "type": "string", "description": "変数値。" }, "description": { "type": "string", "nullable": true, "description": "変数の説明。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" }, "updated_at": { "type": "integer", "format": "int64", "description": "最終更新タイムスタンプ。" } } }, + "AudioToTextRequestJp": { "type": "object", "required": ["file", "user"], "properties": { "file": { "type": "string", "format": "binary", "description": "オーディオファイル。サポート形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`。サイズ制限：15MB。" }, "user": { "type": "string", "description": "ユーザー識別子。" } } }, + "AudioToTextResponseJp": { "type": "object", "properties": { "text": { "type": "string", "description": "出力テキスト。" } } }, + "TextToAudioJsonRequestJp": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "メッセージID（優先）。" }, "text": { "type": "string", "description": "音声生成コンテンツ。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "streaming": {"type": "boolean", "default": false, "description": "trueの場合、応答はオーディオチャンクのストリームになります。"} }, "description": "`user` が必要です。`message_id` または `text` を提供してください。" }, + "AppInfoResponseJp": { "type": "object", "description": "アプリケーションの基本情報。", "properties": { "name": { "type": "string", "description": "アプリケーションの名前。" }, "description": { "type": "string", "description": "アプリケーションの説明。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "アプリケーションのタグ。" } } }, + "ChatAppParametersResponseJp": { "type": "object", "description": "アプリケーションのパラメータ情報。", "properties": { "opening_statement": { "type": "string", "description": "開始の挨拶。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "開始時の推奨質問のリスト。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "答えを有効にした後の質問を提案します。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "音声からテキストへ。" }, "text_to_speech": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" }, "voice": { "type": "string", "description": "音声タイプ。" }, "language": { "type": "string", "description": "言語。" }, "autoPlay": { "type": "string", "enum": ["enabled", "disabled"], "description": "自動再生：enabled 有効, disabled 無効。" } }, "description": "テキストから音声へ。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "引用と帰属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "有効かどうか。" } }, "description": "注釈返信。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemJp" }, "description": "ユーザー入力フォームの設定。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "detail": { "type": "string" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "画像設定。サポートされている画像タイプ：png, jpg, jpeg, webp, gif。" } }, "description": "ファイルアップロード設定。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "ドキュメントアップロードサイズ制限（MB）。" }, "image_file_size_limit": { "type": "integer", "description": "画像ファイルアップロードサイズ制限（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "オーディオファイルアップロードサイズ制限（MB）。" }, "video_file_size_limit": { "type": "integer", "description": "ビデオファイルアップロードサイズ制限（MB）。" } }, "description": "システムパラメータ。" } } }, + "UserInputFormItemJp": { "type": "object", "description": "ユーザー入力フォームのコントロール項目。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperJp" }, { "$ref": "#/components/schemas/ParagraphControlWrapperJp" }, { "$ref": "#/components/schemas/SelectControlWrapperJp" } ] }, + "TextInputControlWrapperJp": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlJp" } }, "required":["text-input"] }, + "ParagraphControlWrapperJp": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlJp" } }, "required":["paragraph"] }, + "SelectControlWrapperJp": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlJp" } }, "required":["select"] }, + "TextInputControlJp": { "type": "object", "description": "テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, + "ParagraphControlJp": { "type": "object", "description": "段落テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, + "SelectControlJp": { "type": "object", "description": "ドロップダウンコントロール。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "オプション値。" } } }, + "AppMetaResponseJp": { "type": "object", "description": "アプリケーションのメタ情報。", "properties": { "tool_icons": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "format": "url", "description": "アイコンのURL。" }, { "$ref": "#/components/schemas/ToolIconDetailJp" } ] }, "description": "ツールアイコン。キーはツール名です。" } } }, + "ToolIconDetailJp": { "type": "object", "description": "ツールアイコン詳細。", "properties": { "background": { "type": "string", "description": "背景色（16進数形式）。" }, "content": { "type": "string", "description": "絵文字。" } } }, + "WebAppSettingsResponseJp": { "type": "object", "description": "アプリのWebApp設定。", "properties": { "title": { "type": "string", "description": "WebApp名。" }, "chat_color_theme": { "type": "string", "description": "チャットの色テーマ、16進数形式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "チャットの色テーマを反転するかどうか。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "アイコンタイプ。" }, "icon": { "type": "string", "description": "アイコン。`emoji`タイプの場合は絵文字、`image`タイプの場合は画像URL。" }, "icon_background": { "type": "string", "description": "16進数形式の背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "アイコンのURL。" }, "description": { "type": "string", "description": "説明。" }, "copyright": { "type": "string", "description": "著作権情報。" }, "privacy_policy": { "type": "string", "description": "プライバシーポリシーのリンク。" }, "custom_disclaimer": { "type": "string", "description": "カスタム免責事項。" }, "default_language": { "type": "string", "description": "デフォルト言語。" }, "show_workflow_steps": { "type": "boolean", "description": "ワークフローの詳細を表示するかどうか。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "WebAppのアイコンをチャット内のロボットアイコンに置き換えるかどうか。" } } }, + "ErrorResponseJp": { "type": "object", "description": "エラー応答。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTPステータスコード。" }, "code": { "type": "string", "nullable": true, "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } } }, "tags": [ - { - "name": "チャットメッセージ", - "description": "チャットメッセージとインタラクションに関連する操作。" - }, - { - "name": "ファイル操作", - "description": "ファイルアップロードとプレビューに関連する操作。" - }, - { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作。" - }, - { - "name": "メッセージフィードバック", - "description": "ユーザーメッセージへのフィードバック操作。" - }, - { - "name": "会話管理", - "description": "会話セッションの管理に関連する操作。" - }, - { - "name": "音声・テキスト変換", - "description": "テキストから音声へ、音声からテキストへの変換操作。" - }, - { - "name": "アプリケーション設定", - "description": "アプリケーション設定と情報の取得に関連する操作。" - } + { "name": "チャットメッセージ", "description": "チャットメッセージとインタラクションに関連する操作。" }, + { "name": "ファイル操作", "description": "ファイルアップロードとプレビューに関連する操作。" }, + { "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" }, + { "name": "メッセージフィードバック", "description": "ユーザーメッセージへのフィードバック操作。" }, + { "name": "会話管理", "description": "会話セッションの管理に関連する操作。" }, + { "name": "音声・テキスト変換", "description": "テキストから音声へ、音声からテキストへの変換操作。" }, + { "name": "アプリケーション設定", "description": "アプリケーション設定と情報の取得に関連する操作。" } ] -} +} \ No newline at end of file diff --git a/ja/api-reference/openapi_completion.json b/ja/api-reference/openapi_completion.json index 8fe9291de..ad6948204 100644 --- a/ja/api-reference/openapi_completion.json +++ b/ja/api-reference/openapi_completion.json @@ -28,9 +28,7 @@ "summary": "完了メッセージの作成", "description": "テキスト生成アプリケーションにリクエストを送信します。", "operationId": "createCompletionMessageJp", - "tags": [ - "完了メッセージ" - ], + "tags": ["完了メッセージ"], "requestBody": { "description": "完了メッセージを作成するためのリクエストボディ。", "required": true, @@ -43,9 +41,7 @@ "streaming_example_jp": { "summary": "ストリーミングモードの例", "value": { - "inputs": { - "query": "こんにちは、世界！" - }, + "inputs": {"query": "こんにちは、世界！"}, "response_mode": "streaming", "user": "jp_user_123" } @@ -71,18 +67,9 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequestGenericJp" - }, - "404": { - "$ref": "#/components/responses/ConversationNotFoundJp" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/completion/create-completion-message" + "400": { "$ref": "#/components/responses/BadRequestGenericJp" }, + "404": { "$ref": "#/components/responses/ConversationNotFoundJp" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJp" } } } }, @@ -91,9 +78,7 @@ "summary": "ファイルアップロード", "description": "メッセージ送信時に使用するファイル（現在は画像のみ対応）をアップロードし、画像とテキストのマルチモーダルな理解を可能にします。png、jpg、jpeg、webp、gif形式に対応しています。アップロードされたファイルは、現在のエンドユーザーのみが使用できます。", "operationId": "uploadCompletionFileJp", - "tags": [ - "ファイル操作" - ], + "tags": ["ファイル操作"], "requestBody": { "description": "ファイルアップロードリクエスト。`multipart/form-data` 形式が必要です。", "required": true, @@ -101,64 +86,23 @@ "multipart/form-data": { "schema": { "type": "object", - "required": [ - "file", - "user" - ], + "required": ["file", "user"], "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "アップロードするファイル。" - }, - "user": { - "type": "string", - "description": "開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。" - } + "file": { "type": "string", "format": "binary", "description": "アップロードするファイル。" }, + "user": { "type": "string", "description": "開発者のルールで定義されたユーザー識別子。アプリケーション内で一意である必要があります。" } } } } } }, "responses": { - "200": { - "description": "ファイルアップロード成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseJp" - } - } - } - }, - "201": { - "description": "ファイル作成成功（代替成功コード）。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseJp" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequestFileJp" - }, - "413": { - "$ref": "#/components/responses/FileTooLargeJp" - }, - "415": { - "$ref": "#/components/responses/UnsupportedFileTypeFileJp" - }, - "503": { - "$ref": "#/components/responses/S3ErrorFileJp" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/files/file-upload" + "200": { "description": "ファイルアップロード成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } }, + "201": { "description": "ファイル作成成功（代替成功コード）。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } }, + "400": { "$ref": "#/components/responses/BadRequestFileJp" }, + "413": { "$ref": "#/components/responses/FileTooLargeJp" }, + "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileJp" }, + "503": { "$ref": "#/components/responses/S3ErrorFileJp" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJp" } } } }, @@ -167,19 +111,14 @@ "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", "operationId": "getEndUserCompletionJp", - "tags": [ - "エンドユーザー" - ], + "tags": ["エンドユーザー"], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "エンドユーザーID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -187,21 +126,12 @@ "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/EndUserDetailJp" - } + "schema": { "$ref": "#/components/schemas/EndUserDetailJp" } } } }, - "404": { - "$ref": "#/components/responses/EndUserNotFoundJp" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/end-users/get-end-user" + "404": { "$ref": "#/components/responses/EndUserNotFoundJp" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJp" } } } }, @@ -210,48 +140,15 @@ "summary": "生成の停止", "description": "完了メッセージの生成を停止します。ストリーミングモードでのみサポートされています。", "operationId": "stopCompletionGenerationJp", - "tags": [ - "完了メッセージ" - ], + "tags": ["完了メッセージ"], "parameters": [ - { - "name": "task_id", - "in": "path", - "required": true, - "description": "タスクID、ストリーミングチャンクの返信から取得可能。", - "schema": { - "type": "string", - "format": "uuid" - } - } + { "name": "task_id", "in": "path", "required": true, "description": "タスクID、ストリーミングチャンクの返信から取得可能。", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "user": { - "type": "string", - "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致する必要があります。" - } - } - } - } - } - }, - "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultJp" - } + "content": { "application/json": { "schema": { "type": "object", "required": ["user"], "properties": { "user": { "type": "string", "description": "ユーザー識別子。メッセージ送信インターフェースで渡されたユーザーと一致する必要があります。" } } } } } }, - "x-mint": { - "href": "/ja/api-reference/completion/stop-generate" - } + "responses": { "200": { "$ref": "#/components/responses/SuccessResultJp" } } } }, "/messages/{message_id}/feedbacks": { @@ -259,39 +156,10 @@ "summary": "メッセージフィードバック", "description": "エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのに役立ちます。", "operationId": "postCompletionMessageFeedbackJp", - "tags": [ - "メッセージフィードバック" - ], - "parameters": [ - { - "name": "message_id", - "in": "path", - "required": true, - "description": "メッセージID。", - "schema": { - "type": "string", - "format": "uuid" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MessageFeedbackRequestJp" - } - } - } - }, - "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/feedback/message-feedback" - } + "tags": ["メッセージフィードバック"], + "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "メッセージID。", "schema": { "type": "string", "format": "uuid" } } ], + "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestJp" } } } }, + "responses": { "200": { "$ref": "#/components/responses/SuccessResultJp" } } } }, "/app/feedbacks": { @@ -299,44 +167,12 @@ "summary": "アプリのメッセージの「いいね」とフィードバックを取得", "description": "アプリのエンドユーザーからのフィードバックや「いいね」を取得します。", "operationId": "getAppFeedbacksCompletionJp", - "tags": [ - "メッセージフィードバック" - ], + "tags": ["メッセージフィードバック"], "parameters": [ - { - "name": "page", - "in": "query", - "description": "（任意）ページ番号。デフォルト値：1。", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "limit", - "in": "query", - "description": "（任意）1ページあたりの件数。デフォルト値：20。", - "schema": { - "type": "integer", - "default": 20 - } - } + { "name": "page", "in": "query", "description": "（任意）ページ番号。デフォルト値：1。", "schema": { "type": "integer", "default": 1 } }, + { "name": "limit", "in": "query", "description": "（任意）1ページあたりの件数。デフォルト値：20。", "schema": { "type": "integer", "default": 20 } } ], - "responses": { - "200": { - "description": "フィードバックリストの取得成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFeedbacksResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/feedback/get-feedbacks-of-application" - } + "responses": { "200": { "description": "フィードバックリストの取得成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseJp" } } } } } } }, "/text-to-audio": { @@ -344,48 +180,13 @@ "summary": "テキストから音声", "description": "テキストを音声に変換します。", "operationId": "textToAudioCompletionJp", - "tags": [ - "音声変換" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TextToAudioRequestJp" - } - } - } - }, + "tags": ["音声変換"], + "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextToAudioRequestJp" } } } }, "responses": { "200": { - "description": "音声ファイル生成成功。", - "content": { - "audio/wav": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "audio/mp3": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "headers": { - "Content-Type": { - "schema": { - "type": "string", - "example": "audio/wav" - } - } - } + "description": "音声ファイル生成成功。", "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, + "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } } - }, - "x-mint": { - "href": "/ja/api-reference/tts/text-to-audio" } } }, @@ -393,1196 +194,145 @@ "get": { "summary": "アプリケーションの基本情報を取得", "operationId": "getCompletionAppInfoJp", - "tags": [ - "アプリケーション情報" - ], - "responses": { - "200": { - "description": "アプリケーション基本情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfoResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-basic-information" - } + "tags": ["アプリケーション情報"], + "responses": { "200": { "description": "アプリケーション基本情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseJp" } } } } } } }, "/parameters": { "get": { "summary": "アプリケーションのパラメータ情報を取得", "operationId": "getCompletionAppParametersJp", - "tags": [ - "アプリケーション情報" - ], - "responses": { - "200": { - "description": "アプリケーションパラメータ情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CompletionAppParametersResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-parameters-information" - } + "tags": ["アプリケーション情報"], + "responses": { "200": { "description": "アプリケーションパラメータ情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletionAppParametersResponseJp" } } } } } } }, "/site": { "get": { "summary": "アプリのWebApp設定を取得", "operationId": "getCompletionWebAppSettingsJp", - "tags": [ - "アプリケーション情報" - ], - "responses": { - "200": { - "description": "WebApp設定。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebAppSettingsResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-webapp-settings" - } + "tags": ["アプリケーション情報"], + "responses": { "200": { "description": "WebApp設定。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseJp" } } } } } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "API_KEY", - "description": "API-Key認証。すべてのAPIリクエストで、`Authorization` HTTPヘッダーに `Bearer {API_KEY}` の形式でAPIキーを含めてください。APIキーの漏洩を避けるため、サーバーサイドでの保存を強く推奨します。" - } + "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key認証。すべてのAPIリクエストで、`Authorization` HTTPヘッダーに `Bearer {API_KEY}` の形式でAPIキーを含めてください。APIキーの漏洩を避けるため、サーバーサイドでの保存を強く推奨します。" } }, "responses": { - "BadRequestGenericJp": { - "description": "リクエストパラメータエラー。エラーコード例: invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "ConversationNotFoundJp": { - "description": "会話が存在しません。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "InternalServerErrorJp": { - "description": "内部サーバーエラー。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "BadRequestFileJp": { - "description": "ファイル操作リクエストエラー。エラーコード例: no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "FileTooLargeJp": { - "description": "ファイルが大きすぎます (file_too_large)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "UnsupportedFileTypeFileJp": { - "description": "サポートされていないファイルタイプです (unsupported_file_type)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "S3ErrorFileJp": { - "description": "S3ストレージサービスエラー。エラーコード例: s3_connection_failed, s3_permission_denied, s3_file_too_large。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "SuccessResultJp": { - "description": "操作成功。", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - } - } - } - } - } - }, - "EndUserNotFoundJp": { - "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - } + "BadRequestGenericJp": { "description": "リクエストパラメータエラー。エラーコード例: invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "ConversationNotFoundJp": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "InternalServerErrorJp": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "BadRequestFileJp": { "description": "ファイル操作リクエストエラー。エラーコード例: no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "FileTooLargeJp": { "description": "ファイルが大きすぎます (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "UnsupportedFileTypeFileJp": { "description": "サポートされていないファイルタイプです (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "S3ErrorFileJp": { "description": "S3ストレージサービスエラー。エラーコード例: s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "SuccessResultJp": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, + "EndUserNotFoundJp": { "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } } }, "schemas": { "CompletionRequestJp": { - "type": "object", - "required": [ - "inputs" - ], + "type": "object", "required": ["inputs"], "properties": { - "inputs": { - "type": "object", - "required": [ - "query" - ], - "properties": { - "query": { - "type": "string", - "description": "入力テキスト、処理される内容。" - } - }, - "additionalProperties": true, - "description": "アプリで定義された各種変数値を入力。少なくとも1つのキー/値ペアが必要。" - }, - "response_mode": { - "type": "string", - "enum": [ - "streaming", - "blocking" - ], - "default": "streaming", - "description": "レスポンス返却モード。streaming (推奨): SSEによるタイプライター風出力。blocking: 実行完了後に結果返却 (Cloudflare 100秒制限あり)。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。アプリケーション内で開発者が一意に定義。" - }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InputFileObjectJp" - }, - "description": "(任意) ファイルリスト。モデルがVision機能をサポートしている場合のみ利用可能。" - } + "inputs": { "type": "object", "required": ["query"], "properties": { "query": { "type": "string", "description": "入力テキスト、処理される内容。" } }, "additionalProperties": true, "description": "アプリで定義された各種変数値を入力。少なくとも1つのキー/値ペアが必要。" }, + "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "レスポンス返却モード。streaming (推奨): SSEによるタイプライター風出力。blocking: 実行完了後に結果返却 (Cloudflare 100秒制限あり)。" }, + "user": { "type": "string", "description": "ユーザー識別子。アプリケーション内で開発者が一意に定義。" }, + "files": { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectJp" }, "description": "(任意) ファイルリスト。モデルがVision機能をサポートしている場合のみ利用可能。" } } }, "InputFileObjectJp": { - "type": "object", - "required": [ - "type", - "transfer_method" - ], + "type": "object", "required": ["type", "transfer_method"], "properties": { - "type": { - "type": "string", - "enum": [ - "image" - ], - "description": "サポートされるタイプ：`image`（現在は画像タイプのみサポート）。" - }, - "transfer_method": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ], - "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" - }, - "url": { - "type": "string", - "format": "url", - "description": "画像URL（転送方法が remote_url の場合）" - }, - "upload_file_id": { - "type": "string", - "format": "uuid", - "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" - } + "type": { "type": "string", "enum": ["image"], "description": "サポートされるタイプ：`image`（現在は画像タイプのみサポート）。" }, + "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" }, + "url": { "type": "string", "format": "url", "description": "画像URL（転送方法が remote_url の場合）" }, + "upload_file_id": { "type": "string", "format": "uuid", "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" } }, "anyOf": [ { - "properties": { - "transfer_method": { - "enum": [ - "remote_url" - ] - }, - "url": { - "type": "string", - "format": "url" - } + "properties": { + "transfer_method": { "enum": ["remote_url"] }, + "url": { "type": "string", "format": "url" } }, - "required": [ - "url" - ], - "not": { - "required": [ - "upload_file_id" - ] - } + "required": ["url"], + "not": { "required": ["upload_file_id"] } }, { - "properties": { - "transfer_method": { - "enum": [ - "local_file" - ] - }, - "upload_file_id": { - "type": "string", - "format": "uuid" - } + "properties": { + "transfer_method": { "enum": ["local_file"] }, + "upload_file_id": { "type": "string", "format": "uuid" } }, - "required": [ - "upload_file_id" - ], - "not": { - "required": [ - "url" - ] - } + "required": ["upload_file_id"], + "not": { "required": ["url"] } } ] }, "CompletionResponseJp": { - "type": "object", - "description": "ブロッキングモードでのアプリの完全な結果。", - "properties": { - "event": { - "type": "string", - "description": "イベントタイプ、通常 'message'。(MarkdownではChatCompletionResponseで 'chat' とあったが、Completionの文脈では 'completion' or 'message' が一般的。blocking example に合わせて 'message' を使用)" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "mode": { - "type": "string", - "description": "アプリモード。ブロッキングモードの例では 'completion'、Markdown本文では 'chat' と記載。ここでは 'completion' を採用。" - }, - "answer": { - "type": "string", - "description": "完全な応答内容。" - }, - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataJp" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "メッセージ作成タイムスタンプ。" - } - } - }, - "ResponseMetadataJp": { - "type": "object", - "description": "メタデータ。", + "type": "object", "description": "ブロッキングモードでのアプリの完全な結果。", "properties": { - "usage": { - "$ref": "#/components/schemas/UsageJp" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResourceJp" - }, - "description": "引用と帰属のリスト。" - } + "event": { "type": "string", "description": "イベントタイプ、通常 'message'。(MarkdownではChatCompletionResponseで 'chat' とあったが、Completionの文脈では 'completion' or 'message' が一般的。blocking example に合わせて 'message' を使用)" }, + "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, + "mode": { "type": "string", "description": "アプリモード。ブロッキングモードの例では 'completion'、Markdown本文では 'chat' と記載。ここでは 'completion' を採用。" }, + "answer": { "type": "string", "description": "完全な応答内容。" }, + "metadata": { "$ref": "#/components/schemas/ResponseMetadataJp" }, + "created_at": { "type": "integer", "format": "int64", "description": "メッセージ作成タイムスタンプ。" } } }, + "ResponseMetadataJp": { "type": "object", "description": "メタデータ。", "properties": { "usage": { "$ref": "#/components/schemas/UsageJp" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceJp" }, "description": "引用と帰属のリスト。" } } }, "ChunkCompletionEventJp": { - "type": "object", - "required": [ - "event" - ], - "properties": { - "event": { - "type": "string", - "enum": [ - "message", - "message_end", - "tts_message", - "tts_message_end", - "message_replace", - "error", - "ping" - ], - "description": "イベントタイプ。" - } - }, - "discriminator": { - "propertyName": "event", - "mapping": { - "message": "#/components/schemas/StreamEventMessageJp", - "message_end": "#/components/schemas/StreamEventMessageEndJp", - "tts_message": "#/components/schemas/StreamEventTtsMessageJp", - "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJp", - "message_replace": "#/components/schemas/StreamEventMessageReplaceJp", - "error": "#/components/schemas/StreamEventErrorJp", - "ping": "#/components/schemas/StreamEventPingJp" - } - } - }, - "StreamEventBaseCompletionJp": { + "type": "object", "required": ["event"], + "properties": { "event": { "type": "string", "enum": ["message", "message_end", "tts_message", "tts_message_end", "message_replace", "error", "ping"], "description": "イベントタイプ。" } }, + "discriminator": { "propertyName": "event", "mapping": { "message": "#/components/schemas/StreamEventMessageJp", "message_end": "#/components/schemas/StreamEventMessageEndJp", "tts_message": "#/components/schemas/StreamEventTtsMessageJp", "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndJp", "message_replace": "#/components/schemas/StreamEventMessageReplaceJp", "error": "#/components/schemas/StreamEventErrorJp", "ping": "#/components/schemas/StreamEventPingJp" } } + }, + "StreamEventBaseCompletionJp": { "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, + "StreamEventMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLMが返したテキストチャンクの内容。" } } } ] }, + "StreamEventMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataJp" } } } ] }, + "StreamEventTtsMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64エンコードされた音声ブロック。" } } } ] }, + "StreamEventTtsMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空文字列。" } } } ] }, + "StreamEventMessageReplaceJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "置換内容。" } } } ] }, + "StreamEventErrorJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseCompletionJp" }, { "type": "object", "required": ["status", "code", "message"], "properties": { "status": { "type": "integer", "description": "HTTPステータスコード。" }, "code": { "type": "string", "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } ] }, + "StreamEventPingJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkCompletionEventJp" }, { "type": "object", "description": "接続維持のためのPingイベント。" } ] }, + "UsageJp": { "type": "object", "description": "モデル使用情報。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, + "RetrieverResourceJp": { "type": "object", "description": "引用と帰属の情報。", "properties": { "document_id": { "type": "string" }, "segment_id": { "type": "string" }, "score": { "type": "number" }, "content": { "type": "string" } } }, + "FileUploadResponseJp": { "type": "object", "description": "ファイルアップロード成功時のレスポンス。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ（バイト）。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, + "EndUserDetailJp": { "type": "object", "properties": { - "task_id": { - "type": "string", - "format": "uuid", - "description": "タスクID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - }, - "StreamEventMessageJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkCompletionEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseCompletionJp" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "LLMが返したテキストチャンクの内容。" - } - } - } - ] - }, - "StreamEventMessageEndJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkCompletionEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseCompletionJp" - }, - { - "type": "object", - "required": [ - "metadata" - ], - "properties": { - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataJp" - } - } - } - ] - }, - "StreamEventTtsMessageJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkCompletionEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseCompletionJp" - }, - { - "type": "object", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "format": "byte", - "description": "Base64エンコードされた音声ブロック。" - } - } - } - ] - }, - "StreamEventTtsMessageEndJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkCompletionEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseCompletionJp" - }, - { - "type": "object", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "description": "空文字列。" - } - } - } - ] - }, - "StreamEventMessageReplaceJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkCompletionEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseCompletionJp" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "置換内容。" - } - } - } - ] - }, - "StreamEventErrorJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkCompletionEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseCompletionJp" - }, - { - "type": "object", - "required": [ - "status", - "code", - "message" - ], - "properties": { - "status": { - "type": "integer", - "description": "HTTPステータスコード。" - }, - "code": { - "type": "string", - "description": "エラーコード。" - }, - "message": { - "type": "string", - "description": "エラーメッセージ。" - } - } - } - ] - }, - "StreamEventPingJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkCompletionEventJp" - }, - { - "type": "object", - "description": "接続維持のためのPingイベント。" - } - ] - }, - "UsageJp": { - "type": "object", - "description": "モデル使用情報。", - "properties": { - "prompt_tokens": { - "type": "integer" - }, - "prompt_unit_price": { - "type": "string" - }, - "prompt_price_unit": { - "type": "string" - }, - "prompt_price": { - "type": "string" - }, - "completion_tokens": { - "type": "integer" - }, - "completion_unit_price": { - "type": "string" - }, - "completion_price_unit": { - "type": "string" - }, - "completion_price": { - "type": "string" - }, - "total_tokens": { - "type": "integer" - }, - "total_price": { - "type": "string" - }, - "currency": { - "type": "string" - }, - "latency": { - "type": "number", - "format": "double" - } - } - }, - "RetrieverResourceJp": { - "type": "object", - "description": "引用と帰属の情報。", - "properties": { - "document_id": { - "type": "string" - }, - "segment_id": { - "type": "string" - }, - "score": { - "type": "number" - }, - "content": { - "type": "string" - } - } - }, - "FileUploadResponseJp": { - "type": "object", - "description": "ファイルアップロード成功時のレスポンス。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "name": { - "type": "string", - "description": "ファイル名。" - }, - "size": { - "type": "integer", - "description": "ファイルサイズ（バイト）。" - }, - "extension": { - "type": "string", - "description": "ファイル拡張子。" - }, - "mime_type": { - "type": "string", - "description": "ファイルのMIMEタイプ。" - }, - "created_by": { - "type": "string", - "format": "uuid", - "description": "エンドユーザーID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - }, - "EndUserDetailJp": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "tenant_id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "type": { - "type": "string", - "example": "service_api" - }, - "external_user_id": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "is_anonymous": { - "type": "boolean" - }, - "session_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "MessageFeedbackRequestJp": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true, - "description": "高評価 `like`, 低評価 `dislike`, 取り消し `null`。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - }, - "content": { - "type": "string", - "nullable": true, - "description": "メッセージフィードバックの具体的な内容。" - } - } - }, - "AppFeedbacksResponseJp": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeedbackItemJp" - }, - "description": "このアプリの「いいね」とフィードバックの一覧。" - } - } - }, - "FeedbackItemJp": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid" - }, - "conversation_id": { - "type": "string", - "format": "uuid" - }, - "message_id": { - "type": "string", - "format": "uuid" - }, - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true - }, - "content": { - "type": "string" - }, - "from_source": { - "type": "string" - }, - "from_end_user_id": { - "type": "string", - "format": "uuid" - }, - "from_account_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "TextToAudioRequestJp": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "message_id": { - "type": "string", - "format": "uuid", - "description": "メッセージID（textより優先）。" - }, - "text": { - "type": "string", - "description": "音声生成コンテンツ。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - } - }, - "description": "`user`が必須。`message_id`または`text`のいずれかを提供。" - }, - "AppInfoResponseJp": { - "type": "object", - "description": "アプリケーションの基本情報。", - "properties": { - "name": { - "type": "string", - "description": "アプリケーションの名前。" - }, - "description": { - "type": "string", - "description": "アプリケーションの説明。" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "アプリケーションのタグ。" - } - } - }, - "CompletionAppParametersResponseJp": { - "type": "object", - "description": "アプリケーションのパラメータ情報。", - "properties": { - "opening_statement": { - "type": "string", - "description": "開始文。" - }, - "suggested_questions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "開始時の提案質問リスト。" - }, - "suggested_questions_after_answer": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "description": "回答後の提案質問。" - }, - "speech_to_text": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "description": "音声からテキスト。" - }, - "retriever_resource": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "description": "引用と帰属。" - }, - "annotation_reply": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - } - }, - "description": "注釈付き返信。" - }, - "user_input_form": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserInputFormItemJp" - }, - "description": "ユーザー入力フォーム設定。" - }, - "file_upload": { - "type": "object", - "properties": { - "image": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "number_limits": { - "type": "integer" - }, - "detail": { - "type": "string" - }, - "transfer_methods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ] - } - } - }, - "description": "画像設定。" - } - }, - "description": "ファイルアップロード設定。" - }, - "system_parameters": { - "type": "object", - "properties": { - "file_size_limit": { - "type": "integer" - }, - "image_file_size_limit": { - "type": "integer" - }, - "audio_file_size_limit": { - "type": "integer" - }, - "video_file_size_limit": { - "type": "integer" - } - }, - "description": "システムパラメータ。" - } - } - }, - "UserInputFormItemJp": { - "type": "object", - "description": "ユーザー入力フォームのコントロール項目。", - "oneOf": [ - { - "$ref": "#/components/schemas/TextInputControlWrapperJp" - }, - { - "$ref": "#/components/schemas/ParagraphControlWrapperJp" - }, - { - "$ref": "#/components/schemas/SelectControlWrapperJp" - } - ] - }, - "TextInputControlWrapperJp": { - "type": "object", - "properties": { - "text-input": { - "$ref": "#/components/schemas/TextInputControlJp" - } - }, - "required": [ - "text-input" - ] - }, - "ParagraphControlWrapperJp": { - "type": "object", - "properties": { - "paragraph": { - "$ref": "#/components/schemas/ParagraphControlJp" - } - }, - "required": [ - "paragraph" - ] - }, - "SelectControlWrapperJp": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/SelectControlJp" - } - }, - "required": [ - "select" - ] - }, - "TextInputControlJp": { - "type": "object", - "description": "テキスト入力コントロール。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - } - } - }, - "ParagraphControlJp": { - "type": "object", - "description": "段落テキスト入力コントロール。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - } - } - }, - "SelectControlJp": { - "type": "object", - "description": "ドロップダウンコントロール。", - "required": [ - "label", - "variable", - "required", - "options" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必须かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - }, - "options": { - "type": "array", - "items": { - "type": "string" - }, - "description": "オプション値。" - } - } - }, - "WebAppSettingsResponseJp": { - "type": "object", - "description": "アプリケーションのWebApp設定。", - "properties": { - "title": { - "type": "string", - "description": "WebApp名。" - }, - "chat_color_theme": { - "type": "string", - "description": "チャットの色テーマ（16進数）。" - }, - "chat_color_theme_inverted": { - "type": "boolean", - "description": "テーマ反転。" - }, - "icon_type": { - "type": "string", - "enum": [ - "emoji", - "image" - ], - "description": "アイコンタイプ。" - }, - "icon": { - "type": "string", - "description": "アイコン（emojiまたは画像URL）。" - }, - "icon_background": { - "type": "string", - "description": "背景色（16進数）。" - }, - "icon_url": { - "type": "string", - "format": "url", - "nullable": true, - "description": "アイコンURL。" - }, - "description": { - "type": "string", - "description": "説明。" - }, - "copyright": { - "type": "string", - "description": "著作権情報。" - }, - "privacy_policy": { - "type": "string", - "description": "プライバシーポリシーリンク。" - }, - "custom_disclaimer": { - "type": "string", - "description": "カスタム免責事項。" - }, - "default_language": { - "type": "string", - "description": "デフォルト言語。" - }, - "show_workflow_steps": { - "type": "boolean", - "description": "ワークフロー詳細表示。" - }, - "use_icon_as_answer_icon": { - "type": "boolean", - "description": "WebAppアイコンを返信アイコンとして使用。" - } - } - }, - "ErrorResponseJp": { - "type": "object", - "description": "エラーレスポンス。", - "properties": { - "status": { - "type": "integer", - "nullable": true, - "description": "HTTPステータスコード。" - }, - "code": { - "type": "string", - "nullable": true, - "description": "エラーコード。" - }, - "message": { - "type": "string", - "description": "エラーメッセージ。" - } - } - } + "id": { "type": "string", "format": "uuid" }, + "tenant_id": { "type": "string", "format": "uuid" }, + "app_id": { "type": "string", "format": "uuid", "nullable": true }, + "type": { "type": "string", "example": "service_api" }, + "external_user_id": { "type": "string", "nullable": true }, + "name": { "type": "string", "nullable": true }, + "is_anonymous": { "type": "boolean" }, + "session_id": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + } + }, + "MessageFeedbackRequestJp": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "高評価 `like`, 低評価 `dislike`, 取り消し `null`。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "content": { "type": "string", "nullable": true, "description": "メッセージフィードバックの具体的な内容。" } } }, + "AppFeedbacksResponseJp": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemJp" }, "description": "このアプリの「いいね」とフィードバックの一覧。" } } }, + "FeedbackItemJp": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, + "TextToAudioRequestJp": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "メッセージID（textより優先）。" }, "text": { "type": "string", "description": "音声生成コンテンツ。" }, "user": { "type": "string", "description": "ユーザー識別子。" } }, "description": "`user`が必須。`message_id`または`text`のいずれかを提供。" }, + "AppInfoResponseJp": { "type": "object", "description": "アプリケーションの基本情報。", "properties": { "name": { "type": "string", "description": "アプリケーションの名前。" }, "description": { "type": "string", "description": "アプリケーションの説明。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "アプリケーションのタグ。" } } }, + "CompletionAppParametersResponseJp": { "type": "object", "description": "アプリケーションのパラメータ情報。", "properties": { "opening_statement": { "type": "string", "description": "開始文。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "開始時の提案質問リスト。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "description": "回答後の提案質問。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "description": "音声からテキスト。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "description": "引用と帰属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "description": "注釈付き返信。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemJp" }, "description": "ユーザー入力フォーム設定。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "detail": { "type": "string" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "画像設定。" } }, "description": "ファイルアップロード設定。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer" }, "image_file_size_limit": { "type": "integer" }, "audio_file_size_limit": { "type": "integer" }, "video_file_size_limit": { "type": "integer" } }, "description": "システムパラメータ。" } } }, + "UserInputFormItemJp": { "type": "object", "description": "ユーザー入力フォームのコントロール項目。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperJp" }, { "$ref": "#/components/schemas/ParagraphControlWrapperJp" }, { "$ref": "#/components/schemas/SelectControlWrapperJp" } ] }, + "TextInputControlWrapperJp": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlJp" } }, "required":["text-input"] }, + "ParagraphControlWrapperJp": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlJp" } }, "required":["paragraph"] }, + "SelectControlWrapperJp": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlJp" } }, "required":["select"] }, + "TextInputControlJp": { "type": "object", "description": "テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, + "ParagraphControlJp": { "type": "object", "description": "段落テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, + "SelectControlJp": { "type": "object", "description": "ドロップダウンコントロール。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必须かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "オプション値。" } } }, + "WebAppSettingsResponseJp": { "type": "object", "description": "アプリケーションのWebApp設定。", "properties": { "title": { "type": "string", "description": "WebApp名。" }, "chat_color_theme": { "type": "string", "description": "チャットの色テーマ（16進数）。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "テーマ反転。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "アイコンタイプ。" }, "icon": { "type": "string", "description": "アイコン（emojiまたは画像URL）。" }, "icon_background": { "type": "string", "description": "背景色（16進数）。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "アイコンURL。" }, "description": { "type": "string", "description": "説明。" }, "copyright": { "type": "string", "description": "著作権情報。" }, "privacy_policy": { "type": "string", "description": "プライバシーポリシーリンク。" }, "custom_disclaimer": { "type": "string", "description": "カスタム免責事項。" }, "default_language": { "type": "string", "description": "デフォルト言語。" }, "show_workflow_steps": { "type": "boolean", "description": "ワークフロー詳細表示。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "WebAppアイコンを返信アイコンとして使用。" } } }, + "ErrorResponseJp": { "type": "object", "description": "エラーレスポンス。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTPステータスコード。" }, "code": { "type": "string", "nullable": true, "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } } }, "tags": [ - { - "name": "完了メッセージ", - "description": "テキスト生成と完了に関連する操作。" - }, - { - "name": "ファイル操作", - "description": "ファイル管理に関連する操作。" - }, - { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作。" - }, - { - "name": "メッセージフィードバック", - "description": "ユーザーフィードバックに関連する操作。" - }, - { - "name": "音声変換", - "description": "テキストから音声への変換に関連する操作。" - }, - { - "name": "アプリケーション情報", - "description": "アプリケーションの設定と情報を取得する操作。" - } + { "name": "完了メッセージ", "description": "テキスト生成と完了に関連する操作。" }, + { "name": "ファイル操作", "description": "ファイル管理に関連する操作。" }, + { "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" }, + { "name": "メッセージフィードバック", "description": "ユーザーフィードバックに関連する操作。" }, + { "name": "音声変換", "description": "テキストから音声への変換に関連する操作。" }, + { "name": "アプリケーション情報", "description": "アプリケーションの設定と情報を取得する操作。" } ] -} +} \ No newline at end of file diff --git a/ja/api-reference/openapi_knowledge.json b/ja/api-reference/openapi_knowledge.json index 349c18566..d55eecd87 100644 --- a/ja/api-reference/openapi_knowledge.json +++ b/ja/api-reference/openapi_knowledge.json @@ -77,9 +77,6 @@ "409": { "$ref": "#/components/responses/DatasetNameDuplicate" } - }, - "x-mint": { - "href": "/ja/api-reference/datasets/create-an-empty-knowledge-base" } }, "get": { @@ -152,9 +149,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/datasets/get-knowledge-base-list" } } }, @@ -189,9 +183,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/datasets/get-knowledge-base-details" } }, "patch": { @@ -237,9 +228,6 @@ "409": { "$ref": "#/components/responses/DatasetNameDuplicate" } - }, - "x-mint": { - "href": "/ja/api-reference/datasets/update-knowledge-base" } }, "delete": { @@ -265,9 +253,6 @@ "204": { "description": "データセットの削除に成功しました。" } - }, - "x-mint": { - "href": "/ja/api-reference/datasets/delete-a-knowledge-base" } } }, @@ -312,9 +297,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/documents/create-a-document-from-text" } } }, @@ -380,9 +362,6 @@ "415": { "$ref": "#/components/responses/UnsupportedFileType" } - }, - "x-mint": { - "href": "/ja/api-reference/documents/create-a-document-from-a-file" } } }, @@ -437,9 +416,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/documents/update-a-document-with-text" } } }, @@ -506,9 +482,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/documents/update-a-document-with-a-file" } } }, @@ -560,9 +533,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/documents/get-document-embedding-status-progress" } } }, @@ -621,9 +591,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/documents/get-document-detail" } }, "delete": { @@ -659,9 +626,6 @@ "204": { "description": "ドキュメントの削除に成功しました。" } - }, - "x-mint": { - "href": "/ja/api-reference/documents/delete-a-document" } } }, @@ -724,9 +688,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/documents/get-the-document-list-of-a-knowledge-base" } } }, @@ -792,9 +753,6 @@ "200": { "$ref": "#/components/responses/Success" } - }, - "x-mint": { - "href": "/ja/api-reference/documents/update-document-status" } } }, @@ -849,9 +807,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/chunks/add-chunks-to-a-document" } }, "get": { @@ -931,9 +886,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/chunks/get-chunks-from-a-document" } } }, @@ -988,9 +940,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/chunks/get-a-chunk-details-in-a-document" } }, "post": { @@ -1053,9 +1002,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/chunks/update-a-chunk-in-a-document" } }, "delete": { @@ -1101,9 +1047,6 @@ "204": { "description": "セグメントの削除に成功しました。" } - }, - "x-mint": { - "href": "/ja/api-reference/chunks/delete-a-chunk-in-a-document" } } }, @@ -1148,9 +1091,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/datasets/retrieve-chunks-from-a-knowledge-base-test-retrieval" } } }, @@ -1181,9 +1121,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/models/get-available-embedding-models" } } }, @@ -1248,9 +1185,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/chunks/create-child-chunk" } }, "get": { @@ -1330,9 +1264,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/chunks/get-child-chunks" } } }, @@ -1407,9 +1338,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/chunks/update-child-chunk" } }, "delete": { @@ -1465,9 +1393,6 @@ "204": { "description": "子チャンクの削除に成功しました。" } - }, - "x-mint": { - "href": "/ja/api-reference/chunks/delete-child-chunk" } } }, @@ -1510,9 +1435,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/metadata-tags/create-new-knowledge-base-type-tag" } }, "get": { @@ -1536,9 +1458,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/metadata-tags/get-knowledge-base-type-tags" } }, "patch": { @@ -1585,9 +1504,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/metadata-tags/modify-knowledge-base-type-tag-name" } }, "delete": { @@ -1621,9 +1537,6 @@ "200": { "$ref": "#/components/responses/Success" } - }, - "x-mint": { - "href": "/ja/api-reference/metadata-tags/delete-knowledge-base-type-tag" } } }, @@ -1668,9 +1581,6 @@ "200": { "$ref": "#/components/responses/Success" } - }, - "x-mint": { - "href": "/ja/api-reference/metadata-tags/bind-dataset-to-knowledge-base-type-tag" } } }, @@ -1712,9 +1622,6 @@ "200": { "$ref": "#/components/responses/Success" } - }, - "x-mint": { - "href": "/ja/api-reference/metadata-tags/unbind-dataset-and-knowledge-base-type-tag" } } }, @@ -1769,9 +1676,6 @@ } } } - }, - "x-mint": { - "href": "/ja/api-reference/metadata-tags/query-tags-bound-to-a-dataset" } } } diff --git a/ja/api-reference/openapi_workflow.json b/ja/api-reference/openapi_workflow.json index cf9c7f004..16269a904 100644 --- a/ja/api-reference/openapi_workflow.json +++ b/ja/api-reference/openapi_workflow.json @@ -28,9 +28,7 @@ "summary": "ワークフローを実行", "description": "ワークフローを実行します。公開されたワークフローがないと実行できません。", "operationId": "executeWorkflowJp", - "tags": [ - "ワークフロー実行" - ], + "tags": ["ワークフロー実行"], "requestBody": { "required": true, "content": { @@ -49,7 +47,7 @@ "user": "workflow_user_jp_001" } }, - "with_file_array_variable_jp": { + "with_file_array_variable_jp":{ "summary": "ファイルリスト変数を含む入力の例", "value": { "inputs": { @@ -91,15 +89,8 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequestWorkflowJp" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/workflow-execution/execute-workflow" + "400": { "$ref": "#/components/responses/BadRequestWorkflowJp" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJp" } } } }, @@ -108,19 +99,14 @@ "summary": "ワークフロー実行詳細を取得", "description": "ワークフロー実行IDに基づいて、ワークフロータスクの現在の実行結果を取得します。", "operationId": "getWorkflowRunDetailJp", - "tags": [ - "ワークフロー実行" - ], + "tags": ["ワークフロー実行"], "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "ワークフロー実行ID。ワークフロー実行の応答またはストリーミングイベントから取得できます。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -128,18 +114,11 @@ "description": "ワークフロー実行詳細の取得に成功しました。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowRunDetailResponseJp" - } + "schema": { "$ref": "#/components/schemas/WorkflowRunDetailResponseJp" } } } }, - "404": { - "description": "ワークフロー実行記録が見つかりません。" - } - }, - "x-mint": { - "href": "/ja/api-reference/workflow-execution/get-workflow-run-detail" + "404": {"description": "ワークフロー実行記録が見つかりません。"} } } }, @@ -148,19 +127,14 @@ "summary": "生成を停止 (ワークフロータスク)", "description": "ワークフロータスクの生成を停止します。ストリーミングモードでのみサポートされています。", "operationId": "stopWorkflowTaskGenerationJp", - "tags": [ - "ワークフロー実行" - ], + "tags": ["ワークフロー実行"], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "タスクID。ストリーミングチャンクの返り値から取得可能。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { @@ -169,26 +143,16 @@ "application/json": { "schema": { "type": "object", - "required": [ - "user" - ], + "required": ["user"], "properties": { - "user": { - "type": "string", - "description": "ユーザー識別子。実行ワークフローAPIに渡されたユーザーと一致する必要があります。" - } + "user": { "type": "string", "description": "ユーザー識別子。実行ワークフローAPIに渡されたユーザーと一致する必要があります。" } } } } } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/workflow-execution/stop-workflow-task-generation" + "200": { "$ref": "#/components/responses/SuccessResultJp" } } } }, @@ -197,73 +161,30 @@ "summary": "ファイルアップロード (ワークフロー用)", "description": "ワークフローで使用するファイルをアップロードします。ワークフローでサポートされている任意の形式をサポートします。アップロードされたファイルは、現在のエンドユーザーのみが使用できます。", "operationId": "uploadWorkflowFileJp", - "tags": [ - "ファイル操作 (ワークフロー)" - ], + "tags": ["ファイル操作 (ワークフロー)"], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", - "required": [ - "file", - "user" - ], + "required": ["file", "user"], "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "アップロードするファイル。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。" - } + "file": { "type": "string", "format": "binary", "description": "アップロードするファイル。" }, + "user": { "type": "string", "description": "ユーザー識別子。" } } } } } }, "responses": { - "200": { - "description": "ファイルのアップロードに成功しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseJp" - } - } - } - }, - "201": { - "description": "ファイルの作成に成功しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseJp" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequestFileJp" - }, - "413": { - "$ref": "#/components/responses/FileTooLargeJp" - }, - "415": { - "$ref": "#/components/responses/UnsupportedFileTypeFileJp" - }, - "503": { - "$ref": "#/components/responses/S3ErrorFileJp" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/files/file-upload-for-workflow" + "200": { "description": "ファイルのアップロードに成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } }, + "201": { "description": "ファイルの作成に成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseJp" } } } }, + "400": { "$ref": "#/components/responses/BadRequestFileJp" }, + "413": { "$ref": "#/components/responses/FileTooLargeJp" }, + "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileJp" }, + "503": { "$ref": "#/components/responses/S3ErrorFileJp" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJp" } } } }, @@ -272,19 +193,14 @@ "summary": "エンドユーザー取得", "description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。", "operationId": "getEndUserWorkflowJp", - "tags": [ - "エンドユーザー" - ], + "tags": ["エンドユーザー"], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "エンドユーザーID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -292,1548 +208,241 @@ "description": "エンドユーザーの取得に成功しました。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/EndUserDetailJp" - } + "schema": { "$ref": "#/components/schemas/EndUserDetailJp" } } } }, - "404": { - "$ref": "#/components/responses/EndUserNotFoundJp" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorJp" - } - }, - "x-mint": { - "href": "/ja/api-reference/end-users/get-end-user" + "404": { "$ref": "#/components/responses/EndUserNotFoundJp" }, + "500": { "$ref": "#/components/responses/InternalServerErrorJp" } } } }, "/workflows/logs": { - "get": { - "summary": "ワークフローログを取得", - "description": "ワークフローログを返します。最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", - "operationId": "getWorkflowLogsJp", - "tags": [ - "ワークフロー実行" - ], - "parameters": [ - { - "name": "keyword", - "in": "query", - "description": "（オプション）検索するキーワード。", - "schema": { - "type": "string" - } - }, - { - "name": "status", - "in": "query", - "description": "（オプション）実行ステータス：succeeded, failed, stopped, running。", - "schema": { - "type": "string", - "enum": [ - "succeeded", - "failed", - "stopped", - "running" - ] - } - }, - { - "name": "page", - "in": "query", - "description": "（オプション）現在のページ、デフォルトは1。", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "limit", - "in": "query", - "description": "（オプション）1回のリクエストで返すアイテムの数、デフォルトは20。", - "schema": { - "type": "integer", - "default": 20 - } - } - ], - "responses": { - "200": { - "description": "ワークフローログの取得に成功しました。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowLogsResponseJp" - } - } + "get": { + "summary": "ワークフローログを取得", + "description": "ワークフローログを返します。最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。", + "operationId": "getWorkflowLogsJp", + "tags": ["ワークフロー実行"], + "parameters": [ + { "name": "keyword", "in": "query", "description": "（オプション）検索するキーワード。", "schema": { "type": "string" } }, + { "name": "status", "in": "query", "description": "（オプション）実行ステータス：succeeded, failed, stopped, running。", "schema": { "type": "string", "enum": ["succeeded", "failed", "stopped", "running"] } }, + { "name": "page", "in": "query", "description": "（オプション）現在のページ、デフォルトは1。", "schema": { "type": "integer", "default": 1 } }, + { "name": "limit", "in": "query", "description": "（オプション）1回のリクエストで返すアイテムの数、デフォルトは20。", "schema": { "type": "integer", "default": 20 } } + ], + "responses": { + "200": { "description": "ワークフローログの取得に成功しました。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowLogsResponseJp" } } } } } - } - }, - "x-mint": { - "href": "/ja/api-reference/workflow-execution/get-workflow-logs" } - } }, "/info": { "get": { "summary": "アプリケーションの基本情報を取得 (ワークフロー)", "operationId": "getWorkflowAppInfoJp", - "tags": [ - "アプリケーション設定 (ワークフロー)" - ], - "responses": { - "200": { - "description": "アプリケーションの基本情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfoResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-basic-information" - } + "tags": ["アプリケーション設定 (ワークフロー)"], + "responses": { "200": { "description": "アプリケーションの基本情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseJp" } } } } } } }, "/parameters": { "get": { "summary": "アプリケーションのパラメータ情報を取得 (ワークフロー)", "operationId": "getWorkflowAppParametersJp", - "tags": [ - "アプリケーション設定 (ワークフロー)" - ], - "responses": { - "200": { - "description": "アプリケーションのパラメータ情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowAppParametersResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-parameters-information" - } + "tags": ["アプリケーション設定 (ワークフロー)"], + "responses": { "200": { "description": "アプリケーションのパラメータ情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAppParametersResponseJp" } } } } } } }, "/site": { "get": { "summary": "アプリのWebApp設定を取得 (ワークフロー)", "operationId": "getWorkflowWebAppSettingsJp", - "tags": [ - "アプリケーション設定 (ワークフロー)" - ], - "responses": { - "200": { - "description": "WebApp設定情報。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowWebAppSettingsResponseJp" - } - } - } - } - }, - "x-mint": { - "href": "/ja/api-reference/application/get-application-webapp-settings" - } + "tags": ["アプリケーション設定 (ワークフロー)"], + "responses": { "200": { "description": "WebApp設定情報。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowWebAppSettingsResponseJp" } } } } } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "API_KEY", - "description": "API-Key認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください（例：Bearer {API_KEY}）。APIキーの漏洩を防ぐため、サーバー側で保存することを強くお勧めします。" - } + "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key認証。すべてのAPIリクエストにおいて、Authorization HTTPヘッダーにAPIキーを含めてください（例：Bearer {API_KEY}）。APIキーの漏洩を防ぐため、サーバー側で保存することを強くお勧めします。" } }, "responses": { - "BadRequestWorkflowJp": { - "description": "リクエストパラメータエラーまたはワークフロー実行失敗。考えられるエラーコード：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, workflow_request_error。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "BadRequestFileJp": { - "description": "ファイル操作リクエストエラー。考えられるエラーコード：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "FileTooLargeJp": { - "description": "ファイルが大きすぎます (file_too_large)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "UnsupportedFileTypeFileJp": { - "description": "サポートされていないファイルタイプです (unsupported_file_type)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "S3ErrorFileJp": { - "description": "S3ストレージサービスエラー。考えられるエラーコード：s3_connection_failed, s3_permission_denied, s3_file_too_large。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "InternalServerErrorJp": { - "description": "内部サーバーエラー。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - }, - "SuccessResultJp": { - "description": "操作に成功しました。", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - } - } - } - } - } - }, - "EndUserNotFoundJp": { - "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseJp" - } - } - } - } + "BadRequestWorkflowJp": { "description": "リクエストパラメータエラーまたはワークフロー実行失敗。考えられるエラーコード：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, workflow_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "BadRequestFileJp": { "description": "ファイル操作リクエストエラー。考えられるエラーコード：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "FileTooLargeJp": { "description": "ファイルが大きすぎます (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "UnsupportedFileTypeFileJp": { "description": "サポートされていないファイルタイプです (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "S3ErrorFileJp": { "description": "S3ストレージサービスエラー。考えられるエラーコード：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "InternalServerErrorJp": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }, + "SuccessResultJp": { "description": "操作に成功しました。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, + "EndUserNotFoundJp": { "description": "エンドユーザーが見つかりません。エラーコード：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } } }, "schemas": { "WorkflowExecutionRequestJp": { "type": "object", - "required": [ - "inputs", - "response_mode", - "user" - ], + "required": ["inputs", "response_mode", "user"], "properties": { "inputs": { "type": "object", "description": "アプリで定義されたさまざまな変数値の入力を許可します。変数がファイルリストの場合、その値はInputFileObjectWorkflowJpオブジェクトのリストである必要があります。", "additionalProperties": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/InputFileObjectWorkflowJp" - } - } - ] + "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object" }, { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectWorkflowJp" } } ] }, - "example": { - "user_query": "これを翻訳してください。", - "target_language": "フランス語" - } - }, - "response_mode": { - "type": "string", - "enum": [ - "streaming", - "blocking" - ], - "description": "応答の返却モード。streaming (推奨) はSSEに基づきます。blocking は実行完了後に結果を返します (Cloudflareの100秒タイムアウト制限あり)。" - }, - "user": { - "type": "string", - "description": "ユーザー識別子。アプリケーション内で一意である必要があります。" + "example": { "user_query": "これを翻訳してください。", "target_language": "フランス語" } }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InputFileObjectWorkflowJp" - }, - "description": "（オプション）このフィールドはinputs内のファイル型変数に置き換えられました。下位互換性のために残されていますが、inputsを使用することを推奨します。" - } + "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "description": "応答の返却モード。streaming (推奨) はSSEに基づきます。blocking は実行完了後に結果を返します (Cloudflareの100秒タイムアウト制限あり)。" }, + "user": { "type": "string", "description": "ユーザー識別子。アプリケーション内で一意である必要があります。" }, + "files": { "type": "array", "items": {"$ref": "#/components/schemas/InputFileObjectWorkflowJp"}, "description": "（オプション）このフィールドはinputs内のファイル型変数に置き換えられました。下位互換性のために残されていますが、inputsを使用することを推奨します。"} } }, "InputFileObjectWorkflowJp": { "type": "object", - "required": [ - "type", - "transfer_method" - ], + "required": ["type", "transfer_method"], "properties": { - "type": { - "type": "string", - "enum": [ - "document", - "image", - "audio", - "video", - "custom" - ], - "description": "ファイルタイプ。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: その他。" - }, - "transfer_method": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ], - "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" - }, - "url": { - "type": "string", - "format": "url", - "description": "画像URL（転送方法が remote_url の場合）" - }, - "upload_file_id": { - "type": "string", - "format": "uuid", - "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" - } + "type": { "type": "string", "enum": ["document", "image", "audio", "video", "custom"], "description": "ファイルタイプ。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: その他。" }, + "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "転送方法。remote_url は画像URL / local_file はファイルアップロード用" }, + "url": { "type": "string", "format": "url", "description": "画像URL（転送方法が remote_url の場合）" }, + "upload_file_id": { "type": "string", "format": "uuid", "description": "アップロードされたファイルID、事前にファイルアップロードAPIで取得する必要があります（転送方法が local_file の場合）" } }, "anyOf": [ { - "properties": { - "transfer_method": { - "enum": [ - "remote_url" - ] - }, - "url": { - "type": "string", - "format": "url" - } + "properties": { + "transfer_method": { "enum": ["remote_url"] }, + "url": { "type": "string", "format": "url" } }, - "required": [ - "url" - ], - "not": { - "required": [ - "upload_file_id" - ] - } + "required": ["url"], + "not": { "required": ["upload_file_id"] } }, { - "properties": { - "transfer_method": { - "enum": [ - "local_file" - ] - }, - "upload_file_id": { - "type": "string", - "format": "uuid" - } + "properties": { + "transfer_method": { "enum": ["local_file"] }, + "upload_file_id": { "type": "string", "format": "uuid" } }, - "required": [ - "upload_file_id" - ], - "not": { - "required": [ - "url" - ] - } + "required": ["upload_file_id"], + "not": { "required": ["url"] } } ] }, "WorkflowCompletionResponseJp": { - "type": "object", - "description": "ブロッキングモードでのワークフロー実行結果。", + "type": "object", "description": "ブロッキングモードでのワークフロー実行結果。", "properties": { - "workflow_run_id": { - "type": "string", - "format": "uuid", - "description": "ワークフロー実行の一意のID。" - }, - "task_id": { - "type": "string", - "format": "uuid", - "description": "タスクID。" - }, - "data": { - "$ref": "#/components/schemas/WorkflowFinishedDataJp" - } + "workflow_run_id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意のID。" }, + "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, + "data": { "$ref": "#/components/schemas/WorkflowFinishedDataJp" } } }, "ChunkWorkflowEventJp": { - "type": "object", - "required": [ - "event" - ], - "properties": { - "event": { - "type": "string", - "enum": [ - "workflow_started", - "node_started", - "text_chunk", - "node_finished", - "workflow_finished", - "tts_message", - "tts_message_end", - "ping" - ], - "description": "イベントタイプ。" - } - }, - "discriminator": { - "propertyName": "event", - "mapping": { - "workflow_started": "#/components/schemas/StreamEventWfWorkflowStartedJp", - "node_started": "#/components/schemas/StreamEventWfNodeStartedJp", - "text_chunk": "#/components/schemas/StreamEventWfTextChunkJp", - "node_finished": "#/components/schemas/StreamEventWfNodeFinishedJp", - "workflow_finished": "#/components/schemas/StreamEventWfWorkflowFinishedJp", - "tts_message": "#/components/schemas/StreamEventWfTtsMessageJp", - "tts_message_end": "#/components/schemas/StreamEventWfTtsMessageEndJp", - "ping": "#/components/schemas/StreamEventWfPingJp" - } - } + "type": "object", "required": ["event"], + "properties": { "event": { "type": "string", "enum": ["workflow_started", "node_started", "text_chunk", "node_finished", "workflow_finished", "tts_message", "tts_message_end", "ping"], "description": "イベントタイプ。" } }, + "discriminator": { "propertyName": "event", "mapping": { + "workflow_started": "#/components/schemas/StreamEventWfWorkflowStartedJp", "node_started": "#/components/schemas/StreamEventWfNodeStartedJp", + "text_chunk": "#/components/schemas/StreamEventWfTextChunkJp", "node_finished": "#/components/schemas/StreamEventWfNodeFinishedJp", + "workflow_finished": "#/components/schemas/StreamEventWfWorkflowFinishedJp", "tts_message": "#/components/schemas/StreamEventWfTtsMessageJp", + "tts_message_end": "#/components/schemas/StreamEventWfTtsMessageEndJp", "ping": "#/components/schemas/StreamEventWfPingJp" + }} }, "StreamEventBaseWfJp": { + "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid", "description": "タスクID。" }, "workflow_run_id": { "type": "string", "format": "uuid", "description": "ワークフロー実行ID。" } } + }, + "StreamEventWfWorkflowStartedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowStartedDataJp" } } } ] }, + "WorkflowStartedDataJp": { "type": "object", "description": "ワークフロー開始イベントの詳細。", "required": ["id", "workflow_id", "sequence_number", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意のID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "関連するワークフローのID。" }, "sequence_number": { "type": "integer", "description": "自己増加シリアル番号、1から始まります。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始時間。" } } }, + "StreamEventWfNodeStartedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/NodeStartedDataJp" } } } ] }, + "NodeStartedDataJp": { "type": "object", "description": "ノード開始イベントの詳細。", "required": ["id", "node_id", "node_type", "title", "index", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行の一意のID（文脈上、ノード実行IDであるべき）。" }, "node_id": { "type": "string", "format": "uuid", "description": "ノードのID。" }, "node_type": { "type": "string", "description": "ノードのタイプ。" }, "title": { "type": "string", "description": "ノードの名前。" }, "index": { "type": "integer", "description": "実行シーケンス番号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（オプション）前のノードID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "ノードで使用されるすべての前のノード変数の内容。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始のタイムスタンプ。" } } }, + "StreamEventWfTextChunkJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TextChunkDataJp" } } } ] }, + "TextChunkDataJp": { "type": "object", "description": "テキストフラグメントイベントの詳細。", "required": ["text", "from_variable_selector"], "properties": { "text": { "type": "string", "description": "テキスト内容。" }, "from_variable_selector": { "type": "array", "items": { "type": "string" }, "description": "テキスト生成元パス。" } } }, + "StreamEventWfNodeFinishedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/NodeFinishedDataJp" } } } ] }, + "NodeFinishedDataJp": { "type": "object", "description": "ノード終了イベントの詳細。", "required": ["id", "node_id", "index", "status", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ノード実行ID。" }, "node_id": { "type": "string", "format": "uuid", "description": "ノードのID。" }, "index": { "type": "integer", "description": "実行シーケンス番号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（オプション）前のノードID。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "ノードで使用されるすべての前のノード変数の内容。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（オプション）ノードプロセスデータ (JSON)。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（オプション）出力内容 (JSON)。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行のステータス。" }, "error": { "type": "string", "nullable": true, "description": "（オプション）エラー理由。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（オプション）使用時間（秒）。" }, "execution_metadata": { "$ref": "#/components/schemas/NodeExecutionMetadataJp" , "nullable": true, "description":"メタデータ"}, "created_at": { "type": "integer", "format": "int64", "description": "開始のタイムスタンプ。" } } }, + "NodeExecutionMetadataJp": { "type": "object", "description": "ノード実行メタデータ。", "properties": { "total_tokens": { "type": "integer", "nullable": true, "description": "（オプション）使用トークン数。" }, "total_price": { "type": "number", "format": "float", "nullable": true, "description": "（オプション）総コスト (floatでdecimalを表現)。" }, "currency": { "type": "string", "nullable": true, "example": "USD", "description": "（オプション）通貨、例：USD / RMB。" } } }, + "StreamEventWfWorkflowFinishedJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowFinishedDataJp" } } } ] }, + "WorkflowFinishedDataJp": { "type": "object", "description": "ワークフロー終了イベントの詳細。", "required": ["id", "workflow_id", "status", "created_at", "finished_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行のID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "関連するワークフローのID。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行のステータス。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（オプション）出力内容 (JSON)。" }, "error": { "type": "string", "nullable": true, "description": "（オプション）エラー理由。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（オプション）使用時間（秒）。" }, "total_tokens": { "type": "integer", "nullable": true, "description": "（オプション）使用トークン数。" }, "total_steps": { "type": "integer", "default": 0, "description": "総ステップ数、デフォルト0。" }, "created_at": { "type": "integer", "format": "int64", "description": "開始時間。" }, "finished_at": { "type": "integer", "format": "int64", "description": "終了時間。" } } }, + "StreamEventWfTtsMessageJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["audio", "message_id", "created_at"], "properties": { "audio": { "type": "string", "format": "byte", "description": "音声合成後のオーディオ、base64テキストコンテンツ。" }, "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } } ] }, + "StreamEventWfTtsMessageEndJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "$ref": "#/components/schemas/StreamEventBaseWfJp" }, { "type": "object", "required": ["audio", "message_id", "created_at"], "properties": { "audio": { "type": "string", "description": "終了イベントにはオーディオがないため、これは空の文字列です。" }, "message_id": { "type": "string", "format": "uuid", "description": "一意のメッセージID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } } ] }, + "StreamEventWfPingJp": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventJp" }, { "type": "object", "description": "接続を維持するために10秒ごとに送信されるPingイベント。" } ] }, + "WorkflowRunDetailResponseJp": { + "type": "object", "description": "ワークフロー実行詳細。", + "properties": { + "id": { "type": "string", "format": "uuid", "description": "ワークフロー実行のID。" }, + "workflow_id": { "type": "string", "format": "uuid", "description": "関連するワークフローのID。" }, + "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行のステータス。" }, + "inputs": { "type": "string", "description": "入力内容のJSON文字列。" }, + "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "出力内容のJSONオブジェクト。" }, + "error": { "type": "string", "nullable": true, "description": "エラー理由。" }, + "total_steps": { "type": "integer", "description": "タスクの総ステップ数。" }, + "total_tokens": { "type": "integer", "description": "使用されるトークンの総数。" }, + "created_at": { "type": "integer", "format": "int64", "description": "タスク開始時間。" }, + "finished_at": { "type": "integer", "format": "int64", "nullable": true, "description": "タスク終了時間。" }, + "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "使用される総秒数。" } + } + }, + "FileUploadResponseJp": { "type": "object", "description": "ファイルアップロード成功時の応答。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ（バイト）。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } }, + "EndUserDetailJp": { "type": "object", "properties": { - "task_id": { - "type": "string", - "format": "uuid", - "description": "タスクID。" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid", - "description": "ワークフロー実行ID。" - } + "id": { "type": "string", "format": "uuid" }, + "tenant_id": { "type": "string", "format": "uuid" }, + "app_id": { "type": "string", "format": "uuid", "nullable": true }, + "type": { "type": "string", "example": "service_api" }, + "external_user_id": { "type": "string", "nullable": true }, + "name": { "type": "string", "nullable": true }, + "is_anonymous": { "type": "boolean" }, + "session_id": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } } }, - "StreamEventWfWorkflowStartedJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfJp" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/WorkflowStartedDataJp" - } - } - } - ] - }, - "WorkflowStartedDataJp": { - "type": "object", - "description": "ワークフロー開始イベントの詳細。", - "required": [ - "id", - "workflow_id", - "sequence_number", - "created_at" - ], + "WorkflowLogsResponseJp": { + "type": "object", "description": "ワークフローログリストの応答。", "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ワークフロー実行の一意のID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "関連するワークフローのID。" - }, - "sequence_number": { - "type": "integer", - "description": "自己増加シリアル番号、1から始まります。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "開始時間。" - } + "page": { "type": "integer", "description": "現在のページ。" }, "limit": { "type": "integer", "description": "1ページあたりのアイテム数。" }, + "total": { "type": "integer", "description": "合計アイテム数。" }, "has_more": { "type": "boolean", "description": "さらにデータがあるかどうか。" }, + "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowLogItemJp" }, "description": "現在のページのデータ。" } } }, - "StreamEventWfNodeStartedJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfJp" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/NodeStartedDataJp" - } - } - } - ] - }, - "NodeStartedDataJp": { - "type": "object", - "description": "ノード開始イベントの詳細。", - "required": [ - "id", - "node_id", - "node_type", - "title", - "index", - "created_at" - ], + "WorkflowLogItemJp": { + "type": "object", "description": "単一のワークフローログアイテム。", "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ワークフロー実行の一意のID（文脈上、ノード実行IDであるべき）。" - }, - "node_id": { - "type": "string", - "format": "uuid", - "description": "ノードのID。" - }, - "node_type": { - "type": "string", - "description": "ノードのタイプ。" - }, - "title": { - "type": "string", - "description": "ノードの名前。" - }, - "index": { - "type": "integer", - "description": "実行シーケンス番号。" - }, - "predecessor_node_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "（オプション）前のノードID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "ノードで使用されるすべての前のノード変数の内容。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "開始のタイムスタンプ。" - } + "id": { "type": "string", "format": "uuid", "description": "ID。" }, + "workflow_run": { "$ref": "#/components/schemas/WorkflowRunSummaryJp", "description": "ワークフロー実行ログ。" }, + "created_from": { "type": "string", "description": "作成元。" }, + "created_by_role": { "type": "string", "description": "作成者の役割。" }, + "created_by_account": { "type": "string", "format": "uuid", "nullable": true, "description": "（オプション）作成者アカウント。" }, + "created_by_end_user": { "$ref": "#/components/schemas/EndUserSummaryJp", "description": "作成者ユーザー。" }, + "created_at": { "type": "integer", "format": "int64", "description": "作成時間。" } } }, - "StreamEventWfTextChunkJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfJp" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/TextChunkDataJp" - } - } - } - ] - }, - "TextChunkDataJp": { - "type": "object", - "description": "テキストフラグメントイベントの詳細。", - "required": [ - "text", - "from_variable_selector" - ], + "WorkflowRunSummaryJp": { + "type": "object", "description": "ワークフロー実行概要情報。", "properties": { - "text": { - "type": "string", - "description": "テキスト内容。" - }, - "from_variable_selector": { - "type": "array", - "items": { - "type": "string" - }, - "description": "テキスト生成元パス。" - } - } - }, - "StreamEventWfNodeFinishedJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfJp" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/NodeFinishedDataJp" - } - } - } - ] - }, - "NodeFinishedDataJp": { - "type": "object", - "description": "ノード終了イベントの詳細。", - "required": [ - "id", - "node_id", - "index", - "status", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ノード実行ID。" - }, - "node_id": { - "type": "string", - "format": "uuid", - "description": "ノードのID。" - }, - "index": { - "type": "integer", - "description": "実行シーケンス番号。" - }, - "predecessor_node_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "（オプション）前のノードID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "ノードで使用されるすべての前のノード変数の内容。" - }, - "process_data": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "（オプション）ノードプロセスデータ (JSON)。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "（オプション）出力内容 (JSON)。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "実行のステータス。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "（オプション）エラー理由。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "（オプション）使用時間（秒）。" - }, - "execution_metadata": { - "$ref": "#/components/schemas/NodeExecutionMetadataJp", - "nullable": true, - "description": "メタデータ" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "開始のタイムスタンプ。" - } - } - }, - "NodeExecutionMetadataJp": { - "type": "object", - "description": "ノード実行メタデータ。", - "properties": { - "total_tokens": { - "type": "integer", - "nullable": true, - "description": "（オプション）使用トークン数。" - }, - "total_price": { - "type": "number", - "format": "float", - "nullable": true, - "description": "（オプション）総コスト (floatでdecimalを表現)。" - }, - "currency": { - "type": "string", - "nullable": true, - "example": "USD", - "description": "（オプション）通貨、例：USD / RMB。" - } - } - }, - "StreamEventWfWorkflowFinishedJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfJp" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/WorkflowFinishedDataJp" - } - } - } - ] - }, - "WorkflowFinishedDataJp": { - "type": "object", - "description": "ワークフロー終了イベントの詳細。", - "required": [ - "id", - "workflow_id", - "status", - "created_at", - "finished_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ワークフロー実行のID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "関連するワークフローのID。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "実行のステータス。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "（オプション）出力内容 (JSON)。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "（オプション）エラー理由。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "（オプション）使用時間（秒）。" - }, - "total_tokens": { - "type": "integer", - "nullable": true, - "description": "（オプション）使用トークン数。" - }, - "total_steps": { - "type": "integer", - "default": 0, - "description": "総ステップ数、デフォルト0。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "開始時間。" - }, - "finished_at": { - "type": "integer", - "format": "int64", - "description": "終了時間。" - } - } - }, - "StreamEventWfTtsMessageJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfJp" - }, - { - "type": "object", - "required": [ - "audio", - "message_id", - "created_at" - ], - "properties": { - "audio": { - "type": "string", - "format": "byte", - "description": "音声合成後のオーディオ、base64テキストコンテンツ。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - } - ] - }, - "StreamEventWfTtsMessageEndJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventJp" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfJp" - }, - { - "type": "object", - "required": [ - "audio", - "message_id", - "created_at" - ], - "properties": { - "audio": { - "type": "string", - "description": "終了イベントにはオーディオがないため、これは空の文字列です。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "一意のメッセージID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - } - ] - }, - "StreamEventWfPingJp": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventJp" - }, - { - "type": "object", - "description": "接続を維持するために10秒ごとに送信されるPingイベント。" - } - ] - }, - "WorkflowRunDetailResponseJp": { - "type": "object", - "description": "ワークフロー実行詳細。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ワークフロー実行のID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "関連するワークフローのID。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "実行のステータス。" - }, - "inputs": { - "type": "string", - "description": "入力内容のJSON文字列。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "出力内容のJSONオブジェクト。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "エラー理由。" - }, - "total_steps": { - "type": "integer", - "description": "タスクの総ステップ数。" - }, - "total_tokens": { - "type": "integer", - "description": "使用されるトークンの総数。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "タスク開始時間。" - }, - "finished_at": { - "type": "integer", - "format": "int64", - "nullable": true, - "description": "タスク終了時間。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "使用される総秒数。" - } - } - }, - "FileUploadResponseJp": { - "type": "object", - "description": "ファイルアップロード成功時の応答。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "name": { - "type": "string", - "description": "ファイル名。" - }, - "size": { - "type": "integer", - "description": "ファイルサイズ（バイト）。" - }, - "extension": { - "type": "string", - "description": "ファイル拡張子。" - }, - "mime_type": { - "type": "string", - "description": "ファイルのMIMEタイプ。" - }, - "created_by": { - "type": "string", - "format": "uuid", - "description": "エンドユーザーID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成タイムスタンプ。" - } - } - }, - "EndUserDetailJp": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "tenant_id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "type": { - "type": "string", - "example": "service_api" - }, - "external_user_id": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "is_anonymous": { - "type": "boolean" - }, - "session_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "WorkflowLogsResponseJp": { - "type": "object", - "description": "ワークフローログリストの応答。", - "properties": { - "page": { - "type": "integer", - "description": "現在のページ。" - }, - "limit": { - "type": "integer", - "description": "1ページあたりのアイテム数。" - }, - "total": { - "type": "integer", - "description": "合計アイテム数。" - }, - "has_more": { - "type": "boolean", - "description": "さらにデータがあるかどうか。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkflowLogItemJp" - }, - "description": "現在のページのデータ。" - } - } - }, - "WorkflowLogItemJp": { - "type": "object", - "description": "単一のワークフローログアイテム。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "workflow_run": { - "$ref": "#/components/schemas/WorkflowRunSummaryJp", - "description": "ワークフロー実行ログ。" - }, - "created_from": { - "type": "string", - "description": "作成元。" - }, - "created_by_role": { - "type": "string", - "description": "作成者の役割。" - }, - "created_by_account": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "（オプション）作成者アカウント。" - }, - "created_by_end_user": { - "$ref": "#/components/schemas/EndUserSummaryJp", - "description": "作成者ユーザー。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "作成時間。" - } - } - }, - "WorkflowRunSummaryJp": { - "type": "object", - "description": "ワークフロー実行概要情報。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "version": { - "type": "string", - "description": "バージョン。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "実行ステータス。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "（オプション）エラー。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "description": "使用時間（秒）。" - }, - "total_tokens": { - "type": "integer", - "description": "消費トークン数。" - }, - "total_steps": { - "type": "integer", - "description": "実行ステップ長。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "開始時間。" - }, - "finished_at": { - "type": "integer", - "format": "int64", - "nullable": true, - "description": "終了時間。" - } + "id": { "type": "string", "format": "uuid", "description": "ID。" }, "version": { "type": "string", "description": "バージョン。" }, + "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "実行ステータス。" }, + "error": { "type": "string", "nullable": true, "description": "（オプション）エラー。" }, + "elapsed_time": { "type": "number", "format": "float", "description": "使用時間（秒）。" }, + "total_tokens": { "type": "integer", "description": "消費トークン数。" }, + "total_steps": { "type": "integer", "description": "実行ステップ長。" }, + "created_at": { "type": "integer", "format": "int64", "description": "開始時間。" }, + "finished_at": { "type": "integer", "format": "int64", "nullable": true, "description": "終了時間。" } } }, "EndUserSummaryJp": { - "type": "object", - "description": "エンドユーザー概要情報。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "type": { - "type": "string", - "description": "タイプ。" - }, - "is_anonymous": { - "type": "boolean", - "description": "匿名かどうか。" - }, - "session_id": { - "type": "string", - "description": "セッションID。" - } - } - }, - "AppInfoResponseJp": { - "type": "object", - "description": "アプリケーションの基本情報。", - "properties": { - "name": { - "type": "string", - "description": "アプリケーションの名前。" - }, - "description": { - "type": "string", - "description": "アプリケーションの説明。" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "アプリケーションのタグ。" - } - } - }, - "WorkflowAppParametersResponseJp": { - "type": "object", - "description": "ワークフローアプリのパラメータ情報。", - "properties": { - "user_input_form": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserInputFormItemJp" - }, - "description": "ユーザー入力フォームの設定。" - }, - "file_upload": { - "type": "object", - "properties": { - "image": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "number_limits": { - "type": "integer" - }, - "detail": { - "type": "string" - }, - "transfer_methods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ] - } - } - }, - "description": "画像設定。現在サポートされている画像タイプのみ：png, jpg, jpeg, webp, gif。" - } - }, - "description": "ファイルアップロード設定。" - }, - "system_parameters": { - "type": "object", - "properties": { - "file_size_limit": { - "type": "integer", - "description": "ドキュメントアップロードサイズ制限（MB）。" - }, - "image_file_size_limit": { - "type": "integer", - "description": "画像ファイルアップロードサイズ制限（MB）。" - }, - "audio_file_size_limit": { - "type": "integer", - "description": "オーディオファイルアップロードサイズ制限（MB）。" - }, - "video_file_size_limit": { - "type": "integer", - "description": "ビデオファイルアップロードサイズ制限（MB）。" - } - }, - "description": "システムパラメータ。" - } - } - }, - "UserInputFormItemJp": { - "type": "object", - "description": "ユーザー入力フォーム内のコントロールアイテム。", - "oneOf": [ - { - "$ref": "#/components/schemas/TextInputControlWrapperJp" - }, - { - "$ref": "#/components/schemas/ParagraphControlWrapperJp" - }, - { - "$ref": "#/components/schemas/SelectControlWrapperJp" - } - ] - }, - "TextInputControlWrapperJp": { - "type": "object", - "properties": { - "text-input": { - "$ref": "#/components/schemas/TextInputControlJp" - } - }, - "required": [ - "text-input" - ] - }, - "ParagraphControlWrapperJp": { - "type": "object", - "properties": { - "paragraph": { - "$ref": "#/components/schemas/ParagraphControlJp" - } - }, - "required": [ - "paragraph" - ] - }, - "SelectControlWrapperJp": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/SelectControlJp" - } - }, - "required": [ - "select" - ] - }, - "TextInputControlJp": { - "type": "object", - "description": "テキスト入力コントロール。", - "required": [ - "label", - "variable", - "required" - ], + "type": "object", "description": "エンドユーザー概要情報。", "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - } - } - }, - "ParagraphControlJp": { - "type": "object", - "description": "段落テキスト入力コントロール。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - } - } - }, - "SelectControlJp": { - "type": "object", - "description": "ドロップダウンコントロール。", - "required": [ - "label", - "variable", - "required", - "options" - ], - "properties": { - "label": { - "type": "string", - "description": "変数表示ラベル名。" - }, - "variable": { - "type": "string", - "description": "変数ID。" - }, - "required": { - "type": "boolean", - "description": "必須かどうか。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "デフォルト値。" - }, - "options": { - "type": "array", - "items": { - "type": "string" - }, - "description": "オプション値。" - } - } - }, - "WorkflowWebAppSettingsResponseJp": { - "type": "object", - "description": "ワークフローアプリのWebApp設定。", - "properties": { - "title": { - "type": "string", - "description": "WebApp名。" - }, - "icon_type": { - "type": "string", - "enum": [ - "emoji", - "image" - ], - "description": "アイコンタイプ。" - }, - "icon": { - "type": "string", - "description": "アイコン内容 (emojiまたは画像URL)。" - }, - "icon_background": { - "type": "string", - "description": "16進数形式の背景色。" - }, - "icon_url": { - "type": "string", - "format": "url", - "nullable": true, - "description": "アイコンのURL。" - }, - "description": { - "type": "string", - "description": "説明。" - }, - "copyright": { - "type": "string", - "description": "著作権情報。" - }, - "privacy_policy": { - "type": "string", - "description": "プライバシーポリシーのリンク。" - }, - "custom_disclaimer": { - "type": "string", - "description": "カスタム免責事項。" - }, - "default_language": { - "type": "string", - "description": "デフォルト言語。" - }, - "show_workflow_steps": { - "type": "boolean", - "description": "ワークフローの詳細を表示するかどうか。" - } - } - }, - "ErrorResponseJp": { - "type": "object", - "description": "エラー応答。", - "properties": { - "status": { - "type": "integer", - "nullable": true, - "description": "HTTPステータスコード。" - }, - "code": { - "type": "string", - "nullable": true, - "description": "エラーコード。" - }, - "message": { - "type": "string", - "description": "エラーメッセージ。" - } - } - } + "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "タイプ。" }, + "is_anonymous": { "type": "boolean", "description": "匿名かどうか。" }, "session_id": { "type": "string", "description": "セッションID。" } + } + }, + "AppInfoResponseJp": { "type": "object", "description": "アプリケーションの基本情報。", "properties": { "name": { "type": "string", "description": "アプリケーションの名前。" }, "description": { "type": "string", "description": "アプリケーションの説明。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "アプリケーションのタグ。" } } }, + "WorkflowAppParametersResponseJp": { "type": "object", "description": "ワークフローアプリのパラメータ情報。", "properties": { "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemJp" }, "description": "ユーザー入力フォームの設定。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "detail": { "type": "string" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "画像設定。現在サポートされている画像タイプのみ：png, jpg, jpeg, webp, gif。" } }, "description": "ファイルアップロード設定。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "ドキュメントアップロードサイズ制限（MB）。" }, "image_file_size_limit": { "type": "integer", "description": "画像ファイルアップロードサイズ制限（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "オーディオファイルアップロードサイズ制限（MB）。" }, "video_file_size_limit": { "type": "integer", "description": "ビデオファイルアップロードサイズ制限（MB）。" } }, "description": "システムパラメータ。" } } }, + "UserInputFormItemJp": { "type": "object", "description": "ユーザー入力フォーム内のコントロールアイテム。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperJp" }, { "$ref": "#/components/schemas/ParagraphControlWrapperJp" }, { "$ref": "#/components/schemas/SelectControlWrapperJp" } ] }, + "TextInputControlWrapperJp": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlJp" } }, "required":["text-input"] }, + "ParagraphControlWrapperJp": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlJp" } }, "required":["paragraph"] }, + "SelectControlWrapperJp": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlJp" } }, "required":["select"] }, + "TextInputControlJp": { "type": "object", "description": "テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, + "ParagraphControlJp": { "type": "object", "description": "段落テキスト入力コントロール。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" } } }, + "SelectControlJp": { "type": "object", "description": "ドロップダウンコントロール。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "変数表示ラベル名。" }, "variable": { "type": "string", "description": "変数ID。" }, "required": { "type": "boolean", "description": "必須かどうか。" }, "default": { "type": "string", "nullable": true, "description": "デフォルト値。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "オプション値。" } } }, + "WorkflowWebAppSettingsResponseJp": { "type": "object", "description": "ワークフローアプリのWebApp設定。", "properties": { "title": { "type": "string", "description": "WebApp名。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "アイコンタイプ。" }, "icon": { "type": "string", "description": "アイコン内容 (emojiまたは画像URL)。" }, "icon_background": { "type": "string", "description": "16進数形式の背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "アイコンのURL。" }, "description": { "type": "string", "description": "説明。" }, "copyright": { "type": "string", "description": "著作権情報。" }, "privacy_policy": { "type": "string", "description": "プライバシーポリシーのリンク。" }, "custom_disclaimer": { "type": "string", "description": "カスタム免責事項。" }, "default_language": { "type": "string", "description": "デフォルト言語。" }, "show_workflow_steps": { "type": "boolean", "description": "ワークフローの詳細を表示するかどうか。" } } }, + "ErrorResponseJp": { "type": "object", "description": "エラー応答。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTPステータスコード。" }, "code": { "type": "string", "nullable": true, "description": "エラーコード。" }, "message": { "type": "string", "description": "エラーメッセージ。" } } } } }, "tags": [ - { - "name": "ワークフロー実行", - "description": "ワークフローの実行と管理に関連する操作。" - }, - { - "name": "ファイル操作 (ワークフロー)", - "description": "ワークフロー固有のファイルアップロードとプレビュー操作。" - }, - { - "name": "エンドユーザー", - "description": "エンドユーザー情報に関連する操作。" - }, - { - "name": "アプリケーション設定 (ワークフロー)", - "description": "ワークフローアプリのアプリケーション設定と情報。" - } + { "name": "ワークフロー実行", "description": "ワークフローの実行と管理に関連する操作。" }, + { "name": "ファイル操作 (ワークフロー)", "description": "ワークフロー固有のファイルアップロードとプレビュー操作。" }, + { "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" }, + { "name": "アプリケーション設定 (ワークフロー)", "description": "ワークフローアプリのアプリケーション設定と情報。" } ] -} +} \ No newline at end of file diff --git a/zh/api-reference/openapi_chat.json b/zh/api-reference/openapi_chat.json index 33903cc9c..296d1855f 100644 --- a/zh/api-reference/openapi_chat.json +++ b/zh/api-reference/openapi_chat.json @@ -28,9 +28,7 @@ "summary": "发送对话消息", "description": "创建会话消息。", "operationId": "sendBasicChatMessageCn", - "tags": [ - "对话消息" - ], + "tags": ["对话消息"], "requestBody": { "description": "发送对话消息的请求体。", "required": true, @@ -80,18 +78,9 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequestGenericCn" - }, - "404": { - "$ref": "#/components/responses/ConversationNotFoundCn" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/chat/send-chat-message" + "400": { "$ref": "#/components/responses/BadRequestGenericCn" }, + "404": { "$ref": "#/components/responses/ConversationNotFoundCn" }, + "500": { "$ref": "#/components/responses/InternalServerErrorCn" } } } }, @@ -100,9 +89,7 @@ "summary": "上传文件", "description": "上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。支持 png, jpg, jpeg, webp, gif 格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadBasicChatFileCn", - "tags": [ - "文件操作" - ], + "tags": ["文件操作"], "requestBody": { "description": "文件上传请求。需使用 `multipart/form-data` 进行请求。", "required": true, @@ -110,10 +97,7 @@ "multipart/form-data": { "schema": { "type": "object", - "required": [ - "file", - "user" - ], + "required": ["file", "user"], "properties": { "file": { "type": "string", @@ -140,34 +124,15 @@ } } }, - "201": { + "201": { "description": "文件创建成功 (备选成功状态码)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseCn" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseCn" } } } }, - "400": { - "$ref": "#/components/responses/BadRequestFileCn" - }, - "413": { - "$ref": "#/components/responses/FileTooLargeCn" - }, - "415": { - "$ref": "#/components/responses/UnsupportedFileTypeFileCn" - }, - "503": { - "$ref": "#/components/responses/S3ErrorFileCn" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/files/file-upload" + "400": { "$ref": "#/components/responses/BadRequestFileCn" }, + "413": { "$ref": "#/components/responses/FileTooLargeCn" }, + "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileCn" }, + "503": { "$ref": "#/components/responses/S3ErrorFileCn" }, + "500": { "$ref": "#/components/responses/InternalServerErrorCn" } } } }, @@ -176,19 +141,14 @@ "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", "operationId": "getEndUserChatCn", - "tags": [ - "终端用户" - ], + "tags": ["终端用户"], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "终端用户 ID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -196,21 +156,12 @@ "description": "成功获取终端用户信息。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/EndUserDetailCn" - } + "schema": { "$ref": "#/components/schemas/EndUserDetailCn" } } } }, - "404": { - "$ref": "#/components/responses/EndUserNotFoundCn" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/end-users/get-end-user" + "404": { "$ref": "#/components/responses/EndUserNotFoundCn" }, + "500": { "$ref": "#/components/responses/InternalServerErrorCn" } } } }, @@ -219,9 +170,7 @@ "summary": "文件预览", "description": "预览或下载已上传的文件。此端点允许你访问之前通过文件上传API上传的文件。文件只能在所属的应用程序消息内访问。", "operationId": "previewBasicChatFileCn", - "tags": [ - "文件操作" - ], + "tags": ["文件操作"], "parameters": [ { "name": "file_id", @@ -318,9 +267,7 @@ "description": "错误请求。可能的错误代码:\n- `invalid_param`: 异常参数输入。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, @@ -328,9 +275,7 @@ "description": "禁止访问。可能的错误代码:\n- `file_access_denied`: 文件访问被拒绝或文件不属于当前应用程序。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, @@ -338,9 +283,7 @@ "description": "未找到。可能的错误代码:\n- `file_not_found`: 文件未找到或已被删除。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, @@ -348,15 +291,10 @@ "description": "内部服务器错误。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/files/file-preview" } } }, @@ -365,19 +303,14 @@ "summary": "停止响应", "description": "停止生成对话消息。仅支持流式模式。", "operationId": "stopBasicChatMessageGenerationCn", - "tags": [ - "对话消息" - ], + "tags": ["对话消息"], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "任务 ID，可在流式返回 Chunk 中获取。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { @@ -386,9 +319,7 @@ "application/json": { "schema": { "type": "object", - "required": [ - "user" - ], + "required": ["user"], "properties": { "user": { "type": "string", @@ -400,12 +331,7 @@ } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/chat/stop-chat-message-generation" + "200": { "$ref": "#/components/responses/SuccessResultCn" } } } }, @@ -414,38 +340,26 @@ "summary": "消息反馈（点赞）", "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", "operationId": "postBasicChatMessageFeedbackCn", - "tags": [ - "消息反馈" - ], + "tags": ["消息反馈"], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/MessageFeedbackRequestCn" - } + "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestCn" } } } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/feedback/message-feedback" + "200": { "$ref": "#/components/responses/SuccessResultCn" } } } }, @@ -454,31 +368,20 @@ "summary": "获取APP的消息点赞和反馈", "description": "获取应用的终端用户反馈、点赞。", "operationId": "getBasicChatAppFeedbacksCn", - "tags": [ - "消息反馈" - ], + "tags": ["消息反馈"], "parameters": [ - { - "$ref": "#/components/parameters/PageQueryParamCn" - }, - { - "$ref": "#/components/parameters/LimitQueryParamCn" - } + { "$ref": "#/components/parameters/PageQueryParamCn" }, + { "$ref": "#/components/parameters/LimitQueryParamCn" } ], "responses": { "200": { "description": "成功获取应用的反馈列表。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFeedbacksResponseCn" - } + "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -487,38 +390,26 @@ "summary": "获取下一轮建议问题列表", "description": "获取当前消息的下一轮建议问题列表。", "operationId": "getBasicChatSuggestedQuestionsCn", - "tags": [ - "对话消息" - ], + "tags": ["对话消息"], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } }, - { - "$ref": "#/components/parameters/UserQueryParamCn" - } + { "$ref": "#/components/parameters/UserQueryParamCn" } ], "responses": { "200": { "description": "成功获取建议问题列表。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/SuggestedQuestionsResponseCn" - } + "schema": { "$ref": "#/components/schemas/SuggestedQuestionsResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/chat/next-suggested-questions" } } }, @@ -527,44 +418,27 @@ "summary": "获取会话历史消息", "description": "滚动加载形式返回历史聊天记录，第一页返回最新 `limit` 条，即倒序返回。", "operationId": "getBasicChatConversationHistoryCn", - "tags": [ - "会话管理" - ], + "tags": ["会话管理"], "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdQueryParamCn" - }, - { - "$ref": "#/components/parameters/UserQueryParamCn" - }, + { "$ref": "#/components/parameters/ConversationIdQueryParamCn" }, + { "$ref": "#/components/parameters/UserQueryParamCn" }, { "name": "first_id", "in": "query", "description": "当前页第一条聊天记录的 ID，默认 null。", - "schema": { - "type": "string", - "format": "uuid", - "nullable": true - } + "schema": { "type": "string", "format": "uuid", "nullable": true } }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Cn" - } + { "$ref": "#/components/parameters/LimitQueryParamDefault20Cn" } ], "responses": { "200": { "description": "成功获取会话历史消息。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/BasicConversationHistoryResponseCn" - } + "schema": { "$ref": "#/components/schemas/BasicConversationHistoryResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/get-conversation-history-messages" } } }, @@ -573,37 +447,22 @@ "summary": "获取会话列表", "description": "获取当前用户的会话列表，默认返回最近的 20 条。", "operationId": "getBasicChatConversationsListCn", - "tags": [ - "会话管理" - ], + "tags": ["会话管理"], "parameters": [ - { - "$ref": "#/components/parameters/UserQueryParamCn" - }, - { - "$ref": "#/components/parameters/LastIdQueryParamCn" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" - }, - { - "$ref": "#/components/parameters/SortByQueryParamCn" - } + { "$ref": "#/components/parameters/UserQueryParamCn" }, + { "$ref": "#/components/parameters/LastIdQueryParamCn" }, + { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" }, + { "$ref": "#/components/parameters/SortByQueryParamCn" } ], "responses": { "200": { "description": "成功获取会话列表。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationsListResponseCn" - } + "schema": { "$ref": "#/components/schemas/ConversationsListResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/get-conversations" } } }, @@ -612,41 +471,20 @@ "summary": "删除会话", "description": "删除一个指定的会话。", "operationId": "deleteBasicChatConversationCn", - "tags": [ - "会话管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamCn" - } - ], + "tags": ["会话管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamCn" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "user": { - "type": "string", - "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" - } - } + "type": "object", "required": ["user"], + "properties": { "user": { "type": "string", "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" } } } } } }, - "responses": { - "204": { - "description": "会话删除成功，无内容返回。" - } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/delete-conversation" - } + "responses": { "204": { "description": "会话删除成功，无内容返回。" } } } }, "/conversations/{conversation_id}/name": { @@ -654,83 +492,33 @@ "summary": "会话重命名", "description": "对会话进行重命名。", "operationId": "renameBasicChatConversationCn", - "tags": [ - "会话管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamCn" - } - ], + "tags": ["会话管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamCn" } ], "requestBody": { "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationRenameRequestCn" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameRequestCn" } } } }, "responses": { - "200": { - "description": "会话重命名成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationRenameResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/conversation-rename" + "200": { "description": "会话重命名成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameResponseCn" } } } } } } }, - "/conversations/{conversation_id}/variables": { + "/conversations/{conversation_id}/variables": { "get": { "summary": "获取对话变量", "description": "从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。", "operationId": "getBasicChatConversationVariablesCn", - "tags": [ - "会话管理" - ], + "tags": ["会话管理"], "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamCn" - }, - { - "$ref": "#/components/parameters/UserQueryParamCn" - }, - { - "$ref": "#/components/parameters/LastIdQueryParamCn" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" - }, - { - "$ref": "#/components/parameters/VariableNameQueryParamCn" - } + { "$ref": "#/components/parameters/ConversationIdPathParamCn" }, + { "$ref": "#/components/parameters/UserQueryParamCn" }, + { "$ref": "#/components/parameters/LastIdQueryParamCn" }, + { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" }, + { "$ref": "#/components/parameters/VariableNameQueryParamCn" } ], "responses": { - "200": { - "description": "成功获取对话变量。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationVariablesResponseCn" - } - } - } - }, - "404": { - "$ref": "#/components/responses/ConversationNotFoundCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/get-conversation-variables" + "200": { "description": "成功获取对话变量。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationVariablesResponseCn" } } } }, + "404": { "$ref": "#/components/responses/ConversationNotFoundCn" } } } }, @@ -739,33 +527,13 @@ "summary": "语音转文字", "description": "将语音文件转换为文字。支持格式：mp3, mp4, mpeg, mpga, m4a, wav, webm。文件大小限制：15MB。", "operationId": "basicChatAudioToTextCn", - "tags": [ - "语音与文字转换" - ], + "tags": ["语音与文字转换"], "requestBody": { "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AudioToTextRequestCn" - } - } - } + "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioToTextRequestCn" } } } }, "responses": { - "200": { - "description": "成功将语音转换为文字。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AudioToTextResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/tts/speech-to-text" + "200": { "description": "成功将语音转换为文字。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioToTextResponseCn" } } } } } } }, @@ -774,48 +542,19 @@ "summary": "文字转语音", "description": "将文字内容转换为语音。", "operationId": "basicChatTextToAudioCn", - "tags": [ - "语音与文字转换" - ], + "tags": ["语音与文字转换"], "requestBody": { "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/TextToAudioFormRequestCn" - } - } + "content": { + "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TextToAudioFormRequestCn" } } } }, "responses": { "200": { "description": "成功生成语音文件。", - "content": { - "audio/wav": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "audio/mp3": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "headers": { - "Content-Type": { - "schema": { - "type": "string", - "example": "audio/wav" - } - } - } + "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, + "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/tts/text-to-audio" } } }, @@ -823,24 +562,8 @@ "get": { "summary": "获取应用基本信息", "operationId": "getBasicChatAppInfoCn", - "tags": [ - "应用配置" - ], - "responses": { - "200": { - "description": "应用基本信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfoResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-basic-information" - } + "tags": ["应用配置"], + "responses": { "200": { "description": "应用基本信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseCn" } } } } } } }, "/parameters": { @@ -848,24 +571,8 @@ "summary": "获取应用参数", "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", "operationId": "getBasicChatAppParametersCn", - "tags": [ - "应用配置" - ], - "responses": { - "200": { - "description": "应用参数信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatAppParametersResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-parameters-information" - } + "tags": ["应用配置"], + "responses": { "200": { "description": "应用参数信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAppParametersResponseCn" } } } } } } }, "/meta": { @@ -873,24 +580,8 @@ "summary": "获取应用Meta信息", "description": "用于获取工具 icon。", "operationId": "getBasicChatAppMetaCn", - "tags": [ - "应用配置" - ], - "responses": { - "200": { - "description": "成功获取应用 Meta 信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppMetaResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-meta-information" - } + "tags": ["应用配置"], + "responses": { "200": { "description": "成功获取应用 Meta 信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMetaResponseCn" } } } } } } }, "/site": { @@ -898,454 +589,107 @@ "summary": "获取应用 WebApp 设置", "description": "用于获取应用的 WebApp 设置。", "operationId": "getBasicChatWebAppSettingsCn", - "tags": [ - "应用配置" - ], - "responses": { - "200": { - "description": "WebApp 设置信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebAppSettingsResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-webapp-settings" - } + "tags": ["应用配置"], + "responses": { "200": { "description": "WebApp 设置信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseCn" } } } } } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "API_KEY", - "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" - } + "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" } }, "parameters": { - "PageQueryParamCn": { - "name": "page", - "in": "query", - "description": "页码，（选填）默认值：1。", - "schema": { - "type": "integer", - "default": 1 - } - }, - "LimitQueryParamCn": { - "name": "limit", - "in": "query", - "description": "每页数量，（选填）默认值：20。", - "schema": { - "type": "integer", - "default": 20 - } - }, - "LimitQueryParamDefault20Cn": { - "name": "limit", - "in": "query", - "description": "一次请求返回多少条记录，默认 20 条。", - "schema": { - "type": "integer", - "default": 20 - } - }, - "LimitQueryParamDefault20Max100Cn": { - "name": "limit", - "in": "query", - "description": "一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。", - "schema": { - "type": "integer", - "default": 20, - "minimum": 1, - "maximum": 100 - } - }, - "UserQueryParamCn": { - "name": "user", - "in": "query", - "required": true, - "description": "用户标识，由开发者定义规则，需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", - "schema": { - "type": "string" - } - }, - "ConversationIdQueryParamCn": { - "name": "conversation_id", - "in": "query", - "required": true, - "description": "会话 ID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - "LastIdQueryParamCn": { - "name": "last_id", - "in": "query", - "description": "（选填）当前页最后面一条记录的 ID，默认 null。", - "schema": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "SortByQueryParamCn": { - "name": "sort_by", - "in": "query", - "description": "（选填）排序字段，默认 -updated_at (按更新时间倒序排列)。可选值：created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", - "schema": { - "type": "string", - "enum": [ - "created_at", - "-created_at", - "updated_at", - "-updated_at" - ], - "default": "-updated_at" - } - }, - "ConversationIdPathParamCn": { - "name": "conversation_id", - "in": "path", - "required": true, - "description": "会话 ID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - "VariableNameQueryParamCn": { - "name": "variable_name", - "in": "query", - "description": "（选填）按变量名称筛选。", - "schema": { - "type": "string" - } - } + "PageQueryParamCn": { "name": "page", "in": "query", "description": "页码，（选填）默认值：1。", "schema": { "type": "integer", "default": 1 } }, + "LimitQueryParamCn": { "name": "limit", "in": "query", "description": "每页数量，（选填）默认值：20。", "schema": { "type": "integer", "default": 20 } }, + "LimitQueryParamDefault20Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录，默认 20 条。", "schema": { "type": "integer", "default": 20 } }, + "LimitQueryParamDefault20Max100Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, + "UserQueryParamCn": { "name": "user", "in": "query", "required": true, "description": "用户标识，由开发者定义规则，需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", "schema": { "type": "string" } }, + "ConversationIdQueryParamCn": { "name": "conversation_id", "in": "query", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } }, + "LastIdQueryParamCn": { "name": "last_id", "in": "query", "description": "（选填）当前页最后面一条记录的 ID，默认 null。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, + "SortByQueryParamCn": { "name": "sort_by", "in": "query", "description": "（选填）排序字段，默认 -updated_at (按更新时间倒序排列)。可选值：created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } }, + "ConversationIdPathParamCn": { "name": "conversation_id", "in": "path", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } }, + "VariableNameQueryParamCn": { "name": "variable_name", "in": "query", "description": "（选填）按变量名称筛选。", "schema": { "type": "string" } } }, "responses": { - "BadRequestGenericCn": { - "description": "请求参数错误。可能原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "BadRequestFileCn": { - "description": "文件操作请求错误。可能原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "FileTooLargeCn": { - "description": "文件太大 (file_too_large)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "UnsupportedFileTypeFileCn": { - "description": "不支持的文件类型 (unsupported_file_type)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "S3ErrorFileCn": { - "description": "S3 存储服务错误。可能原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "InternalServerErrorCn": { - "description": "服务内部异常。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "SuccessResultCn": { - "description": "操作成功。", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - } - } - } - } - } - }, - "ConversationNotFoundCn": { - "description": "对话不存在。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "EndUserNotFoundCn": { - "description": "终端用户不存在。错误码：`end_user_not_found`", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - } + "BadRequestGenericCn": { "description": "请求参数错误。可能原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "BadRequestFileCn": { "description": "文件操作请求错误。可能原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "FileTooLargeCn": { "description": "文件太大 (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "UnsupportedFileTypeFileCn": { "description": "不支持的文件类型 (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "S3ErrorFileCn": { "description": "S3 存储服务错误。可能原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "InternalServerErrorCn": { "description": "服务内部异常。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "SuccessResultCn": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, + "ConversationNotFoundCn": { "description": "对话不存在。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "EndUserNotFoundCn": { "description": "终端用户不存在。错误码：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } } }, "schemas": { "BasicChatRequestCn": { "type": "object", - "required": [ - "query", - "user" - ], + "required": ["query", "user"], "properties": { - "query": { - "type": "string", - "description": "用户输入/提问内容。" - }, + "query": { "type": "string", "description": "用户输入/提问内容。" }, "inputs": { "type": "object", "description": "允许传入 App 定义的各变量值。", "additionalProperties": true, "default": {} }, - "response_mode": { - "type": "string", - "enum": [ - "streaming", - "blocking" - ], - "default": "streaming", - "description": "响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制；Agent模式下不允许)。" - }, - "user": { - "type": "string", - "description": "用户标识，应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "（选填）会话 ID，用于继续之前的对话。" - }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BasicInputFileObjectCn" - }, - "description": "（选填）上传的文件列表 (目前仅支持图片)。" - }, - "auto_generate_name": { - "type": "boolean", - "default": true, - "description": "（选填）自动生成会话标题，默认 true。" - } + "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制；Agent模式下不允许)。" }, + "user": { "type": "string", "description": "用户标识，应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "（选填）会话 ID，用于继续之前的对话。" }, + "files": { "type": "array", "items": { "$ref": "#/components/schemas/BasicInputFileObjectCn" }, "description": "（选填）上传的文件列表 (目前仅支持图片)。" }, + "auto_generate_name": { "type": "boolean", "default": true, "description": "（选填）自动生成会话标题，默认 true。" } } }, "BasicInputFileObjectCn": { "type": "object", - "required": [ - "type", - "transfer_method" - ], + "required": ["type", "transfer_method"], "properties": { - "type": { - "type": "string", - "enum": [ - "image" - ], - "description": "文件类型，目前仅支持 'image'。" - }, - "transfer_method": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ], - "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" - }, - "url": { - "type": "string", - "format": "url", - "description": "图片地址（当传递方式为 remote_url 时）" - }, - "upload_file_id": { - "type": "string", - "format": "uuid", - "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" - } + "type": { "type": "string", "enum": ["image"], "description": "文件类型，目前仅支持 'image'。" }, + "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" }, + "url": { "type": "string", "format": "url", "description": "图片地址（当传递方式为 remote_url 时）" }, + "upload_file_id": { "type": "string", "format":"uuid", "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" } }, "anyOf": [ { - "properties": { - "transfer_method": { - "enum": [ - "remote_url" - ] - }, - "url": { - "type": "string", - "format": "url" - } + "properties": { + "transfer_method": { "enum": ["remote_url"] }, + "url": { "type": "string", "format": "url" } }, - "required": [ - "url" - ], - "not": { - "required": [ - "upload_file_id" - ] - } + "required": ["url"], + "not": { "required": ["upload_file_id"] } }, { - "properties": { - "transfer_method": { - "enum": [ - "local_file" - ] - }, - "upload_file_id": { - "type": "string", - "format": "uuid" - } + "properties": { + "transfer_method": { "enum": ["local_file"] }, + "upload_file_id": { "type": "string", "format":"uuid" } }, - "required": [ - "upload_file_id" - ], - "not": { - "required": [ - "url" - ] - } + "required": ["upload_file_id"], + "not": { "required": ["url"] } } ] }, "ChatCompletionResponseCn": { - "type": "object", - "description": "阻塞模式下的完整 App 结果。", + "type": "object", "description": "阻塞模式下的完整 App 结果。", "properties": { - "event": { - "type": "string", - "example": "message", - "description": "事件类型，固定为 `message`。" - }, - "task_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID。" - }, - "id": { - "type": "string", - "format": "uuid", - "description": "唯一ID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息唯一 ID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会话 ID。" - }, - "mode": { - "type": "string", - "example": "chat", - "description": "App 模式，固定为 `chat`。" - }, - "answer": { - "type": "string", - "description": "完整回复内容。" - }, - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataCn" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "消息创建时间戳。" - } + "event": { "type": "string", "example": "message", "description": "事件类型，固定为 `message`。" }, + "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, + "id": { "type": "string", "format": "uuid", "description": "唯一ID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, + "mode": { "type": "string", "example": "chat", "description": "App 模式，固定为 `chat`。" }, + "answer": { "type": "string", "description": "完整回复内容。" }, + "metadata": { "$ref": "#/components/schemas/ResponseMetadataCn" }, + "created_at": { "type": "integer", "format": "int64", "description": "消息创建时间戳。" } } }, "ResponseMetadataCn": { - "type": "object", - "description": "元数据。", - "properties": { - "usage": { - "$ref": "#/components/schemas/UsageCn" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResourceCn" - }, - "description": "引用和归属分段列表。" - } - } + "type": "object", "description": "元数据。", + "properties": { "usage": { "$ref": "#/components/schemas/UsageCn" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceCn" }, "description": "引用和归属分段列表。" } } }, "ChunkBasicChatEventCn": { - "type": "object", - "required": [ - "event" - ], - "properties": { - "event": { - "type": "string", - "enum": [ - "message", - "agent_message", - "agent_thought", - "message_file", - "message_end", - "tts_message", - "tts_message_end", - "message_replace", - "error", - "ping" - ], - "description": "事件类型。" - } - }, - "discriminator": { - "propertyName": "event", - "mapping": { + "type": "object", "required": ["event"], + "properties": { "event": { "type": "string", "enum": ["message", "agent_message", "agent_thought", "message_file", "message_end", "tts_message", "tts_message_end", "message_replace", "error", "ping"], "description": "事件类型。" } }, + "discriminator": { "propertyName": "event", "mapping": { "message": "#/components/schemas/StreamEventChatMessageCn", "agent_message": "#/components/schemas/StreamEventAgentMessageCn", "agent_thought": "#/components/schemas/StreamEventAgentThoughtCn", @@ -1356,1401 +700,111 @@ "message_replace": "#/components/schemas/StreamEventMessageReplaceCn", "error": "#/components/schemas/StreamEventErrorCn", "ping": "#/components/schemas/StreamEventPingCn" - } - } + }} }, "StreamEventBaseChatCn": { - "type": "object", - "properties": { - "task_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息唯一 ID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会话 ID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间戳。" - } + "type": "object", "properties": { + "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, + "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } } }, - "StreamEventChatMessageCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "LLM 返回文本块内容。" - } - } - } - ] - }, - "StreamEventAgentMessageCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "Agent模式下 LLM 返回文本块内容。" - } - } - } - ] - }, + "StreamEventChatMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLM 返回文本块内容。" } } } ] }, + "StreamEventAgentMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "Agent模式下 LLM 返回文本块内容。" } } } ] }, "StreamEventAgentThoughtCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "id", - "position" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "agent_thought ID。" - }, - "position": { - "type": "integer", - "description": "agent_thought 在消息中的位置。" - }, - "thought": { - "type": "string", - "description": "agent 的思考内容。" - }, - "observation": { - "type": "string", - "description": "工具调用的返回结果。" - }, - "tool": { - "type": "string", - "description": "使用的工具列表，以 ';' 分割。" - }, - "tool_input": { - "type": "string", - "description": "工具的输入，JSON 格式的字符串。" - }, - "message_files": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "当前 agent_thought 关联的文件ID列表 (原描述为 file_id 字符串，修正为数组以匹配 agent_thoughts 历史消息中的 files)。" - } - } - } - ] - }, - "StreamEventMessageFileCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "type": "object", - "required": [ - "id", - "type", - "belongs_to", - "url", - "conversation_id" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "文件唯一ID。" - }, - "type": { - "type": "string", - "enum": [ - "image" - ], - "description": "文件类型，目前仅为 image。" - }, - "belongs_to": { - "type": "string", - "enum": [ - "assistant" - ], - "description": "文件归属，仅为 assistant。" - }, - "url": { - "type": "string", - "format": "url", - "description": "文件访问地址。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会话ID。" - } - } - } - ] - }, - "StreamEventMessageEndCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "metadata" - ], - "properties": { - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataCn" - } - } - } - ] - }, - "StreamEventTtsMessageCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "audio" - ], + "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, + { "type": "object", "required": ["id", "position"], "properties": { - "audio": { - "type": "string", - "format": "byte", - "description": "Base64 编码的音频块。" - } - } - } - ] - }, - "StreamEventTtsMessageEndCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "description": "空字符串。" - } - } - } - ] - }, - "StreamEventMessageReplaceCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "替换内容（直接替换 LLM 所有回复文本）。" - } - } - } - ] - }, - "StreamEventErrorCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "type": "object", - "required": [ - "task_id", - "status", - "code", - "message" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "message_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "消息唯一 ID（错误事件中可能不存在）。" - }, - "status": { - "type": "integer", - "description": "HTTP 状态码。" - }, - "code": { - "type": "string", - "description": "错误码。" - }, - "message": { - "type": "string", - "description": "错误消息。" - } + "id": { "type": "string", "format": "uuid", "description": "agent_thought ID。" }, + "position": { "type": "integer", "description": "agent_thought 在消息中的位置。" }, + "thought": { "type": "string", "description": "agent 的思考内容。" }, + "observation": { "type": "string", "description": "工具调用的返回结果。" }, + "tool": { "type": "string", "description": "使用的工具列表，以 ';' 分割。" }, + "tool_input": { "type": "string", "description": "工具的输入，JSON 格式的字符串。" }, + "message_files": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "当前 agent_thought 关联的文件ID列表 (原描述为 file_id 字符串，修正为数组以匹配 agent_thoughts 历史消息中的 files)。" } } } ] }, - "StreamEventPingCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkBasicChatEventCn" - }, - { - "type": "object", - "description": "每 10s 一次的 ping 事件，保持连接存活。" - } - ] - }, - "UsageCn": { - "type": "object", - "description": "模型用量信息。", - "properties": { - "prompt_tokens": { - "type": "integer" - }, - "prompt_unit_price": { - "type": "string" - }, - "prompt_price_unit": { - "type": "string" - }, - "prompt_price": { - "type": "string" - }, - "completion_tokens": { - "type": "integer" - }, - "completion_unit_price": { - "type": "string" - }, - "completion_price_unit": { - "type": "string" - }, - "completion_price": { - "type": "string" - }, - "total_tokens": { - "type": "integer" - }, - "total_price": { - "type": "string" - }, - "currency": { - "type": "string" - }, - "latency": { - "type": "number", - "format": "double" - } - } - }, - "RetrieverResourceCn": { + "StreamEventMessageFileCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "type": "object", "required": ["id", "type", "belongs_to", "url", "conversation_id"], "properties": { "id": { "type": "string", "format": "uuid", "description": "文件唯一ID。" }, "type": { "type": "string", "enum": ["image"], "description": "文件类型，目前仅为 image。" }, "belongs_to": { "type": "string", "enum": ["assistant"], "description": "文件归属，仅为 assistant。" }, "url": { "type": "string", "format": "url", "description": "文件访问地址。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会话ID。" } } } ] }, + "StreamEventMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataCn" } } } ] }, + "StreamEventTtsMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64 编码的音频块。" } } } ] }, + "StreamEventTtsMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空字符串。" } } } ] }, + "StreamEventMessageReplaceCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "替换内容（直接替换 LLM 所有回复文本）。" } } } ] }, + "StreamEventErrorCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "type": "object", "required": ["task_id", "status", "code", "message"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid", "nullable": true, "description": "消息唯一 ID（错误事件中可能不存在）。" }, "status": { "type": "integer", "description": "HTTP 状态码。" }, "code": { "type": "string", "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } ] }, + "StreamEventPingCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkBasicChatEventCn" }, { "type": "object", "description": "每 10s 一次的 ping 事件，保持连接存活。" } ] }, + "UsageCn": { "type": "object", "description": "模型用量信息。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, + "RetrieverResourceCn": { "type": "object", "description": "引用和归属分段信息。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } }, + "FileUploadResponseCn": { "type": "object", "description": "文件上传成功后的响应。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "文件名。" }, "size": { "type": "integer", "description": "文件大小 (byte)。" }, "extension": { "type": "string", "description": "文件后缀。" }, "mime_type": { "type": "string", "description": "文件 mime-type。" }, "created_by": { "type": "string", "format": "uuid", "description": "上传人 ID。" }, "created_at": { "type": "integer", "format": "int64", "description": "上传时间。" } } }, + "EndUserDetailCn": { "type": "object", - "description": "引用和归属分段信息。", "properties": { - "position": { - "type": "integer" - }, - "dataset_id": { - "type": "string", - "format": "uuid" - }, - "dataset_name": { - "type": "string" - }, - "document_id": { - "type": "string", - "format": "uuid" - }, - "document_name": { - "type": "string" - }, - "segment_id": { - "type": "string", - "format": "uuid" - }, - "score": { - "type": "number", - "format": "float" - }, - "content": { - "type": "string" - } - } - }, - "FileUploadResponseCn": { - "type": "object", - "description": "文件上传成功后的响应。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "name": { - "type": "string", - "description": "文件名。" - }, - "size": { - "type": "integer", - "description": "文件大小 (byte)。" - }, - "extension": { - "type": "string", - "description": "文件后缀。" - }, - "mime_type": { - "type": "string", - "description": "文件 mime-type。" - }, - "created_by": { - "type": "string", - "format": "uuid", - "description": "上传人 ID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "上传时间。" - } - } - }, - "EndUserDetailCn": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "tenant_id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "type": { - "type": "string", - "example": "service_api" - }, - "external_user_id": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "is_anonymous": { - "type": "boolean" - }, - "session_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "MessageFeedbackRequestCn": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true, - "description": "点赞 'like', 点踩 'dislike', 撤销点赞 null。" - }, - "user": { - "type": "string", - "description": "用户标识。" - }, - "content": { - "type": "string", - "nullable": true, - "description": "消息反馈的具体信息。" - } - } - }, - "AppFeedbacksResponseCn": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeedbackItemCn" - }, - "description": "返回该APP的点赞、反馈列表。" - } - } - }, - "FeedbackItemCn": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid" - }, - "conversation_id": { - "type": "string", - "format": "uuid" - }, - "message_id": { - "type": "string", - "format": "uuid" - }, - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true - }, - "content": { - "type": "string" - }, - "from_source": { - "type": "string" - }, - "from_end_user_id": { - "type": "string", - "format": "uuid" - }, - "from_account_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "SuggestedQuestionsResponseCn": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - }, - "data": { - "type": "array", - "items": { - "type": "string" - }, - "description": "建议问题列表。" - } - } - }, - "BasicConversationHistoryResponseCn": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "返回条数。" - }, - "has_more": { - "type": "boolean", - "description": "是否存在下一页。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BasicConversationMessageItemCn" - }, - "description": "消息列表。" - } - } - }, - "BasicConversationMessageItemCn": { - "type": "object", - "description": "会话中的单条消息。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "消息 ID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会话 ID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "用户输入参数。" - }, - "query": { - "type": "string", - "description": "用户输入/提问内容。" - }, - "answer": { - "type": "string", - "description": "回答消息内容。" - }, - "message_files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MessageFileItemCn" - }, - "description": "消息文件列表。" - }, - "feedback": { - "type": "object", - "nullable": true, - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike" - ], - "description": "点赞 'like' / 点踩 'dislike'。" - } - }, - "description": "反馈信息。" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResourceCn" - }, - "description": "引用和归属分段列表。" - }, - "agent_thoughts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AgentThoughtItemCn" - }, - "description": "Agent思考内容（仅Agent模式下不为空）。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间。" - } - } - }, - "MessageFileItemCn": { - "type": "object", - "description": "消息中的文件项。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "type": { - "type": "string", - "description": "文件类型，例如 'image'。" - }, - "url": { - "type": "string", - "format": "url", - "description": "预览图片地址。" - }, - "belongs_to": { - "type": "string", - "enum": [ - "user", - "assistant" - ], - "description": "文件归属方。" - } - } - }, + "id": { "type": "string", "format": "uuid" }, + "tenant_id": { "type": "string", "format": "uuid" }, + "app_id": { "type": "string", "format": "uuid", "nullable": true }, + "type": { "type": "string", "example": "service_api" }, + "external_user_id": { "type": "string", "nullable": true }, + "name": { "type": "string", "nullable": true }, + "is_anonymous": { "type": "boolean" }, + "session_id": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + } + }, + "MessageFeedbackRequestCn": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "点赞 'like', 点踩 'dislike', 撤销点赞 null。" }, "user": { "type": "string", "description": "用户标识。" }, "content": { "type": "string", "nullable": true, "description": "消息反馈的具体信息。" } } }, + "AppFeedbacksResponseCn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemCn" }, "description": "返回该APP的点赞、反馈列表。" } } }, + "FeedbackItemCn": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, + "SuggestedQuestionsResponseCn": { "type": "object", "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "string" }, "description": "建议问题列表。" } } }, + "BasicConversationHistoryResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返回条数。" }, "has_more": { "type": "boolean", "description": "是否存在下一页。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BasicConversationMessageItemCn" }, "description": "消息列表。" } } }, + "BasicConversationMessageItemCn": { "type": "object", "description": "会话中的单条消息。", "properties": { "id": { "type": "string", "format": "uuid", "description": "消息 ID。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "用户输入参数。" }, "query": { "type": "string", "description": "用户输入/提问内容。" }, "answer": { "type": "string", "description": "回答消息内容。" }, "message_files": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFileItemCn" }, "description": "消息文件列表。" }, "feedback": { "type": "object", "nullable": true, "properties": { "rating": { "type": "string", "enum": ["like", "dislike"], "description": "点赞 'like' / 点踩 'dislike'。" } }, "description": "反馈信息。" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceCn" }, "description": "引用和归属分段列表。" }, "agent_thoughts": { "type": "array", "items": { "$ref": "#/components/schemas/AgentThoughtItemCn" }, "description": "Agent思考内容（仅Agent模式下不为空）。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" } } }, + "MessageFileItemCn": { "type": "object", "description": "消息中的文件项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "文件类型，例如 'image'。" }, "url": { "type": "string", "format": "url", "description": "预览图片地址。" }, "belongs_to": { "type": "string", "enum": ["user", "assistant"], "description": "文件归属方。" } } }, "AgentThoughtItemCn": { - "type": "object", - "description": "Agent思考内容。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "agent_thought ID。" - }, - "chain_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "（示例中存在，描述中未明确，暂定为可选）" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息唯一ID。" - }, - "position": { - "type": "integer", - "description": "agent_thought在消息中的位置。" - }, - "thought": { - "type": "string", - "description": "agent的思考内容。" - }, - "tool": { - "type": "string", - "description": "使用的工具列表，以 ';' 分割。" - }, - "tool_input": { - "type": "string", - "description": "工具的输入，JSON格式的字符串。" - }, - "observation": { - "type": "string", - "description": "工具调用的返回结果。" - }, - "files": { - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "description": "当前agent_thought关联的文件ID (示例中为files，markdown中为message_files.file_id)。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间戳。" - } - } - }, - "ConversationsListResponseCn": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "返回条数。" - }, - "has_more": { - "type": "boolean" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationListItemCn" - }, - "description": "会话列表。" - } - } - }, - "ConversationListItemCn": { - "type": "object", - "description": "会话列表中的单项。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "会话 ID。" - }, - "name": { - "type": "string", - "description": "会话名称。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "用户输入参数。" - }, - "status": { - "type": "string", - "description": "会话状态。" - }, - "introduction": { - "type": "string", - "nullable": true, - "description": "开场白。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间。" - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "更新时间。" - } - } - }, - "ConversationRenameRequestCn": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "name": { - "type": "string", - "nullable": true, - "description": "（选填）名称，若 auto_generate 为 true 时可不传。" - }, - "auto_generate": { - "type": "boolean", - "default": false, - "description": "（选填）自动生成标题，默认 false。" - }, - "user": { - "type": "string", - "description": "用户标识。" - } - } - }, - "ConversationRenameResponseCn": { - "$ref": "#/components/schemas/ConversationListItemCn" - }, - "ConversationVariablesResponseCn": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "每页项目数。" - }, - "has_more": { - "type": "boolean", - "description": "是否有更多项目。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationVariableItemCn" - }, - "description": "变量列表。" - } - } - }, - "ConversationVariableItemCn": { - "type": "object", - "description": "对话中的变量项。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "变量ID。" - }, - "name": { - "type": "string", - "description": "变量名称。" - }, - "value_type": { - "type": "string", - "description": "变量类型 (string, number, boolean 等)。" - }, - "value": { - "type": "string", - "description": "变量值。" - }, - "description": { - "type": "string", - "nullable": true, - "description": "变量描述。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间戳。" - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "最后更新时间戳。" - } - } - }, - "AudioToTextRequestCn": { - "type": "object", - "required": [ - "file", - "user" - ], - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "语音文件。支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']。大小限制：15MB。" - }, - "user": { - "type": "string", - "description": "用户标识。" - } - } - }, - "AudioToTextResponseCn": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "输出文字。" - } - } - }, - "TextToAudioFormRequestCn": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息ID (优先)。" - }, - "text": { - "type": "string", - "description": "语音生成内容。" - }, - "user": { - "type": "string", - "description": "用户标识。" - } - }, - "description": "需要 `user`。提供 `message_id` 或 `text`。" - }, - "AppInfoResponseCn": { - "type": "object", - "description": "应用基本信息。", - "properties": { - "name": { - "type": "string", - "description": "应用名称。" - }, - "description": { - "type": "string", - "description": "应用描述。" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "应用标签。" - } - } - }, - "ChatAppParametersResponseCn": { - "type": "object", - "description": "应用参数信息。", - "properties": { - "opening_statement": { - "type": "string", - "description": "开场白。" - }, - "suggested_questions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "开场推荐问题列表。" - }, - "suggested_questions_after_answer": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - } - }, - "description": "启用回答后给出推荐问题。" - }, - "speech_to_text": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - } - }, - "description": "语音转文本。" - }, - "text_to_speech": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - }, - "voice": { - "type": "string", - "description": "语音类型。" - }, - "language": { - "type": "string", - "description": "语言。" - }, - "autoPlay": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ], - "description": "自动播放：enabled 开启, disabled 关闭。" - } - }, - "description": "文本转语音。" - }, - "retriever_resource": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - } - }, - "description": "引用和归属。" - }, - "annotation_reply": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - } - }, - "description": "标记回复。" - }, - "user_input_form": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserInputFormItemCn" - }, - "description": "用户输入表单配置。" - }, - "file_upload": { - "type": "object", - "properties": { - "image": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "number_limits": { - "type": "integer" - }, - "transfer_methods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ] - } - } - }, - "description": "图片设置。支持 png, jpg, jpeg, webp, gif。" - } - }, - "description": "文件上传配置。" - }, - "system_parameters": { - "type": "object", - "properties": { - "file_size_limit": { - "type": "integer", - "description": "文档上传大小限制 (MB)。" - }, - "image_file_size_limit": { - "type": "integer", - "description": "图片文件上传大小限制（MB）。" - }, - "audio_file_size_limit": { - "type": "integer", - "description": "音频文件上传大小限制 (MB)。" - }, - "video_file_size_limit": { - "type": "integer", - "description": "视频文件上传大小限制 (MB)。" - } - }, - "description": "系统参数。" - } - } - }, - "UserInputFormItemCn": { - "type": "object", - "description": "用户输入表单中的控件项。", - "oneOf": [ - { - "$ref": "#/components/schemas/TextInputControlWrapperCn" - }, - { - "$ref": "#/components/schemas/ParagraphControlWrapperCn" - }, - { - "$ref": "#/components/schemas/SelectControlWrapperCn" - } - ] - }, - "TextInputControlWrapperCn": { - "type": "object", - "properties": { - "text-input": { - "$ref": "#/components/schemas/TextInputControlCn" - } - }, - "required": [ - "text-input" - ] - }, - "ParagraphControlWrapperCn": { - "type": "object", - "properties": { - "paragraph": { - "$ref": "#/components/schemas/ParagraphControlCn" - } - }, - "required": [ - "paragraph" - ] - }, - "SelectControlWrapperCn": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/SelectControlCn" - } - }, - "required": [ - "select" - ] - }, - "TextInputControlCn": { - "type": "object", - "description": "文本输入控件。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "默认值。" - } - } - }, - "ParagraphControlCn": { - "type": "object", - "description": "段落文本输入控件。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "默认值。" - } - } - }, - "SelectControlCn": { - "type": "object", - "description": "下拉控件。", - "required": [ - "label", - "variable", - "required", - "options" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "默认值。" - }, - "options": { - "type": "array", - "items": { - "type": "string" - }, - "description": "选项值。" - } - } - }, - "AppMetaResponseCn": { - "type": "object", - "description": "应用 Meta 信息。", - "properties": { - "tool_icons": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "string", - "format": "url", - "description": "图标 URL。" - }, - { - "$ref": "#/components/schemas/ToolIconDetailCn" - } - ] - }, - "description": "工具图标，键为工具名称。" - } - } - }, - "ToolIconDetailCn": { - "type": "object", - "description": "工具图标详情。", - "properties": { - "background": { - "type": "string", - "description": "hex 格式的背景色。" - }, - "content": { - "type": "string", - "description": "emoji。" - } - } - }, - "WebAppSettingsResponseCn": { - "type": "object", - "description": "应用 WebApp 设置。", - "properties": { - "title": { - "type": "string", - "description": "WebApp 名称。" - }, - "chat_color_theme": { - "type": "string", - "description": "聊天颜色主题, hex 格式。" - }, - "chat_color_theme_inverted": { - "type": "boolean", - "description": "聊天颜色主题是否反转。" - }, - "icon_type": { - "type": "string", - "enum": [ - "emoji", - "image" - ], - "description": "图标类型。" - }, - "icon": { - "type": "string", - "description": "图标内容 (emoji 或图片 URL)。" - }, - "icon_background": { - "type": "string", - "description": "hex 格式的背景色。" - }, - "icon_url": { - "type": "string", - "format": "url", - "nullable": true, - "description": "图标 URL。" - }, - "description": { - "type": "string", - "description": "描述。" - }, - "copyright": { - "type": "string", - "description": "版权信息。" - }, - "privacy_policy": { - "type": "string", - "description": "隐私政策链接。" - }, - "custom_disclaimer": { - "type": "string", - "description": "自定义免责声明。" - }, - "default_language": { - "type": "string", - "description": "默认语言。" - }, - "show_workflow_steps": { - "type": "boolean", - "description": "是否显示工作流详情。" - }, - "use_icon_as_answer_icon": { - "type": "boolean", - "description": "是否使用 WebApp 图标替换聊天中的机器人图标。" - } - } - }, - "ErrorResponseCn": { - "type": "object", - "description": "错误响应。", - "properties": { - "status": { - "type": "integer", - "nullable": true, - "description": "HTTP 状态码。" - }, - "code": { - "type": "string", - "nullable": true, - "description": "错误码。" - }, - "message": { - "type": "string", - "description": "错误消息。" - } - } - } + "type": "object", "description": "Agent思考内容。", + "properties": { + "id": { "type": "string", "format": "uuid", "description": "agent_thought ID。" }, + "chain_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（示例中存在，描述中未明确，暂定为可选）"}, + "message_id": { "type": "string", "format": "uuid", "description": "消息唯一ID。" }, + "position": { "type": "integer", "description": "agent_thought在消息中的位置。" }, + "thought": { "type": "string", "description": "agent的思考内容。" }, + "tool": { "type": "string", "description": "使用的工具列表，以 ';' 分割。" }, + "tool_input": { "type": "string", "description": "工具的输入，JSON格式的字符串。" }, + "observation": { "type": "string", "description": "工具调用的返回结果。" }, + "files": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "当前agent_thought关联的文件ID (示例中为files，markdown中为message_files.file_id)。" }, + "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } + } + }, + "ConversationsListResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返回条数。" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationListItemCn" }, "description": "会话列表。" } } }, + "ConversationListItemCn": { "type": "object", "description": "会话列表中的单项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, "name": { "type": "string", "description": "会话名称。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "用户输入参数。" }, "status": { "type": "string", "description": "会话状态。" }, "introduction": { "type": "string", "nullable": true, "description": "开场白。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" }, "updated_at": { "type": "integer", "format": "int64", "description": "更新时间。" } } }, + "ConversationRenameRequestCn": { "type": "object", "required": ["user"], "properties": { "name": { "type": "string", "nullable": true, "description": "（选填）名称，若 auto_generate 为 true 时可不传。" }, "auto_generate": { "type": "boolean", "default": false, "description": "（选填）自动生成标题，默认 false。" }, "user": { "type": "string", "description": "用户标识。" } } }, + "ConversationRenameResponseCn": { "$ref": "#/components/schemas/ConversationListItemCn" }, + "ConversationVariablesResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "每页项目数。" }, "has_more": { "type": "boolean", "description": "是否有更多项目。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationVariableItemCn" }, "description": "变量列表。" } } }, + "ConversationVariableItemCn": { "type": "object", "description": "对话中的变量项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "变量ID。" }, "name": { "type": "string", "description": "变量名称。" }, "value_type": { "type": "string", "description": "变量类型 (string, number, boolean 等)。" }, "value": { "type": "string", "description": "变量值。" }, "description": { "type": "string", "nullable": true, "description": "变量描述。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" }, "updated_at": { "type": "integer", "format": "int64", "description": "最后更新时间戳。" } } }, + "AudioToTextRequestCn": { "type": "object", "required": ["file", "user"], "properties": { "file": { "type": "string", "format": "binary", "description": "语音文件。支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']。大小限制：15MB。" }, "user": { "type": "string", "description": "用户标识。" } } }, + "AudioToTextResponseCn": { "type": "object", "properties": { "text": { "type": "string", "description": "输出文字。" } } }, + "TextToAudioFormRequestCn": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "消息ID (优先)。" }, "text": { "type": "string", "description": "语音生成内容。" }, "user": { "type": "string", "description": "用户标识。" } }, "description": "需要 `user`。提供 `message_id` 或 `text`。" }, + "AppInfoResponseCn": { "type": "object", "description": "应用基本信息。", "properties": { "name": { "type": "string", "description": "应用名称。" }, "description": { "type": "string", "description": "应用描述。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "应用标签。" } } }, + "ChatAppParametersResponseCn": { "type": "object", "description": "应用参数信息。", "properties": { "opening_statement": { "type": "string", "description": "开场白。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "开场推荐问题列表。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "启用回答后给出推荐问题。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "语音转文本。" }, "text_to_speech": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" }, "voice": { "type": "string", "description": "语音类型。" }, "language": { "type": "string", "description": "语言。" }, "autoPlay": { "type": "string", "enum": ["enabled", "disabled"], "description": "自动播放：enabled 开启, disabled 关闭。" } }, "description": "文本转语音。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "引用和归属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "标记回复。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemCn" }, "description": "用户输入表单配置。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "图片设置。支持 png, jpg, jpeg, webp, gif。" } }, "description": "文件上传配置。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "文档上传大小限制 (MB)。" }, "image_file_size_limit": { "type": "integer", "description": "图片文件上传大小限制（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "音频文件上传大小限制 (MB)。" }, "video_file_size_limit": { "type": "integer", "description": "视频文件上传大小限制 (MB)。" } }, "description": "系统参数。" } } }, + "UserInputFormItemCn": { "type": "object", "description": "用户输入表单中的控件项。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperCn" }, { "$ref": "#/components/schemas/ParagraphControlWrapperCn" }, { "$ref": "#/components/schemas/SelectControlWrapperCn" } ] }, + "TextInputControlWrapperCn": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlCn" } }, "required":["text-input"] }, + "ParagraphControlWrapperCn": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlCn" } }, "required":["paragraph"] }, + "SelectControlWrapperCn": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlCn" } }, "required":["select"] }, + "TextInputControlCn": { "type": "object", "description": "文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, + "ParagraphControlCn": { "type": "object", "description": "段落文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, + "SelectControlCn": { "type": "object", "description": "下拉控件。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "选项值。" } } }, + "AppMetaResponseCn": { "type": "object", "description": "应用 Meta 信息。", "properties": { "tool_icons": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "format": "url", "description": "图标 URL。" }, { "$ref": "#/components/schemas/ToolIconDetailCn" } ] }, "description": "工具图标，键为工具名称。" } } }, + "ToolIconDetailCn": { "type": "object", "description": "工具图标详情。", "properties": { "background": { "type": "string", "description": "hex 格式的背景色。" }, "content": { "type": "string", "description": "emoji。" } } }, + "WebAppSettingsResponseCn": { "type": "object", "description": "应用 WebApp 设置。", "properties": { "title": { "type": "string", "description": "WebApp 名称。" }, "chat_color_theme": { "type": "string", "description": "聊天颜色主题, hex 格式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "图标类型。" }, "icon": { "type": "string", "description": "图标内容 (emoji 或图片 URL)。" }, "icon_background": { "type": "string", "description": "hex 格式的背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "图标 URL。" }, "description": { "type": "string", "description": "描述。" }, "copyright": { "type": "string", "description": "版权信息。" }, "privacy_policy": { "type": "string", "description": "隐私政策链接。" }, "custom_disclaimer": { "type": "string", "description": "自定义免责声明。" }, "default_language": { "type": "string", "description": "默认语言。" }, "show_workflow_steps": { "type": "boolean", "description": "是否显示工作流详情。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "是否使用 WebApp 图标替换聊天中的机器人图标。" } } }, + "ErrorResponseCn": { "type": "object", "description": "错误响应。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTP 状态码。" }, "code": { "type": "string", "nullable": true, "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } } }, "tags": [ - { - "name": "对话消息", - "description": "与对话消息和交互相关的操作。" - }, - { - "name": "文件操作", - "description": "文件上传和预览相关的操作。" - }, - { - "name": "终端用户", - "description": "终端用户信息相关的操作。" - }, - { - "name": "消息反馈", - "description": "用户对消息的反馈操作。" - }, - { - "name": "会话管理", - "description": "管理对话会话相关的操作。" - }, - { - "name": "语音与文字转换", - "description": "文本转语音和语音转文本操作。" - }, - { - "name": "应用配置", - "description": "获取应用设置和信息相关的操作。" - } + { "name": "对话消息", "description": "与对话消息和交互相关的操作。" }, + { "name": "文件操作", "description": "文件上传和预览相关的操作。" }, + { "name": "终端用户", "description": "终端用户信息相关的操作。" }, + { "name": "消息反馈", "description": "用户对消息的反馈操作。" }, + { "name": "会话管理", "description": "管理对话会话相关的操作。" }, + { "name": "语音与文字转换", "description": "文本转语音和语音转文本操作。" }, + { "name": "应用配置", "description": "获取应用设置和信息相关的操作。" } ] -} +} \ No newline at end of file diff --git a/zh/api-reference/openapi_chatflow.json b/zh/api-reference/openapi_chatflow.json index 951b0086d..341280133 100644 --- a/zh/api-reference/openapi_chatflow.json +++ b/zh/api-reference/openapi_chatflow.json @@ -28,9 +28,7 @@ "summary": "发送对话消息", "description": "创建会话消息。", "operationId": "sendChatMessageCn", - "tags": [ - "对话消息" - ], + "tags": ["对话消息"], "requestBody": { "description": "发送对话消息的请求体。", "required": true, @@ -80,18 +78,9 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequestGenericCn" - }, - "404": { - "$ref": "#/components/responses/ConversationNotFoundCn" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/chatflow/send-chat-message" + "400": { "$ref": "#/components/responses/BadRequestGenericCn" }, + "404": { "$ref": "#/components/responses/ConversationNotFoundCn" }, + "500": { "$ref": "#/components/responses/InternalServerErrorCn" } } } }, @@ -100,9 +89,7 @@ "summary": "上传文件", "description": "上传文件并在发送消息时使用，可实现图文多模态理解。支持你的应用程序所支持的所有格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadFileCn", - "tags": [ - "文件操作" - ], + "tags": ["文件操作"], "requestBody": { "description": "文件上传请求。需使用 `multipart/form-data` 进行请求。", "required": true, @@ -110,10 +97,7 @@ "multipart/form-data": { "schema": { "type": "object", - "required": [ - "file", - "user" - ], + "required": ["file", "user"], "properties": { "file": { "type": "string", @@ -140,34 +124,15 @@ } } }, - "201": { + "201": { "description": "文件创建成功 (备选成功状态码)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseCn" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseCn" } } } }, - "400": { - "$ref": "#/components/responses/BadRequestFileCn" - }, - "413": { - "$ref": "#/components/responses/FileTooLargeCn" - }, - "415": { - "$ref": "#/components/responses/UnsupportedFileTypeFileCn" - }, - "503": { - "$ref": "#/components/responses/S3ErrorFileCn" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/files/file-upload" + "400": { "$ref": "#/components/responses/BadRequestFileCn" }, + "413": { "$ref": "#/components/responses/FileTooLargeCn" }, + "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileCn" }, + "503": { "$ref": "#/components/responses/S3ErrorFileCn" }, + "500": { "$ref": "#/components/responses/InternalServerErrorCn" } } } }, @@ -176,19 +141,14 @@ "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", "operationId": "getEndUserChatflowCn", - "tags": [ - "终端用户" - ], + "tags": ["终端用户"], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "终端用户 ID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -196,21 +156,12 @@ "description": "成功获取终端用户信息。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/EndUserDetailCn" - } + "schema": { "$ref": "#/components/schemas/EndUserDetailCn" } } } }, - "404": { - "$ref": "#/components/responses/EndUserNotFoundCn" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/end-users/get-end-user" + "404": { "$ref": "#/components/responses/EndUserNotFoundCn" }, + "500": { "$ref": "#/components/responses/InternalServerErrorCn" } } } }, @@ -219,9 +170,7 @@ "summary": "文件预览", "description": "预览或下载已上传的文件。此端点允许你访问之前通过文件上传API上传的文件。文件只能在所属的应用程序消息内访问。", "operationId": "previewChatFlowFileCn", - "tags": [ - "文件操作" - ], + "tags": ["文件操作"], "parameters": [ { "name": "file_id", @@ -318,9 +267,7 @@ "description": "错误请求。可能的错误代码:\n- `invalid_param`: 异常参数输入。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, @@ -328,9 +275,7 @@ "description": "禁止访问。可能的错误代码:\n- `file_access_denied`: 文件访问被拒绝或文件不属于当前应用程序。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, @@ -338,9 +283,7 @@ "description": "未找到。可能的错误代码:\n- `file_not_found`: 文件未找到或已被删除。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, @@ -348,15 +291,10 @@ "description": "内部服务器错误。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } + "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/files/file-preview" } } }, @@ -365,19 +303,14 @@ "summary": "停止响应", "description": "停止生成对话消息。仅支持流式模式。", "operationId": "stopChatMessageGenerationCn", - "tags": [ - "对话消息" - ], + "tags": ["对话消息"], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "任务 ID，可在流式返回 Chunk 中获取。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { @@ -386,9 +319,7 @@ "application/json": { "schema": { "type": "object", - "required": [ - "user" - ], + "required": ["user"], "properties": { "user": { "type": "string", @@ -400,12 +331,7 @@ } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/chatflow/stop-advanced-chat-message-generation" + "200": { "$ref": "#/components/responses/SuccessResultCn" } } } }, @@ -414,38 +340,26 @@ "summary": "消息反馈（点赞）", "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", "operationId": "postMessageFeedbackCn", - "tags": [ - "消息反馈" - ], + "tags": ["消息反馈"], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/MessageFeedbackRequestCn" - } + "schema": { "$ref": "#/components/schemas/MessageFeedbackRequestCn" } } } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/feedback/message-feedback" + "200": { "$ref": "#/components/responses/SuccessResultCn" } } } }, @@ -454,31 +368,20 @@ "summary": "获取APP的消息点赞和反馈", "description": "获取应用的终端用户反馈、点赞。", "operationId": "getAppFeedbacksCn", - "tags": [ - "消息反馈" - ], + "tags": ["消息反馈"], "parameters": [ - { - "$ref": "#/components/parameters/PageQueryParamCn" - }, - { - "$ref": "#/components/parameters/LimitQueryParamCn" - } + { "$ref": "#/components/parameters/PageQueryParamCn" }, + { "$ref": "#/components/parameters/LimitQueryParamCn" } ], "responses": { "200": { "description": "成功获取应用的反馈列表。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFeedbacksResponseCn" - } + "schema": { "$ref": "#/components/schemas/AppFeedbacksResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -487,38 +390,26 @@ "summary": "获取下一轮建议问题列表", "description": "获取当前消息的下一轮建议问题列表。", "operationId": "getSuggestedQuestionsCn", - "tags": [ - "对话消息" - ], + "tags": ["对话消息"], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } }, - { - "$ref": "#/components/parameters/UserQueryParamCn" - } + { "$ref": "#/components/parameters/UserQueryParamCn" } ], "responses": { "200": { "description": "成功获取建议问题列表。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/SuggestedQuestionsResponseCn" - } + "schema": { "$ref": "#/components/schemas/SuggestedQuestionsResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/chatflow/next-suggested-questions" } } }, @@ -527,44 +418,27 @@ "summary": "获取会话历史消息", "description": "滚动加载形式返回历史聊天记录，第一页返回最新 `limit` 条，即倒序返回。", "operationId": "getConversationHistoryCn", - "tags": [ - "会话管理" - ], + "tags": ["会话管理"], "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdQueryParamCn" - }, - { - "$ref": "#/components/parameters/UserQueryParamCn" - }, + { "$ref": "#/components/parameters/ConversationIdQueryParamCn" }, + { "$ref": "#/components/parameters/UserQueryParamCn" }, { "name": "first_id", "in": "query", "description": "当前页第一条聊天记录的 ID，默认 null。", - "schema": { - "type": "string", - "format": "uuid", - "nullable": true - } + "schema": { "type": "string", "format": "uuid", "nullable": true } }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Cn" - } + { "$ref": "#/components/parameters/LimitQueryParamDefault20Cn" } ], "responses": { "200": { "description": "成功获取会话历史消息。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationHistoryResponseCn" - } + "schema": { "$ref": "#/components/schemas/ConversationHistoryResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/get-conversation-history-messages" } } }, @@ -573,37 +447,22 @@ "summary": "获取会话列表", "description": "获取当前用户的会话列表，默认返回最近的 20 条。", "operationId": "getConversationsListCn", - "tags": [ - "会话管理" - ], + "tags": ["会话管理"], "parameters": [ - { - "$ref": "#/components/parameters/UserQueryParamCn" - }, - { - "$ref": "#/components/parameters/LastIdQueryParamCn" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" - }, - { - "$ref": "#/components/parameters/SortByQueryParamCn" - } + { "$ref": "#/components/parameters/UserQueryParamCn" }, + { "$ref": "#/components/parameters/LastIdQueryParamCn" }, + { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" }, + { "$ref": "#/components/parameters/SortByQueryParamCn" } ], "responses": { "200": { "description": "成功获取会话列表。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationsListResponseCn" - } + "schema": { "$ref": "#/components/schemas/ConversationsListResponseCn" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/get-conversations" } } }, @@ -612,41 +471,20 @@ "summary": "删除会话", "description": "删除一个指定的会话。", "operationId": "deleteConversationCn", - "tags": [ - "会话管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamCn" - } - ], + "tags": ["会话管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamCn" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "user": { - "type": "string", - "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" - } - } + "type": "object", "required": ["user"], + "properties": { "user": { "type": "string", "description": "用户标识。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" } } } } } }, - "responses": { - "204": { - "description": "会话删除成功，无内容返回。" - } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/delete-conversation" - } + "responses": { "204": { "description": "会话删除成功，无内容返回。" } } } }, "/conversations/{conversation_id}/name": { @@ -654,80 +492,32 @@ "summary": "会话重命名", "description": "对会话进行重命名。", "operationId": "renameConversationCn", - "tags": [ - "会话管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamCn" - } - ], + "tags": ["会话管理"], + "parameters": [ { "$ref": "#/components/parameters/ConversationIdPathParamCn" } ], "requestBody": { "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationRenameRequestCn" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameRequestCn" } } } }, "responses": { - "200": { - "description": "会话重命名成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationRenameResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/conversation-rename" + "200": { "description": "会话重命名成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationRenameResponseCn" } } } } } } }, - "/conversations/{conversation_id}/variables": { + "/conversations/{conversation_id}/variables": { "get": { "summary": "获取对话变量", "description": "从特定对话中检索变量。此端点对于提取对话过程中捕获的结构化数据非常有用。", "operationId": "getConversationVariablesCn", - "tags": [ - "会话管理" - ], + "tags": ["会话管理"], "parameters": [ - { - "$ref": "#/components/parameters/ConversationIdPathParamCn" - }, - { - "$ref": "#/components/parameters/UserQueryParamCn" - }, - { - "$ref": "#/components/parameters/LastIdQueryParamCn" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" - } + { "$ref": "#/components/parameters/ConversationIdPathParamCn" }, + { "$ref": "#/components/parameters/UserQueryParamCn" }, + { "$ref": "#/components/parameters/LastIdQueryParamCn" }, + { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" } ], "responses": { - "200": { - "description": "成功获取对话变量。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConversationVariablesResponseCn" - } - } - } - }, - "404": { - "$ref": "#/components/responses/ConversationNotFoundCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/conversations/get-conversation-variables" + "200": { "description": "成功获取对话变量。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationVariablesResponseCn" } } } }, + "404": { "$ref": "#/components/responses/ConversationNotFoundCn" } } } }, @@ -736,33 +526,13 @@ "summary": "语音转文字", "description": "将语音文件转换为文字。支持格式：mp3, mp4, mpeg, mpga, m4a, wav, webm。文件大小限制：15MB。", "operationId": "audioToTextCn", - "tags": [ - "语音与文字转换" - ], + "tags": ["语音与文字转换"], "requestBody": { "required": true, - "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/AudioToTextRequestCn" - } - } - } + "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AudioToTextRequestCn" } } } }, "responses": { - "200": { - "description": "成功将语音转换为文字。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AudioToTextResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/tts/speech-to-text" + "200": { "description": "成功将语音转换为文字。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioToTextResponseCn" } } } } } } }, @@ -771,48 +541,17 @@ "summary": "文字转语音", "description": "将文字内容转换为语音。", "operationId": "textToAudioCn", - "tags": [ - "语音与文字转换" - ], + "tags": ["语音与文字转换"], "requestBody": { "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TextToAudioJsonRequestCn" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextToAudioJsonRequestCn" } } } }, "responses": { "200": { "description": "成功生成语音文件。", - "content": { - "audio/wav": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "audio/mp3": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, - "headers": { - "Content-Type": { - "schema": { - "type": "string", - "example": "audio/wav" - } - } - } + "content": { "audio/wav": { "schema": { "type": "string", "format": "binary" } }, "audio/mp3": { "schema": { "type": "string", "format": "binary" } } }, + "headers": { "Content-Type": { "schema": { "type": "string", "example": "audio/wav" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/tts/text-to-audio" } } }, @@ -820,24 +559,8 @@ "get": { "summary": "获取应用基本信息", "operationId": "getAppInfoCn", - "tags": [ - "应用配置" - ], - "responses": { - "200": { - "description": "应用基本信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfoResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-basic-information" - } + "tags": ["应用配置"], + "responses": { "200": { "description": "应用基本信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseCn" } } } } } } }, "/parameters": { @@ -845,24 +568,8 @@ "summary": "获取应用参数", "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", "operationId": "getAppParametersCn", - "tags": [ - "应用配置" - ], - "responses": { - "200": { - "description": "应用参数信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatAppParametersResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-parameters-information" - } + "tags": ["应用配置"], + "responses": { "200": { "description": "应用参数信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAppParametersResponseCn" } } } } } } }, "/meta": { @@ -870,24 +577,8 @@ "summary": "获取应用Meta信息", "description": "用于获取工具 icon。", "operationId": "getAppMetaCn", - "tags": [ - "应用配置" - ], - "responses": { - "200": { - "description": "成功获取应用 Meta 信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppMetaResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-meta-information" - } + "tags": ["应用配置"], + "responses": { "200": { "description": "成功获取应用 Meta 信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppMetaResponseCn" } } } } } } }, "/site": { @@ -895,97 +586,26 @@ "summary": "获取应用 WebApp 设置", "description": "用于获取应用的 WebApp 设置。", "operationId": "getWebAppSettingsCn", - "tags": [ - "应用配置" - ], - "responses": { - "200": { - "description": "WebApp 设置信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebAppSettingsResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-webapp-settings" - } + "tags": ["应用配置"], + "responses": { "200": { "description": "WebApp 设置信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponseCn" } } } } } } }, "/apps/annotations": { "get": { "summary": "获取标注列表", "operationId": "getAnnotationListCn", - "tags": [ - "标注管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/PageQueryParamCn" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" - } - ], - "responses": { - "200": { - "description": "成功获取标注列表。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnnotationListResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/annotations/get-annotation-list" - } + "tags": ["标注管理"], + "parameters": [ { "$ref": "#/components/parameters/PageQueryParamCn" }, { "$ref": "#/components/parameters/LimitQueryParamDefault20Max100Cn" } ], + "responses": { "200": { "description": "成功获取标注列表。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationListResponseCn" } } } } } }, "post": { "summary": "创建标注", "operationId": "createAnnotationCn", - "tags": [ - "标注管理" - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAnnotationRequestCn" - } - } - } - }, + "tags": ["标注管理"], + "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationRequestCn" } } } }, "responses": { - "200": { - "description": "标注创建成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnnotationItemCn" - } - } - } - }, - "201": { - "description": "标注创建成功 (备选)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnnotationItemCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/annotations/create-annotation" + "200": { "description": "标注创建成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItemCn" } } } }, + "201": { "description": "标注创建成功 (备选)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItemCn" } } } } } } }, @@ -993,59 +613,17 @@ "put": { "summary": "更新标注", "operationId": "updateAnnotationCn", - "tags": [ - "标注管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/AnnotationIdPathParamCn" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAnnotationRequestCn" - } - } - } - }, - "responses": { - "200": { - "description": "标注更新成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnnotationItemCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/annotations/update-annotation" - } + "tags": ["标注管理"], + "parameters": [ { "$ref": "#/components/parameters/AnnotationIdPathParamCn" } ], + "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnnotationRequestCn" } } } }, + "responses": { "200": { "description": "标注更新成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItemCn" } } } } } }, "delete": { "summary": "删除标注", "operationId": "deleteAnnotationCn", - "tags": [ - "标注管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/AnnotationIdPathParamCn" - } - ], - "responses": { - "204": { - "description": "标注删除成功。" - } - }, - "x-mint": { - "href": "/zh/api-reference/annotations/delete-annotation" - } + "tags": ["标注管理"], + "parameters": [ { "$ref": "#/components/parameters/AnnotationIdPathParamCn" } ], + "responses": { "204": { "description": "标注删除成功。" } } } }, "/apps/annotation-reply/{action}": { @@ -1053,48 +631,12 @@ "summary": "标注回复初始设置", "description": "启用或禁用标注回复功能，并配置相关的嵌入模型和阈值。此接口异步执行。", "operationId": "initialAnnotationReplySettingsCn", - "tags": [ - "标注管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/AnnotationActionPathParamCn" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InitialAnnotationReplySettingsRequestCn" - } - } - } - }, + "tags": ["标注管理"], + "parameters": [ { "$ref": "#/components/parameters/AnnotationActionPathParamCn" } ], + "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsRequestCn" } } } }, "responses": { - "200": { - "description": "任务已启动。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InitialAnnotationReplySettingsResponseCn" - } - } - } - }, - "202": { - "description": "任务已接受处理。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InitialAnnotationReplySettingsResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/annotations/initial-annotation-reply-settings" + "200": { "description": "任务已启动。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsResponseCn" } } } }, + "202": { "description": "任务已接受处理。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsResponseCn" } } } } } } }, @@ -1102,2289 +644,209 @@ "get": { "summary": "查询标注回复初始设置任务状态", "operationId": "getInitialAnnotationReplySettingsStatusCn", - "tags": [ - "标注管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/AnnotationActionPathParamCn" - }, - { - "$ref": "#/components/parameters/JobIdPathParamCn" - } - ], - "responses": { - "200": { - "description": "任务状态。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InitialAnnotationReplySettingsStatusResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/annotations/query-initial-annotation-reply-settings-task-status" - } + "tags": ["标注管理"], + "parameters": [ { "$ref": "#/components/parameters/AnnotationActionPathParamCn" }, { "$ref": "#/components/parameters/JobIdPathParamCn" } ], + "responses": { "200": { "description": "任务状态。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsStatusResponseCn" } } } } } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "API_KEY", - "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" - } + "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" } }, "parameters": { - "PageQueryParamCn": { - "name": "page", - "in": "query", - "description": "页码，（选填）默认值：1。", - "schema": { - "type": "integer", - "default": 1 - } - }, - "LimitQueryParamCn": { - "name": "limit", - "in": "query", - "description": "每页数量，（选填）默认值：20。", - "schema": { - "type": "integer", - "default": 20 - } - }, - "LimitQueryParamDefault20Cn": { - "name": "limit", - "in": "query", - "description": "一次请求返回多少条记录，默认 20 条。", - "schema": { - "type": "integer", - "default": 20 - } - }, - "LimitQueryParamDefault20Max100Cn": { - "name": "limit", - "in": "query", - "description": "一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。", - "schema": { - "type": "integer", - "default": 20, - "minimum": 1, - "maximum": 100 - } - }, - "UserQueryParamCn": { - "name": "user", - "in": "query", - "required": true, - "description": "用户标识，由开发者定义规则，需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", - "schema": { - "type": "string" - } - }, - "ConversationIdQueryParamCn": { - "name": "conversation_id", - "in": "query", - "required": true, - "description": "会话 ID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - "LastIdQueryParamCn": { - "name": "last_id", - "in": "query", - "description": "（选填）当前页最后面一条记录的 ID，默认 null。", - "schema": { - "type": "string", - "format": "uuid", - "nullable": true - } - }, - "SortByQueryParamCn": { - "name": "sort_by", - "in": "query", - "description": "（选填）排序字段，默认 -updated_at (按更新时间倒序排列)。可选值：created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", - "schema": { - "type": "string", - "enum": [ - "created_at", - "-created_at", - "updated_at", - "-updated_at" - ], - "default": "-updated_at" - } - }, - "ConversationIdPathParamCn": { - "name": "conversation_id", - "in": "path", - "required": true, - "description": "会话 ID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - "AnnotationIdPathParamCn": { - "name": "annotation_id", - "in": "path", - "required": true, - "description": "标注 ID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - "AnnotationActionPathParamCn": { - "name": "action", - "in": "path", - "required": true, - "description": "动作，只能是 'enable' 或 'disable'。", - "schema": { - "type": "string", - "enum": [ - "enable", - "disable" - ] - } - }, - "JobIdPathParamCn": { - "name": "job_id", - "in": "path", - "required": true, - "description": "任务 ID，从标注回复初始设置接口返回的 job_id。", - "schema": { - "type": "string", - "format": "uuid" - } - } + "PageQueryParamCn": { "name": "page", "in": "query", "description": "页码，（选填）默认值：1。", "schema": { "type": "integer", "default": 1 } }, + "LimitQueryParamCn": { "name": "limit", "in": "query", "description": "每页数量，（选填）默认值：20。", "schema": { "type": "integer", "default": 20 } }, + "LimitQueryParamDefault20Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录，默认 20 条。", "schema": { "type": "integer", "default": 20 } }, + "LimitQueryParamDefault20Max100Cn": { "name": "limit", "in": "query", "description": "一次请求返回多少条记录，默认 20 条，最大 100 条，最小 1 条。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, + "UserQueryParamCn": { "name": "user", "in": "query", "required": true, "description": "用户标识，由开发者定义规则，需保证用户标识在应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。", "schema": { "type": "string" } }, + "ConversationIdQueryParamCn": { "name": "conversation_id", "in": "query", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } }, + "LastIdQueryParamCn": { "name": "last_id", "in": "query", "description": "（选填）当前页最后面一条记录的 ID，默认 null。", "schema": { "type": "string", "format": "uuid", "nullable": true } }, + "SortByQueryParamCn": { "name": "sort_by", "in": "query", "description": "（选填）排序字段，默认 -updated_at (按更新时间倒序排列)。可选值：created_at, -created_at, updated_at, -updated_at。'-' 代表倒序。", "schema": { "type": "string", "enum": ["created_at", "-created_at", "updated_at", "-updated_at"], "default": "-updated_at" } }, + "ConversationIdPathParamCn": { "name": "conversation_id", "in": "path", "required": true, "description": "会话 ID。", "schema": { "type": "string", "format": "uuid" } }, + "AnnotationIdPathParamCn": { "name": "annotation_id", "in": "path", "required": true, "description": "标注 ID。", "schema": { "type": "string", "format": "uuid" } }, + "AnnotationActionPathParamCn": { "name": "action", "in": "path", "required": true, "description": "动作，只能是 'enable' 或 'disable'。", "schema": { "type": "string", "enum": ["enable", "disable"] } }, + "JobIdPathParamCn": { "name": "job_id", "in": "path", "required": true, "description": "任务 ID，从标注回复初始设置接口返回的 job_id。", "schema": { "type": "string", "format": "uuid" } } }, "responses": { - "BadRequestGenericCn": { - "description": "请求参数错误。可能原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "BadRequestFileCn": { - "description": "文件操作请求错误。可能原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "FileTooLargeCn": { - "description": "文件太大 (file_too_large)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "UnsupportedFileTypeFileCn": { - "description": "不支持的文件类型 (unsupported_file_type)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "S3ErrorFileCn": { - "description": "S3 存储服务错误。可能原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "InternalServerErrorCn": { - "description": "服务内部异常。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "SuccessResultCn": { - "description": "操作成功。", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - } - } - } - } - } - }, - "ConversationNotFoundCn": { - "description": "对话不存在。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "EndUserNotFoundCn": { - "description": "终端用户不存在。错误码：`end_user_not_found`", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - } + "BadRequestGenericCn": { "description": "请求参数错误。可能原因：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, completion_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "BadRequestFileCn": { "description": "文件操作请求错误。可能原因：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "FileTooLargeCn": { "description": "文件太大 (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "UnsupportedFileTypeFileCn": { "description": "不支持的文件类型 (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "S3ErrorFileCn": { "description": "S3 存储服务错误。可能原因：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "InternalServerErrorCn": { "description": "服务内部异常。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "SuccessResultCn": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, + "ConversationNotFoundCn": { "description": "对话不存在。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "EndUserNotFoundCn": { "description": "终端用户不存在。错误码：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } } }, "schemas": { "ChatRequestCn": { "type": "object", - "required": [ - "query", - "user" - ], + "required": ["query", "user"], "properties": { - "query": { - "type": "string", - "description": "用户输入/提问内容。" - }, + "query": { "type": "string", "description": "用户输入/提问内容。" }, "inputs": { "type": "object", "description": "允许传入 App 定义的各变量值。如果变量是文件类型，请指定一个 InputFileObjectCn 对象。", "additionalProperties": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/InputFileObjectCn" - } - ] + "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "$ref": "#/components/schemas/InputFileObjectCn" } ] }, "default": {} }, - "response_mode": { - "type": "string", - "enum": [ - "streaming", - "blocking" - ], - "default": "streaming", - "description": "响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。" - }, - "user": { - "type": "string", - "description": "用户标识，应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "（选填）会话 ID，用于继续之前的对话。" - }, - "files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InputFileObjectCn" - }, - "description": "（选填）文件列表，仅当模型支持 Vision 能力时可用。" - }, - "auto_generate_name": { - "type": "boolean", - "default": true, - "description": "（选填）自动生成会话标题，默认 true。" - } + "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "default": "streaming", "description": "响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。" }, + "user": { "type": "string", "description": "用户标识，应用内唯一。**重要说明**: Service API 不共享 WebApp 创建的对话。通过 API 创建的对话与 WebApp 界面中创建的对话是相互隔离的。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "（选填）会话 ID，用于继续之前的对话。" }, + "files": { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectCn" }, "description": "（选填）文件列表，仅当模型支持 Vision 能力时可用。" }, + "auto_generate_name": { "type": "boolean", "default": true, "description": "（选填）自动生成会话标题，默认 true。" } } }, "InputFileObjectCn": { "type": "object", - "required": [ - "type", - "transfer_method" - ], + "required": ["type", "transfer_method"], "properties": { - "type": { - "type": "string", - "enum": [ - "document", - "image", - "audio", - "video", - "custom" - ], - "description": "文件类型。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: 其他。" - }, - "transfer_method": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ], - "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" - }, - "url": { - "type": "string", - "format": "url", - "description": "图片地址（当传递方式为 remote_url 时）" - }, - "upload_file_id": { - "type": "string", - "format": "uuid", - "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" - } + "type": { "type": "string", "enum": ["document", "image", "audio", "video", "custom"], "description": "文件类型。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: 其他。" }, + "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" }, + "url": { "type": "string", "format": "url", "description": "图片地址（当传递方式为 remote_url 时）" }, + "upload_file_id": { "type": "string", "format":"uuid", "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" } }, "anyOf": [ { - "properties": { - "transfer_method": { - "enum": [ - "remote_url" - ] - }, - "url": { - "type": "string", - "format": "url" - } + "properties": { + "transfer_method": { "enum": ["remote_url"] }, + "url": { "type": "string", "format": "url" } }, - "required": [ - "url" - ], - "not": { - "required": [ - "upload_file_id" - ] - } + "required": ["url"], + "not": { "required": ["upload_file_id"] } }, { - "properties": { - "transfer_method": { - "enum": [ - "local_file" - ] - }, - "upload_file_id": { - "type": "string", - "format": "uuid" - } + "properties": { + "transfer_method": { "enum": ["local_file"] }, + "upload_file_id": { "type": "string", "format":"uuid" } }, - "required": [ - "upload_file_id" - ], - "not": { - "required": [ - "url" - ] - } + "required": ["upload_file_id"], + "not": { "required": ["url"] } } ] }, "ChatCompletionResponseCn": { - "type": "object", - "description": "阻塞模式下的完整 App 结果。", + "type": "object", "description": "阻塞模式下的完整 App 结果。", "properties": { - "event": { - "type": "string", - "example": "message", - "description": "事件类型，固定为 `message`。" - }, - "task_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID。" - }, - "id": { - "type": "string", - "format": "uuid", - "description": "唯一ID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息唯一 ID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会话 ID。" - }, - "mode": { - "type": "string", - "example": "chat", - "description": "App 模式，固定为 `chat`。" - }, - "answer": { - "type": "string", - "description": "完整回复内容。" - }, - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataCn" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "消息创建时间戳。" - } + "event": { "type": "string", "example": "message", "description": "事件类型，固定为 `message`。" }, + "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, + "id": { "type": "string", "format": "uuid", "description": "唯一ID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, + "mode": { "type": "string", "example": "chat", "description": "App 模式，固定为 `chat`。" }, + "answer": { "type": "string", "description": "完整回复内容。" }, + "metadata": { "$ref": "#/components/schemas/ResponseMetadataCn" }, + "created_at": { "type": "integer", "format": "int64", "description": "消息创建时间戳。" } } }, "ResponseMetadataCn": { - "type": "object", - "description": "元数据。", - "properties": { - "usage": { - "$ref": "#/components/schemas/UsageCn" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResourceCn" - }, - "description": "引用和归属分段列表。" - } - } + "type": "object", "description": "元数据。", + "properties": { "usage": { "$ref": "#/components/schemas/UsageCn" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceCn" }, "description": "引用和归属分段列表。" } } }, "ChunkChatEventCn": { - "type": "object", - "required": [ - "event" - ], - "properties": { - "event": { - "type": "string", - "enum": [ - "message", - "message_file", - "message_end", - "tts_message", - "tts_message_end", - "message_replace", - "workflow_started", - "node_started", - "node_finished", - "workflow_finished", - "error", - "ping" - ], - "description": "事件类型。" - } - }, - "discriminator": { - "propertyName": "event", - "mapping": { - "message": "#/components/schemas/StreamEventChatMessageCn", - "message_file": "#/components/schemas/StreamEventMessageFileCn", - "message_end": "#/components/schemas/StreamEventMessageEndCn", - "tts_message": "#/components/schemas/StreamEventTtsMessageCn", - "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndCn", - "message_replace": "#/components/schemas/StreamEventMessageReplaceCn", - "workflow_started": "#/components/schemas/StreamEventWorkflowStartedCn", - "node_started": "#/components/schemas/StreamEventNodeStartedCn", - "node_finished": "#/components/schemas/StreamEventNodeFinishedCn", - "workflow_finished": "#/components/schemas/StreamEventWorkflowFinishedCn", - "error": "#/components/schemas/StreamEventErrorCn", - "ping": "#/components/schemas/StreamEventPingCn" - } - } + "type": "object", "required": ["event"], + "properties": { "event": { "type": "string", "enum": ["message", "message_file", "message_end", "tts_message", "tts_message_end", "message_replace", "workflow_started", "node_started", "node_finished", "workflow_finished", "error", "ping"], "description": "事件类型。" } }, + "discriminator": { "propertyName": "event", "mapping": { + "message": "#/components/schemas/StreamEventChatMessageCn", "message_file": "#/components/schemas/StreamEventMessageFileCn", + "message_end": "#/components/schemas/StreamEventMessageEndCn", "tts_message": "#/components/schemas/StreamEventTtsMessageCn", + "tts_message_end": "#/components/schemas/StreamEventTtsMessageEndCn", "message_replace": "#/components/schemas/StreamEventMessageReplaceCn", + "workflow_started": "#/components/schemas/StreamEventWorkflowStartedCn", "node_started": "#/components/schemas/StreamEventNodeStartedCn", + "node_finished": "#/components/schemas/StreamEventNodeFinishedCn", "workflow_finished": "#/components/schemas/StreamEventWorkflowFinishedCn", + "error": "#/components/schemas/StreamEventErrorCn", "ping": "#/components/schemas/StreamEventPingCn" + }} }, "StreamEventBaseChatCn": { + "type": "object", "properties": { + "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, + "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, + "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, + "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } + } + }, + "StreamEventChatMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLM 返回文本块内容。" } } } ] }, + "StreamEventMessageFileCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["id", "type", "belongs_to", "url", "conversation_id"], "properties": { "id": { "type": "string", "format": "uuid", "description": "文件唯一ID。" }, "type": { "type": "string", "enum": ["image"], "description": "文件类型，目前仅为 image。" }, "belongs_to": { "type": "string", "enum": ["assistant"], "description": "文件归属，仅为 assistant。" }, "url": { "type": "string", "format": "url", "description": "文件访问地址。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会话ID。" } } } ] }, + "StreamEventMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadataCn" } } } ] }, + "StreamEventTtsMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64 编码的音频块。" } } } ] }, + "StreamEventTtsMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空字符串。" } } } ] }, + "StreamEventMessageReplaceCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseChatCn" }, { "type": "object", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "替换内容（直接替换 LLM 所有回复文本）。" } } } ] }, + "StreamEventWorkflowStartedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/WorkflowStartedDataCn" } } } ] }, + "WorkflowStartedDataCn": { "type": "object", "required": ["id", "workflow_id", "sequence_number", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "关联 Workflow ID。" }, "sequence_number": { "type": "integer", "description": "自增序号，App 内自增，从 1 开始。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, + "StreamEventNodeStartedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/NodeStartedDataCn" } } } ] }, + "NodeStartedDataCn": { "type": "object", "required": ["id", "node_id", "node_type", "title", "index", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID (应为 node 执行 ID，根据上下文修正)。" }, "node_id": { "type": "string", "format": "uuid", "description": "节点 ID。" }, "node_type": { "type": "string", "description": "节点类型。" }, "title": { "type": "string", "description": "节点名称。" }, "index": { "type": "integer", "description": "执行序号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "前置节点 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "节点使用的前置变量内容。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, + "StreamEventNodeFinishedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/NodeFinishedDataCn" } } } ] }, + "NodeFinishedDataCn": { "type": "object", "required": ["id", "node_id", "index", "status", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "node 执行 ID。" }, "node_id": { "type": "string", "format": "uuid", "description": "节点 ID。" }, "index": { "type": "integer", "description": "执行序号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（可选）前置节点 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "节点使用的前置变量内容。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）节点过程数据 (JSON)。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）输出内容 (JSON)。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, "error": { "type": "string", "nullable": true, "description": "（可选）错误原因。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（可选）耗时(秒)。" }, "execution_metadata": { "$ref": "#/components/schemas/NodeExecutionMetadataCn" , "nullable": true, "description":"元数据"}, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, + "NodeExecutionMetadataCn": { "type": "object", "description": "节点执行元数据。", "properties": { "total_tokens": { "type": "integer", "nullable": true, "description": "（可选）总使用 tokens。" }, "total_price": { "type": "number", "format": "float", "nullable": true, "description": "（可选）总费用 (使用 float 兼容 decimal)。" }, "currency": { "type": "string", "nullable": true, "example": "USD", "description": "（可选）货币。" } } }, + "StreamEventWorkflowFinishedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "workflow_run_id", "data"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "workflow_run_id": { "type": "string", "format": "uuid" }, "data": { "$ref": "#/components/schemas/WorkflowFinishedDataCn" } } } ] }, + "WorkflowFinishedDataCn": { "type": "object", "required": ["id", "workflow_id", "status", "created_at", "finished_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "关联 Workflow ID。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）输出内容 (JSON)。" }, "error": { "type": "string", "nullable": true, "description": "（可选）错误原因。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（可选）耗时(秒)。" }, "total_tokens": { "type": "integer", "nullable": true, "description": "（可选）总使用 tokens。" }, "total_steps": { "type": "integer", "default": 0, "description": "总步数，默认 0。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" }, "finished_at": { "type": "integer", "format": "int64", "description": "结束时间。" } } }, + "StreamEventErrorCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "required": ["task_id", "status", "code", "message"], "properties": { "task_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid", "nullable": true, "description": "消息唯一 ID（错误事件中可能不存在）。" }, "status": { "type": "integer", "description": "HTTP 状态码。" }, "code": { "type": "string", "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } ] }, + "StreamEventPingCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkChatEventCn" }, { "type": "object", "description": "每 10s 一次的 ping 事件，保持连接存活。" } ] }, + "UsageCn": { "type": "object", "description": "模型用量信息。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, + "RetrieverResourceCn": { "type": "object", "description": "引用和归属分段信息。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } }, + "FileUploadResponseCn": { "type": "object", "description": "文件上传成功后的响应。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "文件名。" }, "size": { "type": "integer", "description": "文件大小 (byte)。" }, "extension": { "type": "string", "description": "文件后缀。" }, "mime_type": { "type": "string", "description": "文件 mime-type。" }, "created_by": { "type": "string", "format": "uuid", "description": "上传人 ID (应为 uuid，示例中为 int，已修正)。" }, "created_at": { "type": "integer", "format": "int64", "description": "上传时间。" } } }, + "EndUserDetailCn": { "type": "object", "properties": { - "task_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息唯一 ID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会话 ID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间戳。" - } - } - }, - "StreamEventChatMessageCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "LLM 返回文本块内容。" - } - } - } - ] - }, - "StreamEventMessageFileCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "type": "object", - "required": [ - "id", - "type", - "belongs_to", - "url", - "conversation_id" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "文件唯一ID。" - }, - "type": { - "type": "string", - "enum": [ - "image" - ], - "description": "文件类型，目前仅为 image。" - }, - "belongs_to": { - "type": "string", - "enum": [ - "assistant" - ], - "description": "文件归属，仅为 assistant。" - }, - "url": { - "type": "string", - "format": "url", - "description": "文件访问地址。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会话ID。" - } - } - } - ] - }, - "StreamEventMessageEndCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "metadata" - ], - "properties": { - "metadata": { - "$ref": "#/components/schemas/ResponseMetadataCn" - } - } - } - ] - }, - "StreamEventTtsMessageCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "format": "byte", - "description": "Base64 编码的音频块。" - } - } - } - ] - }, - "StreamEventTtsMessageEndCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "description": "空字符串。" - } - } - } - ] - }, - "StreamEventMessageReplaceCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseChatCn" - }, - { - "type": "object", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "替换内容（直接替换 LLM 所有回复文本）。" - } - } - } - ] - }, - "StreamEventWorkflowStartedCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "type": "object", - "required": [ - "task_id", - "workflow_run_id", - "data" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid" - }, - "data": { - "$ref": "#/components/schemas/WorkflowStartedDataCn" - } - } - } - ] - }, - "WorkflowStartedDataCn": { - "type": "object", - "required": [ - "id", - "workflow_id", - "sequence_number", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "workflow 执行 ID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "关联 Workflow ID。" - }, - "sequence_number": { - "type": "integer", - "description": "自增序号，App 内自增，从 1 开始。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "开始时间。" - } - } - }, - "StreamEventNodeStartedCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "type": "object", - "required": [ - "task_id", - "workflow_run_id", - "data" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid" - }, - "data": { - "$ref": "#/components/schemas/NodeStartedDataCn" - } - } - } - ] - }, - "NodeStartedDataCn": { - "type": "object", - "required": [ - "id", - "node_id", - "node_type", - "title", - "index", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "workflow 执行 ID (应为 node 执行 ID，根据上下文修正)。" - }, - "node_id": { - "type": "string", - "format": "uuid", - "description": "节点 ID。" - }, - "node_type": { - "type": "string", - "description": "节点类型。" - }, - "title": { - "type": "string", - "description": "节点名称。" - }, - "index": { - "type": "integer", - "description": "执行序号。" - }, - "predecessor_node_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "前置节点 ID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "节点使用的前置变量内容。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "开始时间。" - } - } - }, - "StreamEventNodeFinishedCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "type": "object", - "required": [ - "task_id", - "workflow_run_id", - "data" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid" - }, - "data": { - "$ref": "#/components/schemas/NodeFinishedDataCn" - } - } - } - ] - }, - "NodeFinishedDataCn": { - "type": "object", - "required": [ - "id", - "node_id", - "index", - "status", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "node 执行 ID。" - }, - "node_id": { - "type": "string", - "format": "uuid", - "description": "节点 ID。" - }, - "index": { - "type": "integer", - "description": "执行序号。" - }, - "predecessor_node_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "（可选）前置节点 ID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "节点使用的前置变量内容。" - }, - "process_data": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "（可选）节点过程数据 (JSON)。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "（可选）输出内容 (JSON)。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "执行状态。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "（可选）错误原因。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "（可选）耗时(秒)。" - }, - "execution_metadata": { - "$ref": "#/components/schemas/NodeExecutionMetadataCn", - "nullable": true, - "description": "元数据" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "开始时间。" - } - } - }, - "NodeExecutionMetadataCn": { - "type": "object", - "description": "节点执行元数据。", - "properties": { - "total_tokens": { - "type": "integer", - "nullable": true, - "description": "（可选）总使用 tokens。" - }, - "total_price": { - "type": "number", - "format": "float", - "nullable": true, - "description": "（可选）总费用 (使用 float 兼容 decimal)。" - }, - "currency": { - "type": "string", - "nullable": true, - "example": "USD", - "description": "（可选）货币。" - } - } - }, - "StreamEventWorkflowFinishedCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "type": "object", - "required": [ - "task_id", - "workflow_run_id", - "data" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid" - }, - "data": { - "$ref": "#/components/schemas/WorkflowFinishedDataCn" - } - } - } - ] - }, - "WorkflowFinishedDataCn": { - "type": "object", - "required": [ - "id", - "workflow_id", - "status", - "created_at", - "finished_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "workflow 执行 ID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "关联 Workflow ID。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "执行状态。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "（可选）输出内容 (JSON)。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "（可选）错误原因。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "（可选）耗时(秒)。" - }, - "total_tokens": { - "type": "integer", - "nullable": true, - "description": "（可选）总使用 tokens。" - }, - "total_steps": { - "type": "integer", - "default": 0, - "description": "总步数，默认 0。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "开始时间。" - }, - "finished_at": { - "type": "integer", - "format": "int64", - "description": "结束时间。" - } - } - }, - "StreamEventErrorCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "type": "object", - "required": [ - "task_id", - "status", - "code", - "message" - ], - "properties": { - "task_id": { - "type": "string", - "format": "uuid" - }, - "message_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "消息唯一 ID（错误事件中可能不存在）。" - }, - "status": { - "type": "integer", - "description": "HTTP 状态码。" - }, - "code": { - "type": "string", - "description": "错误码。" - }, - "message": { - "type": "string", - "description": "错误消息。" - } - } - } - ] - }, - "StreamEventPingCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkChatEventCn" - }, - { - "type": "object", - "description": "每 10s 一次的 ping 事件，保持连接存活。" - } - ] - }, - "UsageCn": { - "type": "object", - "description": "模型用量信息。", - "properties": { - "prompt_tokens": { - "type": "integer" - }, - "prompt_unit_price": { - "type": "string" - }, - "prompt_price_unit": { - "type": "string" - }, - "prompt_price": { - "type": "string" - }, - "completion_tokens": { - "type": "integer" - }, - "completion_unit_price": { - "type": "string" - }, - "completion_price_unit": { - "type": "string" - }, - "completion_price": { - "type": "string" - }, - "total_tokens": { - "type": "integer" - }, - "total_price": { - "type": "string" - }, - "currency": { - "type": "string" - }, - "latency": { - "type": "number", - "format": "double" - } - } - }, - "RetrieverResourceCn": { - "type": "object", - "description": "引用和归属分段信息。", - "properties": { - "position": { - "type": "integer" - }, - "dataset_id": { - "type": "string", - "format": "uuid" - }, - "dataset_name": { - "type": "string" - }, - "document_id": { - "type": "string", - "format": "uuid" - }, - "document_name": { - "type": "string" - }, - "segment_id": { - "type": "string", - "format": "uuid" - }, - "score": { - "type": "number", - "format": "float" - }, - "content": { - "type": "string" - } - } - }, - "FileUploadResponseCn": { - "type": "object", - "description": "文件上传成功后的响应。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "name": { - "type": "string", - "description": "文件名。" - }, - "size": { - "type": "integer", - "description": "文件大小 (byte)。" - }, - "extension": { - "type": "string", - "description": "文件后缀。" - }, - "mime_type": { - "type": "string", - "description": "文件 mime-type。" - }, - "created_by": { - "type": "string", - "format": "uuid", - "description": "上传人 ID (应为 uuid，示例中为 int，已修正)。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "上传时间。" - } - } - }, - "EndUserDetailCn": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "tenant_id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "type": { - "type": "string", - "example": "service_api" - }, - "external_user_id": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "is_anonymous": { - "type": "boolean" - }, - "session_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "MessageFeedbackRequestCn": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true, - "description": "点赞 'like', 点踩 'dislike', 撤销点赞 null。" - }, - "user": { - "type": "string", - "description": "用户标识。" - }, - "content": { - "type": "string", - "nullable": true, - "description": "消息反馈的具体信息。" - } - } - }, - "AppFeedbacksResponseCn": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeedbackItemCn" - }, - "description": "返回该APP的点赞、反馈列表。" - } - } - }, - "FeedbackItemCn": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid" - }, - "conversation_id": { - "type": "string", - "format": "uuid" - }, - "message_id": { - "type": "string", - "format": "uuid" - }, - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true - }, - "content": { - "type": "string" - }, - "from_source": { - "type": "string" - }, - "from_end_user_id": { - "type": "string", - "format": "uuid" - }, - "from_account_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "SuggestedQuestionsResponseCn": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - }, - "data": { - "type": "array", - "items": { - "type": "string" - }, - "description": "建议问题列表。" - } - } - }, - "ConversationHistoryResponseCn": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "返回条数。" - }, - "has_more": { - "type": "boolean", - "description": "是否存在下一页。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationMessageItemCn" - }, - "description": "消息列表。" - } - } - }, - "ConversationMessageItemCn": { - "type": "object", - "description": "会话中的单条消息。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "消息 ID。" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "description": "会话 ID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "用户输入参数。" - }, - "query": { - "type": "string", - "description": "用户输入/提问内容。" - }, - "answer": { - "type": "string", - "description": "回答消息内容。" - }, - "message_files": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MessageFileItemCn" - }, - "description": "消息文件列表。" - }, - "feedback": { - "type": "object", - "nullable": true, - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike" - ], - "description": "点赞 'like' / 点踩 'dislike'。" - } - }, - "description": "反馈信息。" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResourceCn" - }, - "description": "引用和归属分段列表。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间。" - } - } - }, - "MessageFileItemCn": { - "type": "object", - "description": "消息中的文件项。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "type": { - "type": "string", - "description": "文件类型，例如 'image'。" - }, - "url": { - "type": "string", - "format": "url", - "description": "预览图片地址。" - }, - "belongs_to": { - "type": "string", - "enum": [ - "user", - "assistant" - ], - "description": "文件归属方。" - } - } - }, - "ConversationsListResponseCn": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "返回条数。" - }, - "has_more": { - "type": "boolean" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationListItemCn" - }, - "description": "会话列表。" - } - } - }, - "ConversationListItemCn": { - "type": "object", - "description": "会话列表中的单项。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "会话 ID。" - }, - "name": { - "type": "string", - "description": "会话名称。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "用户输入参数。" - }, - "status": { - "type": "string", - "description": "会话状态。" - }, - "introduction": { - "type": "string", - "nullable": true, - "description": "开场白。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间。" - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "更新时间。" - } - } - }, - "ConversationRenameRequestCn": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "name": { - "type": "string", - "nullable": true, - "description": "（选填）名称，若 auto_generate 为 true 时可不传。" - }, - "auto_generate": { - "type": "boolean", - "default": false, - "description": "（选填）自动生成标题，默认 false。" - }, - "user": { - "type": "string", - "description": "用户标识。" - } - } - }, - "ConversationRenameResponseCn": { - "$ref": "#/components/schemas/ConversationListItemCn" - }, - "ConversationVariablesResponseCn": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "每页项目数。" - }, - "has_more": { - "type": "boolean", - "description": "是否有更多项目。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ConversationVariableItemCn" - }, - "description": "变量列表。" - } - } - }, - "ConversationVariableItemCn": { - "type": "object", - "description": "对话中的变量项。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "变量ID。" - }, - "name": { - "type": "string", - "description": "变量名称。" - }, - "value_type": { - "type": "string", - "description": "变量类型 (string, number, boolean 等)。" - }, - "value": { - "type": "string", - "description": "变量值。" - }, - "description": { - "type": "string", - "nullable": true, - "description": "变量描述。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间戳。" - }, - "updated_at": { - "type": "integer", - "format": "int64", - "description": "最后更新时间戳。" - } - } - }, - "AudioToTextRequestCn": { - "type": "object", - "required": [ - "file", - "user" - ], - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "语音文件。支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']。大小限制：15MB。" - }, - "user": { - "type": "string", - "description": "用户标识。" - } - } - }, - "AudioToTextResponseCn": { - "type": "object", - "properties": { - "text": { - "type": "string", - "description": "输出文字。" - } - } - }, - "TextToAudioJsonRequestCn": { - "type": "object", - "required": [ - "user" - ], - "properties": { - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息ID (优先)。" - }, - "text": { - "type": "string", - "description": "语音生成内容。" - }, - "user": { - "type": "string", - "description": "用户标识。" - } - }, - "description": "需要 `user`。提供 `message_id` 或 `text`。" - }, - "AppInfoResponseCn": { - "type": "object", - "description": "应用基本信息。", - "properties": { - "name": { - "type": "string", - "description": "应用名称。" - }, - "description": { - "type": "string", - "description": "应用描述。" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "应用标签。" - } - } - }, - "ChatAppParametersResponseCn": { - "type": "object", - "description": "应用参数信息。", - "properties": { - "opening_statement": { - "type": "string", - "description": "开场白。" - }, - "suggested_questions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "开场推荐问题列表。" - }, - "suggested_questions_after_answer": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - } - }, - "description": "启用回答后给出推荐问题。" - }, - "speech_to_text": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - } - }, - "description": "语音转文本。" - }, - "text_to_speech": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - }, - "voice": { - "type": "string", - "description": "语音类型。" - }, - "language": { - "type": "string", - "description": "语言。" - }, - "autoPlay": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ], - "description": "自动播放：enabled 开启, disabled 关闭。" - } - }, - "description": "文本转语音。" - }, - "retriever_resource": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - } - }, - "description": "引用和归属。" - }, - "annotation_reply": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - } - }, - "description": "标记回复。" - }, - "user_input_form": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserInputFormItemCn" - }, - "description": "用户输入表单配置。" - }, - "file_upload": { - "type": "object", - "properties": { - "image": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "number_limits": { - "type": "integer" - }, - "transfer_methods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ] - } - } - }, - "description": "图片设置。支持 png, jpg, jpeg, webp, gif。" - } - }, - "description": "文件上传配置。" - }, - "system_parameters": { - "type": "object", - "properties": { - "file_size_limit": { - "type": "integer", - "description": "文档上传大小限制 (MB)。" - }, - "image_file_size_limit": { - "type": "integer", - "description": "图片文件上传大小限制 (MB)。" - }, - "audio_file_size_limit": { - "type": "integer", - "description": "音频文件上传大小限制 (MB)。" - }, - "video_file_size_limit": { - "type": "integer", - "description": "视频文件上传大小限制 (MB)。" - } - }, - "description": "系统参数。" - } - } - }, - "UserInputFormItemCn": { - "type": "object", - "description": "用户输入表单中的控件项。", - "oneOf": [ - { - "$ref": "#/components/schemas/TextInputControlWrapperCn" - }, - { - "$ref": "#/components/schemas/ParagraphControlWrapperCn" - }, - { - "$ref": "#/components/schemas/SelectControlWrapperCn" - } - ] - }, - "TextInputControlWrapperCn": { - "type": "object", - "properties": { - "text-input": { - "$ref": "#/components/schemas/TextInputControlCn" - } - }, - "required": [ - "text-input" - ] - }, - "ParagraphControlWrapperCn": { - "type": "object", - "properties": { - "paragraph": { - "$ref": "#/components/schemas/ParagraphControlCn" - } - }, - "required": [ - "paragraph" - ] - }, - "SelectControlWrapperCn": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/SelectControlCn" - } - }, - "required": [ - "select" - ] - }, - "TextInputControlCn": { - "type": "object", - "description": "文本输入控件。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "默认值。" - } - } - }, - "ParagraphControlCn": { - "type": "object", - "description": "段落文本输入控件。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "默认值。" - } - } - }, - "SelectControlCn": { - "type": "object", - "description": "下拉控件。", - "required": [ - "label", - "variable", - "required", - "options" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "默认值。" - }, - "options": { - "type": "array", - "items": { - "type": "string" - }, - "description": "选项值。" - } - } - }, - "AppMetaResponseCn": { - "type": "object", - "description": "应用 Meta 信息。", - "properties": { - "tool_icons": { - "type": "object", - "additionalProperties": { - "oneOf": [ - { - "type": "string", - "format": "url", - "description": "图标 URL。" - }, - { - "$ref": "#/components/schemas/ToolIconDetailCn" - } - ] - }, - "description": "工具图标，键为工具名称。" - } - } - }, - "ToolIconDetailCn": { - "type": "object", - "description": "工具图标详情。", - "properties": { - "background": { - "type": "string", - "description": "hex 格式的背景色。" - }, - "content": { - "type": "string", - "description": "emoji。" - } - } - }, - "WebAppSettingsResponseCn": { - "type": "object", - "description": "应用 WebApp 设置。", - "properties": { - "title": { - "type": "string", - "description": "WebApp 名称。" - }, - "chat_color_theme": { - "type": "string", - "description": "聊天颜色主题, hex 格式。" - }, - "chat_color_theme_inverted": { - "type": "boolean", - "description": "聊天颜色主题是否反转。" - }, - "icon_type": { - "type": "string", - "enum": [ - "emoji", - "image" - ], - "description": "图标类型。" - }, - "icon": { - "type": "string", - "description": "图标内容 (emoji 或图片 URL)。" - }, - "icon_background": { - "type": "string", - "description": "hex 格式的背景色。" - }, - "icon_url": { - "type": "string", - "format": "url", - "nullable": true, - "description": "图标 URL。" - }, - "description": { - "type": "string", - "description": "描述。" - }, - "copyright": { - "type": "string", - "description": "版权信息。" - }, - "privacy_policy": { - "type": "string", - "description": "隐私政策链接。" - }, - "custom_disclaimer": { - "type": "string", - "description": "自定义免责声明。" - }, - "default_language": { - "type": "string", - "description": "默认语言。" - }, - "show_workflow_steps": { - "type": "boolean", - "description": "是否显示工作流详情。" - }, - "use_icon_as_answer_icon": { - "type": "boolean", - "description": "是否使用 WebApp 图标替换聊天中的机器人图标。" - } - } - }, - "AnnotationListResponseCn": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AnnotationItemCn" - } - }, - "has_more": { - "type": "boolean" - }, - "limit": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "page": { - "type": "integer" - } - } - }, - "AnnotationItemCn": { - "type": "object", - "description": "标注项。", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "question": { - "type": "string", - "description": "问题。" - }, - "answer": { - "type": "string", - "description": "答案内容。" - }, - "hit_count": { - "type": "integer", - "description": "命中次数。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间。" - } - } - }, - "CreateAnnotationRequestCn": { - "type": "object", - "required": [ - "question", - "answer" - ], - "properties": { - "question": { - "type": "string", - "description": "问题。" - }, - "answer": { - "type": "string", - "description": "答案内容。" - } - } - }, - "UpdateAnnotationRequestCn": { - "type": "object", - "required": [ - "question", - "answer" - ], - "properties": { - "question": { - "type": "string", - "description": "问题。" - }, - "answer": { - "type": "string", - "description": "答案内容。" - } - } - }, - "InitialAnnotationReplySettingsRequestCn": { - "type": "object", - "required": [ - "score_threshold" - ], - "properties": { - "embedding_provider_name": { - "type": "string", - "nullable": true, - "description": "指定的嵌入模型提供商名称。" - }, - "embedding_model_name": { - "type": "string", - "nullable": true, - "description": "指定的嵌入模型名称。" - }, - "score_threshold": { - "type": "number", - "format": "float", - "description": "相似度阈值。" - } - } - }, - "InitialAnnotationReplySettingsResponseCn": { - "type": "object", - "properties": { - "job_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID。" - }, - "job_status": { - "type": "string", - "description": "任务状态。" - } - } - }, - "InitialAnnotationReplySettingsStatusResponseCn": { - "type": "object", - "properties": { - "job_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID。" - }, - "job_status": { - "type": "string", - "description": "任务状态。" - }, - "error_msg": { - "type": "string", - "nullable": true, - "description": "错误信息。" - } - } - }, - "ErrorResponseCn": { - "type": "object", - "description": "错误响应。", - "properties": { - "status": { - "type": "integer", - "nullable": true, - "description": "HTTP 状态码。" - }, - "code": { - "type": "string", - "nullable": true, - "description": "错误码。" - }, - "message": { - "type": "string", - "description": "错误消息。" - } - } - } + "id": { "type": "string", "format": "uuid" }, + "tenant_id": { "type": "string", "format": "uuid" }, + "app_id": { "type": "string", "format": "uuid", "nullable": true }, + "type": { "type": "string", "example": "service_api" }, + "external_user_id": { "type": "string", "nullable": true }, + "name": { "type": "string", "nullable": true }, + "is_anonymous": { "type": "boolean" }, + "session_id": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } + } + }, + "MessageFeedbackRequestCn": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "点赞 'like', 点踩 'dislike', 撤销点赞 null。" }, "user": { "type": "string", "description": "用户标识。" }, "content": { "type": "string", "nullable": true, "description": "消息反馈的具体信息。" } } }, + "AppFeedbacksResponseCn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemCn" }, "description": "返回该APP的点赞、反馈列表。" } } }, + "FeedbackItemCn": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, + "SuggestedQuestionsResponseCn": { "type": "object", "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "type": "string" }, "description": "建议问题列表。" } } }, + "ConversationHistoryResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返回条数。" }, "has_more": { "type": "boolean", "description": "是否存在下一页。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMessageItemCn" }, "description": "消息列表。" } } }, + "ConversationMessageItemCn": { "type": "object", "description": "会话中的单条消息。", "properties": { "id": { "type": "string", "format": "uuid", "description": "消息 ID。" }, "conversation_id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "用户输入参数。" }, "query": { "type": "string", "description": "用户输入/提问内容。" }, "answer": { "type": "string", "description": "回答消息内容。" }, "message_files": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFileItemCn" }, "description": "消息文件列表。" }, "feedback": { "type": "object", "nullable": true, "properties": { "rating": { "type": "string", "enum": ["like", "dislike"], "description": "点赞 'like' / 点踩 'dislike'。" } }, "description": "反馈信息。" }, "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResourceCn" }, "description": "引用和归属分段列表。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" } } }, + "MessageFileItemCn": { "type": "object", "description": "消息中的文件项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "type": { "type": "string", "description": "文件类型，例如 'image'。" }, "url": { "type": "string", "format": "url", "description": "预览图片地址。" }, "belongs_to": { "type": "string", "enum": ["user", "assistant"], "description": "文件归属方。" } } }, + "ConversationsListResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "返回条数。" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationListItemCn" }, "description": "会话列表。" } } }, + "ConversationListItemCn": { "type": "object", "description": "会话列表中的单项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "会话 ID。" }, "name": { "type": "string", "description": "会话名称。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "用户输入参数。" }, "status": { "type": "string", "description": "会话状态。" }, "introduction": { "type": "string", "nullable": true, "description": "开场白。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" }, "updated_at": { "type": "integer", "format": "int64", "description": "更新时间。" } } }, + "ConversationRenameRequestCn": { "type": "object", "required": ["user"], "properties": { "name": { "type": "string", "nullable": true, "description": "（选填）名称，若 auto_generate 为 true 时可不传。" }, "auto_generate": { "type": "boolean", "default": false, "description": "（选填）自动生成标题，默认 false。" }, "user": { "type": "string", "description": "用户标识。" } } }, + "ConversationRenameResponseCn": { "$ref": "#/components/schemas/ConversationListItemCn" }, + "ConversationVariablesResponseCn": { "type": "object", "properties": { "limit": { "type": "integer", "description": "每页项目数。" }, "has_more": { "type": "boolean", "description": "是否有更多项目。" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationVariableItemCn" }, "description": "变量列表。" } } }, + "ConversationVariableItemCn": { "type": "object", "description": "对话中的变量项。", "properties": { "id": { "type": "string", "format": "uuid", "description": "变量ID。" }, "name": { "type": "string", "description": "变量名称。" }, "value_type": { "type": "string", "description": "变量类型 (string, number, boolean 等)。" }, "value": { "type": "string", "description": "变量值。" }, "description": { "type": "string", "nullable": true, "description": "变量描述。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" }, "updated_at": { "type": "integer", "format": "int64", "description": "最后更新时间戳。" } } }, + "AudioToTextRequestCn": { "type": "object", "required": ["file", "user"], "properties": { "file": { "type": "string", "format": "binary", "description": "语音文件。支持格式：['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']。大小限制：15MB。" }, "user": { "type": "string", "description": "用户标识。" } } }, + "AudioToTextResponseCn": { "type": "object", "properties": { "text": { "type": "string", "description": "输出文字。" } } }, + "TextToAudioJsonRequestCn": { "type": "object", "required": ["user"], "properties": { "message_id": { "type": "string", "format": "uuid", "description": "消息ID (优先)。" }, "text": { "type": "string", "description": "语音生成内容。" }, "user": { "type": "string", "description": "用户标识。" } }, "description": "需要 `user`。提供 `message_id` 或 `text`。" }, + "AppInfoResponseCn": { "type": "object", "description": "应用基本信息。", "properties": { "name": { "type": "string", "description": "应用名称。" }, "description": { "type": "string", "description": "应用描述。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "应用标签。" } } }, + "ChatAppParametersResponseCn": { "type": "object", "description": "应用参数信息。", "properties": { "opening_statement": { "type": "string", "description": "开场白。" }, "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "开场推荐问题列表。" }, "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "启用回答后给出推荐问题。" }, "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "语音转文本。" }, "text_to_speech": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" }, "voice": { "type": "string", "description": "语音类型。" }, "language": { "type": "string", "description": "语言。" }, "autoPlay": { "type": "string", "enum": ["enabled", "disabled"], "description": "自动播放：enabled 开启, disabled 关闭。" } }, "description": "文本转语音。" }, "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "引用和归属。" }, "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" } }, "description": "标记回复。" }, "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemCn" }, "description": "用户输入表单配置。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "图片设置。支持 png, jpg, jpeg, webp, gif。" } }, "description": "文件上传配置。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "文档上传大小限制 (MB)。" }, "image_file_size_limit": { "type": "integer", "description": "图片文件上传大小限制 (MB)。" }, "audio_file_size_limit": { "type": "integer", "description": "音频文件上传大小限制 (MB)。" }, "video_file_size_limit": { "type": "integer", "description": "视频文件上传大小限制 (MB)。" } }, "description": "系统参数。" } } }, + "UserInputFormItemCn": { "type": "object", "description": "用户输入表单中的控件项。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperCn" }, { "$ref": "#/components/schemas/ParagraphControlWrapperCn" }, { "$ref": "#/components/schemas/SelectControlWrapperCn" } ] }, + "TextInputControlWrapperCn": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlCn" } }, "required":["text-input"] }, + "ParagraphControlWrapperCn": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlCn" } }, "required":["paragraph"] }, + "SelectControlWrapperCn": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlCn" } }, "required":["select"] }, + "TextInputControlCn": { "type": "object", "description": "文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, + "ParagraphControlCn": { "type": "object", "description": "段落文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, + "SelectControlCn": { "type": "object", "description": "下拉控件。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "选项值。" } } }, + "AppMetaResponseCn": { "type": "object", "description": "应用 Meta 信息。", "properties": { "tool_icons": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "format": "url", "description": "图标 URL。" }, { "$ref": "#/components/schemas/ToolIconDetailCn" } ] }, "description": "工具图标，键为工具名称。" } } }, + "ToolIconDetailCn": { "type": "object", "description": "工具图标详情。", "properties": { "background": { "type": "string", "description": "hex 格式的背景色。" }, "content": { "type": "string", "description": "emoji。" } } }, + "WebAppSettingsResponseCn": { "type": "object", "description": "应用 WebApp 设置。", "properties": { "title": { "type": "string", "description": "WebApp 名称。" }, "chat_color_theme": { "type": "string", "description": "聊天颜色主题, hex 格式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "图标类型。" }, "icon": { "type": "string", "description": "图标内容 (emoji 或图片 URL)。" }, "icon_background": { "type": "string", "description": "hex 格式的背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "图标 URL。" }, "description": { "type": "string", "description": "描述。" }, "copyright": { "type": "string", "description": "版权信息。" }, "privacy_policy": { "type": "string", "description": "隐私政策链接。" }, "custom_disclaimer": { "type": "string", "description": "自定义免责声明。" }, "default_language": { "type": "string", "description": "默认语言。" }, "show_workflow_steps": { "type": "boolean", "description": "是否显示工作流详情。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "是否使用 WebApp 图标替换聊天中的机器人图标。" } } }, + "AnnotationListResponseCn": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationItemCn" } }, "has_more": { "type": "boolean" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "page": { "type": "integer" } } }, + "AnnotationItemCn": { "type": "object", "description": "标注项。", "properties": { "id": { "type": "string", "format": "uuid" }, "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" }, "hit_count": { "type": "integer", "description": "命中次数。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" } } }, + "CreateAnnotationRequestCn": { "type": "object", "required": ["question", "answer"], "properties": { "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" } } }, + "UpdateAnnotationRequestCn": { "type": "object", "required": ["question", "answer"], "properties": { "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" } } }, + "InitialAnnotationReplySettingsRequestCn": { "type": "object", "required": ["score_threshold"], "properties": { "embedding_provider_name": { "type": "string", "nullable": true, "description": "指定的嵌入模型提供商名称。" }, "embedding_model_name": { "type": "string", "nullable": true, "description": "指定的嵌入模型名称。" }, "score_threshold": { "type": "number", "format": "float", "description": "相似度阈值。" } } }, + "InitialAnnotationReplySettingsResponseCn": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, "job_status": { "type": "string", "description": "任务状态。" } } }, + "InitialAnnotationReplySettingsStatusResponseCn": { "type": "object", "properties": { "job_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, "job_status": { "type": "string", "description": "任务状态。" }, "error_msg": { "type": "string", "nullable": true, "description": "错误信息。" } } }, + "ErrorResponseCn": { "type": "object", "description": "错误响应。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTP 状态码。" }, "code": { "type": "string", "nullable": true, "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } } }, "tags": [ - { - "name": "对话消息", - "description": "与对话消息和交互相关的操作。" - }, - { - "name": "文件操作", - "description": "文件上传和预览相关的操作。" - }, - { - "name": "终端用户", - "description": "终端用户信息相关的操作。" - }, - { - "name": "消息反馈", - "description": "用户对消息的反馈操作。" - }, - { - "name": "会话管理", - "description": "管理对话会话相关的操作。" - }, - { - "name": "语音与文字转换", - "description": "文本转语音和语音转文本操作。" - }, - { - "name": "应用配置", - "description": "获取应用设置和信息相关的操作。" - }, - { - "name": "标注管理", - "description": "管理用于直接回复的标注数据。" - } + { "name": "对话消息", "description": "与对话消息和交互相关的操作。" }, + { "name": "文件操作", "description": "文件上传和预览相关的操作。" }, + { "name": "终端用户", "description": "终端用户信息相关的操作。" }, + { "name": "消息反馈", "description": "用户对消息的反馈操作。" }, + { "name": "会话管理", "description": "管理对话会话相关的操作。" }, + { "name": "语音与文字转换", "description": "文本转语音和语音转文本操作。" }, + { "name": "应用配置", "description": "获取应用设置和信息相关的操作。" }, + { "name": "标注管理", "description": "管理用于直接回复的标注数据。" } ] -} +} \ No newline at end of file diff --git a/zh/api-reference/openapi_completion.json b/zh/api-reference/openapi_completion.json index 10e41ffd6..27b149097 100644 --- a/zh/api-reference/openapi_completion.json +++ b/zh/api-reference/openapi_completion.json @@ -28,9 +28,7 @@ "summary": "发送消息", "description": "发送请求给文本生成型应用。", "operationId": "createCompletionMessage", - "tags": [ - "文本生成" - ], + "tags": ["文本生成"], "requestBody": { "description": "创建完成消息的请求体。", "required": true, @@ -43,9 +41,7 @@ "streaming_example": { "summary": "流式模式示例", "value": { - "inputs": { - "query": "你好，世界！" - }, + "inputs": {"query": "你好，世界！"}, "response_mode": "streaming", "user": "abc-123" } @@ -63,17 +59,17 @@ "$ref": "#/components/schemas/ChatCompletionResponse" }, "examples": { - "blockingResponse": { - "summary": "阻塞模式响应示例", - "value": { - "id": "0b089b9a-24d9-48cc-94f8-762677276261", - "message_id": "0b089b9a-24d9-48cc-94f8-762677276261", - "mode": "chat", - "answer": "how are you?", - "metadata": {}, - "created_at": 1679586667 + "blockingResponse": { + "summary": "阻塞模式响应示例", + "value": { + "id": "0b089b9a-24d9-48cc-94f8-762677276261", + "message_id": "0b089b9a-24d9-48cc-94f8-762677276261", + "mode": "chat", + "answer": "how are you?", + "metadata": {}, + "created_at": 1679586667 + } } - } } }, "text/event-stream": { @@ -90,18 +86,9 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequestCompletion" - }, - "404": { - "$ref": "#/components/responses/ConversationNotFound" - }, - "500": { - "$ref": "#/components/responses/InternalServerError" - } - }, - "x-mint": { - "href": "/zh/api-reference/completion/create-completion-message" + "400": { "$ref": "#/components/responses/BadRequestCompletion" }, + "404": { "$ref": "#/components/responses/ConversationNotFound" }, + "500": { "$ref": "#/components/responses/InternalServerError" } } } }, @@ -110,9 +97,7 @@ "summary": "上传文件", "description": "上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。支持 png, jpg, jpeg, webp, gif 格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadFile", - "tags": [ - "文件管理" - ], + "tags": ["文件管理"], "requestBody": { "description": "文件上传请求，需使用 `multipart/form-data`。", "required": true, @@ -120,10 +105,7 @@ "multipart/form-data": { "schema": { "type": "object", - "required": [ - "file", - "user" - ], + "required": ["file", "user"], "properties": { "file": { "type": "string", @@ -160,21 +142,10 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequestFile" - }, - "413": { - "$ref": "#/components/responses/FileTooLarge" - }, - "415": { - "$ref": "#/components/responses/UnsupportedFileTypeFile" - }, - "503": { - "$ref": "#/components/responses/S3ErrorFile" - } - }, - "x-mint": { - "href": "/zh/api-reference/files/file-upload" + "400": { "$ref": "#/components/responses/BadRequestFile" }, + "413": { "$ref": "#/components/responses/FileTooLarge" }, + "415": { "$ref": "#/components/responses/UnsupportedFileTypeFile" }, + "503": { "$ref": "#/components/responses/S3ErrorFile" } } } }, @@ -183,19 +154,14 @@ "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", "operationId": "getEndUserCompletionCn", - "tags": [ - "终端用户" - ], + "tags": ["终端用户"], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "终端用户 ID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -203,9 +169,7 @@ "description": "成功获取终端用户信息。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/EndUserDetail" - } + "schema": { "$ref": "#/components/schemas/EndUserDetail" } } } }, @@ -213,9 +177,7 @@ "description": "终端用户不存在。错误码：`end_user_not_found`", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, @@ -223,15 +185,10 @@ "description": "服务内部异常。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } + "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/end-users/get-end-user" } } }, @@ -240,19 +197,14 @@ "summary": "停止响应", "description": "停止生成任务，仅支持流式模式。", "operationId": "stopCompletionGeneration", - "tags": [ - "文本生成" - ], + "tags": ["文本生成"], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "任务 ID，可在流式返回 Chunk 中获取。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { @@ -261,9 +213,7 @@ "application/json": { "schema": { "type": "object", - "required": [ - "user" - ], + "required": ["user"], "properties": { "user": { "type": "string", @@ -275,12 +225,7 @@ } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResult" - } - }, - "x-mint": { - "href": "/zh/api-reference/completion/stop-generate" + "200": { "$ref": "#/components/responses/SuccessResult" } } } }, @@ -289,38 +234,26 @@ "summary": "消息反馈（点赞）", "description": "消息终端用户反馈、点赞，方便应用开发者优化输出预期。", "operationId": "postMessageFeedback", - "tags": [ - "反馈" - ], + "tags": ["反馈"], "parameters": [ { "name": "message_id", "in": "path", "required": true, "description": "消息 ID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/MessageFeedbackRequest" - } + "schema": { "$ref": "#/components/schemas/MessageFeedbackRequest" } } } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResult" - } - }, - "x-mint": { - "href": "/zh/api-reference/feedback/message-feedback" + "200": { "$ref": "#/components/responses/SuccessResult" } } } }, @@ -329,31 +262,20 @@ "summary": "获取应用反馈列表", "description": "获取应用的反馈信息。", "operationId": "getAppFeedbacks", - "tags": [ - "反馈" - ], + "tags": ["反馈"], "parameters": [ - { - "$ref": "#/components/parameters/PageQueryParam" - }, - { - "$ref": "#/components/parameters/LimitQueryParamDefault20" - } + { "$ref": "#/components/parameters/PageQueryParam" }, + { "$ref": "#/components/parameters/LimitQueryParamDefault20" } ], "responses": { "200": { "description": "成功获取应用反馈列表。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFeedbacksResponse" - } + "schema": { "$ref": "#/components/schemas/AppFeedbacksResponse" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/feedback/get-feedbacks-of-application" } } }, @@ -362,16 +284,12 @@ "summary": "文字转语音", "description": "将文本内容转换为语音。", "operationId": "textToAudio", - "tags": [ - "语音服务" - ], + "tags": ["语音服务"], "requestBody": { "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/TextToAudioRequest" - } + "schema": { "$ref": "#/components/schemas/TextToAudioRequest" } } } }, @@ -379,34 +297,13 @@ "200": { "description": "语音文件生成成功。", "content": { - "audio/wav": { - "schema": { - "type": "string", - "format": "binary", - "description": "生成的 WAV 格式音频文件。" - } - }, - "audio/mp3": { - "schema": { - "type": "string", - "format": "binary", - "description": "生成的 MP3 格式音频文件。" - } - } + "audio/wav": { "schema": { "type": "string", "format": "binary", "description": "生成的 WAV 格式音频文件。" } }, + "audio/mp3": { "schema": { "type": "string", "format": "binary", "description": "生成的 MP3 格式音频文件。" } } }, "headers": { - "Content-Type": { - "schema": { - "type": "string", - "example": "audio/wav" - }, - "description": "响应的内容类型，通常为 `audio/wav` 或 `audio/mp3`。" - } + "Content-Type": { "schema": { "type": "string", "example": "audio/wav" }, "description": "响应的内容类型，通常为 `audio/wav` 或 `audio/mp3`。" } } } - }, - "x-mint": { - "href": "/zh/api-reference/tts/text-to-audio" } } }, @@ -415,23 +312,12 @@ "summary": "获取应用基本信息", "description": "用于获取此应用的基本信息。", "operationId": "getAppInfo", - "tags": [ - "应用设置" - ], + "tags": ["应用设置"], "responses": { "200": { "description": "应用的基本信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfoResponse" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponse" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-basic-information" } } }, @@ -440,23 +326,12 @@ "summary": "获取应用参数", "description": "用于进入页面一开始，获取功能开关、输入参数名称、类型及默认值等使用。", "operationId": "getAppParameters", - "tags": [ - "应用设置" - ], + "tags": ["应用设置"], "responses": { "200": { "description": "应用的参数信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppParametersResponseCompletion" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppParametersResponseCompletion" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-parameters-information" } } }, @@ -465,23 +340,12 @@ "summary": "获取应用 WebApp 设置", "description": "用于获取应用的 WebApp 设置。", "operationId": "getWebAppSettings", - "tags": [ - "应用设置" - ], + "tags": ["应用设置"], "responses": { "200": { "description": "应用的 WebApp 设置信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WebAppSettingsResponse" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAppSettingsResponse" } } } } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-webapp-settings" } } }, @@ -490,68 +354,27 @@ "summary": "获取标注列表", "description": "获取应用的标注列表。", "operationId": "getAnnotationList", - "tags": [ - "标注管理" - ], + "tags": ["标注管理"], "parameters": [ - { - "$ref": "#/components/parameters/PageQueryParam" - }, - { - "$ref": "#/components/parameters/LimitQueryParamAnnotation" - } + { "$ref": "#/components/parameters/PageQueryParam" }, + { "$ref": "#/components/parameters/LimitQueryParamAnnotation" } ], "responses": { - "200": { - "description": "成功获取标注列表。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnnotationListResponse" - } - } - } - } + "200": { "description": "成功获取标注列表。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationListResponse" } } } } } }, "post": { "summary": "创建标注", "description": "创建一个新的标注。", "operationId": "createAnnotation", - "tags": [ - "标注管理" - ], + "tags": ["标注管理"], "requestBody": { "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateAnnotationRequest" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnotationRequest" } } } }, "responses": { - "200": { - "description": "标注创建成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnnotationItem" - } - } - } - }, - "201": { - "description": "标注创建成功 (备选)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnnotationItem" - } - } - } - } + "200": { "description": "标注创建成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItem" } } } }, + "201": { "description": "标注创建成功 (备选)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItem" } } } } } } }, @@ -560,54 +383,23 @@ "summary": "更新标注", "description": "更新一个已存在的标注。", "operationId": "updateAnnotation", - "tags": [ - "标注管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/AnnotationIdPathParam" - } - ], + "tags": ["标注管理"], + "parameters": [ { "$ref": "#/components/parameters/AnnotationIdPathParam" } ], "requestBody": { "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAnnotationRequest" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnnotationRequest" } } } }, "responses": { - "200": { - "description": "标注更新成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnnotationItem" - } - } - } - } + "200": { "description": "标注更新成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationItem" } } } } } }, "delete": { "summary": "删除标注", "description": "删除一个标注。", "operationId": "deleteAnnotation", - "tags": [ - "标注管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/AnnotationIdPathParam" - } - ], - "responses": { - "204": { - "description": "标注删除成功，无内容返回。" - } - } + "tags": ["标注管理"], + "parameters": [ { "$ref": "#/components/parameters/AnnotationIdPathParam" } ], + "responses": { "204": { "description": "标注删除成功，无内容返回。" } } } }, "/apps/annotation-reply/{action}": { @@ -615,45 +407,15 @@ "summary": "标注回复初始设置", "description": "启用或禁用标注回复设置，并配置嵌入模型。此接口异步执行。嵌入模型的提供商和模型名称可通过 v1/workspaces/current/models/model-types/text-embedding 接口获取（使用 Dataset API Token 鉴权）。", "operationId": "initialAnnotationReplySettings", - "tags": [ - "标注管理" - ], - "parameters": [ - { - "$ref": "#/components/parameters/AnnotationActionPathParam" - } - ], + "tags": ["标注管理"], + "parameters": [ { "$ref": "#/components/parameters/AnnotationActionPathParam" } ], "requestBody": { "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InitialAnnotationReplySettingsRequest" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitialAnnotationReplySettingsRequest" } } } }, "responses": { - "200": { - "description": "标注回复设置任务已启动。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AsyncJobResponse" - } - } - } - }, - "202": { - "description": "标注回复设置任务已接受。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AsyncJobResponse" - } - } - } - } + "200": { "description": "标注回复设置任务已启动。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncJobResponse" } } } }, + "202": { "description": "标注回复设置任务已接受。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncJobResponse" } } } } } } }, @@ -662,28 +424,13 @@ "summary": "查询标注回复初始设置任务状态", "description": "查询异步执行的标注回复初始设置任务的状态。", "operationId": "getInitialAnnotationReplySettingsStatus", - "tags": [ - "标注管理" - ], + "tags": ["标注管理"], "parameters": [ - { - "$ref": "#/components/parameters/AnnotationActionPathParam" - }, - { - "$ref": "#/components/parameters/JobIdPathParam" - } + { "$ref": "#/components/parameters/AnnotationActionPathParam" }, + { "$ref": "#/components/parameters/JobIdPathParam" } ], "responses": { - "200": { - "description": "成功获取任务状态。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AsyncJobStatusResponse" - } - } - } - } + "200": { "description": "成功获取任务状态。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncJobStatusResponse" } } } } } } } @@ -698,274 +445,71 @@ } }, "parameters": { - "PageQueryParam": { - "name": "page", - "in": "query", - "description": "（可选）分页页码，默认：1。", - "schema": { - "type": "integer", - "default": 1 - } - }, - "LimitQueryParamDefault20": { - "name": "limit", - "in": "query", - "description": "（可选）每页记录数，默认：20。", - "schema": { - "type": "integer", - "default": 20 - } - }, - "LimitQueryParamAnnotation": { - "name": "limit", - "in": "query", - "description": "每页数量，默认 20，范围 1-100。", - "schema": { - "type": "integer", - "default": 20, - "minimum": 1, - "maximum": 100 - } - }, - "AnnotationIdPathParam": { - "name": "annotation_id", - "in": "path", - "required": true, - "description": "标注 ID。", - "schema": { - "type": "string", - "format": "uuid" - } - }, - "AnnotationActionPathParam": { - "name": "action", - "in": "path", - "required": true, - "description": "动作，只能是 'enable' 或 'disable'。", - "schema": { - "type": "string", - "enum": [ - "enable", - "disable" - ] - } - }, - "JobIdPathParam": { - "name": "job_id", - "in": "path", - "required": true, - "description": "任务 ID，从标注回复初始设置接口返回。", - "schema": { - "type": "string", - "format": "uuid" - } - } + "PageQueryParam": { "name": "page", "in": "query", "description": "（可选）分页页码，默认：1。", "schema": { "type": "integer", "default": 1 } }, + "LimitQueryParamDefault20": { "name": "limit", "in": "query", "description": "（可选）每页记录数，默认：20。", "schema": { "type": "integer", "default": 20 } }, + "LimitQueryParamAnnotation": { "name": "limit", "in": "query", "description": "每页数量，默认 20，范围 1-100。", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 100 } }, + "AnnotationIdPathParam": { "name": "annotation_id", "in": "path", "required": true, "description": "标注 ID。", "schema": { "type": "string", "format": "uuid" } }, + "AnnotationActionPathParam": { "name": "action", "in": "path", "required": true, "description": "动作，只能是 'enable' 或 'disable'。", "schema": { "type": "string", "enum": ["enable", "disable"] } }, + "JobIdPathParam": { "name": "job_id", "in": "path", "required": true, "description": "任务 ID，从标注回复初始设置接口返回。", "schema": { "type": "string", "format": "uuid" } } }, "responses": { - "BadRequestCompletion": { - "description": "错误的请求。可能原因：`invalid_param`（参数异常），`app_unavailable`（App 配置不可用），`provider_not_initialize`（无可用模型凭据），`provider_quota_exceeded`（额度不足），`model_currently_not_support`（模型不可用），`completion_request_error`（文本生成失败）。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "BadRequestFile": { - "description": "文件操作相关的错误请求。可能原因：`no_file_uploaded`，`too_many_files`，`unsupported_preview`，`unsupported_estimate`。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "ConversationNotFound": { - "description": "对话不存在。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "FileTooLarge": { - "description": "文件太大 (`file_too_large`)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "UnsupportedFileTypeFile": { - "description": "不支持的文件类型 (`unsupported_file_type`)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "S3ErrorFile": { - "description": "S3 存储服务错误。可能原因：`s3_connection_failed`，`s3_permission_denied`，`s3_file_too_large`。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "InternalServerError": { - "description": "服务内部异常。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "SuccessResult": { - "description": "操作成功。", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - } - } - } - } - } - } + "BadRequestCompletion": { "description": "错误的请求。可能原因：`invalid_param`（参数异常），`app_unavailable`（App 配置不可用），`provider_not_initialize`（无可用模型凭据），`provider_quota_exceeded`（额度不足），`model_currently_not_support`（模型不可用），`completion_request_error`（文本生成失败）。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, + "BadRequestFile": { "description": "文件操作相关的错误请求。可能原因：`no_file_uploaded`，`too_many_files`，`unsupported_preview`，`unsupported_estimate`。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, + "ConversationNotFound": { "description": "对话不存在。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, + "FileTooLarge": { "description": "文件太大 (`file_too_large`)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, + "UnsupportedFileTypeFile": { "description": "不支持的文件类型 (`unsupported_file_type`)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, + "S3ErrorFile": { "description": "S3 存储服务错误。可能原因：`s3_connection_failed`，`s3_permission_denied`，`s3_file_too_large`。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, + "InternalServerError": { "description": "服务内部异常。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, + "SuccessResult": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } } }, "schemas": { "CompletionRequest": { "type": "object", - "required": [ - "inputs", - "response_mode", - "user" - ], + "required": ["inputs", "response_mode", "user"], "properties": { "inputs": { "type": "object", "description": "（选填）允许传入 App 定义的各变量值。inputs 参数包含了多组键值对，每组的键对应一个特定变量，值则是该变量的具体值。文本生成型应用要求至少传入一组键值对。", - "required": [ - "query" - ], + "required": ["query"], "properties": { - "query": { - "type": "string", - "description": "用户输入的文本内容。" - } + "query": { "type": "string", "description": "用户输入的文本内容。" } }, - "additionalProperties": true - }, - "response_mode": { - "type": "string", - "enum": [ - "streaming", - "blocking" - ], - "description": "响应返回模式。`streaming`：流式模式（推荐），基于 SSE 实现打字机输出。`blocking`：阻塞模式，等待执行完毕后返回（长流程可能中断）。Cloudflare 限制为 100 秒超时。" - }, - "user": { - "type": "string", - "description": "用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一。" + "additionalProperties": true }, + "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "description": "响应返回模式。`streaming`：流式模式（推荐），基于 SSE 实现打字机输出。`blocking`：阻塞模式，等待执行完毕后返回（长流程可能中断）。Cloudflare 限制为 100 秒超时。" }, + "user": { "type": "string", "description": "用户标识，用于定义终端用户的身份，方便检索、统计。由开发者定义规则，需保证用户标识在应用内唯一。" }, "files": { "type": "array", - "items": { - "$ref": "#/components/schemas/InputFileObject" - }, + "items": { "$ref": "#/components/schemas/InputFileObject" }, "description": "上传的文件列表（目前仅支持图片）。" } } }, "InputFileObject": { "type": "object", - "required": [ - "type", - "transfer_method" - ], + "required": ["type", "transfer_method"], "properties": { - "type": { - "type": "string", - "enum": [ - "image" - ], - "description": "支持类型：图片 `image`。" - }, - "transfer_method": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ], - "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" - }, - "url": { - "type": "string", - "format": "url", - "description": "图片地址（当传递方式为 remote_url 时）" - }, - "upload_file_id": { - "type": "string", - "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" - } + "type": { "type": "string", "enum": ["image"], "description": "支持类型：图片 `image`。" }, + "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" }, + "url": { "type": "string", "format": "url", "description": "图片地址（当传递方式为 remote_url 时）" }, + "upload_file_id": { "type": "string", "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" } }, "anyOf": [ { - "properties": { - "transfer_method": { - "enum": [ - "remote_url" - ] - }, - "url": { - "type": "string", - "format": "url" - } + "properties": { + "transfer_method": { "enum": ["remote_url"] }, + "url": { "type": "string", "format": "url" } }, - "required": [ - "url" - ], - "not": { - "required": [ - "upload_file_id" - ] - } + "required": ["url"], + "not": { "required": ["upload_file_id"] } }, { - "properties": { - "transfer_method": { - "enum": [ - "local_file" - ] - }, - "upload_file_id": { - "type": "string" - } + "properties": { + "transfer_method": { "enum": ["local_file"] }, + "upload_file_id": { "type": "string" } }, - "required": [ - "upload_file_id" - ], - "not": { - "required": [ - "url" - ] - } + "required": ["upload_file_id"], + "not": { "required": ["url"] } } ] }, @@ -973,66 +517,26 @@ "type": "object", "description": "阻塞模式下的完整 App 结果。", "properties": { - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息唯一 ID。" - }, - "mode": { - "type": "string", - "description": "App 模式，固定为 `chat`。", - "example": "chat" - }, - "answer": { - "type": "string", - "description": "完整回复内容。" - }, - "metadata": { - "$ref": "#/components/schemas/ResponseMetadata" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "消息创建时间戳，如：1705395332。" - } + "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, + "mode": { "type": "string", "description": "App 模式，固定为 `chat`。", "example": "chat" }, + "answer": { "type": "string", "description": "完整回复内容。" }, + "metadata": { "$ref": "#/components/schemas/ResponseMetadata" }, + "created_at": { "type": "integer", "format": "int64", "description": "消息创建时间戳，如：1705395332。" } } }, "ResponseMetadata": { - "type": "object", - "description": "元数据。", + "type": "object", "description": "元数据。", "properties": { - "usage": { - "$ref": "#/components/schemas/Usage" - }, - "retriever_resources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RetrieverResource" - }, - "description": "引用和归属分段列表。" - } + "usage": { "$ref": "#/components/schemas/Usage" }, + "retriever_resources": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieverResource" }, "description": "引用和归属分段列表。" } } }, "ChunkEvent": { "type": "object", "description": "流式响应中的事件块结构。", - "required": [ - "event" - ], + "required": ["event"], "properties": { - "event": { - "type": "string", - "enum": [ - "message", - "message_end", - "tts_message", - "tts_message_end", - "message_replace", - "error", - "ping" - ], - "description": "事件类型。" - } + "event": { "type": "string", "enum": ["message", "message_end", "tts_message", "tts_message_end", "message_replace", "error", "ping"], "description": "事件类型。" } }, "discriminator": { "propertyName": "event", @@ -1048,1020 +552,168 @@ } }, "StreamEventBase": { - "type": "object", - "properties": { - "task_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID，用于请求跟踪和停止响应接口。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息唯一 ID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间戳，如：1705395332。" + "type": "object", + "properties": { + "task_id": { "type": "string", "format": "uuid", "description": "任务 ID，用于请求跟踪和停止响应接口。" }, + "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, + "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳，如：1705395332。" } } - } }, "StreamEventMessage": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkEvent" - }, - { - "$ref": "#/components/schemas/StreamEventBase" - }, - { - "type": "object", - "description": "LLM 返回文本块事件。", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "LLM 返回文本块内容。" - } - } - } + "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, + { "type": "object", "description": "LLM 返回文本块事件。", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "LLM 返回文本块内容。" } } } ] }, "StreamEventMessageEnd": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkEvent" - }, - { - "$ref": "#/components/schemas/StreamEventBase" - }, - { - "type": "object", - "description": "消息结束事件。", - "required": [ - "metadata" - ], - "properties": { - "metadata": { - "$ref": "#/components/schemas/ResponseMetadata" - } - } - } + "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, + { "type": "object", "description": "消息结束事件。", "required": ["metadata"], "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadata" } } } ] }, "StreamEventTtsMessage": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkEvent" - }, - { - "$ref": "#/components/schemas/StreamEventBase" - }, - { - "type": "object", - "description": "TTS 音频流事件 (Mp3格式, Base64编码)。开启自动播放时可用。", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "format": "byte", - "description": "Base64 编码的音频块。" - } - } - } + "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, + { "type": "object", "description": "TTS 音频流事件 (Mp3格式, Base64编码)。开启自动播放时可用。", "required": ["audio"], "properties": { "audio": { "type": "string", "format": "byte", "description": "Base64 编码的音频块。" } } } ] }, "StreamEventTtsMessageEnd": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkEvent" - }, - { - "$ref": "#/components/schemas/StreamEventBase" - }, - { - "type": "object", - "description": "TTS 音频流结束事件。", - "required": [ - "audio" - ], - "properties": { - "audio": { - "type": "string", - "description": "空字符串。" - } - } - } + "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, + { "type": "object", "description": "TTS 音频流结束事件。", "required": ["audio"], "properties": { "audio": { "type": "string", "description": "空字符串。" } } } ] }, "StreamEventMessageReplace": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkEvent" - }, - { - "$ref": "#/components/schemas/StreamEventBase" - }, - { - "type": "object", - "description": "消息内容替换事件（内容审查触发）。", - "required": [ - "answer" - ], - "properties": { - "answer": { - "type": "string", - "description": "替换内容（直接替换所有 LLM 回复）。" - } - } - } + "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, + { "type": "object", "description": "消息内容替换事件（内容审查触发）。", "required": ["answer"], "properties": { "answer": { "type": "string", "description": "替换内容（直接替换所有 LLM 回复）。" } } } ] }, "StreamEventError": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkEvent" - }, - { - "$ref": "#/components/schemas/StreamEventBase" - }, - { - "type": "object", - "description": "流式输出过程中的异常事件。", - "required": [ - "status", - "code", - "message" - ], - "properties": { - "status": { - "type": "integer", - "description": "HTTP 状态码。" - }, - "code": { - "type": "string", - "description": "错误码。" - }, - "message": { - "type": "string", - "description": "错误消息。" - } - } + "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "$ref": "#/components/schemas/StreamEventBase" }, + { "type": "object", "description": "流式输出过程中的异常事件。", "required": ["status", "code", "message"], + "properties": { "status": { "type": "integer", "description": "HTTP 状态码。" }, "code": { "type": "string", "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } ] }, "StreamEventPing": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkEvent" - }, - { - "type": "object", - "description": "每 10s 一次的 ping 事件，保持连接存活。" - } - ] + "allOf": [ { "$ref": "#/components/schemas/ChunkEvent" }, { "type": "object", "description": "每 10s 一次的 ping 事件，保持连接存活。" } ] }, "Usage": { - "type": "object", - "description": "模型用量信息。", - "properties": { - "prompt_tokens": { - "type": "integer" - }, - "prompt_unit_price": { - "type": "string" - }, - "prompt_price_unit": { - "type": "string" - }, - "prompt_price": { - "type": "string" - }, - "completion_tokens": { - "type": "integer" - }, - "completion_unit_price": { - "type": "string" - }, - "completion_price_unit": { - "type": "string" - }, - "completion_price": { - "type": "string" - }, - "total_tokens": { - "type": "integer" - }, - "total_price": { - "type": "string" - }, - "currency": { - "type": "string" - }, - "latency": { - "type": "number", - "format": "double" - } - } + "type": "object", "description": "模型用量信息。", + "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } }, "RetrieverResource": { - "type": "object", - "description": "引用和归属分段信息。", - "properties": { - "position": { - "type": "integer" - }, - "dataset_id": { - "type": "string", - "format": "uuid" - }, - "dataset_name": { - "type": "string" - }, - "document_id": { - "type": "string", - "format": "uuid" - }, - "document_name": { - "type": "string" - }, - "segment_id": { - "type": "string", - "format": "uuid" - }, - "score": { - "type": "number", - "format": "float" - }, - "content": { - "type": "string" - } - } + "type": "object", "description": "引用和归属分段信息。", + "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } }, "FileUploadResponse": { - "type": "object", - "description": "文件上传成功后的响应。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "name": { - "type": "string", - "description": "文件名。" - }, - "size": { - "type": "integer", - "description": "文件大小（byte）。" - }, - "extension": { - "type": "string", - "description": "文件后缀。" - }, - "mime_type": { - "type": "string", - "description": "文件 mime-type。" - }, - "created_by": { - "type": "string", - "format": "uuid", - "description": "上传人 ID (示例中为integer，规范为uuid)。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "上传时间。" - } - } + "type": "object", "description": "文件上传成功后的响应。", + "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "文件名。" }, "size": { "type": "integer", "description": "文件大小（byte）。" }, "extension": { "type": "string", "description": "文件后缀。" }, "mime_type": { "type": "string", "description": "文件 mime-type。" }, "created_by": { "type": "string", "format": "uuid", "description": "上传人 ID (示例中为integer，规范为uuid)。" }, "created_at": { "type": "integer", "format": "int64", "description": "上传时间。" } } }, "EndUserDetail": { "type": "object", "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "tenant_id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "type": { - "type": "string", - "example": "service_api" - }, - "external_user_id": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "is_anonymous": { - "type": "boolean" - }, - "session_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "id": { "type": "string", "format": "uuid" }, + "tenant_id": { "type": "string", "format": "uuid" }, + "app_id": { "type": "string", "format": "uuid", "nullable": true }, + "type": { "type": "string", "example": "service_api" }, + "external_user_id": { "type": "string", "nullable": true }, + "name": { "type": "string", "nullable": true }, + "is_anonymous": { "type": "boolean" }, + "session_id": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } } }, "MessageFeedbackRequest": { - "type": "object", - "required": [ - "user" - ], - "description": "消息反馈请求体。", - "properties": { - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true, - "description": "点赞 `like`, 点踩 `dislike`, 撤销 `null`。" - }, - "user": { - "type": "string", - "description": "用户标识，应用内唯一。" - }, - "content": { - "type": "string", - "nullable": true, - "description": "消息反馈的具体信息。" - } - } + "type": "object", "required": ["user"], "description": "消息反馈请求体。", + "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "点赞 `like`, 点踩 `dislike`, 撤销 `null`。" }, "user": { "type": "string", "description": "用户标识，应用内唯一。" }, "content": { "type": "string", "nullable": true, "description": "消息反馈的具体信息。" } } }, "AppFeedbacksResponse": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FeedbackItem" - }, - "description": "应用反馈列表。" - } - } + "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItem" }, "description": "应用反馈列表。" } } }, "FeedbackItem": { - "type": "object", - "description": "单个反馈条目。", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid" - }, - "conversation_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "message_id": { - "type": "string", - "format": "uuid" - }, - "rating": { - "type": "string", - "enum": [ - "like", - "dislike", - null - ], - "nullable": true - }, - "content": { - "type": "string", - "nullable": true - }, - "from_source": { - "type": "string" - }, - "from_end_user_id": { - "type": "string", - "format": "uuid" - }, - "from_account_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } + "type": "object", "description": "单个反馈条目。", + "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid", "nullable": true }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string", "nullable": true }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "TextToAudioRequest": { - "type": "object", - "required": [ - "user" - ], - "description": "文字转语音请求体。", - "properties": { - "message_id": { - "type": "string", - "format": "uuid", - "description": "Dify 生成的消息 ID（优先使用）。" - }, - "text": { - "type": "string", - "description": "语音生成内容（若无 message_id）。" - }, - "user": { - "type": "string", - "description": "用户标识，应用内唯一。" - }, - "streaming": { - "type": "boolean", - "default": false, - "description": "是否流式返回音频。" - } - }, - "example": { - "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", - "text": "你好Dify", - "user": "abc-123", - "streaming": false - } + "type": "object", "required": ["user"], "description": "文字转语音请求体。", + "properties": { "message_id": { "type": "string", "format": "uuid", "description": "Dify 生成的消息 ID（优先使用）。" }, "text": { "type": "string", "description": "语音生成内容（若无 message_id）。" }, "user": { "type": "string", "description": "用户标识，应用内唯一。" }, "streaming": {"type": "boolean", "default": false, "description": "是否流式返回音频。"} }, + "example": { "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "text": "你好Dify", "user": "abc-123", "streaming": false } }, "AppInfoResponse": { - "type": "object", - "description": "应用基本信息。", - "properties": { - "name": { - "type": "string", - "description": "应用名称。" - }, - "description": { - "type": "string", - "description": "应用描述。" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "应用标签。" - } - } + "type": "object", "description": "应用基本信息。", + "properties": { "name": { "type": "string", "description": "应用名称。" }, "description": { "type": "string", "description": "应用描述。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "应用标签。" } } }, "AppParametersResponseCompletion": { - "type": "object", - "description": "应用参数信息。", - "properties": { - "opening_statement": { - "type": "string", - "description": "开场白。", - "example": "nice to meet you" - }, - "suggested_questions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "开场推荐问题列表。" - }, - "suggested_questions_after_answer": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启回答后推荐问题。" - } - } - }, - "speech_to_text": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启语音转文本。" - } - } - }, - "retriever_resource": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启引用和归属。" - } - } - }, - "annotation_reply": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启标记回复。" - } - } - }, - "user_input_form": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserInputFormItem" - }, - "description": "用户输入表单配置。" - }, - "file_upload": { - "$ref": "#/components/schemas/FileUploadSetting" - }, - "system_parameters": { - "$ref": "#/components/schemas/SystemParameters" - } - } - }, - "UserInputFormItem": { - "type": "object", - "description": "用户输入表单中的一个控件。", - "oneOf": [ - { - "$ref": "#/components/schemas/TextInputControlWrapper" - }, - { - "$ref": "#/components/schemas/ParagraphControlWrapper" - }, - { - "$ref": "#/components/schemas/SelectControlWrapper" - } - ] - }, - "TextInputControlWrapper": { - "type": "object", - "properties": { - "text-input": { - "$ref": "#/components/schemas/TextInputControl" - } - }, - "required": [ - "text-input" - ] - }, - "ParagraphControlWrapper": { - "type": "object", - "properties": { - "paragraph": { - "$ref": "#/components/schemas/ParagraphControl" - } - }, - "required": [ - "paragraph" - ] - }, - "SelectControlWrapper": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/SelectControl" - } - }, - "required": [ - "select" - ] - }, - "TextInputControl": { - "type": "object", - "description": "文本输入控件。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "description": "默认值。" - }, - "max_length": { - "type": "integer", - "description": "最大长度 (来自示例)。", - "nullable": true - } - } - }, - "ParagraphControl": { - "type": "object", - "description": "段落文本输入控件。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "description": "默认值。" - } - } - }, - "SelectControl": { - "type": "object", - "description": "下拉控件。", - "required": [ - "label", - "variable", - "required", - "options" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "description": "默认值。" - }, - "options": { - "type": "array", - "items": { - "type": "string" - }, - "description": "选项值。" - } - } - }, + "type": "object", "description": "应用参数信息。", + "properties": { + "opening_statement": { "type": "string", "description": "开场白。", "example": "nice to meet you" }, + "suggested_questions": { "type": "array", "items": { "type": "string" }, "description": "开场推荐问题列表。" }, + "suggested_questions_after_answer": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启回答后推荐问题。" } } }, + "speech_to_text": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启语音转文本。" } } }, + "retriever_resource": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启引用和归属。" } } }, + "annotation_reply": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "是否开启标记回复。" } } }, + "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItem" }, "description": "用户输入表单配置。" }, + "file_upload": { "$ref": "#/components/schemas/FileUploadSetting" }, + "system_parameters": { "$ref": "#/components/schemas/SystemParameters" } + } + }, + "UserInputFormItem": { "type": "object", "description": "用户输入表单中的一个控件。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapper" }, { "$ref": "#/components/schemas/ParagraphControlWrapper" }, { "$ref": "#/components/schemas/SelectControlWrapper" } ] }, + "TextInputControlWrapper": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControl" } }, "required":["text-input"] }, + "ParagraphControlWrapper": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControl" } }, "required":["paragraph"] }, + "SelectControlWrapper": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControl" } }, "required":["select"] }, + "TextInputControl": { "type": "object", "description": "文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "description": "默认值。" }, "max_length": {"type": "integer", "description": "最大长度 (来自示例)。", "nullable": true} } }, + "ParagraphControl": { "type": "object", "description": "段落文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "description": "默认值。" } } }, + "SelectControl": { "type": "object", "description": "下拉控件。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "description": "默认值。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "选项值。" } } }, "FileUploadSetting": { - "type": "object", - "description": "文件上传配置。", - "properties": { - "image": { - "type": "object", - "description": "图片设置。当前仅支持图片类型：`png`, `jpg`, `jpeg`, `webp`, `gif`。", - "properties": { - "enabled": { - "type": "boolean", - "description": "是否开启。" - }, - "number_limits": { - "type": "integer", - "description": "图片数量限制，默认 3。" - }, - "detail": { - "type": "string", - "description": "图片细节 (来自示例)。", - "nullable": true - }, - "transfer_methods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ] - }, - "description": "传递方式列表，remote_url , local_file，必选一个。" - } - } - } - } + "type": "object", "description": "文件上传配置。", + "properties": { "image": { "type": "object", "description": "图片设置。当前仅支持图片类型：`png`, `jpg`, `jpeg`, `webp`, `gif`。", "properties": { "enabled": { "type": "boolean", "description": "是否开启。" }, "number_limits": { "type": "integer", "description": "图片数量限制，默认 3。" }, "detail": {"type": "string", "description": "图片细节 (来自示例)。", "nullable": true}, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] }, "description": "传递方式列表，remote_url , local_file，必选一个。" } } } } }, "SystemParameters": { - "type": "object", - "description": "系统参数。", - "properties": { - "file_size_limit": { - "type": "integer", - "description": "文档上传大小限制 (MB)。" - }, - "image_file_size_limit": { - "type": "integer", - "description": "图片文件上传大小限制（MB）。" - }, - "audio_file_size_limit": { - "type": "integer", - "description": "音频文件上传大小限制 (MB)。" - }, - "video_file_size_limit": { - "type": "integer", - "description": "视频文件上传大小限制 (MB)。" - } - } + "type": "object", "description": "系统参数。", + "properties": { "file_size_limit": { "type": "integer", "description": "文档上传大小限制 (MB)。" }, "image_file_size_limit": { "type": "integer", "description": "图片文件上传大小限制（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "音频文件上传大小限制 (MB)。" }, "video_file_size_limit": { "type": "integer", "description": "视频文件上传大小限制 (MB)。" } } }, "WebAppSettingsResponse": { - "type": "object", - "description": "应用的 WebApp 设置。", - "properties": { - "title": { - "type": "string", - "description": "WebApp 名称。" - }, - "chat_color_theme": { - "type": "string", - "description": "聊天颜色主题, hex 格式。" - }, - "chat_color_theme_inverted": { - "type": "boolean", - "description": "聊天颜色主题是否反转。" - }, - "icon_type": { - "type": "string", - "enum": [ - "emoji", - "image" - ], - "description": "图标类型, `emoji`-表情, `image`-图片。" - }, - "icon": { - "type": "string", - "description": "图标, emoji 或图片 URL。" - }, - "icon_background": { - "type": "string", - "description": "hex 格式的背景色。" - }, - "icon_url": { - "type": "string", - "format": "url", - "nullable": true, - "description": "图标 URL。" - }, - "description": { - "type": "string", - "description": "描述。" - }, - "copyright": { - "type": "string", - "description": "版权信息。" - }, - "privacy_policy": { - "type": "string", - "description": "隐私政策链接。" - }, - "custom_disclaimer": { - "type": "string", - "description": "自定义免责声明。" - }, - "default_language": { - "type": "string", - "description": "默认语言。" - }, - "show_workflow_steps": { - "type": "boolean", - "description": "是否显示工作流详情。" - }, - "use_icon_as_answer_icon": { - "type": "boolean", - "description": "是否使用 WebApp 图标替换聊天中的 机器人图标。" - } - } + "type": "object", "description": "应用的 WebApp 设置。", + "properties": { "title": { "type": "string", "description": "WebApp 名称。" }, "chat_color_theme": { "type": "string", "description": "聊天颜色主题, hex 格式。" }, "chat_color_theme_inverted": { "type": "boolean", "description": "聊天颜色主题是否反转。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "图标类型, `emoji`-表情, `image`-图片。" }, "icon": { "type": "string", "description": "图标, emoji 或图片 URL。" }, "icon_background": { "type": "string", "description": "hex 格式的背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "图标 URL。" }, "description": { "type": "string", "description": "描述。" }, "copyright": { "type": "string", "description": "版权信息。" }, "privacy_policy": { "type": "string", "description": "隐私政策链接。" }, "custom_disclaimer": { "type": "string", "description": "自定义免责声明。" }, "default_language": { "type": "string", "description": "默认语言。" }, "show_workflow_steps": { "type": "boolean", "description": "是否显示工作流详情。" }, "use_icon_as_answer_icon": { "type": "boolean", "description": "是否使用 WebApp 图标替换聊天中的 机器人图标。" } } }, "AnnotationListResponse": { - "type": "object", - "description": "标注列表响应。", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AnnotationItem" - } - }, - "has_more": { - "type": "boolean" - }, - "limit": { - "type": "integer" - }, - "total": { - "type": "integer" - }, - "page": { - "type": "integer" - } - } + "type": "object", "description": "标注列表响应。", + "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationItem" } }, "has_more": { "type": "boolean" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "page": { "type": "integer" } } }, "AnnotationItem": { - "type": "object", - "description": "单个标注条目。", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "question": { - "type": "string", - "description": "问题。" - }, - "answer": { - "type": "string", - "description": "答案内容。" - }, - "hit_count": { - "type": "integer", - "description": "命中次数。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间戳。" - } - } + "type": "object", "description": "单个标注条目。", + "properties": { "id": { "type": "string", "format": "uuid" }, "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" }, "hit_count": { "type": "integer", "description": "命中次数。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } } }, "CreateAnnotationRequest": { - "type": "object", - "required": [ - "question", - "answer" - ], - "description": "创建标注请求体。", - "properties": { - "question": { - "type": "string", - "description": "问题。" - }, - "answer": { - "type": "string", - "description": "答案内容。" - } - } + "type": "object", "required": ["question", "answer"], "description": "创建标注请求体。", + "properties": { "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" } } }, "UpdateAnnotationRequest": { - "type": "object", - "required": [ - "question", - "answer" - ], - "description": "更新标注请求体。", - "properties": { - "question": { - "type": "string", - "description": "问题。" - }, - "answer": { - "type": "string", - "description": "答案内容。" - } - } + "type": "object", "required": ["question", "answer"], "description": "更新标注请求体。", + "properties": { "question": { "type": "string", "description": "问题。" }, "answer": { "type": "string", "description": "答案内容。" } } }, "InitialAnnotationReplySettingsRequest": { - "type": "object", - "required": [ - "score_threshold" - ], - "description": "标注回复初始设置请求体。", - "properties": { - "embedding_provider_name": { - "type": "string", - "nullable": true, - "description": "（可选）指定的嵌入模型提供商名称。" - }, - "embedding_model_name": { - "type": "string", - "nullable": true, - "description": "（可选）指定的嵌入模型名称。" - }, - "score_threshold": { - "type": "number", - "format": "float", - "description": "相似度阈值。" - } - } + "type": "object", "required": ["score_threshold"], "description": "标注回复初始设置请求体。", + "properties": { "embedding_provider_name": { "type": "string", "nullable": true, "description": "（可选）指定的嵌入模型提供商名称。" }, "embedding_model_name": { "type": "string", "nullable": true, "description": "（可选）指定的嵌入模型名称。" }, "score_threshold": { "type": "number", "format": "float", "description": "相似度阈值。" } } }, "AsyncJobResponse": { - "type": "object", - "description": "异步任务响应。", - "properties": { - "job_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID。" - }, - "job_status": { - "type": "string", - "description": "任务状态。" - } - } + "type": "object", "description": "异步任务响应。", + "properties": { "job_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, "job_status": { "type": "string", "description": "任务状态。" } } }, "AsyncJobStatusResponse": { - "allOf": [ - { - "$ref": "#/components/schemas/AsyncJobResponse" - }, - { - "type": "object", - "properties": { - "error_msg": { - "type": "string", - "nullable": true, - "description": "错误信息（如果任务失败）。" - } - } - } - ] + "allOf": [ { "$ref": "#/components/schemas/AsyncJobResponse" }, { "type": "object", "properties": { "error_msg": { "type": "string", "nullable": true, "description": "错误信息（如果任务失败）。" } } } ] }, "ErrorResponse": { - "type": "object", - "description": "错误响应结构。", - "properties": { - "status": { - "type": "integer", - "description": "HTTP 状态码。", - "nullable": true - }, - "code": { - "type": "string", - "description": "错误码。", - "nullable": true - }, - "message": { - "type": "string", - "description": "错误消息。" - } - } + "type": "object", "description": "错误响应结构。", + "properties": { "status": { "type": "integer", "description": "HTTP 状态码。", "nullable": true }, "code": { "type": "string", "description": "错误码。", "nullable": true }, "message": { "type": "string", "description": "错误消息。" } } } } }, "tags": [ - { - "name": "文本生成", - "description": "与文本生成和完成相关的操作。" - }, - { - "name": "文件管理", - "description": "与文件上传和管理相关的操作。" - }, - { - "name": "终端用户", - "description": "终端用户信息相关的操作。" - }, - { - "name": "反馈", - "description": "与用户反馈相关的操作。" - }, - { - "name": "语音服务", - "description": "与文本转语音相关的操作。" - }, - { - "name": "应用设置", - "description": "获取应用基本信息和参数配置的操作。" - }, - { - "name": "标注管理", - "description": "与标注（用于直接回复）相关的操作。" - } + { "name": "文本生成", "description": "与文本生成和完成相关的操作。" }, + { "name": "文件管理", "description": "与文件上传和管理相关的操作。" }, + { "name": "终端用户", "description": "终端用户信息相关的操作。" }, + { "name": "反馈", "description": "与用户反馈相关的操作。" }, + { "name": "语音服务", "description": "与文本转语音相关的操作。" }, + { "name": "应用设置", "description": "获取应用基本信息和参数配置的操作。" }, + { "name": "标注管理", "description": "与标注（用于直接回复）相关的操作。" } ] -} +} \ No newline at end of file diff --git a/zh/api-reference/openapi_knowledge.json b/zh/api-reference/openapi_knowledge.json index a8575feb5..0c1e92e6b 100644 --- a/zh/api-reference/openapi_knowledge.json +++ b/zh/api-reference/openapi_knowledge.json @@ -77,9 +77,6 @@ "409": { "$ref": "#/components/responses/DatasetNameDuplicate" } - }, - "x-mint": { - "href": "/zh/api-reference/datasets/create-an-empty-knowledge-base" } }, "get": { @@ -152,9 +149,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/datasets/get-knowledge-base-list" } } }, @@ -189,9 +183,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/datasets/get-knowledge-base-details" } }, "patch": { @@ -237,9 +228,6 @@ "409": { "$ref": "#/components/responses/DatasetNameDuplicate" } - }, - "x-mint": { - "href": "/zh/api-reference/datasets/update-knowledge-base" } }, "delete": { @@ -265,9 +253,6 @@ "204": { "description": "成功删除数据集。" } - }, - "x-mint": { - "href": "/zh/api-reference/datasets/delete-a-knowledge-base" } } }, @@ -312,9 +297,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/documents/create-a-document-from-text" } } }, @@ -380,9 +362,6 @@ "415": { "$ref": "#/components/responses/UnsupportedFileType" } - }, - "x-mint": { - "href": "/zh/api-reference/documents/create-a-document-from-a-file" } } }, @@ -437,9 +416,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/documents/update-a-document-with-text" } } }, @@ -506,9 +482,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/documents/update-a-document-with-a-file" } } }, @@ -560,9 +533,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/documents/get-document-embedding-status-progress" } } }, @@ -621,9 +591,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/documents/get-document-detail" } }, "delete": { @@ -659,9 +626,6 @@ "204": { "description": "成功删除文档。" } - }, - "x-mint": { - "href": "/zh/api-reference/documents/delete-a-document" } } }, @@ -724,9 +688,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/documents/get-the-document-list-of-a-knowledge-base" } } }, @@ -792,9 +753,6 @@ "200": { "$ref": "#/components/responses/Success" } - }, - "x-mint": { - "href": "/zh/api-reference/documents/update-document-status" } } }, @@ -849,9 +807,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/chunks/add-chunks-to-a-document" } }, "get": { @@ -931,9 +886,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/chunks/get-chunks-from-a-document" } } }, @@ -988,9 +940,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/chunks/get-a-chunk-details-in-a-document" } }, "post": { @@ -1053,9 +1002,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/chunks/update-a-chunk-in-a-document" } }, "delete": { @@ -1101,9 +1047,6 @@ "204": { "description": "成功删除段落。" } - }, - "x-mint": { - "href": "/zh/api-reference/chunks/delete-a-chunk-in-a-document" } } }, @@ -1148,9 +1091,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/datasets/retrieve-chunks-from-a-knowledge-base-test-retrieval" } } }, @@ -1181,9 +1121,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/models/get-available-embedding-models" } } }, @@ -1248,9 +1185,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/chunks/create-child-chunk" } }, "get": { @@ -1330,9 +1264,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/chunks/get-child-chunks" } } }, @@ -1407,9 +1338,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/chunks/update-child-chunk" } }, "delete": { @@ -1465,9 +1393,6 @@ "204": { "description": "成功删除子块。" } - }, - "x-mint": { - "href": "/zh/api-reference/chunks/delete-child-chunk" } } }, @@ -1510,9 +1435,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/metadata-tags/create-new-knowledge-base-type-tag" } }, "get": { @@ -1536,9 +1458,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/metadata-tags/get-knowledge-base-type-tags" } }, "patch": { @@ -1585,9 +1504,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/metadata-tags/modify-knowledge-base-type-tag-name" } }, "delete": { @@ -1621,9 +1537,6 @@ "200": { "$ref": "#/components/responses/Success" } - }, - "x-mint": { - "href": "/zh/api-reference/metadata-tags/delete-knowledge-base-type-tag" } } }, @@ -1668,9 +1581,6 @@ "200": { "$ref": "#/components/responses/Success" } - }, - "x-mint": { - "href": "/zh/api-reference/metadata-tags/bind-dataset-to-knowledge-base-type-tag" } } }, @@ -1712,9 +1622,6 @@ "200": { "$ref": "#/components/responses/Success" } - }, - "x-mint": { - "href": "/zh/api-reference/metadata-tags/unbind-dataset-and-knowledge-base-type-tag" } } }, @@ -1769,9 +1676,6 @@ } } } - }, - "x-mint": { - "href": "/zh/api-reference/metadata-tags/query-tags-bound-to-a-dataset" } } } diff --git a/zh/api-reference/openapi_workflow.json b/zh/api-reference/openapi_workflow.json index e247c6eb0..ed9742e9a 100644 --- a/zh/api-reference/openapi_workflow.json +++ b/zh/api-reference/openapi_workflow.json @@ -28,9 +28,7 @@ "summary": "执行 workflow", "description": "执行 workflow，没有已发布的 workflow，不可执行。", "operationId": "executeWorkflowCn", - "tags": [ - "工作流执行" - ], + "tags": ["工作流执行"], "requestBody": { "required": true, "content": { @@ -49,7 +47,7 @@ "user": "workflow_user_001" } }, - "with_file_array_variable_cn": { + "with_file_array_variable_cn":{ "summary": "包含文件列表变量的输入示例", "value": { "inputs": { @@ -91,15 +89,8 @@ } } }, - "400": { - "$ref": "#/components/responses/BadRequestWorkflowCn" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/workflow-execution/execute-workflow" + "400": { "$ref": "#/components/responses/BadRequestWorkflowCn" }, + "500": { "$ref": "#/components/responses/InternalServerErrorCn" } } } }, @@ -108,19 +99,14 @@ "summary": "获取workflow执行情况", "description": "根据 workflow 执行 ID 获取 workflow 任务当前执行结果。", "operationId": "getWorkflowRunDetailCn", - "tags": [ - "工作流执行" - ], + "tags": ["工作流执行"], "parameters": [ { "name": "workflow_run_id", "in": "path", "required": true, "description": "workflow 执行 ID，可在流式返回 Chunk 或阻塞模式响应中获取。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -128,18 +114,11 @@ "description": "成功获取 workflow 执行详情。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowRunDetailResponseCn" - } + "schema": { "$ref": "#/components/schemas/WorkflowRunDetailResponseCn" } } } }, - "404": { - "description": "Workflow 执行记录未找到。" - } - }, - "x-mint": { - "href": "/zh/api-reference/workflow-execution/get-workflow-run-detail" + "404": {"description": "Workflow 执行记录未找到。"} } } }, @@ -148,19 +127,14 @@ "summary": "停止响应 (Workflow Task)", "description": "停止 workflow 任务的生成。仅支持流式模式。", "operationId": "stopWorkflowTaskGenerationCn", - "tags": [ - "工作流执行" - ], + "tags": ["工作流执行"], "parameters": [ { "name": "task_id", "in": "path", "required": true, "description": "任务 ID，可在流式返回 Chunk 中获取。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { @@ -169,26 +143,16 @@ "application/json": { "schema": { "type": "object", - "required": [ - "user" - ], + "required": ["user"], "properties": { - "user": { - "type": "string", - "description": "用户标识，必须和执行 workflow 接口传入的 user 保持一致。" - } + "user": { "type": "string", "description": "用户标识，必须和执行 workflow 接口传入的 user 保持一致。" } } } } } }, "responses": { - "200": { - "$ref": "#/components/responses/SuccessResultCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/workflow-execution/stop-workflow-task-generation" + "200": { "$ref": "#/components/responses/SuccessResultCn" } } } }, @@ -197,73 +161,30 @@ "summary": "上传文件 (Workflow)", "description": "上传文件并在执行 workflow 时使用。支持你的工作流程所支持的任何格式。上传的文件仅供当前终端用户使用。", "operationId": "uploadWorkflowFileCn", - "tags": [ - "文件操作 (Workflow)" - ], + "tags": ["文件操作 (Workflow)"], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", - "required": [ - "file", - "user" - ], + "required": ["file", "user"], "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "要上传的文件。" - }, - "user": { - "type": "string", - "description": "用户标识。" - } + "file": { "type": "string", "format": "binary", "description": "要上传的文件。" }, + "user": { "type": "string", "description": "用户标识。" } } } } } }, "responses": { - "200": { - "description": "文件上传成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseCn" - } - } - } - }, - "201": { - "description": "文件创建成功。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileUploadResponseCn" - } - } - } - }, - "400": { - "$ref": "#/components/responses/BadRequestFileCn" - }, - "413": { - "$ref": "#/components/responses/FileTooLargeCn" - }, - "415": { - "$ref": "#/components/responses/UnsupportedFileTypeFileCn" - }, - "503": { - "$ref": "#/components/responses/S3ErrorFileCn" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/files/file-upload-for-workflow" + "200": { "description": "文件上传成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseCn" } } } }, + "201": { "description": "文件创建成功。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadResponseCn" } } } }, + "400": { "$ref": "#/components/responses/BadRequestFileCn" }, + "413": { "$ref": "#/components/responses/FileTooLargeCn" }, + "415": { "$ref": "#/components/responses/UnsupportedFileTypeFileCn" }, + "503": { "$ref": "#/components/responses/S3ErrorFileCn" }, + "500": { "$ref": "#/components/responses/InternalServerErrorCn" } } } }, @@ -272,19 +193,14 @@ "summary": "获取终端用户", "description": "通过 ID 获取终端用户信息。\n\n当其他 API 返回终端用户 ID（例如文件上传接口返回的 `created_by`）时，可使用该接口查询对应的终端用户信息。", "operationId": "getEndUserWorkflowCn", - "tags": [ - "终端用户" - ], + "tags": ["终端用户"], "parameters": [ { "name": "end_user_id", "in": "path", "required": true, "description": "终端用户 ID。", - "schema": { - "type": "string", - "format": "uuid" - } + "schema": { "type": "string", "format": "uuid" } } ], "responses": { @@ -292,1539 +208,240 @@ "description": "成功获取终端用户信息。", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/EndUserDetailCn" - } + "schema": { "$ref": "#/components/schemas/EndUserDetailCn" } } } }, - "404": { - "$ref": "#/components/responses/EndUserNotFoundCn" - }, - "500": { - "$ref": "#/components/responses/InternalServerErrorCn" - } - }, - "x-mint": { - "href": "/zh/api-reference/end-users/get-end-user" + "404": { "$ref": "#/components/responses/EndUserNotFoundCn" }, + "500": { "$ref": "#/components/responses/InternalServerErrorCn" } } } }, "/workflows/logs": { - "get": { - "summary": "获取 workflow 日志", - "description": "倒序返回 workflow 日志。", - "operationId": "getWorkflowLogsCn", - "tags": [ - "工作流执行" - ], - "parameters": [ - { - "name": "keyword", - "in": "query", - "description": "（可选）关键字。", - "schema": { - "type": "string" - } - }, - { - "name": "status", - "in": "query", - "description": "（可选）执行状态：succeeded, failed, stopped, running。", - "schema": { - "type": "string", - "enum": [ - "succeeded", - "failed", - "stopped", - "running" - ] - } - }, - { - "name": "page", - "in": "query", - "description": "（可选）当前页码, 默认1。", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "limit", - "in": "query", - "description": "（可选）每页条数, 默认20。", - "schema": { - "type": "integer", - "default": 20 - } - } - ], - "responses": { - "200": { - "description": "成功获取 workflow 日志。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowLogsResponseCn" - } - } + "get": { + "summary": "获取 workflow 日志", + "description": "倒序返回 workflow 日志。", + "operationId": "getWorkflowLogsCn", + "tags": ["工作流执行"], + "parameters": [ + { "name": "keyword", "in": "query", "description": "（可选）关键字。", "schema": { "type": "string" } }, + { "name": "status", "in": "query", "description": "（可选）执行状态：succeeded, failed, stopped, running。", "schema": { "type": "string", "enum": ["succeeded", "failed", "stopped", "running"] } }, + { "name": "page", "in": "query", "description": "（可选）当前页码, 默认1。", "schema": { "type": "integer", "default": 1 } }, + { "name": "limit", "in": "query", "description": "（可选）每页条数, 默认20。", "schema": { "type": "integer", "default": 20 } } + ], + "responses": { + "200": { "description": "成功获取 workflow 日志。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowLogsResponseCn" } } } } } - } - }, - "x-mint": { - "href": "/zh/api-reference/workflow-execution/get-workflow-logs" } - } }, "/info": { "get": { "summary": "获取应用基本信息 (Workflow)", "operationId": "getWorkflowAppInfoCn", - "tags": [ - "应用配置 (Workflow)" - ], - "responses": { - "200": { - "description": "应用基本信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppInfoResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-basic-information" - } + "tags": ["应用配置 (Workflow)"], + "responses": { "200": { "description": "应用基本信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppInfoResponseCn" } } } } } } }, "/parameters": { "get": { "summary": "获取应用参数 (Workflow)", "operationId": "getWorkflowAppParametersCn", - "tags": [ - "应用配置 (Workflow)" - ], - "responses": { - "200": { - "description": "应用参数信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowAppParametersResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-parameters-information" - } + "tags": ["应用配置 (Workflow)"], + "responses": { "200": { "description": "应用参数信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAppParametersResponseCn" } } } } } } }, "/site": { "get": { "summary": "获取应用 WebApp 设置 (Workflow)", "operationId": "getWorkflowWebAppSettingsCn", - "tags": [ - "应用配置 (Workflow)" - ], - "responses": { - "200": { - "description": "WebApp 设置信息。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkflowWebAppSettingsResponseCn" - } - } - } - } - }, - "x-mint": { - "href": "/zh/api-reference/application/get-application-webapp-settings" - } + "tags": ["应用配置 (Workflow)"], + "responses": { "200": { "description": "WebApp 设置信息。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowWebAppSettingsResponseCn" } } } } } } } }, "components": { "securitySchemes": { - "ApiKeyAuth": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "API_KEY", - "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" - } + "ApiKeyAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API_KEY", "description": "API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key，格式为：Bearer {API_KEY}。强烈建议开发者把 API-Key 放在后端存储，而非客户端，以免泄露。" } }, "responses": { - "BadRequestWorkflowCn": { - "description": "请求参数错误或工作流执行失败。可能错误码：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, workflow_request_error。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "BadRequestFileCn": { - "description": "文件操作请求错误。可能错误码：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "FileTooLargeCn": { - "description": "文件太大 (file_too_large)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "UnsupportedFileTypeFileCn": { - "description": "不支持的文件类型 (unsupported_file_type)。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "S3ErrorFileCn": { - "description": "S3 存储服务错误。可能错误码：s3_connection_failed, s3_permission_denied, s3_file_too_large。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "InternalServerErrorCn": { - "description": "服务内部异常。", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - }, - "SuccessResultCn": { - "description": "操作成功。", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "result": { - "type": "string", - "example": "success" - } - } - } - } - } - }, - "EndUserNotFoundCn": { - "description": "终端用户不存在。错误码：`end_user_not_found`", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponseCn" - } - } - } - } + "BadRequestWorkflowCn": { "description": "请求参数错误或工作流执行失败。可能错误码：invalid_param, app_unavailable, provider_not_initialize, provider_quota_exceeded, model_currently_not_support, workflow_request_error。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "BadRequestFileCn": { "description": "文件操作请求错误。可能错误码：no_file_uploaded, too_many_files, unsupported_preview, unsupported_estimate。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "FileTooLargeCn": { "description": "文件太大 (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "UnsupportedFileTypeFileCn": { "description": "不支持的文件类型 (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "S3ErrorFileCn": { "description": "S3 存储服务错误。可能错误码：s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "InternalServerErrorCn": { "description": "服务内部异常。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } }, + "SuccessResultCn": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }, + "EndUserNotFoundCn": { "description": "终端用户不存在。错误码：`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseCn" } } } } }, "schemas": { "WorkflowExecutionRequestCn": { "type": "object", - "required": [ - "inputs", - "response_mode", - "user" - ], + "required": ["inputs", "response_mode", "user"], "properties": { "inputs": { "type": "object", "description": "允许传入 App 定义的各变量值。如果变量是文件列表类型，该变量对应的值应是 InputFileObjectWorkflowCn 对象的列表。", "additionalProperties": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/InputFileObjectWorkflowCn" - } - } - ] + "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "object" }, { "type": "array", "items": { "$ref": "#/components/schemas/InputFileObjectWorkflowCn" } } ] }, - "example": { - "user_query": "请帮我翻译这句话。", - "target_language": "法语" - } - }, - "response_mode": { - "type": "string", - "enum": [ - "streaming", - "blocking" - ], - "description": "返回响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。" + "example": { "user_query": "请帮我翻译这句话。", "target_language": "法语" } }, - "user": { - "type": "string", - "description": "用户标识，应用内唯一。" - } + "response_mode": { "type": "string", "enum": ["streaming", "blocking"], "description": "返回响应模式。streaming (推荐) 基于 SSE；blocking 等待执行完毕后返回 (Cloudflare 100秒超时限制)。" }, + "user": { "type": "string", "description": "用户标识，应用内唯一。" } } }, "InputFileObjectWorkflowCn": { "type": "object", - "required": [ - "type", - "transfer_method" - ], + "required": ["type", "transfer_method"], "properties": { - "type": { - "type": "string", - "enum": [ - "document", - "image", - "audio", - "video", - "custom" - ], - "description": "文件类型。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: 其他。" - }, - "transfer_method": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ], - "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" - }, - "url": { - "type": "string", - "format": "url", - "description": "图片地址（当传递方式为 remote_url 时）" - }, - "upload_file_id": { - "type": "string", - "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" - } + "type": { "type": "string", "enum": ["document", "image", "audio", "video", "custom"], "description": "文件类型。document: TXT,MD,PDF等; image: JPG,PNG等; audio: MP3,WAV等; video: MP4,MOV等; custom: 其他。" }, + "transfer_method": { "type": "string", "enum": ["remote_url", "local_file"], "description": "传递方式，remote_url 用于图片 URL / local_file 用于文件上传" }, + "url": { "type": "string", "format": "url", "description": "图片地址（当传递方式为 remote_url 时）" }, + "upload_file_id": { "type": "string", "description": "上传文件 ID，必须通过事先上传文件接口获得（当传递方式为 local_file 时）" } }, "anyOf": [ { - "properties": { - "transfer_method": { - "enum": [ - "remote_url" - ] - }, - "url": { - "type": "string", - "format": "url" - } + "properties": { + "transfer_method": { "enum": ["remote_url"] }, + "url": { "type": "string", "format": "url" } }, - "required": [ - "url" - ], - "not": { - "required": [ - "upload_file_id" - ] - } + "required": ["url"], + "not": { "required": ["upload_file_id"] } }, { - "properties": { - "transfer_method": { - "enum": [ - "local_file" - ] - }, - "upload_file_id": { - "type": "string" - } + "properties": { + "transfer_method": { "enum": ["local_file"] }, + "upload_file_id": { "type": "string" } }, - "required": [ - "upload_file_id" - ], - "not": { - "required": [ - "url" - ] - } + "required": ["upload_file_id"], + "not": { "required": ["url"] } } ] }, "WorkflowCompletionResponseCn": { - "type": "object", - "description": "阻塞模式下的 workflow 执行结果。", + "type": "object", "description": "阻塞模式下的 workflow 执行结果。", "properties": { - "workflow_run_id": { - "type": "string", - "format": "uuid", - "description": "workflow 执行 ID。" - }, - "task_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID。" - }, - "data": { - "$ref": "#/components/schemas/WorkflowFinishedDataCn" - } + "workflow_run_id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, + "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, + "data": { "$ref": "#/components/schemas/WorkflowFinishedDataCn" } } }, "ChunkWorkflowEventCn": { - "type": "object", - "required": [ - "event" - ], - "properties": { - "event": { - "type": "string", - "enum": [ - "workflow_started", - "node_started", - "text_chunk", - "node_finished", - "workflow_finished", - "tts_message", - "tts_message_end", - "ping" - ], - "description": "事件类型。" - } - }, - "discriminator": { - "propertyName": "event", - "mapping": { - "workflow_started": "#/components/schemas/StreamEventWfWorkflowStartedCn", - "node_started": "#/components/schemas/StreamEventWfNodeStartedCn", - "text_chunk": "#/components/schemas/StreamEventWfTextChunkCn", - "node_finished": "#/components/schemas/StreamEventWfNodeFinishedCn", - "workflow_finished": "#/components/schemas/StreamEventWfWorkflowFinishedCn", - "tts_message": "#/components/schemas/StreamEventWfTtsMessageCn", - "tts_message_end": "#/components/schemas/StreamEventWfTtsMessageEndCn", - "ping": "#/components/schemas/StreamEventWfPingCn" - } - } + "type": "object", "required": ["event"], + "properties": { "event": { "type": "string", "enum": ["workflow_started", "node_started", "text_chunk", "node_finished", "workflow_finished", "tts_message", "tts_message_end", "ping"], "description": "事件类型。" } }, + "discriminator": { "propertyName": "event", "mapping": { + "workflow_started": "#/components/schemas/StreamEventWfWorkflowStartedCn", "node_started": "#/components/schemas/StreamEventWfNodeStartedCn", + "text_chunk": "#/components/schemas/StreamEventWfTextChunkCn", "node_finished": "#/components/schemas/StreamEventWfNodeFinishedCn", + "workflow_finished": "#/components/schemas/StreamEventWfWorkflowFinishedCn", "tts_message": "#/components/schemas/StreamEventWfTtsMessageCn", + "tts_message_end": "#/components/schemas/StreamEventWfTtsMessageEndCn", "ping": "#/components/schemas/StreamEventWfPingCn" + }} }, "StreamEventBaseWfCn": { + "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid", "description": "任务 ID。" }, "workflow_run_id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" } } + }, + "StreamEventWfWorkflowStartedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowStartedDataCn" } } } ] }, + "WorkflowStartedDataCn": { "type": "object", "description": "Workflow 开始执行事件的详细内容。", "required": ["id", "workflow_id", "sequence_number", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "关联 Workflow ID。" }, "sequence_number": { "type": "integer", "description": "自增序号，App 内自增，从 1 开始。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, + "StreamEventWfNodeStartedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/NodeStartedDataCn" } } } ] }, + "NodeStartedDataCn": { "type": "object", "description": "Node 开始执行事件的详细内容。", "required": ["id", "node_id", "node_type", "title", "index", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID (应为 node 执行 ID，根据上下文修正)。" }, "node_id": { "type": "string", "format": "uuid", "description": "节点 ID。" }, "node_type": { "type": "string", "description": "节点类型。" }, "title": { "type": "string", "description": "节点名称。" }, "index": { "type": "integer", "description": "执行序号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "前置节点 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "description": "节点中所有使用到的前置节点变量内容。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, + "StreamEventWfTextChunkCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/TextChunkDataCn" } } } ] }, + "TextChunkDataCn": { "type": "object", "description": "文本片段事件的详细内容。", "required": ["text", "from_variable_selector"], "properties": { "text": { "type": "string", "description": "文本内容。" }, "from_variable_selector": { "type": "array", "items": { "type": "string" }, "description": "文本来源路径，帮助开发者了解文本是由哪个节点的哪个变量生成的。" } } }, + "StreamEventWfNodeFinishedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/NodeFinishedDataCn" } } } ] }, + "NodeFinishedDataCn": { "type": "object", "description": "Node 执行结束事件的详细内容。", "required": ["id", "node_id", "index", "status", "created_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "node 执行 ID。" }, "node_id": { "type": "string", "format": "uuid", "description": "节点 ID。" }, "index": { "type": "integer", "description": "执行序号。" }, "predecessor_node_id": { "type": "string", "format": "uuid", "nullable": true, "description": "（可选）前置节点 ID。" }, "inputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "节点中所有使用到的前置节点变量内容。" }, "process_data": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）节点过程数据 (JSON)。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）输出内容 (JSON)。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, "error": { "type": "string", "nullable": true, "description": "（可选）错误原因。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（可选）耗时(秒)。" }, "execution_metadata": { "$ref": "#/components/schemas/NodeExecutionMetadataCn" , "nullable": true, "description":"元数据"}, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" } } }, + "NodeExecutionMetadataCn": { "type": "object", "description": "节点执行元数据。", "properties": { "total_tokens": { "type": "integer", "nullable": true, "description": "（可选）总使用 tokens。" }, "total_price": { "type": "number", "format": "float", "nullable": true, "description": "（可选）总费用 (使用 float 兼容 decimal)。" }, "currency": { "type": "string", "nullable": true, "example": "USD", "description": "（可选）货币，如 USD / RMB。" } } }, + "StreamEventWfWorkflowFinishedCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["data"], "properties": { "data": { "$ref": "#/components/schemas/WorkflowFinishedDataCn" } } } ] }, + "WorkflowFinishedDataCn": { "type": "object", "description": "Workflow 执行结束事件的详细内容。", "required": ["id", "workflow_id", "status", "created_at", "finished_at"], "properties": { "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, "workflow_id": { "type": "string", "format": "uuid", "description": "关联 Workflow ID。" }, "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "（可选）输出内容 (JSON)。" }, "error": { "type": "string", "nullable": true, "description": "（可选）错误原因。" }, "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "（可选）耗时(秒)。" }, "total_tokens": { "type": "integer", "nullable": true, "description": "（可选）总使用 tokens。" }, "total_steps": { "type": "integer", "default": 0, "description": "总步数，默认 0。" }, "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" }, "finished_at": { "type": "integer", "format": "int64", "description": "结束时间。" } } }, + "StreamEventWfTtsMessageCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["audio", "message_id", "created_at"], "properties": { "audio": { "type": "string", "format": "byte", "description": "语音合成之后的音频块 Base64 编码文本。" }, "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } } } ] }, + "StreamEventWfTtsMessageEndCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "$ref": "#/components/schemas/StreamEventBaseWfCn" }, { "type": "object", "required": ["audio", "message_id", "created_at"], "properties": { "audio": { "type": "string", "description": "结束事件音频为空字符串。" }, "message_id": { "type": "string", "format": "uuid", "description": "消息唯一 ID。" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间戳。" } } } ] }, + "StreamEventWfPingCn": { "allOf": [ { "$ref": "#/components/schemas/ChunkWorkflowEventCn" }, { "type": "object", "description": "每 10s 一次的 ping 事件，保持连接存活。" } ] }, + "WorkflowRunDetailResponseCn": { + "type": "object", "description": "Workflow 执行详情。", + "properties": { + "id": { "type": "string", "format": "uuid", "description": "workflow 执行 ID。" }, + "workflow_id": { "type": "string", "format": "uuid", "description": "关联的 Workflow ID。" }, + "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, + "inputs": { "type": "string", "description": "任务输入内容的 JSON 字符串。" }, + "outputs": { "type": "object", "additionalProperties": true, "nullable": true, "description": "任务输出内容的 JSON 对象。" }, + "error": { "type": "string", "nullable": true, "description": "错误原因。" }, + "total_steps": { "type": "integer", "description": "任务执行总步数。" }, + "total_tokens": { "type": "integer", "description": "任务执行总 tokens。" }, + "created_at": { "type": "integer", "format": "int64", "description": "任务开始时间。" }, + "finished_at": { "type": "integer", "format": "int64", "nullable": true, "description": "任务结束时间。" }, + "elapsed_time": { "type": "number", "format": "float", "nullable": true, "description": "耗时(秒)。" } + } + }, + "FileUploadResponseCn": { "type": "object", "description": "文件上传成功响应。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "文件名。" }, "size": { "type": "integer", "description": "文件大小 (byte)。" }, "extension": { "type": "string", "description": "文件后缀。" }, "mime_type": { "type": "string", "description": "文件 mime-type。" }, "created_by": { "type": "string", "format": "uuid", "description": "上传人 ID (应为 uuid，示例中为 int，已修正)。" }, "created_at": { "type": "integer", "format": "int64", "description": "上传时间。" } } }, + "EndUserDetailCn": { "type": "object", "properties": { - "task_id": { - "type": "string", - "format": "uuid", - "description": "任务 ID。" - }, - "workflow_run_id": { - "type": "string", - "format": "uuid", - "description": "workflow 执行 ID。" - } + "id": { "type": "string", "format": "uuid" }, + "tenant_id": { "type": "string", "format": "uuid" }, + "app_id": { "type": "string", "format": "uuid", "nullable": true }, + "type": { "type": "string", "example": "service_api" }, + "external_user_id": { "type": "string", "nullable": true }, + "name": { "type": "string", "nullable": true }, + "is_anonymous": { "type": "boolean" }, + "session_id": { "type": "string" }, + "created_at": { "type": "string", "format": "date-time" }, + "updated_at": { "type": "string", "format": "date-time" } } }, - "StreamEventWfWorkflowStartedCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfCn" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/WorkflowStartedDataCn" - } - } - } - ] - }, - "WorkflowStartedDataCn": { - "type": "object", - "description": "Workflow 开始执行事件的详细内容。", - "required": [ - "id", - "workflow_id", - "sequence_number", - "created_at" - ], + "WorkflowLogsResponseCn": { + "type": "object", "description": "Workflow 日志列表响应。", "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "workflow 执行 ID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "关联 Workflow ID。" - }, - "sequence_number": { - "type": "integer", - "description": "自增序号，App 内自增，从 1 开始。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "开始时间。" - } + "page": { "type": "integer", "description": "当前页码。" }, "limit": { "type": "integer", "description": "每页条数。" }, + "total": { "type": "integer", "description": "总条数。" }, "has_more": { "type": "boolean", "description": "是否还有更多数据。" }, + "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowLogItemCn" }, "description": "当前页码的数据。" } } }, - "StreamEventWfNodeStartedCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfCn" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/NodeStartedDataCn" - } - } - } - ] - }, - "NodeStartedDataCn": { - "type": "object", - "description": "Node 开始执行事件的详细内容。", - "required": [ - "id", - "node_id", - "node_type", - "title", - "index", - "created_at" - ], + "WorkflowLogItemCn": { + "type": "object", "description": "单条 Workflow 日志。", "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "workflow 执行 ID (应为 node 执行 ID，根据上下文修正)。" - }, - "node_id": { - "type": "string", - "format": "uuid", - "description": "节点 ID。" - }, - "node_type": { - "type": "string", - "description": "节点类型。" - }, - "title": { - "type": "string", - "description": "节点名称。" - }, - "index": { - "type": "integer", - "description": "执行序号。" - }, - "predecessor_node_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "前置节点 ID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "description": "节点中所有使用到的前置节点变量内容。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "开始时间。" - } + "id": { "type": "string", "format": "uuid", "description": "标识。" }, + "workflow_run": { "$ref": "#/components/schemas/WorkflowRunSummaryCn", "description": "Workflow 执行日志。" }, + "created_from": { "type": "string", "description": "来源。" }, + "created_by_role": { "type": "string", "description": "角色。" }, + "created_by_account": { "type": "string", "format": "uuid", "nullable": true, "description": "（可选）帐号。" }, + "created_by_end_user": { "$ref": "#/components/schemas/EndUserSummaryCn", "description": "用户。" }, + "created_at": { "type": "integer", "format": "int64", "description": "创建时间。" } } }, - "StreamEventWfTextChunkCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfCn" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/TextChunkDataCn" - } - } - } - ] - }, - "TextChunkDataCn": { - "type": "object", - "description": "文本片段事件的详细内容。", - "required": [ - "text", - "from_variable_selector" - ], + "WorkflowRunSummaryCn": { + "type": "object", "description": "Workflow 执行摘要信息。", "properties": { - "text": { - "type": "string", - "description": "文本内容。" - }, - "from_variable_selector": { - "type": "array", - "items": { - "type": "string" - }, - "description": "文本来源路径，帮助开发者了解文本是由哪个节点的哪个变量生成的。" - } - } - }, - "StreamEventWfNodeFinishedCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfCn" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/NodeFinishedDataCn" - } - } - } - ] - }, - "NodeFinishedDataCn": { - "type": "object", - "description": "Node 执行结束事件的详细内容。", - "required": [ - "id", - "node_id", - "index", - "status", - "created_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "node 执行 ID。" - }, - "node_id": { - "type": "string", - "format": "uuid", - "description": "节点 ID。" - }, - "index": { - "type": "integer", - "description": "执行序号。" - }, - "predecessor_node_id": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "（可选）前置节点 ID。" - }, - "inputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "节点中所有使用到的前置节点变量内容。" - }, - "process_data": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "（可选）节点过程数据 (JSON)。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "（可选）输出内容 (JSON)。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "执行状态。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "（可选）错误原因。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "（可选）耗时(秒)。" - }, - "execution_metadata": { - "$ref": "#/components/schemas/NodeExecutionMetadataCn", - "nullable": true, - "description": "元数据" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "开始时间。" - } - } - }, - "NodeExecutionMetadataCn": { - "type": "object", - "description": "节点执行元数据。", - "properties": { - "total_tokens": { - "type": "integer", - "nullable": true, - "description": "（可选）总使用 tokens。" - }, - "total_price": { - "type": "number", - "format": "float", - "nullable": true, - "description": "（可选）总费用 (使用 float 兼容 decimal)。" - }, - "currency": { - "type": "string", - "nullable": true, - "example": "USD", - "description": "（可选）货币，如 USD / RMB。" - } - } - }, - "StreamEventWfWorkflowFinishedCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfCn" - }, - { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/WorkflowFinishedDataCn" - } - } - } - ] - }, - "WorkflowFinishedDataCn": { - "type": "object", - "description": "Workflow 执行结束事件的详细内容。", - "required": [ - "id", - "workflow_id", - "status", - "created_at", - "finished_at" - ], - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "workflow 执行 ID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "关联 Workflow ID。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "执行状态。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "（可选）输出内容 (JSON)。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "（可选）错误原因。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "（可选）耗时(秒)。" - }, - "total_tokens": { - "type": "integer", - "nullable": true, - "description": "（可选）总使用 tokens。" - }, - "total_steps": { - "type": "integer", - "default": 0, - "description": "总步数，默认 0。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "开始时间。" - }, - "finished_at": { - "type": "integer", - "format": "int64", - "description": "结束时间。" - } - } - }, - "StreamEventWfTtsMessageCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfCn" - }, - { - "type": "object", - "required": [ - "audio", - "message_id", - "created_at" - ], - "properties": { - "audio": { - "type": "string", - "format": "byte", - "description": "语音合成之后的音频块 Base64 编码文本。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息唯一 ID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间戳。" - } - } - } - ] - }, - "StreamEventWfTtsMessageEndCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventCn" - }, - { - "$ref": "#/components/schemas/StreamEventBaseWfCn" - }, - { - "type": "object", - "required": [ - "audio", - "message_id", - "created_at" - ], - "properties": { - "audio": { - "type": "string", - "description": "结束事件音频为空字符串。" - }, - "message_id": { - "type": "string", - "format": "uuid", - "description": "消息唯一 ID。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间戳。" - } - } - } - ] - }, - "StreamEventWfPingCn": { - "allOf": [ - { - "$ref": "#/components/schemas/ChunkWorkflowEventCn" - }, - { - "type": "object", - "description": "每 10s 一次的 ping 事件，保持连接存活。" - } - ] - }, - "WorkflowRunDetailResponseCn": { - "type": "object", - "description": "Workflow 执行详情。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "workflow 执行 ID。" - }, - "workflow_id": { - "type": "string", - "format": "uuid", - "description": "关联的 Workflow ID。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "执行状态。" - }, - "inputs": { - "type": "string", - "description": "任务输入内容的 JSON 字符串。" - }, - "outputs": { - "type": "object", - "additionalProperties": true, - "nullable": true, - "description": "任务输出内容的 JSON 对象。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "错误原因。" - }, - "total_steps": { - "type": "integer", - "description": "任务执行总步数。" - }, - "total_tokens": { - "type": "integer", - "description": "任务执行总 tokens。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "任务开始时间。" - }, - "finished_at": { - "type": "integer", - "format": "int64", - "nullable": true, - "description": "任务结束时间。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "nullable": true, - "description": "耗时(秒)。" - } - } - }, - "FileUploadResponseCn": { - "type": "object", - "description": "文件上传成功响应。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "ID。" - }, - "name": { - "type": "string", - "description": "文件名。" - }, - "size": { - "type": "integer", - "description": "文件大小 (byte)。" - }, - "extension": { - "type": "string", - "description": "文件后缀。" - }, - "mime_type": { - "type": "string", - "description": "文件 mime-type。" - }, - "created_by": { - "type": "string", - "format": "uuid", - "description": "上传人 ID (应为 uuid，示例中为 int，已修正)。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "上传时间。" - } - } - }, - "EndUserDetailCn": { - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid" - }, - "tenant_id": { - "type": "string", - "format": "uuid" - }, - "app_id": { - "type": "string", - "format": "uuid", - "nullable": true - }, - "type": { - "type": "string", - "example": "service_api" - }, - "external_user_id": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - }, - "is_anonymous": { - "type": "boolean" - }, - "session_id": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - } - }, - "WorkflowLogsResponseCn": { - "type": "object", - "description": "Workflow 日志列表响应。", - "properties": { - "page": { - "type": "integer", - "description": "当前页码。" - }, - "limit": { - "type": "integer", - "description": "每页条数。" - }, - "total": { - "type": "integer", - "description": "总条数。" - }, - "has_more": { - "type": "boolean", - "description": "是否还有更多数据。" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WorkflowLogItemCn" - }, - "description": "当前页码的数据。" - } - } - }, - "WorkflowLogItemCn": { - "type": "object", - "description": "单条 Workflow 日志。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "标识。" - }, - "workflow_run": { - "$ref": "#/components/schemas/WorkflowRunSummaryCn", - "description": "Workflow 执行日志。" - }, - "created_from": { - "type": "string", - "description": "来源。" - }, - "created_by_role": { - "type": "string", - "description": "角色。" - }, - "created_by_account": { - "type": "string", - "format": "uuid", - "nullable": true, - "description": "（可选）帐号。" - }, - "created_by_end_user": { - "$ref": "#/components/schemas/EndUserSummaryCn", - "description": "用户。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "创建时间。" - } - } - }, - "WorkflowRunSummaryCn": { - "type": "object", - "description": "Workflow 执行摘要信息。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "标识。" - }, - "version": { - "type": "string", - "description": "版本。" - }, - "status": { - "type": "string", - "enum": [ - "running", - "succeeded", - "failed", - "stopped" - ], - "description": "执行状态。" - }, - "error": { - "type": "string", - "nullable": true, - "description": "（可选）错误。" - }, - "elapsed_time": { - "type": "number", - "format": "float", - "description": "耗时，单位秒。" - }, - "total_tokens": { - "type": "integer", - "description": "消耗的token数量。" - }, - "total_steps": { - "type": "integer", - "description": "执行步骤长度。" - }, - "created_at": { - "type": "integer", - "format": "int64", - "description": "开始时间。" - }, - "finished_at": { - "type": "integer", - "format": "int64", - "nullable": true, - "description": "结束时间。" - } + "id": { "type": "string", "format": "uuid", "description": "标识。" }, "version": { "type": "string", "description": "版本。" }, + "status": { "type": "string", "enum": ["running", "succeeded", "failed", "stopped"], "description": "执行状态。" }, + "error": { "type": "string", "nullable": true, "description": "（可选）错误。" }, + "elapsed_time": { "type": "number", "format": "float", "description": "耗时，单位秒。" }, + "total_tokens": { "type": "integer", "description": "消耗的token数量。" }, + "total_steps": { "type": "integer", "description": "执行步骤长度。" }, + "created_at": { "type": "integer", "format": "int64", "description": "开始时间。" }, + "finished_at": { "type": "integer", "format": "int64", "nullable": true, "description": "结束时间。" } } }, "EndUserSummaryCn": { - "type": "object", - "description": "终端用户信息摘要。", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "标识。" - }, - "type": { - "type": "string", - "description": "类型。" - }, - "is_anonymous": { - "type": "boolean", - "description": "是否匿名。" - }, - "session_id": { - "type": "string", - "description": "会话标识。" - } - } - }, - "AppInfoResponseCn": { - "type": "object", - "description": "应用基本信息。", - "properties": { - "name": { - "type": "string", - "description": "应用名称。" - }, - "description": { - "type": "string", - "description": "应用描述。" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - }, - "description": "应用标签。" - } - } - }, - "WorkflowAppParametersResponseCn": { - "type": "object", - "description": "Workflow 应用参数信息。", - "properties": { - "user_input_form": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserInputFormItemCn" - }, - "description": "用户输入表单配置。" - }, - "file_upload": { - "type": "object", - "properties": { - "image": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "number_limits": { - "type": "integer" - }, - "detail": { - "type": "string" - }, - "transfer_methods": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "remote_url", - "local_file" - ] - } - } - }, - "description": "图片设置。当前仅支持图片类型：png, jpg, jpeg, webp, gif。" - } - }, - "description": "文件上传配置。" - }, - "system_parameters": { - "type": "object", - "properties": { - "file_size_limit": { - "type": "integer", - "description": "文档上传大小限制 (MB)。" - }, - "image_file_size_limit": { - "type": "integer", - "description": "图片文件上传大小限制（MB）。" - }, - "audio_file_size_limit": { - "type": "integer", - "description": "音频文件上传大小限制 (MB)。" - }, - "video_file_size_limit": { - "type": "integer", - "description": "视频文件上传大小限制 (MB)。" - } - }, - "description": "系统参数。" - } - } - }, - "UserInputFormItemCn": { - "type": "object", - "description": "用户输入表单中的控件项。", - "oneOf": [ - { - "$ref": "#/components/schemas/TextInputControlWrapperCn" - }, - { - "$ref": "#/components/schemas/ParagraphControlWrapperCn" - }, - { - "$ref": "#/components/schemas/SelectControlWrapperCn" - } - ] - }, - "TextInputControlWrapperCn": { - "type": "object", + "type": "object", "description": "终端用户信息摘要。", "properties": { - "text-input": { - "$ref": "#/components/schemas/TextInputControlCn" - } - }, - "required": [ - "text-input" - ] - }, - "ParagraphControlWrapperCn": { - "type": "object", - "properties": { - "paragraph": { - "$ref": "#/components/schemas/ParagraphControlCn" - } - }, - "required": [ - "paragraph" - ] - }, - "SelectControlWrapperCn": { - "type": "object", - "properties": { - "select": { - "$ref": "#/components/schemas/SelectControlCn" - } - }, - "required": [ - "select" - ] - }, - "TextInputControlCn": { - "type": "object", - "description": "文本输入控件。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "默认值。" - } - } - }, - "ParagraphControlCn": { - "type": "object", - "description": "段落文本输入控件。", - "required": [ - "label", - "variable", - "required" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "默认值。" - } - } - }, - "SelectControlCn": { - "type": "object", - "description": "下拉控件。", - "required": [ - "label", - "variable", - "required", - "options" - ], - "properties": { - "label": { - "type": "string", - "description": "控件展示标签名。" - }, - "variable": { - "type": "string", - "description": "控件 ID。" - }, - "required": { - "type": "boolean", - "description": "是否必填。" - }, - "default": { - "type": "string", - "nullable": true, - "description": "默认值。" - }, - "options": { - "type": "array", - "items": { - "type": "string" - }, - "description": "选项值。" - } - } - }, - "WorkflowWebAppSettingsResponseCn": { - "type": "object", - "description": "Workflow 应用 WebApp 设置。", - "properties": { - "title": { - "type": "string", - "description": "WebApp 名称。" - }, - "icon_type": { - "type": "string", - "enum": [ - "emoji", - "image" - ], - "description": "图标类型。" - }, - "icon": { - "type": "string", - "description": "图标内容 (emoji 或图片 URL)。" - }, - "icon_background": { - "type": "string", - "description": "hex 格式的背景色。" - }, - "icon_url": { - "type": "string", - "format": "url", - "nullable": true, - "description": "图标 URL。" - }, - "description": { - "type": "string", - "description": "描述。" - }, - "copyright": { - "type": "string", - "description": "版权信息。" - }, - "privacy_policy": { - "type": "string", - "description": "隐私政策链接。" - }, - "custom_disclaimer": { - "type": "string", - "description": "自定义免责声明。" - }, - "default_language": { - "type": "string", - "description": "默认语言。" - }, - "show_workflow_steps": { - "type": "boolean", - "description": "是否显示工作流详情。" - } - } - }, - "ErrorResponseCn": { - "type": "object", - "description": "错误响应。", - "properties": { - "status": { - "type": "integer", - "nullable": true, - "description": "HTTP 状态码。" - }, - "code": { - "type": "string", - "nullable": true, - "description": "错误码。" - }, - "message": { - "type": "string", - "description": "错误消息。" - } - } - } + "id": { "type": "string", "format": "uuid", "description": "标识。" }, "type": { "type": "string", "description": "类型。" }, + "is_anonymous": { "type": "boolean", "description": "是否匿名。" }, "session_id": { "type": "string", "description": "会话标识。" } + } + }, + "AppInfoResponseCn": { "type": "object", "description": "应用基本信息。", "properties": { "name": { "type": "string", "description": "应用名称。" }, "description": { "type": "string", "description": "应用描述。" }, "tags": { "type": "array", "items": { "type": "string" }, "description": "应用标签。" } } }, + "WorkflowAppParametersResponseCn": { "type": "object", "description": "Workflow 应用参数信息。", "properties": { "user_input_form": { "type": "array", "items": { "$ref": "#/components/schemas/UserInputFormItemCn" }, "description": "用户输入表单配置。" }, "file_upload": { "type": "object", "properties": { "image": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "number_limits": { "type": "integer" }, "detail": { "type": "string" }, "transfer_methods": { "type": "array", "items": { "type": "string", "enum": ["remote_url", "local_file"] } } }, "description": "图片设置。当前仅支持图片类型：png, jpg, jpeg, webp, gif。" } }, "description": "文件上传配置。" }, "system_parameters": { "type": "object", "properties": { "file_size_limit": { "type": "integer", "description": "文档上传大小限制 (MB)。" }, "image_file_size_limit": { "type": "integer", "description": "图片文件上传大小限制（MB）。" }, "audio_file_size_limit": { "type": "integer", "description": "音频文件上传大小限制 (MB)。" }, "video_file_size_limit": { "type": "integer", "description": "视频文件上传大小限制 (MB)。" } }, "description": "系统参数。" } } }, + "UserInputFormItemCn": { "type": "object", "description": "用户输入表单中的控件项。", "oneOf": [ { "$ref": "#/components/schemas/TextInputControlWrapperCn" }, { "$ref": "#/components/schemas/ParagraphControlWrapperCn" }, { "$ref": "#/components/schemas/SelectControlWrapperCn" } ] }, + "TextInputControlWrapperCn": { "type": "object", "properties": { "text-input": { "$ref": "#/components/schemas/TextInputControlCn" } }, "required":["text-input"] }, + "ParagraphControlWrapperCn": { "type": "object", "properties": { "paragraph": { "$ref": "#/components/schemas/ParagraphControlCn" } }, "required":["paragraph"] }, + "SelectControlWrapperCn": { "type": "object", "properties": { "select": { "$ref": "#/components/schemas/SelectControlCn" } }, "required":["select"] }, + "TextInputControlCn": { "type": "object", "description": "文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, + "ParagraphControlCn": { "type": "object", "description": "段落文本输入控件。", "required": ["label", "variable", "required"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" } } }, + "SelectControlCn": { "type": "object", "description": "下拉控件。", "required": ["label", "variable", "required", "options"], "properties": { "label": { "type": "string", "description": "控件展示标签名。" }, "variable": { "type": "string", "description": "控件 ID。" }, "required": { "type": "boolean", "description": "是否必填。" }, "default": { "type": "string", "nullable": true, "description": "默认值。" }, "options": { "type": "array", "items": { "type": "string" }, "description": "选项值。" } } }, + "WorkflowWebAppSettingsResponseCn": { "type": "object", "description": "Workflow 应用 WebApp 设置。", "properties": { "title": { "type": "string", "description": "WebApp 名称。" }, "icon_type": { "type": "string", "enum": ["emoji", "image"], "description": "图标类型。" }, "icon": { "type": "string", "description": "图标内容 (emoji 或图片 URL)。" }, "icon_background": { "type": "string", "description": "hex 格式的背景色。" }, "icon_url": { "type": "string", "format": "url", "nullable": true, "description": "图标 URL。" }, "description": { "type": "string", "description": "描述。" }, "copyright": { "type": "string", "description": "版权信息。" }, "privacy_policy": { "type": "string", "description": "隐私政策链接。" }, "custom_disclaimer": { "type": "string", "description": "自定义免责声明。" }, "default_language": { "type": "string", "description": "默认语言。" }, "show_workflow_steps": { "type": "boolean", "description": "是否显示工作流详情。" } } }, + "ErrorResponseCn": { "type": "object", "description": "错误响应。", "properties": { "status": { "type": "integer", "nullable": true, "description": "HTTP 状态码。" }, "code": { "type": "string", "nullable": true, "description": "错误码。" }, "message": { "type": "string", "description": "错误消息。" } } } } }, "tags": [ - { - "name": "工作流执行", - "description": "与执行和管理工作流相关的操作。" - }, - { - "name": "文件操作 (工作流)", - "description": "特定于工作流的文件上传和预览操作。" - }, - { - "name": "终端用户", - "description": "终端用户信息相关的操作。" - }, - { - "name": "应用配置 (Workflow)", - "description": "工作流应用的应用设置和信息。" - } + { "name": "工作流执行", "description": "与执行和管理工作流相关的操作。" }, + { "name": "文件操作 (工作流)", "description": "特定于工作流的文件上传和预览操作。" }, + { "name": "终端用户", "description": "终端用户信息相关的操作。" }, + { "name": "应用配置 (Workflow)", "description": "工作流应用的应用设置和信息。" } ] -} +} \ No newline at end of file From 747f360e6e14d7ca9ce63b8379aad5447d82312b Mon Sep 17 00:00:00 2001 From: RiskeyL <7a8y@163.com> Date: Mon, 16 Mar 2026 15:18:46 +0800 Subject: [PATCH 10/10] remove all enterprise versions --- docs.json | 6329 +++++------------------------------------------------ 1 file changed, 527 insertions(+), 5802 deletions(-) diff --git a/docs.json b/docs.json index 20ffd98f6..7a42b53e1 100644 --- a/docs.json +++ b/docs.json @@ -405,6064 +405,789 @@ } ], "default": true - }, + } + ] + }, + { + "language": "zh", + "versions": [ { - "version": "3.7.x (Enterprise)", - "groups": [ + "version": "Latest", + "dropdowns": [ { - "group": "User Guide", + "dropdown": "使用 Dify", + "icon": "book-open", "pages": [ - "versions/3-7-x/en/user-guide/introduction", - { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema", - "versions/3-5-x/en/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/en/user-guide/model-configuration/load-balancing" - ] - }, { - "group": "Application Orchestration", + "group": " ", "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", { - "group": "Application Toolkits", + "group": "入门", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" + "zh/use-dify/getting-started/introduction", + "zh/use-dify/getting-started/quick-start", + "zh/use-dify/getting-started/key-concepts" ] - } - ] - }, - { - "group": "Workflow", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", + }, { - "group": "Node Description", + "group": "节点", + "expanded": false, "pages": [ - "versions/3-7-x/en/user-guide/workflow/node/user-input", + "zh/use-dify/nodes/user-input", { - "group": "Trigger", + "group": "触发器", + "icon": "bolt-lightning", "pages": [ - "versions/3-7-x/en/user-guide/workflow/node/trigger/overview", - "versions/3-7-x/en/user-guide/workflow/node/trigger/schedule-trigger", - "versions/3-7-x/en/user-guide/workflow/node/trigger/plugin-trigger", - "versions/3-7-x/en/user-guide/workflow/node/trigger/webhook-trigger" + "zh/use-dify/nodes/trigger/overview", + "zh/use-dify/nodes/trigger/schedule-trigger", + "zh/use-dify/nodes/trigger/plugin-trigger", + "zh/use-dify/nodes/trigger/webhook-trigger" ] }, - "versions/3-7-x/en/user-guide/workflow/node/output", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-7-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" + "zh/use-dify/nodes/llm", + "zh/use-dify/nodes/knowledge-retrieval", + "zh/use-dify/nodes/answer", + "zh/use-dify/nodes/output", + "zh/use-dify/nodes/agent", + "zh/use-dify/nodes/question-classifier", + "zh/use-dify/nodes/ifelse", + "zh/use-dify/nodes/human-input", + "zh/use-dify/nodes/iteration", + "zh/use-dify/nodes/loop", + "zh/use-dify/nodes/code", + "zh/use-dify/nodes/template", + "zh/use-dify/nodes/variable-aggregator", + "zh/use-dify/nodes/doc-extractor", + "zh/use-dify/nodes/variable-assigner", + "zh/use-dify/nodes/parameter-extractor", + "zh/use-dify/nodes/http-request", + "zh/use-dify/nodes/list-operator", + "zh/use-dify/nodes/tools" ] }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", { - "group": "Error Handling", + "group": "构建", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" + "zh/use-dify/build/shortcut-key", + "zh/use-dify/build/goto-anything", + "zh/use-dify/build/orchestrate-node", + "zh/use-dify/build/predefined-error-handling-logic", + "zh/use-dify/build/mcp", + "zh/use-dify/build/version-control", + "zh/use-dify/build/additional-features" ] }, - "versions/3-0-x/en/user-guide/workflow/additional-features", { - "group": "Debug and Preview", + "group": "调试", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" + "zh/use-dify/debug/step-run", + "zh/use-dify/debug/variable-inspect", + "zh/use-dify/debug/history-and-logs", + "zh/use-dify/debug/error-type" ] }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" - ] - }, - { - "group": "Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", { - "group": "Create Knowledge", + "group": "发布", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", + "zh/use-dify/publish/README", { - "group": "1. Import Text Data", + "group": "Web App", + "icon": "globe", "pages": [ - "versions/3-7-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" + "zh/use-dify/publish/webapp/workflow-webapp", + "zh/use-dify/publish/webapp/chatflow-webapp", + "zh/use-dify/publish/webapp/web-app-settings", + "zh/use-dify/publish/webapp/web-app-access", + "zh/use-dify/publish/webapp/embedding-in-websites" ] }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-7-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Create from Knowledge Pipeline", - "pages": [ - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/readme", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", - "versions/3-7-x/en/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/upload-files", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" + "zh/use-dify/publish/publish-mcp", + "zh/use-dify/publish/developing-with-apis", + "zh/use-dify/publish/publish-to-marketplace" ] }, { - "group": "Manage Knowledge", + "group": "监控", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-7-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + "zh/use-dify/monitor/analysis", + "zh/use-dify/monitor/logs", + "zh/use-dify/monitor/annotation-reply", + { + "group": "集成", + "icon": "grid-2-plus", + "pages": [ + "zh/use-dify/monitor/integrations/integrate-langsmith", + "zh/use-dify/monitor/integrations/integrate-langfuse", + "zh/use-dify/monitor/integrations/integrate-opik", + "zh/use-dify/monitor/integrations/integrate-weave", + "zh/use-dify/monitor/integrations/integrate-arize", + "zh/use-dify/monitor/integrations/integrate-phoenix", + "zh/use-dify/monitor/integrations/integrate-aliyun" + ] + } ] }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" - ] - }, - { - "group": "Tools", - "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" - ] - }, - { - "group": "Publishing", - "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", { - "group": "Publish as a Single-page Web App", + "group": "知识库", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "zh/use-dify/knowledge/readme", + { + "group": "创建知识库", + "icon": "square-plus", + "pages": [ + { + "group": "快速创建", + "pages": [ + "zh/use-dify/knowledge/create-knowledge/introduction", + { + "group": "导入数据", + "pages": [ + "zh/use-dify/knowledge/create-knowledge/import-text-data/readme", + "zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion", + "zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website" + ] + }, + "zh/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text", + "zh/use-dify/knowledge/create-knowledge/setting-indexing-methods" + ] + }, + { + "group": "通过知识流水线创建", + "pages": [ + "zh/use-dify/knowledge/knowledge-pipeline/readme", + "zh/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline", + "zh/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration", + "zh/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline", + "zh/use-dify/knowledge/knowledge-pipeline/upload-files", + "zh/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base", + "zh/use-dify/knowledge/knowledge-pipeline/authorize-data-source" + ] + }, + { + "group": "连接外部知识库", + "pages": [ + "zh/use-dify/knowledge/connect-external-knowledge-base", + "zh/use-dify/knowledge/external-knowledge-api" + ] + } + ] + }, + { + "group": "管理知识库", + "icon": "gear", + "pages": [ + "zh/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents", + "zh/use-dify/knowledge/manage-knowledge/introduction", + "zh/use-dify/knowledge/metadata", + "zh/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api" + ] + }, + "zh/use-dify/knowledge/test-retrieval", + "zh/use-dify/knowledge/integrate-knowledge-within-application", + "zh/use-dify/knowledge/knowledge-request-rate-limit" ] }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - }, - { - "group": "Extensions", - "pages": [ { - "group": "API-Based Extension", + "group": "工作区", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + "zh/use-dify/workspace/readme", + "zh/use-dify/workspace/model-providers", + "zh/use-dify/workspace/plugins", + "zh/use-dify/workspace/app-management", + "zh/use-dify/workspace/team-members-management", + "zh/use-dify/workspace/personal-account-management", + "zh/use-dify/workspace/subscription-management", + { + "group": "API 扩展", + "icon": "puzzle-piece-simple", + "pages": [ + "zh/use-dify/workspace/api-extension/api-extension", + "zh/use-dify/workspace/api-extension/external-data-tool-api-extension", + "zh/use-dify/workspace/api-extension/moderation-api-extension", + "zh/use-dify/workspace/api-extension/cloudflare-worker" + ] + } ] }, { - "group": "Code-Based Extension", + "group": "教程", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + "zh/use-dify/tutorials/simple-chatbot", + "zh/use-dify/tutorials/twitter-chatflow", + "zh/use-dify/tutorials/customer-service-bot", + "zh/use-dify/tutorials/build-ai-image-generation-app", + "zh/use-dify/tutorials/article-reader" ] } ] - }, - { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] } ] - } - ] - }, - { - "version": "3.6.x (Enterprise)", - "groups": [ + }, { - "group": "User Guide", + "dropdown": "自托管", + "icon": "server", "pages": [ - "versions/3-6-x/en/user-guide/introduction", { - "group": "Model Configuration", + "group": "快速开始", "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema", - "versions/3-5-x/en/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/en/user-guide/model-configuration/load-balancing" + "zh/self-host/quick-start/docker-compose", + "zh/self-host/quick-start/faqs" ] }, { - "group": "Application Orchestration", + "group": "进阶部署", "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } + "zh/self-host/advanced-deployments/local-source-code", + "zh/self-host/advanced-deployments/start-the-frontend-docker-container" ] }, { - "group": "Workflow", + "group": "配置", "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", - { - "group": "Debug and Preview", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" + "zh/self-host/configuration/environments" ] }, { - "group": "Knowledge", + "group": "平台指南", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", - { - "group": "Create Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. Import Text Data", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Create from Knowledge Pipeline", - "pages": [ - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/readme", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/upload-files", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", - "versions/3-6-x/en/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" - ] - }, - { - "group": "Manage Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" + "zh/self-host/platform-guides/bt-panel", + "zh/self-host/platform-guides/dify-premium" ] }, { - "group": "Tools", + "group": "故障排除", "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" + "zh/self-host/troubleshooting/common-issues", + "zh/self-host/troubleshooting/docker-issues", + "zh/self-host/troubleshooting/integrations", + "zh/self-host/troubleshooting/storage-and-migration", + "zh/self-host/troubleshooting/weaviate-v4-migration" ] - }, + } + ] + }, + { + "dropdown": "API 文档", + "icon": "code", + "groups": [ { - "group": "Publishing", - "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] + "group": "Chatbot 和 Agent", + "openapi": "zh/api-reference/openapi_chat.json" }, { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" - ] + "group": "Chatflow", + "openapi": "zh/api-reference/openapi_chatflow.json" }, { - "group": "Monitoring", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] + "group": "工作流", + "openapi": "zh/api-reference/openapi_workflow.json" }, { - "group": "Extensions", - "pages": [ - { - "group": "API-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" - ] - }, - { - "group": "Code-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" - ] - } - ] + "group": "知识库", + "openapi": "zh/api-reference/openapi_knowledge.json" }, { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] + "group": "文本生成", + "openapi": "zh/api-reference/openapi_completion.json" } ] - } - ] - }, - { - "version": "3.5.x (Enterprise)", - "groups": [ + }, { - "group": "User Guide", - "pages": [ - "versions/3-5-x/en/user-guide/introduction", - { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema", - "versions/3-5-x/en/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/en/user-guide/model-configuration/load-balancing" - ] - }, + "dropdown": "开发插件", + "icon": "code-pull-request", + "groups": [ { - "group": "Application Orchestration", + "group": "快速开始", "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } + "zh/develop-plugin/getting-started/getting-started-dify-plugin", + "zh/develop-plugin/getting-started/cli" ] }, { - "group": "Workflow", + "group": "特性与规范", "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", { - "group": "Debug and Preview", + "group": "插件类型", "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" + "zh/develop-plugin/features-and-specs/plugin-types/general-specifications", + "zh/develop-plugin/features-and-specs/plugin-types/model-designing-rules", + "zh/develop-plugin/features-and-specs/plugin-types/model-schema", + "zh/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv", + "zh/develop-plugin/features-and-specs/plugin-types/tool", + "zh/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest", + "zh/develop-plugin/features-and-specs/plugin-types/multilingual-readme", + "zh/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin", + "zh/develop-plugin/features-and-specs/plugin-types/plugin-logging" ] }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" - ] - }, - { - "group": "Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", { - "group": "Create Knowledge", + "group": "高级开发", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", { - "group": "1. Import Text Data", + "group": "反向调用", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" + "zh/develop-plugin/features-and-specs/advanced-development/bundle", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool", + "zh/develop-plugin/features-and-specs/advanced-development/customizable-model", + "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node" ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Manage Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + } ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" + } ] }, { - "group": "Tools", + "group": "开发指南与示例", "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" + "zh/develop-plugin/dev-guides-and-walkthroughs/cheatsheet", + "zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/tool-oauth", + "zh/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider", + "zh/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/endpoint", + "zh/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin", + "zh/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter", + "zh/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool" ] }, { - "group": "Publishing", + "group": "发布", "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", { - "group": "Publish as a Single-page Web App", + "group": "标准", "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "zh/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct", + "zh/develop-plugin/publishing/standards/privacy-protection-guidelines", + "zh/develop-plugin/publishing/standards/third-party-signature-verification" ] }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - }, - { - "group": "Extensions", - "pages": [ { - "group": "API-Based Extension", + "group": "上架插件市场", "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" + "zh/develop-plugin/publishing/marketplace-listing/plugin-auto-publish-pr", + "zh/develop-plugin/publishing/marketplace-listing/release-overview", + "zh/develop-plugin/publishing/marketplace-listing/release-by-file", + "zh/develop-plugin/publishing/marketplace-listing/release-to-dify-marketplace", + "zh/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo" ] }, { - "group": "Code-Based Extension", + "group": "常见问题", "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" + "zh/develop-plugin/publishing/faq/faq" ] } ] - }, - { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] } ] } - ] - }, + ], + "default": true + } + ] + }, + { + "language": "ja", + "versions": [ { - "version": "3.4.x (Enterprise)", - "groups": [ + "version": "Latest", + "dropdowns": [ { - "group": "User Guide", + "dropdown": "Dify を使う", + "icon": "book-open", "pages": [ - "versions/3-4-x/en/user-guide/introduction", - { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, { - "group": "Workflow", + "group": " ", "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", { - "group": "Debug and Preview", + "group": "はじめに", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" + "ja/use-dify/getting-started/introduction", + "ja/use-dify/getting-started/quick-start", + "ja/use-dify/getting-started/key-concepts" ] }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" - ] - }, - { - "group": "Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", { - "group": "Create Knowledge", + "group": "ノード", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", + "ja/use-dify/nodes/user-input", { - "group": "1. Import Text Data", + "group": "トリガー", + "icon": "bolt-lightning", "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" + "ja/use-dify/nodes/trigger/overview", + "ja/use-dify/nodes/trigger/schedule-trigger", + "ja/use-dify/nodes/trigger/plugin-trigger", + "ja/use-dify/nodes/trigger/webhook-trigger" ] }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" + "ja/use-dify/nodes/llm", + "ja/use-dify/nodes/knowledge-retrieval", + "ja/use-dify/nodes/answer", + "ja/use-dify/nodes/output", + "ja/use-dify/nodes/agent", + "ja/use-dify/nodes/question-classifier", + "ja/use-dify/nodes/ifelse", + "ja/use-dify/nodes/human-input", + "ja/use-dify/nodes/iteration", + "ja/use-dify/nodes/loop", + "ja/use-dify/nodes/code", + "ja/use-dify/nodes/template", + "ja/use-dify/nodes/variable-aggregator", + "ja/use-dify/nodes/doc-extractor", + "ja/use-dify/nodes/variable-assigner", + "ja/use-dify/nodes/parameter-extractor", + "ja/use-dify/nodes/http-request", + "ja/use-dify/nodes/list-operator", + "ja/use-dify/nodes/tools" ] }, { - "group": "Manage Knowledge", + "group": "ビルド", + "expanded": false, "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" + "ja/use-dify/build/shortcut-key", + "ja/use-dify/build/goto-anything", + "ja/use-dify/build/orchestrate-node", + "ja/use-dify/build/predefined-error-handling-logic", + "ja/use-dify/build/mcp", + "ja/use-dify/build/version-control", + "ja/use-dify/build/additional-features" ] }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" - ] - }, - { - "group": "Tools", - "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" - ] - }, - { - "group": "Publishing", - "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - }, - { - "group": "Extensions", - "pages": [ - { - "group": "API-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" - ] - }, - { - "group": "Code-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" - ] - } - ] - }, - { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "3.3.x (Enterprise)", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/3-3-x/en/user-guide/introduction", - { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "Workflow", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", - { - "group": "Debug and Preview", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" - ] - }, - { - "group": "Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", - { - "group": "Create Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. Import Text Data", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Manage Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" - ] - }, - { - "group": "Tools", - "pages": [ - "versions/3-3-x/en/user-guide/tools/mcp" - ] - }, - { - "group": "Publishing", - "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - "versions/3-3-x/en/user-guide/application-publishing/publish-mcp", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - }, - { - "group": "Extensions", - "pages": [ - { - "group": "API-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" - ] - }, - { - "group": "Code-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" - ] - } - ] - }, - { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "3.2.x (Enterprise)", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/3-2-x/en/user-guide/introduction", - { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema", - "versions/3-0-x/en/user-guide/model-configuration/manage-model-credential" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "Workflow", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", - { - "group": "Debug and Preview", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/en/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" - ] - }, - { - "group": "Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", - { - "group": "Create Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. Import Text Data", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Manage Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" - ] - }, - { - "group": "Publishing", - "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - }, - { - "group": "Extensions", - "pages": [ - { - "group": "API-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" - ] - }, - { - "group": "Code-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" - ] - } - ] - }, - { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "3.0.x (Enterprise)", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/3-0-x/en/user-guide/introduction", - { - "group": "Model Configuration", - "pages": [ - "versions/3-0-x/en/user-guide/model-configuration/readme", - "versions/3-0-x/en/user-guide/model-configuration/new-provider", - "versions/3-0-x/en/user-guide/model-configuration/predefined-model", - "versions/3-0-x/en/user-guide/model-configuration/customizable-model", - "versions/3-0-x/en/user-guide/model-configuration/interfaces", - "versions/3-0-x/en/user-guide/model-configuration/schema" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/creating-an-application", - "versions/3-0-x/en/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/en/user-guide/application-orchestrate/multiple-llms-debugging", - "versions/3-0-x/en/user-guide/application-orchestrate/text-generator", - "versions/3-0-x/en/user-guide/application-orchestrate/agent", - { - "group": "Application Toolkits", - "pages": [ - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/en/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "Workflow", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/README", - "versions/3-0-x/en/user-guide/workflow/key-concepts", - "versions/3-0-x/en/user-guide/workflow/variables", - { - "group": "Node Description", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/node/start", - "versions/3-0-x/en/user-guide/workflow/node/end", - "versions/3-0-x/en/user-guide/workflow/node/answer", - "versions/3-0-x/en/user-guide/workflow/node/llm", - "versions/3-0-x/en/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/en/user-guide/workflow/node/question-classifier", - "versions/3-0-x/en/user-guide/workflow/node/ifelse", - "versions/3-0-x/en/user-guide/workflow/node/code", - "versions/3-0-x/en/user-guide/workflow/node/template", - "versions/3-0-x/en/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/en/user-guide/workflow/node/list-operator", - "versions/3-0-x/en/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/en/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/en/user-guide/workflow/node/iteration", - "versions/3-0-x/en/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/en/user-guide/workflow/node/http-request", - "versions/3-0-x/en/user-guide/workflow/node/agent", - "versions/3-0-x/en/user-guide/workflow/node/tools", - "versions/3-0-x/en/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/en/user-guide/workflow/shortcut-key", - "versions/3-0-x/en/user-guide/workflow/orchestrate-node", - "versions/3-0-x/en/user-guide/workflow/file-upload", - { - "group": "Error Handling", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/error-handling/README", - "versions/3-0-x/en/user-guide/workflow/error-handling/predefined-error-handling-logic", - "versions/3-0-x/en/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/en/user-guide/workflow/additional-features", - { - "group": "Debug and Preview", - "pages": [ - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/en/user-guide/workflow/debug-and-preview/history" - ] - }, - "versions/3-0-x/en/user-guide/workflow/publish", - "versions/3-0-x/en/user-guide/workflow/structured-outputs" - ] - }, - { - "group": "Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/readme", - { - "group": "Create Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. Import Text Data", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/en/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "Manage Knowledge", - "pages": [ - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/en/user-guide/knowledge-base/metadata", - "versions/3-0-x/en/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/en/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/en/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/en/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/en/user-guide/knowledge-base/external-knowledge-api" - ] - }, - { - "group": "Publishing", - "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/README", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/en/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/en/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Annotation", - "pages": [ - "versions/3-0-x/en/user-guide/annotation/logs", - "versions/3-0-x/en/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/README", - "versions/3-0-x/en/user-guide/monitoring/analysis", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/README", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/en/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - }, - { - "group": "Extensions", - "pages": [ - { - "group": "API-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/api-based-extension/README", - "versions/3-0-x/en/user-guide/extension/api-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/api-based-extension/cloudflare-workers", - "versions/3-0-x/en/user-guide/extension/api-based-extension/moderation" - ] - }, - { - "group": "Code-Based Extension", - "pages": [ - "versions/3-0-x/en/user-guide/extension/code-based-extension/README", - "versions/3-0-x/en/user-guide/extension/code-based-extension/external-data-tool", - "versions/3-0-x/en/user-guide/extension/code-based-extension/moderation" - ] - } - ] - }, - { - "group": "Management", - "pages": [ - "versions/3-0-x/en/user-guide/management/app-management", - "versions/3-0-x/en/user-guide/management/team-members-management", - "versions/3-0-x/en/user-guide/management/personal-account-management", - "versions/3-0-x/en/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "2.8.x (Enterprise)", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/legacy/en/user-guide/welcome", - { - "group": "Model", - "pages": [ - "versions/legacy/en/user-guide/models/model-configuration", - "versions/legacy/en/user-guide/models/new-provider", - "versions/legacy/en/user-guide/models/predefined-model", - "versions/legacy/en/user-guide/models/customizable-model", - "versions/legacy/en/user-guide/models/interfaces", - "versions/legacy/en/user-guide/models/schema", - "versions/legacy/en/user-guide/models/load-balancing" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/legacy/en/user-guide/build-app/chatbot", - "versions/legacy/en/user-guide/build-app/text-generator", - "versions/legacy/en/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/concepts", - "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/en/user-guide/build-app/flow-app/variables", - { - "group": "Nodes", - "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", - "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/en/user-guide/build-app/flow-app/file-upload", - "versions/legacy/en/user-guide/build-app/flow-app/additional-features" - ] - } - ] - }, - { - "group": "Debug and Preview", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] - }, - { - "group": "Application Publishing", - "pages": [ - "versions/2-8-x/en/user-guide/application-publishing/permission-management", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/en/user-guide/application-publishing/developing-with-apis", - "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Management", - "pages": [ - "versions/legacy/en/user-guide/management/app-management", - "versions/legacy/en/user-guide/management/team-members-management", - "versions/legacy/en/user-guide/management/personal-account-management" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/legacy/en/user-guide/monitoring/analysis", - "versions/legacy/en/user-guide/monitoring/logs", - "versions/legacy/en/user-guide/monitoring/annotation-reply", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" - ] - } - ] - } - ] - } - ] - }, - { - "version": "2.7.x (Enterprise)", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/legacy/en/user-guide/welcome", - { - "group": "Model", - "pages": [ - "versions/legacy/en/user-guide/models/model-configuration", - "versions/legacy/en/user-guide/models/new-provider", - "versions/legacy/en/user-guide/models/predefined-model", - "versions/legacy/en/user-guide/models/customizable-model", - "versions/legacy/en/user-guide/models/interfaces", - "versions/legacy/en/user-guide/models/schema", - "versions/legacy/en/user-guide/models/load-balancing" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/legacy/en/user-guide/build-app/chatbot", - "versions/legacy/en/user-guide/build-app/text-generator", - "versions/legacy/en/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/concepts", - "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/en/user-guide/build-app/flow-app/variables", - { - "group": "Nodes", - "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", - "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/en/user-guide/build-app/flow-app/file-upload", - "versions/legacy/en/user-guide/build-app/flow-app/additional-features" - ] - } - ] - }, - { - "group": "Debug and Preview", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] - }, - { - "group": "Application Publishing", - "pages": [ - "versions/legacy/en/user-guide/application-publishing/permission-management", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/en/user-guide/application-publishing/developing-with-apis", - "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Management", - "pages": [ - "versions/legacy/en/user-guide/management/app-management", - "versions/legacy/en/user-guide/management/team-members-management", - "versions/legacy/en/user-guide/management/personal-account-management" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/legacy/en/user-guide/monitoring/analysis", - "versions/legacy/en/user-guide/monitoring/logs", - "versions/legacy/en/user-guide/monitoring/annotation-reply", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" - ] - } - ] - } - ] - } - ] - }, - { - "version": "2.6.x (Enterprise)", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/legacy/en/user-guide/welcome", - { - "group": "Model", - "pages": [ - "versions/legacy/en/user-guide/models/model-configuration", - "versions/legacy/en/user-guide/models/new-provider", - "versions/legacy/en/user-guide/models/predefined-model", - "versions/legacy/en/user-guide/models/customizable-model", - "versions/legacy/en/user-guide/models/interfaces", - "versions/legacy/en/user-guide/models/schema", - "versions/legacy/en/user-guide/models/load-balancing" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/legacy/en/user-guide/build-app/chatbot", - "versions/legacy/en/user-guide/build-app/text-generator", - "versions/legacy/en/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/concepts", - "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/en/user-guide/build-app/flow-app/variables", - { - "group": "Nodes", - "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", - "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/en/user-guide/build-app/flow-app/file-upload", - "versions/legacy/en/user-guide/build-app/flow-app/additional-features" - ] - } - ] - }, - { - "group": "Debug and Preview", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] - }, - { - "group": "Application Publishing", - "pages": [ - "versions/legacy/en/user-guide/application-publishing/permission-management", - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/en/user-guide/application-publishing/developing-with-apis", - "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Management", - "pages": [ - "versions/legacy/en/user-guide/management/app-management", - "versions/legacy/en/user-guide/management/team-members-management", - "versions/legacy/en/user-guide/management/personal-account-management" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/legacy/en/user-guide/monitoring/analysis", - "versions/legacy/en/user-guide/monitoring/logs", - "versions/legacy/en/user-guide/monitoring/annotation-reply", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" - ] - } - ] - } - ] - } - ] - }, - { - "version": "2.5.x (Enterprise)", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/legacy/en/user-guide/welcome", - { - "group": "Model", - "pages": [ - "versions/legacy/en/user-guide/models/model-configuration", - "versions/legacy/en/user-guide/models/new-provider", - "versions/legacy/en/user-guide/models/predefined-model", - "versions/legacy/en/user-guide/models/customizable-model", - "versions/legacy/en/user-guide/models/interfaces", - "versions/legacy/en/user-guide/models/schema", - "versions/legacy/en/user-guide/models/load-balancing" - ] - }, - { - "group": "Application Orchestration", - "pages": [ - "versions/legacy/en/user-guide/build-app/chatbot", - "versions/legacy/en/user-guide/build-app/text-generator", - "versions/legacy/en/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/concepts", - "versions/legacy/en/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/en/user-guide/build-app/flow-app/variables", - { - "group": "Nodes", - "pages": [ - "versions/legacy/en/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/en/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/en/user-guide/build-app/flow-app/shotcut-key", - "versions/legacy/en/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/en/user-guide/build-app/flow-app/file-upload", - "versions/legacy/en/user-guide/build-app/flow-app/additional-features" - ] - } - ] - }, - { - "group": "Debug and Preview", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/en/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] - }, - { - "group": "Application Publishing", - "pages": [ - { - "group": "Publish as a Single-page Web App", - "pages": [ - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/en/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/en/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/en/user-guide/application-publishing/developing-with-apis", - "versions/legacy/en/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "Management", - "pages": [ - "versions/legacy/en/user-guide/management/app-management", - "versions/legacy/en/user-guide/management/team-members-management", - "versions/legacy/en/user-guide/management/personal-account-management" - ] - }, - { - "group": "Monitoring", - "pages": [ - "versions/legacy/en/user-guide/monitoring/analysis", - "versions/legacy/en/user-guide/monitoring/logs", - "versions/legacy/en/user-guide/monitoring/annotation-reply", - { - "group": "Integrate External Ops Tools", - "pages": [ - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/en/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "language": "zh", - "versions": [ - { - "version": "Latest", - "dropdowns": [ - { - "dropdown": "使用 Dify", - "icon": "book-open", - "pages": [ - { - "group": " ", - "pages": [ - { - "group": "入门", - "expanded": false, - "pages": [ - "zh/use-dify/getting-started/introduction", - "zh/use-dify/getting-started/quick-start", - "zh/use-dify/getting-started/key-concepts" - ] - }, - { - "group": "节点", - "expanded": false, - "pages": [ - "zh/use-dify/nodes/user-input", - { - "group": "触发器", - "icon": "bolt-lightning", - "pages": [ - "zh/use-dify/nodes/trigger/overview", - "zh/use-dify/nodes/trigger/schedule-trigger", - "zh/use-dify/nodes/trigger/plugin-trigger", - "zh/use-dify/nodes/trigger/webhook-trigger" - ] - }, - "zh/use-dify/nodes/llm", - "zh/use-dify/nodes/knowledge-retrieval", - "zh/use-dify/nodes/answer", - "zh/use-dify/nodes/output", - "zh/use-dify/nodes/agent", - "zh/use-dify/nodes/question-classifier", - "zh/use-dify/nodes/ifelse", - "zh/use-dify/nodes/human-input", - "zh/use-dify/nodes/iteration", - "zh/use-dify/nodes/loop", - "zh/use-dify/nodes/code", - "zh/use-dify/nodes/template", - "zh/use-dify/nodes/variable-aggregator", - "zh/use-dify/nodes/doc-extractor", - "zh/use-dify/nodes/variable-assigner", - "zh/use-dify/nodes/parameter-extractor", - "zh/use-dify/nodes/http-request", - "zh/use-dify/nodes/list-operator", - "zh/use-dify/nodes/tools" - ] - }, - { - "group": "构建", - "expanded": false, - "pages": [ - "zh/use-dify/build/shortcut-key", - "zh/use-dify/build/goto-anything", - "zh/use-dify/build/orchestrate-node", - "zh/use-dify/build/predefined-error-handling-logic", - "zh/use-dify/build/mcp", - "zh/use-dify/build/version-control", - "zh/use-dify/build/additional-features" - ] - }, - { - "group": "调试", - "expanded": false, - "pages": [ - "zh/use-dify/debug/step-run", - "zh/use-dify/debug/variable-inspect", - "zh/use-dify/debug/history-and-logs", - "zh/use-dify/debug/error-type" - ] - }, - { - "group": "发布", - "expanded": false, - "pages": [ - "zh/use-dify/publish/README", - { - "group": "Web App", - "icon": "globe", - "pages": [ - "zh/use-dify/publish/webapp/workflow-webapp", - "zh/use-dify/publish/webapp/chatflow-webapp", - "zh/use-dify/publish/webapp/web-app-settings", - "zh/use-dify/publish/webapp/web-app-access", - "zh/use-dify/publish/webapp/embedding-in-websites" - ] - }, - "zh/use-dify/publish/publish-mcp", - "zh/use-dify/publish/developing-with-apis", - "zh/use-dify/publish/publish-to-marketplace" - ] - }, - { - "group": "监控", - "expanded": false, - "pages": [ - "zh/use-dify/monitor/analysis", - "zh/use-dify/monitor/logs", - "zh/use-dify/monitor/annotation-reply", - { - "group": "集成", - "icon": "grid-2-plus", - "pages": [ - "zh/use-dify/monitor/integrations/integrate-langsmith", - "zh/use-dify/monitor/integrations/integrate-langfuse", - "zh/use-dify/monitor/integrations/integrate-opik", - "zh/use-dify/monitor/integrations/integrate-weave", - "zh/use-dify/monitor/integrations/integrate-arize", - "zh/use-dify/monitor/integrations/integrate-phoenix", - "zh/use-dify/monitor/integrations/integrate-aliyun" - ] - } - ] - }, - { - "group": "知识库", - "expanded": false, - "pages": [ - "zh/use-dify/knowledge/readme", - { - "group": "创建知识库", - "icon": "square-plus", - "pages": [ - { - "group": "快速创建", - "pages": [ - "zh/use-dify/knowledge/create-knowledge/introduction", - { - "group": "导入数据", - "pages": [ - "zh/use-dify/knowledge/create-knowledge/import-text-data/readme", - "zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion", - "zh/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website" - ] - }, - "zh/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text", - "zh/use-dify/knowledge/create-knowledge/setting-indexing-methods" - ] - }, - { - "group": "通过知识流水线创建", - "pages": [ - "zh/use-dify/knowledge/knowledge-pipeline/readme", - "zh/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline", - "zh/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration", - "zh/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline", - "zh/use-dify/knowledge/knowledge-pipeline/upload-files", - "zh/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base", - "zh/use-dify/knowledge/knowledge-pipeline/authorize-data-source" - ] - }, - { - "group": "连接外部知识库", - "pages": [ - "zh/use-dify/knowledge/connect-external-knowledge-base", - "zh/use-dify/knowledge/external-knowledge-api" - ] - } - ] - }, - { - "group": "管理知识库", - "icon": "gear", - "pages": [ - "zh/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents", - "zh/use-dify/knowledge/manage-knowledge/introduction", - "zh/use-dify/knowledge/metadata", - "zh/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api" - ] - }, - "zh/use-dify/knowledge/test-retrieval", - "zh/use-dify/knowledge/integrate-knowledge-within-application", - "zh/use-dify/knowledge/knowledge-request-rate-limit" - ] - }, - { - "group": "工作区", - "expanded": false, - "pages": [ - "zh/use-dify/workspace/readme", - "zh/use-dify/workspace/model-providers", - "zh/use-dify/workspace/plugins", - "zh/use-dify/workspace/app-management", - "zh/use-dify/workspace/team-members-management", - "zh/use-dify/workspace/personal-account-management", - "zh/use-dify/workspace/subscription-management", - { - "group": "API 扩展", - "icon": "puzzle-piece-simple", - "pages": [ - "zh/use-dify/workspace/api-extension/api-extension", - "zh/use-dify/workspace/api-extension/external-data-tool-api-extension", - "zh/use-dify/workspace/api-extension/moderation-api-extension", - "zh/use-dify/workspace/api-extension/cloudflare-worker" - ] - } - ] - }, - { - "group": "教程", - "expanded": false, - "pages": [ - "zh/use-dify/tutorials/simple-chatbot", - "zh/use-dify/tutorials/twitter-chatflow", - "zh/use-dify/tutorials/customer-service-bot", - "zh/use-dify/tutorials/build-ai-image-generation-app", - "zh/use-dify/tutorials/article-reader" - ] - } - ] - } - ] - }, - { - "dropdown": "自托管", - "icon": "server", - "pages": [ - { - "group": "快速开始", - "pages": [ - "zh/self-host/quick-start/docker-compose", - "zh/self-host/quick-start/faqs" - ] - }, - { - "group": "进阶部署", - "pages": [ - "zh/self-host/advanced-deployments/local-source-code", - "zh/self-host/advanced-deployments/start-the-frontend-docker-container" - ] - }, - { - "group": "配置", - "pages": [ - "zh/self-host/configuration/environments" - ] - }, - { - "group": "平台指南", - "pages": [ - "zh/self-host/platform-guides/bt-panel", - "zh/self-host/platform-guides/dify-premium" - ] - }, - { - "group": "故障排除", - "pages": [ - "zh/self-host/troubleshooting/common-issues", - "zh/self-host/troubleshooting/docker-issues", - "zh/self-host/troubleshooting/integrations", - "zh/self-host/troubleshooting/storage-and-migration", - "zh/self-host/troubleshooting/weaviate-v4-migration" - ] - } - ] - }, - { - "dropdown": "API 文档", - "icon": "code", - "groups": [ - { - "group": "Chatbot 和 Agent", - "openapi": "zh/api-reference/openapi_chat.json" - }, - { - "group": "Chatflow", - "openapi": "zh/api-reference/openapi_chatflow.json" - }, - { - "group": "工作流", - "openapi": "zh/api-reference/openapi_workflow.json" - }, - { - "group": "知识库", - "openapi": "zh/api-reference/openapi_knowledge.json" - }, - { - "group": "文本生成", - "openapi": "zh/api-reference/openapi_completion.json" - } - ] - }, - { - "dropdown": "开发插件", - "icon": "code-pull-request", - "groups": [ - { - "group": "快速开始", - "pages": [ - "zh/develop-plugin/getting-started/getting-started-dify-plugin", - "zh/develop-plugin/getting-started/cli" - ] - }, - { - "group": "特性与规范", - "pages": [ - { - "group": "插件类型", - "pages": [ - "zh/develop-plugin/features-and-specs/plugin-types/general-specifications", - "zh/develop-plugin/features-and-specs/plugin-types/model-designing-rules", - "zh/develop-plugin/features-and-specs/plugin-types/model-schema", - "zh/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv", - "zh/develop-plugin/features-and-specs/plugin-types/tool", - "zh/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest", - "zh/develop-plugin/features-and-specs/plugin-types/multilingual-readme", - "zh/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin", - "zh/develop-plugin/features-and-specs/plugin-types/plugin-logging" - ] - }, - { - "group": "高级开发", - "pages": [ - { - "group": "反向调用", - "pages": [ - "zh/develop-plugin/features-and-specs/advanced-development/bundle", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool", - "zh/develop-plugin/features-and-specs/advanced-development/customizable-model", - "zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node" - ] - } - ] - } - ] - }, - { - "group": "开发指南与示例", - "pages": [ - "zh/develop-plugin/dev-guides-and-walkthroughs/cheatsheet", - "zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/tool-oauth", - "zh/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider", - "zh/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/endpoint", - "zh/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin", - "zh/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter", - "zh/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool" - ] - }, - { - "group": "发布", - "pages": [ - { - "group": "标准", - "pages": [ - "zh/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct", - "zh/develop-plugin/publishing/standards/privacy-protection-guidelines", - "zh/develop-plugin/publishing/standards/third-party-signature-verification" - ] - }, - { - "group": "上架插件市场", - "pages": [ - "zh/develop-plugin/publishing/marketplace-listing/plugin-auto-publish-pr", - "zh/develop-plugin/publishing/marketplace-listing/release-overview", - "zh/develop-plugin/publishing/marketplace-listing/release-by-file", - "zh/develop-plugin/publishing/marketplace-listing/release-to-dify-marketplace", - "zh/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo" - ] - }, - { - "group": "常见问题", - "pages": [ - "zh/develop-plugin/publishing/faq/faq" - ] - } - ] - } - ] - } - ], - "default": true - }, - { - "version": "3.7.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/3-7-x/zh/user-guide/introduction", - { - "group": "接入大模型", - "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-5-x/zh/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/zh/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", - { - "group": "聊天助手", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" - ] - }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", - { - "group": "应用工具箱", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "工作流", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", - { - "group": "节点说明", - "pages": [ - "versions/3-7-x/zh/user-guide/workflow/node/user-input", - { - "group": "触发器", - "pages": [ - "versions/3-7-x/zh/user-guide/workflow/node/trigger/overview", - "versions/3-7-x/zh/user-guide/workflow/node/trigger/schedule-trigger", - "versions/3-7-x/zh/user-guide/workflow/node/trigger/plugin-trigger", - "versions/3-7-x/zh/user-guide/workflow/node/trigger/webhook-trigger" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-7-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-7-x/zh/user-guide/workflow/node/output", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", - { - "group": "异常处理", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", - { - "group": "预览与调试", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" - ] - }, - { - "group": "知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", - { - "group": "创建知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. 导入文本数据", - "pages": [ - "versions/3-7-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-7-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "从知识流水线创建", - "pages": [ - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/readme", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", - "versions/3-7-x/zh/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/upload-files", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" - ] - }, - { - "group": "管理知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-7-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" - ] - }, - { - "group": "工具", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-3-x/zh/user-guide/tools/mcp", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", - { - "group": "工具配置详情", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" - ] - } - ] - }, - { - "group": "发布", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - "versions/3-3-x/zh/user-guide/application-publishing/publish-mcp", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "标注", - "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "监测", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", - { - "group": "集成外部与 Ops 工具", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" - ] - }, - { - "group": "管理", - "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "3.6.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/3-6-x/zh/user-guide/introduction", - { - "group": "接入大模型", - "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-5-x/zh/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/zh/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", - { - "group": "聊天助手", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" - ] - }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", - { - "group": "应用工具箱", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "工作流", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", - { - "group": "节点说明", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/node/start", - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-0-x/zh/user-guide/workflow/node/end", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", - { - "group": "异常处理", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", - { - "group": "预览与调试", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" - ] - }, - { - "group": "知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", - { - "group": "创建知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. 导入文本数据", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "从知识流水线创建", - "pages": [ - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/readme", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/create-knowledge-pipeline", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/knowledge-pipeline-orchestration", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/publish-knowledge-pipeline", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/upload-files", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/manage-knowledge-base", - "versions/3-6-x/zh/user-guide/knowledge-base/knowledge-pipeline/authorize-data-source" - ] - }, - { - "group": "管理知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" - ] - }, - { - "group": "工具", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-3-x/zh/user-guide/tools/mcp", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", - { - "group": "工具配置详情", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" - ] - } - ] - }, - { - "group": "发布", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - "versions/3-3-x/zh/user-guide/application-publishing/publish-mcp", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "标注", - "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "监测", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", - { - "group": "集成外部与 Ops 工具", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" - ] - }, - { - "group": "管理", - "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "3.5.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/3-5-x/zh/user-guide/introduction", - { - "group": "接入大模型", - "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-5-x/zh/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/zh/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", - { - "group": "聊天助手", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" - ] - }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", - { - "group": "应用工具箱", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "工作流", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", - { - "group": "节点说明", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/node/start", - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-0-x/zh/user-guide/workflow/node/end", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", - { - "group": "异常处理", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", - { - "group": "预览与调试", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" - ] - }, - { - "group": "知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", - { - "group": "创建知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. 导入文本数据", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "管理知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" - ] - }, - { - "group": "工具", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-3-x/zh/user-guide/tools/mcp", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", - { - "group": "工具配置详情", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" - ] - } - ] - }, - { - "group": "发布", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - "versions/3-3-x/zh/user-guide/application-publishing/publish-mcp", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "标注", - "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "监测", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", - { - "group": "集成外部与 Ops 工具", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" - ] - }, - { - "group": "管理", - "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "3.4.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/3-4-x/zh/user-guide/introduction", - { - "group": "接入大模型", - "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-0-x/zh/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", - { - "group": "聊天助手", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" - ] - }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", - { - "group": "应用工具箱", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "工作流", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", - { - "group": "节点说明", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/node/start", - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-0-x/zh/user-guide/workflow/node/end", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", - { - "group": "异常处理", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", - { - "group": "预览与调试", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" - ] - }, - { - "group": "知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", - { - "group": "创建知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. 导入文本数据", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "管理知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" - ] - }, - { - "group": "工具", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-3-x/zh/user-guide/tools/mcp", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", - { - "group": "工具配置详情", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" - ] - } - ] - }, - { - "group": "发布", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - "versions/3-3-x/zh/user-guide/application-publishing/publish-mcp", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "标注", - "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "监测", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", - { - "group": "集成外部与 Ops 工具", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" - ] - }, - { - "group": "管理", - "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "3.3.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/3-3-x/zh/user-guide/introduction", - { - "group": "接入大模型", - "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-0-x/zh/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", - { - "group": "聊天助手", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" - ] - }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", - { - "group": "应用工具箱", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "工作流", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", - { - "group": "节点说明", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/node/start", - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-0-x/zh/user-guide/workflow/node/end", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", - { - "group": "异常处理", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", - { - "group": "预览与调试", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" - ] - }, - { - "group": "知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", - { - "group": "创建知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. 导入文本数据", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "管理知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" - ] - }, - { - "group": "工具", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-3-x/zh/user-guide/tools/mcp", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", - { - "group": "工具配置详情", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" - ] - } - ] - }, - { - "group": "发布", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - "versions/3-3-x/zh/user-guide/application-publishing/publish-mcp", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "标注", - "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "监测", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", - { - "group": "集成外部与 Ops 工具", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" - ] - }, - { - "group": "管理", - "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "3.2.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/3-2-x/zh/user-guide/introduction", - { - "group": "接入大模型", - "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-0-x/zh/user-guide/model-configuration/load-balancing", - "versions/3-0-x/zh/user-guide/model-configuration/manage-model-credential" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", - { - "group": "聊天助手", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" - ] - }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", - { - "group": "应用工具箱", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "工作流", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", - { - "group": "节点说明", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/node/start", - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-0-x/zh/user-guide/workflow/node/end", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", - { - "group": "异常处理", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", - { - "group": "预览与调试", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/zh/user-guide/workflow/debug-and-preview/variable-inspect" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" - ] - }, - { - "group": "知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", - { - "group": "创建知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. 导入文本数据", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "管理知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" - ] - }, - { - "group": "工具", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", - { - "group": "工具配置详情", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" - ] - } - ] - }, - { - "group": "发布", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "标注", - "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "监测", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", - { - "group": "集成外部与 Ops 工具", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" - ] - }, - { - "group": "管理", - "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "3.0.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/3-0-x/zh/user-guide/introduction", - { - "group": "接入大模型", - "pages": [ - "versions/3-0-x/zh/user-guide/model-configuration/readme", - "versions/3-0-x/zh/user-guide/model-configuration/new-provider", - "versions/3-0-x/zh/user-guide/model-configuration/predefined-model", - "versions/3-0-x/zh/user-guide/model-configuration/customizable-model", - "versions/3-0-x/zh/user-guide/model-configuration/interfaces", - "versions/3-0-x/zh/user-guide/model-configuration/schema", - "versions/3-0-x/zh/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/creating-an-application", - { - "group": "聊天助手", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/chatbot-application", - "versions/3-0-x/zh/user-guide/application-orchestrate/multiple-llms-debugging" - ] - }, - "versions/3-0-x/zh/user-guide/application-orchestrate/agent", - { - "group": "应用工具箱", - "pages": [ - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/readme", - "versions/3-0-x/zh/user-guide/application-orchestrate/app-toolkits/moderation-tool" - ] - } - ] - }, - { - "group": "工作流", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/readme", - "versions/3-0-x/zh/user-guide/workflow/key-concept", - "versions/3-0-x/zh/user-guide/workflow/variables", - { - "group": "节点说明", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/node/start", - "versions/3-0-x/zh/user-guide/workflow/node/llm", - "versions/3-0-x/zh/user-guide/workflow/node/knowledge-retrieval", - "versions/3-0-x/zh/user-guide/workflow/node/question-classifier", - "versions/3-0-x/zh/user-guide/workflow/node/ifelse", - "versions/3-0-x/zh/user-guide/workflow/node/code", - "versions/3-0-x/zh/user-guide/workflow/node/template", - "versions/3-0-x/zh/user-guide/workflow/node/doc-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/list-operator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-aggregator", - "versions/3-0-x/zh/user-guide/workflow/node/variable-assigner", - "versions/3-0-x/zh/user-guide/workflow/node/iteration", - "versions/3-0-x/zh/user-guide/workflow/node/parameter-extractor", - "versions/3-0-x/zh/user-guide/workflow/node/http-request", - "versions/3-0-x/zh/user-guide/workflow/node/agent", - "versions/3-0-x/zh/user-guide/workflow/node/tools", - "versions/3-0-x/zh/user-guide/workflow/node/end", - "versions/3-0-x/zh/user-guide/workflow/node/answer", - "versions/3-0-x/zh/user-guide/workflow/node/loop" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/shortcut-key", - "versions/3-0-x/zh/user-guide/workflow/orchestrate-node", - "versions/3-0-x/zh/user-guide/workflow/file-upload", - { - "group": "异常处理", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/error-handling/readme", - "versions/3-0-x/zh/user-guide/workflow/error-handling/predefined-nodes-failure-logic", - "versions/3-0-x/zh/user-guide/workflow/error-handling/error-type" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/additional-feature", - { - "group": "预览与调试", - "pages": [ - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/zh/user-guide/workflow/debug-and-preview/step-run" - ] - }, - "versions/3-0-x/zh/user-guide/workflow/publish", - "versions/3-0-x/zh/user-guide/workflow/structured-outputs", - "versions/3-0-x/zh/user-guide/workflow/bulletin" - ] - }, - { - "group": "知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/readme", - { - "group": "创建知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-base-creation/introduction", - { - "group": "1. 导入文本数据", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/readme", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-notion", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/import-content-data/sync-from-website" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/chunking-and-cleaning-text", - "versions/3-0-x/zh/user-guide/knowledge-base/create-knowledge-and-upload-documents/setting-indexing-methods" - ] - }, - { - "group": "管理知识库", - "pages": [ - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/introduction", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-knowledge-documents", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-and-documents-maintenance/maintain-dataset-via-api" - ] - }, - "versions/3-0-x/zh/user-guide/knowledge-base/metadata", - "versions/3-0-x/zh/user-guide/knowledge-base/integrate-knowledge-within-application", - "versions/3-0-x/zh/user-guide/knowledge-base/retrieval-test-and-citation", - "versions/3-0-x/zh/user-guide/knowledge-base/knowledge-request-rate-limit", - "versions/3-0-x/zh/user-guide/knowledge-base/connect-external-knowledge-base", - "versions/3-0-x/zh/user-guide/knowledge-base/api-documentation/external-knowledge-api-documentation" - ] - }, - { - "group": "工具", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/readme", - "versions/3-0-x/zh/user-guide/tools/quick-tool-integration", - "versions/3-0-x/zh/user-guide/tools/advanced-tool-integration", - { - "group": "工具配置详情", - "pages": [ - "versions/3-0-x/zh/user-guide/tools/tool-configuration/google", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/bing", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searchapi", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/stable-diffusion", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/dall-e", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/perplexity", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/alphavantage", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/searxng", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/serper", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/siliconflow", - "versions/3-0-x/zh/user-guide/tools/tool-configuration/comfyui" - ] - } - ] - }, - { - "group": "发布", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/readme", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/3-0-x/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/3-0-x/zh/user-guide/application-publishing/embedding-in-websites", - "versions/3-0-x/zh/user-guide/application-publishing/developing-with-apis", - "versions/3-0-x/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "标注", - "pages": [ - "versions/3-0-x/zh/user-guide/annotation/logs", - "versions/3-0-x/zh/user-guide/annotation/annotation-reply" - ] - }, - { - "group": "监测", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/README", - { - "group": "集成外部与 Ops 工具", - "pages": [ - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/readme", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-opik", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-weave", - "versions/3-0-x/zh/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - }, - "versions/3-0-x/zh/user-guide/monitoring/analysis" - ] - }, - { - "group": "管理", - "pages": [ - "versions/3-0-x/zh/user-guide/management/app-management", - "versions/3-0-x/zh/user-guide/management/team-members-management", - "versions/3-0-x/zh/user-guide/management/personal-account-management", - "versions/3-0-x/zh/user-guide/management/subscription-management", - "versions/3-0-x/zh/user-guide/management/version-control" - ] - } - ] - } - ] - }, - { - "version": "2.8.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/legacy/zh/user-guide/welcome", - { - "group": "接入模型", - "pages": [ - "versions/legacy/zh/user-guide/models/model-configuration", - "versions/legacy/zh/user-guide/models/new-provider", - "versions/legacy/zh/user-guide/models/predefined-model", - "versions/legacy/zh/user-guide/models/customizable-model", - "versions/legacy/zh/user-guide/models/interfaces", - "versions/legacy/zh/user-guide/models/schema", - "versions/legacy/zh/user-guide/models/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/legacy/zh/user-guide/build-app/chatbot", - "versions/legacy/zh/user-guide/build-app/text-generator", - "versions/legacy/zh/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/concepts", - "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/zh/user-guide/build-app/flow-app/variables", - { - "group": "节点说明", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", - "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "调试应用", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] - }, - { - "group": "发布应用", - "pages": [ - "versions/2-8-x/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", - "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/zh/user-guide/management/app-management", - "versions/legacy/zh/user-guide/management/team-members-management", - "versions/legacy/zh/user-guide/management/personal-account-management" - ] - } - ] - } - ] - }, - { - "version": "2.7.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/legacy/zh/user-guide/welcome", - { - "group": "接入模型", - "pages": [ - "versions/legacy/zh/user-guide/models/model-configuration", - "versions/legacy/zh/user-guide/models/new-provider", - "versions/legacy/zh/user-guide/models/predefined-model", - "versions/legacy/zh/user-guide/models/customizable-model", - "versions/legacy/zh/user-guide/models/interfaces", - "versions/legacy/zh/user-guide/models/schema", - "versions/legacy/zh/user-guide/models/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/legacy/zh/user-guide/build-app/chatbot", - "versions/legacy/zh/user-guide/build-app/text-generator", - "versions/legacy/zh/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/concepts", - "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/zh/user-guide/build-app/flow-app/variables", - { - "group": "节点说明", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", - "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "调试应用", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] - }, - { - "group": "发布应用", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", - "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/zh/user-guide/management/app-management", - "versions/legacy/zh/user-guide/management/team-members-management", - "versions/legacy/zh/user-guide/management/personal-account-management" - ] - } - ] - } - ] - }, - { - "version": "2.6.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/legacy/zh/user-guide/welcome", - { - "group": "接入模型", - "pages": [ - "versions/legacy/zh/user-guide/models/model-configuration", - "versions/legacy/zh/user-guide/models/new-provider", - "versions/legacy/zh/user-guide/models/predefined-model", - "versions/legacy/zh/user-guide/models/customizable-model", - "versions/legacy/zh/user-guide/models/interfaces", - "versions/legacy/zh/user-guide/models/schema", - "versions/legacy/zh/user-guide/models/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/legacy/zh/user-guide/build-app/chatbot", - "versions/legacy/zh/user-guide/build-app/text-generator", - "versions/legacy/zh/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/concepts", - "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/zh/user-guide/build-app/flow-app/variables", - { - "group": "节点说明", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", - "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "调试应用", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] - }, - { - "group": "发布应用", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/permission-management", - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", - "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/zh/user-guide/management/app-management", - "versions/legacy/zh/user-guide/management/team-members-management", - "versions/legacy/zh/user-guide/management/personal-account-management" - ] - } - ] - } - ] - }, - { - "version": "2.5.x (Enterprise)", - "groups": [ - { - "group": "用户手册", - "pages": [ - "versions/legacy/zh/user-guide/welcome", - { - "group": "接入模型", - "pages": [ - "versions/legacy/zh/user-guide/models/model-configuration", - "versions/legacy/zh/user-guide/models/new-provider", - "versions/legacy/zh/user-guide/models/predefined-model", - "versions/legacy/zh/user-guide/models/customizable-model", - "versions/legacy/zh/user-guide/models/interfaces", - "versions/legacy/zh/user-guide/models/schema", - "versions/legacy/zh/user-guide/models/load-balancing" - ] - }, - { - "group": "构建应用", - "pages": [ - "versions/legacy/zh/user-guide/build-app/chatbot", - "versions/legacy/zh/user-guide/build-app/text-generator", - "versions/legacy/zh/user-guide/build-app/agent", - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/concepts", - "versions/legacy/zh/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/zh/user-guide/build-app/flow-app/variables", - { - "group": "节点说明", - "pages": [ - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/zh/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/zh/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/zh/user-guide/build-app/flow-app/file-upload", - "versions/legacy/zh/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "调试应用", - "pages": [ - { - "group": "Chatflow & Workflow", - "pages": [ - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/zh/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] - }, - { - "group": "发布应用", - "pages": [ - { - "group": "发布为公开 Web 站点", - "pages": [ - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/zh/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/zh/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/zh/user-guide/application-publishing/developing-with-apis", - "versions/legacy/zh/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/zh/user-guide/management/app-management", - "versions/legacy/zh/user-guide/management/team-members-management", - "versions/legacy/zh/user-guide/management/personal-account-management" - ] - } - ] - } - ] - } - ] - }, - { - "language": "ja", - "versions": [ - { - "version": "Latest", - "dropdowns": [ - { - "dropdown": "Dify を使う", - "icon": "book-open", - "pages": [ - { - "group": " ", - "pages": [ - { - "group": "はじめに", - "expanded": false, - "pages": [ - "ja/use-dify/getting-started/introduction", - "ja/use-dify/getting-started/quick-start", - "ja/use-dify/getting-started/key-concepts" - ] - }, - { - "group": "ノード", - "expanded": false, - "pages": [ - "ja/use-dify/nodes/user-input", - { - "group": "トリガー", - "icon": "bolt-lightning", - "pages": [ - "ja/use-dify/nodes/trigger/overview", - "ja/use-dify/nodes/trigger/schedule-trigger", - "ja/use-dify/nodes/trigger/plugin-trigger", - "ja/use-dify/nodes/trigger/webhook-trigger" - ] - }, - "ja/use-dify/nodes/llm", - "ja/use-dify/nodes/knowledge-retrieval", - "ja/use-dify/nodes/answer", - "ja/use-dify/nodes/output", - "ja/use-dify/nodes/agent", - "ja/use-dify/nodes/question-classifier", - "ja/use-dify/nodes/ifelse", - "ja/use-dify/nodes/human-input", - "ja/use-dify/nodes/iteration", - "ja/use-dify/nodes/loop", - "ja/use-dify/nodes/code", - "ja/use-dify/nodes/template", - "ja/use-dify/nodes/variable-aggregator", - "ja/use-dify/nodes/doc-extractor", - "ja/use-dify/nodes/variable-assigner", - "ja/use-dify/nodes/parameter-extractor", - "ja/use-dify/nodes/http-request", - "ja/use-dify/nodes/list-operator", - "ja/use-dify/nodes/tools" - ] - }, - { - "group": "ビルド", - "expanded": false, - "pages": [ - "ja/use-dify/build/shortcut-key", - "ja/use-dify/build/goto-anything", - "ja/use-dify/build/orchestrate-node", - "ja/use-dify/build/predefined-error-handling-logic", - "ja/use-dify/build/mcp", - "ja/use-dify/build/version-control", - "ja/use-dify/build/additional-features" - ] - }, - { - "group": "デバッグ", - "expanded": false, - "pages": [ - "ja/use-dify/debug/step-run", - "ja/use-dify/debug/variable-inspect", - "ja/use-dify/debug/history-and-logs", - "ja/use-dify/debug/error-type" - ] - }, - { - "group": "公開", - "expanded": false, - "pages": [ - "ja/use-dify/publish/README", - { - "group": "Webアプリ", - "icon": "globe", - "pages": [ - "ja/use-dify/publish/webapp/workflow-webapp", - "ja/use-dify/publish/webapp/chatflow-webapp", - "ja/use-dify/publish/webapp/web-app-settings", - "ja/use-dify/publish/webapp/web-app-access", - "ja/use-dify/publish/webapp/embedding-in-websites" - ] - }, - "ja/use-dify/publish/publish-mcp", - "ja/use-dify/publish/developing-with-apis", - "ja/use-dify/publish/publish-to-marketplace" - ] - }, - { - "group": "モニタリング", - "expanded": false, - "pages": [ - "ja/use-dify/monitor/analysis", - "ja/use-dify/monitor/logs", - "ja/use-dify/monitor/annotation-reply", - { - "group": "インテグレーション", - "icon": "grid-2-plus", - "pages": [ - "ja/use-dify/monitor/integrations/integrate-langsmith", - "ja/use-dify/monitor/integrations/integrate-langfuse", - "ja/use-dify/monitor/integrations/integrate-opik", - "ja/use-dify/monitor/integrations/integrate-weave", - "ja/use-dify/monitor/integrations/integrate-arize", - "ja/use-dify/monitor/integrations/integrate-phoenix", - "ja/use-dify/monitor/integrations/integrate-aliyun" - ] - } - ] - }, - { - "group": "ナレッジ", - "expanded": false, - "pages": [ - "ja/use-dify/knowledge/readme", - { - "group": "ナレッジの作成", - "icon": "square-plus", - "pages": [ - { - "group": "クイック作成", - "pages": [ - "ja/use-dify/knowledge/create-knowledge/introduction", - { - "group": "データのインポート", - "pages": [ - "ja/use-dify/knowledge/create-knowledge/import-text-data/readme", - "ja/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion", - "ja/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website" - ] - }, - "ja/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text", - "ja/use-dify/knowledge/create-knowledge/setting-indexing-methods" - ] - }, - { - "group": "ナレッジパイプラインから作成", - "pages": [ - "ja/use-dify/knowledge/knowledge-pipeline/readme", - "ja/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline", - "ja/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration", - "ja/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline", - "ja/use-dify/knowledge/knowledge-pipeline/upload-files", - "ja/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base", - "ja/use-dify/knowledge/knowledge-pipeline/authorize-data-source" - ] - }, - { - "group": "外部ナレッジベースと連携", - "pages": [ - "ja/use-dify/knowledge/connect-external-knowledge-base", - "ja/use-dify/knowledge/external-knowledge-api" - ] - } - ] - }, - { - "group": "ナレッジの管理", - "icon": "gear", - "pages": [ - "ja/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents", - "ja/use-dify/knowledge/manage-knowledge/introduction", - "ja/use-dify/knowledge/metadata", - "ja/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api" - ] - }, - "ja/use-dify/knowledge/test-retrieval", - "ja/use-dify/knowledge/integrate-knowledge-within-application", - "ja/use-dify/knowledge/knowledge-request-rate-limit" - ] - }, - { - "group": "ワークスペース", - "expanded": false, - "pages": [ - "ja/use-dify/workspace/readme", - "ja/use-dify/workspace/model-providers", - "ja/use-dify/workspace/plugins", - "ja/use-dify/workspace/app-management", - "ja/use-dify/workspace/team-members-management", - "ja/use-dify/workspace/personal-account-management", - "ja/use-dify/workspace/subscription-management", - { - "group": "API 拡張", - "icon": "puzzle-piece-simple", - "pages": [ - "ja/use-dify/workspace/api-extension/api-extension", - "ja/use-dify/workspace/api-extension/external-data-tool-api-extension", - "ja/use-dify/workspace/api-extension/moderation-api-extension", - "ja/use-dify/workspace/api-extension/cloudflare-worker" - ] - } - ] - }, - { - "group": "チュートリアル", - "expanded": false, - "pages": [ - "ja/use-dify/tutorials/twitter-chatflow", - "ja/use-dify/tutorials/customer-service-bot", - "ja/use-dify/tutorials/build-ai-image-generation-app", - "ja/use-dify/tutorials/article-reader" - ] - } - ] - } - ] - }, - { - "dropdown": "セルフホスティング", - "icon": "server", - "pages": [ - { - "group": "クイックスタート", - "pages": [ - "ja/self-host/quick-start/docker-compose", - "ja/self-host/quick-start/faqs" - ] - }, - { - "group": "高度なデプロイ", - "pages": [ - "ja/self-host/advanced-deployments/local-source-code", - "ja/self-host/advanced-deployments/start-the-frontend-docker-container" - ] - }, - { - "group": "設定", - "pages": [ - "ja/self-host/configuration/environments" - ] - }, - { - "group": "プラットフォームガイド", - "pages": [ - "ja/self-host/platform-guides/bt-panel", - "ja/self-host/platform-guides/dify-premium" - ] - }, - { - "group": "トラブルシューティング", - "pages": [ - "ja/self-host/troubleshooting/common-issues", - "ja/self-host/troubleshooting/docker-issues", - "ja/self-host/troubleshooting/integrations", - "ja/self-host/troubleshooting/storage-and-migration", - "ja/self-host/troubleshooting/weaviate-v4-migration" - ] - } - ] - }, - { - "dropdown": "APIアクセス", - "icon": "code", - "groups": [ - { - "group": "ChatbotとAgent", - "openapi": "ja/api-reference/openapi_chat.json" - }, - { - "group": "チャットフロー", - "openapi": "ja/api-reference/openapi_chatflow.json" - }, - { - "group": "ワークフロー", - "openapi": "ja/api-reference/openapi_workflow.json" - }, - { - "group": "ナレッジ", - "openapi": "ja/api-reference/openapi_knowledge.json" - }, - { - "group": "テキスト ジェネレーター", - "openapi": "ja/api-reference/openapi_completion.json" - } - ] - }, - { - "dropdown": "プラグイン開発", - "icon": "code-pull-request", - "groups": [ - { - "group": "はじめに", - "pages": [ - "ja/develop-plugin/getting-started/getting-started-dify-plugin", - "ja/develop-plugin/getting-started/cli" - ] - }, - { - "group": "特性と仕様", - "pages": [ - { - "group": "プラグインタイプ", - "pages": [ - "ja/develop-plugin/features-and-specs/plugin-types/general-specifications", - "ja/develop-plugin/features-and-specs/plugin-types/model-designing-rules", - "ja/develop-plugin/features-and-specs/plugin-types/model-schema", - "ja/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv", - "ja/develop-plugin/features-and-specs/plugin-types/tool", - "ja/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest", - "ja/develop-plugin/features-and-specs/plugin-types/multilingual-readme", - "ja/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin", - "ja/develop-plugin/features-and-specs/plugin-types/plugin-logging" - ] - }, - { - "group": "高度な開発", - "pages": [ - { - "group": "リバース呼び出し", - "pages": [ - "ja/develop-plugin/features-and-specs/advanced-development/bundle", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool", - "ja/develop-plugin/features-and-specs/advanced-development/customizable-model", - "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node" - ] - } - ] - } - ] - }, - { - "group": "開発ガイドとサンプル", - "pages": [ - "ja/develop-plugin/dev-guides-and-walkthroughs/cheatsheet", - "ja/develop-plugin/dev-guides-and-walkthroughs/tool-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/tool-oauth", - "ja/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider", - "ja/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/endpoint", - "ja/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin", - "ja/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter", - "ja/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool" - ] - }, - { - "group": "公開", - "pages": [ - { - "group": "標準", - "pages": [ - "ja/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct", - "ja/develop-plugin/publishing/standards/privacy-protection-guidelines", - "ja/develop-plugin/publishing/standards/third-party-signature-verification" - ] - }, - { - "group": "マーケットプレイスリスト", - "pages": [ - "ja/develop-plugin/publishing/marketplace-listing/plugin-auto-publish-pr", - "ja/develop-plugin/publishing/marketplace-listing/release-overview", - "ja/develop-plugin/publishing/marketplace-listing/release-by-file", - "ja/develop-plugin/publishing/marketplace-listing/release-to-dify-marketplace", - "ja/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo" - ] - }, - { - "group": "よくある質問", - "pages": [ - "ja/develop-plugin/publishing/faq/faq" - ] - } - ] - } - ] - } - ], - "default": true - }, - { - "version": "3.7.x (Enterprise)", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-7-x/ja/user-guide/introduction", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/3-5-x/ja/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/ja/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", - { - "group": "ノードの説明", - "pages": [ - "versions/3-7-x/ja/user-guide/workflow/node/user-input", - { - "group": "トリガー", - "pages": [ - "versions/3-7-x/ja/user-guide/workflow/node/trigger/overview", - "versions/3-7-x/ja/user-guide/workflow/node/trigger/schedule-trigger", - "versions/3-7-x/ja/user-guide/workflow/node/trigger/plugin-trigger", - "versions/3-7-x/ja/user-guide/workflow/node/trigger/webhook-trigger" - ] - }, - "versions/3-7-x/ja/user-guide/workflow/node/output", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/3-7-x/ja/user-guide/workflow/node/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "アプリのデバッグ", - "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" - ] - } - ] - }, - { - "group": "ツール", - "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" - ] - }, - { - "group": "アプリのリリース", - "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", - { - "group": "公開Webアプリとしてのリリース", - "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - } - ] - } - ] - }, - { - "version": "3.6.x (Enterprise)", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-6-x/ja/user-guide/introduction", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/3-5-x/ja/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/ja/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", - { - "group": "ノードの説明", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "アプリのデバッグ", - "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" - ] - } - ] - }, - { - "group": "ツール", - "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" - ] - }, - { - "group": "アプリのリリース", - "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", - { - "group": "公開Webアプリとしてのリリース", - "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - } - ] - } - ] - }, - { - "version": "3.5.x (Enterprise)", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-5-x/ja/user-guide/introduction", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/3-5-x/ja/user-guide/model-configuration/manage-model-credential", - "versions/3-5-x/ja/user-guide/model-configuration/load-balancing" - ] - }, - { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", - { - "group": "ノードの説明", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "アプリのデバッグ", - "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" - ] - } - ] - }, - { - "group": "ツール", - "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" - ] - }, - { - "group": "アプリのリリース", - "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", { - "group": "公開Webアプリとしてのリリース", + "group": "デバッグ", + "expanded": false, "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "ja/use-dify/debug/step-run", + "ja/use-dify/debug/variable-inspect", + "ja/use-dify/debug/history-and-logs", + "ja/use-dify/debug/error-type" ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - } - ] - } - ] - }, - { - "version": "3.4.x (Enterprise)", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-4-x/ja/user-guide/introduction", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" - ] - }, - { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", { - "group": "チャットフロー & ワークフロー", + "group": "公開", + "expanded": false, "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", + "ja/use-dify/publish/README", { - "group": "ノードの説明", + "group": "Webアプリ", + "icon": "globe", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" + "ja/use-dify/publish/webapp/workflow-webapp", + "ja/use-dify/publish/webapp/chatflow-webapp", + "ja/use-dify/publish/webapp/web-app-settings", + "ja/use-dify/publish/webapp/web-app-access", + "ja/use-dify/publish/webapp/embedding-in-websites" ] }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "アプリのデバッグ", - "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" - ] - } - ] - }, - { - "group": "ツール", - "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" - ] - }, - { - "group": "アプリのリリース", - "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", - { - "group": "公開Webアプリとしてのリリース", - "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "ja/use-dify/publish/publish-mcp", + "ja/use-dify/publish/developing-with-apis", + "ja/use-dify/publish/publish-to-marketplace" ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - } - ] - } - ] - }, - { - "version": "3.3.x (Enterprise)", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-3-x/ja/user-guide/introduction", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" - ] - }, - { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", { - "group": "チャットフロー & ワークフロー", + "group": "モニタリング", + "expanded": false, "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", + "ja/use-dify/monitor/analysis", + "ja/use-dify/monitor/logs", + "ja/use-dify/monitor/annotation-reply", { - "group": "ノードの説明", + "group": "インテグレーション", + "icon": "grid-2-plus", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" + "ja/use-dify/monitor/integrations/integrate-langsmith", + "ja/use-dify/monitor/integrations/integrate-langfuse", + "ja/use-dify/monitor/integrations/integrate-opik", + "ja/use-dify/monitor/integrations/integrate-weave", + "ja/use-dify/monitor/integrations/integrate-arize", + "ja/use-dify/monitor/integrations/integrate-phoenix", + "ja/use-dify/monitor/integrations/integrate-aliyun" ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "アプリのデバッグ", - "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" - ] - } - ] - }, - { - "group": "ツール", - "pages": [ - "versions/3-3-x/ja/user-guide/tools/mcp" - ] - }, - { - "group": "アプリのリリース", - "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - "versions/3-3-x/ja/user-guide/application-publishing/publish-mcp", - { - "group": "公開Webアプリとしてのリリース", - "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + } ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - } - ] - } - ] - }, - { - "version": "3.2.x (Enterprise)", - "groups": [ - { - "group": "User Guide", - "pages": [ - "versions/3-2-x/ja/user-guide/introduction", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" - ] - }, - { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", { - "group": "チャットフロー & ワークフロー", + "group": "ナレッジ", + "expanded": false, "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", + "ja/use-dify/knowledge/readme", { - "group": "ノードの説明", + "group": "ナレッジの作成", + "icon": "square-plus", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "アプリのデバッグ", - "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/preview-and-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/step-run", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/log", - "versions/3-0-x/ja/user-guide/workflow/debug-and-preview/history", - "versions/3-2-x/ja/user-guide/workflow/debug-and-preview/variable-inspect" - ] - } - ] - }, - { - "group": "アプリのリリース", - "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - { - "group": "公開Webアプリとしてのリリース", - "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" - ] - } - ] - } - ] - } - ] - }, - { - "version": "3.0.x (Enterprise)", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/3-0-x/ja/user-guide/introduction", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" - ] - }, - { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", + { + "group": "クイック作成", + "pages": [ + "ja/use-dify/knowledge/create-knowledge/introduction", + { + "group": "データのインポート", + "pages": [ + "ja/use-dify/knowledge/create-knowledge/import-text-data/readme", + "ja/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion", + "ja/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website" + ] + }, + "ja/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text", + "ja/use-dify/knowledge/create-knowledge/setting-indexing-methods" + ] + }, + { + "group": "ナレッジパイプラインから作成", + "pages": [ + "ja/use-dify/knowledge/knowledge-pipeline/readme", + "ja/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline", + "ja/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration", + "ja/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline", + "ja/use-dify/knowledge/knowledge-pipeline/upload-files", + "ja/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base", + "ja/use-dify/knowledge/knowledge-pipeline/authorize-data-source" + ] + }, + { + "group": "外部ナレッジベースと連携", + "pages": [ + "ja/use-dify/knowledge/connect-external-knowledge-base", + "ja/use-dify/knowledge/external-knowledge-api" + ] + } + ] + }, { - "group": "ノードの説明", + "group": "ナレッジの管理", + "icon": "gear", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" + "ja/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents", + "ja/use-dify/knowledge/manage-knowledge/introduction", + "ja/use-dify/knowledge/metadata", + "ja/use-dify/knowledge/manage-knowledge/maintain-dataset-via-api" ] }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } - ] - }, - { - "group": "アプリのデバッグ", - "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" + "ja/use-dify/knowledge/test-retrieval", + "ja/use-dify/knowledge/integrate-knowledge-within-application", + "ja/use-dify/knowledge/knowledge-request-rate-limit" ] - } - ] - }, - { - "group": "アプリのリリース", - "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", + }, { - "group": "公開Webアプリとしてのリリース", + "group": "ワークスペース", + "expanded": false, "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "ja/use-dify/workspace/readme", + "ja/use-dify/workspace/model-providers", + "ja/use-dify/workspace/plugins", + "ja/use-dify/workspace/app-management", + "ja/use-dify/workspace/team-members-management", + "ja/use-dify/workspace/personal-account-management", + "ja/use-dify/workspace/subscription-management", + { + "group": "API 拡張", + "icon": "puzzle-piece-simple", + "pages": [ + "ja/use-dify/workspace/api-extension/api-extension", + "ja/use-dify/workspace/api-extension/external-data-tool-api-extension", + "ja/use-dify/workspace/api-extension/moderation-api-extension", + "ja/use-dify/workspace/api-extension/cloudflare-worker" + ] + } ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - }, - { - "group": "監視", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", { - "group": "外部Opsツールの統合", + "group": "チュートリアル", + "expanded": false, "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-aliyun" + "ja/use-dify/tutorials/twitter-chatflow", + "ja/use-dify/tutorials/customer-service-bot", + "ja/use-dify/tutorials/build-ai-image-generation-app", + "ja/use-dify/tutorials/article-reader" ] } ] } ] - } - ] - }, - { - "version": "2.8.x (Enterprise)", - "groups": [ + }, { - "group": "ユーザーマニュアル", + "dropdown": "セルフホスティング", + "icon": "server", "pages": [ - "versions/legacy/ja/user-guide/welcome", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" - ] - }, { - "group": "アプリの構築", + "group": "クイックスタート", "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", - { - "group": "ノードの説明", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } + "ja/self-host/quick-start/docker-compose", + "ja/self-host/quick-start/faqs" ] }, { - "group": "アプリのデバッグ", + "group": "高度なデプロイ", "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" - ] - } + "ja/self-host/advanced-deployments/local-source-code", + "ja/self-host/advanced-deployments/start-the-frontend-docker-container" ] }, { - "group": "アプリのリリース", + "group": "設定", "pages": [ - "versions/2-8-x/ja/user-guide/application-publishing/permission-management", - { - "group": "公開Webアプリとしてのリリース", - "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" + "ja/self-host/configuration/environments" ] }, { - "group": "管理", + "group": "プラットフォームガイド", "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" + "ja/self-host/platform-guides/bt-panel", + "ja/self-host/platform-guides/dify-premium" ] }, { - "group": "監視", + "group": "トラブルシューティング", "pages": [ - "versions/legacy/ja/user-guide/monitoring/analysis", - "versions/legacy/ja/user-guide/monitoring/logs", - "versions/legacy/ja/user-guide/monitoring/annotation-reply", - { - "group": "外部Opsツールの統合", - "pages": [ - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langfuse", - "versions/legacy/ja/user-guide/monitoring/integrate-external-ops-tools/integrate-langsmith" - ] - } + "ja/self-host/troubleshooting/common-issues", + "ja/self-host/troubleshooting/docker-issues", + "ja/self-host/troubleshooting/integrations", + "ja/self-host/troubleshooting/storage-and-migration", + "ja/self-host/troubleshooting/weaviate-v4-migration" ] } ] - } - ] - }, - { - "version": "2.7.x (Enterprise)", - "groups": [ + }, { - "group": "ユーザーマニュアル", - "pages": [ - "versions/legacy/ja/user-guide/welcome", + "dropdown": "APIアクセス", + "icon": "code", + "groups": [ { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" - ] + "group": "ChatbotとAgent", + "openapi": "ja/api-reference/openapi_chat.json" }, { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", - { - "group": "ノードの説明", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" - ] - } - ] + "group": "チャットフロー", + "openapi": "ja/api-reference/openapi_chatflow.json" }, { - "group": "アプリのデバッグ", - "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" - ] - } - ] + "group": "ワークフロー", + "openapi": "ja/api-reference/openapi_workflow.json" }, { - "group": "アプリのリリース", - "pages": [ - "versions/legacy/ja/user-guide/application-publishing/permission-management", - { - "group": "公開Webアプリとしてのリリース", - "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] + "group": "ナレッジ", + "openapi": "ja/api-reference/openapi_knowledge.json" }, { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] + "group": "テキスト ジェネレーター", + "openapi": "ja/api-reference/openapi_completion.json" } ] - } - ] - }, - { - "version": "2.6.x (Enterprise)", - "groups": [ + }, { - "group": "ユーザーマニュアル", - "pages": [ - "versions/legacy/ja/user-guide/welcome", + "dropdown": "プラグイン開発", + "icon": "code-pull-request", + "groups": [ { - "group": "モデルの接続", + "group": "はじめに", "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" + "ja/develop-plugin/getting-started/getting-started-dify-plugin", + "ja/develop-plugin/getting-started/cli" ] }, { - "group": "アプリの構築", + "group": "特性と仕様", "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", { - "group": "チャットフロー & ワークフロー", + "group": "プラグインタイプ", + "pages": [ + "ja/develop-plugin/features-and-specs/plugin-types/general-specifications", + "ja/develop-plugin/features-and-specs/plugin-types/model-designing-rules", + "ja/develop-plugin/features-and-specs/plugin-types/model-schema", + "ja/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv", + "ja/develop-plugin/features-and-specs/plugin-types/tool", + "ja/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest", + "ja/develop-plugin/features-and-specs/plugin-types/multilingual-readme", + "ja/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin", + "ja/develop-plugin/features-and-specs/plugin-types/plugin-logging" + ] + }, + { + "group": "高度な開発", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", { - "group": "ノードの説明", + "group": "リバース呼び出し", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" + "ja/develop-plugin/features-and-specs/advanced-development/bundle", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool", + "ja/develop-plugin/features-and-specs/advanced-development/customizable-model", + "ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node" ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" + } ] } ] }, { - "group": "アプリのデバッグ", + "group": "開発ガイドとサンプル", "pages": [ - { - "group": "チャットフロー & ワークフロー", - "pages": [ - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" - ] - } + "ja/develop-plugin/dev-guides-and-walkthroughs/cheatsheet", + "ja/develop-plugin/dev-guides-and-walkthroughs/tool-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/tool-oauth", + "ja/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider", + "ja/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/endpoint", + "ja/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin", + "ja/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter", + "ja/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool" ] }, { - "group": "アプリのリリース", + "group": "公開", "pages": [ - "versions/legacy/ja/user-guide/application-publishing/permission-management", { - "group": "公開Webアプリとしてのリリース", + "group": "標準", "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" + "ja/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct", + "ja/develop-plugin/publishing/standards/privacy-protection-guidelines", + "ja/develop-plugin/publishing/standards/third-party-signature-verification" ] }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] - } - ] - } - ] - }, - { - "version": "2.5.x (Enterprise)", - "groups": [ - { - "group": "ユーザーマニュアル", - "pages": [ - "versions/legacy/ja/user-guide/welcome", - { - "group": "モデルの接続", - "pages": [ - "versions/legacy/ja/user-guide/models/model-configuration", - "versions/legacy/ja/user-guide/models/new-provider", - "versions/legacy/ja/user-guide/models/predefined-model", - "versions/legacy/ja/user-guide/models/customizable-model", - "versions/legacy/ja/user-guide/models/interfaces", - "versions/legacy/ja/user-guide/models/schema", - "versions/legacy/ja/user-guide/models/load-balancing" - ] - }, - { - "group": "アプリの構築", - "pages": [ - "versions/legacy/ja/user-guide/build-app/chatbot", - "versions/legacy/ja/user-guide/build-app/text-generator", - "versions/legacy/ja/user-guide/build-app/agent", { - "group": "チャットフロー & ワークフロー", + "group": "マーケットプレイスリスト", "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/concepts", - "versions/legacy/ja/user-guide/build-app/flow-app/create-flow-app", - "versions/legacy/ja/user-guide/build-app/flow-app/variables", - { - "group": "ノードの説明", - "pages": [ - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/start", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/end", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/answer", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/llm", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/knowledge-retrieval", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/question-classifier", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/ifelse", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/code", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/template", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/doc-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/list-operator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-aggregator", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/variable-assigner", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/iteration", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/parameter-extractor", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/http-request", - "versions/legacy/ja/user-guide/build-app/flow-app/nodes/tools" - ] - }, - "versions/legacy/ja/user-guide/build-app/flow-app/orchestrate-node", - "versions/legacy/ja/user-guide/build-app/flow-app/file-upload", - "versions/legacy/ja/user-guide/build-app/flow-app/additional-feature" + "ja/develop-plugin/publishing/marketplace-listing/plugin-auto-publish-pr", + "ja/develop-plugin/publishing/marketplace-listing/release-overview", + "ja/develop-plugin/publishing/marketplace-listing/release-by-file", + "ja/develop-plugin/publishing/marketplace-listing/release-to-dify-marketplace", + "ja/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo" ] - } - ] - }, - { - "group": "アプリのデバッグ", - "pages": [ + }, { - "group": "チャットフロー & ワークフロー", + "group": "よくある質問", "pages": [ - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/preview-and-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/step-run", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/log", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/checklist", - "versions/legacy/ja/user-guide/debug-app/chatflow-and-workflow/history" + "ja/develop-plugin/publishing/faq/faq" ] } ] - }, - { - "group": "アプリのリリース", - "pages": [ - { - "group": "公開Webアプリとしてのリリース", - "pages": [ - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/web-app-settings", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/text-generator", - "versions/legacy/ja/user-guide/application-publishing/launch-your-webapp-quickly/conversation-application" - ] - }, - "versions/legacy/ja/user-guide/application-publishing/embedding-in-websites", - "versions/legacy/ja/user-guide/application-publishing/developing-with-apis", - "versions/legacy/ja/user-guide/application-publishing/based-on-frontend-templates" - ] - }, - { - "group": "管理", - "pages": [ - "versions/legacy/ja/user-guide/management/app-management", - "versions/legacy/ja/user-guide/management/team-members-management", - "versions/legacy/ja/user-guide/management/personal-account-management" - ] } ] } - ] + ], + "default": true } ] }