{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Dify Docs","description":"Dify is an open-source platform for building AI applications. It provides a comprehensive set of tools and features to help you build, deploy, and manage your AI applications.","colors":{"primary":"#0060FF","light":"#688FE8","dark":"#0034FF"},"logo":{"light":"https://assets-docs.dify.ai/2025/05/d05cfc6ebe48f725d171dc71c64a5d16.svg","dark":"https://assets-docs.dify.ai/2025/05/c51f1cda47c1d9a4a162d7736f6e4c53.svg","href":"https://docs.dify.ai"},"favicon":"https://mintcdn.com/dify-6c0370d8/7ofzWAXbPyxqXN2g/logo/dify-logo.png?fit=max\u0026auto=format\u0026n=7ofzWAXbPyxqXN2g\u0026q=85\u0026s=1ff6cbe1000cf72c39ff756308a85823","navbar":{"links":[{"href":"https://github.com/langgenius/dify","label":"GitHub"}],"primary":{"type":"button","label":"Try Dify","href":"https://cloud.dify.ai"}},"footer":{"socials":{"x":"https://x.com/dify_ai","github":"https://github.com/langgenius/dify-docs","linkedin":"https://www.linkedin.com/company/langgenius"}},"integrations":{"ga4":{"measurementId":"G-HHGQ6GKNCE"}},"contextual":{"options":["copy","view","download-spec","claude","chatgpt","perplexity","mcp","add-mcp","cursor","vscode","devin-mcp"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"en/cloud/use-dify/getting-started/introduction"},{"language":"zh","href":"zh/cloud/use-dify/getting-started/introduction"},{"language":"ja","href":"ja/cloud/use-dify/getting-started/introduction"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dify-6c0370d8","hasAudioNarration":false,"actualSubdomain":"dify-6c0370d8","customDomains":["docs.dify.ai"],"gitSource":{"type":"github","owner":"langgenius","repo":"dify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae16a14ea737d79d907d97f","collectionId":"0f4219d2-ead5-4040-a066-ef8aa0465206","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae16a14ea737d79d907d97f"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae19db1b41e76453cfb7b61","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"en","tag":"Self-Host","count":327},{"language":"ja","tag":"セルフホスト","count":327},{"language":"zh","tag":"自部署","count":327},{"language":"en","tag":"Developer Resources","count":205},{"language":"ja","tag":"開発者リソース","count":205},{"language":"zh","tag":"开发者资源","count":205},{"language":"en","tag":"Use","count":195},{"language":"ja","tag":"使い方","count":195},{"language":"zh","tag":"使用","count":195},{"language":"en","tag":"API","count":153},{"language":"ja","tag":"API","count":153},{"language":"zh","tag":"API","count":153},{"language":"en","tag":"Knowledge APIs","count":105},{"language":"ja","tag":"ナレッジ API","count":105},{"language":"zh","tag":"知识库 API","count":105},{"language":"en","tag":"Cloud","count":104},{"language":"ja","tag":"Cloud","count":104},{"language":"zh","tag":"Cloud","count":104},{"language":"en","tag":"Orchestrate","count":81},{"language":"ja","tag":"オーケストレーション","count":81},{"language":"zh","tag":"编排","count":81},{"language":"en","tag":"Agent Knowledge Base","count":68},{"language":"ja","tag":"Agent ナレッジベース","count":68},{"language":"zh","tag":"Agent 知识库","count":68},{"language":"en","tag":"Classic Knowledge Base","count":67},{"language":"ja","tag":"従来型ナレッジベース","count":67},{"language":"zh","tag":"经典知识库","count":67},{"language":"en","tag":"Workflow \u0026 Chatflow","count":66},{"language":"ja","tag":"Workflow と Chatflow","count":66},{"language":"zh","tag":"Workflow 与 Chatflow","count":66}],"searchSettings":{"maxResults":12}},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"body{text-autospace:normal}html[data-current-path=\"/\"] .nav-tabs,html[data-current-path=\"/en/home\"] .nav-tabs,html[data-current-path=\"/ja/home\"] .nav-tabs,html[data-current-path=\"/zh/home\"] .nav-tabs{display:none}#sidebar-content :has(>a[href=\"/en/home\"]),#sidebar-content :has(>a[href=\"/ja/home\"]),#sidebar-content :has(>a[href=\"/zh/home\"]),#sidebar-content a[href=\"/en/home\"],#sidebar-content a[href=\"/ja/home\"],#sidebar-content a[href=\"/zh/home\"]{display:none}.uo-wrap{max-width:64rem;margin:0 auto;padding:2.5rem 2rem 4rem}.uo-hero{display:flex;gap:40px;align-items:center;margin:0 0 48px}.uo-hero-text{flex:1 1 100%}.uo-actions{display:flex;flex-wrap:wrap;align-items:center;gap:20px;margin-top:24px}.uo-cta{display:inline-flex;align-items:center;gap:6px;background:#0060ff;color:#fff!important;padding:8px 18px;border-radius:8px;font-weight:600;text-decoration:none!important;border:0!important}.uo-cta:hover{background:#0034ff}.uo-secondary{font-weight:500}.uo-secondary a{text-decoration:none!important}.uo-secondary a:hover{color:#0060ff}.uo-grid{display:grid;grid-template-columns:repeat(6,minmax(0,1fr));gap:16px}.uo-grid>*{grid-column:span 2;margin:0}.uo-grid>:nth-child(4):nth-last-child(2){grid-column:2/span 2}.uo-help-links{display:flex;flex-wrap:wrap;align-items:center;gap:4px 8px;margin-top:10px;font-weight:500}@media (max-width:900px){.uo-grid{grid-template-columns:1fr}.uo-grid>*,.uo-grid>:nth-child(4):nth-last-child(2){grid-column:auto}}"}],"page":{"pagePath":"ja/api-reference/source-syncs-and-imports/import-website-pages","slug":"/ja/api-reference/source-syncs-and-imports/import-website-pages","pageMetadata":{"title":"ウェブサイトのページをインポート","description":"既知の URL をウェブサイトソースにインポートし、実行を返します。`state` が `completed`、`failed`、`canceled` のいずれかになるまで、その `id` で [ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run) をポーリングしてください。\n\n各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。\n\n実行が完了すると、`sourceUrls` がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。\n\nソースは `web` ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。\n\nウェブサイトのページをインポートする 2 つの方法については、[ウェブサイトのページのインポート](/ja/api-reference/guides/knowledge-base#import-website-pages) を参照してください。","deprecated":null,"version":null,"sidebarTitle":"ウェブサイトのページをインポート","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import","href":"/ja/api-reference/source-syncs-and-imports/import-website-pages","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"既知の URL をウェブサイトソースにインポートし、実行を返します。\", _jsx(_components.code, {\n children: \"state\"\n }), \" が \", _jsx(_components.code, {\n children: \"completed\"\n }), \"、\", _jsx(_components.code, {\n children: \"failed\"\n }), \"、\", _jsx(_components.code, {\n children: \"canceled\"\n }), \" のいずれかになるまで、その \", _jsx(_components.code, {\n children: \"id\"\n }), \" で \", _jsx(_components.a, {\n href: \"/ja/api-reference/source-syncs-and-imports/get-source-run\",\n children: \"ソースの実行を取得\"\n }), \" をポーリングしてください。\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"実行が完了すると、\", _jsx(_components.code, {\n children: \"sourceUrls\"\n }), \" がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"ソースは \", _jsx(_components.code, {\n children: \"web\"\n }), \" ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"ウェブサイトのページをインポートする 2 つの方法については、\", _jsx(_components.a, {\n href: \"/ja/api-reference/guides/knowledge-base#import-website-pages\",\n children: \"ウェブサイトのページのインポート\"\n }), \" を参照してください。\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"ウェブサイトのページをインポート","description":"既知の URL をウェブサイトソースにインポートし、実行を返します。`state` が `completed`、`failed`、`canceled` のいずれかになるまで、その `id` で [ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run) をポーリングしてください。\n\n各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。\n\n実行が完了すると、`sourceUrls` がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。\n\nソースは `web` ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。\n\nウェブサイトのページをインポートする 2 つの方法については、[ウェブサイトのページのインポート](/ja/api-reference/guides/knowledge-base#import-website-pages) を参照してください。","deprecated":null,"version":null,"sidebarTitle":"ウェブサイトのページをインポート","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import","href":"/ja/api-reference/source-syncs-and-imports/import-website-pages","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/dify-6c0370d8/90066d529e522771/contributing-footer.js"],"openApiReferenceData":{"operation":{"description":"既知の URL をウェブサイトソースにインポートし、実行を返します。`state` が `completed`、`failed`、`canceled` のいずれかになるまで、その `id` で [ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run) をポーリングしてください。\n\n各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。\n\n実行が完了すると、`sourceUrls` がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。\n\nソースは `web` ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。\n\nウェブサイトのページをインポートする 2 つの方法については、[ウェブサイトのページのインポート](/ja/api-reference/guides/knowledge-base#import-website-pages) を参照してください。","operationId":"importWebsitePages","parameters":["fede6706-e8bc-4ead-9d2f-9bedf0b8e2e5","c7c8de6f-12a6-4a4b-a8ea-b5d1dfda17d8","c1b59643-6826-4dad-ac4a-308924aa1cce"],"requestBody":"24609a8f-913c-4c74-9d90-d8c14ecc5f76","responses":{"202":"b18f0297-f317-421d-80a6-5208688a7275","400":"d189efc6-fa3d-4e45-ae14-6866db873b2b","401":"dcfc8dca-f1a6-409d-ba99-5f9f94c307fa","403":"4ec0bc4b-004e-4860-9a7f-868e538187e7","404":"61c8c9fb-72aa-451a-9551-668d5981a84e","409":"d78a16dc-ab4f-4b94-bb69-6da3176cefc1","413":"a861af14-57b7-45f6-833b-fbaa6232f294","502":"7bee5084-5cd5-45ea-8950-9ebb17b250b5","503":"df2558bc-54ce-4d77-8b6d-ad683fc8e729"},"summary":"ウェブサイトのページをインポート","tags":["Source Syncs and Imports"],"x-mint":{"href":"/ja/api-reference/source-syncs-and-imports/import-website-pages","metadata":{"sidebarTitle":"ウェブサイトのページをインポート","title":"ウェブサイトのページをインポート"}},"method":"post","type":"path","servers":["71002776-abb7-4c36-98f2-ee3c409fe32f"],"security":["ee693238-ceef-4828-b10e-766b8e137a69"],"path":"/knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import","baseUrlOptions":["https://{api_base_url}"],"title":"ウェブサイトのページをインポート","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fede6706-e8bc-4ead-9d2f-9bedf0b8e2e5":{"description":"ナレッジベース ID です。ナレッジベースの **API アクセス** ダイアログに表示されるサービス API エンドポイントの最後のセグメント(`…/knowledge-fs/spaces/\u003cknowledge base ID>`)です。アドレスバーでは `/datasets/new/` の後のセグメントです。","in":"path","name":"knowledge_base_id","required":true,"schema":{"format":"uuid","type":"string","isRequired":true,"description":"ナレッジベース ID です。ナレッジベースの **API アクセス** ダイアログに表示されるサービス API エンドポイントの最後のセグメント(`…/knowledge-fs/spaces/\u003cknowledge base ID>`)です。アドレスバーでは `/datasets/new/` の後のセグメントです。","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"c7c8de6f-12a6-4a4b-a8ea-b5d1dfda17d8":{"description":"ソース ID です。[ソース一覧を取得](/ja/api-reference/sources/list-sources) から取得します。","in":"path","name":"source_id","required":true,"schema":{"format":"uuid","type":"string","isRequired":true,"description":"ソース ID です。[ソース一覧を取得](/ja/api-reference/sources/list-sources) から取得します。","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"c1b59643-6826-4dad-ac4a-308924aa1cce":{"description":"同じ API キーで同じ冪等キーと同じリクエストを再送信すると、元の実行が現在の状態で返されます。開始するインポートごとに新しいキーを使用してください。このソースで同じキーを異なるボディとともに再利用すると、`409` が返ります。前後に空白を含まない、印字可能な ASCII 文字を使用してください。","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":255,"minLength":8,"type":"string","isRequired":true,"description":"同じ API キーで同じ冪等キーと同じリクエストを再送信すると、元の実行が現在の状態で返されます。開始するインポートごとに新しいキーを使用してください。このソースで同じキーを異なるボディとともに再利用すると、`409` が返ります。前後に空白を含まない、印字可能な ASCII 文字を使用してください。","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"examples":{"request":{"title":"request","value":{"replaceExistingSelection":true,"sourceUrls":["https://docs.example.com/guides/billing","https://docs.example.com/pricing"]}}},"schema":{"properties":{"sourceUrls":{"description":"インポートする URL です。同じ URL は 1 回だけ指定します。前後の空白は取り除かれます。","items":{"maxLength":4096,"minLength":1,"type":"string","uniqueKey":"sourceUrls.items.[INDEX]","typeLabel":"string"},"maxItems":200,"minItems":1,"type":"array","isRequired":true,"uniqueKey":"sourceUrls","typeLabel":"string[]"},"replaceExistingSelection":{"default":false,"description":"`true` にすると、`sourceUrls` に含まれないページに対応するソースのドキュメントを、同じ実行で削除します。","type":"boolean","uniqueKey":"replaceExistingSelection","typeLabel":"boolean"}},"required":["sourceUrls"],"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"正規化後のリクエストは、UTF-8 で 1,048,576 バイト以内に収める必要があります。[リクエストサイズの制限](/ja/api-reference/guides/knowledge-base#request-size-limits) を参照してください。","required":true,"exampleType":"examples"},"responses":{"b18f0297-f317-421d-80a6-5208688a7275":{"content":{"application/json":{"examples":{"success":{"title":"success","value":{"canceled_at":null,"checkpoint":"queued","completed_at":null,"created_at":"2026-10-20T10:00:00Z","cursor":null,"execution_attempts":0,"failure":null,"id":"e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b","kind":"crawl-import","knowledge_space_id":"0a9d3c2e-5b6f-4e1a-8c7d-2f3e4a5b6c7d","last_error_code":null,"max_execution_attempts":5,"progress_completed":0,"progress_failed":0,"progress_skipped":0,"progress_total":2,"source_id":"6f1c2b0e-3d0b-4a5e-9f4c-1c0e6a7b8d90","state":"queued","updated_at":"2026-10-20T10:00:00Z"}}},"schema":{"properties":{"canceled_at":{"oneOf":[{"description":"実行がキャンセルされた日時です。`state` が `canceled` でない場合は `null` です。","type":"string","uniqueKey":"canceled_at.oneOf.0","typeLabel":"string"},{"description":"実行がキャンセルされた日時です。`state` が `canceled` でない場合は `null` です。","type":"null","uniqueKey":"canceled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"canceled_at","typeLabel":"string | null"},"checkpoint":{"description":"実行が到達した最後のステップで、`queued`、`provider-read`、`preview-staged`、`selection-frozen`、`materialized`、`cleanup-staging`、`source-committed` のいずれかです。[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) は、チェックポイントにかかわらず実行を最初からやり直します。","type":"string","uniqueKey":"checkpoint","typeLabel":"string"},"completed_at":{"oneOf":[{"description":"実行が `completed`、`zero_results`、`failed`、`canceled` のいずれかで終了した日時(ISO 8601)です。実行中は `null` です。","type":"string","uniqueKey":"completed_at.oneOf.0","typeLabel":"string"},{"description":"実行が `completed`、`zero_results`、`failed`、`canceled` のいずれかで終了した日時(ISO 8601)です。実行中は `null` です。","type":"null","uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"completed_at","typeLabel":"string | null"},"created_at":{"description":"作成日時(ISO 8601)です。","type":"string","uniqueKey":"created_at","typeLabel":"string"},"cursor":{"oneOf":[{"description":"実行の再開位置となるプロバイダーのカーソルです。実行がページ送りをしていない場合は `null` です。","type":"string","uniqueKey":"cursor.oneOf.0","typeLabel":"string"},{"description":"実行の再開位置となるプロバイダーのカーソルです。実行がページ送りをしていない場合は `null` です。","type":"null","uniqueKey":"cursor.oneOf.1","typeLabel":"null"}],"uniqueKey":"cursor","typeLabel":"string | null"},"execution_attempts":{"description":"ワーカーが実行を取得した回数です。[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) の後の取得も含み、再試行してもリセットされません。","type":"integer","uniqueKey":"execution_attempts","typeLabel":"integer"},"failure":{"oneOf":[{"type":"object","description":"`state` が `failed` の場合のエラー詳細です。`stage` は失敗時点の実行の `checkpoint`、`traceId` は実行 ID です。それ以外の場合は `null` です。","properties":{"action":{"oneOf":[{"description":"推奨される次の対応です。ある場合は `configure_model`、`configure_parser`、`configure_source`、`contact_admin`、`reupload`、`retry` のいずれかです。該当しない場合は `null` で、HTTP エラーのボディでは省略されます。","type":"string","uniqueKey":"failure.oneOf.0.action.oneOf.0","typeLabel":"string"},{"description":"推奨される次の対応です。ある場合は `configure_model`、`configure_parser`、`configure_source`、`contact_admin`、`reupload`、`retry` のいずれかです。該当しない場合は `null` で、HTTP エラーのボディでは省略されます。","type":"null","uniqueKey":"failure.oneOf.0.action.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure.oneOf.0.action","typeLabel":"string | null"},"category":{"description":"失敗の種類で、`authorization`、`canceled`、`configuration`、`conflict`、`dependency`、`internal`、`not_found`、`rate_limit`、`timeout`、`validation` のいずれかです。","type":"string","uniqueKey":"failure.oneOf.0.category","typeLabel":"string"},"code":{"description":"大文字のスネークケースで表される固定のエラーコードです(例:`KNOWLEDGE_FS_CONFLICT`、`SOURCE_CREDENTIAL_TEST_FAILED`)。","type":"string","uniqueKey":"failure.oneOf.0.code","typeLabel":"string"},"message":{"description":"エラーコードまたは失敗の種類に対応する公開用メッセージです。プロバイダーのエラー詳細は公開されません。","type":"string","uniqueKey":"failure.oneOf.0.message","typeLabel":"string"},"parameters":{"oneOf":[{"additionalProperties":true,"description":"失敗の内容を補足する最大 8 個の値です。キーは `attempt`、`currentRowVersion`、`documentCount`、`expectedRowVersion`、`fileSizeBytes`、`limit`、`maxFileSizeBytes`、`maxItems`、`modelType`、`providerKind`、`retryAfterSeconds`、`status` のいずれかです。値がない場合は `null` で、HTTP エラーのボディでは省略されます。","type":"object","uniqueKey":"failure.oneOf.0.parameters.oneOf.0","typeLabel":"object"},{"additionalProperties":true,"description":"失敗の内容を補足する最大 8 個の値です。キーは `attempt`、`currentRowVersion`、`documentCount`、`expectedRowVersion`、`fileSizeBytes`、`limit`、`maxFileSizeBytes`、`maxItems`、`modelType`、`providerKind`、`retryAfterSeconds`、`status` のいずれかです。値がない場合は `null` で、HTTP エラーのボディでは省略されます。","type":"null","uniqueKey":"failure.oneOf.0.parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure.oneOf.0.parameters","typeLabel":"object | null"},"retryPolicy":{"description":"再試行で解決できるかどうかです。`automatic`(サービスが自動で再試行)、`manual`(呼び出し側で再試行)、`after_configuration`(先に Dify でナレッジベースの設定を修正)、`never`(リクエストを変更)のいずれかです。","type":"string","uniqueKey":"failure.oneOf.0.retryPolicy","typeLabel":"string"},"stage":{"oneOf":[{"description":"失敗が発生した段階です(例:`query_generation`、`credential-test`)。該当しない場合は `null` で、HTTP エラーのボディでは省略されます。","type":"string","uniqueKey":"failure.oneOf.0.stage.oneOf.0","typeLabel":"string"},{"description":"失敗が発生した段階です(例:`query_generation`、`credential-test`)。該当しない場合は `null` で、HTTP エラーのボディでは省略されます。","type":"null","uniqueKey":"failure.oneOf.0.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure.oneOf.0.stage","typeLabel":"string | null"},"traceId":{"oneOf":[{"description":"管理者に問い合わせる際に伝える参照情報です。失敗の詳細を含む成功レスポンスでは `null` になることがあり、HTTP エラーのボディでは省略されることがあります。","type":"string","uniqueKey":"failure.oneOf.0.traceId.oneOf.0","typeLabel":"string"},{"description":"管理者に問い合わせる際に伝える参照情報です。失敗の詳細を含む成功レスポンスでは `null` になることがあり、HTTP エラーのボディでは省略されることがあります。","type":"null","uniqueKey":"failure.oneOf.0.traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure.oneOf.0.traceId","typeLabel":"string | null"}},"uniqueKey":"failure.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"failure.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure","typeLabel":"object | null"},"id":{"description":"実行 ID です。[ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run)、[ソースの実行をキャンセル](/ja/api-reference/source-syncs-and-imports/cancel-source-run)、[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) に渡します。","type":"string","uniqueKey":"id","typeLabel":"string"},"kind":{"description":"実行の処理内容です:\n\n- `sync`:[ソースを同期](/ja/api-reference/source-syncs-and-imports/sync-source)、[ソースを更新](/ja/api-reference/sources/update-source)、スケジュール、または Dify によって開始されます。\n- `crawl-preview`:[ウェブサイトのクロールをプレビュー](/ja/api-reference/source-syncs-and-imports/preview-website-crawl) によって開始されます。[選択したページをインポート](/ja/api-reference/source-syncs-and-imports/import-selected-pages) がこの実行からインポートしている間も、種類は変わりません。\n- `crawl-import`:[ウェブサイトのページをインポート](/ja/api-reference/source-syncs-and-imports/import-website-pages) によって開始されます。\n- `online-document-import`、`online-drive-import`:[ソースのアイテムをインポート](/ja/api-reference/source-syncs-and-imports/import-source-items) によって開始されます。\n\nDify でソースを追加または編集した場合も、Dify がプレビューとインポートを開始します。","type":"string","uniqueKey":"kind","typeLabel":"string"},"knowledge_space_id":{"description":"ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。","type":"string","uniqueKey":"knowledge_space_id","typeLabel":"string"},"last_error_code":{"oneOf":[{"description":"`state` が `failed` の場合は `failure.code` の値です。それ以外の場合は `null` です。","type":"string","uniqueKey":"last_error_code.oneOf.0","typeLabel":"string"},{"description":"`state` が `failed` の場合は `failure.code` の値です。それ以外の場合は `null` です。","type":"null","uniqueKey":"last_error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_error_code","typeLabel":"string | null"},"max_execution_attempts":{"description":"`execution_attempts` の上限です。上限に達すると、[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) は `409` を返します。","type":"integer","uniqueKey":"max_execution_attempts","typeLabel":"integer"},"progress_completed":{"description":"完了したアイテム数です。同期で確認された未変更のアイテムも含みます。","type":"integer","uniqueKey":"progress_completed","typeLabel":"integer"},"progress_failed":{"description":"ソースの実行では常に `0` です。1 つのアイテムが失敗すると、実行全体が失敗するためです。","type":"integer","uniqueKey":"progress_failed","typeLabel":"integer"},"progress_skipped":{"description":"ソースの実行では常に `0` です。","type":"integer","uniqueKey":"progress_skipped","typeLabel":"integer"},"progress_total":{"oneOf":[{"description":"実行が処理する予定のアイテム数です。インポートではリクエストされたページまたはアイテム、クロールプレビューではこれまでに一時保存されたページ、同期では一覧の取得後のソースのアイテムを数えます。判明するまでは `null` です。\n\n[ウェブサイトのページをインポート](/ja/api-reference/source-syncs-and-imports/import-website-pages) の実行が URL をクロールしている間は、`progress_completed` と `progress_total` のどちらも、それまでにクロールしたページ数を数えます。すべての URL のクロールが終わると、URL の数を総数として `0` から数え直します。","type":"integer","uniqueKey":"progress_total.oneOf.0","typeLabel":"integer"},{"description":"実行が処理する予定のアイテム数です。インポートではリクエストされたページまたはアイテム、クロールプレビューではこれまでに一時保存されたページ、同期では一覧の取得後のソースのアイテムを数えます。判明するまでは `null` です。\n\n[ウェブサイトのページをインポート](/ja/api-reference/source-syncs-and-imports/import-website-pages) の実行が URL をクロールしている間は、`progress_completed` と `progress_total` のどちらも、それまでにクロールしたページ数を数えます。すべての URL のクロールが終わると、URL の数を総数として `0` から数え直します。","type":"null","uniqueKey":"progress_total.oneOf.1","typeLabel":"null"}],"uniqueKey":"progress_total","typeLabel":"integer | null"},"source_id":{"oneOf":[{"description":"実行が属するソースです。","type":"string","uniqueKey":"source_id.oneOf.0","typeLabel":"string"},{"description":"実行が属するソースです。","type":"null","uniqueKey":"source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_id","typeLabel":"string | null"},"state":{"description":"実行の進行状況です。\n\n進行中の状態:\n\n- `queued`:ワーカー待ち\n- `crawling`:クロールプレビューによるページの取得中\n- `preview_ready`:クロールプレビューが [選択したページをインポート](/ja/api-reference/source-syncs-and-imports/import-selected-pages) または [ソースの実行をキャンセル](/ja/api-reference/source-syncs-and-imports/cancel-source-run) を待機中\n- `importing`:アイテムのインポートとインデックス処理中\n- `syncing`:ソースのドキュメントを更新中\n\n最終状態:\n\n- `completed`:すべてのアイテムのインポートまたは更新、インデックス処理、アクティブ化が完了\n- `zero_results`:クロールプレビューで見つかったページが 0 件\n- `failed`:`failure` を参照\n- `canceled`\n\n`failed` または `canceled` の後は、[ソースの実行を再試行](/ja/api-reference/source-syncs-and-imports/retry-source-run) で再実行でき、[ソースを同期](/ja/api-reference/source-syncs-and-imports/sync-source) で新しい同期を開始できます。","type":"string","uniqueKey":"state","typeLabel":"string"},"updated_at":{"description":"最終更新日時(ISO 8601)です。","type":"string","uniqueKey":"updated_at","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"`kind: crawl-import`、`state: queued` で、`progress_total` に URL の数が設定された実行です。","exampleType":"examples"},"d189efc6-fa3d-4e45-ae14-6866db873b2b":{"content":{"application/json":{"examples":{"knowledge_fs_invalid_request_local":{"title":"knowledge_fs_invalid_request_local","value":{"code":"knowledge_fs_invalid_request","message":"Agent Knowledge Base request is invalid.","status":400,"violations":[{"field":["sourceUrls"],"type":"too_long"}]}},"knowledge_fs_invalid_request_path":{"title":"knowledge_fs_invalid_request_path","value":{"code":"knowledge_fs_invalid_request","message":"Agent Knowledge Base request is invalid.","status":400}},"knowledge_fs_invalid_request_upstream":{"title":"knowledge_fs_invalid_request_upstream","value":{"code":"knowledge_fs_invalid_request","failure":{"category":"validation","code":"KNOWLEDGE_FS_INVALID_REQUEST","message":"The Agent Knowledge Base request is invalid.","retryPolicy":"never","traceId":"7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"},"message":"The Agent Knowledge Base request is invalid.","status":400}}},"exampleType":"examples"}},"description":"- `knowledge_fs_invalid_request`:リクエストが検証に失敗しました。`violations` には、問題のあるフィールドがそれぞれ示されます。`sourceUrls` の欠落または空、200 件を超える URL、空または長すぎる URL、ボディの不明なキー、`Idempotency-Key` のルール違反がこれに該当します。\n- `knowledge_fs_invalid_request`:ソースが `web` ソースではない、URL が有効な URL ではない、または `source_id` が UUID ではありません。\n- `knowledge_fs_invalid_request`:`source_id` の形式が正しくありません。","exampleType":"examples"},"dcfc8dca-f1a6-409d-ba99-5f9f94c307fa":{"content":{"application/json":{"examples":{"knowledge_fs_invalid_credential":{"title":"knowledge_fs_invalid_credential","value":{"code":"knowledge_fs_invalid_credential","message":"Invalid Agent Knowledge Base service credential.","status":401}},"unauthorized":{"title":"unauthorized","value":{"code":"unauthorized","message":"Access token is invalid","status":401}}},"exampleType":"examples"}},"description":"- `unauthorized`:`Authorization` ヘッダーがないか、キーが不明であるか、ナレッジベースの API キーではありません。\n- `knowledge_fs_invalid_credential`:キーは有効ですが、キーのワークスペースにこの ID のナレッジベースが存在しないか、キーがワークスペースに紐付いていません。","exampleType":"examples"},"4ec0bc4b-004e-4860-9a7f-868e538187e7":{"content":{"application/json":{"examples":{"forbidden":{"title":"forbidden","value":{"code":"forbidden","message":"Sorry, you have reached the knowledge base request rate limit of your subscription.","status":403}},"knowledge_fs_access_denied_scope":{"title":"knowledge_fs_access_denied_scope","value":{"code":"knowledge_fs_access_denied","message":"Agent Knowledge Base operation is not allowed.","status":403}}},"exampleType":"examples"}},"description":"- `knowledge_fs_access_denied`:キーのアクセス範囲がほかのナレッジベースに限定されているか、このナレッジベースで **API アクセス** がオフになっています。または、ナレッジベースがアクティブではありません。\n- `forbidden`:Dify Cloud で、ワークスペースがサブスクリプションで定められたナレッジベースのリクエストレート制限に達しました。読み取りを含め、すべての呼び出しがカウントされます。","exampleType":"examples"},"61c8c9fb-72aa-451a-9551-668d5981a84e":{"content":{"application/json":{"examples":{"knowledge_fs_resource_not_found":{"title":"knowledge_fs_resource_not_found","value":{"code":"knowledge_fs_resource_not_found","failure":{"category":"not_found","code":"KNOWLEDGE_FS_NOT_FOUND","message":"The requested Agent Knowledge Base resource was not found.","retryPolicy":"never","traceId":"7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"},"message":"The requested Agent Knowledge Base resource was not found.","status":404}},"not_found":{"title":"not_found","value":{"code":"not_found","message":"The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.","status":404}}},"exampleType":"examples"}},"description":"- `knowledge_fs_resource_not_found`:この ID のソースがナレッジベースに存在しない、キーでそのソースを読み取れない、またはソースの削除がすでに受け付けられています。\n- `not_found`:このデプロイ環境では Agent ナレッジベース機能が無効になっています。","exampleType":"examples"},"d78a16dc-ab4f-4b94-bb69-6da3176cefc1":{"content":{"application/json":{"examples":{"knowledge_fs_conflict":{"title":"knowledge_fs_conflict","value":{"code":"knowledge_fs_conflict","failure":{"action":"retry","category":"conflict","code":"KNOWLEDGE_FS_CONFLICT","message":"The Agent Knowledge Base operation conflicts with the current resource state.","retryPolicy":"manual","traceId":"7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"},"message":"The Agent Knowledge Base operation conflicts with the current resource state.","status":409}}},"exampleType":"examples"}},"description":"- `knowledge_fs_conflict`:この API キーは、このソースで同じ `Idempotency-Key` を別のリクエストにすでに使用しています。","exampleType":"examples"},"a861af14-57b7-45f6-833b-fbaa6232f294":{"content":{"application/json":{"examples":{"knowledge_fs_request_too_large":{"title":"knowledge_fs_request_too_large","value":{"code":"knowledge_fs_request_too_large","message":"Agent Knowledge Base request is too large.","status":413}}},"exampleType":"examples"}},"description":"- `knowledge_fs_request_too_large`:Dify がデフォルト値を追加した後のリクエストが、UTF-8 で 1,048,576 バイトを超えています。[リクエストサイズの制限](/ja/api-reference/guides/knowledge-base#request-size-limits) を参照してください。","exampleType":"examples"},"7bee5084-5cd5-45ea-8950-9ebb17b250b5":{"content":{"application/json":{"examples":{"knowledge_fs_upstream_unavailable":{"title":"knowledge_fs_upstream_unavailable","value":{"code":"knowledge_fs_upstream_unavailable","failure":{"action":"contact_admin","category":"internal","code":"KNOWLEDGE_FS_INTERNAL_ERROR","message":"Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.","retryPolicy":"manual","traceId":"5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"},"message":"Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.","status":502}},"knowledge_fs_upstream_unavailable_transport":{"title":"knowledge_fs_upstream_unavailable_transport","value":{"code":"knowledge_fs_upstream_unavailable","message":"Agent Knowledge Base is unavailable.","status":502}}},"exampleType":"examples"}},"description":"- `knowledge_fs_upstream_unavailable`:時間内に応答が返らなかったか、応答を読み取れませんでした。\n\n実行が開始されている可能性があります。同じ `Idempotency-Key` で同じリクエストを再送信してください。実行が開始されていた場合は、その実行が返されます。","exampleType":"examples"},"df2558bc-54ce-4d77-8b6d-ad683fc8e729":{"content":{"application/json":{"examples":{"knowledge_fs_operation_unavailable":{"title":"knowledge_fs_operation_unavailable","value":{"code":"knowledge_fs_operation_unavailable","message":"Agent Knowledge Base operation is not available.","status":503}},"knowledge_fs_operation_unavailable_upstream":{"title":"knowledge_fs_operation_unavailable_upstream","value":{"code":"knowledge_fs_operation_unavailable","failure":{"action":"retry","category":"dependency","code":"KNOWLEDGE_FS_UNAVAILABLE","message":"A service required by Agent Knowledge Base is temporarily unavailable.","retryPolicy":"manual","traceId":"5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"},"message":"A service required by Agent Knowledge Base is temporarily unavailable.","status":503}}},"exampleType":"examples"}},"description":"- `knowledge_fs_operation_unavailable`:このワークスペースで Agent ナレッジベース機能が設定されていないか、このデプロイ環境ではこの操作を利用できません。または、リクエストの認可中に、このナレッジベースに対するキーのアクセス権が変更されました。\n- `knowledge_fs_operation_unavailable`:現在このリクエストを処理できません。`failure.retryPolicy` に従ってください。","exampleType":"examples"}},"security":{"ee693238-ceef-4828-b10e-766b8e137a69":{"ApiKeyAuth":{"bearerFormat":"API_KEY","description":"すべてのリクエストは API キーで認証します:`Authorization: Bearer {API_KEY}`。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します([Dify API クイックスタート](/ja/api-reference/guides/get-started))。\n\nキーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP `401`(`unauthorized`)で失敗します。","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"71002776-abb7-4c36-98f2-ee3c409fe32f":{"description":"Dify サービス API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。","url":"https://{api_base_url}","variables":{"api_base_url":{"default":"api.dify.ai/v1","description":"API ベース URL のホストとパス(`https://` を除く)。"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"API_KEY","description":"すべてのリクエストは API キーで認証します:`Authorization: Bearer {API_KEY}`。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します([Dify API クイックスタート](/ja/api-reference/guides/get-started))。\n\nキーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP `401`(`unauthorized`)で失敗します。","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"すべてのリクエストは API キーで認証します:`Authorization: Bearer {API_KEY}`。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します([Dify API クイックスタート](/ja/api-reference/guides/get-started))。\n\nキーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP `401`(`unauthorized`)で失敗します。","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"ja/api-reference/openapi_service.json"},"subdomain":"dify-6c0370d8","siteName":"Dify Docs","title":"ウェブサイトのページをインポート - Dify Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"ja/api-reference/source-syncs-and-imports/import-website-pages.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"既知の URL をウェブサイトソースにインポートし、実行を返します。state が completed、failed、canceled のいずれかになるまで、その id で ソースの実行を取得 をポーリングしてください。 各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。 実行が完了すると、sourceUrls がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。 ソースは web ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。 ウェブサイトのページをインポートする 2 つの方法については、ウェブサイトのページのインポート を参照してください。\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dify Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"ウェブサイトのページをインポート - Dify Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"既知の URL をウェブサイトソースにインポートし、実行を返します。state が completed、failed、canceled のいずれかになるまで、その id で ソースの実行を取得 をポーリングしてください。 各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。 実行が完了すると、sourceUrls がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。 ソースは web ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。 ウェブサイトのページをインポートする 2 つの方法については、ウェブサイトのページのインポート を参照してください。\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dify Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dify-6c0370d8.mintlify.app/_mintlify/api/og/v2?division=%E3%82%BD%E3%83%BC%E3%82%B9%E3%81%AE%E5%90%8C%E6%9C%9F%E3%81%A8%E3%82%A4%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%88\u0026amp;title=%E3%82%A6%E3%82%A7%E3%83%96%E3%82%B5%E3%82%A4%E3%83%88%E3%81%AE%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E3%82%A4%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%88\u0026amp;description=%E6%97%A2%E7%9F%A5%E3%81%AE+URL+%E3%82%92%E3%82%A6%E3%82%A7%E3%83%96%E3%82%B5%E3%82%A4%E3%83%88%E3%82%BD%E3%83%BC%E3%82%B9%E3%81%AB%E3%82%A4%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%88%E3%81%97%E3%80%81%E5%AE%9F%E8%A1%8C%E3%82%92%E8%BF%94%E3%81%97%E3%81%BE%E3%81%99%E3%80%82%60state%60+%E3%81%8C+%60completed%60%E3%80%81%60failed%60%E3%80%81%60canceled%60+%E3%81%AE%E3%81%84%E3%81%9A%E3%82%8C%E3%81%8B%E3%81%AB%E3%81%AA%E3%82%8B%E3%81%BE%E3%81%A7%E3%80%81%E3%81%9D%E3%81%AE+%60id%60+%E3%81%A7+%5B%E3%82%BD%E3%83%BC%E3%82%B9%E3%81%AE%E5%AE%9F%E8%A1%8C%E3%82%92%E5%8F%96%E5%BE%97%5D%28%2Fja%2Fapi-reference%2Fsource-syncs-and-imports%2Fget-sour\u0026amp;theme=fc270d2c96587e5833522f0e\u0026amp;signature=b1d5788448370fd098a3b37a43cc877c4f7296a40d80e545f4bbbf72698527b6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"ウェブサイトのページをインポート - Dify Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"既知の URL をウェブサイトソースにインポートし、実行を返します。state が completed、failed、canceled のいずれかになるまで、その id で ソースの実行を取得 をポーリングしてください。 各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。 実行が完了すると、sourceUrls がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。 ソースは web ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。 ウェブサイトのページをインポートする 2 つの方法については、ウェブサイトのページのインポート を参照してください。\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dify-6c0370d8.mintlify.app/_mintlify/api/og/v2?division=%E3%82%BD%E3%83%BC%E3%82%B9%E3%81%AE%E5%90%8C%E6%9C%9F%E3%81%A8%E3%82%A4%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%88\u0026amp;title=%E3%82%A6%E3%82%A7%E3%83%96%E3%82%B5%E3%82%A4%E3%83%88%E3%81%AE%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E3%82%A4%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%88\u0026amp;description=%E6%97%A2%E7%9F%A5%E3%81%AE+URL+%E3%82%92%E3%82%A6%E3%82%A7%E3%83%96%E3%82%B5%E3%82%A4%E3%83%88%E3%82%BD%E3%83%BC%E3%82%B9%E3%81%AB%E3%82%A4%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%88%E3%81%97%E3%80%81%E5%AE%9F%E8%A1%8C%E3%82%92%E8%BF%94%E3%81%97%E3%81%BE%E3%81%99%E3%80%82%60state%60+%E3%81%8C+%60completed%60%E3%80%81%60failed%60%E3%80%81%60canceled%60+%E3%81%AE%E3%81%84%E3%81%9A%E3%82%8C%E3%81%8B%E3%81%AB%E3%81%AA%E3%82%8B%E3%81%BE%E3%81%A7%E3%80%81%E3%81%9D%E3%81%AE+%60id%60+%E3%81%A7+%5B%E3%82%BD%E3%83%BC%E3%82%B9%E3%81%AE%E5%AE%9F%E8%A1%8C%E3%82%92%E5%8F%96%E5%BE%97%5D%28%2Fja%2Fapi-reference%2Fsource-syncs-and-imports%2Fget-sour\u0026amp;theme=fc270d2c96587e5833522f0e\u0026amp;signature=b1d5788448370fd098a3b37a43cc877c4f7296a40d80e545f4bbbf72698527b6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/dify-6c0370d8/tWYYD8GkT0MUJV0z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dify Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0060FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/ja/api-reference/source-syncs-and-imports/import-website-pages.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dify.ai/#organization\",\"name\":\"Dify Docs\",\"url\":\"https://docs.dify.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://assets-docs.dify.ai/2025/05/d05cfc6ebe48f725d171dc71c64a5d16.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dify.ai#website\",\"name\":\"Dify Docs\",\"url\":\"https://docs.dify.ai\",\"publisher\":{\"@id\":\"https://docs.dify.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages#webpage\",\"url\":\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages\",\"name\":\"ウェブサイトのページをインポート\",\"description\":\"既知の URL をウェブサイトソースにインポートし、実行を返します。state が completed、failed、canceled のいずれかになるまで、その id で ソースの実行を取得 をポーリングしてください。 各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。 実行が完了すると、sourceUrls がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。 ソースは web ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。 ウェブサイトのページをインポートする 2 つの方法については、ウェブサイトのページのインポート を参照してください。\",\"isPartOf\":{\"@id\":\"https://docs.dify.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"ナレッジ API\",\"item\":\"https://docs.dify.ai/ja/api-reference/queries/create-query-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agent ナレッジベース\",\"item\":\"https://docs.dify.ai/ja/api-reference/queries/create-query-token\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"ソースの同期とインポート\",\"item\":\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/sync-source\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"ウェブサイトのページをインポート\",\"item\":\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages#apireference\",\"headline\":\"ウェブサイトのページをインポート\",\"name\":\"ウェブサイトのページをインポート\",\"description\":\"既知の URL をウェブサイトソースにインポートし、実行を返します。state が completed、failed、canceled のいずれかになるまで、その id で ソースの実行を取得 をポーリングしてください。 各 URL は個別にクロールされ、すべての URL のクロールが終わるとインポートが始まります。ページを返さない URL があると、ページがインポートされる前に実行が失敗し、ソースのドキュメントは変更されません。 実行が完了すると、sourceUrls がソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したい URL はすべて送信してください。 ソースは web ソースである必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけです。別の実行を開始する前に、アクティブな実行が終わるのを待ってください。インポートしないクロールプレビューはキャンセルしてください。 ウェブサイトのページをインポートする 2 つの方法については、ウェブサイトのページのインポート を参照してください。\",\"url\":\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dify.ai/ja/api-reference/source-syncs-and-imports/import-website-pages#webpage\"},\"publisher\":{\"@id\":\"https://docs.dify.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dify.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dify Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Dify Docs","nav":{"global":null,"languages":[{"language":"en","default":true,"products":[{"product":"Cloud","icon":"cloud","tabs":[{"tab":"Use","icon":"book-open","pages":[{"title":"Use Dify","sidebarTitle":"Overview","mode":"frame","href":"/en/cloud/use-dify/getting-started/introduction"},{"title":"Dify Documentation","mode":"custom","hidden":true,"href":"/en/home"},{"group":"Orchestrate","icon":"hammer","pages":[{"group":"Workflow \u0026 Chatflow","expanded":false,"pages":[{"title":"Workflow \u0026 Chatflow","sidebarTitle":"Overview","href":"/en/cloud/use-dify/build/workflow-chatflow"},{"title":"Orchestration Logic","href":"/en/cloud/use-dify/build/orchestrate-node"},{"group":"Nodes","expanded":false,"pages":[{"group":"Start","root":{"title":"Start Node","href":"/en/cloud/use-dify/nodes/start"},"pages":[{"title":"User Input","href":"/en/cloud/use-dify/nodes/user-input"},{"group":"Trigger","root":{"title":"Trigger","sidebarTitle":"Overview","href":"/en/cloud/use-dify/nodes/trigger/overview"},"pages":[{"title":"Schedule Trigger","href":"/en/cloud/use-dify/nodes/trigger/schedule-trigger"},{"title":"Integration Trigger","href":"/en/cloud/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook Trigger","href":"/en/cloud/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"LLM","href":"/en/cloud/use-dify/nodes/llm"},{"title":"Agent Knowledge Retrieval","href":"/en/cloud/use-dify/nodes/knowledge-retrieval-v2"},{"title":"Classic Knowledge Retrieval","href":"/en/cloud/use-dify/nodes/knowledge-retrieval"},{"title":"Answer","href":"/en/cloud/use-dify/nodes/answer"},{"title":"Output","href":"/en/cloud/use-dify/nodes/output"},{"title":"Agent","href":"/en/cloud/use-dify/nodes/agent"},{"title":"Question Classifier","href":"/en/cloud/use-dify/nodes/question-classifier"},{"title":"If-Else","href":"/en/cloud/use-dify/nodes/ifelse"},{"group":"Human Input","root":{"title":"Human Input","href":"/en/cloud/use-dify/nodes/human-input"},"expanded":false,"pages":[]},{"title":"Iteration","href":"/en/cloud/use-dify/nodes/iteration"},{"title":"Loop","href":"/en/cloud/use-dify/nodes/loop"},{"title":"Code","href":"/en/cloud/use-dify/nodes/code"},{"title":"Template","href":"/en/cloud/use-dify/nodes/template"},{"title":"Variable Aggregator","href":"/en/cloud/use-dify/nodes/variable-aggregator"},{"title":"Document Extractor","href":"/en/cloud/use-dify/nodes/doc-extractor"},{"title":"Variable Assigner","href":"/en/cloud/use-dify/nodes/variable-assigner"},{"title":"Parameter Extractor","href":"/en/cloud/use-dify/nodes/parameter-extractor"},{"title":"HTTP Request","href":"/en/cloud/use-dify/nodes/http-request"},{"title":"List Operator","href":"/en/cloud/use-dify/nodes/list-operator"},{"title":"Tool Node","sidebarTitle":"Tool","href":"/en/cloud/use-dify/nodes/tools"}]},{"title":"Hotkeys","href":"/en/cloud/use-dify/build/shortcut-key"},{"title":"Version Control","href":"/en/cloud/use-dify/build/version-control"},{"title":"Snippets","sidebarTitle":"Snippets","href":"/en/cloud/use-dify/build/snippet"},{"group":"Debug","expanded":false,"pages":[{"title":"Handle Errors","href":"/en/cloud/use-dify/build/predefined-error-handling-logic"},{"title":"Single Node","href":"/en/cloud/use-dify/debug/step-run"},{"title":"Variable Inspector","href":"/en/cloud/use-dify/debug/variable-inspect"},{"title":"Run History","href":"/en/cloud/use-dify/debug/history-and-logs"},{"title":"Error Types","href":"/en/cloud/use-dify/debug/error-type"}]}]},{"group":"Agent","tag":"New","expanded":false,"pages":[{"title":"Agent","sidebarTitle":"Overview","href":"/en/cloud/use-dify/build/new-agent/overview"},{"title":"Build an Agent","sidebarTitle":"Build","href":"/en/cloud/use-dify/build/new-agent/build"}]},{"group":"Basic Apps","expanded":false,"pages":[{"title":"Agent","tag":"Legacy","href":"/en/cloud/use-dify/build/agent"},{"title":"Chatbot","sidebarTitle":"Chatbot","href":"/en/cloud/use-dify/build/chatbot"},{"title":"Text Generator","sidebarTitle":"Text Generator","href":"/en/cloud/use-dify/build/text-generator"}]},{"title":"App Toolkit","href":"/en/cloud/use-dify/build/additional-features"},{"title":"Go to Anything","href":"/en/cloud/use-dify/build/goto-anything"}]},{"group":"Publish","icon":"paper-plane","expanded":false,"pages":[{"title":"Overview","href":"/en/cloud/use-dify/publish/README"},{"title":"IP Access Control","href":"/en/cloud/use-dify/publish/ip-access-control"},{"group":"Web App","pages":[{"title":"Workflow Web Apps","href":"/en/cloud/use-dify/publish/webapp/workflow-webapp"},{"title":"Chat Web Apps","href":"/en/cloud/use-dify/publish/webapp/chatflow-webapp"},{"title":"Settings","href":"/en/cloud/use-dify/publish/webapp/web-app-settings"},{"title":"Embed Your Web App","sidebarTitle":"Embeds","href":"/en/cloud/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP Server","href":"/en/cloud/use-dify/publish/publish-mcp"},{"title":"Publish Apps to Marketplace","sidebarTitle":"Marketplace","href":"/en/cloud/use-dify/publish/publish-to-marketplace"}]},{"group":"Monitor","icon":"chart-line","expanded":false,"pages":[{"title":"Dashboard","href":"/en/cloud/use-dify/monitor/analysis"},{"title":"Logs","href":"/en/cloud/use-dify/monitor/logs"},{"title":"Annotation System","href":"/en/cloud/use-dify/monitor/annotation-reply"},{"group":"Integrations","pages":[{"title":"Integrate with LangSmith","sidebarTitle":"LangSmith","href":"/en/cloud/use-dify/monitor/integrations/integrate-langsmith"},{"title":"Integrate with Langfuse","sidebarTitle":"Langfuse","href":"/en/cloud/use-dify/monitor/integrations/integrate-langfuse"},{"title":"Integrate with Opik","sidebarTitle":"Opik","href":"/en/cloud/use-dify/monitor/integrations/integrate-opik"},{"title":"Integrate with W\u0026B Weave","sidebarTitle":"W\u0026B Weave","href":"/en/cloud/use-dify/monitor/integrations/integrate-weave"},{"title":"Integrate with Arize","sidebarTitle":"Arize","href":"/en/cloud/use-dify/monitor/integrations/integrate-arize"},{"title":"Integrate with Phoenix","sidebarTitle":"Phoenix","href":"/en/cloud/use-dify/monitor/integrations/integrate-phoenix"},{"title":"Integrate with Alibaba Cloud Monitor","sidebarTitle":"Alibaba Cloud Monitor","href":"/en/cloud/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"Knowledge","icon":"book","expanded":false,"pages":[{"title":"Knowledge","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge/overview"},{"group":"Agent Knowledge Base","tag":"New","expanded":false,"pages":[{"title":"Agent Knowledge Base","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge-base/overview"},{"title":"Create an Agent Knowledge Base","sidebarTitle":"Create","href":"/en/cloud/use-dify/knowledge-base/create-knowledge-base"},{"title":"Review Indexed Documents","sidebarTitle":"Review Indexing","href":"/en/cloud/use-dify/knowledge-base/review-indexed-documents"},{"title":"Test and Tune Retrieval","sidebarTitle":"Test and Tune","href":"/en/cloud/use-dify/knowledge-base/test-and-tune"},{"title":"Retrieval Settings","sidebarTitle":"Retrieval Settings","href":"/en/cloud/use-dify/knowledge-base/retrieval-settings"},{"title":"Connect to Apps, Agents, and Code","sidebarTitle":"Connect","href":"/en/cloud/use-dify/knowledge-base/use-knowledge-in-apps"},{"title":"Multimodal Retrieval","sidebarTitle":"Multimodal Retrieval","href":"/en/cloud/use-dify/knowledge-base/multimodal-retrieval"},{"title":"Maintain an Agent Knowledge Base","sidebarTitle":"Maintain","href":"/en/cloud/use-dify/knowledge-base/maintain-knowledge-base"},{"title":"Upgrade from the Classic Knowledge Base to an Agent Knowledge Base","sidebarTitle":"Upgrade from Classic","href":"/en/cloud/use-dify/knowledge-base/upgrade-from-classic"}]},{"group":"Classic Knowledge Base","expanded":false,"pages":[{"title":"Classic Knowledge Base","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge/readme"},{"group":"Create","pages":[{"group":"Ready-to-Use Knowledge Base","pages":[{"title":"Create a Ready-to-Use Knowledge Base","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge/create-knowledge/introduction"},{"group":"Import Data","pages":[{"title":"Upload Local Files","href":"/en/cloud/use-dify/knowledge/create-knowledge/import-text-data/readme"},{"title":"Sync Data from Notion","href":"/en/cloud/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion"},{"title":"Import Data from Website","href":"/en/cloud/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website"}]},{"title":"Configure the Chunk Settings","href":"/en/cloud/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text"},{"title":"Specify the Index Method and Retrieval Settings","href":"/en/cloud/use-dify/knowledge/create-knowledge/setting-indexing-methods"}]},{"group":"Custom Knowledge Base","pages":[{"title":"Build a Custom Knowledge Base","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/readme"},{"title":"Step 1: Create Knowledge Pipeline","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline"},{"title":"Step 2: Orchestrate Knowledge Pipeline","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration"},{"title":"Step 3: Publish Knowledge Pipeline","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline"},{"title":"Step 4: Upload Files","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/upload-files"},{"title":"Step 5: Manage and Use Knowledge Base","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base"},{"title":"Authorize Data Source","href":"/en/cloud/use-dify/knowledge/knowledge-pipeline/authorize-data-source"}]},{"group":"Connect to External Knowledge","pages":[{"title":"Connect to External Knowledge Base","sidebarTitle":"Overview","href":"/en/cloud/use-dify/knowledge/connect-external-knowledge-base"},{"title":"External Knowledge API","href":"/en/cloud/use-dify/knowledge/external-knowledge-api"}]}]},{"group":"Manage","pages":[{"title":"Manage Knowledge Content","sidebarTitle":"Documents \u0026 Chunks","href":"/en/cloud/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents"},{"title":"Manage Document Metadata","sidebarTitle":"Metadata","href":"/en/cloud/use-dify/knowledge/metadata"},{"title":"Manage Knowledge Settings","sidebarTitle":"Settings","href":"/en/cloud/use-dify/knowledge/manage-knowledge/introduction"}]},{"title":"Test Knowledge Retrieval","sidebarTitle":"Test Retrieval","href":"/en/cloud/use-dify/knowledge/test-retrieval"},{"title":"Integrate Knowledge within Apps","sidebarTitle":"Integrate in Apps","href":"/en/cloud/use-dify/knowledge/integrate-knowledge-within-application"}]},{"title":"Knowledge Request Rate Limit","sidebarTitle":"Request Rate Limit","href":"/en/cloud/use-dify/knowledge/knowledge-request-rate-limit"},{"title":"Knowledge Storage and Document Quotas","sidebarTitle":"Storage and Document Quotas","href":"/en/cloud/use-dify/knowledge/knowledge-storage-limit"}]},{"group":"Integrations","icon":"plug","expanded":false,"pages":[{"title":"Integrations","sidebarTitle":"Overview","href":"/en/cloud/use-dify/workspace/plugins"},{"title":"Model Providers","href":"/en/cloud/use-dify/workspace/model-providers"},{"title":"Dify Tools","sidebarTitle":"Tools","href":"/en/cloud/use-dify/workspace/tools"},{"group":"Custom Endpoint","pages":[{"title":"Custom Endpoints","sidebarTitle":"Overview","href":"/en/cloud/use-dify/workspace/api-extension/api-extension"},{"title":"External Data Tool","href":"/en/cloud/use-dify/workspace/api-extension/external-data-tool-api-extension"},{"title":"Sensitive Content Moderation","href":"/en/cloud/use-dify/workspace/api-extension/moderation-api-extension"},{"title":"Deploy Custom Endpoints Using Cloudflare Workers","href":"/en/cloud/use-dify/workspace/api-extension/cloudflare-worker"}]}]},{"group":"Workspace","icon":"briefcase","expanded":false,"pages":[{"title":"Overview","href":"/en/cloud/use-dify/workspace/readme"},{"title":"Export and Import Apps","sidebarTitle":"Export and Import","href":"/en/cloud/use-dify/workspace/export-import-apps"},{"title":"Manage Members","href":"/en/cloud/use-dify/workspace/team-members-management"},{"title":"Personal Settings","href":"/en/cloud/use-dify/workspace/personal-account-management"},{"title":"Billing","href":"/en/cloud/use-dify/workspace/subscription-management"}]}]},{"tab":"Learn","icon":"graduation-cap","pages":[{"title":"Key Concepts","href":"/en/learn/key-concepts"},{"group":"Tutorials","pages":[{"title":"30-Minute Quick Start","href":"/en/quick-start"},{"group":"Workflow 101","pages":[{"title":"Lesson 1: What is a Workflow?","href":"/en/learn/tutorials/workflow-101/lesson-01"},{"title":"Lesson 2: Head and Tail (Start \u0026 Output Node)","sidebarTitle":"Lesson 2: Head and Tail","href":"/en/learn/tutorials/workflow-101/lesson-02"},{"title":"Lesson 3: The Brain of the Workflow (LLM Node)","sidebarTitle":"Lesson 3: The Brain of the Workflow","href":"/en/learn/tutorials/workflow-101/lesson-03"},{"title":"Lesson 4: The Cheat Sheet (Knowledge Retrieval)","sidebarTitle":"Lesson 4: The Cheat Sheet","href":"/en/learn/tutorials/workflow-101/lesson-04"},{"title":"Lesson 5: The Crossroads of Your Workflow (Sorting and Executing)","sidebarTitle":"Lesson 5: The Crossroads of Your Workflow","href":"/en/learn/tutorials/workflow-101/lesson-05"},{"title":"Lesson 6: Handle Multiple Tasks (Parameter Extraction \u0026 Iteration)","sidebarTitle":"Lesson 6: Handle Multiple Tasks","href":"/en/learn/tutorials/workflow-101/lesson-06"},{"title":"Lesson 7: Enhance Workflows (Tools)","sidebarTitle":"Lesson 7: Enhance Workflows","href":"/en/learn/tutorials/workflow-101/lesson-07"},{"title":"Lesson 8: The Agent Node","sidebarTitle":"Lesson 8: The Agent Node","href":"/en/learn/tutorials/workflow-101/lesson-08"},{"title":"Lesson 9: Layout Designer (Template)","sidebarTitle":"Lesson 9: Layout Designer","href":"/en/learn/tutorials/workflow-101/lesson-09"},{"title":"Lesson 10: Publish and Monitor Your AI App","sidebarTitle":"Lesson 10: Publish and Monitor","href":"/en/learn/tutorials/workflow-101/lesson-10"}]},{"title":"Simple Chatbot","href":"/en/learn/tutorials/simple-chatbot"},{"title":"Twitter Account Analyzer","href":"/en/learn/tutorials/twitter-chatflow"},{"title":"Customer Service Bot With Knowledge Base","href":"/en/learn/tutorials/customer-service-bot"},{"title":"AI Image Generation App","href":"/en/learn/tutorials/build-ai-image-generation-app"},{"title":"Article Reader Using File Upload","href":"/en/learn/tutorials/article-reader"}]}]},{"tab":"Developer Resources","icon":"code","menu":[{"item":"API","icon":"code","groups":[{"group":"Guides","pages":[{"title":"Get Started with the Dify API","sidebarTitle":"Get Started","href":"/en/api-reference/guides/get-started"},{"group":"API Overviews","expanded":true,"pages":[{"title":"Chatflow App API","sidebarTitle":"Chatflow","href":"/en/api-reference/guides/chatflow"},{"title":"Workflow App API","sidebarTitle":"Workflow","href":"/en/api-reference/guides/workflow"},{"title":"Agent API","sidebarTitle":"Agent","tag":"New","href":"/en/api-reference/guides/agent"},{"group":"Knowledge Base","root":{"title":"Knowledge Base API","sidebarTitle":"Knowledge Base","href":"/en/api-reference/guides/knowledge-base-api"},"pages":[{"title":"Agent Knowledge Base API","tag":"Cloud","sidebarTitle":"Agent Knowledge Base","href":"/en/api-reference/guides/knowledge-base"},{"title":"Classic Knowledge Base API","sidebarTitle":"Classic Knowledge Base","href":"/en/api-reference/guides/knowledge"}]},{"title":"Chat App API","sidebarTitle":"Chatbot and Legacy Agent","href":"/en/api-reference/guides/chat"},{"title":"Completion App API","sidebarTitle":"Text Generator","href":"/en/api-reference/guides/completion"}]},{"title":"Consume Streaming Responses","sidebarTitle":"SSE Streaming","href":"/en/api-reference/guides/streaming"},{"title":"Human Input API Integration Flow","sidebarTitle":"Human Input Flow","href":"/en/api-reference/guides/human-input-flow"},{"title":"End User Identity","sidebarTitle":"End User Identity","href":"/en/api-reference/guides/end-user-identity"},{"title":"Handle Errors and Rate Limits","sidebarTitle":"Errors \u0026 Rate Limits","href":"/en/api-reference/guides/errors"}]},{"group":"App APIs","pages":[{"group":"Chat Messages","pages":[{"title":"Send Chat Message","deprecated":null,"version":null,"sidebarTitle":"Send Chat Message","openapi":"/en/api-reference/openapi_service.json post /chat-messages","href":"/en/api-reference/chat-messages/send-chat-message"},{"title":"Stop Chat Message Generation","deprecated":null,"version":null,"sidebarTitle":"Stop Chat Message Generation","openapi":"/en/api-reference/openapi_service.json post /chat-messages/{task_id}/stop","href":"/en/api-reference/chat-messages/stop-chat-message-generation"},{"title":"Get Next Suggested Questions","deprecated":null,"version":null,"sidebarTitle":"Get Next Suggested Questions","openapi":"/en/api-reference/openapi_service.json get /messages/{message_id}/suggested","href":"/en/api-reference/chat-messages/get-next-suggested-questions"}]},{"group":"Completion Messages","pages":[{"title":"Send Completion Message","deprecated":null,"version":null,"sidebarTitle":"Send Completion Message","openapi":"/en/api-reference/openapi_service.json post /completion-messages","href":"/en/api-reference/completion-messages/send-completion-message"},{"title":"Stop Completion Message Generation","deprecated":null,"version":null,"sidebarTitle":"Stop Completion Message Generation","openapi":"/en/api-reference/openapi_service.json post /completion-messages/{task_id}/stop","href":"/en/api-reference/completion-messages/stop-completion-message-generation"}]},{"group":"Workflow Runs","pages":[{"title":"Run Workflow","deprecated":null,"version":null,"sidebarTitle":"Run Workflow","openapi":"/en/api-reference/openapi_service.json post /workflows/run","href":"/en/api-reference/workflow-runs/run-workflow"},{"title":"Run Workflow by ID","deprecated":null,"version":null,"sidebarTitle":"Run Workflow by ID","openapi":"/en/api-reference/openapi_service.json post /workflows/{workflow_id}/run","href":"/en/api-reference/workflow-runs/run-workflow-by-id"},{"title":"Stop Workflow Task","deprecated":null,"version":null,"sidebarTitle":"Stop Workflow Task","openapi":"/en/api-reference/openapi_service.json post /workflows/tasks/{task_id}/stop","href":"/en/api-reference/workflow-runs/stop-workflow-task"},{"title":"Get Workflow Run Detail","deprecated":null,"version":null,"sidebarTitle":"Get Workflow Run Detail","openapi":"/en/api-reference/openapi_service.json get /workflows/run/{workflow_run_id}","href":"/en/api-reference/workflow-runs/get-workflow-run-detail"},{"title":"List Workflow Logs","deprecated":null,"version":null,"sidebarTitle":"List Workflow Logs","openapi":"/en/api-reference/openapi_service.json get /workflows/logs","href":"/en/api-reference/workflow-runs/list-workflow-logs"},{"title":"Stream Workflow Events","deprecated":null,"version":null,"sidebarTitle":"Stream Workflow Events","openapi":"/en/api-reference/openapi_service.json get /workflow/{workflow_run_id}/events","href":"/en/api-reference/workflow-runs/stream-workflow-events"}]},{"group":"Conversations","pages":[{"title":"List Conversations","deprecated":null,"version":null,"sidebarTitle":"List Conversations","openapi":"/en/api-reference/openapi_service.json get /conversations","href":"/en/api-reference/conversations/list-conversations"},{"title":"List Conversation Messages","deprecated":null,"version":null,"sidebarTitle":"List Conversation Messages","openapi":"/en/api-reference/openapi_service.json get /messages","href":"/en/api-reference/conversations/list-conversation-messages"},{"title":"List Conversation Variables","deprecated":null,"version":null,"sidebarTitle":"List Conversation Variables","openapi":"/en/api-reference/openapi_service.json get /conversations/{conversation_id}/variables","href":"/en/api-reference/conversations/list-conversation-variables"},{"title":"Rename Conversation","deprecated":null,"version":null,"sidebarTitle":"Rename Conversation","openapi":"/en/api-reference/openapi_service.json post /conversations/{conversation_id}/name","href":"/en/api-reference/conversations/rename-conversation"},{"title":"Update Conversation Variable","deprecated":null,"version":null,"sidebarTitle":"Update Conversation Variable","openapi":"/en/api-reference/openapi_service.json put /conversations/{conversation_id}/variables/{variable_id}","href":"/en/api-reference/conversations/update-conversation-variable"},{"title":"Delete Conversation","deprecated":null,"version":null,"sidebarTitle":"Delete Conversation","openapi":"/en/api-reference/openapi_service.json delete /conversations/{conversation_id}","href":"/en/api-reference/conversations/delete-conversation"}]},{"group":"Files","pages":[{"title":"Upload File","deprecated":null,"version":null,"sidebarTitle":"Upload File","openapi":"/en/api-reference/openapi_service.json post /files/upload","href":"/en/api-reference/files/upload-file"},{"title":"Download File","deprecated":null,"version":null,"sidebarTitle":"Download File","openapi":"/en/api-reference/openapi_service.json get /files/{file_id}/preview","href":"/en/api-reference/files/download-file"}]},{"group":"Audio","pages":[{"title":"Convert Audio to Text","deprecated":null,"version":null,"sidebarTitle":"Convert Audio to Text","openapi":"/en/api-reference/openapi_service.json post /audio-to-text","href":"/en/api-reference/audio/convert-audio-to-text"},{"title":"Convert Text to Audio","deprecated":null,"version":null,"sidebarTitle":"Convert Text to Audio","openapi":"/en/api-reference/openapi_service.json post /text-to-audio","href":"/en/api-reference/audio/convert-text-to-audio"}]},{"group":"Applications","pages":[{"title":"Get App Info","deprecated":null,"version":null,"sidebarTitle":"Get App Info","openapi":"/en/api-reference/openapi_service.json get /info","href":"/en/api-reference/applications/get-app-info"},{"title":"Get App Parameters","deprecated":null,"version":null,"sidebarTitle":"Get App Parameters","openapi":"/en/api-reference/openapi_service.json get /parameters","href":"/en/api-reference/applications/get-app-parameters"},{"title":"Get App Meta","deprecated":null,"version":null,"sidebarTitle":"Get App Meta","openapi":"/en/api-reference/openapi_service.json get /meta","href":"/en/api-reference/applications/get-app-meta"},{"title":"Get App WebApp Settings","deprecated":null,"version":null,"sidebarTitle":"Get App WebApp Settings","openapi":"/en/api-reference/openapi_service.json get /site","href":"/en/api-reference/applications/get-app-webapp-settings"}]},{"group":"Feedback","pages":[{"title":"Submit Message Feedback","deprecated":null,"version":null,"sidebarTitle":"Submit Message Feedback","openapi":"/en/api-reference/openapi_service.json post /messages/{message_id}/feedbacks","href":"/en/api-reference/feedback/submit-message-feedback"},{"title":"List App Feedbacks","deprecated":null,"version":null,"sidebarTitle":"List App Feedbacks","openapi":"/en/api-reference/openapi_service.json get /app/feedbacks","href":"/en/api-reference/feedback/list-app-feedbacks"}]},{"group":"Annotations","pages":[{"title":"Create Annotation","deprecated":null,"version":null,"sidebarTitle":"Create Annotation","openapi":"/en/api-reference/openapi_service.json post /apps/annotations","href":"/en/api-reference/annotations/create-annotation"},{"title":"List Annotations","deprecated":null,"version":null,"sidebarTitle":"List Annotations","openapi":"/en/api-reference/openapi_service.json get /apps/annotations","href":"/en/api-reference/annotations/list-annotations"},{"title":"Update Annotation","deprecated":null,"version":null,"sidebarTitle":"Update Annotation","openapi":"/en/api-reference/openapi_service.json put /apps/annotations/{annotation_id}","href":"/en/api-reference/annotations/update-annotation"},{"title":"Delete Annotation","deprecated":null,"version":null,"sidebarTitle":"Delete Annotation","openapi":"/en/api-reference/openapi_service.json delete /apps/annotations/{annotation_id}","href":"/en/api-reference/annotations/delete-annotation"},{"title":"Configure Annotation Reply","deprecated":null,"version":null,"sidebarTitle":"Configure Annotation Reply","openapi":"/en/api-reference/openapi_service.json post /apps/annotation-reply/{action}","href":"/en/api-reference/annotations/configure-annotation-reply"},{"title":"Get Annotation Reply Job Status","deprecated":null,"version":null,"sidebarTitle":"Get Annotation Reply Job Status","openapi":"/en/api-reference/openapi_service.json get /apps/annotation-reply/{action}/status/{job_id}","href":"/en/api-reference/annotations/get-annotation-reply-job-status"}]},{"group":"End Users","pages":[{"title":"Get End User Info","deprecated":null,"version":null,"sidebarTitle":"Get End User Info","openapi":"/en/api-reference/openapi_service.json get /end-users/{end_user_id}","href":"/en/api-reference/end-users/get-end-user-info"}]},{"group":"Human Input","pages":[{"title":"Get Human Input Form","deprecated":null,"version":null,"sidebarTitle":"Get Human Input Form","openapi":"/en/api-reference/openapi_service.json get /form/human_input/{form_token}","href":"/en/api-reference/human-input/get-human-input-form"},{"title":"Submit Human Input Form","deprecated":null,"version":null,"sidebarTitle":"Submit Human Input Form","openapi":"/en/api-reference/openapi_service.json post /form/human_input/{form_token}","href":"/en/api-reference/human-input/submit-human-input-form"}]}]},{"group":"Knowledge APIs","pages":[{"group":"Agent Knowledge Base","tag":"Cloud","pages":[{"group":"Queries","pages":[{"title":"Create Query Token","deprecated":null,"version":null,"sidebarTitle":"Create Query Token","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/queries/admission","href":"/en/api-reference/queries/create-query-token"},{"title":"Run Query","deprecated":null,"version":null,"sidebarTitle":"Run Query","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/query-stream","href":"/en/api-reference/queries/run-query"}]},{"group":"Query Records","pages":[{"title":"List Query Records","deprecated":null,"version":null,"sidebarTitle":"List Query Records","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces","href":"/en/api-reference/query-records/list-query-records"},{"title":"Get Query Record","deprecated":null,"version":null,"sidebarTitle":"Get Query Record","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}","href":"/en/api-reference/query-records/get-query-record"},{"title":"List Query Chunks","deprecated":null,"version":null,"sidebarTitle":"List Query Chunks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/evidence","href":"/en/api-reference/query-records/list-query-chunks"},{"title":"List Query Conflicts","deprecated":null,"version":null,"sidebarTitle":"List Query Conflicts","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/conflicts","href":"/en/api-reference/query-records/list-query-conflicts"},{"title":"List Missing Chunks","deprecated":null,"version":null,"sidebarTitle":"List Missing Chunks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/missing","href":"/en/api-reference/query-records/list-missing-chunks"}]},{"group":"Research Tasks","pages":[{"title":"List Research Tasks","deprecated":null,"version":null,"sidebarTitle":"List Research Tasks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/en/api-reference/research-tasks/list-research-tasks"},{"title":"Create Research Task","deprecated":null,"version":null,"sidebarTitle":"Create Research Task","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/en/api-reference/research-tasks/create-research-task"},{"title":"Plan Research Task","deprecated":null,"version":null,"sidebarTitle":"Plan Research Task","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/plan","href":"/en/api-reference/research-tasks/plan-research-task"},{"title":"Get Research Task","deprecated":null,"version":null,"sidebarTitle":"Get Research Task","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/en/api-reference/research-tasks/get-research-task"},{"title":"Cancel Research Task","deprecated":null,"version":null,"sidebarTitle":"Cancel Research Task","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/en/api-reference/research-tasks/cancel-research-task"},{"title":"List Research Task Results","deprecated":null,"version":null,"sidebarTitle":"List Research Task Results","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials","href":"/en/api-reference/research-tasks/list-research-task-results"}]},{"group":"Documents and Chunks","pages":[{"title":"List Documents","deprecated":null,"version":null,"sidebarTitle":"List Documents","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents","href":"/en/api-reference/documents-and-chunks/list-documents"},{"title":"Get Document","deprecated":null,"version":null,"sidebarTitle":"Get Document","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/en/api-reference/documents-and-chunks/get-document"},{"title":"Update Document Metadata","deprecated":null,"version":null,"sidebarTitle":"Update Document Metadata","openapi":"/en/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/en/api-reference/documents-and-chunks/update-document-metadata"},{"title":"Get Document by File","deprecated":null,"version":null,"sidebarTitle":"Get Document by File","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/document-references/resolve","href":"/en/api-reference/documents-and-chunks/get-document-by-file"},{"title":"List Document Files","deprecated":null,"version":null,"sidebarTitle":"List Document Files","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents","href":"/en/api-reference/documents-and-chunks/list-document-files"},{"title":"Get Document File","deprecated":null,"version":null,"sidebarTitle":"Get Document File","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/en/api-reference/documents-and-chunks/get-document-file"},{"title":"Delete Document File","deprecated":null,"version":null,"sidebarTitle":"Delete Document File","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/en/api-reference/documents-and-chunks/delete-document-file"},{"title":"Get Document Outline","deprecated":null,"version":null,"sidebarTitle":"Get Document Outline","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline","href":"/en/api-reference/documents-and-chunks/get-document-outline"},{"title":"List Document Revisions","deprecated":null,"version":null,"sidebarTitle":"List Document Revisions","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions","href":"/en/api-reference/documents-and-chunks/list-document-revisions"},{"title":"List Chunks","deprecated":null,"version":null,"sidebarTitle":"List Chunks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks","href":"/en/api-reference/documents-and-chunks/list-chunks"},{"title":"Get Chunk","deprecated":null,"version":null,"sidebarTitle":"Get Chunk","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}","href":"/en/api-reference/documents-and-chunks/get-chunk"},{"title":"Delete Document Files in Batch","deprecated":null,"version":null,"sidebarTitle":"Delete Document Files in Batch","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/bulk","href":"/en/api-reference/documents-and-chunks/delete-document-files-in-batch"},{"title":"Re-index Documents","deprecated":null,"version":null,"sidebarTitle":"Re-index Documents","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/documents/reindex","href":"/en/api-reference/documents-and-chunks/re-index-documents"}]},{"group":"Indexing Tasks","pages":[{"title":"Get Indexing Task","deprecated":null,"version":null,"sidebarTitle":"Get Indexing Task","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/en/api-reference/indexing-tasks/get-indexing-task"},{"title":"Cancel Indexing Task","deprecated":null,"version":null,"sidebarTitle":"Cancel Indexing Task","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/en/api-reference/indexing-tasks/cancel-indexing-task"},{"title":"Retry Indexing Task","deprecated":null,"version":null,"sidebarTitle":"Retry Indexing Task","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry","href":"/en/api-reference/indexing-tasks/retry-indexing-task"},{"title":"Get Bulk Task","deprecated":null,"version":null,"sidebarTitle":"Get Bulk Task","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id}","href":"/en/api-reference/indexing-tasks/get-bulk-task"},{"title":"List Document Indexing Tasks","deprecated":null,"version":null,"sidebarTitle":"List Document Indexing Tasks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks","href":"/en/api-reference/indexing-tasks/list-document-indexing-tasks"},{"title":"Get Document Indexing Task","deprecated":null,"version":null,"sidebarTitle":"Get Document Indexing Task","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}","href":"/en/api-reference/indexing-tasks/get-document-indexing-task"},{"title":"List Background Tasks","deprecated":null,"version":null,"sidebarTitle":"List Background Tasks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/background-tasks","href":"/en/api-reference/indexing-tasks/list-background-tasks"}]},{"group":"Deletion Jobs","pages":[{"title":"Get Deletion Job","deprecated":null,"version":null,"sidebarTitle":"Get Deletion Job","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}","href":"/en/api-reference/deletion-jobs/get-deletion-job"},{"title":"Get Deletion Batch","deprecated":null,"version":null,"sidebarTitle":"Get Deletion Batch","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-batches/{deletion_batch_id}","href":"/en/api-reference/deletion-jobs/get-deletion-batch"}]},{"group":"Sources","pages":[{"title":"List Source Connections","deprecated":null,"version":null,"sidebarTitle":"List Source Connections","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-connections","href":"/en/api-reference/sources/list-source-connections"},{"title":"Create Source","deprecated":null,"version":null,"sidebarTitle":"Create Source","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/en/api-reference/sources/create-source"},{"title":"List Sources","deprecated":null,"version":null,"sidebarTitle":"List Sources","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/en/api-reference/sources/list-sources"},{"title":"Get Source","deprecated":null,"version":null,"sidebarTitle":"Get Source","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/en/api-reference/sources/get-source"},{"title":"Update Source","deprecated":null,"version":null,"sidebarTitle":"Update Source","openapi":"/en/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/en/api-reference/sources/update-source"},{"title":"Delete Source","deprecated":null,"version":null,"sidebarTitle":"Delete Source","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/en/api-reference/sources/delete-source"},{"title":"Test Source Credentials","deprecated":null,"version":null,"sidebarTitle":"Test Source Credentials","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/test","href":"/en/api-reference/sources/test-source-credentials"},{"title":"List Source Pages","deprecated":null,"version":null,"sidebarTitle":"List Source Pages","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/pages","href":"/en/api-reference/sources/list-source-pages"},{"title":"List Source Files","deprecated":null,"version":null,"sidebarTitle":"List Source Files","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files","href":"/en/api-reference/sources/list-source-files"},{"title":"Get Sync Policy","deprecated":null,"version":null,"sidebarTitle":"Get Sync Policy","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/en/api-reference/sources/get-sync-policy"},{"title":"Update Sync Policy","deprecated":null,"version":null,"sidebarTitle":"Update Sync Policy","openapi":"/en/api-reference/openapi_service.json put /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/en/api-reference/sources/update-sync-policy"}]},{"group":"Source Syncs and Imports","pages":[{"title":"Sync Source","deprecated":null,"version":null,"sidebarTitle":"Sync Source","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync","href":"/en/api-reference/source-syncs-and-imports/sync-source"},{"title":"Preview Website Crawl","deprecated":null,"version":null,"sidebarTitle":"Preview Website Crawl","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-preview","href":"/en/api-reference/source-syncs-and-imports/preview-website-crawl"},{"title":"List Crawl Preview Pages","deprecated":null,"version":null,"sidebarTitle":"List Crawl Preview Pages","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/pages","href":"/en/api-reference/source-syncs-and-imports/list-crawl-preview-pages"},{"title":"Import Selected Pages","deprecated":null,"version":null,"sidebarTitle":"Import Selected Pages","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/selection","href":"/en/api-reference/source-syncs-and-imports/import-selected-pages"},{"title":"Import Website Pages","deprecated":null,"version":null,"sidebarTitle":"Import Website Pages","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import","href":"/en/api-reference/source-syncs-and-imports/import-website-pages"},{"title":"Import Source Items","deprecated":null,"version":null,"sidebarTitle":"Import Source Items","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports","href":"/en/api-reference/source-syncs-and-imports/import-source-items"},{"title":"List Source Runs","deprecated":null,"version":null,"sidebarTitle":"List Source Runs","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows","href":"/en/api-reference/source-syncs-and-imports/list-source-runs"},{"title":"Get Source Run","deprecated":null,"version":null,"sidebarTitle":"Get Source Run","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}","href":"/en/api-reference/source-syncs-and-imports/get-source-run"},{"title":"Cancel Source Run","deprecated":null,"version":null,"sidebarTitle":"Cancel Source Run","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/cancel","href":"/en/api-reference/source-syncs-and-imports/cancel-source-run"},{"title":"Retry Source Run","deprecated":null,"version":null,"sidebarTitle":"Retry Source Run","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry","href":"/en/api-reference/source-syncs-and-imports/retry-source-run"}]},{"group":"Settings","pages":[{"title":"Get Knowledge Base Settings","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base Settings","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/en/api-reference/settings/get-knowledge-base-settings"},{"title":"Update Knowledge Base Settings","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Base Settings","openapi":"/en/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/en/api-reference/settings/update-knowledge-base-settings"},{"title":"Get Settings Migration","deprecated":null,"version":null,"sidebarTitle":"Get Settings Migration","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_id}","href":"/en/api-reference/settings/get-settings-migration"}]}]},{"group":"Classic Knowledge Base","pages":[{"group":"Knowledge Bases","pages":[{"title":"Create an Empty Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Create an Empty Knowledge Base","openapi":"/en/api-reference/openapi_service.json post /datasets","href":"/en/api-reference/knowledge-bases/create-an-empty-knowledge-base"},{"title":"List Knowledge Bases","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Bases","openapi":"/en/api-reference/openapi_service.json get /datasets","href":"/en/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Get Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/get-knowledge-base"},{"title":"Update Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Base","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/update-knowledge-base"},{"title":"Delete Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Base","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"Retrieve Chunks from a Knowledge Base / Test Retrieval","deprecated":null,"version":null,"sidebarTitle":"Retrieve Chunks from a Knowledge Base / Test Retrieval","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/en/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"Documents","pages":[{"title":"Create Document by Text","deprecated":null,"version":null,"sidebarTitle":"Create Document by Text","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/en/api-reference/documents/create-document-by-text"},{"title":"Create Document by File","deprecated":null,"version":null,"sidebarTitle":"Create Document by File","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/en/api-reference/documents/create-document-by-file"},{"title":"List Documents","deprecated":null,"version":null,"sidebarTitle":"List Documents","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents","href":"/en/api-reference/documents/list-documents"},{"title":"Get Document","deprecated":null,"version":null,"sidebarTitle":"Get Document","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/get-document"},{"title":"Delete Document","deprecated":null,"version":null,"sidebarTitle":"Delete Document","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/delete-document"},{"title":"Update Document","deprecated":null,"version":null,"sidebarTitle":"Update Document","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/update-document"},{"title":"Download Document","deprecated":null,"version":null,"sidebarTitle":"Download Document","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/en/api-reference/documents/download-document"},{"title":"Get Document Indexing Status","deprecated":null,"version":null,"sidebarTitle":"Get Document Indexing Status","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/en/api-reference/documents/get-document-indexing-status"},{"title":"Update Document by Text","deprecated":null,"version":null,"sidebarTitle":"Update Document by Text","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/en/api-reference/documents/update-document-by-text"},{"title":"Update Document by File","deprecated":true,"version":null,"sidebarTitle":"Update Document by File","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/en/api-reference/documents/update-document-by-file"},{"title":"Download Documents as ZIP","deprecated":null,"version":null,"sidebarTitle":"Download Documents as ZIP","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/en/api-reference/documents/download-documents-as-zip"},{"title":"Update Document Status in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Status in Batch","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/en/api-reference/documents/update-document-status-in-batch"}]},{"group":"Chunks","pages":[{"title":"Create Chunks","deprecated":null,"version":null,"sidebarTitle":"Create Chunks","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/api-reference/chunks/create-chunks"},{"title":"List Chunks","deprecated":null,"version":null,"sidebarTitle":"List Chunks","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/api-reference/chunks/list-chunks"},{"title":"Get Chunk","deprecated":null,"version":null,"sidebarTitle":"Get Chunk","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/get-chunk"},{"title":"Update Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Chunk","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/update-chunk"},{"title":"Delete Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Chunk","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/delete-chunk"},{"title":"Create Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Create Child Chunk","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/api-reference/chunks/create-child-chunk"},{"title":"List Child Chunks","deprecated":null,"version":null,"sidebarTitle":"List Child Chunks","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/api-reference/chunks/list-child-chunks"},{"title":"Update Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Child Chunk","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/api-reference/chunks/update-child-chunk"},{"title":"Delete Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Child Chunk","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/api-reference/chunks/delete-child-chunk"}]},{"group":"Metadata","pages":[{"title":"Create Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Create Metadata Field","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/en/api-reference/metadata/create-metadata-field"},{"title":"List Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"List Metadata Fields","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/en/api-reference/metadata/list-metadata-fields"},{"title":"Update Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Metadata Field","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/api-reference/metadata/update-metadata-field"},{"title":"Delete Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Delete Metadata Field","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/api-reference/metadata/delete-metadata-field"},{"title":"Get Built-in Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"Get Built-in Metadata Fields","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/en/api-reference/metadata/get-built-in-metadata-fields"},{"title":"Update Built-in Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Built-in Metadata Field","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/en/api-reference/metadata/update-built-in-metadata-field"},{"title":"Update Document Metadata in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Metadata in Batch","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/en/api-reference/metadata/update-document-metadata-in-batch"}]},{"group":"Tags","pages":[{"title":"Create Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Create Knowledge Tag","openapi":"/en/api-reference/openapi_service.json post /datasets/tags","href":"/en/api-reference/tags/create-knowledge-tag"},{"title":"List Knowledge Tags","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Tags","openapi":"/en/api-reference/openapi_service.json get /datasets/tags","href":"/en/api-reference/tags/list-knowledge-tags"},{"title":"Update Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Tag","openapi":"/en/api-reference/openapi_service.json patch /datasets/tags","href":"/en/api-reference/tags/update-knowledge-tag"},{"title":"Delete Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Tag","openapi":"/en/api-reference/openapi_service.json delete /datasets/tags","href":"/en/api-reference/tags/delete-knowledge-tag"},{"title":"Create Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Create Tag Binding","openapi":"/en/api-reference/openapi_service.json post /datasets/tags/binding","href":"/en/api-reference/tags/create-tag-binding"},{"title":"Delete Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Delete Tag Binding","openapi":"/en/api-reference/openapi_service.json post /datasets/tags/unbinding","href":"/en/api-reference/tags/delete-tag-binding"},{"title":"Get Knowledge Base Tags","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base Tags","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/tags","href":"/en/api-reference/tags/get-knowledge-base-tags"}]},{"group":"Models","pages":[{"title":"Get Available Models","deprecated":null,"version":null,"sidebarTitle":"Get Available Models","openapi":"/en/api-reference/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/en/api-reference/models/get-available-models"}]},{"group":"Knowledge Pipeline","pages":[{"title":"Upload Pipeline File","deprecated":null,"version":null,"sidebarTitle":"Upload Pipeline File","openapi":"/en/api-reference/openapi_service.json post /datasets/pipeline/file-upload","href":"/en/api-reference/knowledge-pipeline/upload-pipeline-file"},{"title":"List Datasource Plugins","deprecated":null,"version":null,"sidebarTitle":"List Datasource Plugins","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/en/api-reference/knowledge-pipeline/list-datasource-plugins"},{"title":"Run Datasource Node","deprecated":null,"version":null,"sidebarTitle":"Run Datasource Node","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/en/api-reference/knowledge-pipeline/run-datasource-node"},{"title":"Run Pipeline","deprecated":null,"version":null,"sidebarTitle":"Run Pipeline","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/en/api-reference/knowledge-pipeline/run-pipeline"}]}]}]}]},{"item":"CLI","icon":"terminal","groups":[{"group":" ","expanded":true,"pages":[{"title":"Overview","href":"/en/cli/overview"},{"title":"Get Started","href":"/en/cli/get-started"},{"title":"Find and Run Commands","href":"/en/cli/find-and-run-commands"},{"group":"Work with Apps","expanded":true,"pages":[{"title":"Build Apps","sidebarTitle":"Build","href":"/en/cli/build-apps"},{"title":"Run Apps","sidebarTitle":"Run","href":"/en/cli/run-apps"},{"title":"Create and Update Apps from DSL Files","sidebarTitle":"Create or Update from DSL","href":"/en/cli/create-and-update-apps-from-dsl-files"},{"title":"Use `difyctl` in CI and Automation","sidebarTitle":"CI and Automation","href":"/en/cli/scripts-and-ci"}]},{"group":"Manage difyctl","expanded":true,"pages":[{"title":"Manage Your Sign-In","sidebarTitle":"Sign-In and Sessions","href":"/en/cli/manage-sign-in"},{"title":"Update or Uninstall difyctl","sidebarTitle":"Update or Uninstall","href":"/en/cli/update-or-uninstall"},{"title":"Upgrade Across Dify 1.18.0","sidebarTitle":"Upgrade Across 1.18.0","href":"/en/cli/upgrade-across-1-18"}]},{"group":"Reference","expanded":true,"pages":[{"title":"Command Index","href":"/en/cli/reference/command-index"},{"title":"Results, Errors, and Exit Codes","sidebarTitle":"Results and Errors","href":"/en/cli/reference/results-errors-and-exit-codes"},{"title":"Configuration","href":"/en/cli/reference/configuration"}]}]}]},{"item":"Plugins","icon":"code-pull-request","groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"Dify Plugin","href":"/en/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"Choose a Plugin Type","href":"/en/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify Plugin CLI","href":"/en/develop-plugin/getting-started/cli"}]},{"group":"Features \u0026 Specs","icon":"list-check","pages":[{"group":"Plugin Types","pages":[{"title":"General Specs","href":"/en/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"Model Specs","href":"/en/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"Model API Interface","href":"/en/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"Persistent Storage","href":"/en/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"Tool Return","href":"/en/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/en/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"Multilingual README","href":"/en/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"Plugin Debugging","href":"/en/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"Plugin Logging","href":"/en/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"Advanced Development","pages":[{"group":"Reverse Calling","pages":[{"title":"Bundle Plugin Package","href":"/en/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Reverse Invocation of Dify Services","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"App","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"Reverse Invocation Model","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"Tool","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"Integrate Custom Models","href":"/en/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"Node","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"Development Guides \u0026 Walkthroughs","icon":"code","pages":[{"title":"Cheatsheet","href":"/en/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"By Plugin Type","pages":[{"title":"Tool Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/en/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"Model Provider Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"Agent Strategy Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"Data Source Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"Trigger Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"Full Walkthroughs","pages":[{"title":"Flomo Tool (10-min)","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdown Exporter","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"Multimodal Tool","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"Publishing","icon":"upload","pages":[{"title":"Publish Plugins","href":"/en/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"Standards","pages":[{"title":"Plugin Development Guidelines","href":"/en/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"Privacy Guidelines","href":"/en/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"Publish a Plugin to Marketplace","sidebarTitle":"Marketplace","href":"/en/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub Repository","pages":[{"title":"Publish to Individual GitHub Repository","href":"/en/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"Local File","pages":[{"title":"Package as Local File and Share","href":"/en/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"Sign Plugins for Third-Party Signature Verification","href":"/en/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"Frequently Asked Questions","sidebarTitle":"FAQ","href":"/en/develop-plugin/publishing/faq/faq"}]}]}]}]},{"product":"Self-Host","icon":"server","tabs":[{"tab":"Deploy","icon":"server","pages":[{"title":"Deploy Dify","sidebarTitle":"Overview","mode":"frame","href":"/en/self-host/deploy/overview"},{"group":"Quick Start","icon":"rocket","pages":[{"title":"Deploy Dify with Docker Compose","sidebarTitle":"Docker Compose","href":"/en/self-host/deploy/quick-start/docker-compose"},{"title":"FAQs","href":"/en/self-host/deploy/quick-start/faqs"}]},{"group":"Advanced Deployments","icon":"server","pages":[{"title":"Local Source Code Start","href":"/en/self-host/deploy/advanced-deployments/local-source-code"},{"title":"Start Frontend Docker Container Separately","href":"/en/self-host/deploy/advanced-deployments/start-the-frontend-docker-container"}]},{"group":"Configuration","icon":"gear","pages":[{"title":"Environment Variables","href":"/en/self-host/deploy/configuration/environments"}]},{"group":"Platform Guides","icon":"map","pages":[{"title":"Deploy with aaPanel","href":"/en/self-host/deploy/platform-guides/bt-panel"},{"title":"Dify Premium on AWS","href":"/en/self-host/deploy/platform-guides/dify-premium"}]},{"group":"Troubleshooting","icon":"wrench","pages":[{"title":"Common Issues","href":"/en/self-host/deploy/troubleshooting/common-issues"},{"title":"Docker Issues","href":"/en/self-host/deploy/troubleshooting/docker-issues"},{"title":"Third-Party Integrations","href":"/en/self-host/deploy/troubleshooting/integrations"},{"title":"Storage \u0026 Migration","href":"/en/self-host/deploy/troubleshooting/storage-and-migration"},{"title":"Weaviate Migration Guide upgrading to Client v4 and Server 1.27+","href":"/en/self-host/deploy/troubleshooting/weaviate-v4-migration"},{"title":"Weaviate Server Upgrade Path","href":"/en/self-host/deploy/troubleshooting/weaviate-server-migration-path"}]}]},{"tab":"Use","icon":"book-open","pages":[{"title":"Use Dify","sidebarTitle":"Overview","mode":"frame","href":"/en/self-host/use-dify/getting-started/introduction"},{"group":"Orchestrate","icon":"hammer","pages":[{"group":"Workflow \u0026 Chatflow","expanded":false,"pages":[{"title":"Workflow \u0026 Chatflow","sidebarTitle":"Overview","href":"/en/self-host/use-dify/build/workflow-chatflow"},{"title":"Orchestration Logic","href":"/en/self-host/use-dify/build/orchestrate-node"},{"group":"Nodes","expanded":false,"pages":[{"group":"Start","root":{"title":"Start Node","href":"/en/self-host/use-dify/nodes/start"},"pages":[{"title":"User Input","href":"/en/self-host/use-dify/nodes/user-input"},{"group":"Trigger","root":{"title":"Trigger","sidebarTitle":"Overview","href":"/en/self-host/use-dify/nodes/trigger/overview"},"pages":[{"title":"Schedule Trigger","href":"/en/self-host/use-dify/nodes/trigger/schedule-trigger"},{"title":"Integration Trigger","href":"/en/self-host/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook Trigger","href":"/en/self-host/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"LLM","href":"/en/self-host/use-dify/nodes/llm"},{"title":"Knowledge Retrieval","href":"/en/self-host/use-dify/nodes/knowledge-retrieval"},{"title":"Answer","href":"/en/self-host/use-dify/nodes/answer"},{"title":"Output","href":"/en/self-host/use-dify/nodes/output"},{"title":"Agent","href":"/en/self-host/use-dify/nodes/agent"},{"title":"Question Classifier","href":"/en/self-host/use-dify/nodes/question-classifier"},{"title":"If-Else","href":"/en/self-host/use-dify/nodes/ifelse"},{"group":"Human Input","root":{"title":"Human Input","href":"/en/self-host/use-dify/nodes/human-input"},"expanded":false,"pages":[]},{"title":"Iteration","href":"/en/self-host/use-dify/nodes/iteration"},{"title":"Loop","href":"/en/self-host/use-dify/nodes/loop"},{"title":"Code","href":"/en/self-host/use-dify/nodes/code"},{"title":"Template","href":"/en/self-host/use-dify/nodes/template"},{"title":"Variable Aggregator","href":"/en/self-host/use-dify/nodes/variable-aggregator"},{"title":"Document Extractor","href":"/en/self-host/use-dify/nodes/doc-extractor"},{"title":"Variable Assigner","href":"/en/self-host/use-dify/nodes/variable-assigner"},{"title":"Parameter Extractor","href":"/en/self-host/use-dify/nodes/parameter-extractor"},{"title":"HTTP Request","href":"/en/self-host/use-dify/nodes/http-request"},{"title":"List Operator","href":"/en/self-host/use-dify/nodes/list-operator"},{"title":"Tool Node","sidebarTitle":"Tool","href":"/en/self-host/use-dify/nodes/tools"}]},{"title":"Hotkeys","href":"/en/self-host/use-dify/build/shortcut-key"},{"title":"Version Control","href":"/en/self-host/use-dify/build/version-control"},{"title":"Snippets","sidebarTitle":"Snippets","href":"/en/self-host/use-dify/build/snippet"},{"title":"Collaborate with Teammates","sidebarTitle":"Collaboration","href":"/en/self-host/use-dify/build/workflow-collaboration"},{"group":"Debug","expanded":false,"pages":[{"title":"Handle Errors","href":"/en/self-host/use-dify/build/predefined-error-handling-logic"},{"title":"Single Node","href":"/en/self-host/use-dify/debug/step-run"},{"title":"Variable Inspector","href":"/en/self-host/use-dify/debug/variable-inspect"},{"title":"Run History","href":"/en/self-host/use-dify/debug/history-and-logs"},{"title":"Error Types","href":"/en/self-host/use-dify/debug/error-type"}]}]},{"group":"Agent","tag":"New","expanded":false,"pages":[{"title":"Agent","sidebarTitle":"Overview","href":"/en/self-host/use-dify/build/new-agent/overview"},{"title":"Build an Agent","sidebarTitle":"Build","href":"/en/self-host/use-dify/build/new-agent/build"}]},{"title":"Skills","sidebarTitle":"Skills","href":"/en/self-host/use-dify/build/skills"},{"group":"Basic Apps","expanded":false,"pages":[{"title":"Agent","tag":"Legacy","href":"/en/self-host/use-dify/build/agent"},{"title":"Chatbot","sidebarTitle":"Chatbot","href":"/en/self-host/use-dify/build/chatbot"},{"title":"Text Generator","sidebarTitle":"Text Generator","href":"/en/self-host/use-dify/build/text-generator"}]},{"title":"App Toolkit","href":"/en/self-host/use-dify/build/additional-features"},{"title":"Go to Anything","href":"/en/self-host/use-dify/build/goto-anything"}]},{"group":"Publish","icon":"paper-plane","expanded":false,"pages":[{"title":"Overview","href":"/en/self-host/use-dify/publish/README"},{"group":"Web App","pages":[{"title":"Workflow Web Apps","href":"/en/self-host/use-dify/publish/webapp/workflow-webapp"},{"title":"Chat Web Apps","href":"/en/self-host/use-dify/publish/webapp/chatflow-webapp"},{"title":"Settings","href":"/en/self-host/use-dify/publish/webapp/web-app-settings"},{"title":"Embed Your Web App","sidebarTitle":"Embeds","href":"/en/self-host/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP Server","href":"/en/self-host/use-dify/publish/publish-mcp"},{"title":"Publish Apps to Marketplace","sidebarTitle":"Marketplace","href":"/en/self-host/use-dify/publish/publish-to-marketplace"}]},{"group":"Monitor","icon":"chart-line","expanded":false,"pages":[{"title":"Dashboard","href":"/en/self-host/use-dify/monitor/analysis"},{"title":"Logs","href":"/en/self-host/use-dify/monitor/logs"},{"title":"Annotation System","href":"/en/self-host/use-dify/monitor/annotation-reply"},{"group":"Integrations","pages":[{"title":"Integrate with LangSmith","sidebarTitle":"LangSmith","href":"/en/self-host/use-dify/monitor/integrations/integrate-langsmith"},{"title":"Integrate with Langfuse","sidebarTitle":"Langfuse","href":"/en/self-host/use-dify/monitor/integrations/integrate-langfuse"},{"title":"Integrate with Opik","sidebarTitle":"Opik","href":"/en/self-host/use-dify/monitor/integrations/integrate-opik"},{"title":"Integrate with W\u0026B Weave","sidebarTitle":"W\u0026B Weave","href":"/en/self-host/use-dify/monitor/integrations/integrate-weave"},{"title":"Integrate with Arize","sidebarTitle":"Arize","href":"/en/self-host/use-dify/monitor/integrations/integrate-arize"},{"title":"Integrate with Phoenix","sidebarTitle":"Phoenix","href":"/en/self-host/use-dify/monitor/integrations/integrate-phoenix"},{"title":"Integrate with Alibaba Cloud Monitor","sidebarTitle":"Alibaba Cloud Monitor","href":"/en/self-host/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"Knowledge","icon":"book","expanded":false,"pages":[{"title":"Knowledge","sidebarTitle":"Overview","href":"/en/self-host/use-dify/knowledge/readme"},{"group":"Create","pages":[{"group":"Ready-to-Use Knowledge Base","pages":[{"title":"Create a Ready-to-Use Knowledge Base","sidebarTitle":"Overview","href":"/en/self-host/use-dify/knowledge/create-knowledge/introduction"},{"group":"Import Data","pages":[{"title":"Upload Local Files","href":"/en/self-host/use-dify/knowledge/create-knowledge/import-text-data/readme"},{"title":"Sync Data from Notion","href":"/en/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion"},{"title":"Import Data from Website","href":"/en/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website"}]},{"title":"Configure the Chunk Settings","href":"/en/self-host/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text"},{"title":"Specify the Index Method and Retrieval Settings","href":"/en/self-host/use-dify/knowledge/create-knowledge/setting-indexing-methods"}]},{"group":"Custom Knowledge Base","pages":[{"title":"Build a Custom Knowledge Base","sidebarTitle":"Overview","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/readme"},{"title":"Step 1: Create Knowledge Pipeline","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline"},{"title":"Step 2: Orchestrate Knowledge Pipeline","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration"},{"title":"Step 3: Publish Knowledge Pipeline","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline"},{"title":"Step 4: Upload Files","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/upload-files"},{"title":"Step 5: Manage and Use Knowledge Base","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base"},{"title":"Authorize Data Source","href":"/en/self-host/use-dify/knowledge/knowledge-pipeline/authorize-data-source"}]},{"group":"Connect to External Knowledge","pages":[{"title":"Connect to External Knowledge Base","sidebarTitle":"Overview","href":"/en/self-host/use-dify/knowledge/connect-external-knowledge-base"},{"title":"External Knowledge API","href":"/en/self-host/use-dify/knowledge/external-knowledge-api"}]}]},{"group":"Manage","pages":[{"title":"Manage Knowledge Content","sidebarTitle":"Documents \u0026 Chunks","href":"/en/self-host/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents"},{"title":"Manage Document Metadata","sidebarTitle":"Metadata","href":"/en/self-host/use-dify/knowledge/metadata"},{"title":"Manage Knowledge Settings","sidebarTitle":"Settings","href":"/en/self-host/use-dify/knowledge/manage-knowledge/introduction"}]},{"title":"Test Knowledge Retrieval","sidebarTitle":"Test Retrieval","href":"/en/self-host/use-dify/knowledge/test-retrieval"},{"title":"Integrate Knowledge within Apps","sidebarTitle":"Integrate in Apps","href":"/en/self-host/use-dify/knowledge/integrate-knowledge-within-application"}]},{"group":"Integrations","icon":"plug","expanded":false,"pages":[{"title":"Integrations","sidebarTitle":"Overview","href":"/en/self-host/use-dify/workspace/plugins"},{"title":"Model Providers","href":"/en/self-host/use-dify/workspace/model-providers"},{"title":"Dify Tools","sidebarTitle":"Tools","href":"/en/self-host/use-dify/workspace/tools"},{"group":"Custom Endpoint","pages":[{"title":"Custom Endpoints","sidebarTitle":"Overview","href":"/en/self-host/use-dify/workspace/api-extension/api-extension"},{"title":"External Data Tool","href":"/en/self-host/use-dify/workspace/api-extension/external-data-tool-api-extension"},{"title":"Sensitive Content Moderation","href":"/en/self-host/use-dify/workspace/api-extension/moderation-api-extension"},{"title":"Deploy Custom Endpoints Using Cloudflare Workers","href":"/en/self-host/use-dify/workspace/api-extension/cloudflare-worker"}]}]},{"group":"Workspace","icon":"briefcase","expanded":false,"pages":[{"title":"Overview","href":"/en/self-host/use-dify/workspace/readme"},{"title":"Export and Import Apps","sidebarTitle":"Export and Import","href":"/en/self-host/use-dify/workspace/export-import-apps"},{"title":"Manage Members","href":"/en/self-host/use-dify/workspace/team-members-management"},{"title":"Personal Settings","href":"/en/self-host/use-dify/workspace/personal-account-management"}]}]},{"tab":"Learn","icon":"graduation-cap","pages":[{"title":"Key Concepts","href":"/en/learn/key-concepts"},{"group":"Tutorials","pages":[{"title":"30-Minute Quick Start","href":"/en/quick-start"},{"group":"Workflow 101","pages":[{"title":"Lesson 1: What is a Workflow?","href":"/en/learn/tutorials/workflow-101/lesson-01"},{"title":"Lesson 2: Head and Tail (Start \u0026 Output Node)","sidebarTitle":"Lesson 2: Head and Tail","href":"/en/learn/tutorials/workflow-101/lesson-02"},{"title":"Lesson 3: The Brain of the Workflow (LLM Node)","sidebarTitle":"Lesson 3: The Brain of the Workflow","href":"/en/learn/tutorials/workflow-101/lesson-03"},{"title":"Lesson 4: The Cheat Sheet (Knowledge Retrieval)","sidebarTitle":"Lesson 4: The Cheat Sheet","href":"/en/learn/tutorials/workflow-101/lesson-04"},{"title":"Lesson 5: The Crossroads of Your Workflow (Sorting and Executing)","sidebarTitle":"Lesson 5: The Crossroads of Your Workflow","href":"/en/learn/tutorials/workflow-101/lesson-05"},{"title":"Lesson 6: Handle Multiple Tasks (Parameter Extraction \u0026 Iteration)","sidebarTitle":"Lesson 6: Handle Multiple Tasks","href":"/en/learn/tutorials/workflow-101/lesson-06"},{"title":"Lesson 7: Enhance Workflows (Tools)","sidebarTitle":"Lesson 7: Enhance Workflows","href":"/en/learn/tutorials/workflow-101/lesson-07"},{"title":"Lesson 8: The Agent Node","sidebarTitle":"Lesson 8: The Agent Node","href":"/en/learn/tutorials/workflow-101/lesson-08"},{"title":"Lesson 9: Layout Designer (Template)","sidebarTitle":"Lesson 9: Layout Designer","href":"/en/learn/tutorials/workflow-101/lesson-09"},{"title":"Lesson 10: Publish and Monitor Your AI App","sidebarTitle":"Lesson 10: Publish and Monitor","href":"/en/learn/tutorials/workflow-101/lesson-10"}]},{"title":"Simple Chatbot","href":"/en/learn/tutorials/simple-chatbot"},{"title":"Twitter Account Analyzer","href":"/en/learn/tutorials/twitter-chatflow"},{"title":"Customer Service Bot With Knowledge Base","href":"/en/learn/tutorials/customer-service-bot"},{"title":"AI Image Generation App","href":"/en/learn/tutorials/build-ai-image-generation-app"},{"title":"Article Reader Using File Upload","href":"/en/learn/tutorials/article-reader"}]}]},{"tab":"Developer Resources","icon":"code","menu":[{"item":"API","icon":"code","groups":[{"group":"Guides","pages":[{"title":"Get Started with the Dify API","sidebarTitle":"Get Started","href":"/en/api-reference/guides/get-started"},{"group":"API Overviews","expanded":true,"pages":[{"title":"Chatflow App API","sidebarTitle":"Chatflow","href":"/en/api-reference/guides/chatflow"},{"title":"Workflow App API","sidebarTitle":"Workflow","href":"/en/api-reference/guides/workflow"},{"title":"Agent API","sidebarTitle":"Agent","tag":"New","href":"/en/api-reference/guides/agent"},{"group":"Knowledge Base","root":{"title":"Knowledge Base API","sidebarTitle":"Knowledge Base","href":"/en/api-reference/guides/knowledge-base-api"},"pages":[{"title":"Agent Knowledge Base API","tag":"Cloud","sidebarTitle":"Agent Knowledge Base","href":"/en/api-reference/guides/knowledge-base"},{"title":"Classic Knowledge Base API","sidebarTitle":"Classic Knowledge Base","href":"/en/api-reference/guides/knowledge"}]},{"title":"Chat App API","sidebarTitle":"Chatbot and Legacy Agent","href":"/en/api-reference/guides/chat"},{"title":"Completion App API","sidebarTitle":"Text Generator","href":"/en/api-reference/guides/completion"}]},{"title":"Consume Streaming Responses","sidebarTitle":"SSE Streaming","href":"/en/api-reference/guides/streaming"},{"title":"Human Input API Integration Flow","sidebarTitle":"Human Input Flow","href":"/en/api-reference/guides/human-input-flow"},{"title":"End User Identity","sidebarTitle":"End User Identity","href":"/en/api-reference/guides/end-user-identity"},{"title":"Handle Errors and Rate Limits","sidebarTitle":"Errors \u0026 Rate Limits","href":"/en/api-reference/guides/errors"}]},{"group":"App APIs","pages":[{"group":"Chat Messages","pages":[{"title":"Send Chat Message","deprecated":null,"version":null,"sidebarTitle":"Send Chat Message","openapi":"/en/api-reference/openapi_service.json post /chat-messages","href":"/en/api-reference/chat-messages/send-chat-message"},{"title":"Stop Chat Message Generation","deprecated":null,"version":null,"sidebarTitle":"Stop Chat Message Generation","openapi":"/en/api-reference/openapi_service.json post /chat-messages/{task_id}/stop","href":"/en/api-reference/chat-messages/stop-chat-message-generation"},{"title":"Get Next Suggested Questions","deprecated":null,"version":null,"sidebarTitle":"Get Next Suggested Questions","openapi":"/en/api-reference/openapi_service.json get /messages/{message_id}/suggested","href":"/en/api-reference/chat-messages/get-next-suggested-questions"}]},{"group":"Completion Messages","pages":[{"title":"Send Completion Message","deprecated":null,"version":null,"sidebarTitle":"Send Completion Message","openapi":"/en/api-reference/openapi_service.json post /completion-messages","href":"/en/api-reference/completion-messages/send-completion-message"},{"title":"Stop Completion Message Generation","deprecated":null,"version":null,"sidebarTitle":"Stop Completion Message Generation","openapi":"/en/api-reference/openapi_service.json post /completion-messages/{task_id}/stop","href":"/en/api-reference/completion-messages/stop-completion-message-generation"}]},{"group":"Workflow Runs","pages":[{"title":"Run Workflow","deprecated":null,"version":null,"sidebarTitle":"Run Workflow","openapi":"/en/api-reference/openapi_service.json post /workflows/run","href":"/en/api-reference/workflow-runs/run-workflow"},{"title":"Run Workflow by ID","deprecated":null,"version":null,"sidebarTitle":"Run Workflow by ID","openapi":"/en/api-reference/openapi_service.json post /workflows/{workflow_id}/run","href":"/en/api-reference/workflow-runs/run-workflow-by-id"},{"title":"Stop Workflow Task","deprecated":null,"version":null,"sidebarTitle":"Stop Workflow Task","openapi":"/en/api-reference/openapi_service.json post /workflows/tasks/{task_id}/stop","href":"/en/api-reference/workflow-runs/stop-workflow-task"},{"title":"Get Workflow Run Detail","deprecated":null,"version":null,"sidebarTitle":"Get Workflow Run Detail","openapi":"/en/api-reference/openapi_service.json get /workflows/run/{workflow_run_id}","href":"/en/api-reference/workflow-runs/get-workflow-run-detail"},{"title":"List Workflow Logs","deprecated":null,"version":null,"sidebarTitle":"List Workflow Logs","openapi":"/en/api-reference/openapi_service.json get /workflows/logs","href":"/en/api-reference/workflow-runs/list-workflow-logs"},{"title":"Stream Workflow Events","deprecated":null,"version":null,"sidebarTitle":"Stream Workflow Events","openapi":"/en/api-reference/openapi_service.json get /workflow/{workflow_run_id}/events","href":"/en/api-reference/workflow-runs/stream-workflow-events"}]},{"group":"Conversations","pages":[{"title":"List Conversations","deprecated":null,"version":null,"sidebarTitle":"List Conversations","openapi":"/en/api-reference/openapi_service.json get /conversations","href":"/en/api-reference/conversations/list-conversations"},{"title":"List Conversation Messages","deprecated":null,"version":null,"sidebarTitle":"List Conversation Messages","openapi":"/en/api-reference/openapi_service.json get /messages","href":"/en/api-reference/conversations/list-conversation-messages"},{"title":"List Conversation Variables","deprecated":null,"version":null,"sidebarTitle":"List Conversation Variables","openapi":"/en/api-reference/openapi_service.json get /conversations/{conversation_id}/variables","href":"/en/api-reference/conversations/list-conversation-variables"},{"title":"Rename Conversation","deprecated":null,"version":null,"sidebarTitle":"Rename Conversation","openapi":"/en/api-reference/openapi_service.json post /conversations/{conversation_id}/name","href":"/en/api-reference/conversations/rename-conversation"},{"title":"Update Conversation Variable","deprecated":null,"version":null,"sidebarTitle":"Update Conversation Variable","openapi":"/en/api-reference/openapi_service.json put /conversations/{conversation_id}/variables/{variable_id}","href":"/en/api-reference/conversations/update-conversation-variable"},{"title":"Delete Conversation","deprecated":null,"version":null,"sidebarTitle":"Delete Conversation","openapi":"/en/api-reference/openapi_service.json delete /conversations/{conversation_id}","href":"/en/api-reference/conversations/delete-conversation"}]},{"group":"Files","pages":[{"title":"Upload File","deprecated":null,"version":null,"sidebarTitle":"Upload File","openapi":"/en/api-reference/openapi_service.json post /files/upload","href":"/en/api-reference/files/upload-file"},{"title":"Download File","deprecated":null,"version":null,"sidebarTitle":"Download File","openapi":"/en/api-reference/openapi_service.json get /files/{file_id}/preview","href":"/en/api-reference/files/download-file"}]},{"group":"Audio","pages":[{"title":"Convert Audio to Text","deprecated":null,"version":null,"sidebarTitle":"Convert Audio to Text","openapi":"/en/api-reference/openapi_service.json post /audio-to-text","href":"/en/api-reference/audio/convert-audio-to-text"},{"title":"Convert Text to Audio","deprecated":null,"version":null,"sidebarTitle":"Convert Text to Audio","openapi":"/en/api-reference/openapi_service.json post /text-to-audio","href":"/en/api-reference/audio/convert-text-to-audio"}]},{"group":"Applications","pages":[{"title":"Get App Info","deprecated":null,"version":null,"sidebarTitle":"Get App Info","openapi":"/en/api-reference/openapi_service.json get /info","href":"/en/api-reference/applications/get-app-info"},{"title":"Get App Parameters","deprecated":null,"version":null,"sidebarTitle":"Get App Parameters","openapi":"/en/api-reference/openapi_service.json get /parameters","href":"/en/api-reference/applications/get-app-parameters"},{"title":"Get App Meta","deprecated":null,"version":null,"sidebarTitle":"Get App Meta","openapi":"/en/api-reference/openapi_service.json get /meta","href":"/en/api-reference/applications/get-app-meta"},{"title":"Get App WebApp Settings","deprecated":null,"version":null,"sidebarTitle":"Get App WebApp Settings","openapi":"/en/api-reference/openapi_service.json get /site","href":"/en/api-reference/applications/get-app-webapp-settings"}]},{"group":"Feedback","pages":[{"title":"Submit Message Feedback","deprecated":null,"version":null,"sidebarTitle":"Submit Message Feedback","openapi":"/en/api-reference/openapi_service.json post /messages/{message_id}/feedbacks","href":"/en/api-reference/feedback/submit-message-feedback"},{"title":"List App Feedbacks","deprecated":null,"version":null,"sidebarTitle":"List App Feedbacks","openapi":"/en/api-reference/openapi_service.json get /app/feedbacks","href":"/en/api-reference/feedback/list-app-feedbacks"}]},{"group":"Annotations","pages":[{"title":"Create Annotation","deprecated":null,"version":null,"sidebarTitle":"Create Annotation","openapi":"/en/api-reference/openapi_service.json post /apps/annotations","href":"/en/api-reference/annotations/create-annotation"},{"title":"List Annotations","deprecated":null,"version":null,"sidebarTitle":"List Annotations","openapi":"/en/api-reference/openapi_service.json get /apps/annotations","href":"/en/api-reference/annotations/list-annotations"},{"title":"Update Annotation","deprecated":null,"version":null,"sidebarTitle":"Update Annotation","openapi":"/en/api-reference/openapi_service.json put /apps/annotations/{annotation_id}","href":"/en/api-reference/annotations/update-annotation"},{"title":"Delete Annotation","deprecated":null,"version":null,"sidebarTitle":"Delete Annotation","openapi":"/en/api-reference/openapi_service.json delete /apps/annotations/{annotation_id}","href":"/en/api-reference/annotations/delete-annotation"},{"title":"Configure Annotation Reply","deprecated":null,"version":null,"sidebarTitle":"Configure Annotation Reply","openapi":"/en/api-reference/openapi_service.json post /apps/annotation-reply/{action}","href":"/en/api-reference/annotations/configure-annotation-reply"},{"title":"Get Annotation Reply Job Status","deprecated":null,"version":null,"sidebarTitle":"Get Annotation Reply Job Status","openapi":"/en/api-reference/openapi_service.json get /apps/annotation-reply/{action}/status/{job_id}","href":"/en/api-reference/annotations/get-annotation-reply-job-status"}]},{"group":"End Users","pages":[{"title":"Get End User Info","deprecated":null,"version":null,"sidebarTitle":"Get End User Info","openapi":"/en/api-reference/openapi_service.json get /end-users/{end_user_id}","href":"/en/api-reference/end-users/get-end-user-info"}]},{"group":"Human Input","pages":[{"title":"Get Human Input Form","deprecated":null,"version":null,"sidebarTitle":"Get Human Input Form","openapi":"/en/api-reference/openapi_service.json get /form/human_input/{form_token}","href":"/en/api-reference/human-input/get-human-input-form"},{"title":"Submit Human Input Form","deprecated":null,"version":null,"sidebarTitle":"Submit Human Input Form","openapi":"/en/api-reference/openapi_service.json post /form/human_input/{form_token}","href":"/en/api-reference/human-input/submit-human-input-form"}]}]},{"group":"Knowledge APIs","pages":[{"group":"Agent Knowledge Base","tag":"Cloud","pages":[{"group":"Queries","pages":[{"title":"Create Query Token","deprecated":null,"version":null,"sidebarTitle":"Create Query Token","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/queries/admission","href":"/en/api-reference/queries/create-query-token"},{"title":"Run Query","deprecated":null,"version":null,"sidebarTitle":"Run Query","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/query-stream","href":"/en/api-reference/queries/run-query"}]},{"group":"Query Records","pages":[{"title":"List Query Records","deprecated":null,"version":null,"sidebarTitle":"List Query Records","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces","href":"/en/api-reference/query-records/list-query-records"},{"title":"Get Query Record","deprecated":null,"version":null,"sidebarTitle":"Get Query Record","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}","href":"/en/api-reference/query-records/get-query-record"},{"title":"List Query Chunks","deprecated":null,"version":null,"sidebarTitle":"List Query Chunks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/evidence","href":"/en/api-reference/query-records/list-query-chunks"},{"title":"List Query Conflicts","deprecated":null,"version":null,"sidebarTitle":"List Query Conflicts","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/conflicts","href":"/en/api-reference/query-records/list-query-conflicts"},{"title":"List Missing Chunks","deprecated":null,"version":null,"sidebarTitle":"List Missing Chunks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/missing","href":"/en/api-reference/query-records/list-missing-chunks"}]},{"group":"Research Tasks","pages":[{"title":"List Research Tasks","deprecated":null,"version":null,"sidebarTitle":"List Research Tasks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/en/api-reference/research-tasks/list-research-tasks"},{"title":"Create Research Task","deprecated":null,"version":null,"sidebarTitle":"Create Research Task","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/en/api-reference/research-tasks/create-research-task"},{"title":"Plan Research Task","deprecated":null,"version":null,"sidebarTitle":"Plan Research Task","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/plan","href":"/en/api-reference/research-tasks/plan-research-task"},{"title":"Get Research Task","deprecated":null,"version":null,"sidebarTitle":"Get Research Task","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/en/api-reference/research-tasks/get-research-task"},{"title":"Cancel Research Task","deprecated":null,"version":null,"sidebarTitle":"Cancel Research Task","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/en/api-reference/research-tasks/cancel-research-task"},{"title":"List Research Task Results","deprecated":null,"version":null,"sidebarTitle":"List Research Task Results","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials","href":"/en/api-reference/research-tasks/list-research-task-results"}]},{"group":"Documents and Chunks","pages":[{"title":"List Documents","deprecated":null,"version":null,"sidebarTitle":"List Documents","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents","href":"/en/api-reference/documents-and-chunks/list-documents"},{"title":"Get Document","deprecated":null,"version":null,"sidebarTitle":"Get Document","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/en/api-reference/documents-and-chunks/get-document"},{"title":"Update Document Metadata","deprecated":null,"version":null,"sidebarTitle":"Update Document Metadata","openapi":"/en/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/en/api-reference/documents-and-chunks/update-document-metadata"},{"title":"Get Document by File","deprecated":null,"version":null,"sidebarTitle":"Get Document by File","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/document-references/resolve","href":"/en/api-reference/documents-and-chunks/get-document-by-file"},{"title":"List Document Files","deprecated":null,"version":null,"sidebarTitle":"List Document Files","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents","href":"/en/api-reference/documents-and-chunks/list-document-files"},{"title":"Get Document File","deprecated":null,"version":null,"sidebarTitle":"Get Document File","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/en/api-reference/documents-and-chunks/get-document-file"},{"title":"Delete Document File","deprecated":null,"version":null,"sidebarTitle":"Delete Document File","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/en/api-reference/documents-and-chunks/delete-document-file"},{"title":"Get Document Outline","deprecated":null,"version":null,"sidebarTitle":"Get Document Outline","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline","href":"/en/api-reference/documents-and-chunks/get-document-outline"},{"title":"List Document Revisions","deprecated":null,"version":null,"sidebarTitle":"List Document Revisions","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions","href":"/en/api-reference/documents-and-chunks/list-document-revisions"},{"title":"List Chunks","deprecated":null,"version":null,"sidebarTitle":"List Chunks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks","href":"/en/api-reference/documents-and-chunks/list-chunks"},{"title":"Get Chunk","deprecated":null,"version":null,"sidebarTitle":"Get Chunk","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}","href":"/en/api-reference/documents-and-chunks/get-chunk"},{"title":"Delete Document Files in Batch","deprecated":null,"version":null,"sidebarTitle":"Delete Document Files in Batch","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/bulk","href":"/en/api-reference/documents-and-chunks/delete-document-files-in-batch"},{"title":"Re-index Documents","deprecated":null,"version":null,"sidebarTitle":"Re-index Documents","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/documents/reindex","href":"/en/api-reference/documents-and-chunks/re-index-documents"}]},{"group":"Indexing Tasks","pages":[{"title":"Get Indexing Task","deprecated":null,"version":null,"sidebarTitle":"Get Indexing Task","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/en/api-reference/indexing-tasks/get-indexing-task"},{"title":"Cancel Indexing Task","deprecated":null,"version":null,"sidebarTitle":"Cancel Indexing Task","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/en/api-reference/indexing-tasks/cancel-indexing-task"},{"title":"Retry Indexing Task","deprecated":null,"version":null,"sidebarTitle":"Retry Indexing Task","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry","href":"/en/api-reference/indexing-tasks/retry-indexing-task"},{"title":"Get Bulk Task","deprecated":null,"version":null,"sidebarTitle":"Get Bulk Task","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id}","href":"/en/api-reference/indexing-tasks/get-bulk-task"},{"title":"List Document Indexing Tasks","deprecated":null,"version":null,"sidebarTitle":"List Document Indexing Tasks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks","href":"/en/api-reference/indexing-tasks/list-document-indexing-tasks"},{"title":"Get Document Indexing Task","deprecated":null,"version":null,"sidebarTitle":"Get Document Indexing Task","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}","href":"/en/api-reference/indexing-tasks/get-document-indexing-task"},{"title":"List Background Tasks","deprecated":null,"version":null,"sidebarTitle":"List Background Tasks","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/background-tasks","href":"/en/api-reference/indexing-tasks/list-background-tasks"}]},{"group":"Deletion Jobs","pages":[{"title":"Get Deletion Job","deprecated":null,"version":null,"sidebarTitle":"Get Deletion Job","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}","href":"/en/api-reference/deletion-jobs/get-deletion-job"},{"title":"Get Deletion Batch","deprecated":null,"version":null,"sidebarTitle":"Get Deletion Batch","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-batches/{deletion_batch_id}","href":"/en/api-reference/deletion-jobs/get-deletion-batch"}]},{"group":"Sources","pages":[{"title":"List Source Connections","deprecated":null,"version":null,"sidebarTitle":"List Source Connections","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-connections","href":"/en/api-reference/sources/list-source-connections"},{"title":"Create Source","deprecated":null,"version":null,"sidebarTitle":"Create Source","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/en/api-reference/sources/create-source"},{"title":"List Sources","deprecated":null,"version":null,"sidebarTitle":"List Sources","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/en/api-reference/sources/list-sources"},{"title":"Get Source","deprecated":null,"version":null,"sidebarTitle":"Get Source","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/en/api-reference/sources/get-source"},{"title":"Update Source","deprecated":null,"version":null,"sidebarTitle":"Update Source","openapi":"/en/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/en/api-reference/sources/update-source"},{"title":"Delete Source","deprecated":null,"version":null,"sidebarTitle":"Delete Source","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/en/api-reference/sources/delete-source"},{"title":"Test Source Credentials","deprecated":null,"version":null,"sidebarTitle":"Test Source Credentials","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/test","href":"/en/api-reference/sources/test-source-credentials"},{"title":"List Source Pages","deprecated":null,"version":null,"sidebarTitle":"List Source Pages","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/pages","href":"/en/api-reference/sources/list-source-pages"},{"title":"List Source Files","deprecated":null,"version":null,"sidebarTitle":"List Source Files","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files","href":"/en/api-reference/sources/list-source-files"},{"title":"Get Sync Policy","deprecated":null,"version":null,"sidebarTitle":"Get Sync Policy","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/en/api-reference/sources/get-sync-policy"},{"title":"Update Sync Policy","deprecated":null,"version":null,"sidebarTitle":"Update Sync Policy","openapi":"/en/api-reference/openapi_service.json put /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/en/api-reference/sources/update-sync-policy"}]},{"group":"Source Syncs and Imports","pages":[{"title":"Sync Source","deprecated":null,"version":null,"sidebarTitle":"Sync Source","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync","href":"/en/api-reference/source-syncs-and-imports/sync-source"},{"title":"Preview Website Crawl","deprecated":null,"version":null,"sidebarTitle":"Preview Website Crawl","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-preview","href":"/en/api-reference/source-syncs-and-imports/preview-website-crawl"},{"title":"List Crawl Preview Pages","deprecated":null,"version":null,"sidebarTitle":"List Crawl Preview Pages","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/pages","href":"/en/api-reference/source-syncs-and-imports/list-crawl-preview-pages"},{"title":"Import Selected Pages","deprecated":null,"version":null,"sidebarTitle":"Import Selected Pages","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/selection","href":"/en/api-reference/source-syncs-and-imports/import-selected-pages"},{"title":"Import Website Pages","deprecated":null,"version":null,"sidebarTitle":"Import Website Pages","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import","href":"/en/api-reference/source-syncs-and-imports/import-website-pages"},{"title":"Import Source Items","deprecated":null,"version":null,"sidebarTitle":"Import Source Items","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports","href":"/en/api-reference/source-syncs-and-imports/import-source-items"},{"title":"List Source Runs","deprecated":null,"version":null,"sidebarTitle":"List Source Runs","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows","href":"/en/api-reference/source-syncs-and-imports/list-source-runs"},{"title":"Get Source Run","deprecated":null,"version":null,"sidebarTitle":"Get Source Run","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}","href":"/en/api-reference/source-syncs-and-imports/get-source-run"},{"title":"Cancel Source Run","deprecated":null,"version":null,"sidebarTitle":"Cancel Source Run","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/cancel","href":"/en/api-reference/source-syncs-and-imports/cancel-source-run"},{"title":"Retry Source Run","deprecated":null,"version":null,"sidebarTitle":"Retry Source Run","openapi":"/en/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry","href":"/en/api-reference/source-syncs-and-imports/retry-source-run"}]},{"group":"Settings","pages":[{"title":"Get Knowledge Base Settings","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base Settings","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/en/api-reference/settings/get-knowledge-base-settings"},{"title":"Update Knowledge Base Settings","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Base Settings","openapi":"/en/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/en/api-reference/settings/update-knowledge-base-settings"},{"title":"Get Settings Migration","deprecated":null,"version":null,"sidebarTitle":"Get Settings Migration","openapi":"/en/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_id}","href":"/en/api-reference/settings/get-settings-migration"}]}]},{"group":"Classic Knowledge Base","pages":[{"group":"Knowledge Bases","pages":[{"title":"Create an Empty Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Create an Empty Knowledge Base","openapi":"/en/api-reference/openapi_service.json post /datasets","href":"/en/api-reference/knowledge-bases/create-an-empty-knowledge-base"},{"title":"List Knowledge Bases","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Bases","openapi":"/en/api-reference/openapi_service.json get /datasets","href":"/en/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Get Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/get-knowledge-base"},{"title":"Update Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Base","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/update-knowledge-base"},{"title":"Delete Knowledge Base","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Base","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}","href":"/en/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"Retrieve Chunks from a Knowledge Base / Test Retrieval","deprecated":null,"version":null,"sidebarTitle":"Retrieve Chunks from a Knowledge Base / Test Retrieval","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/en/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"Documents","pages":[{"title":"Create Document by Text","deprecated":null,"version":null,"sidebarTitle":"Create Document by Text","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/en/api-reference/documents/create-document-by-text"},{"title":"Create Document by File","deprecated":null,"version":null,"sidebarTitle":"Create Document by File","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/en/api-reference/documents/create-document-by-file"},{"title":"List Documents","deprecated":null,"version":null,"sidebarTitle":"List Documents","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents","href":"/en/api-reference/documents/list-documents"},{"title":"Get Document","deprecated":null,"version":null,"sidebarTitle":"Get Document","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/get-document"},{"title":"Delete Document","deprecated":null,"version":null,"sidebarTitle":"Delete Document","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/delete-document"},{"title":"Update Document","deprecated":null,"version":null,"sidebarTitle":"Update Document","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/en/api-reference/documents/update-document"},{"title":"Download Document","deprecated":null,"version":null,"sidebarTitle":"Download Document","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/en/api-reference/documents/download-document"},{"title":"Get Document Indexing Status","deprecated":null,"version":null,"sidebarTitle":"Get Document Indexing Status","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/en/api-reference/documents/get-document-indexing-status"},{"title":"Update Document by Text","deprecated":null,"version":null,"sidebarTitle":"Update Document by Text","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/en/api-reference/documents/update-document-by-text"},{"title":"Update Document by File","deprecated":true,"version":null,"sidebarTitle":"Update Document by File","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/en/api-reference/documents/update-document-by-file"},{"title":"Download Documents as ZIP","deprecated":null,"version":null,"sidebarTitle":"Download Documents as ZIP","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/en/api-reference/documents/download-documents-as-zip"},{"title":"Update Document Status in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Status in Batch","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/en/api-reference/documents/update-document-status-in-batch"}]},{"group":"Chunks","pages":[{"title":"Create Chunks","deprecated":null,"version":null,"sidebarTitle":"Create Chunks","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/api-reference/chunks/create-chunks"},{"title":"List Chunks","deprecated":null,"version":null,"sidebarTitle":"List Chunks","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/en/api-reference/chunks/list-chunks"},{"title":"Get Chunk","deprecated":null,"version":null,"sidebarTitle":"Get Chunk","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/get-chunk"},{"title":"Update Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Chunk","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/update-chunk"},{"title":"Delete Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Chunk","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/en/api-reference/chunks/delete-chunk"},{"title":"Create Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Create Child Chunk","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/api-reference/chunks/create-child-chunk"},{"title":"List Child Chunks","deprecated":null,"version":null,"sidebarTitle":"List Child Chunks","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/en/api-reference/chunks/list-child-chunks"},{"title":"Update Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Update Child Chunk","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/api-reference/chunks/update-child-chunk"},{"title":"Delete Child Chunk","deprecated":null,"version":null,"sidebarTitle":"Delete Child Chunk","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/en/api-reference/chunks/delete-child-chunk"}]},{"group":"Metadata","pages":[{"title":"Create Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Create Metadata Field","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/en/api-reference/metadata/create-metadata-field"},{"title":"List Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"List Metadata Fields","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/en/api-reference/metadata/list-metadata-fields"},{"title":"Update Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Metadata Field","openapi":"/en/api-reference/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/api-reference/metadata/update-metadata-field"},{"title":"Delete Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Delete Metadata Field","openapi":"/en/api-reference/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/en/api-reference/metadata/delete-metadata-field"},{"title":"Get Built-in Metadata Fields","deprecated":null,"version":null,"sidebarTitle":"Get Built-in Metadata Fields","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/en/api-reference/metadata/get-built-in-metadata-fields"},{"title":"Update Built-in Metadata Field","deprecated":null,"version":null,"sidebarTitle":"Update Built-in Metadata Field","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/en/api-reference/metadata/update-built-in-metadata-field"},{"title":"Update Document Metadata in Batch","deprecated":null,"version":null,"sidebarTitle":"Update Document Metadata in Batch","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/en/api-reference/metadata/update-document-metadata-in-batch"}]},{"group":"Tags","pages":[{"title":"Create Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Create Knowledge Tag","openapi":"/en/api-reference/openapi_service.json post /datasets/tags","href":"/en/api-reference/tags/create-knowledge-tag"},{"title":"List Knowledge Tags","deprecated":null,"version":null,"sidebarTitle":"List Knowledge Tags","openapi":"/en/api-reference/openapi_service.json get /datasets/tags","href":"/en/api-reference/tags/list-knowledge-tags"},{"title":"Update Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Update Knowledge Tag","openapi":"/en/api-reference/openapi_service.json patch /datasets/tags","href":"/en/api-reference/tags/update-knowledge-tag"},{"title":"Delete Knowledge Tag","deprecated":null,"version":null,"sidebarTitle":"Delete Knowledge Tag","openapi":"/en/api-reference/openapi_service.json delete /datasets/tags","href":"/en/api-reference/tags/delete-knowledge-tag"},{"title":"Create Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Create Tag Binding","openapi":"/en/api-reference/openapi_service.json post /datasets/tags/binding","href":"/en/api-reference/tags/create-tag-binding"},{"title":"Delete Tag Binding","deprecated":null,"version":null,"sidebarTitle":"Delete Tag Binding","openapi":"/en/api-reference/openapi_service.json post /datasets/tags/unbinding","href":"/en/api-reference/tags/delete-tag-binding"},{"title":"Get Knowledge Base Tags","deprecated":null,"version":null,"sidebarTitle":"Get Knowledge Base Tags","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/tags","href":"/en/api-reference/tags/get-knowledge-base-tags"}]},{"group":"Models","pages":[{"title":"Get Available Models","deprecated":null,"version":null,"sidebarTitle":"Get Available Models","openapi":"/en/api-reference/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/en/api-reference/models/get-available-models"}]},{"group":"Knowledge Pipeline","pages":[{"title":"Upload Pipeline File","deprecated":null,"version":null,"sidebarTitle":"Upload Pipeline File","openapi":"/en/api-reference/openapi_service.json post /datasets/pipeline/file-upload","href":"/en/api-reference/knowledge-pipeline/upload-pipeline-file"},{"title":"List Datasource Plugins","deprecated":null,"version":null,"sidebarTitle":"List Datasource Plugins","openapi":"/en/api-reference/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/en/api-reference/knowledge-pipeline/list-datasource-plugins"},{"title":"Run Datasource Node","deprecated":null,"version":null,"sidebarTitle":"Run Datasource Node","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/en/api-reference/knowledge-pipeline/run-datasource-node"},{"title":"Run Pipeline","deprecated":null,"version":null,"sidebarTitle":"Run Pipeline","openapi":"/en/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/en/api-reference/knowledge-pipeline/run-pipeline"}]}]}]}]},{"item":"CLI","icon":"terminal","groups":[{"group":" ","expanded":true,"pages":[{"title":"Overview","href":"/en/cli/overview"},{"title":"Get Started","href":"/en/cli/get-started"},{"title":"Find and Run Commands","href":"/en/cli/find-and-run-commands"},{"group":"Work with Apps","expanded":true,"pages":[{"title":"Build Apps","sidebarTitle":"Build","href":"/en/cli/build-apps"},{"title":"Run Apps","sidebarTitle":"Run","href":"/en/cli/run-apps"},{"title":"Create and Update Apps from DSL Files","sidebarTitle":"Create or Update from DSL","href":"/en/cli/create-and-update-apps-from-dsl-files"},{"title":"Use `difyctl` in CI and Automation","sidebarTitle":"CI and Automation","href":"/en/cli/scripts-and-ci"}]},{"group":"Manage difyctl","expanded":true,"pages":[{"title":"Manage Your Sign-In","sidebarTitle":"Sign-In and Sessions","href":"/en/cli/manage-sign-in"},{"title":"Update or Uninstall difyctl","sidebarTitle":"Update or Uninstall","href":"/en/cli/update-or-uninstall"},{"title":"Upgrade Across Dify 1.18.0","sidebarTitle":"Upgrade Across 1.18.0","href":"/en/cli/upgrade-across-1-18"}]},{"group":"Reference","expanded":true,"pages":[{"title":"Command Index","href":"/en/cli/reference/command-index"},{"title":"Results, Errors, and Exit Codes","sidebarTitle":"Results and Errors","href":"/en/cli/reference/results-errors-and-exit-codes"},{"title":"Configuration","href":"/en/cli/reference/configuration"}]}]}]},{"item":"Plugins","icon":"code-pull-request","groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"Dify Plugin","href":"/en/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"Choose a Plugin Type","href":"/en/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify Plugin CLI","href":"/en/develop-plugin/getting-started/cli"}]},{"group":"Features \u0026 Specs","icon":"list-check","pages":[{"group":"Plugin Types","pages":[{"title":"General Specs","href":"/en/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"Model Specs","href":"/en/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"Model API Interface","href":"/en/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"Persistent Storage","href":"/en/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"Tool Return","href":"/en/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/en/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"Multilingual README","href":"/en/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"Plugin Debugging","href":"/en/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"Plugin Logging","href":"/en/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"Advanced Development","pages":[{"group":"Reverse Calling","pages":[{"title":"Bundle Plugin Package","href":"/en/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Reverse Invocation of Dify Services","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"App","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"Reverse Invocation Model","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"Tool","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"Integrate Custom Models","href":"/en/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"Node","href":"/en/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"Development Guides \u0026 Walkthroughs","icon":"code","pages":[{"title":"Cheatsheet","href":"/en/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"By Plugin Type","pages":[{"title":"Tool Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/en/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"Model Provider Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"Agent Strategy Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"Data Source Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"Trigger Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint Plugin","href":"/en/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"Full Walkthroughs","pages":[{"title":"Flomo Tool (10-min)","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdown Exporter","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"Multimodal Tool","href":"/en/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"Publishing","icon":"upload","pages":[{"title":"Publish Plugins","href":"/en/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"Standards","pages":[{"title":"Plugin Development Guidelines","href":"/en/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"Privacy Guidelines","href":"/en/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"Publish a Plugin to Marketplace","sidebarTitle":"Marketplace","href":"/en/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub Repository","pages":[{"title":"Publish to Individual GitHub Repository","href":"/en/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"Local File","pages":[{"title":"Package as Local File and Share","href":"/en/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"Sign Plugins for Third-Party Signature Verification","href":"/en/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"Frequently Asked Questions","sidebarTitle":"FAQ","href":"/en/develop-plugin/publishing/faq/faq"}]}]}]}]}]},{"language":"zh","products":[{"product":"Cloud","icon":"cloud","tabs":[{"tab":"使用","icon":"book-open","pages":[{"title":"使用 Dify","sidebarTitle":"概览","mode":"frame","href":"/zh/cloud/use-dify/getting-started/introduction"},{"title":"Dify 文档","mode":"custom","hidden":true,"href":"/zh/home"},{"group":"编排","icon":"hammer","pages":[{"group":"Workflow 与 Chatflow","expanded":false,"pages":[{"title":"Workflow 与 Chatflow","sidebarTitle":"概述","href":"/zh/cloud/use-dify/build/workflow-chatflow"},{"title":"编排逻辑","href":"/zh/cloud/use-dify/build/orchestrate-node"},{"group":"节点","expanded":false,"pages":[{"group":"开始","root":{"title":"开始节点","href":"/zh/cloud/use-dify/nodes/start"},"pages":[{"title":"用户输入","href":"/zh/cloud/use-dify/nodes/user-input"},{"group":"触发器","root":{"title":"触发器","sidebarTitle":"概述","href":"/zh/cloud/use-dify/nodes/trigger/overview"},"pages":[{"title":"定时触发器","href":"/zh/cloud/use-dify/nodes/trigger/schedule-trigger"},{"title":"集成触发器","href":"/zh/cloud/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook 触发器","href":"/zh/cloud/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"大语言模型","href":"/zh/cloud/use-dify/nodes/llm"},{"title":"Agent 知识检索","href":"/zh/cloud/use-dify/nodes/knowledge-retrieval-v2"},{"title":"经典知识检索","href":"/zh/cloud/use-dify/nodes/knowledge-retrieval"},{"title":"直接回复","href":"/zh/cloud/use-dify/nodes/answer"},{"title":"输出","href":"/zh/cloud/use-dify/nodes/output"},{"title":"Agent","href":"/zh/cloud/use-dify/nodes/agent"},{"title":"问题分类器","href":"/zh/cloud/use-dify/nodes/question-classifier"},{"title":"If-Else","href":"/zh/cloud/use-dify/nodes/ifelse"},{"group":"人工介入","root":{"title":"人工介入","href":"/zh/cloud/use-dify/nodes/human-input"},"expanded":false,"pages":[]},{"title":"迭代","href":"/zh/cloud/use-dify/nodes/iteration"},{"title":"循环","href":"/zh/cloud/use-dify/nodes/loop"},{"title":"代码","href":"/zh/cloud/use-dify/nodes/code"},{"title":"模板转换","href":"/zh/cloud/use-dify/nodes/template"},{"title":"变量聚合器","href":"/zh/cloud/use-dify/nodes/variable-aggregator"},{"title":"文档提取器","href":"/zh/cloud/use-dify/nodes/doc-extractor"},{"title":"变量赋值器","href":"/zh/cloud/use-dify/nodes/variable-assigner"},{"title":"参数提取器","href":"/zh/cloud/use-dify/nodes/parameter-extractor"},{"title":"HTTP 请求","href":"/zh/cloud/use-dify/nodes/http-request"},{"title":"列表操作符","href":"/zh/cloud/use-dify/nodes/list-operator"},{"title":"工具节点","sidebarTitle":"工具","href":"/zh/cloud/use-dify/nodes/tools"}]},{"title":"快捷键","href":"/zh/cloud/use-dify/build/shortcut-key"},{"title":"版本控制","href":"/zh/cloud/use-dify/build/version-control"},{"title":"Snippets","href":"/zh/cloud/use-dify/build/snippet"},{"group":"调试","expanded":false,"pages":[{"title":"处理错误","href":"/zh/cloud/use-dify/build/predefined-error-handling-logic"},{"title":"单节点","href":"/zh/cloud/use-dify/debug/step-run"},{"title":"变量检查器","href":"/zh/cloud/use-dify/debug/variable-inspect"},{"title":"运行历史","href":"/zh/cloud/use-dify/debug/history-and-logs"},{"title":"错误类型","href":"/zh/cloud/use-dify/debug/error-type"}]}]},{"group":"Agent","tag":"New","expanded":false,"pages":[{"title":"Agent","sidebarTitle":"概述","href":"/zh/cloud/use-dify/build/new-agent/overview"},{"title":"构建 Agent","sidebarTitle":"构建","href":"/zh/cloud/use-dify/build/new-agent/build"}]},{"group":"基础应用","expanded":false,"pages":[{"title":"Agent","tag":"Legacy","href":"/zh/cloud/use-dify/build/agent"},{"title":"聊天助手","sidebarTitle":"聊天助手","href":"/zh/cloud/use-dify/build/chatbot"},{"title":"文本生成应用","sidebarTitle":"文本生成应用","href":"/zh/cloud/use-dify/build/text-generator"}]},{"title":"应用工具箱","href":"/zh/cloud/use-dify/build/additional-features"},{"title":"全局搜索","href":"/zh/cloud/use-dify/build/goto-anything"}]},{"group":"发布","icon":"paper-plane","expanded":false,"pages":[{"title":"分享你的 AI 应用","href":"/zh/cloud/use-dify/publish/README"},{"title":"IP 访问控制","href":"/zh/cloud/use-dify/publish/ip-access-control"},{"group":"Web App","pages":[{"title":"Workflow Web 应用","href":"/zh/cloud/use-dify/publish/webapp/workflow-webapp"},{"title":"聊天 Web App","href":"/zh/cloud/use-dify/publish/webapp/chatflow-webapp"},{"title":"Web App 设置","href":"/zh/cloud/use-dify/publish/webapp/web-app-settings"},{"title":"嵌入 Web 应用","sidebarTitle":"嵌入","href":"/zh/cloud/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP 服务器","href":"/zh/cloud/use-dify/publish/publish-mcp"},{"title":"发布应用到市场","sidebarTitle":"市场","href":"/zh/cloud/use-dify/publish/publish-to-marketplace"}]},{"group":"监控","icon":"chart-line","expanded":false,"pages":[{"title":"仪表盘","href":"/zh/cloud/use-dify/monitor/analysis"},{"title":"日志","href":"/zh/cloud/use-dify/monitor/logs"},{"title":"标注系统","href":"/zh/cloud/use-dify/monitor/annotation-reply"},{"group":"集成","pages":[{"title":"集成 LangSmith","href":"/zh/cloud/use-dify/monitor/integrations/integrate-langsmith"},{"title":"集成 Langfuse","href":"/zh/cloud/use-dify/monitor/integrations/integrate-langfuse"},{"title":"集成 Opik","href":"/zh/cloud/use-dify/monitor/integrations/integrate-opik"},{"title":"集成 W\u0026B Weave","href":"/zh/cloud/use-dify/monitor/integrations/integrate-weave"},{"title":"集成 Arize","href":"/zh/cloud/use-dify/monitor/integrations/integrate-arize"},{"title":"集成 Phoenix","href":"/zh/cloud/use-dify/monitor/integrations/integrate-phoenix"},{"title":"集成阿里云云监控","href":"/zh/cloud/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"知识库","icon":"book","expanded":false,"pages":[{"title":"知识库","sidebarTitle":"概述","href":"/zh/cloud/use-dify/knowledge/overview"},{"group":"Agent 知识库","tag":"New","expanded":false,"pages":[{"title":"Agent 知识库","sidebarTitle":"概述","href":"/zh/cloud/use-dify/knowledge-base/overview"},{"title":"创建 Agent 知识库","sidebarTitle":"创建","href":"/zh/cloud/use-dify/knowledge-base/create-knowledge-base"},{"title":"检查已索引的文档","sidebarTitle":"检查索引结果","href":"/zh/cloud/use-dify/knowledge-base/review-indexed-documents"},{"title":"测试并调优检索","sidebarTitle":"测试与调优","href":"/zh/cloud/use-dify/knowledge-base/test-and-tune"},{"title":"检索设置","sidebarTitle":"检索设置","href":"/zh/cloud/use-dify/knowledge-base/retrieval-settings"},{"title":"接入应用、Agent 和代码","sidebarTitle":"接入","href":"/zh/cloud/use-dify/knowledge-base/use-knowledge-in-apps"},{"title":"多模态检索","sidebarTitle":"多模态检索","href":"/zh/cloud/use-dify/knowledge-base/multimodal-retrieval"},{"title":"维护 Agent 知识库","sidebarTitle":"维护","href":"/zh/cloud/use-dify/knowledge-base/maintain-knowledge-base"},{"title":"从经典知识库升级到 Agent 知识库","sidebarTitle":"从经典知识库升级","href":"/zh/cloud/use-dify/knowledge-base/upgrade-from-classic"}]},{"group":"经典知识库","expanded":false,"pages":[{"title":"经典知识库","sidebarTitle":"概述","href":"/zh/cloud/use-dify/knowledge/readme"},{"group":"创建","pages":[{"group":"创建即用型知识库","pages":[{"title":"创建即用型知识库","sidebarTitle":"概述","href":"/zh/cloud/use-dify/knowledge/create-knowledge/introduction"},{"group":"导入数据","pages":[{"title":"上传本地文件","href":"/zh/cloud/use-dify/knowledge/create-knowledge/import-text-data/readme"},{"title":"从 Notion 导入数据","href":"/zh/cloud/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion"},{"title":"从网页导入数据","href":"/zh/cloud/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website"}]},{"title":"指定分段设置","sidebarTitle":"设置分段","href":"/zh/cloud/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text"},{"title":"指定索引方式与检索设置","sidebarTitle":"设置索引与检索","href":"/zh/cloud/use-dify/knowledge/create-knowledge/setting-indexing-methods"}]},{"group":"构建自定义知识库","pages":[{"title":"构建自定义知识库","sidebarTitle":"概述","href":"/zh/cloud/use-dify/knowledge/knowledge-pipeline/readme"},{"title":"步骤一:创建知识流水线","href":"/zh/cloud/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline"},{"title":"步骤二:编排知识流水线","href":"/zh/cloud/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration"},{"title":"步骤三:发布知识流水线","href":"/zh/cloud/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline"},{"title":"步骤四:上传文件","href":"/zh/cloud/use-dify/knowledge/knowledge-pipeline/upload-files"},{"title":"步骤五:管理和使用知识库","href":"/zh/cloud/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base"},{"title":"数据源授权","href":"/zh/cloud/use-dify/knowledge/knowledge-pipeline/authorize-data-source"}]},{"group":"连接外部知识库","pages":[{"title":"连接外部知识库","sidebarTitle":"概述","href":"/zh/cloud/use-dify/knowledge/connect-external-knowledge-base"},{"title":"外部知识库 API","href":"/zh/cloud/use-dify/knowledge/external-knowledge-api"}]}]},{"group":"管理","pages":[{"title":"维护知识库内容","sidebarTitle":"文档与分段","href":"/zh/cloud/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents"},{"title":"管理文档元数据","sidebarTitle":"元数据","href":"/zh/cloud/use-dify/knowledge/metadata"},{"title":"调整知识库设置","sidebarTitle":"设置","href":"/zh/cloud/use-dify/knowledge/manage-knowledge/introduction"}]},{"title":"测试检索","sidebarTitle":"调试","href":"/zh/cloud/use-dify/knowledge/test-retrieval"},{"title":"在应用内集成知识库","sidebarTitle":"在应用内集成","href":"/zh/cloud/use-dify/knowledge/integrate-knowledge-within-application"}]},{"title":"知识库请求频率限制","sidebarTitle":"请求频率限制","href":"/zh/cloud/use-dify/knowledge/knowledge-request-rate-limit"},{"title":"知识库存储与文档配额","sidebarTitle":"存储与文档配额","href":"/zh/cloud/use-dify/knowledge/knowledge-storage-limit"}]},{"group":"集成","icon":"plug","expanded":false,"pages":[{"title":"集成","sidebarTitle":"概览","href":"/zh/cloud/use-dify/workspace/plugins"},{"title":"模型供应商","href":"/zh/cloud/use-dify/workspace/model-providers"},{"title":"Dify 工具","sidebarTitle":"工具","href":"/zh/cloud/use-dify/workspace/tools"},{"group":"自定义端点","pages":[{"title":"自定义端点","sidebarTitle":"概述","href":"/zh/cloud/use-dify/workspace/api-extension/api-extension"},{"title":"外部数据工具","href":"/zh/cloud/use-dify/workspace/api-extension/external-data-tool-api-extension"},{"title":"敏感内容审查","href":"/zh/cloud/use-dify/workspace/api-extension/moderation-api-extension"},{"title":"使用 Cloudflare Workers 部署自定义端点","href":"/zh/cloud/use-dify/workspace/api-extension/cloudflare-worker"}]}]},{"group":"工作空间","icon":"briefcase","expanded":false,"pages":[{"title":"工作空间","sidebarTitle":"概述","href":"/zh/cloud/use-dify/workspace/readme"},{"title":"导出和导入应用","sidebarTitle":"导出和导入","href":"/zh/cloud/use-dify/workspace/export-import-apps"},{"title":"管理成员","href":"/zh/cloud/use-dify/workspace/team-members-management"},{"title":"个人设置","href":"/zh/cloud/use-dify/workspace/personal-account-management"},{"title":"计费","href":"/zh/cloud/use-dify/workspace/subscription-management"}]}]},{"tab":"学习","icon":"graduation-cap","pages":[{"title":"核心概念","href":"/zh/learn/key-concepts"},{"group":"教程","pages":[{"title":"30 分钟快速入门","href":"/zh/quick-start"},{"group":"工作流 101","pages":[{"title":"第 1 课:什么是工作流","href":"/zh/learn/tutorials/workflow-101/lesson-01"},{"title":"第 2 课:流程的头和尾(开始与输出节点)","sidebarTitle":"第 2 课:流程的头和尾","href":"/zh/learn/tutorials/workflow-101/lesson-02"},{"title":"第 3 课:工作流的大脑(LLM 节点)","sidebarTitle":"第 3 课:工作流的大脑","href":"/zh/learn/tutorials/workflow-101/lesson-03"},{"title":"第 4 课:小抄(知识检索)","sidebarTitle":"第 4 课:小抄","href":"/zh/learn/tutorials/workflow-101/lesson-04"},{"title":"第 5 课:工作流的岔路口(分类与执行)","sidebarTitle":"第 5 课:工作流的岔路口","href":"/zh/learn/tutorials/workflow-101/lesson-05"},{"title":"第 6 课:处理多个任务(参数提取 \u0026 迭代)","sidebarTitle":"第 6 课:处理多个任务","href":"/zh/learn/tutorials/workflow-101/lesson-06"},{"title":"第 7 课:增强工作流(工具)","sidebarTitle":"第 7 课:增强工作流","href":"/zh/learn/tutorials/workflow-101/lesson-07"},{"title":"第 8 课:Agent 节点","sidebarTitle":"第 8 课:Agent 节点","href":"/zh/learn/tutorials/workflow-101/lesson-08"},{"title":"第 9 课:排版设计师(模板)","sidebarTitle":"第 9 课:排版设计师","href":"/zh/learn/tutorials/workflow-101/lesson-09"},{"title":"第 10 课:发布和监控你的 AI 应用","sidebarTitle":"第 10 课:发布和监控","href":"/zh/learn/tutorials/workflow-101/lesson-10"}]},{"title":"简单聊天机器人","href":"/zh/learn/tutorials/simple-chatbot"},{"title":"ChatFlow 实战:搭建 Twitter 账号分析助手","href":"/zh/learn/tutorials/twitter-chatflow"},{"title":"使用知识库搭建智能客服机器人","href":"/zh/learn/tutorials/customer-service-bot"},{"title":"如何搭建 AI 图片生成应用","href":"/zh/learn/tutorials/build-ai-image-generation-app"},{"title":"使用文件上传搭建文章理解助手","href":"/zh/learn/tutorials/article-reader"}]}]},{"tab":"开发者资源","icon":"code","menu":[{"item":"API","icon":"code","groups":[{"group":"指南","pages":[{"title":"Dify API 快速开始","sidebarTitle":"快速开始","href":"/zh/api-reference/guides/get-started"},{"group":"API 概览","expanded":true,"pages":[{"title":"Chatflow 应用 API","sidebarTitle":"Chatflow","href":"/zh/api-reference/guides/chatflow"},{"title":"Workflow 应用 API","sidebarTitle":"Workflow","href":"/zh/api-reference/guides/workflow"},{"title":"Agent API","sidebarTitle":"Agent","tag":"New","href":"/zh/api-reference/guides/agent"},{"group":"知识库","root":{"title":"知识库 API","sidebarTitle":"知识库","href":"/zh/api-reference/guides/knowledge-base-api"},"pages":[{"title":"Agent 知识库 API","tag":"Cloud","sidebarTitle":"Agent 知识库","href":"/zh/api-reference/guides/knowledge-base"},{"title":"经典知识库 API","sidebarTitle":"经典知识库","href":"/zh/api-reference/guides/knowledge"}]},{"title":"对话型应用 API","sidebarTitle":"Chatbot 和旧版 Agent","href":"/zh/api-reference/guides/chat"},{"title":"文本生成应用 API","sidebarTitle":"文本生成应用","href":"/zh/api-reference/guides/completion"}]},{"title":"处理流式响应","sidebarTitle":"SSE 流式传输","href":"/zh/api-reference/guides/streaming"},{"title":"人工介入 API 集成流程","sidebarTitle":"人工介入流程","href":"/zh/api-reference/guides/human-input-flow"},{"title":"终端用户身份","sidebarTitle":"终端用户身份","href":"/zh/api-reference/guides/end-user-identity"},{"title":"处理错误与速率限制","sidebarTitle":"错误与速率限制","href":"/zh/api-reference/guides/errors"}]},{"group":"应用 API","pages":[{"group":"对话消息","pages":[{"title":"发送对话消息","deprecated":null,"version":null,"sidebarTitle":"发送对话消息","openapi":"/zh/api-reference/openapi_service.json post /chat-messages","href":"/zh/api-reference/chat-messages/send-chat-message"},{"title":"停止响应","deprecated":null,"version":null,"sidebarTitle":"停止响应","openapi":"/zh/api-reference/openapi_service.json post /chat-messages/{task_id}/stop","href":"/zh/api-reference/chat-messages/stop-chat-message-generation"},{"title":"获取下一轮建议问题列表","deprecated":null,"version":null,"sidebarTitle":"获取下一轮建议问题列表","openapi":"/zh/api-reference/openapi_service.json get /messages/{message_id}/suggested","href":"/zh/api-reference/chat-messages/get-next-suggested-questions"}]},{"group":"文本生成消息","pages":[{"title":"发送消息","deprecated":null,"version":null,"sidebarTitle":"发送消息","openapi":"/zh/api-reference/openapi_service.json post /completion-messages","href":"/zh/api-reference/completion-messages/send-completion-message"},{"title":"停止响应","deprecated":null,"version":null,"sidebarTitle":"停止响应","openapi":"/zh/api-reference/openapi_service.json post /completion-messages/{task_id}/stop","href":"/zh/api-reference/completion-messages/stop-completion-message-generation"}]},{"group":"工作流运行","pages":[{"title":"执行工作流","deprecated":null,"version":null,"sidebarTitle":"执行工作流","openapi":"/zh/api-reference/openapi_service.json post /workflows/run","href":"/zh/api-reference/workflow-runs/run-workflow"},{"title":"按 ID 执行工作流","deprecated":null,"version":null,"sidebarTitle":"按 ID 执行工作流","openapi":"/zh/api-reference/openapi_service.json post /workflows/{workflow_id}/run","href":"/zh/api-reference/workflow-runs/run-workflow-by-id"},{"title":"停止工作流任务","deprecated":null,"version":null,"sidebarTitle":"停止工作流任务","openapi":"/zh/api-reference/openapi_service.json post /workflows/tasks/{task_id}/stop","href":"/zh/api-reference/workflow-runs/stop-workflow-task"},{"title":"获取工作流执行情况","deprecated":null,"version":null,"sidebarTitle":"获取工作流执行情况","openapi":"/zh/api-reference/openapi_service.json get /workflows/run/{workflow_run_id}","href":"/zh/api-reference/workflow-runs/get-workflow-run-detail"},{"title":"获取工作流日志","deprecated":null,"version":null,"sidebarTitle":"获取工作流日志","openapi":"/zh/api-reference/openapi_service.json get /workflows/logs","href":"/zh/api-reference/workflow-runs/list-workflow-logs"},{"title":"流式获取工作流事件","deprecated":null,"version":null,"sidebarTitle":"流式获取工作流事件","openapi":"/zh/api-reference/openapi_service.json get /workflow/{workflow_run_id}/events","href":"/zh/api-reference/workflow-runs/stream-workflow-events"}]},{"group":"会话管理","pages":[{"title":"获取会话列表","deprecated":null,"version":null,"sidebarTitle":"获取会话列表","openapi":"/zh/api-reference/openapi_service.json get /conversations","href":"/zh/api-reference/conversations/list-conversations"},{"title":"获取会话历史消息","deprecated":null,"version":null,"sidebarTitle":"获取会话历史消息","openapi":"/zh/api-reference/openapi_service.json get /messages","href":"/zh/api-reference/conversations/list-conversation-messages"},{"title":"获取会话变量","deprecated":null,"version":null,"sidebarTitle":"获取会话变量","openapi":"/zh/api-reference/openapi_service.json get /conversations/{conversation_id}/variables","href":"/zh/api-reference/conversations/list-conversation-variables"},{"title":"重命名会话","deprecated":null,"version":null,"sidebarTitle":"重命名会话","openapi":"/zh/api-reference/openapi_service.json post /conversations/{conversation_id}/name","href":"/zh/api-reference/conversations/rename-conversation"},{"title":"更新会话变量","deprecated":null,"version":null,"sidebarTitle":"更新会话变量","openapi":"/zh/api-reference/openapi_service.json put /conversations/{conversation_id}/variables/{variable_id}","href":"/zh/api-reference/conversations/update-conversation-variable"},{"title":"删除会话","deprecated":null,"version":null,"sidebarTitle":"删除会话","openapi":"/zh/api-reference/openapi_service.json delete /conversations/{conversation_id}","href":"/zh/api-reference/conversations/delete-conversation"}]},{"group":"文件操作","pages":[{"title":"上传文件","deprecated":null,"version":null,"sidebarTitle":"上传文件","openapi":"/zh/api-reference/openapi_service.json post /files/upload","href":"/zh/api-reference/files/upload-file"},{"title":"下载文件","deprecated":null,"version":null,"sidebarTitle":"下载文件","openapi":"/zh/api-reference/openapi_service.json get /files/{file_id}/preview","href":"/zh/api-reference/files/download-file"}]},{"group":"语音与文字转换","pages":[{"title":"语音转文字","deprecated":null,"version":null,"sidebarTitle":"语音转文字","openapi":"/zh/api-reference/openapi_service.json post /audio-to-text","href":"/zh/api-reference/audio/convert-audio-to-text"},{"title":"文字转语音","deprecated":null,"version":null,"sidebarTitle":"文字转语音","openapi":"/zh/api-reference/openapi_service.json post /text-to-audio","href":"/zh/api-reference/audio/convert-text-to-audio"}]},{"group":"应用配置","pages":[{"title":"获取应用基本信息","deprecated":null,"version":null,"sidebarTitle":"获取应用基本信息","openapi":"/zh/api-reference/openapi_service.json get /info","href":"/zh/api-reference/applications/get-app-info"},{"title":"获取应用参数","deprecated":null,"version":null,"sidebarTitle":"获取应用参数","openapi":"/zh/api-reference/openapi_service.json get /parameters","href":"/zh/api-reference/applications/get-app-parameters"},{"title":"获取应用元数据","deprecated":null,"version":null,"sidebarTitle":"获取应用元数据","openapi":"/zh/api-reference/openapi_service.json get /meta","href":"/zh/api-reference/applications/get-app-meta"},{"title":"获取应用 WebApp 设置","deprecated":null,"version":null,"sidebarTitle":"获取应用 WebApp 设置","openapi":"/zh/api-reference/openapi_service.json get /site","href":"/zh/api-reference/applications/get-app-webapp-settings"}]},{"group":"消息反馈","pages":[{"title":"提交消息反馈","deprecated":null,"version":null,"sidebarTitle":"提交消息反馈","openapi":"/zh/api-reference/openapi_service.json post /messages/{message_id}/feedbacks","href":"/zh/api-reference/feedback/submit-message-feedback"},{"title":"获取应用的消息反馈","deprecated":null,"version":null,"sidebarTitle":"获取应用的消息反馈","openapi":"/zh/api-reference/openapi_service.json get /app/feedbacks","href":"/zh/api-reference/feedback/list-app-feedbacks"}]},{"group":"标注管理","pages":[{"title":"创建标注","deprecated":null,"version":null,"sidebarTitle":"创建标注","openapi":"/zh/api-reference/openapi_service.json post /apps/annotations","href":"/zh/api-reference/annotations/create-annotation"},{"title":"获取标注列表","deprecated":null,"version":null,"sidebarTitle":"获取标注列表","openapi":"/zh/api-reference/openapi_service.json get /apps/annotations","href":"/zh/api-reference/annotations/list-annotations"},{"title":"更新标注","deprecated":null,"version":null,"sidebarTitle":"更新标注","openapi":"/zh/api-reference/openapi_service.json put /apps/annotations/{annotation_id}","href":"/zh/api-reference/annotations/update-annotation"},{"title":"删除标注","deprecated":null,"version":null,"sidebarTitle":"删除标注","openapi":"/zh/api-reference/openapi_service.json delete /apps/annotations/{annotation_id}","href":"/zh/api-reference/annotations/delete-annotation"},{"title":"配置标注回复","deprecated":null,"version":null,"sidebarTitle":"配置标注回复","openapi":"/zh/api-reference/openapi_service.json post /apps/annotation-reply/{action}","href":"/zh/api-reference/annotations/configure-annotation-reply"},{"title":"查询标注回复配置任务状态","deprecated":null,"version":null,"sidebarTitle":"查询标注回复配置任务状态","openapi":"/zh/api-reference/openapi_service.json get /apps/annotation-reply/{action}/status/{job_id}","href":"/zh/api-reference/annotations/get-annotation-reply-job-status"}]},{"group":"终端用户","pages":[{"title":"获取终端用户信息","deprecated":null,"version":null,"sidebarTitle":"获取终端用户信息","openapi":"/zh/api-reference/openapi_service.json get /end-users/{end_user_id}","href":"/zh/api-reference/end-users/get-end-user-info"}]},{"group":"人工介入","pages":[{"title":"获取人工介入表单","deprecated":null,"version":null,"sidebarTitle":"获取人工介入表单","openapi":"/zh/api-reference/openapi_service.json get /form/human_input/{form_token}","href":"/zh/api-reference/human-input/get-human-input-form"},{"title":"提交人工介入表单","deprecated":null,"version":null,"sidebarTitle":"提交人工介入表单","openapi":"/zh/api-reference/openapi_service.json post /form/human_input/{form_token}","href":"/zh/api-reference/human-input/submit-human-input-form"}]}]},{"group":"知识库 API","pages":[{"group":"Agent 知识库","tag":"Cloud","pages":[{"group":"查询","pages":[{"title":"创建查询令牌","deprecated":null,"version":null,"sidebarTitle":"创建查询令牌","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/queries/admission","href":"/zh/api-reference/queries/create-query-token"},{"title":"运行查询","deprecated":null,"version":null,"sidebarTitle":"运行查询","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/query-stream","href":"/zh/api-reference/queries/run-query"}]},{"group":"查询记录","pages":[{"title":"获取查询记录列表","deprecated":null,"version":null,"sidebarTitle":"获取查询记录列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces","href":"/zh/api-reference/query-records/list-query-records"},{"title":"获取查询记录","deprecated":null,"version":null,"sidebarTitle":"获取查询记录","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}","href":"/zh/api-reference/query-records/get-query-record"},{"title":"获取查询分段列表","deprecated":null,"version":null,"sidebarTitle":"获取查询分段列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/evidence","href":"/zh/api-reference/query-records/list-query-chunks"},{"title":"获取查询冲突列表","deprecated":null,"version":null,"sidebarTitle":"获取查询冲突列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/conflicts","href":"/zh/api-reference/query-records/list-query-conflicts"},{"title":"获取缺失分段列表","deprecated":null,"version":null,"sidebarTitle":"获取缺失分段列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/missing","href":"/zh/api-reference/query-records/list-missing-chunks"}]},{"group":"研究任务","pages":[{"title":"获取研究任务列表","deprecated":null,"version":null,"sidebarTitle":"获取研究任务列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/zh/api-reference/research-tasks/list-research-tasks"},{"title":"创建研究任务","deprecated":null,"version":null,"sidebarTitle":"创建研究任务","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/zh/api-reference/research-tasks/create-research-task"},{"title":"规划研究任务","deprecated":null,"version":null,"sidebarTitle":"规划研究任务","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/plan","href":"/zh/api-reference/research-tasks/plan-research-task"},{"title":"获取研究任务","deprecated":null,"version":null,"sidebarTitle":"获取研究任务","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/zh/api-reference/research-tasks/get-research-task"},{"title":"取消研究任务","deprecated":null,"version":null,"sidebarTitle":"取消研究任务","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/zh/api-reference/research-tasks/cancel-research-task"},{"title":"获取研究任务结果列表","deprecated":null,"version":null,"sidebarTitle":"获取研究任务结果列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials","href":"/zh/api-reference/research-tasks/list-research-task-results"}]},{"group":"文档与分段","pages":[{"title":"获取文档列表","deprecated":null,"version":null,"sidebarTitle":"获取文档列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents","href":"/zh/api-reference/documents-and-chunks/list-documents"},{"title":"获取文档","deprecated":null,"version":null,"sidebarTitle":"获取文档","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/zh/api-reference/documents-and-chunks/get-document"},{"title":"更新文档元数据","deprecated":null,"version":null,"sidebarTitle":"更新文档元数据","openapi":"/zh/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/zh/api-reference/documents-and-chunks/update-document-metadata"},{"title":"按文件获取文档","deprecated":null,"version":null,"sidebarTitle":"按文件获取文档","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/document-references/resolve","href":"/zh/api-reference/documents-and-chunks/get-document-by-file"},{"title":"获取文档文件列表","deprecated":null,"version":null,"sidebarTitle":"获取文档文件列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents","href":"/zh/api-reference/documents-and-chunks/list-document-files"},{"title":"获取文档文件","deprecated":null,"version":null,"sidebarTitle":"获取文档文件","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/zh/api-reference/documents-and-chunks/get-document-file"},{"title":"删除文档文件","deprecated":null,"version":null,"sidebarTitle":"删除文档文件","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/zh/api-reference/documents-and-chunks/delete-document-file"},{"title":"获取文档大纲","deprecated":null,"version":null,"sidebarTitle":"获取文档大纲","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline","href":"/zh/api-reference/documents-and-chunks/get-document-outline"},{"title":"获取文档修订版本列表","deprecated":null,"version":null,"sidebarTitle":"获取文档修订版本列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions","href":"/zh/api-reference/documents-and-chunks/list-document-revisions"},{"title":"获取分段列表","deprecated":null,"version":null,"sidebarTitle":"获取分段列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks","href":"/zh/api-reference/documents-and-chunks/list-chunks"},{"title":"获取分段","deprecated":null,"version":null,"sidebarTitle":"获取分段","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}","href":"/zh/api-reference/documents-and-chunks/get-chunk"},{"title":"批量删除文档文件","deprecated":null,"version":null,"sidebarTitle":"批量删除文档文件","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/bulk","href":"/zh/api-reference/documents-and-chunks/delete-document-files-in-batch"},{"title":"重新索引文档","deprecated":null,"version":null,"sidebarTitle":"重新索引文档","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/documents/reindex","href":"/zh/api-reference/documents-and-chunks/re-index-documents"}]},{"group":"索引任务","pages":[{"title":"获取索引任务","deprecated":null,"version":null,"sidebarTitle":"获取索引任务","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/zh/api-reference/indexing-tasks/get-indexing-task"},{"title":"取消索引任务","deprecated":null,"version":null,"sidebarTitle":"取消索引任务","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/zh/api-reference/indexing-tasks/cancel-indexing-task"},{"title":"重试索引任务","deprecated":null,"version":null,"sidebarTitle":"重试索引任务","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry","href":"/zh/api-reference/indexing-tasks/retry-indexing-task"},{"title":"获取批量任务","deprecated":null,"version":null,"sidebarTitle":"获取批量任务","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id}","href":"/zh/api-reference/indexing-tasks/get-bulk-task"},{"title":"获取文档的索引任务列表","deprecated":null,"version":null,"sidebarTitle":"获取文档的索引任务列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks","href":"/zh/api-reference/indexing-tasks/list-document-indexing-tasks"},{"title":"获取文档的索引任务","deprecated":null,"version":null,"sidebarTitle":"获取文档的索引任务","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}","href":"/zh/api-reference/indexing-tasks/get-document-indexing-task"},{"title":"获取后台任务列表","deprecated":null,"version":null,"sidebarTitle":"获取后台任务列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/background-tasks","href":"/zh/api-reference/indexing-tasks/list-background-tasks"}]},{"group":"删除作业","pages":[{"title":"获取删除作业","deprecated":null,"version":null,"sidebarTitle":"获取删除作业","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}","href":"/zh/api-reference/deletion-jobs/get-deletion-job"},{"title":"获取删除批次","deprecated":null,"version":null,"sidebarTitle":"获取删除批次","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-batches/{deletion_batch_id}","href":"/zh/api-reference/deletion-jobs/get-deletion-batch"}]},{"group":"数据源","pages":[{"title":"获取数据源连接列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源连接列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-connections","href":"/zh/api-reference/sources/list-source-connections"},{"title":"创建数据源","deprecated":null,"version":null,"sidebarTitle":"创建数据源","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/zh/api-reference/sources/create-source"},{"title":"获取数据源列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/zh/api-reference/sources/list-sources"},{"title":"获取数据源","deprecated":null,"version":null,"sidebarTitle":"获取数据源","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/zh/api-reference/sources/get-source"},{"title":"更新数据源","deprecated":null,"version":null,"sidebarTitle":"更新数据源","openapi":"/zh/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/zh/api-reference/sources/update-source"},{"title":"删除数据源","deprecated":null,"version":null,"sidebarTitle":"删除数据源","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/zh/api-reference/sources/delete-source"},{"title":"测试数据源凭据","deprecated":null,"version":null,"sidebarTitle":"测试数据源凭据","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/test","href":"/zh/api-reference/sources/test-source-credentials"},{"title":"获取数据源页面列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源页面列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/pages","href":"/zh/api-reference/sources/list-source-pages"},{"title":"获取数据源文件列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源文件列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files","href":"/zh/api-reference/sources/list-source-files"},{"title":"获取同步策略","deprecated":null,"version":null,"sidebarTitle":"获取同步策略","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/zh/api-reference/sources/get-sync-policy"},{"title":"更新同步策略","deprecated":null,"version":null,"sidebarTitle":"更新同步策略","openapi":"/zh/api-reference/openapi_service.json put /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/zh/api-reference/sources/update-sync-policy"}]},{"group":"数据源同步与导入","pages":[{"title":"同步数据源","deprecated":null,"version":null,"sidebarTitle":"同步数据源","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync","href":"/zh/api-reference/source-syncs-and-imports/sync-source"},{"title":"预览网站抓取","deprecated":null,"version":null,"sidebarTitle":"预览网站抓取","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-preview","href":"/zh/api-reference/source-syncs-and-imports/preview-website-crawl"},{"title":"获取抓取预览页面列表","deprecated":null,"version":null,"sidebarTitle":"获取抓取预览页面列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/pages","href":"/zh/api-reference/source-syncs-and-imports/list-crawl-preview-pages"},{"title":"导入所选页面","deprecated":null,"version":null,"sidebarTitle":"导入所选页面","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/selection","href":"/zh/api-reference/source-syncs-and-imports/import-selected-pages"},{"title":"导入网站页面","deprecated":null,"version":null,"sidebarTitle":"导入网站页面","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import","href":"/zh/api-reference/source-syncs-and-imports/import-website-pages"},{"title":"导入数据源条目","deprecated":null,"version":null,"sidebarTitle":"导入数据源条目","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports","href":"/zh/api-reference/source-syncs-and-imports/import-source-items"},{"title":"获取数据源运行列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源运行列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows","href":"/zh/api-reference/source-syncs-and-imports/list-source-runs"},{"title":"获取数据源运行","deprecated":null,"version":null,"sidebarTitle":"获取数据源运行","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}","href":"/zh/api-reference/source-syncs-and-imports/get-source-run"},{"title":"取消数据源运行","deprecated":null,"version":null,"sidebarTitle":"取消数据源运行","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/cancel","href":"/zh/api-reference/source-syncs-and-imports/cancel-source-run"},{"title":"重试数据源运行","deprecated":null,"version":null,"sidebarTitle":"重试数据源运行","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry","href":"/zh/api-reference/source-syncs-and-imports/retry-source-run"}]},{"group":"设置","pages":[{"title":"获取知识库设置","deprecated":null,"version":null,"sidebarTitle":"获取知识库设置","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/zh/api-reference/settings/get-knowledge-base-settings"},{"title":"更新知识库设置","deprecated":null,"version":null,"sidebarTitle":"更新知识库设置","openapi":"/zh/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/zh/api-reference/settings/update-knowledge-base-settings"},{"title":"获取设置迁移","deprecated":null,"version":null,"sidebarTitle":"获取设置迁移","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_id}","href":"/zh/api-reference/settings/get-settings-migration"}]}]},{"group":"经典知识库","pages":[{"group":"知识库","pages":[{"title":"创建空知识库","deprecated":null,"version":null,"sidebarTitle":"创建空知识库","openapi":"/zh/api-reference/openapi_service.json post /datasets","href":"/zh/api-reference/knowledge-bases/create-an-empty-knowledge-base"},{"title":"获取知识库列表","deprecated":null,"version":null,"sidebarTitle":"获取知识库列表","openapi":"/zh/api-reference/openapi_service.json get /datasets","href":"/zh/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"获取知识库详情","deprecated":null,"version":null,"sidebarTitle":"获取知识库详情","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}","href":"/zh/api-reference/knowledge-bases/get-knowledge-base"},{"title":"更新知识库","deprecated":null,"version":null,"sidebarTitle":"更新知识库","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}","href":"/zh/api-reference/knowledge-bases/update-knowledge-base"},{"title":"删除知识库","deprecated":null,"version":null,"sidebarTitle":"删除知识库","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}","href":"/zh/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"从知识库检索分段 / 测试检索","deprecated":null,"version":null,"sidebarTitle":"从知识库检索分段 / 测试检索","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/zh/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"文档","pages":[{"title":"从文本创建文档","deprecated":null,"version":null,"sidebarTitle":"从文本创建文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/zh/api-reference/documents/create-document-by-text"},{"title":"从文件创建文档","deprecated":null,"version":null,"sidebarTitle":"从文件创建文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/zh/api-reference/documents/create-document-by-file"},{"title":"获取知识库的文档列表","deprecated":null,"version":null,"sidebarTitle":"获取知识库的文档列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents","href":"/zh/api-reference/documents/list-documents"},{"title":"获取文档详情","deprecated":null,"version":null,"sidebarTitle":"获取文档详情","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/zh/api-reference/documents/get-document"},{"title":"删除文档","deprecated":null,"version":null,"sidebarTitle":"删除文档","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/zh/api-reference/documents/delete-document"},{"title":"更新文档","deprecated":null,"version":null,"sidebarTitle":"更新文档","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/zh/api-reference/documents/update-document"},{"title":"下载文档","deprecated":null,"version":null,"sidebarTitle":"下载文档","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/zh/api-reference/documents/download-document"},{"title":"获取文档嵌入状态(进度)","deprecated":null,"version":null,"sidebarTitle":"获取文档嵌入状态(进度)","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/zh/api-reference/documents/get-document-indexing-status"},{"title":"用文本更新文档","deprecated":null,"version":null,"sidebarTitle":"用文本更新文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/zh/api-reference/documents/update-document-by-text"},{"title":"用文件更新文档","deprecated":true,"version":null,"sidebarTitle":"用文件更新文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/zh/api-reference/documents/update-document-by-file"},{"title":"批量下载文档(ZIP)","deprecated":null,"version":null,"sidebarTitle":"批量下载文档(ZIP)","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/zh/api-reference/documents/download-documents-as-zip"},{"title":"批量更新文档状态","deprecated":null,"version":null,"sidebarTitle":"批量更新文档状态","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/zh/api-reference/documents/update-document-status-in-batch"}]},{"group":"分段","pages":[{"title":"向文档添加分段","deprecated":null,"version":null,"sidebarTitle":"向文档添加分段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/zh/api-reference/chunks/create-chunks"},{"title":"从文档获取分段","deprecated":null,"version":null,"sidebarTitle":"从文档获取分段","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/zh/api-reference/chunks/list-chunks"},{"title":"获取文档中的分段详情","deprecated":null,"version":null,"sidebarTitle":"获取文档中的分段详情","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/zh/api-reference/chunks/get-chunk"},{"title":"更新文档中的分段","deprecated":null,"version":null,"sidebarTitle":"更新文档中的分段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/zh/api-reference/chunks/update-chunk"},{"title":"删除文档中的分段","deprecated":null,"version":null,"sidebarTitle":"删除文档中的分段","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/zh/api-reference/chunks/delete-chunk"},{"title":"创建子分段","deprecated":null,"version":null,"sidebarTitle":"创建子分段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/zh/api-reference/chunks/create-child-chunk"},{"title":"获取子分段","deprecated":null,"version":null,"sidebarTitle":"获取子分段","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/zh/api-reference/chunks/list-child-chunks"},{"title":"更新子分段","deprecated":null,"version":null,"sidebarTitle":"更新子分段","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/zh/api-reference/chunks/update-child-chunk"},{"title":"删除子分段","deprecated":null,"version":null,"sidebarTitle":"删除子分段","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/zh/api-reference/chunks/delete-child-chunk"}]},{"group":"元数据","pages":[{"title":"创建元数据字段","deprecated":null,"version":null,"sidebarTitle":"创建元数据字段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/zh/api-reference/metadata/create-metadata-field"},{"title":"获取元数据字段列表","deprecated":null,"version":null,"sidebarTitle":"获取元数据字段列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/zh/api-reference/metadata/list-metadata-fields"},{"title":"更新元数据字段","deprecated":null,"version":null,"sidebarTitle":"更新元数据字段","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/zh/api-reference/metadata/update-metadata-field"},{"title":"删除元数据字段","deprecated":null,"version":null,"sidebarTitle":"删除元数据字段","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/zh/api-reference/metadata/delete-metadata-field"},{"title":"获取内置元数据字段","deprecated":null,"version":null,"sidebarTitle":"获取内置元数据字段","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/zh/api-reference/metadata/get-built-in-metadata-fields"},{"title":"更新内置元数据字段","deprecated":null,"version":null,"sidebarTitle":"更新内置元数据字段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/zh/api-reference/metadata/update-built-in-metadata-field"},{"title":"批量更新文档元数据","deprecated":null,"version":null,"sidebarTitle":"批量更新文档元数据","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/zh/api-reference/metadata/update-document-metadata-in-batch"}]},{"group":"标签","pages":[{"title":"创建知识库标签","deprecated":null,"version":null,"sidebarTitle":"创建知识库标签","openapi":"/zh/api-reference/openapi_service.json post /datasets/tags","href":"/zh/api-reference/tags/create-knowledge-tag"},{"title":"获取知识库标签列表","deprecated":null,"version":null,"sidebarTitle":"获取知识库标签列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/tags","href":"/zh/api-reference/tags/list-knowledge-tags"},{"title":"修改知识库标签","deprecated":null,"version":null,"sidebarTitle":"修改知识库标签","openapi":"/zh/api-reference/openapi_service.json patch /datasets/tags","href":"/zh/api-reference/tags/update-knowledge-tag"},{"title":"删除知识库标签","deprecated":null,"version":null,"sidebarTitle":"删除知识库标签","openapi":"/zh/api-reference/openapi_service.json delete /datasets/tags","href":"/zh/api-reference/tags/delete-knowledge-tag"},{"title":"绑定标签到知识库","deprecated":null,"version":null,"sidebarTitle":"绑定标签到知识库","openapi":"/zh/api-reference/openapi_service.json post /datasets/tags/binding","href":"/zh/api-reference/tags/create-tag-binding"},{"title":"解除标签与知识库的绑定","deprecated":null,"version":null,"sidebarTitle":"解除标签与知识库的绑定","openapi":"/zh/api-reference/openapi_service.json post /datasets/tags/unbinding","href":"/zh/api-reference/tags/delete-tag-binding"},{"title":"获取知识库绑定的标签","deprecated":null,"version":null,"sidebarTitle":"获取知识库绑定的标签","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/tags","href":"/zh/api-reference/tags/get-knowledge-base-tags"}]},{"group":"模型","pages":[{"title":"获取可用模型","deprecated":null,"version":null,"sidebarTitle":"获取可用模型","openapi":"/zh/api-reference/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/zh/api-reference/models/get-available-models"}]},{"group":"知识流水线","pages":[{"title":"上传流水线文件","deprecated":null,"version":null,"sidebarTitle":"上传流水线文件","openapi":"/zh/api-reference/openapi_service.json post /datasets/pipeline/file-upload","href":"/zh/api-reference/knowledge-pipeline/upload-pipeline-file"},{"title":"获取数据源插件列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源插件列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/zh/api-reference/knowledge-pipeline/list-datasource-plugins"},{"title":"执行数据源节点","deprecated":null,"version":null,"sidebarTitle":"执行数据源节点","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/zh/api-reference/knowledge-pipeline/run-datasource-node"},{"title":"运行流水线","deprecated":null,"version":null,"sidebarTitle":"运行流水线","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/zh/api-reference/knowledge-pipeline/run-pipeline"}]}]}]}]},{"item":"CLI","icon":"terminal","groups":[{"group":" ","expanded":true,"pages":[{"title":"概述","href":"/zh/cli/overview"},{"title":"快速开始","href":"/zh/cli/get-started"},{"title":"查找并运行命令","href":"/zh/cli/find-and-run-commands"},{"group":"应用操作","expanded":true,"pages":[{"title":"构建应用","sidebarTitle":"构建","href":"/zh/cli/build-apps"},{"title":"运行应用","sidebarTitle":"运行","href":"/zh/cli/run-apps"},{"title":"通过 DSL 文件创建和更新应用","sidebarTitle":"通过 DSL 创建或更新","href":"/zh/cli/create-and-update-apps-from-dsl-files"},{"title":"在 CI 和自动化中使用 `difyctl`","sidebarTitle":"CI 和自动化","href":"/zh/cli/scripts-and-ci"}]},{"group":"管理 difyctl","expanded":true,"pages":[{"title":"管理登录","sidebarTitle":"登录与会话","href":"/zh/cli/manage-sign-in"},{"title":"更新或卸载 difyctl","sidebarTitle":"更新或卸载","href":"/zh/cli/update-or-uninstall"},{"title":"Dify 1.18.0 升级指南","sidebarTitle":"1.18.0 升级指南","href":"/zh/cli/upgrade-across-1-18"}]},{"group":"参考","expanded":true,"pages":[{"title":"命令索引","href":"/zh/cli/reference/command-index"},{"title":"结果、错误与退出码","sidebarTitle":"结果与错误","href":"/zh/cli/reference/results-errors-and-exit-codes"},{"title":"配置","href":"/zh/cli/reference/configuration"}]}]}]},{"item":"插件开发","icon":"code-pull-request","groups":[{"group":"快速开始","icon":"rocket","pages":[{"title":"Dify 插件","href":"/zh/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"选择插件类型","href":"/zh/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify 插件 CLI","href":"/zh/develop-plugin/getting-started/cli"}]},{"group":"特性与规范","icon":"list-check","pages":[{"group":"插件类型","pages":[{"title":"通用规范","href":"/zh/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"模型规范","href":"/zh/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"模型 API 接口","href":"/zh/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"持久化存储","href":"/zh/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"工具返回","href":"/zh/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/zh/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"多语言 README","href":"/zh/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"插件调试","href":"/zh/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"输出插件日志","href":"/zh/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"高级开发","pages":[{"group":"反向调用","pages":[{"title":"Bundle 插件包","href":"/zh/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Dify 服务的反向调用","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"应用","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"反向调用模型","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"工具","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"集成自定义模型","href":"/zh/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"节点","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"开发指南与示例","icon":"code","pages":[{"title":"速查表","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"按插件类型","pages":[{"title":"工具插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"模型供应商插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"Agent 策略插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"数据源插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"触发器插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint 插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"完整示例","pages":[{"title":"Flomo 工具(10分钟)","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdown 导出器","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"多模态工具","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"发布","icon":"upload","pages":[{"title":"发布插件","href":"/zh/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"标准","pages":[{"title":"插件开发指南","href":"/zh/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"隐私政策指南","href":"/zh/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"发布插件到市场","sidebarTitle":"市场","href":"/zh/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub 仓库","pages":[{"title":"发布到个人 GitHub 仓库","href":"/zh/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"本地文件","pages":[{"title":"打包为本地文件并分享","href":"/zh/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"为第三方签名验证签署插件","href":"/zh/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"常见问题","sidebarTitle":"常见问题","href":"/zh/develop-plugin/publishing/faq/faq"}]}]}]}]},{"product":"自部署","icon":"server","tabs":[{"tab":"部署","icon":"server","pages":[{"title":"部署 Dify","sidebarTitle":"概览","mode":"frame","href":"/zh/self-host/deploy/overview"},{"group":"快速开始","icon":"rocket","pages":[{"title":"使用 Docker Compose 部署 Dify","sidebarTitle":"Docker Compose","href":"/zh/self-host/deploy/quick-start/docker-compose"},{"title":"常见问题","href":"/zh/self-host/deploy/quick-start/faqs"}]},{"group":"进阶部署","icon":"server","pages":[{"title":"使用源代码本地启动","href":"/zh/self-host/deploy/advanced-deployments/local-source-code"},{"title":"单独启动前端 Docker 容器","href":"/zh/self-host/deploy/advanced-deployments/start-the-frontend-docker-container"}]},{"group":"配置","icon":"gear","pages":[{"title":"环境变量","href":"/zh/self-host/deploy/configuration/environments"}]},{"group":"平台指南","icon":"map","pages":[{"title":"使用 aaPanel 部署","href":"/zh/self-host/deploy/platform-guides/bt-panel"},{"title":"AWS 上的 Dify Premium","href":"/zh/self-host/deploy/platform-guides/dify-premium"}]},{"group":"故障排除","icon":"wrench","pages":[{"title":"常见问题","href":"/zh/self-host/deploy/troubleshooting/common-issues"},{"title":"Docker 问题","href":"/zh/self-host/deploy/troubleshooting/docker-issues"},{"title":"第三方集成","href":"/zh/self-host/deploy/troubleshooting/integrations"},{"title":"存储与迁移","href":"/zh/self-host/deploy/troubleshooting/storage-and-migration"},{"title":"Weaviate 迁移指南:升级到客户端 v4 和服务器 1.27+","href":"/zh/self-host/deploy/troubleshooting/weaviate-v4-migration"},{"title":"Weaviate 服务器升级路径","href":"/zh/self-host/deploy/troubleshooting/weaviate-server-migration-path"}]}]},{"tab":"使用","icon":"book-open","pages":[{"title":"使用 Dify","sidebarTitle":"概览","mode":"frame","href":"/zh/self-host/use-dify/getting-started/introduction"},{"group":"编排","icon":"hammer","pages":[{"group":"Workflow 与 Chatflow","expanded":false,"pages":[{"title":"Workflow 与 Chatflow","sidebarTitle":"概述","href":"/zh/self-host/use-dify/build/workflow-chatflow"},{"title":"编排逻辑","href":"/zh/self-host/use-dify/build/orchestrate-node"},{"group":"节点","expanded":false,"pages":[{"group":"开始","root":{"title":"开始节点","href":"/zh/self-host/use-dify/nodes/start"},"pages":[{"title":"用户输入","href":"/zh/self-host/use-dify/nodes/user-input"},{"group":"触发器","root":{"title":"触发器","sidebarTitle":"概述","href":"/zh/self-host/use-dify/nodes/trigger/overview"},"pages":[{"title":"定时触发器","href":"/zh/self-host/use-dify/nodes/trigger/schedule-trigger"},{"title":"集成触发器","href":"/zh/self-host/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook 触发器","href":"/zh/self-host/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"大语言模型","href":"/zh/self-host/use-dify/nodes/llm"},{"title":"知识检索","href":"/zh/self-host/use-dify/nodes/knowledge-retrieval"},{"title":"直接回复","href":"/zh/self-host/use-dify/nodes/answer"},{"title":"输出","href":"/zh/self-host/use-dify/nodes/output"},{"title":"Agent","href":"/zh/self-host/use-dify/nodes/agent"},{"title":"问题分类器","href":"/zh/self-host/use-dify/nodes/question-classifier"},{"title":"If-Else","href":"/zh/self-host/use-dify/nodes/ifelse"},{"group":"人工介入","root":{"title":"人工介入","href":"/zh/self-host/use-dify/nodes/human-input"},"expanded":false,"pages":[]},{"title":"迭代","href":"/zh/self-host/use-dify/nodes/iteration"},{"title":"循环","href":"/zh/self-host/use-dify/nodes/loop"},{"title":"代码","href":"/zh/self-host/use-dify/nodes/code"},{"title":"模板转换","href":"/zh/self-host/use-dify/nodes/template"},{"title":"变量聚合器","href":"/zh/self-host/use-dify/nodes/variable-aggregator"},{"title":"文档提取器","href":"/zh/self-host/use-dify/nodes/doc-extractor"},{"title":"变量赋值器","href":"/zh/self-host/use-dify/nodes/variable-assigner"},{"title":"参数提取器","href":"/zh/self-host/use-dify/nodes/parameter-extractor"},{"title":"HTTP 请求","href":"/zh/self-host/use-dify/nodes/http-request"},{"title":"列表操作符","href":"/zh/self-host/use-dify/nodes/list-operator"},{"title":"工具节点","sidebarTitle":"工具","href":"/zh/self-host/use-dify/nodes/tools"}]},{"title":"快捷键","href":"/zh/self-host/use-dify/build/shortcut-key"},{"title":"版本控制","href":"/zh/self-host/use-dify/build/version-control"},{"title":"Snippets","href":"/zh/self-host/use-dify/build/snippet"},{"title":"与团队成员协作","sidebarTitle":"协作","href":"/zh/self-host/use-dify/build/workflow-collaboration"},{"group":"调试","expanded":false,"pages":[{"title":"处理错误","href":"/zh/self-host/use-dify/build/predefined-error-handling-logic"},{"title":"单节点","href":"/zh/self-host/use-dify/debug/step-run"},{"title":"变量检查器","href":"/zh/self-host/use-dify/debug/variable-inspect"},{"title":"运行历史","href":"/zh/self-host/use-dify/debug/history-and-logs"},{"title":"错误类型","href":"/zh/self-host/use-dify/debug/error-type"}]}]},{"group":"Agent","tag":"New","expanded":false,"pages":[{"title":"Agent","sidebarTitle":"概述","href":"/zh/self-host/use-dify/build/new-agent/overview"},{"title":"构建 Agent","sidebarTitle":"构建","href":"/zh/self-host/use-dify/build/new-agent/build"}]},{"title":"Skills","sidebarTitle":"Skills","href":"/zh/self-host/use-dify/build/skills"},{"group":"基础应用","expanded":false,"pages":[{"title":"Agent","tag":"Legacy","href":"/zh/self-host/use-dify/build/agent"},{"title":"聊天助手","sidebarTitle":"聊天助手","href":"/zh/self-host/use-dify/build/chatbot"},{"title":"文本生成应用","sidebarTitle":"文本生成应用","href":"/zh/self-host/use-dify/build/text-generator"}]},{"title":"应用工具箱","href":"/zh/self-host/use-dify/build/additional-features"},{"title":"全局搜索","href":"/zh/self-host/use-dify/build/goto-anything"}]},{"group":"发布","icon":"paper-plane","expanded":false,"pages":[{"title":"分享你的 AI 应用","href":"/zh/self-host/use-dify/publish/README"},{"group":"Web App","pages":[{"title":"Workflow Web 应用","href":"/zh/self-host/use-dify/publish/webapp/workflow-webapp"},{"title":"聊天 Web App","href":"/zh/self-host/use-dify/publish/webapp/chatflow-webapp"},{"title":"Web App 设置","href":"/zh/self-host/use-dify/publish/webapp/web-app-settings"},{"title":"嵌入 Web 应用","sidebarTitle":"嵌入","href":"/zh/self-host/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP 服务器","href":"/zh/self-host/use-dify/publish/publish-mcp"},{"title":"发布应用到市场","sidebarTitle":"市场","href":"/zh/self-host/use-dify/publish/publish-to-marketplace"}]},{"group":"监控","icon":"chart-line","expanded":false,"pages":[{"title":"仪表盘","href":"/zh/self-host/use-dify/monitor/analysis"},{"title":"日志","href":"/zh/self-host/use-dify/monitor/logs"},{"title":"标注系统","href":"/zh/self-host/use-dify/monitor/annotation-reply"},{"group":"集成","pages":[{"title":"集成 LangSmith","href":"/zh/self-host/use-dify/monitor/integrations/integrate-langsmith"},{"title":"集成 Langfuse","href":"/zh/self-host/use-dify/monitor/integrations/integrate-langfuse"},{"title":"集成 Opik","href":"/zh/self-host/use-dify/monitor/integrations/integrate-opik"},{"title":"集成 W\u0026B Weave","href":"/zh/self-host/use-dify/monitor/integrations/integrate-weave"},{"title":"集成 Arize","href":"/zh/self-host/use-dify/monitor/integrations/integrate-arize"},{"title":"集成 Phoenix","href":"/zh/self-host/use-dify/monitor/integrations/integrate-phoenix"},{"title":"集成阿里云云监控","href":"/zh/self-host/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"知识库","icon":"book","expanded":false,"pages":[{"title":"知识库","sidebarTitle":"概述","href":"/zh/self-host/use-dify/knowledge/readme"},{"group":"创建","pages":[{"group":"创建即用型知识库","pages":[{"title":"创建即用型知识库","sidebarTitle":"概述","href":"/zh/self-host/use-dify/knowledge/create-knowledge/introduction"},{"group":"导入数据","pages":[{"title":"上传本地文件","href":"/zh/self-host/use-dify/knowledge/create-knowledge/import-text-data/readme"},{"title":"从 Notion 导入数据","href":"/zh/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion"},{"title":"从网页导入数据","href":"/zh/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website"}]},{"title":"指定分段设置","sidebarTitle":"设置分段","href":"/zh/self-host/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text"},{"title":"指定索引方式与检索设置","sidebarTitle":"设置索引与检索","href":"/zh/self-host/use-dify/knowledge/create-knowledge/setting-indexing-methods"}]},{"group":"构建自定义知识库","pages":[{"title":"构建自定义知识库","sidebarTitle":"概述","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/readme"},{"title":"步骤一:创建知识流水线","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline"},{"title":"步骤二:编排知识流水线","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration"},{"title":"步骤三:发布知识流水线","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline"},{"title":"步骤四:上传文件","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/upload-files"},{"title":"步骤五:管理和使用知识库","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base"},{"title":"数据源授权","href":"/zh/self-host/use-dify/knowledge/knowledge-pipeline/authorize-data-source"}]},{"group":"连接外部知识库","pages":[{"title":"连接外部知识库","sidebarTitle":"概述","href":"/zh/self-host/use-dify/knowledge/connect-external-knowledge-base"},{"title":"外部知识库 API","href":"/zh/self-host/use-dify/knowledge/external-knowledge-api"}]}]},{"group":"管理","pages":[{"title":"维护知识库内容","sidebarTitle":"文档与分段","href":"/zh/self-host/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents"},{"title":"管理文档元数据","sidebarTitle":"元数据","href":"/zh/self-host/use-dify/knowledge/metadata"},{"title":"调整知识库设置","sidebarTitle":"设置","href":"/zh/self-host/use-dify/knowledge/manage-knowledge/introduction"}]},{"title":"测试检索","sidebarTitle":"调试","href":"/zh/self-host/use-dify/knowledge/test-retrieval"},{"title":"在应用内集成知识库","sidebarTitle":"在应用内集成","href":"/zh/self-host/use-dify/knowledge/integrate-knowledge-within-application"}]},{"group":"集成","icon":"plug","expanded":false,"pages":[{"title":"集成","sidebarTitle":"概览","href":"/zh/self-host/use-dify/workspace/plugins"},{"title":"模型供应商","href":"/zh/self-host/use-dify/workspace/model-providers"},{"title":"Dify 工具","sidebarTitle":"工具","href":"/zh/self-host/use-dify/workspace/tools"},{"group":"自定义端点","pages":[{"title":"自定义端点","sidebarTitle":"概述","href":"/zh/self-host/use-dify/workspace/api-extension/api-extension"},{"title":"外部数据工具","href":"/zh/self-host/use-dify/workspace/api-extension/external-data-tool-api-extension"},{"title":"敏感内容审查","href":"/zh/self-host/use-dify/workspace/api-extension/moderation-api-extension"},{"title":"使用 Cloudflare Workers 部署自定义端点","href":"/zh/self-host/use-dify/workspace/api-extension/cloudflare-worker"}]}]},{"group":"工作空间","icon":"briefcase","expanded":false,"pages":[{"title":"工作空间","sidebarTitle":"概述","href":"/zh/self-host/use-dify/workspace/readme"},{"title":"导出和导入应用","sidebarTitle":"导出和导入","href":"/zh/self-host/use-dify/workspace/export-import-apps"},{"title":"管理成员","href":"/zh/self-host/use-dify/workspace/team-members-management"},{"title":"个人设置","href":"/zh/self-host/use-dify/workspace/personal-account-management"}]}]},{"tab":"学习","icon":"graduation-cap","pages":[{"title":"核心概念","href":"/zh/learn/key-concepts"},{"group":"教程","pages":[{"title":"30 分钟快速入门","href":"/zh/quick-start"},{"group":"工作流 101","pages":[{"title":"第 1 课:什么是工作流","href":"/zh/learn/tutorials/workflow-101/lesson-01"},{"title":"第 2 课:流程的头和尾(开始与输出节点)","sidebarTitle":"第 2 课:流程的头和尾","href":"/zh/learn/tutorials/workflow-101/lesson-02"},{"title":"第 3 课:工作流的大脑(LLM 节点)","sidebarTitle":"第 3 课:工作流的大脑","href":"/zh/learn/tutorials/workflow-101/lesson-03"},{"title":"第 4 课:小抄(知识检索)","sidebarTitle":"第 4 课:小抄","href":"/zh/learn/tutorials/workflow-101/lesson-04"},{"title":"第 5 课:工作流的岔路口(分类与执行)","sidebarTitle":"第 5 课:工作流的岔路口","href":"/zh/learn/tutorials/workflow-101/lesson-05"},{"title":"第 6 课:处理多个任务(参数提取 \u0026 迭代)","sidebarTitle":"第 6 课:处理多个任务","href":"/zh/learn/tutorials/workflow-101/lesson-06"},{"title":"第 7 课:增强工作流(工具)","sidebarTitle":"第 7 课:增强工作流","href":"/zh/learn/tutorials/workflow-101/lesson-07"},{"title":"第 8 课:Agent 节点","sidebarTitle":"第 8 课:Agent 节点","href":"/zh/learn/tutorials/workflow-101/lesson-08"},{"title":"第 9 课:排版设计师(模板)","sidebarTitle":"第 9 课:排版设计师","href":"/zh/learn/tutorials/workflow-101/lesson-09"},{"title":"第 10 课:发布和监控你的 AI 应用","sidebarTitle":"第 10 课:发布和监控","href":"/zh/learn/tutorials/workflow-101/lesson-10"}]},{"title":"简单聊天机器人","href":"/zh/learn/tutorials/simple-chatbot"},{"title":"ChatFlow 实战:搭建 Twitter 账号分析助手","href":"/zh/learn/tutorials/twitter-chatflow"},{"title":"使用知识库搭建智能客服机器人","href":"/zh/learn/tutorials/customer-service-bot"},{"title":"如何搭建 AI 图片生成应用","href":"/zh/learn/tutorials/build-ai-image-generation-app"},{"title":"使用文件上传搭建文章理解助手","href":"/zh/learn/tutorials/article-reader"}]}]},{"tab":"开发者资源","icon":"code","menu":[{"item":"API","icon":"code","groups":[{"group":"指南","pages":[{"title":"Dify API 快速开始","sidebarTitle":"快速开始","href":"/zh/api-reference/guides/get-started"},{"group":"API 概览","expanded":true,"pages":[{"title":"Chatflow 应用 API","sidebarTitle":"Chatflow","href":"/zh/api-reference/guides/chatflow"},{"title":"Workflow 应用 API","sidebarTitle":"Workflow","href":"/zh/api-reference/guides/workflow"},{"title":"Agent API","sidebarTitle":"Agent","tag":"New","href":"/zh/api-reference/guides/agent"},{"group":"知识库","root":{"title":"知识库 API","sidebarTitle":"知识库","href":"/zh/api-reference/guides/knowledge-base-api"},"pages":[{"title":"Agent 知识库 API","tag":"Cloud","sidebarTitle":"Agent 知识库","href":"/zh/api-reference/guides/knowledge-base"},{"title":"经典知识库 API","sidebarTitle":"经典知识库","href":"/zh/api-reference/guides/knowledge"}]},{"title":"对话型应用 API","sidebarTitle":"Chatbot 和旧版 Agent","href":"/zh/api-reference/guides/chat"},{"title":"文本生成应用 API","sidebarTitle":"文本生成应用","href":"/zh/api-reference/guides/completion"}]},{"title":"处理流式响应","sidebarTitle":"SSE 流式传输","href":"/zh/api-reference/guides/streaming"},{"title":"人工介入 API 集成流程","sidebarTitle":"人工介入流程","href":"/zh/api-reference/guides/human-input-flow"},{"title":"终端用户身份","sidebarTitle":"终端用户身份","href":"/zh/api-reference/guides/end-user-identity"},{"title":"处理错误与速率限制","sidebarTitle":"错误与速率限制","href":"/zh/api-reference/guides/errors"}]},{"group":"应用 API","pages":[{"group":"对话消息","pages":[{"title":"发送对话消息","deprecated":null,"version":null,"sidebarTitle":"发送对话消息","openapi":"/zh/api-reference/openapi_service.json post /chat-messages","href":"/zh/api-reference/chat-messages/send-chat-message"},{"title":"停止响应","deprecated":null,"version":null,"sidebarTitle":"停止响应","openapi":"/zh/api-reference/openapi_service.json post /chat-messages/{task_id}/stop","href":"/zh/api-reference/chat-messages/stop-chat-message-generation"},{"title":"获取下一轮建议问题列表","deprecated":null,"version":null,"sidebarTitle":"获取下一轮建议问题列表","openapi":"/zh/api-reference/openapi_service.json get /messages/{message_id}/suggested","href":"/zh/api-reference/chat-messages/get-next-suggested-questions"}]},{"group":"文本生成消息","pages":[{"title":"发送消息","deprecated":null,"version":null,"sidebarTitle":"发送消息","openapi":"/zh/api-reference/openapi_service.json post /completion-messages","href":"/zh/api-reference/completion-messages/send-completion-message"},{"title":"停止响应","deprecated":null,"version":null,"sidebarTitle":"停止响应","openapi":"/zh/api-reference/openapi_service.json post /completion-messages/{task_id}/stop","href":"/zh/api-reference/completion-messages/stop-completion-message-generation"}]},{"group":"工作流运行","pages":[{"title":"执行工作流","deprecated":null,"version":null,"sidebarTitle":"执行工作流","openapi":"/zh/api-reference/openapi_service.json post /workflows/run","href":"/zh/api-reference/workflow-runs/run-workflow"},{"title":"按 ID 执行工作流","deprecated":null,"version":null,"sidebarTitle":"按 ID 执行工作流","openapi":"/zh/api-reference/openapi_service.json post /workflows/{workflow_id}/run","href":"/zh/api-reference/workflow-runs/run-workflow-by-id"},{"title":"停止工作流任务","deprecated":null,"version":null,"sidebarTitle":"停止工作流任务","openapi":"/zh/api-reference/openapi_service.json post /workflows/tasks/{task_id}/stop","href":"/zh/api-reference/workflow-runs/stop-workflow-task"},{"title":"获取工作流执行情况","deprecated":null,"version":null,"sidebarTitle":"获取工作流执行情况","openapi":"/zh/api-reference/openapi_service.json get /workflows/run/{workflow_run_id}","href":"/zh/api-reference/workflow-runs/get-workflow-run-detail"},{"title":"获取工作流日志","deprecated":null,"version":null,"sidebarTitle":"获取工作流日志","openapi":"/zh/api-reference/openapi_service.json get /workflows/logs","href":"/zh/api-reference/workflow-runs/list-workflow-logs"},{"title":"流式获取工作流事件","deprecated":null,"version":null,"sidebarTitle":"流式获取工作流事件","openapi":"/zh/api-reference/openapi_service.json get /workflow/{workflow_run_id}/events","href":"/zh/api-reference/workflow-runs/stream-workflow-events"}]},{"group":"会话管理","pages":[{"title":"获取会话列表","deprecated":null,"version":null,"sidebarTitle":"获取会话列表","openapi":"/zh/api-reference/openapi_service.json get /conversations","href":"/zh/api-reference/conversations/list-conversations"},{"title":"获取会话历史消息","deprecated":null,"version":null,"sidebarTitle":"获取会话历史消息","openapi":"/zh/api-reference/openapi_service.json get /messages","href":"/zh/api-reference/conversations/list-conversation-messages"},{"title":"获取会话变量","deprecated":null,"version":null,"sidebarTitle":"获取会话变量","openapi":"/zh/api-reference/openapi_service.json get /conversations/{conversation_id}/variables","href":"/zh/api-reference/conversations/list-conversation-variables"},{"title":"重命名会话","deprecated":null,"version":null,"sidebarTitle":"重命名会话","openapi":"/zh/api-reference/openapi_service.json post /conversations/{conversation_id}/name","href":"/zh/api-reference/conversations/rename-conversation"},{"title":"更新会话变量","deprecated":null,"version":null,"sidebarTitle":"更新会话变量","openapi":"/zh/api-reference/openapi_service.json put /conversations/{conversation_id}/variables/{variable_id}","href":"/zh/api-reference/conversations/update-conversation-variable"},{"title":"删除会话","deprecated":null,"version":null,"sidebarTitle":"删除会话","openapi":"/zh/api-reference/openapi_service.json delete /conversations/{conversation_id}","href":"/zh/api-reference/conversations/delete-conversation"}]},{"group":"文件操作","pages":[{"title":"上传文件","deprecated":null,"version":null,"sidebarTitle":"上传文件","openapi":"/zh/api-reference/openapi_service.json post /files/upload","href":"/zh/api-reference/files/upload-file"},{"title":"下载文件","deprecated":null,"version":null,"sidebarTitle":"下载文件","openapi":"/zh/api-reference/openapi_service.json get /files/{file_id}/preview","href":"/zh/api-reference/files/download-file"}]},{"group":"语音与文字转换","pages":[{"title":"语音转文字","deprecated":null,"version":null,"sidebarTitle":"语音转文字","openapi":"/zh/api-reference/openapi_service.json post /audio-to-text","href":"/zh/api-reference/audio/convert-audio-to-text"},{"title":"文字转语音","deprecated":null,"version":null,"sidebarTitle":"文字转语音","openapi":"/zh/api-reference/openapi_service.json post /text-to-audio","href":"/zh/api-reference/audio/convert-text-to-audio"}]},{"group":"应用配置","pages":[{"title":"获取应用基本信息","deprecated":null,"version":null,"sidebarTitle":"获取应用基本信息","openapi":"/zh/api-reference/openapi_service.json get /info","href":"/zh/api-reference/applications/get-app-info"},{"title":"获取应用参数","deprecated":null,"version":null,"sidebarTitle":"获取应用参数","openapi":"/zh/api-reference/openapi_service.json get /parameters","href":"/zh/api-reference/applications/get-app-parameters"},{"title":"获取应用元数据","deprecated":null,"version":null,"sidebarTitle":"获取应用元数据","openapi":"/zh/api-reference/openapi_service.json get /meta","href":"/zh/api-reference/applications/get-app-meta"},{"title":"获取应用 WebApp 设置","deprecated":null,"version":null,"sidebarTitle":"获取应用 WebApp 设置","openapi":"/zh/api-reference/openapi_service.json get /site","href":"/zh/api-reference/applications/get-app-webapp-settings"}]},{"group":"消息反馈","pages":[{"title":"提交消息反馈","deprecated":null,"version":null,"sidebarTitle":"提交消息反馈","openapi":"/zh/api-reference/openapi_service.json post /messages/{message_id}/feedbacks","href":"/zh/api-reference/feedback/submit-message-feedback"},{"title":"获取应用的消息反馈","deprecated":null,"version":null,"sidebarTitle":"获取应用的消息反馈","openapi":"/zh/api-reference/openapi_service.json get /app/feedbacks","href":"/zh/api-reference/feedback/list-app-feedbacks"}]},{"group":"标注管理","pages":[{"title":"创建标注","deprecated":null,"version":null,"sidebarTitle":"创建标注","openapi":"/zh/api-reference/openapi_service.json post /apps/annotations","href":"/zh/api-reference/annotations/create-annotation"},{"title":"获取标注列表","deprecated":null,"version":null,"sidebarTitle":"获取标注列表","openapi":"/zh/api-reference/openapi_service.json get /apps/annotations","href":"/zh/api-reference/annotations/list-annotations"},{"title":"更新标注","deprecated":null,"version":null,"sidebarTitle":"更新标注","openapi":"/zh/api-reference/openapi_service.json put /apps/annotations/{annotation_id}","href":"/zh/api-reference/annotations/update-annotation"},{"title":"删除标注","deprecated":null,"version":null,"sidebarTitle":"删除标注","openapi":"/zh/api-reference/openapi_service.json delete /apps/annotations/{annotation_id}","href":"/zh/api-reference/annotations/delete-annotation"},{"title":"配置标注回复","deprecated":null,"version":null,"sidebarTitle":"配置标注回复","openapi":"/zh/api-reference/openapi_service.json post /apps/annotation-reply/{action}","href":"/zh/api-reference/annotations/configure-annotation-reply"},{"title":"查询标注回复配置任务状态","deprecated":null,"version":null,"sidebarTitle":"查询标注回复配置任务状态","openapi":"/zh/api-reference/openapi_service.json get /apps/annotation-reply/{action}/status/{job_id}","href":"/zh/api-reference/annotations/get-annotation-reply-job-status"}]},{"group":"终端用户","pages":[{"title":"获取终端用户信息","deprecated":null,"version":null,"sidebarTitle":"获取终端用户信息","openapi":"/zh/api-reference/openapi_service.json get /end-users/{end_user_id}","href":"/zh/api-reference/end-users/get-end-user-info"}]},{"group":"人工介入","pages":[{"title":"获取人工介入表单","deprecated":null,"version":null,"sidebarTitle":"获取人工介入表单","openapi":"/zh/api-reference/openapi_service.json get /form/human_input/{form_token}","href":"/zh/api-reference/human-input/get-human-input-form"},{"title":"提交人工介入表单","deprecated":null,"version":null,"sidebarTitle":"提交人工介入表单","openapi":"/zh/api-reference/openapi_service.json post /form/human_input/{form_token}","href":"/zh/api-reference/human-input/submit-human-input-form"}]}]},{"group":"知识库 API","pages":[{"group":"Agent 知识库","tag":"Cloud","pages":[{"group":"查询","pages":[{"title":"创建查询令牌","deprecated":null,"version":null,"sidebarTitle":"创建查询令牌","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/queries/admission","href":"/zh/api-reference/queries/create-query-token"},{"title":"运行查询","deprecated":null,"version":null,"sidebarTitle":"运行查询","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/query-stream","href":"/zh/api-reference/queries/run-query"}]},{"group":"查询记录","pages":[{"title":"获取查询记录列表","deprecated":null,"version":null,"sidebarTitle":"获取查询记录列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces","href":"/zh/api-reference/query-records/list-query-records"},{"title":"获取查询记录","deprecated":null,"version":null,"sidebarTitle":"获取查询记录","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}","href":"/zh/api-reference/query-records/get-query-record"},{"title":"获取查询分段列表","deprecated":null,"version":null,"sidebarTitle":"获取查询分段列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/evidence","href":"/zh/api-reference/query-records/list-query-chunks"},{"title":"获取查询冲突列表","deprecated":null,"version":null,"sidebarTitle":"获取查询冲突列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/conflicts","href":"/zh/api-reference/query-records/list-query-conflicts"},{"title":"获取缺失分段列表","deprecated":null,"version":null,"sidebarTitle":"获取缺失分段列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/missing","href":"/zh/api-reference/query-records/list-missing-chunks"}]},{"group":"研究任务","pages":[{"title":"获取研究任务列表","deprecated":null,"version":null,"sidebarTitle":"获取研究任务列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/zh/api-reference/research-tasks/list-research-tasks"},{"title":"创建研究任务","deprecated":null,"version":null,"sidebarTitle":"创建研究任务","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/zh/api-reference/research-tasks/create-research-task"},{"title":"规划研究任务","deprecated":null,"version":null,"sidebarTitle":"规划研究任务","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/plan","href":"/zh/api-reference/research-tasks/plan-research-task"},{"title":"获取研究任务","deprecated":null,"version":null,"sidebarTitle":"获取研究任务","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/zh/api-reference/research-tasks/get-research-task"},{"title":"取消研究任务","deprecated":null,"version":null,"sidebarTitle":"取消研究任务","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/zh/api-reference/research-tasks/cancel-research-task"},{"title":"获取研究任务结果列表","deprecated":null,"version":null,"sidebarTitle":"获取研究任务结果列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials","href":"/zh/api-reference/research-tasks/list-research-task-results"}]},{"group":"文档与分段","pages":[{"title":"获取文档列表","deprecated":null,"version":null,"sidebarTitle":"获取文档列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents","href":"/zh/api-reference/documents-and-chunks/list-documents"},{"title":"获取文档","deprecated":null,"version":null,"sidebarTitle":"获取文档","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/zh/api-reference/documents-and-chunks/get-document"},{"title":"更新文档元数据","deprecated":null,"version":null,"sidebarTitle":"更新文档元数据","openapi":"/zh/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/zh/api-reference/documents-and-chunks/update-document-metadata"},{"title":"按文件获取文档","deprecated":null,"version":null,"sidebarTitle":"按文件获取文档","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/document-references/resolve","href":"/zh/api-reference/documents-and-chunks/get-document-by-file"},{"title":"获取文档文件列表","deprecated":null,"version":null,"sidebarTitle":"获取文档文件列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents","href":"/zh/api-reference/documents-and-chunks/list-document-files"},{"title":"获取文档文件","deprecated":null,"version":null,"sidebarTitle":"获取文档文件","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/zh/api-reference/documents-and-chunks/get-document-file"},{"title":"删除文档文件","deprecated":null,"version":null,"sidebarTitle":"删除文档文件","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/zh/api-reference/documents-and-chunks/delete-document-file"},{"title":"获取文档大纲","deprecated":null,"version":null,"sidebarTitle":"获取文档大纲","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline","href":"/zh/api-reference/documents-and-chunks/get-document-outline"},{"title":"获取文档修订版本列表","deprecated":null,"version":null,"sidebarTitle":"获取文档修订版本列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions","href":"/zh/api-reference/documents-and-chunks/list-document-revisions"},{"title":"获取分段列表","deprecated":null,"version":null,"sidebarTitle":"获取分段列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks","href":"/zh/api-reference/documents-and-chunks/list-chunks"},{"title":"获取分段","deprecated":null,"version":null,"sidebarTitle":"获取分段","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}","href":"/zh/api-reference/documents-and-chunks/get-chunk"},{"title":"批量删除文档文件","deprecated":null,"version":null,"sidebarTitle":"批量删除文档文件","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/bulk","href":"/zh/api-reference/documents-and-chunks/delete-document-files-in-batch"},{"title":"重新索引文档","deprecated":null,"version":null,"sidebarTitle":"重新索引文档","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/documents/reindex","href":"/zh/api-reference/documents-and-chunks/re-index-documents"}]},{"group":"索引任务","pages":[{"title":"获取索引任务","deprecated":null,"version":null,"sidebarTitle":"获取索引任务","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/zh/api-reference/indexing-tasks/get-indexing-task"},{"title":"取消索引任务","deprecated":null,"version":null,"sidebarTitle":"取消索引任务","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/zh/api-reference/indexing-tasks/cancel-indexing-task"},{"title":"重试索引任务","deprecated":null,"version":null,"sidebarTitle":"重试索引任务","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry","href":"/zh/api-reference/indexing-tasks/retry-indexing-task"},{"title":"获取批量任务","deprecated":null,"version":null,"sidebarTitle":"获取批量任务","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id}","href":"/zh/api-reference/indexing-tasks/get-bulk-task"},{"title":"获取文档的索引任务列表","deprecated":null,"version":null,"sidebarTitle":"获取文档的索引任务列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks","href":"/zh/api-reference/indexing-tasks/list-document-indexing-tasks"},{"title":"获取文档的索引任务","deprecated":null,"version":null,"sidebarTitle":"获取文档的索引任务","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}","href":"/zh/api-reference/indexing-tasks/get-document-indexing-task"},{"title":"获取后台任务列表","deprecated":null,"version":null,"sidebarTitle":"获取后台任务列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/background-tasks","href":"/zh/api-reference/indexing-tasks/list-background-tasks"}]},{"group":"删除作业","pages":[{"title":"获取删除作业","deprecated":null,"version":null,"sidebarTitle":"获取删除作业","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}","href":"/zh/api-reference/deletion-jobs/get-deletion-job"},{"title":"获取删除批次","deprecated":null,"version":null,"sidebarTitle":"获取删除批次","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-batches/{deletion_batch_id}","href":"/zh/api-reference/deletion-jobs/get-deletion-batch"}]},{"group":"数据源","pages":[{"title":"获取数据源连接列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源连接列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-connections","href":"/zh/api-reference/sources/list-source-connections"},{"title":"创建数据源","deprecated":null,"version":null,"sidebarTitle":"创建数据源","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/zh/api-reference/sources/create-source"},{"title":"获取数据源列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/zh/api-reference/sources/list-sources"},{"title":"获取数据源","deprecated":null,"version":null,"sidebarTitle":"获取数据源","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/zh/api-reference/sources/get-source"},{"title":"更新数据源","deprecated":null,"version":null,"sidebarTitle":"更新数据源","openapi":"/zh/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/zh/api-reference/sources/update-source"},{"title":"删除数据源","deprecated":null,"version":null,"sidebarTitle":"删除数据源","openapi":"/zh/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/zh/api-reference/sources/delete-source"},{"title":"测试数据源凭据","deprecated":null,"version":null,"sidebarTitle":"测试数据源凭据","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/test","href":"/zh/api-reference/sources/test-source-credentials"},{"title":"获取数据源页面列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源页面列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/pages","href":"/zh/api-reference/sources/list-source-pages"},{"title":"获取数据源文件列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源文件列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files","href":"/zh/api-reference/sources/list-source-files"},{"title":"获取同步策略","deprecated":null,"version":null,"sidebarTitle":"获取同步策略","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/zh/api-reference/sources/get-sync-policy"},{"title":"更新同步策略","deprecated":null,"version":null,"sidebarTitle":"更新同步策略","openapi":"/zh/api-reference/openapi_service.json put /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/zh/api-reference/sources/update-sync-policy"}]},{"group":"数据源同步与导入","pages":[{"title":"同步数据源","deprecated":null,"version":null,"sidebarTitle":"同步数据源","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync","href":"/zh/api-reference/source-syncs-and-imports/sync-source"},{"title":"预览网站抓取","deprecated":null,"version":null,"sidebarTitle":"预览网站抓取","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-preview","href":"/zh/api-reference/source-syncs-and-imports/preview-website-crawl"},{"title":"获取抓取预览页面列表","deprecated":null,"version":null,"sidebarTitle":"获取抓取预览页面列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/pages","href":"/zh/api-reference/source-syncs-and-imports/list-crawl-preview-pages"},{"title":"导入所选页面","deprecated":null,"version":null,"sidebarTitle":"导入所选页面","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/selection","href":"/zh/api-reference/source-syncs-and-imports/import-selected-pages"},{"title":"导入网站页面","deprecated":null,"version":null,"sidebarTitle":"导入网站页面","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import","href":"/zh/api-reference/source-syncs-and-imports/import-website-pages"},{"title":"导入数据源条目","deprecated":null,"version":null,"sidebarTitle":"导入数据源条目","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports","href":"/zh/api-reference/source-syncs-and-imports/import-source-items"},{"title":"获取数据源运行列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源运行列表","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows","href":"/zh/api-reference/source-syncs-and-imports/list-source-runs"},{"title":"获取数据源运行","deprecated":null,"version":null,"sidebarTitle":"获取数据源运行","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}","href":"/zh/api-reference/source-syncs-and-imports/get-source-run"},{"title":"取消数据源运行","deprecated":null,"version":null,"sidebarTitle":"取消数据源运行","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/cancel","href":"/zh/api-reference/source-syncs-and-imports/cancel-source-run"},{"title":"重试数据源运行","deprecated":null,"version":null,"sidebarTitle":"重试数据源运行","openapi":"/zh/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry","href":"/zh/api-reference/source-syncs-and-imports/retry-source-run"}]},{"group":"设置","pages":[{"title":"获取知识库设置","deprecated":null,"version":null,"sidebarTitle":"获取知识库设置","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/zh/api-reference/settings/get-knowledge-base-settings"},{"title":"更新知识库设置","deprecated":null,"version":null,"sidebarTitle":"更新知识库设置","openapi":"/zh/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/zh/api-reference/settings/update-knowledge-base-settings"},{"title":"获取设置迁移","deprecated":null,"version":null,"sidebarTitle":"获取设置迁移","openapi":"/zh/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_id}","href":"/zh/api-reference/settings/get-settings-migration"}]}]},{"group":"经典知识库","pages":[{"group":"知识库","pages":[{"title":"创建空知识库","deprecated":null,"version":null,"sidebarTitle":"创建空知识库","openapi":"/zh/api-reference/openapi_service.json post /datasets","href":"/zh/api-reference/knowledge-bases/create-an-empty-knowledge-base"},{"title":"获取知识库列表","deprecated":null,"version":null,"sidebarTitle":"获取知识库列表","openapi":"/zh/api-reference/openapi_service.json get /datasets","href":"/zh/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"获取知识库详情","deprecated":null,"version":null,"sidebarTitle":"获取知识库详情","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}","href":"/zh/api-reference/knowledge-bases/get-knowledge-base"},{"title":"更新知识库","deprecated":null,"version":null,"sidebarTitle":"更新知识库","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}","href":"/zh/api-reference/knowledge-bases/update-knowledge-base"},{"title":"删除知识库","deprecated":null,"version":null,"sidebarTitle":"删除知识库","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}","href":"/zh/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"从知识库检索分段 / 测试检索","deprecated":null,"version":null,"sidebarTitle":"从知识库检索分段 / 测试检索","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/zh/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"文档","pages":[{"title":"从文本创建文档","deprecated":null,"version":null,"sidebarTitle":"从文本创建文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/zh/api-reference/documents/create-document-by-text"},{"title":"从文件创建文档","deprecated":null,"version":null,"sidebarTitle":"从文件创建文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/zh/api-reference/documents/create-document-by-file"},{"title":"获取知识库的文档列表","deprecated":null,"version":null,"sidebarTitle":"获取知识库的文档列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents","href":"/zh/api-reference/documents/list-documents"},{"title":"获取文档详情","deprecated":null,"version":null,"sidebarTitle":"获取文档详情","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/zh/api-reference/documents/get-document"},{"title":"删除文档","deprecated":null,"version":null,"sidebarTitle":"删除文档","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/zh/api-reference/documents/delete-document"},{"title":"更新文档","deprecated":null,"version":null,"sidebarTitle":"更新文档","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/zh/api-reference/documents/update-document"},{"title":"下载文档","deprecated":null,"version":null,"sidebarTitle":"下载文档","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/zh/api-reference/documents/download-document"},{"title":"获取文档嵌入状态(进度)","deprecated":null,"version":null,"sidebarTitle":"获取文档嵌入状态(进度)","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/zh/api-reference/documents/get-document-indexing-status"},{"title":"用文本更新文档","deprecated":null,"version":null,"sidebarTitle":"用文本更新文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/zh/api-reference/documents/update-document-by-text"},{"title":"用文件更新文档","deprecated":true,"version":null,"sidebarTitle":"用文件更新文档","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/zh/api-reference/documents/update-document-by-file"},{"title":"批量下载文档(ZIP)","deprecated":null,"version":null,"sidebarTitle":"批量下载文档(ZIP)","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/zh/api-reference/documents/download-documents-as-zip"},{"title":"批量更新文档状态","deprecated":null,"version":null,"sidebarTitle":"批量更新文档状态","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/zh/api-reference/documents/update-document-status-in-batch"}]},{"group":"分段","pages":[{"title":"向文档添加分段","deprecated":null,"version":null,"sidebarTitle":"向文档添加分段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/zh/api-reference/chunks/create-chunks"},{"title":"从文档获取分段","deprecated":null,"version":null,"sidebarTitle":"从文档获取分段","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/zh/api-reference/chunks/list-chunks"},{"title":"获取文档中的分段详情","deprecated":null,"version":null,"sidebarTitle":"获取文档中的分段详情","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/zh/api-reference/chunks/get-chunk"},{"title":"更新文档中的分段","deprecated":null,"version":null,"sidebarTitle":"更新文档中的分段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/zh/api-reference/chunks/update-chunk"},{"title":"删除文档中的分段","deprecated":null,"version":null,"sidebarTitle":"删除文档中的分段","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/zh/api-reference/chunks/delete-chunk"},{"title":"创建子分段","deprecated":null,"version":null,"sidebarTitle":"创建子分段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/zh/api-reference/chunks/create-child-chunk"},{"title":"获取子分段","deprecated":null,"version":null,"sidebarTitle":"获取子分段","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/zh/api-reference/chunks/list-child-chunks"},{"title":"更新子分段","deprecated":null,"version":null,"sidebarTitle":"更新子分段","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/zh/api-reference/chunks/update-child-chunk"},{"title":"删除子分段","deprecated":null,"version":null,"sidebarTitle":"删除子分段","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/zh/api-reference/chunks/delete-child-chunk"}]},{"group":"元数据","pages":[{"title":"创建元数据字段","deprecated":null,"version":null,"sidebarTitle":"创建元数据字段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/zh/api-reference/metadata/create-metadata-field"},{"title":"获取元数据字段列表","deprecated":null,"version":null,"sidebarTitle":"获取元数据字段列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/zh/api-reference/metadata/list-metadata-fields"},{"title":"更新元数据字段","deprecated":null,"version":null,"sidebarTitle":"更新元数据字段","openapi":"/zh/api-reference/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/zh/api-reference/metadata/update-metadata-field"},{"title":"删除元数据字段","deprecated":null,"version":null,"sidebarTitle":"删除元数据字段","openapi":"/zh/api-reference/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/zh/api-reference/metadata/delete-metadata-field"},{"title":"获取内置元数据字段","deprecated":null,"version":null,"sidebarTitle":"获取内置元数据字段","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/zh/api-reference/metadata/get-built-in-metadata-fields"},{"title":"更新内置元数据字段","deprecated":null,"version":null,"sidebarTitle":"更新内置元数据字段","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/zh/api-reference/metadata/update-built-in-metadata-field"},{"title":"批量更新文档元数据","deprecated":null,"version":null,"sidebarTitle":"批量更新文档元数据","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/zh/api-reference/metadata/update-document-metadata-in-batch"}]},{"group":"标签","pages":[{"title":"创建知识库标签","deprecated":null,"version":null,"sidebarTitle":"创建知识库标签","openapi":"/zh/api-reference/openapi_service.json post /datasets/tags","href":"/zh/api-reference/tags/create-knowledge-tag"},{"title":"获取知识库标签列表","deprecated":null,"version":null,"sidebarTitle":"获取知识库标签列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/tags","href":"/zh/api-reference/tags/list-knowledge-tags"},{"title":"修改知识库标签","deprecated":null,"version":null,"sidebarTitle":"修改知识库标签","openapi":"/zh/api-reference/openapi_service.json patch /datasets/tags","href":"/zh/api-reference/tags/update-knowledge-tag"},{"title":"删除知识库标签","deprecated":null,"version":null,"sidebarTitle":"删除知识库标签","openapi":"/zh/api-reference/openapi_service.json delete /datasets/tags","href":"/zh/api-reference/tags/delete-knowledge-tag"},{"title":"绑定标签到知识库","deprecated":null,"version":null,"sidebarTitle":"绑定标签到知识库","openapi":"/zh/api-reference/openapi_service.json post /datasets/tags/binding","href":"/zh/api-reference/tags/create-tag-binding"},{"title":"解除标签与知识库的绑定","deprecated":null,"version":null,"sidebarTitle":"解除标签与知识库的绑定","openapi":"/zh/api-reference/openapi_service.json post /datasets/tags/unbinding","href":"/zh/api-reference/tags/delete-tag-binding"},{"title":"获取知识库绑定的标签","deprecated":null,"version":null,"sidebarTitle":"获取知识库绑定的标签","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/tags","href":"/zh/api-reference/tags/get-knowledge-base-tags"}]},{"group":"模型","pages":[{"title":"获取可用模型","deprecated":null,"version":null,"sidebarTitle":"获取可用模型","openapi":"/zh/api-reference/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/zh/api-reference/models/get-available-models"}]},{"group":"知识流水线","pages":[{"title":"上传流水线文件","deprecated":null,"version":null,"sidebarTitle":"上传流水线文件","openapi":"/zh/api-reference/openapi_service.json post /datasets/pipeline/file-upload","href":"/zh/api-reference/knowledge-pipeline/upload-pipeline-file"},{"title":"获取数据源插件列表","deprecated":null,"version":null,"sidebarTitle":"获取数据源插件列表","openapi":"/zh/api-reference/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/zh/api-reference/knowledge-pipeline/list-datasource-plugins"},{"title":"执行数据源节点","deprecated":null,"version":null,"sidebarTitle":"执行数据源节点","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/zh/api-reference/knowledge-pipeline/run-datasource-node"},{"title":"运行流水线","deprecated":null,"version":null,"sidebarTitle":"运行流水线","openapi":"/zh/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/zh/api-reference/knowledge-pipeline/run-pipeline"}]}]}]}]},{"item":"CLI","icon":"terminal","groups":[{"group":" ","expanded":true,"pages":[{"title":"概述","href":"/zh/cli/overview"},{"title":"快速开始","href":"/zh/cli/get-started"},{"title":"查找并运行命令","href":"/zh/cli/find-and-run-commands"},{"group":"应用操作","expanded":true,"pages":[{"title":"构建应用","sidebarTitle":"构建","href":"/zh/cli/build-apps"},{"title":"运行应用","sidebarTitle":"运行","href":"/zh/cli/run-apps"},{"title":"通过 DSL 文件创建和更新应用","sidebarTitle":"通过 DSL 创建或更新","href":"/zh/cli/create-and-update-apps-from-dsl-files"},{"title":"在 CI 和自动化中使用 `difyctl`","sidebarTitle":"CI 和自动化","href":"/zh/cli/scripts-and-ci"}]},{"group":"管理 difyctl","expanded":true,"pages":[{"title":"管理登录","sidebarTitle":"登录与会话","href":"/zh/cli/manage-sign-in"},{"title":"更新或卸载 difyctl","sidebarTitle":"更新或卸载","href":"/zh/cli/update-or-uninstall"},{"title":"Dify 1.18.0 升级指南","sidebarTitle":"1.18.0 升级指南","href":"/zh/cli/upgrade-across-1-18"}]},{"group":"参考","expanded":true,"pages":[{"title":"命令索引","href":"/zh/cli/reference/command-index"},{"title":"结果、错误与退出码","sidebarTitle":"结果与错误","href":"/zh/cli/reference/results-errors-and-exit-codes"},{"title":"配置","href":"/zh/cli/reference/configuration"}]}]}]},{"item":"插件开发","icon":"code-pull-request","groups":[{"group":"快速开始","icon":"rocket","pages":[{"title":"Dify 插件","href":"/zh/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"选择插件类型","href":"/zh/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify 插件 CLI","href":"/zh/develop-plugin/getting-started/cli"}]},{"group":"特性与规范","icon":"list-check","pages":[{"group":"插件类型","pages":[{"title":"通用规范","href":"/zh/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"模型规范","href":"/zh/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"模型 API 接口","href":"/zh/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"持久化存储","href":"/zh/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"工具返回","href":"/zh/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/zh/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"多语言 README","href":"/zh/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"插件调试","href":"/zh/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"输出插件日志","href":"/zh/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"高级开发","pages":[{"group":"反向调用","pages":[{"title":"Bundle 插件包","href":"/zh/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Dify 服务的反向调用","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"应用","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"反向调用模型","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"工具","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"集成自定义模型","href":"/zh/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"节点","href":"/zh/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"开发指南与示例","icon":"code","pages":[{"title":"速查表","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"按插件类型","pages":[{"title":"工具插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"模型供应商插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"Agent 策略插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"数据源插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"触发器插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint 插件","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"完整示例","pages":[{"title":"Flomo 工具(10分钟)","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdown 导出器","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"多模态工具","href":"/zh/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"发布","icon":"upload","pages":[{"title":"发布插件","href":"/zh/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"标准","pages":[{"title":"插件开发指南","href":"/zh/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"隐私政策指南","href":"/zh/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"发布插件到市场","sidebarTitle":"市场","href":"/zh/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub 仓库","pages":[{"title":"发布到个人 GitHub 仓库","href":"/zh/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"本地文件","pages":[{"title":"打包为本地文件并分享","href":"/zh/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"为第三方签名验证签署插件","href":"/zh/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"常见问题","sidebarTitle":"常见问题","href":"/zh/develop-plugin/publishing/faq/faq"}]}]}]}]}]},{"language":"ja","products":[{"product":"Cloud","icon":"cloud","tabs":[{"tab":"使い方","icon":"book-open","pages":[{"title":"使い方","href":"/ja/cloud/use-dify/getting-started/introduction"}]},{"tab":"学習","icon":"graduation-cap","pages":[{"title":"学習","href":"/ja/learn/key-concepts"}]},{"tab":"開発者リソース","icon":"code","menu":[{"item":"API","icon":"code","groups":[{"group":"ガイド","pages":[{"title":"Dify API クイックスタート","sidebarTitle":"クイックスタート","href":"/ja/api-reference/guides/get-started"},{"group":"API 概要","expanded":true,"pages":[{"title":"Chatflow アプリ API","sidebarTitle":"Chatflow","href":"/ja/api-reference/guides/chatflow"},{"title":"Workflow アプリ API","sidebarTitle":"Workflow","href":"/ja/api-reference/guides/workflow"},{"title":"Agent API","sidebarTitle":"Agent","tag":"New","href":"/ja/api-reference/guides/agent"},{"group":"ナレッジベース","root":{"title":"ナレッジベース API","sidebarTitle":"ナレッジベース","href":"/ja/api-reference/guides/knowledge-base-api"},"pages":[{"title":"Agent ナレッジベース API","tag":"Cloud","sidebarTitle":"Agent ナレッジベース","href":"/ja/api-reference/guides/knowledge-base"},{"title":"従来型ナレッジベース API","sidebarTitle":"従来型ナレッジベース","href":"/ja/api-reference/guides/knowledge"}]},{"title":"チャットアプリ API","sidebarTitle":"Chatbotとレガシー Agent","href":"/ja/api-reference/guides/chat"},{"title":"テキストジェネレーターアプリ API","sidebarTitle":"テキストジェネレーター","href":"/ja/api-reference/guides/completion"}]},{"title":"ストリーミングレスポンスの処理","sidebarTitle":"SSE ストリーミング","href":"/ja/api-reference/guides/streaming"},{"title":"人間の入力 API 連携フロー","sidebarTitle":"人間の入力フロー","href":"/ja/api-reference/guides/human-input-flow"},{"title":"エンドユーザーの識別","sidebarTitle":"エンドユーザーの識別","href":"/ja/api-reference/guides/end-user-identity"},{"title":"エラーとレート制限の処理","sidebarTitle":"エラーとレート制限","href":"/ja/api-reference/guides/errors"}]},{"group":"アプリ API","pages":[{"group":"チャットメッセージ","pages":[{"title":"チャットメッセージを送信","deprecated":null,"version":null,"sidebarTitle":"チャットメッセージを送信","openapi":"/ja/api-reference/openapi_service.json post /chat-messages","href":"/ja/api-reference/chat-messages/send-chat-message"},{"title":"生成を停止","deprecated":null,"version":null,"sidebarTitle":"生成を停止","openapi":"/ja/api-reference/openapi_service.json post /chat-messages/{task_id}/stop","href":"/ja/api-reference/chat-messages/stop-chat-message-generation"},{"title":"次の推奨質問を取得","deprecated":null,"version":null,"sidebarTitle":"次の推奨質問を取得","openapi":"/ja/api-reference/openapi_service.json get /messages/{message_id}/suggested","href":"/ja/api-reference/chat-messages/get-next-suggested-questions"}]},{"group":"完了メッセージ","pages":[{"title":"完了メッセージを送信","deprecated":null,"version":null,"sidebarTitle":"完了メッセージを送信","openapi":"/ja/api-reference/openapi_service.json post /completion-messages","href":"/ja/api-reference/completion-messages/send-completion-message"},{"title":"生成を停止","deprecated":null,"version":null,"sidebarTitle":"生成を停止","openapi":"/ja/api-reference/openapi_service.json post /completion-messages/{task_id}/stop","href":"/ja/api-reference/completion-messages/stop-completion-message-generation"}]},{"group":"ワークフロー実行","pages":[{"title":"ワークフローを実行","deprecated":null,"version":null,"sidebarTitle":"ワークフローを実行","openapi":"/ja/api-reference/openapi_service.json post /workflows/run","href":"/ja/api-reference/workflow-runs/run-workflow"},{"title":"ID でワークフローを実行","deprecated":null,"version":null,"sidebarTitle":"ID でワークフローを実行","openapi":"/ja/api-reference/openapi_service.json post /workflows/{workflow_id}/run","href":"/ja/api-reference/workflow-runs/run-workflow-by-id"},{"title":"ワークフロータスクを停止","deprecated":null,"version":null,"sidebarTitle":"ワークフロータスクを停止","openapi":"/ja/api-reference/openapi_service.json post /workflows/tasks/{task_id}/stop","href":"/ja/api-reference/workflow-runs/stop-workflow-task"},{"title":"ワークフロー実行詳細を取得","deprecated":null,"version":null,"sidebarTitle":"ワークフロー実行詳細を取得","openapi":"/ja/api-reference/openapi_service.json get /workflows/run/{workflow_run_id}","href":"/ja/api-reference/workflow-runs/get-workflow-run-detail"},{"title":"ワークフローログ一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ワークフローログ一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /workflows/logs","href":"/ja/api-reference/workflow-runs/list-workflow-logs"},{"title":"ワークフローイベントをストリーム","deprecated":null,"version":null,"sidebarTitle":"ワークフローイベントをストリーム","openapi":"/ja/api-reference/openapi_service.json get /workflow/{workflow_run_id}/events","href":"/ja/api-reference/workflow-runs/stream-workflow-events"}]},{"group":"会話管理","pages":[{"title":"会話一覧を取得","deprecated":null,"version":null,"sidebarTitle":"会話一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /conversations","href":"/ja/api-reference/conversations/list-conversations"},{"title":"会話履歴メッセージ一覧を取得","deprecated":null,"version":null,"sidebarTitle":"会話履歴メッセージ一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /messages","href":"/ja/api-reference/conversations/list-conversation-messages"},{"title":"会話変数の取得","deprecated":null,"version":null,"sidebarTitle":"会話変数の取得","openapi":"/ja/api-reference/openapi_service.json get /conversations/{conversation_id}/variables","href":"/ja/api-reference/conversations/list-conversation-variables"},{"title":"会話の名前を変更","deprecated":null,"version":null,"sidebarTitle":"会話の名前を変更","openapi":"/ja/api-reference/openapi_service.json post /conversations/{conversation_id}/name","href":"/ja/api-reference/conversations/rename-conversation"},{"title":"会話変数を更新","deprecated":null,"version":null,"sidebarTitle":"会話変数を更新","openapi":"/ja/api-reference/openapi_service.json put /conversations/{conversation_id}/variables/{variable_id}","href":"/ja/api-reference/conversations/update-conversation-variable"},{"title":"会話を削除","deprecated":null,"version":null,"sidebarTitle":"会話を削除","openapi":"/ja/api-reference/openapi_service.json delete /conversations/{conversation_id}","href":"/ja/api-reference/conversations/delete-conversation"}]},{"group":"ファイル操作","pages":[{"title":"ファイルをアップロード","deprecated":null,"version":null,"sidebarTitle":"ファイルをアップロード","openapi":"/ja/api-reference/openapi_service.json post /files/upload","href":"/ja/api-reference/files/upload-file"},{"title":"ファイルをダウンロード","deprecated":null,"version":null,"sidebarTitle":"ファイルをダウンロード","openapi":"/ja/api-reference/openapi_service.json get /files/{file_id}/preview","href":"/ja/api-reference/files/download-file"}]},{"group":"音声・テキスト変換","pages":[{"title":"音声をテキストに変換","deprecated":null,"version":null,"sidebarTitle":"音声をテキストに変換","openapi":"/ja/api-reference/openapi_service.json post /audio-to-text","href":"/ja/api-reference/audio/convert-audio-to-text"},{"title":"テキストを音声に変換","deprecated":null,"version":null,"sidebarTitle":"テキストを音声に変換","openapi":"/ja/api-reference/openapi_service.json post /text-to-audio","href":"/ja/api-reference/audio/convert-text-to-audio"}]},{"group":"アプリケーション設定","pages":[{"title":"アプリケーションの基本情報を取得","deprecated":null,"version":null,"sidebarTitle":"アプリケーションの基本情報を取得","openapi":"/ja/api-reference/openapi_service.json get /info","href":"/ja/api-reference/applications/get-app-info"},{"title":"アプリケーションのパラメータ情報を取得","deprecated":null,"version":null,"sidebarTitle":"アプリケーションのパラメータ情報を取得","openapi":"/ja/api-reference/openapi_service.json get /parameters","href":"/ja/api-reference/applications/get-app-parameters"},{"title":"アプリケーションのメタ情報を取得","deprecated":null,"version":null,"sidebarTitle":"アプリケーションのメタ情報を取得","openapi":"/ja/api-reference/openapi_service.json get /meta","href":"/ja/api-reference/applications/get-app-meta"},{"title":"アプリの WebApp 設定を取得","deprecated":null,"version":null,"sidebarTitle":"アプリの WebApp 設定を取得","openapi":"/ja/api-reference/openapi_service.json get /site","href":"/ja/api-reference/applications/get-app-webapp-settings"}]},{"group":"メッセージフィードバック","pages":[{"title":"メッセージフィードバックを送信","deprecated":null,"version":null,"sidebarTitle":"メッセージフィードバックを送信","openapi":"/ja/api-reference/openapi_service.json post /messages/{message_id}/feedbacks","href":"/ja/api-reference/feedback/submit-message-feedback"},{"title":"アプリのフィードバック一覧を取得","deprecated":null,"version":null,"sidebarTitle":"アプリのフィードバック一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /app/feedbacks","href":"/ja/api-reference/feedback/list-app-feedbacks"}]},{"group":"アノテーション管理","pages":[{"title":"アノテーションを作成","deprecated":null,"version":null,"sidebarTitle":"アノテーションを作成","openapi":"/ja/api-reference/openapi_service.json post /apps/annotations","href":"/ja/api-reference/annotations/create-annotation"},{"title":"アノテーションリストを取得","deprecated":null,"version":null,"sidebarTitle":"アノテーションリストを取得","openapi":"/ja/api-reference/openapi_service.json get /apps/annotations","href":"/ja/api-reference/annotations/list-annotations"},{"title":"アノテーションを更新","deprecated":null,"version":null,"sidebarTitle":"アノテーションを更新","openapi":"/ja/api-reference/openapi_service.json put /apps/annotations/{annotation_id}","href":"/ja/api-reference/annotations/update-annotation"},{"title":"アノテーションを削除","deprecated":null,"version":null,"sidebarTitle":"アノテーションを削除","openapi":"/ja/api-reference/openapi_service.json delete /apps/annotations/{annotation_id}","href":"/ja/api-reference/annotations/delete-annotation"},{"title":"アノテーション返信を設定","deprecated":null,"version":null,"sidebarTitle":"アノテーション返信を設定","openapi":"/ja/api-reference/openapi_service.json post /apps/annotation-reply/{action}","href":"/ja/api-reference/annotations/configure-annotation-reply"},{"title":"アノテーション返信の初期設定タスクステータスを取得","deprecated":null,"version":null,"sidebarTitle":"アノテーション返信の初期設定タスクステータスを取得","openapi":"/ja/api-reference/openapi_service.json get /apps/annotation-reply/{action}/status/{job_id}","href":"/ja/api-reference/annotations/get-annotation-reply-job-status"}]},{"group":"エンドユーザー","pages":[{"title":"エンドユーザー取得","deprecated":null,"version":null,"sidebarTitle":"エンドユーザー取得","openapi":"/ja/api-reference/openapi_service.json get /end-users/{end_user_id}","href":"/ja/api-reference/end-users/get-end-user-info"}]},{"group":"人間の入力","pages":[{"title":"人間の入力フォームを取得","deprecated":null,"version":null,"sidebarTitle":"人間の入力フォームを取得","openapi":"/ja/api-reference/openapi_service.json get /form/human_input/{form_token}","href":"/ja/api-reference/human-input/get-human-input-form"},{"title":"人間の入力フォームを送信","deprecated":null,"version":null,"sidebarTitle":"人間の入力フォームを送信","openapi":"/ja/api-reference/openapi_service.json post /form/human_input/{form_token}","href":"/ja/api-reference/human-input/submit-human-input-form"}]}]},{"group":"ナレッジ API","pages":[{"group":"Agent ナレッジベース","tag":"Cloud","pages":[{"group":"クエリ","pages":[{"title":"クエリトークンを作成","deprecated":null,"version":null,"sidebarTitle":"クエリトークンを作成","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/queries/admission","href":"/ja/api-reference/queries/create-query-token"},{"title":"クエリを実行","deprecated":null,"version":null,"sidebarTitle":"クエリを実行","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/query-stream","href":"/ja/api-reference/queries/run-query"}]},{"group":"クエリ記録","pages":[{"title":"クエリ記録一覧を取得","deprecated":null,"version":null,"sidebarTitle":"クエリ記録一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces","href":"/ja/api-reference/query-records/list-query-records"},{"title":"クエリ記録を取得","deprecated":null,"version":null,"sidebarTitle":"クエリ記録を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}","href":"/ja/api-reference/query-records/get-query-record"},{"title":"クエリのチャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"クエリのチャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/evidence","href":"/ja/api-reference/query-records/list-query-chunks"},{"title":"クエリの矛盾一覧を取得","deprecated":null,"version":null,"sidebarTitle":"クエリの矛盾一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/conflicts","href":"/ja/api-reference/query-records/list-query-conflicts"},{"title":"欠落チャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"欠落チャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/missing","href":"/ja/api-reference/query-records/list-missing-chunks"}]},{"group":"リサーチタスク","pages":[{"title":"リサーチタスク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"リサーチタスク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/ja/api-reference/research-tasks/list-research-tasks"},{"title":"リサーチタスクを作成","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクを作成","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/ja/api-reference/research-tasks/create-research-task"},{"title":"リサーチタスクを計画","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクを計画","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/plan","href":"/ja/api-reference/research-tasks/plan-research-task"},{"title":"リサーチタスクを取得","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/ja/api-reference/research-tasks/get-research-task"},{"title":"リサーチタスクをキャンセル","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクをキャンセル","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/ja/api-reference/research-tasks/cancel-research-task"},{"title":"リサーチタスクの結果一覧を取得","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクの結果一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials","href":"/ja/api-reference/research-tasks/list-research-task-results"}]},{"group":"ドキュメントとチャンク","pages":[{"title":"ドキュメント一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメント一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents","href":"/ja/api-reference/documents-and-chunks/list-documents"},{"title":"ドキュメントを取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/ja/api-reference/documents-and-chunks/get-document"},{"title":"ドキュメントメタデータを更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメントメタデータを更新","openapi":"/ja/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/ja/api-reference/documents-and-chunks/update-document-metadata"},{"title":"ファイルからドキュメントを取得","deprecated":null,"version":null,"sidebarTitle":"ファイルからドキュメントを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/document-references/resolve","href":"/ja/api-reference/documents-and-chunks/get-document-by-file"},{"title":"ドキュメントファイル一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントファイル一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents","href":"/ja/api-reference/documents-and-chunks/list-document-files"},{"title":"ドキュメントファイルを取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントファイルを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/ja/api-reference/documents-and-chunks/get-document-file"},{"title":"ドキュメントファイルを削除","deprecated":null,"version":null,"sidebarTitle":"ドキュメントファイルを削除","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/ja/api-reference/documents-and-chunks/delete-document-file"},{"title":"ドキュメントのアウトラインを取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントのアウトラインを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline","href":"/ja/api-reference/documents-and-chunks/get-document-outline"},{"title":"ドキュメントリビジョン一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントリビジョン一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions","href":"/ja/api-reference/documents-and-chunks/list-document-revisions"},{"title":"チャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"チャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks","href":"/ja/api-reference/documents-and-chunks/list-chunks"},{"title":"チャンクを取得","deprecated":null,"version":null,"sidebarTitle":"チャンクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}","href":"/ja/api-reference/documents-and-chunks/get-chunk"},{"title":"ドキュメントファイルを一括削除","deprecated":null,"version":null,"sidebarTitle":"ドキュメントファイルを一括削除","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/bulk","href":"/ja/api-reference/documents-and-chunks/delete-document-files-in-batch"},{"title":"ドキュメントを再インデックス","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを再インデックス","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/documents/reindex","href":"/ja/api-reference/documents-and-chunks/re-index-documents"}]},{"group":"インデックスタスク","pages":[{"title":"インデックスタスクを取得","deprecated":null,"version":null,"sidebarTitle":"インデックスタスクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/ja/api-reference/indexing-tasks/get-indexing-task"},{"title":"インデックスタスクをキャンセル","deprecated":null,"version":null,"sidebarTitle":"インデックスタスクをキャンセル","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/ja/api-reference/indexing-tasks/cancel-indexing-task"},{"title":"インデックスタスクを再試行","deprecated":null,"version":null,"sidebarTitle":"インデックスタスクを再試行","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry","href":"/ja/api-reference/indexing-tasks/retry-indexing-task"},{"title":"一括タスクを取得","deprecated":null,"version":null,"sidebarTitle":"一括タスクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id}","href":"/ja/api-reference/indexing-tasks/get-bulk-task"},{"title":"ドキュメントのインデックスタスク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントのインデックスタスク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks","href":"/ja/api-reference/indexing-tasks/list-document-indexing-tasks"},{"title":"ドキュメントのインデックスタスクを取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントのインデックスタスクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}","href":"/ja/api-reference/indexing-tasks/get-document-indexing-task"},{"title":"バックグラウンドタスク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"バックグラウンドタスク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/background-tasks","href":"/ja/api-reference/indexing-tasks/list-background-tasks"}]},{"group":"削除ジョブ","pages":[{"title":"削除ジョブを取得","deprecated":null,"version":null,"sidebarTitle":"削除ジョブを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}","href":"/ja/api-reference/deletion-jobs/get-deletion-job"},{"title":"削除バッチを取得","deprecated":null,"version":null,"sidebarTitle":"削除バッチを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-batches/{deletion_batch_id}","href":"/ja/api-reference/deletion-jobs/get-deletion-batch"}]},{"group":"ソース","pages":[{"title":"ソースの接続一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソースの接続一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-connections","href":"/ja/api-reference/sources/list-source-connections"},{"title":"ソースを作成","deprecated":null,"version":null,"sidebarTitle":"ソースを作成","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/ja/api-reference/sources/create-source"},{"title":"ソース一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソース一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/ja/api-reference/sources/list-sources"},{"title":"ソースを取得","deprecated":null,"version":null,"sidebarTitle":"ソースを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/ja/api-reference/sources/get-source"},{"title":"ソースを更新","deprecated":null,"version":null,"sidebarTitle":"ソースを更新","openapi":"/ja/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/ja/api-reference/sources/update-source"},{"title":"ソースを削除","deprecated":null,"version":null,"sidebarTitle":"ソースを削除","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/ja/api-reference/sources/delete-source"},{"title":"ソースの認証情報をテスト","deprecated":null,"version":null,"sidebarTitle":"ソースの認証情報をテスト","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/test","href":"/ja/api-reference/sources/test-source-credentials"},{"title":"ソースのページ一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソースのページ一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/pages","href":"/ja/api-reference/sources/list-source-pages"},{"title":"ソースのファイル一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソースのファイル一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files","href":"/ja/api-reference/sources/list-source-files"},{"title":"同期ポリシーを取得","deprecated":null,"version":null,"sidebarTitle":"同期ポリシーを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/ja/api-reference/sources/get-sync-policy"},{"title":"同期ポリシーを更新","deprecated":null,"version":null,"sidebarTitle":"同期ポリシーを更新","openapi":"/ja/api-reference/openapi_service.json put /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/ja/api-reference/sources/update-sync-policy"}]},{"group":"ソースの同期とインポート","pages":[{"title":"ソースを同期","deprecated":null,"version":null,"sidebarTitle":"ソースを同期","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync","href":"/ja/api-reference/source-syncs-and-imports/sync-source"},{"title":"ウェブサイトのクロールをプレビュー","deprecated":null,"version":null,"sidebarTitle":"ウェブサイトのクロールをプレビュー","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-preview","href":"/ja/api-reference/source-syncs-and-imports/preview-website-crawl"},{"title":"クロールプレビューのページ一覧を取得","deprecated":null,"version":null,"sidebarTitle":"クロールプレビューのページ一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/pages","href":"/ja/api-reference/source-syncs-and-imports/list-crawl-preview-pages"},{"title":"選択したページをインポート","description":"クロールプレビューのページをドキュメントとしてインポートし、インポートのためにキューに入った同じ実行を返します。`state` が `completed`、`failed`、`canceled` のいずれかになるまで、同じ `id` で [ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run) をポーリングしてください。\n\nページは再クロールされず、プレビューで一時保存された内容からインポートされます。\n\n実行が完了すると、これらのページがソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したいページはすべて含めてください。\n\nプレビューとインポートの流れについては、[ウェブサイトのページのインポート](/ja/api-reference/guides/knowledge-base#import-website-pages) を参照してください。","deprecated":null,"version":null,"sidebarTitle":"選択したページをインポート","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/selection","href":"/ja/api-reference/source-syncs-and-imports/import-selected-pages"},{"title":"ウェブサイトのページをインポート","deprecated":null,"version":null,"sidebarTitle":"ウェブサイトのページをインポート","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import","href":"/ja/api-reference/source-syncs-and-imports/import-website-pages"},{"title":"ソースのアイテムをインポート","description":"オンラインドキュメントのページまたはオンラインドライブのファイルをコネクタソースにインポートし、実行を返します。`state` が `completed`、`failed`、`canceled` のいずれかになるまで、その `id` で [ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run) をポーリングしてください。\n\n指定したアイテムで、ソースのドキュメントが置き換えられます。インポートが完了すると、`items` に含まれないアイテムに対応するソースのドキュメントは削除されます。ソースに残したいアイテムはすべて送信してください。\n\nソースで最初のインポートが完了した後は、そのインポートに含まれていたアイテムしか指定できません。新しいアイテムを指定すると、実行は `SOURCE_OPERATION_FAILED` で失敗し、再試行しても解決しません。新しいアイテムは Dify でソースに追加してください。\n\nソースは `connector` ソースで、`kind` がその `metadata.providerKind` と一致している必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけなので、先にアクティブな実行が終わるのを待ってください。\n\n閲覧とインポートの流れについては、[オンラインドキュメントとドライブファイルのインポート](/ja/api-reference/guides/knowledge-base#import-online-documents-and-drive-files) を参照してください。","deprecated":null,"version":null,"sidebarTitle":"ソースのアイテムをインポート","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports","href":"/ja/api-reference/source-syncs-and-imports/import-source-items"},{"title":"ソースの実行一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソースの実行一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows","href":"/ja/api-reference/source-syncs-and-imports/list-source-runs"},{"title":"ソースの実行を取得","deprecated":null,"version":null,"sidebarTitle":"ソースの実行を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}","href":"/ja/api-reference/source-syncs-and-imports/get-source-run"},{"title":"ソースの実行をキャンセル","deprecated":null,"version":null,"sidebarTitle":"ソースの実行をキャンセル","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/cancel","href":"/ja/api-reference/source-syncs-and-imports/cancel-source-run"},{"title":"ソースの実行を再試行","deprecated":null,"version":null,"sidebarTitle":"ソースの実行を再試行","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry","href":"/ja/api-reference/source-syncs-and-imports/retry-source-run"}]},{"group":"設定","pages":[{"title":"ナレッジベース設定を取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベース設定を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/ja/api-reference/settings/get-knowledge-base-settings"},{"title":"ナレッジベース設定を更新","deprecated":null,"version":null,"sidebarTitle":"ナレッジベース設定を更新","openapi":"/ja/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/ja/api-reference/settings/update-knowledge-base-settings"},{"title":"設定の移行を取得","deprecated":null,"version":null,"sidebarTitle":"設定の移行を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_id}","href":"/ja/api-reference/settings/get-settings-migration"}]}]},{"group":"従来型ナレッジベース","pages":[{"group":"ナレッジベース","pages":[{"title":"空のナレッジベースを作成","deprecated":null,"version":null,"sidebarTitle":"空のナレッジベースを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets","href":"/ja/api-reference/knowledge-bases/create-an-empty-knowledge-base"},{"title":"ナレッジベースリストを取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets","href":"/ja/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"ナレッジベース詳細を取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベース詳細を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}","href":"/ja/api-reference/knowledge-bases/get-knowledge-base"},{"title":"ナレッジベースを更新","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースを更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}","href":"/ja/api-reference/knowledge-bases/update-knowledge-base"},{"title":"ナレッジベースを削除","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}","href":"/ja/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"ナレッジベースからチャンクを取得 / テスト検索","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースからチャンクを取得 / テスト検索","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/ja/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"ドキュメント","pages":[{"title":"テキストからドキュメントを作成","deprecated":null,"version":null,"sidebarTitle":"テキストからドキュメントを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/ja/api-reference/documents/create-document-by-text"},{"title":"ファイルからドキュメントを作成","deprecated":null,"version":null,"sidebarTitle":"ファイルからドキュメントを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/ja/api-reference/documents/create-document-by-file"},{"title":"ナレッジベースのドキュメントリストを取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースのドキュメントリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents","href":"/ja/api-reference/documents/list-documents"},{"title":"ドキュメント詳細を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメント詳細を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/ja/api-reference/documents/get-document"},{"title":"ドキュメントを削除","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/ja/api-reference/documents/delete-document"},{"title":"ドキュメントを更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/ja/api-reference/documents/update-document"},{"title":"ドキュメントをダウンロード","deprecated":null,"version":null,"sidebarTitle":"ドキュメントをダウンロード","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/ja/api-reference/documents/download-document"},{"title":"ドキュメント埋め込みステータス(進捗)を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメント埋め込みステータス(進捗)を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/ja/api-reference/documents/get-document-indexing-status"},{"title":"テキストでドキュメントを更新","deprecated":null,"version":null,"sidebarTitle":"テキストでドキュメントを更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/ja/api-reference/documents/update-document-by-text"},{"title":"ファイルでドキュメントを更新","deprecated":true,"version":null,"sidebarTitle":"ファイルでドキュメントを更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/ja/api-reference/documents/update-document-by-file"},{"title":"ドキュメントを一括ダウンロード(ZIP)","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを一括ダウンロード(ZIP)","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/ja/api-reference/documents/download-documents-as-zip"},{"title":"ドキュメントステータスを一括更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメントステータスを一括更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/ja/api-reference/documents/update-document-status-in-batch"}]},{"group":"チャンク","pages":[{"title":"ドキュメントにチャンクを追加","deprecated":null,"version":null,"sidebarTitle":"ドキュメントにチャンクを追加","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/ja/api-reference/chunks/create-chunks"},{"title":"チャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"チャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/ja/api-reference/chunks/list-chunks"},{"title":"ドキュメント内のチャンク詳細を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメント内のチャンク詳細を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/ja/api-reference/chunks/get-chunk"},{"title":"ドキュメント内のチャンクを更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメント内のチャンクを更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/ja/api-reference/chunks/update-chunk"},{"title":"ドキュメント内のチャンクを削除","deprecated":null,"version":null,"sidebarTitle":"ドキュメント内のチャンクを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/ja/api-reference/chunks/delete-chunk"},{"title":"子チャンクを作成","deprecated":null,"version":null,"sidebarTitle":"子チャンクを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/ja/api-reference/chunks/create-child-chunk"},{"title":"子チャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"子チャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/ja/api-reference/chunks/list-child-chunks"},{"title":"子チャンクを更新","deprecated":null,"version":null,"sidebarTitle":"子チャンクを更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/ja/api-reference/chunks/update-child-chunk"},{"title":"子チャンクを削除","deprecated":null,"version":null,"sidebarTitle":"子チャンクを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/ja/api-reference/chunks/delete-child-chunk"}]},{"group":"メタデータ","pages":[{"title":"メタデータフィールドを作成","deprecated":null,"version":null,"sidebarTitle":"メタデータフィールドを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/ja/api-reference/metadata/create-metadata-field"},{"title":"メタデータフィールドリストを取得","deprecated":null,"version":null,"sidebarTitle":"メタデータフィールドリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/ja/api-reference/metadata/list-metadata-fields"},{"title":"メタデータフィールドを更新","deprecated":null,"version":null,"sidebarTitle":"メタデータフィールドを更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/ja/api-reference/metadata/update-metadata-field"},{"title":"メタデータフィールドを削除","deprecated":null,"version":null,"sidebarTitle":"メタデータフィールドを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/ja/api-reference/metadata/delete-metadata-field"},{"title":"組み込みメタデータフィールドを取得","deprecated":null,"version":null,"sidebarTitle":"組み込みメタデータフィールドを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/ja/api-reference/metadata/get-built-in-metadata-fields"},{"title":"組み込みメタデータフィールドを更新","deprecated":null,"version":null,"sidebarTitle":"組み込みメタデータフィールドを更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/ja/api-reference/metadata/update-built-in-metadata-field"},{"title":"ドキュメントメタデータを一括更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメントメタデータを一括更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/ja/api-reference/metadata/update-document-metadata-in-batch"}]},{"group":"タグ管理","pages":[{"title":"ナレッジベースタグを作成","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースタグを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/tags","href":"/ja/api-reference/tags/create-knowledge-tag"},{"title":"ナレッジベースタグリストを取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースタグリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/tags","href":"/ja/api-reference/tags/list-knowledge-tags"},{"title":"ナレッジベースタグを変更","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースタグを変更","openapi":"/ja/api-reference/openapi_service.json patch /datasets/tags","href":"/ja/api-reference/tags/update-knowledge-tag"},{"title":"ナレッジベースタグを削除","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースタグを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/tags","href":"/ja/api-reference/tags/delete-knowledge-tag"},{"title":"タグをナレッジベースにバインド","deprecated":null,"version":null,"sidebarTitle":"タグをナレッジベースにバインド","openapi":"/ja/api-reference/openapi_service.json post /datasets/tags/binding","href":"/ja/api-reference/tags/create-tag-binding"},{"title":"タグとナレッジベースのバインドを解除","deprecated":null,"version":null,"sidebarTitle":"タグとナレッジベースのバインドを解除","openapi":"/ja/api-reference/openapi_service.json post /datasets/tags/unbinding","href":"/ja/api-reference/tags/delete-tag-binding"},{"title":"ナレッジベースにバインドされたタグを取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースにバインドされたタグを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/tags","href":"/ja/api-reference/tags/get-knowledge-base-tags"}]},{"group":"モデル","pages":[{"title":"利用可能なモデルを取得","deprecated":null,"version":null,"sidebarTitle":"利用可能なモデルを取得","openapi":"/ja/api-reference/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/ja/api-reference/models/get-available-models"}]},{"group":"ナレッジパイプライン","pages":[{"title":"パイプラインファイルをアップロード","deprecated":null,"version":null,"sidebarTitle":"パイプラインファイルをアップロード","openapi":"/ja/api-reference/openapi_service.json post /datasets/pipeline/file-upload","href":"/ja/api-reference/knowledge-pipeline/upload-pipeline-file"},{"title":"データソースプラグインリストを取得","deprecated":null,"version":null,"sidebarTitle":"データソースプラグインリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/ja/api-reference/knowledge-pipeline/list-datasource-plugins"},{"title":"データソースノードを実行","deprecated":null,"version":null,"sidebarTitle":"データソースノードを実行","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/ja/api-reference/knowledge-pipeline/run-datasource-node"},{"title":"パイプラインを実行","deprecated":null,"version":null,"sidebarTitle":"パイプラインを実行","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/ja/api-reference/knowledge-pipeline/run-pipeline"}]}]}]}]},{"item":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/ja/cli/overview"}]},{"item":"プラグイン開発","icon":"code-pull-request","pages":[{"title":"プラグイン開発","href":"/ja/develop-plugin/getting-started/getting-started-dify-plugin"}]}]}]},{"product":"セルフホスト","icon":"server","tabs":[{"tab":"デプロイ","icon":"server","pages":[{"title":"デプロイ","href":"/ja/self-host/deploy/overview"}]},{"tab":"使い方","icon":"book-open","pages":[{"title":"使い方","href":"/ja/self-host/use-dify/getting-started/introduction"}]},{"tab":"学習","icon":"graduation-cap","pages":[{"title":"学習","href":"/ja/learn/key-concepts"}]},{"tab":"開発者リソース","icon":"code","menu":[{"item":"API","icon":"code","groups":[{"group":"ガイド","pages":[{"title":"Dify API クイックスタート","sidebarTitle":"クイックスタート","href":"/ja/api-reference/guides/get-started"},{"group":"API 概要","expanded":true,"pages":[{"title":"Chatflow アプリ API","sidebarTitle":"Chatflow","href":"/ja/api-reference/guides/chatflow"},{"title":"Workflow アプリ API","sidebarTitle":"Workflow","href":"/ja/api-reference/guides/workflow"},{"title":"Agent API","sidebarTitle":"Agent","tag":"New","href":"/ja/api-reference/guides/agent"},{"group":"ナレッジベース","root":{"title":"ナレッジベース API","sidebarTitle":"ナレッジベース","href":"/ja/api-reference/guides/knowledge-base-api"},"pages":[{"title":"Agent ナレッジベース API","tag":"Cloud","sidebarTitle":"Agent ナレッジベース","href":"/ja/api-reference/guides/knowledge-base"},{"title":"従来型ナレッジベース API","sidebarTitle":"従来型ナレッジベース","href":"/ja/api-reference/guides/knowledge"}]},{"title":"チャットアプリ API","sidebarTitle":"Chatbotとレガシー Agent","href":"/ja/api-reference/guides/chat"},{"title":"テキストジェネレーターアプリ API","sidebarTitle":"テキストジェネレーター","href":"/ja/api-reference/guides/completion"}]},{"title":"ストリーミングレスポンスの処理","sidebarTitle":"SSE ストリーミング","href":"/ja/api-reference/guides/streaming"},{"title":"人間の入力 API 連携フロー","sidebarTitle":"人間の入力フロー","href":"/ja/api-reference/guides/human-input-flow"},{"title":"エンドユーザーの識別","sidebarTitle":"エンドユーザーの識別","href":"/ja/api-reference/guides/end-user-identity"},{"title":"エラーとレート制限の処理","sidebarTitle":"エラーとレート制限","href":"/ja/api-reference/guides/errors"}]},{"group":"アプリ API","pages":[{"group":"チャットメッセージ","pages":[{"title":"チャットメッセージを送信","deprecated":null,"version":null,"sidebarTitle":"チャットメッセージを送信","openapi":"/ja/api-reference/openapi_service.json post /chat-messages","href":"/ja/api-reference/chat-messages/send-chat-message"},{"title":"生成を停止","deprecated":null,"version":null,"sidebarTitle":"生成を停止","openapi":"/ja/api-reference/openapi_service.json post /chat-messages/{task_id}/stop","href":"/ja/api-reference/chat-messages/stop-chat-message-generation"},{"title":"次の推奨質問を取得","deprecated":null,"version":null,"sidebarTitle":"次の推奨質問を取得","openapi":"/ja/api-reference/openapi_service.json get /messages/{message_id}/suggested","href":"/ja/api-reference/chat-messages/get-next-suggested-questions"}]},{"group":"完了メッセージ","pages":[{"title":"完了メッセージを送信","deprecated":null,"version":null,"sidebarTitle":"完了メッセージを送信","openapi":"/ja/api-reference/openapi_service.json post /completion-messages","href":"/ja/api-reference/completion-messages/send-completion-message"},{"title":"生成を停止","deprecated":null,"version":null,"sidebarTitle":"生成を停止","openapi":"/ja/api-reference/openapi_service.json post /completion-messages/{task_id}/stop","href":"/ja/api-reference/completion-messages/stop-completion-message-generation"}]},{"group":"ワークフロー実行","pages":[{"title":"ワークフローを実行","deprecated":null,"version":null,"sidebarTitle":"ワークフローを実行","openapi":"/ja/api-reference/openapi_service.json post /workflows/run","href":"/ja/api-reference/workflow-runs/run-workflow"},{"title":"ID でワークフローを実行","deprecated":null,"version":null,"sidebarTitle":"ID でワークフローを実行","openapi":"/ja/api-reference/openapi_service.json post /workflows/{workflow_id}/run","href":"/ja/api-reference/workflow-runs/run-workflow-by-id"},{"title":"ワークフロータスクを停止","deprecated":null,"version":null,"sidebarTitle":"ワークフロータスクを停止","openapi":"/ja/api-reference/openapi_service.json post /workflows/tasks/{task_id}/stop","href":"/ja/api-reference/workflow-runs/stop-workflow-task"},{"title":"ワークフロー実行詳細を取得","deprecated":null,"version":null,"sidebarTitle":"ワークフロー実行詳細を取得","openapi":"/ja/api-reference/openapi_service.json get /workflows/run/{workflow_run_id}","href":"/ja/api-reference/workflow-runs/get-workflow-run-detail"},{"title":"ワークフローログ一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ワークフローログ一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /workflows/logs","href":"/ja/api-reference/workflow-runs/list-workflow-logs"},{"title":"ワークフローイベントをストリーム","deprecated":null,"version":null,"sidebarTitle":"ワークフローイベントをストリーム","openapi":"/ja/api-reference/openapi_service.json get /workflow/{workflow_run_id}/events","href":"/ja/api-reference/workflow-runs/stream-workflow-events"}]},{"group":"会話管理","pages":[{"title":"会話一覧を取得","deprecated":null,"version":null,"sidebarTitle":"会話一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /conversations","href":"/ja/api-reference/conversations/list-conversations"},{"title":"会話履歴メッセージ一覧を取得","deprecated":null,"version":null,"sidebarTitle":"会話履歴メッセージ一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /messages","href":"/ja/api-reference/conversations/list-conversation-messages"},{"title":"会話変数の取得","deprecated":null,"version":null,"sidebarTitle":"会話変数の取得","openapi":"/ja/api-reference/openapi_service.json get /conversations/{conversation_id}/variables","href":"/ja/api-reference/conversations/list-conversation-variables"},{"title":"会話の名前を変更","deprecated":null,"version":null,"sidebarTitle":"会話の名前を変更","openapi":"/ja/api-reference/openapi_service.json post /conversations/{conversation_id}/name","href":"/ja/api-reference/conversations/rename-conversation"},{"title":"会話変数を更新","deprecated":null,"version":null,"sidebarTitle":"会話変数を更新","openapi":"/ja/api-reference/openapi_service.json put /conversations/{conversation_id}/variables/{variable_id}","href":"/ja/api-reference/conversations/update-conversation-variable"},{"title":"会話を削除","deprecated":null,"version":null,"sidebarTitle":"会話を削除","openapi":"/ja/api-reference/openapi_service.json delete /conversations/{conversation_id}","href":"/ja/api-reference/conversations/delete-conversation"}]},{"group":"ファイル操作","pages":[{"title":"ファイルをアップロード","deprecated":null,"version":null,"sidebarTitle":"ファイルをアップロード","openapi":"/ja/api-reference/openapi_service.json post /files/upload","href":"/ja/api-reference/files/upload-file"},{"title":"ファイルをダウンロード","deprecated":null,"version":null,"sidebarTitle":"ファイルをダウンロード","openapi":"/ja/api-reference/openapi_service.json get /files/{file_id}/preview","href":"/ja/api-reference/files/download-file"}]},{"group":"音声・テキスト変換","pages":[{"title":"音声をテキストに変換","deprecated":null,"version":null,"sidebarTitle":"音声をテキストに変換","openapi":"/ja/api-reference/openapi_service.json post /audio-to-text","href":"/ja/api-reference/audio/convert-audio-to-text"},{"title":"テキストを音声に変換","deprecated":null,"version":null,"sidebarTitle":"テキストを音声に変換","openapi":"/ja/api-reference/openapi_service.json post /text-to-audio","href":"/ja/api-reference/audio/convert-text-to-audio"}]},{"group":"アプリケーション設定","pages":[{"title":"アプリケーションの基本情報を取得","deprecated":null,"version":null,"sidebarTitle":"アプリケーションの基本情報を取得","openapi":"/ja/api-reference/openapi_service.json get /info","href":"/ja/api-reference/applications/get-app-info"},{"title":"アプリケーションのパラメータ情報を取得","deprecated":null,"version":null,"sidebarTitle":"アプリケーションのパラメータ情報を取得","openapi":"/ja/api-reference/openapi_service.json get /parameters","href":"/ja/api-reference/applications/get-app-parameters"},{"title":"アプリケーションのメタ情報を取得","deprecated":null,"version":null,"sidebarTitle":"アプリケーションのメタ情報を取得","openapi":"/ja/api-reference/openapi_service.json get /meta","href":"/ja/api-reference/applications/get-app-meta"},{"title":"アプリの WebApp 設定を取得","deprecated":null,"version":null,"sidebarTitle":"アプリの WebApp 設定を取得","openapi":"/ja/api-reference/openapi_service.json get /site","href":"/ja/api-reference/applications/get-app-webapp-settings"}]},{"group":"メッセージフィードバック","pages":[{"title":"メッセージフィードバックを送信","deprecated":null,"version":null,"sidebarTitle":"メッセージフィードバックを送信","openapi":"/ja/api-reference/openapi_service.json post /messages/{message_id}/feedbacks","href":"/ja/api-reference/feedback/submit-message-feedback"},{"title":"アプリのフィードバック一覧を取得","deprecated":null,"version":null,"sidebarTitle":"アプリのフィードバック一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /app/feedbacks","href":"/ja/api-reference/feedback/list-app-feedbacks"}]},{"group":"アノテーション管理","pages":[{"title":"アノテーションを作成","deprecated":null,"version":null,"sidebarTitle":"アノテーションを作成","openapi":"/ja/api-reference/openapi_service.json post /apps/annotations","href":"/ja/api-reference/annotations/create-annotation"},{"title":"アノテーションリストを取得","deprecated":null,"version":null,"sidebarTitle":"アノテーションリストを取得","openapi":"/ja/api-reference/openapi_service.json get /apps/annotations","href":"/ja/api-reference/annotations/list-annotations"},{"title":"アノテーションを更新","deprecated":null,"version":null,"sidebarTitle":"アノテーションを更新","openapi":"/ja/api-reference/openapi_service.json put /apps/annotations/{annotation_id}","href":"/ja/api-reference/annotations/update-annotation"},{"title":"アノテーションを削除","deprecated":null,"version":null,"sidebarTitle":"アノテーションを削除","openapi":"/ja/api-reference/openapi_service.json delete /apps/annotations/{annotation_id}","href":"/ja/api-reference/annotations/delete-annotation"},{"title":"アノテーション返信を設定","deprecated":null,"version":null,"sidebarTitle":"アノテーション返信を設定","openapi":"/ja/api-reference/openapi_service.json post /apps/annotation-reply/{action}","href":"/ja/api-reference/annotations/configure-annotation-reply"},{"title":"アノテーション返信の初期設定タスクステータスを取得","deprecated":null,"version":null,"sidebarTitle":"アノテーション返信の初期設定タスクステータスを取得","openapi":"/ja/api-reference/openapi_service.json get /apps/annotation-reply/{action}/status/{job_id}","href":"/ja/api-reference/annotations/get-annotation-reply-job-status"}]},{"group":"エンドユーザー","pages":[{"title":"エンドユーザー取得","deprecated":null,"version":null,"sidebarTitle":"エンドユーザー取得","openapi":"/ja/api-reference/openapi_service.json get /end-users/{end_user_id}","href":"/ja/api-reference/end-users/get-end-user-info"}]},{"group":"人間の入力","pages":[{"title":"人間の入力フォームを取得","deprecated":null,"version":null,"sidebarTitle":"人間の入力フォームを取得","openapi":"/ja/api-reference/openapi_service.json get /form/human_input/{form_token}","href":"/ja/api-reference/human-input/get-human-input-form"},{"title":"人間の入力フォームを送信","deprecated":null,"version":null,"sidebarTitle":"人間の入力フォームを送信","openapi":"/ja/api-reference/openapi_service.json post /form/human_input/{form_token}","href":"/ja/api-reference/human-input/submit-human-input-form"}]}]},{"group":"ナレッジ API","pages":[{"group":"Agent ナレッジベース","tag":"Cloud","pages":[{"group":"クエリ","pages":[{"title":"クエリトークンを作成","deprecated":null,"version":null,"sidebarTitle":"クエリトークンを作成","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/queries/admission","href":"/ja/api-reference/queries/create-query-token"},{"title":"クエリを実行","deprecated":null,"version":null,"sidebarTitle":"クエリを実行","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/query-stream","href":"/ja/api-reference/queries/run-query"}]},{"group":"クエリ記録","pages":[{"title":"クエリ記録一覧を取得","deprecated":null,"version":null,"sidebarTitle":"クエリ記録一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces","href":"/ja/api-reference/query-records/list-query-records"},{"title":"クエリ記録を取得","deprecated":null,"version":null,"sidebarTitle":"クエリ記録を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}","href":"/ja/api-reference/query-records/get-query-record"},{"title":"クエリのチャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"クエリのチャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/evidence","href":"/ja/api-reference/query-records/list-query-chunks"},{"title":"クエリの矛盾一覧を取得","deprecated":null,"version":null,"sidebarTitle":"クエリの矛盾一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/conflicts","href":"/ja/api-reference/query-records/list-query-conflicts"},{"title":"欠落チャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"欠落チャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/traces/{query_record_id}/missing","href":"/ja/api-reference/query-records/list-missing-chunks"}]},{"group":"リサーチタスク","pages":[{"title":"リサーチタスク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"リサーチタスク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/ja/api-reference/research-tasks/list-research-tasks"},{"title":"リサーチタスクを作成","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクを作成","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks","href":"/ja/api-reference/research-tasks/create-research-task"},{"title":"リサーチタスクを計画","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクを計画","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/plan","href":"/ja/api-reference/research-tasks/plan-research-task"},{"title":"リサーチタスクを取得","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/ja/api-reference/research-tasks/get-research-task"},{"title":"リサーチタスクをキャンセル","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクをキャンセル","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}","href":"/ja/api-reference/research-tasks/cancel-research-task"},{"title":"リサーチタスクの結果一覧を取得","deprecated":null,"version":null,"sidebarTitle":"リサーチタスクの結果一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/research-tasks/{research_task_id}/partials","href":"/ja/api-reference/research-tasks/list-research-task-results"}]},{"group":"ドキュメントとチャンク","pages":[{"title":"ドキュメント一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメント一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents","href":"/ja/api-reference/documents-and-chunks/list-documents"},{"title":"ドキュメントを取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/ja/api-reference/documents-and-chunks/get-document"},{"title":"ドキュメントメタデータを更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメントメタデータを更新","openapi":"/ja/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/ja/api-reference/documents-and-chunks/update-document-metadata"},{"title":"ファイルからドキュメントを取得","deprecated":null,"version":null,"sidebarTitle":"ファイルからドキュメントを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/document-references/resolve","href":"/ja/api-reference/documents-and-chunks/get-document-by-file"},{"title":"ドキュメントファイル一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントファイル一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents","href":"/ja/api-reference/documents-and-chunks/list-document-files"},{"title":"ドキュメントファイルを取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントファイルを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/ja/api-reference/documents-and-chunks/get-document-file"},{"title":"ドキュメントファイルを削除","deprecated":null,"version":null,"sidebarTitle":"ドキュメントファイルを削除","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}","href":"/ja/api-reference/documents-and-chunks/delete-document-file"},{"title":"ドキュメントのアウトラインを取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントのアウトラインを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline","href":"/ja/api-reference/documents-and-chunks/get-document-outline"},{"title":"ドキュメントリビジョン一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントリビジョン一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions","href":"/ja/api-reference/documents-and-chunks/list-document-revisions"},{"title":"チャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"チャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks","href":"/ja/api-reference/documents-and-chunks/list-chunks"},{"title":"チャンクを取得","deprecated":null,"version":null,"sidebarTitle":"チャンクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}","href":"/ja/api-reference/documents-and-chunks/get-chunk"},{"title":"ドキュメントファイルを一括削除","deprecated":null,"version":null,"sidebarTitle":"ドキュメントファイルを一括削除","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/documents/bulk","href":"/ja/api-reference/documents-and-chunks/delete-document-files-in-batch"},{"title":"ドキュメントを再インデックス","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを再インデックス","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/documents/reindex","href":"/ja/api-reference/documents-and-chunks/re-index-documents"}]},{"group":"インデックスタスク","pages":[{"title":"インデックスタスクを取得","deprecated":null,"version":null,"sidebarTitle":"インデックスタスクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/ja/api-reference/indexing-tasks/get-indexing-task"},{"title":"インデックスタスクをキャンセル","deprecated":null,"version":null,"sidebarTitle":"インデックスタスクをキャンセル","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}","href":"/ja/api-reference/indexing-tasks/cancel-indexing-task"},{"title":"インデックスタスクを再試行","deprecated":null,"version":null,"sidebarTitle":"インデックスタスクを再試行","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/jobs/{task_id}/retry","href":"/ja/api-reference/indexing-tasks/retry-indexing-task"},{"title":"一括タスクを取得","deprecated":null,"version":null,"sidebarTitle":"一括タスクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/bulk-jobs/{bulk_task_id}","href":"/ja/api-reference/indexing-tasks/get-bulk-task"},{"title":"ドキュメントのインデックスタスク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントのインデックスタスク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks","href":"/ja/api-reference/indexing-tasks/list-document-indexing-tasks"},{"title":"ドキュメントのインデックスタスクを取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメントのインデックスタスクを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}/processing-tasks/{task_id}","href":"/ja/api-reference/indexing-tasks/get-document-indexing-task"},{"title":"バックグラウンドタスク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"バックグラウンドタスク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/background-tasks","href":"/ja/api-reference/indexing-tasks/list-background-tasks"}]},{"group":"削除ジョブ","pages":[{"title":"削除ジョブを取得","deprecated":null,"version":null,"sidebarTitle":"削除ジョブを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-jobs/{deletion_job_id}","href":"/ja/api-reference/deletion-jobs/get-deletion-job"},{"title":"削除バッチを取得","deprecated":null,"version":null,"sidebarTitle":"削除バッチを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/deletion-batches/{deletion_batch_id}","href":"/ja/api-reference/deletion-jobs/get-deletion-batch"}]},{"group":"ソース","pages":[{"title":"ソースの接続一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソースの接続一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-connections","href":"/ja/api-reference/sources/list-source-connections"},{"title":"ソースを作成","deprecated":null,"version":null,"sidebarTitle":"ソースを作成","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/ja/api-reference/sources/create-source"},{"title":"ソース一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソース一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources","href":"/ja/api-reference/sources/list-sources"},{"title":"ソースを取得","deprecated":null,"version":null,"sidebarTitle":"ソースを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/ja/api-reference/sources/get-source"},{"title":"ソースを更新","deprecated":null,"version":null,"sidebarTitle":"ソースを更新","openapi":"/ja/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/ja/api-reference/sources/update-source"},{"title":"ソースを削除","deprecated":null,"version":null,"sidebarTitle":"ソースを削除","openapi":"/ja/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}","href":"/ja/api-reference/sources/delete-source"},{"title":"ソースの認証情報をテスト","deprecated":null,"version":null,"sidebarTitle":"ソースの認証情報をテスト","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/test","href":"/ja/api-reference/sources/test-source-credentials"},{"title":"ソースのページ一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソースのページ一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/pages","href":"/ja/api-reference/sources/list-source-pages"},{"title":"ソースのファイル一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソースのファイル一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/files","href":"/ja/api-reference/sources/list-source-files"},{"title":"同期ポリシーを取得","deprecated":null,"version":null,"sidebarTitle":"同期ポリシーを取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/ja/api-reference/sources/get-sync-policy"},{"title":"同期ポリシーを更新","deprecated":null,"version":null,"sidebarTitle":"同期ポリシーを更新","openapi":"/ja/api-reference/openapi_service.json put /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync-policy","href":"/ja/api-reference/sources/update-sync-policy"}]},{"group":"ソースの同期とインポート","pages":[{"title":"ソースを同期","deprecated":null,"version":null,"sidebarTitle":"ソースを同期","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/sync","href":"/ja/api-reference/source-syncs-and-imports/sync-source"},{"title":"ウェブサイトのクロールをプレビュー","deprecated":null,"version":null,"sidebarTitle":"ウェブサイトのクロールをプレビュー","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-preview","href":"/ja/api-reference/source-syncs-and-imports/preview-website-crawl"},{"title":"クロールプレビューのページ一覧を取得","deprecated":null,"version":null,"sidebarTitle":"クロールプレビューのページ一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/pages","href":"/ja/api-reference/source-syncs-and-imports/list-crawl-preview-pages"},{"title":"選択したページをインポート","description":"クロールプレビューのページをドキュメントとしてインポートし、インポートのためにキューに入った同じ実行を返します。`state` が `completed`、`failed`、`canceled` のいずれかになるまで、同じ `id` で [ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run) をポーリングしてください。\n\nページは再クロールされず、プレビューで一時保存された内容からインポートされます。\n\n実行が完了すると、これらのページがソースのページリストになります。インポートのたびにリスト全体が設定されるため、ソースに残したいページはすべて含めてください。\n\nプレビューとインポートの流れについては、[ウェブサイトのページのインポート](/ja/api-reference/guides/knowledge-base#import-website-pages) を参照してください。","deprecated":null,"version":null,"sidebarTitle":"選択したページをインポート","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/selection","href":"/ja/api-reference/source-syncs-and-imports/import-selected-pages"},{"title":"ウェブサイトのページをインポート","deprecated":null,"version":null,"sidebarTitle":"ウェブサイトのページをインポート","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/crawl-import","href":"/ja/api-reference/source-syncs-and-imports/import-website-pages"},{"title":"ソースのアイテムをインポート","description":"オンラインドキュメントのページまたはオンラインドライブのファイルをコネクタソースにインポートし、実行を返します。`state` が `completed`、`failed`、`canceled` のいずれかになるまで、その `id` で [ソースの実行を取得](/ja/api-reference/source-syncs-and-imports/get-source-run) をポーリングしてください。\n\n指定したアイテムで、ソースのドキュメントが置き換えられます。インポートが完了すると、`items` に含まれないアイテムに対応するソースのドキュメントは削除されます。ソースに残したいアイテムはすべて送信してください。\n\nソースで最初のインポートが完了した後は、そのインポートに含まれていたアイテムしか指定できません。新しいアイテムを指定すると、実行は `SOURCE_OPERATION_FAILED` で失敗し、再試行しても解決しません。新しいアイテムは Dify でソースに追加してください。\n\nソースは `connector` ソースで、`kind` がその `metadata.providerKind` と一致している必要があります。1 つのソースで同時に実行できる同期、プレビュー、インポートは 1 つだけなので、先にアクティブな実行が終わるのを待ってください。\n\n閲覧とインポートの流れについては、[オンラインドキュメントとドライブファイルのインポート](/ja/api-reference/guides/knowledge-base#import-online-documents-and-drive-files) を参照してください。","deprecated":null,"version":null,"sidebarTitle":"ソースのアイテムをインポート","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/sources/{source_id}/workflow-imports","href":"/ja/api-reference/source-syncs-and-imports/import-source-items"},{"title":"ソースの実行一覧を取得","deprecated":null,"version":null,"sidebarTitle":"ソースの実行一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows","href":"/ja/api-reference/source-syncs-and-imports/list-source-runs"},{"title":"ソースの実行を取得","deprecated":null,"version":null,"sidebarTitle":"ソースの実行を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}","href":"/ja/api-reference/source-syncs-and-imports/get-source-run"},{"title":"ソースの実行をキャンセル","deprecated":null,"version":null,"sidebarTitle":"ソースの実行をキャンセル","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/cancel","href":"/ja/api-reference/source-syncs-and-imports/cancel-source-run"},{"title":"ソースの実行を再試行","deprecated":null,"version":null,"sidebarTitle":"ソースの実行を再試行","openapi":"/ja/api-reference/openapi_service.json post /knowledge-fs/spaces/{knowledge_base_id}/source-workflows/{run_id}/retry","href":"/ja/api-reference/source-syncs-and-imports/retry-source-run"}]},{"group":"設定","pages":[{"title":"ナレッジベース設定を取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベース設定を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/ja/api-reference/settings/get-knowledge-base-settings"},{"title":"ナレッジベース設定を更新","deprecated":null,"version":null,"sidebarTitle":"ナレッジベース設定を更新","openapi":"/ja/api-reference/openapi_service.json patch /knowledge-fs/spaces/{knowledge_base_id}/settings","href":"/ja/api-reference/settings/update-knowledge-base-settings"},{"title":"設定の移行を取得","deprecated":null,"version":null,"sidebarTitle":"設定の移行を取得","openapi":"/ja/api-reference/openapi_service.json get /knowledge-fs/spaces/{knowledge_base_id}/settings/migrations/{migration_id}","href":"/ja/api-reference/settings/get-settings-migration"}]}]},{"group":"従来型ナレッジベース","pages":[{"group":"ナレッジベース","pages":[{"title":"空のナレッジベースを作成","deprecated":null,"version":null,"sidebarTitle":"空のナレッジベースを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets","href":"/ja/api-reference/knowledge-bases/create-an-empty-knowledge-base"},{"title":"ナレッジベースリストを取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets","href":"/ja/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"ナレッジベース詳細を取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベース詳細を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}","href":"/ja/api-reference/knowledge-bases/get-knowledge-base"},{"title":"ナレッジベースを更新","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースを更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}","href":"/ja/api-reference/knowledge-bases/update-knowledge-base"},{"title":"ナレッジベースを削除","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}","href":"/ja/api-reference/knowledge-bases/delete-knowledge-base"},{"title":"ナレッジベースからチャンクを取得 / テスト検索","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースからチャンクを取得 / テスト検索","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/retrieve","href":"/ja/api-reference/knowledge-bases/retrieve-chunks-from-a-knowledge-base-test-retrieval"}]},{"group":"ドキュメント","pages":[{"title":"テキストからドキュメントを作成","deprecated":null,"version":null,"sidebarTitle":"テキストからドキュメントを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-text","href":"/ja/api-reference/documents/create-document-by-text"},{"title":"ファイルからドキュメントを作成","deprecated":null,"version":null,"sidebarTitle":"ファイルからドキュメントを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/document/create-by-file","href":"/ja/api-reference/documents/create-document-by-file"},{"title":"ナレッジベースのドキュメントリストを取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースのドキュメントリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents","href":"/ja/api-reference/documents/list-documents"},{"title":"ドキュメント詳細を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメント詳細を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}","href":"/ja/api-reference/documents/get-document"},{"title":"ドキュメントを削除","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}","href":"/ja/api-reference/documents/delete-document"},{"title":"ドキュメントを更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}","href":"/ja/api-reference/documents/update-document"},{"title":"ドキュメントをダウンロード","deprecated":null,"version":null,"sidebarTitle":"ドキュメントをダウンロード","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/download","href":"/ja/api-reference/documents/download-document"},{"title":"ドキュメント埋め込みステータス(進捗)を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメント埋め込みステータス(進捗)を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{batch}/indexing-status","href":"/ja/api-reference/documents/get-document-indexing-status"},{"title":"テキストでドキュメントを更新","deprecated":null,"version":null,"sidebarTitle":"テキストでドキュメントを更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-text","href":"/ja/api-reference/documents/update-document-by-text"},{"title":"ファイルでドキュメントを更新","deprecated":true,"version":null,"sidebarTitle":"ファイルでドキュメントを更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/update-by-file","href":"/ja/api-reference/documents/update-document-by-file"},{"title":"ドキュメントを一括ダウンロード(ZIP)","deprecated":null,"version":null,"sidebarTitle":"ドキュメントを一括ダウンロード(ZIP)","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/download-zip","href":"/ja/api-reference/documents/download-documents-as-zip"},{"title":"ドキュメントステータスを一括更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメントステータスを一括更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/status/{action}","href":"/ja/api-reference/documents/update-document-status-in-batch"}]},{"group":"チャンク","pages":[{"title":"ドキュメントにチャンクを追加","deprecated":null,"version":null,"sidebarTitle":"ドキュメントにチャンクを追加","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments","href":"/ja/api-reference/chunks/create-chunks"},{"title":"チャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"チャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments","href":"/ja/api-reference/chunks/list-chunks"},{"title":"ドキュメント内のチャンク詳細を取得","deprecated":null,"version":null,"sidebarTitle":"ドキュメント内のチャンク詳細を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/ja/api-reference/chunks/get-chunk"},{"title":"ドキュメント内のチャンクを更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメント内のチャンクを更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/ja/api-reference/chunks/update-chunk"},{"title":"ドキュメント内のチャンクを削除","deprecated":null,"version":null,"sidebarTitle":"ドキュメント内のチャンクを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}","href":"/ja/api-reference/chunks/delete-chunk"},{"title":"子チャンクを作成","deprecated":null,"version":null,"sidebarTitle":"子チャンクを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/ja/api-reference/chunks/create-child-chunk"},{"title":"子チャンク一覧を取得","deprecated":null,"version":null,"sidebarTitle":"子チャンク一覧を取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks","href":"/ja/api-reference/chunks/list-child-chunks"},{"title":"子チャンクを更新","deprecated":null,"version":null,"sidebarTitle":"子チャンクを更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/ja/api-reference/chunks/update-child-chunk"},{"title":"子チャンクを削除","deprecated":null,"version":null,"sidebarTitle":"子チャンクを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}","href":"/ja/api-reference/chunks/delete-child-chunk"}]},{"group":"メタデータ","pages":[{"title":"メタデータフィールドを作成","deprecated":null,"version":null,"sidebarTitle":"メタデータフィールドを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata","href":"/ja/api-reference/metadata/create-metadata-field"},{"title":"メタデータフィールドリストを取得","deprecated":null,"version":null,"sidebarTitle":"メタデータフィールドリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata","href":"/ja/api-reference/metadata/list-metadata-fields"},{"title":"メタデータフィールドを更新","deprecated":null,"version":null,"sidebarTitle":"メタデータフィールドを更新","openapi":"/ja/api-reference/openapi_service.json patch /datasets/{dataset_id}/metadata/{metadata_id}","href":"/ja/api-reference/metadata/update-metadata-field"},{"title":"メタデータフィールドを削除","deprecated":null,"version":null,"sidebarTitle":"メタデータフィールドを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/{dataset_id}/metadata/{metadata_id}","href":"/ja/api-reference/metadata/delete-metadata-field"},{"title":"組み込みメタデータフィールドを取得","deprecated":null,"version":null,"sidebarTitle":"組み込みメタデータフィールドを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/metadata/built-in","href":"/ja/api-reference/metadata/get-built-in-metadata-fields"},{"title":"組み込みメタデータフィールドを更新","deprecated":null,"version":null,"sidebarTitle":"組み込みメタデータフィールドを更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/metadata/built-in/{action}","href":"/ja/api-reference/metadata/update-built-in-metadata-field"},{"title":"ドキュメントメタデータを一括更新","deprecated":null,"version":null,"sidebarTitle":"ドキュメントメタデータを一括更新","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/documents/metadata","href":"/ja/api-reference/metadata/update-document-metadata-in-batch"}]},{"group":"タグ管理","pages":[{"title":"ナレッジベースタグを作成","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースタグを作成","openapi":"/ja/api-reference/openapi_service.json post /datasets/tags","href":"/ja/api-reference/tags/create-knowledge-tag"},{"title":"ナレッジベースタグリストを取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースタグリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/tags","href":"/ja/api-reference/tags/list-knowledge-tags"},{"title":"ナレッジベースタグを変更","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースタグを変更","openapi":"/ja/api-reference/openapi_service.json patch /datasets/tags","href":"/ja/api-reference/tags/update-knowledge-tag"},{"title":"ナレッジベースタグを削除","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースタグを削除","openapi":"/ja/api-reference/openapi_service.json delete /datasets/tags","href":"/ja/api-reference/tags/delete-knowledge-tag"},{"title":"タグをナレッジベースにバインド","deprecated":null,"version":null,"sidebarTitle":"タグをナレッジベースにバインド","openapi":"/ja/api-reference/openapi_service.json post /datasets/tags/binding","href":"/ja/api-reference/tags/create-tag-binding"},{"title":"タグとナレッジベースのバインドを解除","deprecated":null,"version":null,"sidebarTitle":"タグとナレッジベースのバインドを解除","openapi":"/ja/api-reference/openapi_service.json post /datasets/tags/unbinding","href":"/ja/api-reference/tags/delete-tag-binding"},{"title":"ナレッジベースにバインドされたタグを取得","deprecated":null,"version":null,"sidebarTitle":"ナレッジベースにバインドされたタグを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/tags","href":"/ja/api-reference/tags/get-knowledge-base-tags"}]},{"group":"モデル","pages":[{"title":"利用可能なモデルを取得","deprecated":null,"version":null,"sidebarTitle":"利用可能なモデルを取得","openapi":"/ja/api-reference/openapi_service.json get /workspaces/current/models/model-types/{model_type}","href":"/ja/api-reference/models/get-available-models"}]},{"group":"ナレッジパイプライン","pages":[{"title":"パイプラインファイルをアップロード","deprecated":null,"version":null,"sidebarTitle":"パイプラインファイルをアップロード","openapi":"/ja/api-reference/openapi_service.json post /datasets/pipeline/file-upload","href":"/ja/api-reference/knowledge-pipeline/upload-pipeline-file"},{"title":"データソースプラグインリストを取得","deprecated":null,"version":null,"sidebarTitle":"データソースプラグインリストを取得","openapi":"/ja/api-reference/openapi_service.json get /datasets/{dataset_id}/pipeline/datasource-plugins","href":"/ja/api-reference/knowledge-pipeline/list-datasource-plugins"},{"title":"データソースノードを実行","deprecated":null,"version":null,"sidebarTitle":"データソースノードを実行","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run","href":"/ja/api-reference/knowledge-pipeline/run-datasource-node"},{"title":"パイプラインを実行","deprecated":null,"version":null,"sidebarTitle":"パイプラインを実行","openapi":"/ja/api-reference/openapi_service.json post /datasets/{dataset_id}/pipeline/run","href":"/ja/api-reference/knowledge-pipeline/run-pipeline"}]}]}]}]},{"item":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/ja/cli/overview"}]},{"item":"プラグイン開発","icon":"code-pull-request","pages":[{"title":"プラグイン開発","href":"/ja/develop-plugin/getting-started/getting-started-dify-plugin"}]}]}]}]}]},"title":"ウェブサイトのページをインポート - Dify Docs","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-R3M_BF4L.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}