Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).
Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).
{"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":"6aec24fa6ea3dafcfecba34c","collectionId":"9e9dee91-dda1-4f9e-b850-8ef0c086a40c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec24fa6ea3dafcfecba34c"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aed9527585ea7191d52f3fa","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"en","tag":"Self-Host","count":328},{"language":"ja","tag":"セルフホスト","count":328},{"language":"zh","tag":"自部署","count":328},{"language":"en","tag":"Developer Resources","count":206},{"language":"ja","tag":"開発者リソース","count":206},{"language":"zh","tag":"开发者资源","count":206},{"language":"en","tag":"Use","count":195},{"language":"ja","tag":"使い方","count":195},{"language":"zh","tag":"使用","count":195},{"language":"en","tag":"API","count":154},{"language":"ja","tag":"API","count":154},{"language":"zh","tag":"API","count":154},{"language":"en","tag":"Knowledge APIs","count":106},{"language":"ja","tag":"ナレッジ API","count":106},{"language":"zh","tag":"知识库 API","count":106},{"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":69},{"language":"ja","tag":"Agent ナレッジベース","count":69},{"language":"zh","tag":"Agent 知识库","count":69},{"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":[],"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=\"/zh/home\"] .nav-tabs,html[data-current-path=\"/ja/home\"] .nav-tabs{display:none}#sidebar-content a[href=\"/en/home\"],#sidebar-content a[href=\"/zh/home\"],#sidebar-content a[href=\"/ja/home\"],#sidebar-content *:has(>a[href=\"/en/home\"]),#sidebar-content *:has(>a[href=\"/zh/home\"]),#sidebar-content *:has(>a[href=\"/ja/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:none!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":"en/api-reference/documents/update-document-by-text","slug":"/en/api-reference/documents/update-document-by-text","pageMetadata":{"title":"Update Document by Text","description":"Updates a document's text content, name, or processing configuration. Re-indexes the document when its text changes.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates a document’s text content, name, or processing configuration. Re-indexes the document when its text changes.\"\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":"Update Document by Text","description":"Updates a document's text content, name, or processing configuration. Re-indexes the document when its text changes.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/dify-6c0370d8/90066d529e522771/contributing-footer.js"],"openApiReferenceData":{"operation":{"description":"Updates a document's text content, name, or processing configuration. Re-indexes the document when its text changes.","operationId":"updateDocumentByText","parameters":["501dd5c7-ef24-4dc2-a340-669056616663","7636e56c-9305-4b34-92b4-9d96f9267b7c"],"requestBody":"90440bfc-d833-4368-bf89-81f24e9b8b9a","responses":{"200":"cd5107c2-b7cc-4368-a0b4-44e2672c7355","400":"c546f70f-0fa3-4f97-959b-cec606aaf88d","403":"f0c4907e-f267-4c69-b9c9-cfb50845d639","404":"c08771b7-bad0-48b0-92fe-4fb80a34df1a","503":"bcbfbcc6-33b9-41d2-a579-dbea3e62ea2a"},"summary":"Update Document by Text","tags":["Documents"],"x-mint":{"href":"/en/api-reference/documents/update-document-by-text","metadata":{"sidebarTitle":"Update Document by Text","title":"Update Document by Text"}},"method":"post","type":"path","servers":["e3d8eec6-9da0-4bd3-95db-d4f3effeae6a"],"security":["20f91781-67c5-4c44-b7f5-6d48693cb766"],"path":"/datasets/{dataset_id}/documents/{document_id}/update-by-text","baseUrlOptions":["https://{api_base_url}"],"title":"Update Document by Text","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"501dd5c7-ef24-4dc2-a340-669056616663":{"description":"Knowledge base ID, from [List Knowledge Bases](/en/api-reference/knowledge-bases/list-knowledge-bases). For a scoped key, [copy the ID from the Dify URL](/en/api-reference/guides/knowledge#knowledge-base-id).","in":"path","name":"dataset_id","required":true,"schema":{"format":"uuid","type":"string","isRequired":true,"description":"Knowledge base ID, from [List Knowledge Bases](/en/api-reference/knowledge-bases/list-knowledge-bases). For a scoped key, [copy the ID from the Dify URL](/en/api-reference/guides/knowledge#knowledge-base-id).","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"7636e56c-9305-4b34-92b4-9d96f9267b7c":{"description":"Document ID. From [List Documents](/en/api-reference/documents/list-documents).","in":"path","name":"document_id","required":true,"schema":{"format":"uuid","type":"string","isRequired":true,"description":"Document ID. From [List Documents](/en/api-reference/documents/list-documents).","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"doc_form":{"default":"text_model","description":"`text_model` for standard text chunking, `hierarchical_model` for parent-child chunk structure, `qa_model` for question-answer pair extraction.","enum":["text_model","hierarchical_model","qa_model"],"type":"string","uniqueKey":"doc_form","typeLabel":"enum\u003cstring>"},"doc_language":{"default":"English","description":"Language of the document for processing optimization.","type":"string","uniqueKey":"doc_language","typeLabel":"string"},"name":{"description":"Document name. Required when `text` is provided.","type":"string","uniqueKey":"name","typeLabel":"string"},"process_rule":{"description":"Processing rules for chunking.","properties":{"mode":{"description":"`automatic` uses built-in rules, `custom` allows manual configuration, `hierarchical` enables parent-child chunk structure (use with `doc_form: hierarchical_model`).","enum":["automatic","custom","hierarchical"],"type":"string","isRequired":true,"uniqueKey":"process_rule.mode","typeLabel":"enum\u003cstring>"},"rules":{"properties":{"pre_processing_rules":{"items":{"properties":{"enabled":{"description":"Whether this preprocessing rule is enabled.","type":"boolean","uniqueKey":"process_rule.rules.pre_processing_rules.items.[INDEX].enabled","typeLabel":"boolean"},"id":{"description":"Rule identifier.","enum":["remove_stopwords","remove_extra_spaces","remove_urls_emails"],"type":"string","uniqueKey":"process_rule.rules.pre_processing_rules.items.[INDEX].id","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"process_rule.rules.pre_processing_rules.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"process_rule.rules.pre_processing_rules","typeLabel":"object[]"},"segmentation":{"properties":{"chunk_overlap":{"default":0,"description":"Token overlap between chunks.","minimum":0,"type":"integer","uniqueKey":"process_rule.rules.segmentation.chunk_overlap","typeLabel":"integer"},"max_tokens":{"description":"Maximum token count per chunk.","type":"integer","uniqueKey":"process_rule.rules.segmentation.max_tokens","typeLabel":"integer"},"separator":{"default":"\n","description":"Custom separator for splitting text.","type":"string","uniqueKey":"process_rule.rules.segmentation.separator","typeLabel":"string"}},"type":"object","uniqueKey":"process_rule.rules.segmentation","typeLabel":"object"}},"type":"object","uniqueKey":"process_rule.rules","typeLabel":"object"}},"required":["mode"],"type":"object","uniqueKey":"process_rule","typeLabel":"object"},"retrieval_model":{"properties":{"reranking_enable":{"description":"Whether reranking is enabled.","type":"boolean","isRequired":true,"uniqueKey":"retrieval_model.reranking_enable","typeLabel":"boolean"},"score_threshold_enabled":{"description":"Whether score threshold filtering is enabled.","type":"boolean","isRequired":true,"uniqueKey":"retrieval_model.score_threshold_enabled","typeLabel":"boolean"},"search_method":{"description":"Search method used for retrieval.","enum":["keyword_search","semantic_search","full_text_search","hybrid_search"],"type":"string","isRequired":true,"uniqueKey":"retrieval_model.search_method","typeLabel":"enum\u003cstring>"},"top_k":{"description":"Maximum number of results to return.","type":"integer","isRequired":true,"uniqueKey":"retrieval_model.top_k","typeLabel":"integer"},"metadata_filtering_conditions":{"oneOf":[{"description":"Restrict retrieval to chunks whose document metadata matches the given conditions. Conditions are evaluated server-side against document metadata fields.","properties":{"conditions":{"oneOf":[{"description":"List of metadata conditions to evaluate.","items":{"properties":{"comparison_operator":{"description":"Comparison to apply, by metadata type:\n\n- String or array metadata: `contains`, `not contains`, `start with`, `end with`, `is`, `is not`, `empty`, `not empty`, `in`, `not in`\n- Numeric metadata: `=`, `≠`, `>`, `\u003c`, `≥`, `≤`\n- Time metadata: `before`, `after`\n\nThe negative operators `not contains`, `is not`, `≠`, and `not in` also match documents that have no value for that metadata field.","enum":["contains","not contains","start with","end with","is","is not","empty","not empty","in","not in","=","≠",">","\u003c","≥","≤","before","after"],"type":"string","isRequired":true,"uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0.items.[INDEX].comparison_operator","typeLabel":"enum\u003cstring>"},"name":{"description":"Metadata field name to compare against.","type":"string","isRequired":true,"uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`.","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0.items.[INDEX].value.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`.","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0.items.[INDEX].value.oneOf.1","typeLabel":"string[]"},{"type":"number","description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`.","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0.items.[INDEX].value.oneOf.2","typeLabel":"number"},{"type":"null","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0.items.[INDEX].value.oneOf.3","typeLabel":"null"}],"uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0.items.[INDEX].value","typeLabel":"string | string[] | number | null"}},"required":["name","comparison_operator"],"type":"object","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.0","typeLabel":"object[]"},{"description":"List of metadata conditions to evaluate.","items":{"properties":{"comparison_operator":{"description":"Comparison to apply, by metadata type:\n\n- String or array metadata: `contains`, `not contains`, `start with`, `end with`, `is`, `is not`, `empty`, `not empty`, `in`, `not in`\n- Numeric metadata: `=`, `≠`, `>`, `\u003c`, `≥`, `≤`\n- Time metadata: `before`, `after`\n\nThe negative operators `not contains`, `is not`, `≠`, and `not in` also match documents that have no value for that metadata field.","enum":["contains","not contains","start with","end with","is","is not","empty","not empty","in","not in","=","≠",">","\u003c","≥","≤","before","after"],"type":"string"},"name":{"description":"Metadata field name to compare against.","type":"string"},"value":{"oneOf":[{"type":"string","description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`."},{"type":"array","items":{"type":"string"},"description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`."},{"type":"number","description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`."},{"type":"null"}]}},"required":["name","comparison_operator"],"type":"object"},"type":"null","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.conditions","typeLabel":"object[] | null"},"logical_operator":{"oneOf":[{"default":"and","description":"How to combine multiple conditions.","enum":["and","or"],"type":"string","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.logical_operator.oneOf.0","typeLabel":"enum\u003cstring>"},{"default":"and","description":"How to combine multiple conditions.","enum":["and","or"],"type":"null","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.logical_operator.oneOf.1","typeLabel":"null"}],"uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0.logical_operator","typeLabel":"enum\u003cstring> | null"}},"type":"object","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.0","typeLabel":"object"},{"description":"Restrict retrieval to chunks whose document metadata matches the given conditions. Conditions are evaluated server-side against document metadata fields.","properties":{"conditions":{"oneOf":[{"description":"List of metadata conditions to evaluate.","items":{"properties":{"comparison_operator":{"description":"Comparison to apply, by metadata type:\n\n- String or array metadata: `contains`, `not contains`, `start with`, `end with`, `is`, `is not`, `empty`, `not empty`, `in`, `not in`\n- Numeric metadata: `=`, `≠`, `>`, `\u003c`, `≥`, `≤`\n- Time metadata: `before`, `after`\n\nThe negative operators `not contains`, `is not`, `≠`, and `not in` also match documents that have no value for that metadata field.","enum":["contains","not contains","start with","end with","is","is not","empty","not empty","in","not in","=","≠",">","\u003c","≥","≤","before","after"],"type":"string"},"name":{"description":"Metadata field name to compare against.","type":"string"},"value":{"oneOf":[{"type":"string","description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`."},{"type":"array","items":{"type":"string"},"description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`."},{"type":"number","description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`."},{"type":"null"}]}},"required":["name","comparison_operator"],"type":"object"},"type":"array"},{"description":"List of metadata conditions to evaluate.","items":{"properties":{"comparison_operator":{"description":"Comparison to apply, by metadata type:\n\n- String or array metadata: `contains`, `not contains`, `start with`, `end with`, `is`, `is not`, `empty`, `not empty`, `in`, `not in`\n- Numeric metadata: `=`, `≠`, `>`, `\u003c`, `≥`, `≤`\n- Time metadata: `before`, `after`\n\nThe negative operators `not contains`, `is not`, `≠`, and `not in` also match documents that have no value for that metadata field.","enum":["contains","not contains","start with","end with","is","is not","empty","not empty","in","not in","=","≠",">","\u003c","≥","≤","before","after"],"type":"string"},"name":{"description":"Metadata field name to compare against.","type":"string"},"value":{"oneOf":[{"type":"string","description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`."},{"type":"array","items":{"type":"string"},"description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`."},{"type":"number","description":"Value to compare against. Type depends on `comparison_operator`: string for most string operators, array of strings for `in` and `not in`, number for numeric operators, and omitted for `empty` and `not empty`."},{"type":"null"}]}},"required":["name","comparison_operator"],"type":"object"},"type":"null"}]},"logical_operator":{"oneOf":[{"default":"and","description":"How to combine multiple conditions.","enum":["and","or"],"type":"string"},{"default":"and","description":"How to combine multiple conditions.","enum":["and","or"],"type":"null"}]}},"type":"null","uniqueKey":"retrieval_model.metadata_filtering_conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"retrieval_model.metadata_filtering_conditions","typeLabel":"object | null"},"reranking_mode":{"oneOf":[{"description":"Reranking mode. Required when `reranking_enable` is `true`.","enum":["reranking_model","weighted_score"],"type":"string","uniqueKey":"retrieval_model.reranking_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Reranking mode. Required when `reranking_enable` is `true`.","enum":["reranking_model","weighted_score"],"type":"null","uniqueKey":"retrieval_model.reranking_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"retrieval_model.reranking_mode","typeLabel":"enum\u003cstring> | null"},"reranking_model":{"description":"Reranking model configuration.","properties":{"reranking_model_name":{"description":"Name of the reranking model.","type":"string","uniqueKey":"retrieval_model.reranking_model.reranking_model_name","typeLabel":"string"},"reranking_provider_name":{"description":"Reranking model provider identifier, formatted as `organization/plugin_name/provider_name` (e.g. `langgenius/cohere/cohere`). A bare name like `cohere` expands to `langgenius/\u003cname>/\u003cname>` and works only for langgenius-published plugins.\n\nGet valid values from the `provider` field of [Get Available Models](/en/api-reference/models/get-available-models) with `model_type=rerank`.","type":"string","uniqueKey":"retrieval_model.reranking_model.reranking_provider_name","typeLabel":"string"}},"type":"object","uniqueKey":"retrieval_model.reranking_model","typeLabel":"object"},"score_threshold":{"oneOf":[{"description":"Minimum similarity score for results. Only effective when `score_threshold_enabled` is `true`.","type":"number","uniqueKey":"retrieval_model.score_threshold.oneOf.0","typeLabel":"number"},{"description":"Minimum similarity score for results. Only effective when `score_threshold_enabled` is `true`.","type":"null","uniqueKey":"retrieval_model.score_threshold.oneOf.1","typeLabel":"null"}],"uniqueKey":"retrieval_model.score_threshold","typeLabel":"number | null"},"weights":{"oneOf":[{"description":"Weight configuration for hybrid search.","properties":{"keyword_setting":{"description":"Keyword search weight settings.","properties":{"keyword_weight":{"description":"Weight assigned to keyword search results.","type":"number","uniqueKey":"retrieval_model.weights.oneOf.0.keyword_setting.keyword_weight","typeLabel":"number"}},"type":"object","uniqueKey":"retrieval_model.weights.oneOf.0.keyword_setting","typeLabel":"object"},"vector_setting":{"description":"Semantic search weight settings.","properties":{"embedding_model_name":{"description":"Name of the embedding model used for vector search.","type":"string","uniqueKey":"retrieval_model.weights.oneOf.0.vector_setting.embedding_model_name","typeLabel":"string"},"embedding_provider_name":{"description":"Provider of the embedding model used for vector search.","type":"string","uniqueKey":"retrieval_model.weights.oneOf.0.vector_setting.embedding_provider_name","typeLabel":"string"},"vector_weight":{"description":"Weight assigned to semantic (vector) search results.","type":"number","uniqueKey":"retrieval_model.weights.oneOf.0.vector_setting.vector_weight","typeLabel":"number"}},"type":"object","uniqueKey":"retrieval_model.weights.oneOf.0.vector_setting","typeLabel":"object"},"weight_type":{"description":"Strategy for balancing semantic and keyword search weights.","enum":["semantic_first","keyword_first","customized"],"type":"string","uniqueKey":"retrieval_model.weights.oneOf.0.weight_type","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"retrieval_model.weights.oneOf.0","typeLabel":"object"},{"description":"Weight configuration for hybrid search.","properties":{"keyword_setting":{"description":"Keyword search weight settings.","properties":{"keyword_weight":{"description":"Weight assigned to keyword search results.","type":"number"}},"type":"object"},"vector_setting":{"description":"Semantic search weight settings.","properties":{"embedding_model_name":{"description":"Name of the embedding model used for vector search.","type":"string"},"embedding_provider_name":{"description":"Provider of the embedding model used for vector search.","type":"string"},"vector_weight":{"description":"Weight assigned to semantic (vector) search results.","type":"number"}},"type":"object"},"weight_type":{"description":"Strategy for balancing semantic and keyword search weights.","enum":["semantic_first","keyword_first","customized"],"type":"string"}},"type":"null","uniqueKey":"retrieval_model.weights.oneOf.1","typeLabel":"null"}],"uniqueKey":"retrieval_model.weights","typeLabel":"object | null"}},"required":["search_method","reranking_enable","top_k","score_threshold_enabled"],"type":"object","description":"Controls how chunks are searched and ranked when querying this knowledge base.","uniqueKey":"retrieval_model","typeLabel":"object"},"text":{"description":"Document text content.","type":"string","uniqueKey":"text","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"doc_form":"text_model","doc_language":"English","name":"\u003cstring>","text":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"cd5107c2-b7cc-4368-a0b4-44e2672c7355":{"content":{"application/json":{"examples":{"success":{"title":"success","value":{"batch":"20250306150245647595","document":{"archived":false,"created_at":1741267200,"created_by":"ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4","created_from":"api","data_source_detail_dict":{"upload_file":{"created_at":1741267200,"created_by":"ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4","extension":"txt","id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","mime_type":"text/plain","name":"guide.txt","size":2048}},"data_source_info":{"upload_file_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"data_source_type":"upload_file","dataset_process_rule_id":"e1f2a3b4-c5d6-7890-ef12-345678901234","disabled_at":null,"disabled_by":null,"display_status":"available","doc_form":"text_model","doc_metadata":[],"enabled":true,"error":null,"hit_count":0,"id":"a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac","indexing_status":"completed","name":"guide.txt","need_summary":false,"position":1,"summary_index_status":null,"tokens":512,"word_count":350}}}},"schema":{"properties":{"batch":{"description":"Batch ID for tracking indexing progress.","type":"string","uniqueKey":"batch","typeLabel":"string"},"document":{"properties":{"archived":{"description":"Whether the document is archived.","type":"boolean","uniqueKey":"document.archived","typeLabel":"boolean"},"created_at":{"description":"Creation timestamp (Unix epoch in seconds).","type":"number","uniqueKey":"document.created_at","typeLabel":"number"},"created_by":{"description":"ID of the user who created the document.","type":"string","uniqueKey":"document.created_by","typeLabel":"string"},"created_from":{"description":"Origin of the document. `api` for API creation, `web` for UI creation.","type":"string","uniqueKey":"document.created_from","typeLabel":"string"},"data_source_detail_dict":{"description":"Detailed data source information including file details.","type":"object","uniqueKey":"document.data_source_detail_dict","typeLabel":"object"},"data_source_info":{"description":"Raw data source information, varies by `data_source_type`.","type":"object","uniqueKey":"document.data_source_info","typeLabel":"object"},"data_source_type":{"description":"How the document was created. `upload_file` for file uploads, `notion_import` for Notion imports.","type":"string","uniqueKey":"document.data_source_type","typeLabel":"string"},"dataset_process_rule_id":{"description":"ID of the processing rule applied to this document.","type":"string","uniqueKey":"document.dataset_process_rule_id","typeLabel":"string"},"disabled_at":{"oneOf":[{"description":"Timestamp when the document was disabled. `null` if enabled.","type":"number","uniqueKey":"document.disabled_at.oneOf.0","typeLabel":"number"},{"description":"Timestamp when the document was disabled. `null` if enabled.","type":"null","uniqueKey":"document.disabled_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"document.disabled_at","typeLabel":"number | null"},"disabled_by":{"oneOf":[{"description":"ID of the user who disabled the document. `null` if enabled.","type":"string","uniqueKey":"document.disabled_by.oneOf.0","typeLabel":"string"},{"description":"ID of the user who disabled the document. `null` if enabled.","type":"null","uniqueKey":"document.disabled_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"document.disabled_by","typeLabel":"string | null"},"display_status":{"description":"User-facing display status derived from `indexing_status` and `enabled` state.","type":"string","uniqueKey":"document.display_status","typeLabel":"string"},"doc_form":{"description":"Document chunking mode. `text_model` for standard text chunking, `hierarchical_model` for parent-child structure, `qa_model` for QA pair extraction.","type":"string","uniqueKey":"document.doc_form","typeLabel":"string"},"doc_metadata":{"description":"Metadata values assigned to this document.","items":{"properties":{"id":{"description":"Metadata field identifier.","type":"string","uniqueKey":"document.doc_metadata.items.[INDEX].id","typeLabel":"string"},"name":{"description":"Metadata field name.","type":"string","uniqueKey":"document.doc_metadata.items.[INDEX].name","typeLabel":"string"},"type":{"description":"Metadata field value type.","type":"string","uniqueKey":"document.doc_metadata.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Metadata value for this document.","type":"string","uniqueKey":"document.doc_metadata.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"document.doc_metadata.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"document.doc_metadata","typeLabel":"object[]"},"enabled":{"description":"Whether the document is enabled for retrieval.","type":"boolean","uniqueKey":"document.enabled","typeLabel":"boolean"},"error":{"oneOf":[{"description":"Error message if indexing failed. `null` when no error.","type":"string","uniqueKey":"document.error.oneOf.0","typeLabel":"string"},{"description":"Error message if indexing failed. `null` when no error.","type":"null","uniqueKey":"document.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"document.error","typeLabel":"string | null"},"hit_count":{"description":"Number of times the document has been matched in retrieval queries.","type":"integer","uniqueKey":"document.hit_count","typeLabel":"integer"},"id":{"description":"Unique identifier of the document.","type":"string","uniqueKey":"document.id","typeLabel":"string"},"indexing_status":{"description":"Current indexing status. `waiting` for queued, `parsing` while extracting content, `cleaning` while removing noise, `splitting` while chunking, `indexing` while building vectors, `completed` when ready, `error` if failed, `paused` if manually paused.","type":"string","uniqueKey":"document.indexing_status","typeLabel":"string"},"name":{"description":"Document name.","type":"string","uniqueKey":"document.name","typeLabel":"string"},"need_summary":{"description":"Whether a summary needs to be generated for this document.","type":"boolean","uniqueKey":"document.need_summary","typeLabel":"boolean"},"position":{"description":"Display position of the document in the list.","type":"integer","uniqueKey":"document.position","typeLabel":"integer"},"summary_index_status":{"oneOf":[{"description":"Status of the summary index for this document. `null` if summary indexing is not configured.","type":"string","uniqueKey":"document.summary_index_status.oneOf.0","typeLabel":"string"},{"description":"Status of the summary index for this document. `null` if summary indexing is not configured.","type":"null","uniqueKey":"document.summary_index_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"document.summary_index_status","typeLabel":"string | null"},"tokens":{"description":"Total number of tokens in the document.","type":"integer","uniqueKey":"document.tokens","typeLabel":"integer"},"word_count":{"description":"Total word count of the document.","type":"integer","uniqueKey":"document.word_count","typeLabel":"integer"}},"type":"object","uniqueKey":"document","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"description":"Document updated successfully.","exampleType":"examples"},"c546f70f-0fa3-4f97-959b-cec606aaf88d":{"content":{"application/json":{"examples":{"invalid_param_name":{"title":"invalid_param_name","value":{"code":"invalid_param","message":"name is required when text is provided.","status":400}},"invalid_param_not_available":{"title":"invalid_param_not_available","value":{"code":"invalid_param","message":"Document is not available","status":400}},"provider_not_initialize":{"title":"provider_not_initialize","value":{"code":"provider_not_initialize","message":"No valid model provider credentials found. Please go to Settings -> Model Provider to complete your provider credentials.","status":400}}},"exampleType":"examples"}},"description":"- `provider_not_initialize` : No model provider credentials are configured for the workspace.\n- `invalid_param` : `name` is required when `text` is provided, or `doc_form` is invalid.\n- `invalid_param` : The document is not available for update (only available documents can be updated).","exampleType":"examples"},"f0c4907e-f267-4c69-b9c9-cfb50845d639":{"content":{"application/json":{"examples":{"forbidden_1":{"title":"forbidden_1","value":{"code":"forbidden","message":"Dataset api access is not enabled.","status":403}},"forbidden_2":{"title":"forbidden_2","value":{"code":"forbidden","message":"The capacity of the vector space has reached the limit of your subscription.","status":403}},"forbidden_3":{"title":"forbidden_3","value":{"code":"forbidden","message":"Sorry, you have reached the knowledge base request rate limit of your subscription.","status":403}},"forbidden_4":{"title":"forbidden_4","value":{"code":"forbidden","message":"The API key is not authorized to access this knowledge base.","status":403}}},"exampleType":"examples"}},"description":"- `forbidden` : Knowledge base API access is not enabled.\n- `forbidden` : The capacity of the vector space has reached the limit of your subscription.\n- `forbidden` : Sorry, you have reached the knowledge base request rate limit of your subscription.\n- `forbidden` : The API key is scoped to specific knowledge bases, and this knowledge base is not one of them.","exampleType":"examples"},"c08771b7-bad0-48b0-92fe-4fb80a34df1a":{"content":{"application/json":{"examples":{"not_found_1":{"title":"not_found_1","value":{"code":"not_found","message":"Dataset not found.","status":404}},"not_found_2":{"title":"not_found_2","value":{"code":"not_found","message":"Document not found.","status":404}}},"exampleType":"examples"}},"description":"- `not_found` : Knowledge base not found.\n- `not_found` : Document not found.","exampleType":"examples"},"bcbfbcc6-33b9-41d2-a579-dbea3e62ea2a":{"content":{"application/json":{"examples":{"service_unavailable":{"title":"service_unavailable","value":{"code":"service_unavailable","message":"Unable to verify vector space usage right now. Please try again later.","status":503}}},"exampleType":"examples"}},"description":"`service_unavailable` : Vector space usage could not be verified. Returned on the Dify Cloud Sandbox plan only; retry the request later.","exampleType":"examples"}},"security":{"20f91781-67c5-4c44-b7f5-6d48693cb766":{"ApiKeyAuth":{"bearerFormat":"API_KEY","description":"Every request authenticates with an API key: `Authorization: Bearer {API_KEY}`. App endpoints take an app API key; knowledge endpoints take a knowledge base API key ([Get Started](/en/api-reference/guides/get-started)).\n\nKeep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP `401` (`unauthorized`).","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"e3d8eec6-9da0-4bd3-95db-d4f3effeae6a":{"description":"Base URL of the Dify Service API. For self-hosted deployments, replace it with your own API base URL.","url":"https://{api_base_url}","variables":{"api_base_url":{"default":"api.dify.ai/v1","description":"Host and path of the API base URL, without the `https://` prefix."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"API_KEY","description":"Every request authenticates with an API key: `Authorization: Bearer {API_KEY}`. App endpoints take an app API key; knowledge endpoints take a knowledge base API key ([Get Started](/en/api-reference/guides/get-started)).\n\nKeep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP `401` (`unauthorized`).","scheme":"bearer","type":"http","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Every request authenticates with an API key: `Authorization: Bearer {API_KEY}`. App endpoints take an app API key; knowledge endpoints take a knowledge base API key ([Get Started](/en/api-reference/guides/get-started)).\n\nKeep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP `401` (`unauthorized`).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"en/api-reference/openapi_service.json"},"subdomain":"dify-6c0370d8","siteName":"Dify Docs","title":"Update Document by Text - Dify Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"en/api-reference/documents/update-document-by-text.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=\"Updates a document\u0026#x27;s text content, name, or processing configuration. Re-indexes the document when its text changes.\">\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=\"Update Document by Text - Dify Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a document\u0026#x27;s text content, name, or processing configuration. Re-indexes the document when its text changes.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dify Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dify.ai/en/api-reference/documents/update-document-by-text\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dify-6c0370d8.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Update+Document+by+Text\u0026amp;description=Updates+a+document%27s+text+content%2C+name%2C+or+processing+configuration.+Re-indexes+the+document+when+its+text+changes.\u0026amp;theme=fc270d2c96587e5833522f0e\u0026amp;signature=ec7d4cac80e97560c9174b0ebdfd4a0d88f86efaf4b79a517d369657b4b6e79e\">\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=\"Update Document by Text - Dify Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a document\u0026#x27;s text content, name, or processing configuration. Re-indexes the document when its text changes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dify-6c0370d8.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Update+Document+by+Text\u0026amp;description=Updates+a+document%27s+text+content%2C+name%2C+or+processing+configuration.+Re-indexes+the+document+when+its+text+changes.\u0026amp;theme=fc270d2c96587e5833522f0e\u0026amp;signature=ec7d4cac80e97560c9174b0ebdfd4a0d88f86efaf4b79a517d369657b4b6e79e\">\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/en/api-reference/documents/update-document-by-text\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/documents/update-document-by-text.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/en/api-reference/documents/update-document-by-text#webpage\",\"url\":\"https://docs.dify.ai/en/api-reference/documents/update-document-by-text\",\"name\":\"Update Document by Text\",\"description\":\"Updates a document's text content, name, or processing configuration. Re-indexes the document when its text changes.\",\"isPartOf\":{\"@id\":\"https://docs.dify.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dify.ai/en/api-reference/documents/update-document-by-text#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dify.ai/en/api-reference/documents/update-document-by-text#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Knowledge APIs\",\"item\":\"https://docs.dify.ai/en/api-reference/queries/create-query-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Classic Knowledge Base\",\"item\":\"https://docs.dify.ai/en/api-reference/knowledge-bases/create-an-empty-knowledge-base\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Documents\",\"item\":\"https://docs.dify.ai/en/api-reference/documents/create-document-by-text\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update Document by Text\",\"item\":\"https://docs.dify.ai/en/api-reference/documents/update-document-by-text\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dify.ai/en/api-reference/documents/update-document-by-text#apireference\",\"headline\":\"Update Document by Text\",\"name\":\"Update Document by Text\",\"description\":\"Updates a document's text content, name, or processing configuration. Re-indexes the document when its text changes.\",\"url\":\"https://docs.dify.ai/en/api-reference/documents/update-document-by-text\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dify.ai/en/api-reference/documents/update-document-by-text#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","href":"/en/cloud/use-dify/getting-started/introduction"}]},{"tab":"Learn","icon":"graduation-cap","pages":[{"title":"Learn","href":"/en/learn/key-concepts"}]},{"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":"Delete Document","deprecated":null,"version":null,"sidebarTitle":"Delete Document","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/en/api-reference/documents-and-chunks/delete-document"},{"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","description":"Returns indexing progress for every document in a batch: the current stage and chunk completion counts. Poll until each `indexing_status` reaches `completed` or `error`. Status advances through `waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed`.","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","description":"Deprecated. Use [Update Document](/en/api-reference/documents/update-document) instead. Updates a document by uploading a new file, then re-indexes it.","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","pages":[{"title":"CLI","href":"/en/cli/overview"}]},{"item":"Plugins","icon":"code-pull-request","pages":[{"title":"Plugins","href":"/en/develop-plugin/getting-started/getting-started-dify-plugin"}]}]}]},{"product":"Self-Host","icon":"server","tabs":[{"tab":"Deploy","icon":"server","pages":[{"title":"Deploy","href":"/en/self-host/deploy/overview"}]},{"tab":"Use","icon":"book-open","pages":[{"title":"Use","href":"/en/self-host/use-dify/getting-started/introduction"}]},{"tab":"Learn","icon":"graduation-cap","pages":[{"title":"Learn","href":"/en/learn/key-concepts"}]},{"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":"Delete Document","deprecated":null,"version":null,"sidebarTitle":"Delete Document","openapi":"/en/api-reference/openapi_service.json delete /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/en/api-reference/documents-and-chunks/delete-document"},{"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","description":"Returns indexing progress for every document in a batch: the current stage and chunk completion counts. Poll until each `indexing_status` reaches `completed` or `error`. Status advances through `waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed`.","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","description":"Deprecated. Use [Update Document](/en/api-reference/documents/update-document) instead. Updates a document by uploading a new file, then re-indexes it.","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","pages":[{"title":"CLI","href":"/en/cli/overview"}]},{"item":"Plugins","icon":"code-pull-request","pages":[{"title":"Plugins","href":"/en/develop-plugin/getting-started/getting-started-dify-plugin"}]}]}]}]},{"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":"发布应用到 Marketplace","sidebarTitle":"Marketplace","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 delete /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/zh/api-reference/documents-and-chunks/delete-document"},{"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":"发布插件到 Marketplace","sidebarTitle":"Marketplace","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":"发布应用到 Marketplace","sidebarTitle":"Marketplace","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 delete /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/zh/api-reference/documents-and-chunks/delete-document"},{"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":"发布插件到 Marketplace","sidebarTitle":"Marketplace","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":"Dify の使い方","sidebarTitle":"概要","mode":"frame","href":"/ja/cloud/use-dify/getting-started/introduction"},{"title":"Dify ドキュメント","mode":"custom","hidden":true,"href":"/ja/home"},{"group":"オーケストレーション","icon":"hammer","pages":[{"group":"Workflow と Chatflow","expanded":false,"pages":[{"title":"Workflow と Chatflow","sidebarTitle":"概要","href":"/ja/cloud/use-dify/build/workflow-chatflow"},{"title":"オーケストレーションロジック","href":"/ja/cloud/use-dify/build/orchestrate-node"},{"group":"ノード","expanded":false,"pages":[{"group":"開始","root":{"title":"開始ノード","href":"/ja/cloud/use-dify/nodes/start"},"pages":[{"title":"ユーザー入力","href":"/ja/cloud/use-dify/nodes/user-input"},{"group":"トリガー","root":{"title":"トリガー","sidebarTitle":"概要","href":"/ja/cloud/use-dify/nodes/trigger/overview"},"pages":[{"title":"スケジュールトリガー","href":"/ja/cloud/use-dify/nodes/trigger/schedule-trigger"},{"title":"インテグレーショントリガー","href":"/ja/cloud/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook トリガー","href":"/ja/cloud/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"LLM","href":"/ja/cloud/use-dify/nodes/llm"},{"title":"Agent ナレッジ検索","href":"/ja/cloud/use-dify/nodes/knowledge-retrieval-v2"},{"title":"従来型の知識検索","href":"/ja/cloud/use-dify/nodes/knowledge-retrieval"},{"title":"答え","href":"/ja/cloud/use-dify/nodes/answer"},{"title":"出力","href":"/ja/cloud/use-dify/nodes/output"},{"title":"Agent","href":"/ja/cloud/use-dify/nodes/agent"},{"title":"質問分類器","href":"/ja/cloud/use-dify/nodes/question-classifier"},{"title":"If-Else","href":"/ja/cloud/use-dify/nodes/ifelse"},{"group":"人間の入力","root":{"title":"人間の入力","href":"/ja/cloud/use-dify/nodes/human-input"},"expanded":false,"pages":[]},{"title":"反復処理","href":"/ja/cloud/use-dify/nodes/iteration"},{"title":"ループ","href":"/ja/cloud/use-dify/nodes/loop"},{"title":"コード","href":"/ja/cloud/use-dify/nodes/code"},{"title":"テンプレート","href":"/ja/cloud/use-dify/nodes/template"},{"title":"変数集約器","href":"/ja/cloud/use-dify/nodes/variable-aggregator"},{"title":"テキスト抽出","href":"/ja/cloud/use-dify/nodes/doc-extractor"},{"title":"変数アサイナー","href":"/ja/cloud/use-dify/nodes/variable-assigner"},{"title":"パラメータ抽出器","href":"/ja/cloud/use-dify/nodes/parameter-extractor"},{"title":"HTTP リクエスト","href":"/ja/cloud/use-dify/nodes/http-request"},{"title":"リスト演算子","href":"/ja/cloud/use-dify/nodes/list-operator"},{"title":"ツールノード","sidebarTitle":"ツール","href":"/ja/cloud/use-dify/nodes/tools"}]},{"title":"ホットキー","href":"/ja/cloud/use-dify/build/shortcut-key"},{"title":"バージョン管理","href":"/ja/cloud/use-dify/build/version-control"},{"title":"スニペット","href":"/ja/cloud/use-dify/build/snippet"},{"group":"デバッグ","expanded":false,"pages":[{"title":"エラーの処理","href":"/ja/cloud/use-dify/build/predefined-error-handling-logic"},{"title":"単一ノード","href":"/ja/cloud/use-dify/debug/step-run"},{"title":"変数インスペクター","href":"/ja/cloud/use-dify/debug/variable-inspect"},{"title":"実行履歴","href":"/ja/cloud/use-dify/debug/history-and-logs"},{"title":"エラータイプ","href":"/ja/cloud/use-dify/debug/error-type"}]}]},{"group":"Agent","tag":"New","expanded":false,"pages":[{"title":"Agent","sidebarTitle":"概要","href":"/ja/cloud/use-dify/build/new-agent/overview"},{"title":"Agent の構築","sidebarTitle":"構築","href":"/ja/cloud/use-dify/build/new-agent/build"}]},{"group":"基本アプリ","expanded":false,"pages":[{"title":"Agent","tag":"Legacy","href":"/ja/cloud/use-dify/build/agent"},{"title":"チャットボット","sidebarTitle":"チャットボット","href":"/ja/cloud/use-dify/build/chatbot"},{"title":"テキストジェネレーター","sidebarTitle":"テキストジェネレーター","href":"/ja/cloud/use-dify/build/text-generator"}]},{"title":"アプリツールキット","href":"/ja/cloud/use-dify/build/additional-features"},{"title":"グローバル検索","href":"/ja/cloud/use-dify/build/goto-anything"}]},{"group":"公開","icon":"paper-plane","expanded":false,"pages":[{"title":"AI アプリの共有","href":"/ja/cloud/use-dify/publish/README"},{"title":"IP アクセス制御","href":"/ja/cloud/use-dify/publish/ip-access-control"},{"group":"Web アプリ","pages":[{"title":"Workflow Web アプリ","href":"/ja/cloud/use-dify/publish/webapp/workflow-webapp"},{"title":"チャット Web アプリ","href":"/ja/cloud/use-dify/publish/webapp/chatflow-webapp"},{"title":"設定","href":"/ja/cloud/use-dify/publish/webapp/web-app-settings"},{"title":"Web アプリの埋め込み","sidebarTitle":"埋め込み","href":"/ja/cloud/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP サーバー","href":"/ja/cloud/use-dify/publish/publish-mcp"},{"title":"アプリをマーケットプレイスに公開","sidebarTitle":"マーケットプレイス","href":"/ja/cloud/use-dify/publish/publish-to-marketplace"}]},{"group":"モニタリング","icon":"chart-line","expanded":false,"pages":[{"title":"ダッシュボード","href":"/ja/cloud/use-dify/monitor/analysis"},{"title":"ログ","href":"/ja/cloud/use-dify/monitor/logs"},{"title":"注釈システム","href":"/ja/cloud/use-dify/monitor/annotation-reply"},{"group":"インテグレーション","pages":[{"title":"LangSmith の統合","href":"/ja/cloud/use-dify/monitor/integrations/integrate-langsmith"},{"title":"Langfuse の統合","href":"/ja/cloud/use-dify/monitor/integrations/integrate-langfuse"},{"title":"Opik の統合","href":"/ja/cloud/use-dify/monitor/integrations/integrate-opik"},{"title":"W\u0026B Weave の統合","sidebarTitle":"W\u0026B Weave","href":"/ja/cloud/use-dify/monitor/integrations/integrate-weave"},{"title":"Arize の統合","href":"/ja/cloud/use-dify/monitor/integrations/integrate-arize"},{"title":"Phoenix の統合","href":"/ja/cloud/use-dify/monitor/integrations/integrate-phoenix"},{"title":"Alibaba Cloud Monitor の統合","href":"/ja/cloud/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"ナレッジ","icon":"book","expanded":false,"pages":[{"title":"ナレッジ","sidebarTitle":"概要","href":"/ja/cloud/use-dify/knowledge/overview"},{"group":"Agent ナレッジベース","tag":"New","expanded":false,"pages":[{"title":"Agent ナレッジベース","sidebarTitle":"概要","href":"/ja/cloud/use-dify/knowledge-base/overview"},{"title":"Agent ナレッジベースの作成","sidebarTitle":"作成","href":"/ja/cloud/use-dify/knowledge-base/create-knowledge-base"},{"title":"インデックス済みドキュメントの確認","sidebarTitle":"インデックスの確認","href":"/ja/cloud/use-dify/knowledge-base/review-indexed-documents"},{"title":"検索のテストとチューニング","sidebarTitle":"テストとチューニング","href":"/ja/cloud/use-dify/knowledge-base/test-and-tune"},{"title":"検索設定","sidebarTitle":"検索設定","href":"/ja/cloud/use-dify/knowledge-base/retrieval-settings"},{"title":"アプリ、Agent、コードへの接続","sidebarTitle":"接続","href":"/ja/cloud/use-dify/knowledge-base/use-knowledge-in-apps"},{"title":"マルチモーダル検索","sidebarTitle":"マルチモーダル検索","href":"/ja/cloud/use-dify/knowledge-base/multimodal-retrieval"},{"title":"Agent ナレッジベースのメンテナンス","sidebarTitle":"メンテナンス","href":"/ja/cloud/use-dify/knowledge-base/maintain-knowledge-base"},{"title":"従来型ナレッジベースから Agent ナレッジベースへのアップグレード","sidebarTitle":"従来型からのアップグレード","href":"/ja/cloud/use-dify/knowledge-base/upgrade-from-classic"}]},{"group":"従来型ナレッジベース","expanded":false,"pages":[{"title":"従来型ナレッジベース","sidebarTitle":"概要","href":"/ja/cloud/use-dify/knowledge/readme"},{"group":"作成","pages":[{"group":"すぐに使えるナレッジベースを作成","pages":[{"title":"すぐに使えるナレッジベースを作成","sidebarTitle":"概要","href":"/ja/cloud/use-dify/knowledge/create-knowledge/introduction"},{"group":"データのインポート","pages":[{"title":"ローカルファイルをアップロード","href":"/ja/cloud/use-dify/knowledge/create-knowledge/import-text-data/readme"},{"title":"Notion からデータを同期","href":"/ja/cloud/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion"},{"title":"Web サイトからデータをインポート","href":"/ja/cloud/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website"}]},{"title":"チャンク設定","href":"/ja/cloud/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text"},{"title":"インデックス方法と検索設定を指定","href":"/ja/cloud/use-dify/knowledge/create-knowledge/setting-indexing-methods"}]},{"group":"カスタムナレッジベースを構築","pages":[{"title":"カスタムナレッジベースを構築","sidebarTitle":"概要","href":"/ja/cloud/use-dify/knowledge/knowledge-pipeline/readme"},{"title":"ステップ 1:ナレッジパイプラインの作成","href":"/ja/cloud/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline"},{"title":"ステップ 2:ナレッジパイプラインをオーケストレーションする","href":"/ja/cloud/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration"},{"title":"ステップ 3:ナレッジパイプラインの公開","href":"/ja/cloud/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline"},{"title":"ステップ 4:ファイルのアップロード","href":"/ja/cloud/use-dify/knowledge/knowledge-pipeline/upload-files"},{"title":"ステップ 5:ナレッジベースの管理と活用","href":"/ja/cloud/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base"},{"title":"データソース認証","href":"/ja/cloud/use-dify/knowledge/knowledge-pipeline/authorize-data-source"}]},{"group":"外部ナレッジベースと連携","pages":[{"title":"外部ナレッジベースとの接続","sidebarTitle":"概要","href":"/ja/cloud/use-dify/knowledge/connect-external-knowledge-base"},{"title":"外部ナレッジベース API","href":"/ja/cloud/use-dify/knowledge/external-knowledge-api"}]}]},{"group":"管理","pages":[{"title":"ナレッジコンテンツの管理","sidebarTitle":"ドキュメントとチャンク","href":"/ja/cloud/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents"},{"title":"ドキュメントのメタデータを管理","sidebarTitle":"メタデータ","href":"/ja/cloud/use-dify/knowledge/metadata"},{"title":"ナレッジ設定の管理","sidebarTitle":"設定","href":"/ja/cloud/use-dify/knowledge/manage-knowledge/introduction"}]},{"title":"ナレッジ検索テスト","sidebarTitle":"検索テスト","href":"/ja/cloud/use-dify/knowledge/test-retrieval"},{"title":"アプリ内でのナレッジベース統合","sidebarTitle":"アプリ内で統合","href":"/ja/cloud/use-dify/knowledge/integrate-knowledge-within-application"}]},{"title":"ナレッジベースのリクエストレート制限","sidebarTitle":"リクエストレート制限","href":"/ja/cloud/use-dify/knowledge/knowledge-request-rate-limit"},{"title":"ナレッジベースのストレージ容量とドキュメント数の上限","sidebarTitle":"ストレージとドキュメント数の上限","href":"/ja/cloud/use-dify/knowledge/knowledge-storage-limit"}]},{"group":"統合","icon":"plug","expanded":false,"pages":[{"title":"統合","sidebarTitle":"概要","href":"/ja/cloud/use-dify/workspace/plugins"},{"title":"モデルプロバイダー","href":"/ja/cloud/use-dify/workspace/model-providers"},{"title":"Dify ツール","sidebarTitle":"ツール","href":"/ja/cloud/use-dify/workspace/tools"},{"group":"カスタム API","pages":[{"title":"カスタム API","sidebarTitle":"概要","href":"/ja/cloud/use-dify/workspace/api-extension/api-extension"},{"title":"外部データツール","href":"/ja/cloud/use-dify/workspace/api-extension/external-data-tool-api-extension"},{"title":"センシティブコンテンツ審査","href":"/ja/cloud/use-dify/workspace/api-extension/moderation-api-extension"},{"title":"Cloudflare Workers を使用したカスタム API のデプロイ","href":"/ja/cloud/use-dify/workspace/api-extension/cloudflare-worker"}]}]},{"group":"ワークスペース","icon":"briefcase","expanded":false,"pages":[{"title":"概要","href":"/ja/cloud/use-dify/workspace/readme"},{"title":"アプリのエクスポートとインポート","sidebarTitle":"エクスポートとインポート","href":"/ja/cloud/use-dify/workspace/export-import-apps"},{"title":"メンバーの管理","href":"/ja/cloud/use-dify/workspace/team-members-management"},{"title":"個人設定","href":"/ja/cloud/use-dify/workspace/personal-account-management"},{"title":"請求","href":"/ja/cloud/use-dify/workspace/subscription-management"}]}]},{"tab":"学習","icon":"graduation-cap","pages":[{"title":"主要な概念","href":"/ja/learn/key-concepts"},{"group":"チュートリアル","pages":[{"title":"30 分間クイックスタート","href":"/ja/quick-start"},{"group":"ワークフロー 101","pages":[{"title":"レッスン 1:ワークフローとは?","href":"/ja/learn/tutorials/workflow-101/lesson-01"},{"title":"レッスン 2:フローの頭と尾(開始ノードと出力ノード)","sidebarTitle":"レッスン 2:フローの頭と尾","href":"/ja/learn/tutorials/workflow-101/lesson-02"},{"title":"レッスン 3:ワークフローの頭脳(LLM ノード)","sidebarTitle":"レッスン 3:ワークフローの頭脳","href":"/ja/learn/tutorials/workflow-101/lesson-03"},{"title":"レッスン 4:カンニングペーパー(ナレッジ検索)","sidebarTitle":"レッスン 4:カンニングペーパー","href":"/ja/learn/tutorials/workflow-101/lesson-04"},{"title":"レッスン 5:ワークフローの分岐点(分類と実行)","sidebarTitle":"レッスン 5:ワークフローの分岐点","href":"/ja/learn/tutorials/workflow-101/lesson-05"},{"title":"レッスン 6:複数のタスクを処理する(パラメータ抽出 \u0026 イテレーション)","sidebarTitle":"レッスン 6:複数のタスクを処理する","href":"/ja/learn/tutorials/workflow-101/lesson-06"},{"title":"レッスン 7:ワークフローを強化する(ツール)","sidebarTitle":"レッスン 7:ワークフローを強化する","href":"/ja/learn/tutorials/workflow-101/lesson-07"},{"title":"レッスン 8:エージェントノード","sidebarTitle":"レッスン 8:エージェントノード","href":"/ja/learn/tutorials/workflow-101/lesson-08"},{"title":"レッスン 9:レイアウトデザイナー(テンプレート)","sidebarTitle":"レッスン 9:レイアウトデザイナー","href":"/ja/learn/tutorials/workflow-101/lesson-09"},{"title":"レッスン 10:AI アプリを公開してモニタリングする","sidebarTitle":"レッスン 10:公開とモニタリング","href":"/ja/learn/tutorials/workflow-101/lesson-10"}]},{"title":"シンプルなチャットボット","href":"/ja/learn/tutorials/simple-chatbot"},{"title":"チャットストリームエージェントを使用した Twitter アカウントの分析方法","href":"/ja/learn/tutorials/twitter-chatflow"},{"title":"知識ベースを使用したカスタマーサービスボット","href":"/ja/learn/tutorials/customer-service-bot"},{"title":"ゼロから AI 画像生成アプリの構築方法","href":"/ja/learn/tutorials/build-ai-image-generation-app"},{"title":"ファイルアップロードを使用した記事理解アシスタントの構築方法","href":"/ja/learn/tutorials/article-reader"}]}]},{"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 delete /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/ja/api-reference/documents-and-chunks/delete-document"},{"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":"選択したページをインポート","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":"ソースのアイテムをインポート","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","groups":[{"group":" ","expanded":true,"pages":[{"title":"概要","href":"/ja/cli/overview"},{"title":"クイックスタート","href":"/ja/cli/get-started"},{"title":"コマンドの検索と実行","href":"/ja/cli/find-and-run-commands"},{"group":"アプリの操作","expanded":true,"pages":[{"title":"アプリの構築","sidebarTitle":"構築","href":"/ja/cli/build-apps"},{"title":"アプリの実行","sidebarTitle":"実行","href":"/ja/cli/run-apps"},{"title":"DSL ファイルからのアプリの作成と更新","sidebarTitle":"DSL からの作成・更新","href":"/ja/cli/create-and-update-apps-from-dsl-files"},{"title":"CI と自動化での `difyctl` の使用","sidebarTitle":"CI と自動化","href":"/ja/cli/scripts-and-ci"}]},{"group":"difyctl の管理","expanded":true,"pages":[{"title":"サインインの管理","sidebarTitle":"サインインとセッション","href":"/ja/cli/manage-sign-in"},{"title":"difyctl のアップデートとアンインストール","sidebarTitle":"アップデートとアンインストール","href":"/ja/cli/update-or-uninstall"},{"title":"Dify 1.18.0 へのアップグレード","sidebarTitle":"1.18.0 へのアップグレード","href":"/ja/cli/upgrade-across-1-18"}]},{"group":"リファレンス","expanded":true,"pages":[{"title":"コマンド索引","href":"/ja/cli/reference/command-index"},{"title":"結果、エラー、終了コード","sidebarTitle":"結果とエラー","href":"/ja/cli/reference/results-errors-and-exit-codes"},{"title":"設定","href":"/ja/cli/reference/configuration"}]}]}]},{"item":"プラグイン開発","icon":"code-pull-request","pages":[{"group":"クイックスタート","icon":"rocket","pages":[{"title":"Dify プラグイン","href":"/ja/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"プラグインタイプの選択","href":"/ja/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify プラグイン CLI","href":"/ja/develop-plugin/getting-started/cli"}]},{"group":"特性と仕様","icon":"list-check","pages":[{"group":"プラグインタイプ","pages":[{"title":"一般仕様","href":"/ja/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"モデル仕様","href":"/ja/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"モデル API インターフェース","href":"/ja/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"永続ストレージ","href":"/ja/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"ツールの戻り値","href":"/ja/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/ja/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"多言語 README","href":"/ja/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"プラグインのデバッグ","href":"/ja/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"プラグインのロギング","href":"/ja/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"高度な開発","pages":[{"group":"リバース呼び出し","pages":[{"title":"Bundle プラグインパッケージ","href":"/ja/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Dify サービスの逆呼び出し","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"App","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"モデルの逆呼び出し","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"ツール","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"カスタムモデルの統合","href":"/ja/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"ノード","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"開発ガイドとサンプル","icon":"code","pages":[{"title":"チートシート","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"プラグインタイプ別","pages":[{"title":"ツールプラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"モデルプロバイダープラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"エージェント戦略プラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"データソースプラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"トリガープラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint プラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"完全なサンプル","pages":[{"title":"Flomoツール(10分)","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdownエクスポーター","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"マルチモーダルツール","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"公開","icon":"upload","pages":[{"title":"プラグインの公開","href":"/ja/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"標準","pages":[{"title":"プラグイン開発ガイドライン","href":"/ja/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"プライバシーポリシーガイドライン","href":"/ja/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"マーケットプレイスにプラグインを公開","sidebarTitle":"マーケットプレイス","href":"/ja/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub リポジトリ","pages":[{"title":"個人 GitHub リポジトリへの公開","href":"/ja/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"ローカルファイル","pages":[{"title":"ローカルファイルとしてパッケージ化して共有","href":"/ja/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"サードパーティ署名検証用のプラグイン署名","href":"/ja/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"よくある質問","sidebarTitle":"よくある質問","href":"/ja/develop-plugin/publishing/faq/faq"}]}]}]}]},{"product":"セルフホスト","icon":"server","tabs":[{"tab":"デプロイ","icon":"server","pages":[{"title":"Dify のデプロイ","sidebarTitle":"概要","mode":"frame","href":"/ja/self-host/deploy/overview"},{"group":"クイックスタート","icon":"rocket","pages":[{"title":"Docker Compose で Dify をデプロイする","sidebarTitle":"Docker Compose","href":"/ja/self-host/deploy/quick-start/docker-compose"},{"title":"よくある質問","href":"/ja/self-host/deploy/quick-start/faqs"}]},{"group":"高度なデプロイ","icon":"server","pages":[{"title":"ローカルソースコードからの起動","href":"/ja/self-host/deploy/advanced-deployments/local-source-code"},{"title":"フロントコンテナ起動","href":"/ja/self-host/deploy/advanced-deployments/start-the-frontend-docker-container"}]},{"group":"設定","icon":"gear","pages":[{"title":"環境変数","href":"/ja/self-host/deploy/configuration/environments"}]},{"group":"プラットフォームガイド","icon":"map","pages":[{"title":"aaPanelでのデプロイ","href":"/ja/self-host/deploy/platform-guides/bt-panel"},{"title":"AWS 上の Dify Premium","href":"/ja/self-host/deploy/platform-guides/dify-premium"}]},{"group":"トラブルシューティング","icon":"wrench","pages":[{"title":"よくある問題","href":"/ja/self-host/deploy/troubleshooting/common-issues"},{"title":"Dockerの問題","href":"/ja/self-host/deploy/troubleshooting/docker-issues"},{"title":"サードパーティ統合","href":"/ja/self-host/deploy/troubleshooting/integrations"},{"title":"ストレージとマイグレーション","href":"/ja/self-host/deploy/troubleshooting/storage-and-migration"},{"title":"Weaviate 移行ガイド:クライアント v4 とサーバー 1.27+ へのアップグレード","href":"/ja/self-host/deploy/troubleshooting/weaviate-v4-migration"},{"title":"Weaviate サーバーのアップグレード経路","href":"/ja/self-host/deploy/troubleshooting/weaviate-server-migration-path"}]}]},{"tab":"使い方","icon":"book-open","pages":[{"title":"Dify の使い方","sidebarTitle":"概要","mode":"frame","href":"/ja/self-host/use-dify/getting-started/introduction"},{"group":"オーケストレーション","icon":"hammer","pages":[{"group":"Workflow と Chatflow","expanded":false,"pages":[{"title":"Workflow と Chatflow","sidebarTitle":"概要","href":"/ja/self-host/use-dify/build/workflow-chatflow"},{"title":"オーケストレーションロジック","href":"/ja/self-host/use-dify/build/orchestrate-node"},{"group":"ノード","expanded":false,"pages":[{"group":"開始","root":{"title":"開始ノード","href":"/ja/self-host/use-dify/nodes/start"},"pages":[{"title":"ユーザー入力","href":"/ja/self-host/use-dify/nodes/user-input"},{"group":"トリガー","root":{"title":"トリガー","sidebarTitle":"概要","href":"/ja/self-host/use-dify/nodes/trigger/overview"},"pages":[{"title":"スケジュールトリガー","href":"/ja/self-host/use-dify/nodes/trigger/schedule-trigger"},{"title":"インテグレーショントリガー","href":"/ja/self-host/use-dify/nodes/trigger/plugin-trigger"},{"title":"Webhook トリガー","href":"/ja/self-host/use-dify/nodes/trigger/webhook-trigger"}]}]},{"title":"LLM","href":"/ja/self-host/use-dify/nodes/llm"},{"title":"知識検索","href":"/ja/self-host/use-dify/nodes/knowledge-retrieval"},{"title":"答え","href":"/ja/self-host/use-dify/nodes/answer"},{"title":"出力","href":"/ja/self-host/use-dify/nodes/output"},{"title":"Agent","href":"/ja/self-host/use-dify/nodes/agent"},{"title":"質問分類器","href":"/ja/self-host/use-dify/nodes/question-classifier"},{"title":"If-Else","href":"/ja/self-host/use-dify/nodes/ifelse"},{"group":"人間の入力","root":{"title":"人間の入力","href":"/ja/self-host/use-dify/nodes/human-input"},"expanded":false,"pages":[]},{"title":"反復処理","href":"/ja/self-host/use-dify/nodes/iteration"},{"title":"ループ","href":"/ja/self-host/use-dify/nodes/loop"},{"title":"コード","href":"/ja/self-host/use-dify/nodes/code"},{"title":"テンプレート","href":"/ja/self-host/use-dify/nodes/template"},{"title":"変数集約器","href":"/ja/self-host/use-dify/nodes/variable-aggregator"},{"title":"テキスト抽出","href":"/ja/self-host/use-dify/nodes/doc-extractor"},{"title":"変数アサイナー","href":"/ja/self-host/use-dify/nodes/variable-assigner"},{"title":"パラメータ抽出器","href":"/ja/self-host/use-dify/nodes/parameter-extractor"},{"title":"HTTP リクエスト","href":"/ja/self-host/use-dify/nodes/http-request"},{"title":"リスト演算子","href":"/ja/self-host/use-dify/nodes/list-operator"},{"title":"ツールノード","sidebarTitle":"ツール","href":"/ja/self-host/use-dify/nodes/tools"}]},{"title":"ホットキー","href":"/ja/self-host/use-dify/build/shortcut-key"},{"title":"バージョン管理","href":"/ja/self-host/use-dify/build/version-control"},{"title":"スニペット","href":"/ja/self-host/use-dify/build/snippet"},{"title":"チームメンバーと共同作業","sidebarTitle":"コラボレーション","href":"/ja/self-host/use-dify/build/workflow-collaboration"},{"group":"デバッグ","expanded":false,"pages":[{"title":"エラーの処理","href":"/ja/self-host/use-dify/build/predefined-error-handling-logic"},{"title":"単一ノード","href":"/ja/self-host/use-dify/debug/step-run"},{"title":"変数インスペクター","href":"/ja/self-host/use-dify/debug/variable-inspect"},{"title":"実行履歴","href":"/ja/self-host/use-dify/debug/history-and-logs"},{"title":"エラータイプ","href":"/ja/self-host/use-dify/debug/error-type"}]}]},{"group":"Agent","tag":"New","expanded":false,"pages":[{"title":"Agent","sidebarTitle":"概要","href":"/ja/self-host/use-dify/build/new-agent/overview"},{"title":"Agent の構築","sidebarTitle":"構築","href":"/ja/self-host/use-dify/build/new-agent/build"}]},{"title":"Skills","sidebarTitle":"Skills","href":"/ja/self-host/use-dify/build/skills"},{"group":"基本アプリ","expanded":false,"pages":[{"title":"Agent","tag":"Legacy","href":"/ja/self-host/use-dify/build/agent"},{"title":"チャットボット","sidebarTitle":"チャットボット","href":"/ja/self-host/use-dify/build/chatbot"},{"title":"テキストジェネレーター","sidebarTitle":"テキストジェネレーター","href":"/ja/self-host/use-dify/build/text-generator"}]},{"title":"アプリツールキット","href":"/ja/self-host/use-dify/build/additional-features"},{"title":"グローバル検索","href":"/ja/self-host/use-dify/build/goto-anything"}]},{"group":"公開","icon":"paper-plane","expanded":false,"pages":[{"title":"AI アプリの共有","href":"/ja/self-host/use-dify/publish/README"},{"group":"Web アプリ","pages":[{"title":"Workflow Web アプリ","href":"/ja/self-host/use-dify/publish/webapp/workflow-webapp"},{"title":"チャット Web アプリ","href":"/ja/self-host/use-dify/publish/webapp/chatflow-webapp"},{"title":"設定","href":"/ja/self-host/use-dify/publish/webapp/web-app-settings"},{"title":"Web アプリの埋め込み","sidebarTitle":"埋め込み","href":"/ja/self-host/use-dify/publish/webapp/embedding-in-websites"}]},{"title":"MCP サーバー","href":"/ja/self-host/use-dify/publish/publish-mcp"},{"title":"アプリをマーケットプレイスに公開","sidebarTitle":"マーケットプレイス","href":"/ja/self-host/use-dify/publish/publish-to-marketplace"}]},{"group":"モニタリング","icon":"chart-line","expanded":false,"pages":[{"title":"ダッシュボード","href":"/ja/self-host/use-dify/monitor/analysis"},{"title":"ログ","href":"/ja/self-host/use-dify/monitor/logs"},{"title":"注釈システム","href":"/ja/self-host/use-dify/monitor/annotation-reply"},{"group":"インテグレーション","pages":[{"title":"LangSmith の統合","href":"/ja/self-host/use-dify/monitor/integrations/integrate-langsmith"},{"title":"Langfuse の統合","href":"/ja/self-host/use-dify/monitor/integrations/integrate-langfuse"},{"title":"Opik の統合","href":"/ja/self-host/use-dify/monitor/integrations/integrate-opik"},{"title":"W\u0026B Weave の統合","sidebarTitle":"W\u0026B Weave","href":"/ja/self-host/use-dify/monitor/integrations/integrate-weave"},{"title":"Arize の統合","href":"/ja/self-host/use-dify/monitor/integrations/integrate-arize"},{"title":"Phoenix の統合","href":"/ja/self-host/use-dify/monitor/integrations/integrate-phoenix"},{"title":"Alibaba Cloud Monitor の統合","href":"/ja/self-host/use-dify/monitor/integrations/integrate-aliyun"}]}]},{"group":"ナレッジ","icon":"book","expanded":false,"pages":[{"title":"ナレッジ","sidebarTitle":"概要","href":"/ja/self-host/use-dify/knowledge/readme"},{"group":"作成","pages":[{"group":"すぐに使えるナレッジベースを作成","pages":[{"title":"すぐに使えるナレッジベースを作成","sidebarTitle":"概要","href":"/ja/self-host/use-dify/knowledge/create-knowledge/introduction"},{"group":"データのインポート","pages":[{"title":"ローカルファイルをアップロード","href":"/ja/self-host/use-dify/knowledge/create-knowledge/import-text-data/readme"},{"title":"Notion からデータを同期","href":"/ja/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-notion"},{"title":"Web サイトからデータをインポート","href":"/ja/self-host/use-dify/knowledge/create-knowledge/import-text-data/sync-from-website"}]},{"title":"チャンク設定","href":"/ja/self-host/use-dify/knowledge/create-knowledge/chunking-and-cleaning-text"},{"title":"インデックス方法と検索設定を指定","href":"/ja/self-host/use-dify/knowledge/create-knowledge/setting-indexing-methods"}]},{"group":"カスタムナレッジベースを構築","pages":[{"title":"カスタムナレッジベースを構築","sidebarTitle":"概要","href":"/ja/self-host/use-dify/knowledge/knowledge-pipeline/readme"},{"title":"ステップ 1:ナレッジパイプラインの作成","href":"/ja/self-host/use-dify/knowledge/knowledge-pipeline/create-knowledge-pipeline"},{"title":"ステップ 2:ナレッジパイプラインをオーケストレーションする","href":"/ja/self-host/use-dify/knowledge/knowledge-pipeline/knowledge-pipeline-orchestration"},{"title":"ステップ 3:ナレッジパイプラインの公開","href":"/ja/self-host/use-dify/knowledge/knowledge-pipeline/publish-knowledge-pipeline"},{"title":"ステップ 4:ファイルのアップロード","href":"/ja/self-host/use-dify/knowledge/knowledge-pipeline/upload-files"},{"title":"ステップ 5:ナレッジベースの管理と活用","href":"/ja/self-host/use-dify/knowledge/knowledge-pipeline/manage-knowledge-base"},{"title":"データソース認証","href":"/ja/self-host/use-dify/knowledge/knowledge-pipeline/authorize-data-source"}]},{"group":"外部ナレッジベースと連携","pages":[{"title":"外部ナレッジベースとの接続","sidebarTitle":"概要","href":"/ja/self-host/use-dify/knowledge/connect-external-knowledge-base"},{"title":"外部ナレッジベース API","href":"/ja/self-host/use-dify/knowledge/external-knowledge-api"}]}]},{"group":"管理","pages":[{"title":"ナレッジコンテンツの管理","sidebarTitle":"ドキュメントとチャンク","href":"/ja/self-host/use-dify/knowledge/manage-knowledge/maintain-knowledge-documents"},{"title":"ドキュメントのメタデータを管理","sidebarTitle":"メタデータ","href":"/ja/self-host/use-dify/knowledge/metadata"},{"title":"ナレッジ設定の管理","sidebarTitle":"設定","href":"/ja/self-host/use-dify/knowledge/manage-knowledge/introduction"}]},{"title":"ナレッジ検索テスト","sidebarTitle":"検索テスト","href":"/ja/self-host/use-dify/knowledge/test-retrieval"},{"title":"アプリ内でのナレッジベース統合","sidebarTitle":"アプリ内で統合","href":"/ja/self-host/use-dify/knowledge/integrate-knowledge-within-application"}]},{"group":"統合","icon":"plug","expanded":false,"pages":[{"title":"統合","sidebarTitle":"概要","href":"/ja/self-host/use-dify/workspace/plugins"},{"title":"モデルプロバイダー","href":"/ja/self-host/use-dify/workspace/model-providers"},{"title":"Dify ツール","sidebarTitle":"ツール","href":"/ja/self-host/use-dify/workspace/tools"},{"group":"カスタム API","pages":[{"title":"カスタム API","sidebarTitle":"概要","href":"/ja/self-host/use-dify/workspace/api-extension/api-extension"},{"title":"外部データツール","href":"/ja/self-host/use-dify/workspace/api-extension/external-data-tool-api-extension"},{"title":"センシティブコンテンツ審査","href":"/ja/self-host/use-dify/workspace/api-extension/moderation-api-extension"},{"title":"Cloudflare Workers を使用したカスタム API のデプロイ","href":"/ja/self-host/use-dify/workspace/api-extension/cloudflare-worker"}]}]},{"group":"ワークスペース","icon":"briefcase","expanded":false,"pages":[{"title":"概要","href":"/ja/self-host/use-dify/workspace/readme"},{"title":"アプリのエクスポートとインポート","sidebarTitle":"エクスポートとインポート","href":"/ja/self-host/use-dify/workspace/export-import-apps"},{"title":"メンバーの管理","href":"/ja/self-host/use-dify/workspace/team-members-management"},{"title":"個人設定","href":"/ja/self-host/use-dify/workspace/personal-account-management"}]}]},{"tab":"学習","icon":"graduation-cap","pages":[{"title":"主要な概念","href":"/ja/learn/key-concepts"},{"group":"チュートリアル","pages":[{"title":"30 分間クイックスタート","href":"/ja/quick-start"},{"group":"ワークフロー 101","pages":[{"title":"レッスン 1:ワークフローとは?","href":"/ja/learn/tutorials/workflow-101/lesson-01"},{"title":"レッスン 2:フローの頭と尾(開始ノードと出力ノード)","sidebarTitle":"レッスン 2:フローの頭と尾","href":"/ja/learn/tutorials/workflow-101/lesson-02"},{"title":"レッスン 3:ワークフローの頭脳(LLM ノード)","sidebarTitle":"レッスン 3:ワークフローの頭脳","href":"/ja/learn/tutorials/workflow-101/lesson-03"},{"title":"レッスン 4:カンニングペーパー(ナレッジ検索)","sidebarTitle":"レッスン 4:カンニングペーパー","href":"/ja/learn/tutorials/workflow-101/lesson-04"},{"title":"レッスン 5:ワークフローの分岐点(分類と実行)","sidebarTitle":"レッスン 5:ワークフローの分岐点","href":"/ja/learn/tutorials/workflow-101/lesson-05"},{"title":"レッスン 6:複数のタスクを処理する(パラメータ抽出 \u0026 イテレーション)","sidebarTitle":"レッスン 6:複数のタスクを処理する","href":"/ja/learn/tutorials/workflow-101/lesson-06"},{"title":"レッスン 7:ワークフローを強化する(ツール)","sidebarTitle":"レッスン 7:ワークフローを強化する","href":"/ja/learn/tutorials/workflow-101/lesson-07"},{"title":"レッスン 8:エージェントノード","sidebarTitle":"レッスン 8:エージェントノード","href":"/ja/learn/tutorials/workflow-101/lesson-08"},{"title":"レッスン 9:レイアウトデザイナー(テンプレート)","sidebarTitle":"レッスン 9:レイアウトデザイナー","href":"/ja/learn/tutorials/workflow-101/lesson-09"},{"title":"レッスン 10:AI アプリを公開してモニタリングする","sidebarTitle":"レッスン 10:公開とモニタリング","href":"/ja/learn/tutorials/workflow-101/lesson-10"}]},{"title":"シンプルなチャットボット","href":"/ja/learn/tutorials/simple-chatbot"},{"title":"チャットストリームエージェントを使用した Twitter アカウントの分析方法","href":"/ja/learn/tutorials/twitter-chatflow"},{"title":"知識ベースを使用したカスタマーサービスボット","href":"/ja/learn/tutorials/customer-service-bot"},{"title":"ゼロから AI 画像生成アプリの構築方法","href":"/ja/learn/tutorials/build-ai-image-generation-app"},{"title":"ファイルアップロードを使用した記事理解アシスタントの構築方法","href":"/ja/learn/tutorials/article-reader"}]}]},{"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 delete /knowledge-fs/spaces/{knowledge_base_id}/logical-documents/{document_id}","href":"/ja/api-reference/documents-and-chunks/delete-document"},{"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":"選択したページをインポート","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":"ソースのアイテムをインポート","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","groups":[{"group":" ","expanded":true,"pages":[{"title":"概要","href":"/ja/cli/overview"},{"title":"クイックスタート","href":"/ja/cli/get-started"},{"title":"コマンドの検索と実行","href":"/ja/cli/find-and-run-commands"},{"group":"アプリの操作","expanded":true,"pages":[{"title":"アプリの構築","sidebarTitle":"構築","href":"/ja/cli/build-apps"},{"title":"アプリの実行","sidebarTitle":"実行","href":"/ja/cli/run-apps"},{"title":"DSL ファイルからのアプリの作成と更新","sidebarTitle":"DSL からの作成・更新","href":"/ja/cli/create-and-update-apps-from-dsl-files"},{"title":"CI と自動化での `difyctl` の使用","sidebarTitle":"CI と自動化","href":"/ja/cli/scripts-and-ci"}]},{"group":"difyctl の管理","expanded":true,"pages":[{"title":"サインインの管理","sidebarTitle":"サインインとセッション","href":"/ja/cli/manage-sign-in"},{"title":"difyctl のアップデートとアンインストール","sidebarTitle":"アップデートとアンインストール","href":"/ja/cli/update-or-uninstall"},{"title":"Dify 1.18.0 へのアップグレード","sidebarTitle":"1.18.0 へのアップグレード","href":"/ja/cli/upgrade-across-1-18"}]},{"group":"リファレンス","expanded":true,"pages":[{"title":"コマンド索引","href":"/ja/cli/reference/command-index"},{"title":"結果、エラー、終了コード","sidebarTitle":"結果とエラー","href":"/ja/cli/reference/results-errors-and-exit-codes"},{"title":"設定","href":"/ja/cli/reference/configuration"}]}]}]},{"item":"プラグイン開発","icon":"code-pull-request","pages":[{"group":"クイックスタート","icon":"rocket","pages":[{"title":"Dify プラグイン","href":"/ja/develop-plugin/getting-started/getting-started-dify-plugin"},{"title":"プラグインタイプの選択","href":"/ja/develop-plugin/getting-started/choose-plugin-type"},{"title":"Dify プラグイン CLI","href":"/ja/develop-plugin/getting-started/cli"}]},{"group":"特性と仕様","icon":"list-check","pages":[{"group":"プラグインタイプ","pages":[{"title":"一般仕様","href":"/ja/develop-plugin/features-and-specs/plugin-types/general-specifications"},{"title":"モデル仕様","href":"/ja/develop-plugin/features-and-specs/plugin-types/model-designing-rules"},{"title":"モデル API インターフェース","href":"/ja/develop-plugin/features-and-specs/plugin-types/model-schema"},{"title":"永続ストレージ","href":"/ja/develop-plugin/features-and-specs/plugin-types/persistent-storage-kv"},{"title":"ツールの戻り値","href":"/ja/develop-plugin/features-and-specs/plugin-types/tool"},{"title":"Manifest","href":"/ja/develop-plugin/features-and-specs/plugin-types/plugin-info-by-manifest"},{"title":"多言語 README","href":"/ja/develop-plugin/features-and-specs/plugin-types/multilingual-readme"},{"title":"プラグインのデバッグ","href":"/ja/develop-plugin/features-and-specs/plugin-types/remote-debug-a-plugin"},{"title":"プラグインのロギング","href":"/ja/develop-plugin/features-and-specs/plugin-types/plugin-logging"}]},{"group":"高度な開発","pages":[{"group":"リバース呼び出し","pages":[{"title":"Bundle プラグインパッケージ","href":"/ja/develop-plugin/features-and-specs/advanced-development/bundle"},{"title":"Dify サービスの逆呼び出し","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation"},{"title":"App","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-app"},{"title":"モデルの逆呼び出し","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-model"},{"title":"ツール","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-tool"},{"title":"カスタムモデルの統合","href":"/ja/develop-plugin/features-and-specs/advanced-development/customizable-model"},{"title":"ノード","href":"/ja/develop-plugin/features-and-specs/advanced-development/reverse-invocation-node"}]}]}]},{"group":"開発ガイドとサンプル","icon":"code","pages":[{"title":"チートシート","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/cheatsheet"},{"group":"プラグインタイプ別","pages":[{"title":"ツールプラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/tool-plugin"},{"title":"Tool OAuth","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/tool-oauth"},{"title":"モデルプロバイダープラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/creating-new-model-provider"},{"title":"エージェント戦略プラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/agent-strategy-plugin"},{"title":"データソースプラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/datasource-plugin"},{"title":"トリガープラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/trigger-plugin"},{"title":"Endpoint プラグイン","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/endpoint"}]},{"group":"完全なサンプル","pages":[{"title":"Flomoツール(10分)","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/develop-flomo-plugin"},{"title":"Slack Bot","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/develop-a-slack-bot-plugin"},{"title":"Markdownエクスポーター","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/develop-md-exporter"},{"title":"マルチモーダルツール","href":"/ja/develop-plugin/dev-guides-and-walkthroughs/develop-multimodal-data-processing-tool"}]}]},{"group":"公開","icon":"upload","pages":[{"title":"プラグインの公開","href":"/ja/develop-plugin/publishing/marketplace-listing/release-overview"},{"group":"標準","pages":[{"title":"プラグイン開発ガイドライン","href":"/ja/develop-plugin/publishing/standards/contributor-covenant-code-of-conduct"},{"title":"プライバシーポリシーガイドライン","href":"/ja/develop-plugin/publishing/standards/privacy-protection-guidelines"}]},{"title":"マーケットプレイスにプラグインを公開","sidebarTitle":"マーケットプレイス","href":"/ja/develop-plugin/publishing/marketplace-listing/submit-plugin-to-marketplace"},{"group":"GitHub リポジトリ","pages":[{"title":"個人 GitHub リポジトリへの公開","href":"/ja/develop-plugin/publishing/marketplace-listing/release-to-individual-github-repo"}]},{"group":"ローカルファイル","pages":[{"title":"ローカルファイルとしてパッケージ化して共有","href":"/ja/develop-plugin/publishing/marketplace-listing/release-by-file"},{"title":"サードパーティ署名検証用のプラグイン署名","href":"/ja/develop-plugin/publishing/standards/third-party-signature-verification"}]},{"title":"よくある質問","sidebarTitle":"よくある質問","href":"/ja/develop-plugin/publishing/faq/faq"}]}]}]}]}]}]},"basePath":"","title":"Update Document by Text - Dify Docs","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BUDYNlhG.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}